xref: /petsc/src/ts/interface/ts.c (revision 618ce8ba4a5fbcb0ed574c45ef0e9892b3887186)
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;
6347f79407eSBarry Smith   ierr                       = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
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 
2697022c081aSHong Zhang   ierr = PetscFree(ts->vecs_fwdsensipacked);CHKERRQ(ierr);
2698022c081aSHong 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 /*@
2871*618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2872*618ce8baSLisandro Dalcin 
2873*618ce8baSLisandro Dalcin    Logically Collective on TS
2874*618ce8baSLisandro Dalcin 
2875*618ce8baSLisandro Dalcin    Input Parameters:
2876*618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2877*618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2878*618ce8baSLisandro Dalcin 
2879*618ce8baSLisandro Dalcin    Options Database Keys:
2880*618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2881*618ce8baSLisandro Dalcin 
2882*618ce8baSLisandro Dalcin    Notes:
2883*618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2884*618ce8baSLisandro Dalcin 
2885*618ce8baSLisandro Dalcin    Level: intermediate
2886*618ce8baSLisandro Dalcin 
2887*618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps
2888*618ce8baSLisandro Dalcin 
2889*618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2890*618ce8baSLisandro Dalcin @*/
2891*618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2892*618ce8baSLisandro Dalcin {
2893*618ce8baSLisandro Dalcin   PetscFunctionBegin;
2894*618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2895*618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2896*618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2897*618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2898*618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2899*618ce8baSLisandro Dalcin }
2900*618ce8baSLisandro Dalcin 
2901*618ce8baSLisandro Dalcin /*@
2902*618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2903*618ce8baSLisandro Dalcin 
2904*618ce8baSLisandro Dalcin    Not Collective
2905*618ce8baSLisandro Dalcin 
2906*618ce8baSLisandro Dalcin    Input Parameters:
2907*618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2908*618ce8baSLisandro Dalcin 
2909*618ce8baSLisandro Dalcin    Output Parameter:
2910*618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2911*618ce8baSLisandro Dalcin 
2912*618ce8baSLisandro Dalcin    Level: advanced
2913*618ce8baSLisandro Dalcin 
2914*618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps
2915*618ce8baSLisandro Dalcin 
2916*618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2917*618ce8baSLisandro Dalcin @*/
2918*618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2919*618ce8baSLisandro Dalcin {
2920*618ce8baSLisandro Dalcin   PetscFunctionBegin;
2921*618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2922*618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2923*618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2924*618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2925*618ce8baSLisandro Dalcin }
2926*618ce8baSLisandro Dalcin 
2927*618ce8baSLisandro Dalcin /*@
2928*618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2929*618ce8baSLisandro Dalcin 
2930*618ce8baSLisandro Dalcin    Logically Collective on TS
2931*618ce8baSLisandro Dalcin 
2932*618ce8baSLisandro Dalcin    Input Parameters:
2933*618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2934*618ce8baSLisandro Dalcin -  maxtime - final time to step to
2935*618ce8baSLisandro Dalcin 
2936*618ce8baSLisandro Dalcin    Options Database Keys:
2937*618ce8baSLisandro Dalcin .  -ts_final_time <maxtime> - Sets maxtime
2938*618ce8baSLisandro Dalcin 
2939*618ce8baSLisandro Dalcin    Notes:
2940*618ce8baSLisandro Dalcin    The default maximum time is 5.0
2941*618ce8baSLisandro Dalcin 
2942*618ce8baSLisandro Dalcin    Level: intermediate
2943*618ce8baSLisandro Dalcin 
2944*618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time
2945*618ce8baSLisandro Dalcin 
2946*618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
2947*618ce8baSLisandro Dalcin @*/
2948*618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
2949*618ce8baSLisandro Dalcin {
2950*618ce8baSLisandro Dalcin   PetscFunctionBegin;
2951*618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2952*618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
2953*618ce8baSLisandro Dalcin   ts->max_time = maxtime;
2954*618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2955*618ce8baSLisandro Dalcin }
2956*618ce8baSLisandro Dalcin 
2957*618ce8baSLisandro Dalcin /*@
2958*618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
2959*618ce8baSLisandro Dalcin 
2960*618ce8baSLisandro Dalcin    Not Collective
2961*618ce8baSLisandro Dalcin 
2962*618ce8baSLisandro Dalcin    Input Parameters:
2963*618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2964*618ce8baSLisandro Dalcin 
2965*618ce8baSLisandro Dalcin    Output Parameter:
2966*618ce8baSLisandro Dalcin .  maxtime - final time to step to
2967*618ce8baSLisandro Dalcin 
2968*618ce8baSLisandro Dalcin    Level: advanced
2969*618ce8baSLisandro Dalcin 
2970*618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time
2971*618ce8baSLisandro Dalcin 
2972*618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
2973*618ce8baSLisandro Dalcin @*/
2974*618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
2975*618ce8baSLisandro Dalcin {
2976*618ce8baSLisandro Dalcin   PetscFunctionBegin;
2977*618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2978*618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
2979*618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
2980*618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2981*618ce8baSLisandro Dalcin }
2982*618ce8baSLisandro Dalcin 
2983*618ce8baSLisandro Dalcin /*@
2984adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2985adb62b0dSMatthew Knepley    maximum time for iteration.
2986adb62b0dSMatthew Knepley 
29873f9fe445SBarry Smith    Not Collective
2988adb62b0dSMatthew Knepley 
2989adb62b0dSMatthew Knepley    Input Parameters:
2990adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
29910298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
29920298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2993adb62b0dSMatthew Knepley 
2994adb62b0dSMatthew Knepley    Level: intermediate
2995adb62b0dSMatthew Knepley 
2996adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2997adb62b0dSMatthew Knepley @*/
29987087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2999adb62b0dSMatthew Knepley {
3000adb62b0dSMatthew Knepley   PetscFunctionBegin;
30010700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3002abc0a331SBarry Smith   if (maxsteps) {
30034482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
3004adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
3005adb62b0dSMatthew Knepley   }
3006abc0a331SBarry Smith   if (maxtime) {
30074482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
3008adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
3009adb62b0dSMatthew Knepley   }
3010adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
3011adb62b0dSMatthew Knepley }
3012adb62b0dSMatthew Knepley 
3013d763cef2SBarry Smith /*@
3014d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
3015d763cef2SBarry Smith    maximum time for iteration.
3016d763cef2SBarry Smith 
30173f9fe445SBarry Smith    Logically Collective on TS
3018d763cef2SBarry Smith 
3019d763cef2SBarry Smith    Input Parameters:
3020d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3021d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
3022d763cef2SBarry Smith -  maxtime - final time to iterate to
3023d763cef2SBarry Smith 
3024d763cef2SBarry Smith    Options Database Keys:
3025d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
30263bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
3027d763cef2SBarry Smith 
3028d763cef2SBarry Smith    Notes:
3029d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
3030d763cef2SBarry Smith 
3031d763cef2SBarry Smith    Level: intermediate
3032d763cef2SBarry Smith 
3033d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
3034a43b19c4SJed Brown 
3035a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
3036d763cef2SBarry Smith @*/
30377087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
3038d763cef2SBarry Smith {
3039d763cef2SBarry Smith   PetscFunctionBegin;
30400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3041c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
3042c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
304339b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
304439b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
3045d763cef2SBarry Smith   PetscFunctionReturn(0);
3046d763cef2SBarry Smith }
3047d763cef2SBarry Smith 
3048d763cef2SBarry Smith /*@
3049d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
3050d763cef2SBarry Smith    for use by the TS routines.
3051d763cef2SBarry Smith 
30523f9fe445SBarry Smith    Logically Collective on TS and Vec
3053d763cef2SBarry Smith 
3054d763cef2SBarry Smith    Input Parameters:
3055d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
30560910c330SBarry Smith -  u - the solution vector
3057d763cef2SBarry Smith 
3058d763cef2SBarry Smith    Level: beginner
3059d763cef2SBarry Smith 
3060715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values
3061d763cef2SBarry Smith @*/
30620910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3063d763cef2SBarry Smith {
30648737fe31SLisandro Dalcin   PetscErrorCode ierr;
3065496e6a7aSJed Brown   DM             dm;
30668737fe31SLisandro Dalcin 
3067d763cef2SBarry Smith   PetscFunctionBegin;
30680700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30690910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
30700910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
30716bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
30720910c330SBarry Smith   ts->vec_sol = u;
3073bbd56ea5SKarl Rupp 
3074496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
30750910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3076d763cef2SBarry Smith   PetscFunctionReturn(0);
3077d763cef2SBarry Smith }
3078d763cef2SBarry Smith 
307973b18844SBarry Smith /*@
308073b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
308173b18844SBarry Smith 
308273b18844SBarry Smith    Logically Collective on TS
308373b18844SBarry Smith 
308473b18844SBarry Smith    Input Parameters:
308573b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
308673b18844SBarry Smith .  steps - number of steps to use
308773b18844SBarry Smith 
308873b18844SBarry Smith    Level: intermediate
308973b18844SBarry Smith 
309073b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
309173b18844SBarry Smith           so as to integrate back to less than the original timestep
309273b18844SBarry Smith 
309373b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
309473b18844SBarry Smith 
309573b18844SBarry Smith .seealso: TSSetExactFinalTime()
309673b18844SBarry Smith @*/
309773b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
309873b18844SBarry Smith {
309973b18844SBarry Smith   PetscFunctionBegin;
310073b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
310173b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
310273b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
310373b18844SBarry 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");
310473b18844SBarry Smith   ts->adjoint_max_steps = steps;
310573b18844SBarry Smith   PetscFunctionReturn(0);
310673b18844SBarry Smith }
310773b18844SBarry Smith 
3108c235aa8dSHong Zhang /*@
3109715f1b00SHong 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
31100cf82b59SBarry Smith       for use by the TSAdjoint routines.
3111c235aa8dSHong Zhang 
3112c235aa8dSHong Zhang    Logically Collective on TS and Vec
3113c235aa8dSHong Zhang 
3114c235aa8dSHong Zhang    Input Parameters:
3115c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
3116abc2977eSBarry 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
3117abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
3118c235aa8dSHong Zhang 
3119c235aa8dSHong Zhang    Level: beginner
3120c235aa8dSHong Zhang 
3121abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
31220cf82b59SBarry Smith 
3123715f1b00SHong Zhang .keywords: TS, timestep, set, sensitivity, initial values
3124c235aa8dSHong Zhang @*/
3125dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
3126c235aa8dSHong Zhang {
3127c235aa8dSHong Zhang   PetscFunctionBegin;
3128c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3129abc2977eSBarry Smith   PetscValidPointer(lambda,2);
3130abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
3131abc2977eSBarry Smith   ts->vecs_sensip = mu;
3132dfb21088SHong 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");
3133abc2977eSBarry Smith   ts->numcost  = numcost;
3134ad8e2604SHong Zhang   PetscFunctionReturn(0);
3135ad8e2604SHong Zhang }
3136ad8e2604SHong Zhang 
3137ad8e2604SHong Zhang /*@C
31380cf82b59SBarry 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.
3139ad8e2604SHong Zhang 
3140ad8e2604SHong Zhang   Logically Collective on TS
3141ad8e2604SHong Zhang 
3142ad8e2604SHong Zhang   Input Parameters:
3143ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
3144ad8e2604SHong Zhang - func - The function
3145ad8e2604SHong Zhang 
3146ad8e2604SHong Zhang   Calling sequence of func:
31470cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
314805755b9cSHong Zhang +   t - current timestep
31490cf82b59SBarry Smith .   y - input vector (current ODE solution)
315005755b9cSHong Zhang .   A - output matrix
315105755b9cSHong Zhang -   ctx - [optional] user-defined function context
3152ad8e2604SHong Zhang 
3153ad8e2604SHong Zhang   Level: intermediate
3154ad8e2604SHong Zhang 
31550cf82b59SBarry 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
31560cf82b59SBarry Smith 
3157ad8e2604SHong Zhang .keywords: TS, sensitivity
3158ad8e2604SHong Zhang .seealso:
3159ad8e2604SHong Zhang @*/
31605bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
3161ad8e2604SHong Zhang {
3162ad8e2604SHong Zhang   PetscErrorCode ierr;
3163ad8e2604SHong Zhang 
3164ad8e2604SHong Zhang   PetscFunctionBegin;
3165ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
316623706b9aSHong Zhang   PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
3167ad8e2604SHong Zhang 
3168ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
3169ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
3170ad8e2604SHong Zhang   if(Amat) {
3171ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
3172ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
3173ad8e2604SHong Zhang     ts->Jacp = Amat;
3174ad8e2604SHong Zhang   }
3175ad8e2604SHong Zhang   PetscFunctionReturn(0);
3176ad8e2604SHong Zhang }
3177ad8e2604SHong Zhang 
31780cf82b59SBarry Smith /*@C
31795bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
3180ad8e2604SHong Zhang 
3181ad8e2604SHong Zhang   Collective on TS
3182ad8e2604SHong Zhang 
3183ad8e2604SHong Zhang   Input Parameters:
3184ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
3185ad8e2604SHong Zhang 
3186ad8e2604SHong Zhang   Level: developer
3187ad8e2604SHong Zhang 
3188ad8e2604SHong Zhang .keywords: TS, sensitivity
31895bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
3190ad8e2604SHong Zhang @*/
31915bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
3192ad8e2604SHong Zhang {
3193ad8e2604SHong Zhang   PetscErrorCode ierr;
3194ad8e2604SHong Zhang 
3195ad8e2604SHong Zhang   PetscFunctionBegin;
3196ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3197ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
3198ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
3199ad8e2604SHong Zhang 
3200ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
3201ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
3202ad8e2604SHong Zhang   PetscStackPop;
3203c235aa8dSHong Zhang   PetscFunctionReturn(0);
3204c235aa8dSHong Zhang }
3205c235aa8dSHong Zhang 
32066fd0887fSHong Zhang /*@C
3207dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
32086fd0887fSHong Zhang 
32096fd0887fSHong Zhang     Logically Collective on TS
32106fd0887fSHong Zhang 
32116fd0887fSHong Zhang     Input Parameters:
32126fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
3213abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
32143d1d12c6SHong Zhang .   costintegral - vector that stores the integral values
32150cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
3216b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
3217b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
3218feaa1ddbSSatish Balay .   fwd - flag indicating whether to evaluate cost integral in the forward run or the adjoint run
3219b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
32206fd0887fSHong Zhang 
32210cf82b59SBarry Smith     Calling sequence of rf:
32223d1d12c6SHong Zhang $   PetscErrorCode rf(TS ts,PetscReal t,Vec y,Vec f,void *ctx);
32236fd0887fSHong Zhang 
3224b612ec54SBarry Smith     Calling sequence of drdyf:
32250cf82b59SBarry Smith $   PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
3226b612ec54SBarry Smith 
3227b612ec54SBarry Smith     Calling sequence of drdpf:
32280cf82b59SBarry Smith $   PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
3229b612ec54SBarry Smith 
3230b612ec54SBarry Smith     Level: intermediate
32316fd0887fSHong Zhang 
3232715f1b00SHong Zhang     Notes: For optimization there is usually a single cost function (numcost = 1). For sensitivities there may be multiple cost functions
32330cf82b59SBarry Smith 
32346fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
32356fd0887fSHong Zhang 
3236dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
32376fd0887fSHong Zhang @*/
32383d1d12c6SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost,Vec costintegral,PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
3239d8151eeaSBarry Smith                                                           PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
3240b1cb36f3SHong Zhang                                                           PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),
3241b1cb36f3SHong Zhang                                                           PetscBool fwd,void *ctx)
32426fd0887fSHong Zhang {
32436fd0887fSHong Zhang   PetscErrorCode ierr;
32446fd0887fSHong Zhang 
32456fd0887fSHong Zhang   PetscFunctionBegin;
32466fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32473d1d12c6SHong Zhang   if (costintegral) PetscValidHeaderSpecific(costintegral,VEC_CLASSID,3);
3248715f1b00SHong 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()");
3249c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
32506fd0887fSHong Zhang 
32513d1d12c6SHong Zhang   if (costintegral) {
32523d1d12c6SHong Zhang     ierr = PetscObjectReference((PetscObject)costintegral);CHKERRQ(ierr);
32533d1d12c6SHong Zhang     ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
32543d1d12c6SHong Zhang     ts->vec_costintegral = costintegral;
3255afe7b317SHong Zhang   } else {
3256afe7b317SHong Zhang     if (!ts->vec_costintegral) { /* Create a seq vec if user does not provide one */
3257afe7b317SHong Zhang       ierr = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
3258afe7b317SHong Zhang     } else {
3259afe7b317SHong Zhang       ierr = VecSet(ts->vec_costintegral,0.0);CHKERRQ(ierr);
3260afe7b317SHong Zhang     }
3261afe7b317SHong Zhang   }
3262afe7b317SHong Zhang   if (!ts->vec_costintegrand) {
32632c39e106SBarry Smith     ierr = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
3264afe7b317SHong Zhang   } else {
3265afe7b317SHong Zhang     ierr = VecSet(ts->vec_costintegrand,0.0);CHKERRQ(ierr);
3266afe7b317SHong Zhang   }
3267afe7b317SHong Zhang   ts->costintegralfwd  = fwd; /* Evaluate the cost integral in forward run if fwd is true */
32680cf82b59SBarry Smith   ts->costintegrand    = rf;
326905755b9cSHong Zhang   ts->costintegrandctx = ctx;
3270b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
3271b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
32726fd0887fSHong Zhang   PetscFunctionReturn(0);
32736fd0887fSHong Zhang }
32746fd0887fSHong Zhang 
327536eaed60SHong Zhang /*@
3276dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
327736eaed60SHong Zhang    It is valid to call the routine after a backward run.
327836eaed60SHong Zhang 
327936eaed60SHong Zhang    Not Collective
328036eaed60SHong Zhang 
328136eaed60SHong Zhang    Input Parameter:
328236eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
328336eaed60SHong Zhang 
328436eaed60SHong Zhang    Output Parameter:
32852c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
328636eaed60SHong Zhang 
328736eaed60SHong Zhang    Level: intermediate
328836eaed60SHong Zhang 
3289dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
329036eaed60SHong Zhang 
329136eaed60SHong Zhang .keywords: TS, sensitivity analysis
329236eaed60SHong Zhang @*/
3293dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
329436eaed60SHong Zhang {
329536eaed60SHong Zhang   PetscFunctionBegin;
329636eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
329736eaed60SHong Zhang   PetscValidPointer(v,2);
32982c39e106SBarry Smith   *v = ts->vec_costintegral;
329936eaed60SHong Zhang   PetscFunctionReturn(0);
330036eaed60SHong Zhang }
330136eaed60SHong Zhang 
33026fd0887fSHong Zhang /*@
3303022c081aSHong Zhang    TSComputeCostIntegrand - Evaluates the integral function in the cost functions.
33046fd0887fSHong Zhang 
33056fd0887fSHong Zhang    Input Parameters:
33066fd0887fSHong Zhang +  ts - the TS context
33076fd0887fSHong Zhang .  t - current time
33080cf82b59SBarry Smith -  y - state vector, i.e. current solution
33096fd0887fSHong Zhang 
33106fd0887fSHong Zhang    Output Parameter:
3311abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
33126fd0887fSHong Zhang 
33136fd0887fSHong Zhang    Note:
33146fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
33156fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
33166fd0887fSHong Zhang 
33176fd0887fSHong Zhang    Level: developer
33186fd0887fSHong Zhang 
33196fd0887fSHong Zhang .keywords: TS, compute
33206fd0887fSHong Zhang 
3321dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
33226fd0887fSHong Zhang @*/
3323022c081aSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
33246fd0887fSHong Zhang {
33256fd0887fSHong Zhang   PetscErrorCode ierr;
33266fd0887fSHong Zhang 
33276fd0887fSHong Zhang   PetscFunctionBegin;
33286fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33290cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
33306fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
33316fd0887fSHong Zhang 
33320cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
3333e4680132SHong Zhang   if (ts->costintegrand) {
3334e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
33350cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
33366fd0887fSHong Zhang     PetscStackPop;
33376fd0887fSHong Zhang   } else {
33386fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
33396fd0887fSHong Zhang   }
33406fd0887fSHong Zhang 
33410cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
33426fd0887fSHong Zhang   PetscFunctionReturn(0);
33436fd0887fSHong Zhang }
33446fd0887fSHong Zhang 
334505755b9cSHong Zhang /*@
3346d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
334705755b9cSHong Zhang 
334805755b9cSHong Zhang   Collective on TS
334905755b9cSHong Zhang 
335005755b9cSHong Zhang   Input Parameters:
335105755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
335205755b9cSHong Zhang 
335305755b9cSHong Zhang   Notes:
3354d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
335505755b9cSHong Zhang   so most users would not generally call this routine themselves.
335605755b9cSHong Zhang 
335705755b9cSHong Zhang   Level: developer
335805755b9cSHong Zhang 
335905755b9cSHong Zhang .keywords: TS, sensitivity
3360d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
336105755b9cSHong Zhang @*/
33620cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
336305755b9cSHong Zhang {
336405755b9cSHong Zhang   PetscErrorCode ierr;
336505755b9cSHong Zhang 
336605755b9cSHong Zhang   PetscFunctionBegin;
336705755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33680cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
336905755b9cSHong Zhang 
337005755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
33710cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
337205755b9cSHong Zhang   PetscStackPop;
337305755b9cSHong Zhang   PetscFunctionReturn(0);
337405755b9cSHong Zhang }
337505755b9cSHong Zhang 
337605755b9cSHong Zhang /*@
3377d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
337805755b9cSHong Zhang 
337905755b9cSHong Zhang   Collective on TS
338005755b9cSHong Zhang 
338105755b9cSHong Zhang   Input Parameters:
338205755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
338305755b9cSHong Zhang 
338405755b9cSHong Zhang   Notes:
338505755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
338605755b9cSHong Zhang   so most users would not generally call this routine themselves.
338705755b9cSHong Zhang 
338805755b9cSHong Zhang   Level: developer
338905755b9cSHong Zhang 
339005755b9cSHong Zhang .keywords: TS, sensitivity
3391d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
339205755b9cSHong Zhang @*/
33930cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
339405755b9cSHong Zhang {
339505755b9cSHong Zhang   PetscErrorCode ierr;
339605755b9cSHong Zhang 
339705755b9cSHong Zhang   PetscFunctionBegin;
339805755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33990cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
340005755b9cSHong Zhang 
340105755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
34020cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
340305755b9cSHong Zhang   PetscStackPop;
340405755b9cSHong Zhang   PetscFunctionReturn(0);
340505755b9cSHong Zhang }
340605755b9cSHong Zhang 
3407ac226902SBarry Smith /*@C
3408000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
34093f2090d5SJed Brown   called once at the beginning of each time step.
3410000e7ae3SMatthew Knepley 
34113f9fe445SBarry Smith   Logically Collective on TS
3412000e7ae3SMatthew Knepley 
3413000e7ae3SMatthew Knepley   Input Parameters:
3414000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3415000e7ae3SMatthew Knepley - func - The function
3416000e7ae3SMatthew Knepley 
3417000e7ae3SMatthew Knepley   Calling sequence of func:
3418000e7ae3SMatthew Knepley . func (TS ts);
3419000e7ae3SMatthew Knepley 
3420000e7ae3SMatthew Knepley   Level: intermediate
3421000e7ae3SMatthew Knepley 
3422000e7ae3SMatthew Knepley .keywords: TS, timestep
34239be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
3424000e7ae3SMatthew Knepley @*/
34257087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3426000e7ae3SMatthew Knepley {
3427000e7ae3SMatthew Knepley   PetscFunctionBegin;
34280700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3429ae60f76fSBarry Smith   ts->prestep = func;
3430000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3431000e7ae3SMatthew Knepley }
3432000e7ae3SMatthew Knepley 
343309ee8438SJed Brown /*@
34343f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
34353f2090d5SJed Brown 
34363f2090d5SJed Brown   Collective on TS
34373f2090d5SJed Brown 
34383f2090d5SJed Brown   Input Parameters:
34393f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
34403f2090d5SJed Brown 
34413f2090d5SJed Brown   Notes:
34423f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
34433f2090d5SJed Brown   so most users would not generally call this routine themselves.
34443f2090d5SJed Brown 
34453f2090d5SJed Brown   Level: developer
34463f2090d5SJed Brown 
34473f2090d5SJed Brown .keywords: TS, timestep
34489be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
34493f2090d5SJed Brown @*/
34507087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
34513f2090d5SJed Brown {
34523f2090d5SJed Brown   PetscErrorCode ierr;
34533f2090d5SJed Brown 
34543f2090d5SJed Brown   PetscFunctionBegin;
34550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3456ae60f76fSBarry Smith   if (ts->prestep) {
3457ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
3458312ce896SJed Brown   }
34593f2090d5SJed Brown   PetscFunctionReturn(0);
34603f2090d5SJed Brown }
34613f2090d5SJed Brown 
3462b8123daeSJed Brown /*@C
3463b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3464b8123daeSJed Brown   called once at the beginning of each stage.
3465b8123daeSJed Brown 
3466b8123daeSJed Brown   Logically Collective on TS
3467b8123daeSJed Brown 
3468b8123daeSJed Brown   Input Parameters:
3469b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3470b8123daeSJed Brown - func - The function
3471b8123daeSJed Brown 
3472b8123daeSJed Brown   Calling sequence of func:
3473b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3474b8123daeSJed Brown 
3475b8123daeSJed Brown   Level: intermediate
3476b8123daeSJed Brown 
3477b8123daeSJed Brown   Note:
3478b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3479b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
3480b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3481b8123daeSJed Brown 
3482b8123daeSJed Brown .keywords: TS, timestep
34839be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3484b8123daeSJed Brown @*/
3485b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3486b8123daeSJed Brown {
3487b8123daeSJed Brown   PetscFunctionBegin;
3488b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3489ae60f76fSBarry Smith   ts->prestage = func;
3490b8123daeSJed Brown   PetscFunctionReturn(0);
3491b8123daeSJed Brown }
3492b8123daeSJed Brown 
34939be3e283SDebojyoti Ghosh /*@C
34949be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
34959be3e283SDebojyoti Ghosh   called once at the end of each stage.
34969be3e283SDebojyoti Ghosh 
34979be3e283SDebojyoti Ghosh   Logically Collective on TS
34989be3e283SDebojyoti Ghosh 
34999be3e283SDebojyoti Ghosh   Input Parameters:
35009be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
35019be3e283SDebojyoti Ghosh - func - The function
35029be3e283SDebojyoti Ghosh 
35039be3e283SDebojyoti Ghosh   Calling sequence of func:
35049be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
35059be3e283SDebojyoti Ghosh 
35069be3e283SDebojyoti Ghosh   Level: intermediate
35079be3e283SDebojyoti Ghosh 
35089be3e283SDebojyoti Ghosh   Note:
35099be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
35109be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
35119be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
35129be3e283SDebojyoti Ghosh 
35139be3e283SDebojyoti Ghosh .keywords: TS, timestep
35149be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
35159be3e283SDebojyoti Ghosh @*/
35169be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
35179be3e283SDebojyoti Ghosh {
35189be3e283SDebojyoti Ghosh   PetscFunctionBegin;
35199be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
35209be3e283SDebojyoti Ghosh   ts->poststage = func;
35219be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
35229be3e283SDebojyoti Ghosh }
35239be3e283SDebojyoti Ghosh 
3524c688d042SShri Abhyankar /*@C
3525c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3526c688d042SShri Abhyankar   called once at the end of each step evaluation.
3527c688d042SShri Abhyankar 
3528c688d042SShri Abhyankar   Logically Collective on TS
3529c688d042SShri Abhyankar 
3530c688d042SShri Abhyankar   Input Parameters:
3531c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3532c688d042SShri Abhyankar - func - The function
3533c688d042SShri Abhyankar 
3534c688d042SShri Abhyankar   Calling sequence of func:
3535c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3536c688d042SShri Abhyankar 
3537c688d042SShri Abhyankar   Level: intermediate
3538c688d042SShri Abhyankar 
3539c688d042SShri Abhyankar   Note:
35401785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
35411785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3542e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3543e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3544e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3545c688d042SShri Abhyankar 
3546c688d042SShri Abhyankar .keywords: TS, timestep
3547c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3548c688d042SShri Abhyankar @*/
3549c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3550c688d042SShri Abhyankar {
3551c688d042SShri Abhyankar   PetscFunctionBegin;
3552c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3553c688d042SShri Abhyankar   ts->postevaluate = func;
3554c688d042SShri Abhyankar   PetscFunctionReturn(0);
3555c688d042SShri Abhyankar }
3556c688d042SShri Abhyankar 
3557b8123daeSJed Brown /*@
3558b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3559b8123daeSJed Brown 
3560b8123daeSJed Brown   Collective on TS
3561b8123daeSJed Brown 
3562b8123daeSJed Brown   Input Parameters:
3563b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
35649be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3565b8123daeSJed Brown 
3566b8123daeSJed Brown   Notes:
3567b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3568b8123daeSJed Brown   most users would not generally call this routine themselves.
3569b8123daeSJed Brown 
3570b8123daeSJed Brown   Level: developer
3571b8123daeSJed Brown 
3572b8123daeSJed Brown .keywords: TS, timestep
35739be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3574b8123daeSJed Brown @*/
3575b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3576b8123daeSJed Brown {
3577b8123daeSJed Brown   PetscErrorCode ierr;
3578b8123daeSJed Brown 
3579b8123daeSJed Brown   PetscFunctionBegin;
3580b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3581ae60f76fSBarry Smith   if (ts->prestage) {
3582ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3583b8123daeSJed Brown   }
3584b8123daeSJed Brown   PetscFunctionReturn(0);
3585b8123daeSJed Brown }
3586b8123daeSJed Brown 
35879be3e283SDebojyoti Ghosh /*@
35889be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
35899be3e283SDebojyoti Ghosh 
35909be3e283SDebojyoti Ghosh   Collective on TS
35919be3e283SDebojyoti Ghosh 
35929be3e283SDebojyoti Ghosh   Input Parameters:
35939be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
35949be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
35959be3e283SDebojyoti Ghosh   stageindex  - Stage number
35969be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
35979be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
35989be3e283SDebojyoti Ghosh 
35999be3e283SDebojyoti Ghosh   Notes:
36009be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
36019be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
36029be3e283SDebojyoti Ghosh 
36039be3e283SDebojyoti Ghosh   Level: developer
36049be3e283SDebojyoti Ghosh 
36059be3e283SDebojyoti Ghosh .keywords: TS, timestep
36069be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
36079be3e283SDebojyoti Ghosh @*/
36089be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
36099be3e283SDebojyoti Ghosh {
36109be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
36119be3e283SDebojyoti Ghosh 
36129be3e283SDebojyoti Ghosh   PetscFunctionBegin;
36139be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36144beae5d8SLisandro Dalcin   if (ts->poststage) {
36159be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
36169be3e283SDebojyoti Ghosh   }
36179be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
36189be3e283SDebojyoti Ghosh }
36199be3e283SDebojyoti Ghosh 
3620c688d042SShri Abhyankar /*@
3621c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3622c688d042SShri Abhyankar 
3623c688d042SShri Abhyankar   Collective on TS
3624c688d042SShri Abhyankar 
3625c688d042SShri Abhyankar   Input Parameters:
3626c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3627c688d042SShri Abhyankar 
3628c688d042SShri Abhyankar   Notes:
3629c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3630c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3631c688d042SShri Abhyankar 
3632c688d042SShri Abhyankar   Level: developer
3633c688d042SShri Abhyankar 
3634c688d042SShri Abhyankar .keywords: TS, timestep
3635c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3636c688d042SShri Abhyankar @*/
3637c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3638c688d042SShri Abhyankar {
3639c688d042SShri Abhyankar   PetscErrorCode ierr;
3640c688d042SShri Abhyankar 
3641c688d042SShri Abhyankar   PetscFunctionBegin;
3642c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3643c688d042SShri Abhyankar   if (ts->postevaluate) {
3644c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3645c688d042SShri Abhyankar   }
3646c688d042SShri Abhyankar   PetscFunctionReturn(0);
3647c688d042SShri Abhyankar }
3648c688d042SShri Abhyankar 
3649ac226902SBarry Smith /*@C
3650000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
36513f2090d5SJed Brown   called once at the end of each time step.
3652000e7ae3SMatthew Knepley 
36533f9fe445SBarry Smith   Logically Collective on TS
3654000e7ae3SMatthew Knepley 
3655000e7ae3SMatthew Knepley   Input Parameters:
3656000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3657000e7ae3SMatthew Knepley - func - The function
3658000e7ae3SMatthew Knepley 
3659000e7ae3SMatthew Knepley   Calling sequence of func:
3660b8123daeSJed Brown $ func (TS ts);
3661000e7ae3SMatthew Knepley 
36621785ff2aSShri Abhyankar   Notes:
36631785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
36641785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
36651785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
36661785ff2aSShri Abhyankar 
3667000e7ae3SMatthew Knepley   Level: intermediate
3668000e7ae3SMatthew Knepley 
3669000e7ae3SMatthew Knepley .keywords: TS, timestep
36701785ff2aSShri Abhyankar .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
3671000e7ae3SMatthew Knepley @*/
36727087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3673000e7ae3SMatthew Knepley {
3674000e7ae3SMatthew Knepley   PetscFunctionBegin;
36750700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3676ae60f76fSBarry Smith   ts->poststep = func;
3677000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3678000e7ae3SMatthew Knepley }
3679000e7ae3SMatthew Knepley 
368009ee8438SJed Brown /*@
36813f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
36823f2090d5SJed Brown 
36833f2090d5SJed Brown   Collective on TS
36843f2090d5SJed Brown 
36853f2090d5SJed Brown   Input Parameters:
36863f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
36873f2090d5SJed Brown 
36883f2090d5SJed Brown   Notes:
36893f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
36903f2090d5SJed Brown   so most users would not generally call this routine themselves.
36913f2090d5SJed Brown 
36923f2090d5SJed Brown   Level: developer
36933f2090d5SJed Brown 
36943f2090d5SJed Brown .keywords: TS, timestep
36953f2090d5SJed Brown @*/
36967087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
36973f2090d5SJed Brown {
36983f2090d5SJed Brown   PetscErrorCode ierr;
36993f2090d5SJed Brown 
37003f2090d5SJed Brown   PetscFunctionBegin;
37010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3702ae60f76fSBarry Smith   if (ts->poststep) {
3703ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
370472ac3e02SJed Brown   }
37053f2090d5SJed Brown   PetscFunctionReturn(0);
37063f2090d5SJed Brown }
37073f2090d5SJed Brown 
3708d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3709d763cef2SBarry Smith 
3710d763cef2SBarry Smith /*@C
3711a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3712d763cef2SBarry Smith    timestep to display the iteration's  progress.
3713d763cef2SBarry Smith 
37143f9fe445SBarry Smith    Logically Collective on TS
3715d763cef2SBarry Smith 
3716d763cef2SBarry Smith    Input Parameters:
3717d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3718e213d8f1SJed Brown .  monitor - monitoring routine
3719329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
37200298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3721b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
37220298fd71SBarry Smith           (may be NULL)
3723d763cef2SBarry Smith 
3724e213d8f1SJed Brown    Calling sequence of monitor:
37250910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3726d763cef2SBarry Smith 
3727d763cef2SBarry Smith +    ts - the TS context
372863e21af5SBarry 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)
37291f06c33eSBarry Smith .    time - current time
37300910c330SBarry Smith .    u - current iterate
3731d763cef2SBarry Smith -    mctx - [optional] monitoring context
3732d763cef2SBarry Smith 
3733d763cef2SBarry Smith    Notes:
3734d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3735d763cef2SBarry Smith    already has been loaded.
3736d763cef2SBarry Smith 
3737025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
3738025f1a04SBarry Smith 
3739d763cef2SBarry Smith    Level: intermediate
3740d763cef2SBarry Smith 
3741d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3742d763cef2SBarry Smith 
3743a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3744d763cef2SBarry Smith @*/
3745c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3746d763cef2SBarry Smith {
374778064530SBarry Smith   PetscErrorCode ierr;
374878064530SBarry Smith   PetscInt       i;
374978064530SBarry Smith   PetscBool      identical;
375078064530SBarry Smith 
3751d763cef2SBarry Smith   PetscFunctionBegin;
37520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
375378064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
375478064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
375578064530SBarry Smith     if (identical) PetscFunctionReturn(0);
375678064530SBarry Smith   }
375717186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3758d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
37598704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3760d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3761d763cef2SBarry Smith   PetscFunctionReturn(0);
3762d763cef2SBarry Smith }
3763d763cef2SBarry Smith 
3764d763cef2SBarry Smith /*@C
3765a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3766d763cef2SBarry Smith 
37673f9fe445SBarry Smith    Logically Collective on TS
3768d763cef2SBarry Smith 
3769d763cef2SBarry Smith    Input Parameters:
3770d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3771d763cef2SBarry Smith 
3772d763cef2SBarry Smith    Notes:
3773d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3774d763cef2SBarry Smith 
3775d763cef2SBarry Smith    Level: intermediate
3776d763cef2SBarry Smith 
3777d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3778d763cef2SBarry Smith 
3779a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3780d763cef2SBarry Smith @*/
37817087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3782d763cef2SBarry Smith {
3783d952e501SBarry Smith   PetscErrorCode ierr;
3784d952e501SBarry Smith   PetscInt       i;
3785d952e501SBarry Smith 
3786d763cef2SBarry Smith   PetscFunctionBegin;
37870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3788d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
37898704b422SBarry Smith     if (ts->monitordestroy[i]) {
37908704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3791d952e501SBarry Smith     }
3792d952e501SBarry Smith   }
3793d763cef2SBarry Smith   ts->numbermonitors = 0;
3794d763cef2SBarry Smith   PetscFunctionReturn(0);
3795d763cef2SBarry Smith }
3796d763cef2SBarry Smith 
3797721cd6eeSBarry Smith /*@C
3798721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
37995516499fSSatish Balay 
38005516499fSSatish Balay    Level: intermediate
380141251cbbSSatish Balay 
38025516499fSSatish Balay .keywords: TS, set, monitor
38035516499fSSatish Balay 
380463e21af5SBarry Smith .seealso:  TSMonitorSet()
380541251cbbSSatish Balay @*/
3806721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3807d763cef2SBarry Smith {
3808dfbe8321SBarry Smith   PetscErrorCode ierr;
3809721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
381041aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3811d132466eSBarry Smith 
3812d763cef2SBarry Smith   PetscFunctionBegin;
38134d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
381441aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
381541aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3816721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
381741aca3d6SBarry Smith   if (iascii) {
3818649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
381963e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
382063e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
382163e21af5SBarry Smith     } else {
38228392e04aSShri 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);
382363e21af5SBarry Smith     }
3824649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
382541aca3d6SBarry Smith   } else if (ibinary) {
382641aca3d6SBarry Smith     PetscMPIInt rank;
382741aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
382841aca3d6SBarry Smith     if (!rank) {
3829450a797fSBarry Smith       PetscBool skipHeader;
3830450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3831450a797fSBarry Smith 
3832450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3833450a797fSBarry Smith       if (!skipHeader) {
3834450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3835450a797fSBarry Smith        }
383641aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
383741aca3d6SBarry Smith     } else {
383841aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
383941aca3d6SBarry Smith     }
384041aca3d6SBarry Smith   }
3841721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3842d763cef2SBarry Smith   PetscFunctionReturn(0);
3843d763cef2SBarry Smith }
3844d763cef2SBarry Smith 
38459110b2e7SHong Zhang /*@C
38469110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
38479110b2e7SHong Zhang    timestep to display the iteration's  progress.
38489110b2e7SHong Zhang 
38499110b2e7SHong Zhang    Logically Collective on TS
38509110b2e7SHong Zhang 
38519110b2e7SHong Zhang    Input Parameters:
38529110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
38539110b2e7SHong Zhang .  adjointmonitor - monitoring routine
38549110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
38559110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
38569110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
38579110b2e7SHong Zhang           (may be NULL)
38589110b2e7SHong Zhang 
38599110b2e7SHong Zhang    Calling sequence of monitor:
38609110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
38619110b2e7SHong Zhang 
38629110b2e7SHong Zhang +    ts - the TS context
38639110b2e7SHong 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
38649110b2e7SHong Zhang                                been interpolated to)
38659110b2e7SHong Zhang .    time - current time
38669110b2e7SHong Zhang .    u - current iterate
38679110b2e7SHong Zhang .    numcost - number of cost functionos
38689110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
38699110b2e7SHong Zhang .    mu - sensitivities to parameters
38709110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
38719110b2e7SHong Zhang 
38729110b2e7SHong Zhang    Notes:
38739110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
38749110b2e7SHong Zhang    already has been loaded.
38759110b2e7SHong Zhang 
38769110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
38779110b2e7SHong Zhang 
38789110b2e7SHong Zhang    Level: intermediate
38799110b2e7SHong Zhang 
38809110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
38819110b2e7SHong Zhang 
38829110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
38839110b2e7SHong Zhang @*/
38849110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
38859110b2e7SHong Zhang {
388678064530SBarry Smith   PetscErrorCode ierr;
388778064530SBarry Smith   PetscInt       i;
388878064530SBarry Smith   PetscBool      identical;
388978064530SBarry Smith 
38909110b2e7SHong Zhang   PetscFunctionBegin;
38919110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
389278064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
389378064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))adjointmonitor,adjointmctx,adjointmdestroy,(PetscErrorCode (*)(void))ts->adjointmonitor[i],ts->adjointmonitorcontext[i],ts->adjointmonitordestroy[i],&identical);CHKERRQ(ierr);
389478064530SBarry Smith     if (identical) PetscFunctionReturn(0);
389578064530SBarry Smith   }
38969110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
38979110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
38989110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
38999110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
39009110b2e7SHong Zhang   PetscFunctionReturn(0);
39019110b2e7SHong Zhang }
39029110b2e7SHong Zhang 
39039110b2e7SHong Zhang /*@C
39049110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
39059110b2e7SHong Zhang 
39069110b2e7SHong Zhang    Logically Collective on TS
39079110b2e7SHong Zhang 
39089110b2e7SHong Zhang    Input Parameters:
39099110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
39109110b2e7SHong Zhang 
39119110b2e7SHong Zhang    Notes:
39129110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
39139110b2e7SHong Zhang 
39149110b2e7SHong Zhang    Level: intermediate
39159110b2e7SHong Zhang 
39169110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
39179110b2e7SHong Zhang 
39189110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
39199110b2e7SHong Zhang @*/
39209110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
39219110b2e7SHong Zhang {
39229110b2e7SHong Zhang   PetscErrorCode ierr;
39239110b2e7SHong Zhang   PetscInt       i;
39249110b2e7SHong Zhang 
39259110b2e7SHong Zhang   PetscFunctionBegin;
39269110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39279110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
39289110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
39299110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
39309110b2e7SHong Zhang     }
39319110b2e7SHong Zhang   }
39329110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
39339110b2e7SHong Zhang   PetscFunctionReturn(0);
39349110b2e7SHong Zhang }
39359110b2e7SHong Zhang 
3936721cd6eeSBarry Smith /*@C
3937721cd6eeSBarry Smith    TSAdjointMonitorDefault - the default monitor of adjoint computations
3938110eb670SHong Zhang 
3939110eb670SHong Zhang    Level: intermediate
3940110eb670SHong Zhang 
3941110eb670SHong Zhang .keywords: TS, set, monitor
3942110eb670SHong Zhang 
3943110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3944110eb670SHong Zhang @*/
3945721cd6eeSBarry Smith PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,PetscViewerAndFormat *vf)
3946110eb670SHong Zhang {
3947110eb670SHong Zhang   PetscErrorCode ierr;
3948721cd6eeSBarry Smith   PetscViewer    viewer = vf->viewer;
3949110eb670SHong Zhang 
3950110eb670SHong Zhang   PetscFunctionBegin;
3951110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3952721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3953110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3954110eb670SHong 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);
3955110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3956721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3957110eb670SHong Zhang   PetscFunctionReturn(0);
3958110eb670SHong Zhang }
3959110eb670SHong Zhang 
3960cd652676SJed Brown /*@
3961cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3962cd652676SJed Brown 
3963cd652676SJed Brown    Collective on TS
3964cd652676SJed Brown 
3965cd652676SJed Brown    Input Argument:
3966cd652676SJed Brown +  ts - time stepping context
3967cd652676SJed Brown -  t - time to interpolate to
3968cd652676SJed Brown 
3969cd652676SJed Brown    Output Argument:
39700910c330SBarry Smith .  U - state at given time
3971cd652676SJed Brown 
3972cd652676SJed Brown    Level: intermediate
3973cd652676SJed Brown 
3974cd652676SJed Brown    Developer Notes:
3975cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3976cd652676SJed Brown 
3977cd652676SJed Brown .keywords: TS, set
3978cd652676SJed Brown 
3979874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3980cd652676SJed Brown @*/
39810910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3982cd652676SJed Brown {
3983cd652676SJed Brown   PetscErrorCode ierr;
3984cd652676SJed Brown 
3985cd652676SJed Brown   PetscFunctionBegin;
3986cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3987b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3988be5899b3SLisandro 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);
3989ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
39900910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3991cd652676SJed Brown   PetscFunctionReturn(0);
3992cd652676SJed Brown }
3993cd652676SJed Brown 
3994d763cef2SBarry Smith /*@
39956d9e5789SSean Farley    TSStep - Steps one time step
3996d763cef2SBarry Smith 
3997d763cef2SBarry Smith    Collective on TS
3998d763cef2SBarry Smith 
3999d763cef2SBarry Smith    Input Parameter:
4000d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4001d763cef2SBarry Smith 
400227829d71SBarry Smith    Level: developer
4003d763cef2SBarry Smith 
4004b8123daeSJed Brown    Notes:
400527829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
400627829d71SBarry Smith 
4007b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
4008b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
4009b8123daeSJed Brown 
401025cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
401125cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
401225cb2221SBarry Smith 
4013d763cef2SBarry Smith .keywords: TS, timestep, solve
4014d763cef2SBarry Smith 
40159be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
4016d763cef2SBarry Smith @*/
4017193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
4018d763cef2SBarry Smith {
4019dfbe8321SBarry Smith   PetscErrorCode   ierr;
4020fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
4021be5899b3SLisandro Dalcin   PetscReal        ptime;
4022d763cef2SBarry Smith 
4023d763cef2SBarry Smith   PetscFunctionBegin;
40240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4025fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
4026fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
4027fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
4028fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
4029fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
4030fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
4031302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
4032fffbeea8SBarry Smith 
4033d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
403468bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4035d405a339SMatthew Knepley 
4036a6772fa2SLisandro 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()");
4037be5899b3SLisandro 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");
4038a6772fa2SLisandro Dalcin 
4039be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
4040362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4041be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
4042e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
4043d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4044193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
4045d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
4046be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
4047be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps++;
4048be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
404928d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
4050362cd11cSLisandro Dalcin 
4051362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4052cef5090cSJed Brown     if (ts->errorifstepfailed) {
405308c7845fSBarry 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]);
405408c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4055d2daff3dSHong Zhang     }
405608c7845fSBarry Smith   } else if (!ts->reason) {
405708c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
405808c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
405908c7845fSBarry Smith   }
406008c7845fSBarry Smith   PetscFunctionReturn(0);
406108c7845fSBarry Smith }
406208c7845fSBarry Smith 
406308c7845fSBarry Smith /*@
4064b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
406508c7845fSBarry Smith 
406608c7845fSBarry Smith    Collective on TS
406708c7845fSBarry Smith 
406808c7845fSBarry Smith    Input Parameter:
406908c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
407008c7845fSBarry Smith 
40716a4d4014SLisandro Dalcin    Level: intermediate
40726a4d4014SLisandro Dalcin 
4073b957a604SHong Zhang .keywords: TS, adjoint, step
40746a4d4014SLisandro Dalcin 
4075b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
40766a4d4014SLisandro Dalcin @*/
407708c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
40786a4d4014SLisandro Dalcin {
407908c7845fSBarry Smith   DM               dm;
40806a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
40816a4d4014SLisandro Dalcin 
40826a4d4014SLisandro Dalcin   PetscFunctionBegin;
40834a2ae208SSatish Balay   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
408408c7845fSBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
408508c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
4086d763cef2SBarry Smith 
4087685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts,"-ts_view_solution");CHKERRQ(ierr);
4088d763cef2SBarry Smith 
4089be5899b3SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
4090be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime;
409142f2b339SBarry 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);
4092be5899b3SLisandro Dalcin   ierr = PetscLogEventBegin(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
409342f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
40948d0ad7a8SHong Zhang   ierr = PetscLogEventEnd(TS_AdjointStep,ts,0,0,0);CHKERRQ(ierr);
4095be5899b3SLisandro Dalcin   ts->steps++; ts->total_steps--;
4096362cd11cSLisandro Dalcin 
4097362cd11cSLisandro Dalcin   if (ts->reason < 0) {
4098cef5090cSJed Brown     if (ts->errorifstepfailed) {
40996c4ed002SBarry 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]);
41006c4ed002SBarry 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]);
41016c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
4102cef5090cSJed Brown     }
4103362cd11cSLisandro Dalcin   } else if (!ts->reason) {
410473b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps) ts->reason = TS_CONVERGED_ITS;
4105362cd11cSLisandro Dalcin   }
4106d763cef2SBarry Smith   PetscFunctionReturn(0);
4107d763cef2SBarry Smith }
4108d763cef2SBarry Smith 
41097cbde773SLisandro Dalcin /*@
41107cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
41117cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
41127cbde773SLisandro Dalcin 
41137cbde773SLisandro Dalcin    Collective on TS
41147cbde773SLisandro Dalcin 
41157cbde773SLisandro Dalcin    Input Arguments:
41167cbde773SLisandro Dalcin +  ts - time stepping context
41177cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
41187cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
41197cbde773SLisandro Dalcin 
41207cbde773SLisandro Dalcin    Output Arguments:
41217cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
41227cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
41237cbde773SLisandro Dalcin 
41247cbde773SLisandro Dalcin    Level: advanced
41257cbde773SLisandro Dalcin 
41267cbde773SLisandro Dalcin    Notes:
41277cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
41287cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
41297cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
41307cbde773SLisandro Dalcin 
41317cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
41327cbde773SLisandro Dalcin @*/
41337cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
41347cbde773SLisandro Dalcin {
41357cbde773SLisandro Dalcin   PetscErrorCode ierr;
41367cbde773SLisandro Dalcin 
41377cbde773SLisandro Dalcin   PetscFunctionBegin;
41387cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
41397cbde773SLisandro Dalcin   PetscValidType(ts,1);
41407cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
41417cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
41427cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
41437cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
41447cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
41457cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
41467cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
41477cbde773SLisandro Dalcin   PetscFunctionReturn(0);
41487cbde773SLisandro Dalcin }
41497cbde773SLisandro Dalcin 
415005175c85SJed Brown /*@
415105175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
415205175c85SJed Brown 
41531c3436cfSJed Brown    Collective on TS
415405175c85SJed Brown 
415505175c85SJed Brown    Input Arguments:
41561c3436cfSJed Brown +  ts - time stepping context
41571c3436cfSJed Brown .  order - desired order of accuracy
41580298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
415905175c85SJed Brown 
416005175c85SJed Brown    Output Arguments:
41610910c330SBarry Smith .  U - state at the end of the current step
416205175c85SJed Brown 
416305175c85SJed Brown    Level: advanced
416405175c85SJed Brown 
4165108c343cSJed Brown    Notes:
4166108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
4167108c343cSJed 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.
4168108c343cSJed Brown 
41691c3436cfSJed Brown .seealso: TSStep(), TSAdapt
417005175c85SJed Brown @*/
41710910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
417205175c85SJed Brown {
417305175c85SJed Brown   PetscErrorCode ierr;
417405175c85SJed Brown 
417505175c85SJed Brown   PetscFunctionBegin;
417605175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
417705175c85SJed Brown   PetscValidType(ts,1);
41780910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4179ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
41800910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
418105175c85SJed Brown   PetscFunctionReturn(0);
418205175c85SJed Brown }
418305175c85SJed Brown 
4184b1cb36f3SHong Zhang /*@
4185b1cb36f3SHong Zhang    TSForwardCostIntegral - Evaluate the cost integral in the forward run.
4186b1cb36f3SHong Zhang 
4187b1cb36f3SHong Zhang    Collective on TS
4188b1cb36f3SHong Zhang 
4189b1cb36f3SHong Zhang    Input Arguments:
4190b1cb36f3SHong Zhang .  ts - time stepping context
4191b1cb36f3SHong Zhang 
4192b1cb36f3SHong Zhang    Level: advanced
4193b1cb36f3SHong Zhang 
4194b1cb36f3SHong Zhang    Notes:
4195b1cb36f3SHong Zhang    This function cannot be called until TSStep() has been completed.
4196b1cb36f3SHong Zhang 
4197b1cb36f3SHong Zhang .seealso: TSSolve(), TSAdjointCostIntegral()
4198b1cb36f3SHong Zhang @*/
4199b1cb36f3SHong Zhang PetscErrorCode TSForwardCostIntegral(TS ts)
4200b1cb36f3SHong Zhang {
4201b1cb36f3SHong Zhang   PetscErrorCode ierr;
4202b1cb36f3SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4203b1cb36f3SHong 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);
4204b1cb36f3SHong Zhang   ierr = (*ts->ops->forwardintegral)(ts);CHKERRQ(ierr);
4205b1cb36f3SHong Zhang   PetscFunctionReturn(0);
4206b1cb36f3SHong Zhang }
4207d67e68b7SBarry Smith 
4208d763cef2SBarry Smith /*@
4209d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
4210d763cef2SBarry Smith 
4211d763cef2SBarry Smith    Collective on TS
4212d763cef2SBarry Smith 
4213d763cef2SBarry Smith    Input Parameter:
4214d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
421563e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
421663e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
42175a3a76d0SJed Brown 
4218d763cef2SBarry Smith    Level: beginner
4219d763cef2SBarry Smith 
42205a3a76d0SJed Brown    Notes:
42215a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
42225a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
42235a3a76d0SJed Brown    stepped over the final time.
42245a3a76d0SJed Brown 
4225d763cef2SBarry Smith .keywords: TS, timestep, solve
4226d763cef2SBarry Smith 
422763e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
4228d763cef2SBarry Smith @*/
4229cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
4230d763cef2SBarry Smith {
4231b06615a5SLisandro Dalcin   Vec               solution;
4232d763cef2SBarry Smith   PetscErrorCode    ierr;
4233d763cef2SBarry Smith 
4234d763cef2SBarry Smith   PetscFunctionBegin;
4235d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4236f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
4237feed9e9dSBarry Smith 
423849354f04SShri 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 */
4239b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
42400910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
4241b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
4242b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
4243b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
42445a3a76d0SJed Brown     }
42450910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
4246715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
4247bbd56ea5SKarl Rupp   } else if (u) {
42480910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
42495a3a76d0SJed Brown   }
4250b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
425168bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
4252a6772fa2SLisandro Dalcin 
4253a6772fa2SLisandro 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()");
4254a6772fa2SLisandro 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");
4255a6772fa2SLisandro Dalcin 
4256715f1b00SHong Zhang   if (ts->forward_solve) {
4257715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
4258715f1b00SHong Zhang   }
4259715f1b00SHong Zhang 
4260e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
4261715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
4262e7069c78SShri      TSTrajectory to incorrectly save the output files
4263e7069c78SShri   */
4264715f1b00SHong Zhang   /* reset time step and iteration counters */
4265193ac0bcSJed Brown   ts->steps             = 0;
42665ef26d82SJed Brown   ts->ksp_its           = 0;
42675ef26d82SJed Brown   ts->snes_its          = 0;
4268c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
4269c610991cSLisandro Dalcin   ts->reject            = 0;
4270193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
4271193ac0bcSJed Brown 
4272ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
4273f05ece33SBarry Smith 
4274193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4275193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
4276a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4277cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4278a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
4279be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4280db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
4281db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4282e7069c78SShri 
4283938c94caSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
42846427ac75SLisandro Dalcin     ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
4285e7069c78SShri 
428628d5b5d6SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
428728d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_TRUE;
42886427ac75SLisandro Dalcin 
4289e1a7a14fSJed Brown     while (!ts->reason) {
4290938c94caSShri Abhyankar       ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
42919687d888SLisandro Dalcin       if (!ts->steprollback) {
42929687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
42939687d888SLisandro Dalcin       }
4294193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
4295e783b05fSHong 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. */
4296b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
4297b1cb36f3SHong Zhang       }
4298715f1b00SHong 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 */
4299715f1b00SHong Zhang           ierr = TSForwardStep(ts);CHKERRQ(ierr);
4300715f1b00SHong Zhang       }
430110b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
4302e783b05fSHong 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. */
4303e783b05fSHong Zhang       if (!ts->steprollback) {
4304938c94caSShri Abhyankar         ierr = TSTrajectorySet(ts->trajectory,ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43051eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
4306aeb4809dSShri Abhyankar       }
4307193ac0bcSJed Brown     }
4308938c94caSShri Abhyankar     ierr = TSMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
43096427ac75SLisandro Dalcin 
431049354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
43110910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
4312cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4313b06615a5SLisandro Dalcin       solution = u;
431463e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
43150574a7fbSJed Brown     } else {
4316ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
4317cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4318b06615a5SLisandro Dalcin       solution = ts->vec_sol;
43190574a7fbSJed Brown     }
4320193ac0bcSJed Brown   }
4321d2daff3dSHong Zhang 
4322ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
432363e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
432456f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
4325ef222394SBarry Smith   if (ts->adjoint_solve) {
4326ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
43272b0a91c0SBarry Smith   }
4328d763cef2SBarry Smith   PetscFunctionReturn(0);
4329d763cef2SBarry Smith }
4330d763cef2SBarry Smith 
4331b1cb36f3SHong Zhang /*@
4332b1cb36f3SHong Zhang  TSAdjointCostIntegral - Evaluate the cost integral in the adjoint run.
4333b1cb36f3SHong Zhang 
4334b1cb36f3SHong Zhang  Collective on TS
4335b1cb36f3SHong Zhang 
4336b1cb36f3SHong Zhang  Input Arguments:
4337b1cb36f3SHong Zhang  .  ts - time stepping context
4338b1cb36f3SHong Zhang 
4339b1cb36f3SHong Zhang  Level: advanced
4340b1cb36f3SHong Zhang 
4341b1cb36f3SHong Zhang  Notes:
4342b1cb36f3SHong Zhang  This function cannot be called until TSAdjointStep() has been completed.
4343b1cb36f3SHong Zhang 
4344b1cb36f3SHong Zhang  .seealso: TSAdjointSolve(), TSAdjointStep
4345b1cb36f3SHong Zhang  @*/
4346b1cb36f3SHong Zhang PetscErrorCode TSAdjointCostIntegral(TS ts)
4347b1cb36f3SHong Zhang {
4348b1cb36f3SHong Zhang     PetscErrorCode ierr;
4349b1cb36f3SHong Zhang     PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4350b1cb36f3SHong 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);
4351b1cb36f3SHong Zhang     ierr = (*ts->ops->adjointintegral)(ts);CHKERRQ(ierr);
4352b1cb36f3SHong Zhang     PetscFunctionReturn(0);
4353b1cb36f3SHong Zhang }
4354b1cb36f3SHong Zhang 
4355c88f2d44SBarry Smith /*@
4356c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
4357c88f2d44SBarry Smith 
4358c88f2d44SBarry Smith    Collective on TS
4359c88f2d44SBarry Smith 
4360c88f2d44SBarry Smith    Input Parameter:
43612c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
4362c88f2d44SBarry Smith 
4363e87fd094SBarry Smith    Options Database:
4364715f1b00SHong Zhang . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial values
4365e87fd094SBarry Smith 
4366c88f2d44SBarry Smith    Level: intermediate
4367c88f2d44SBarry Smith 
4368c88f2d44SBarry Smith    Notes:
4369c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
4370c88f2d44SBarry Smith 
437173b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
437273b18844SBarry Smith 
4373c88f2d44SBarry Smith .keywords: TS, timestep, solve
4374c88f2d44SBarry Smith 
4375b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
4376c88f2d44SBarry Smith @*/
43772c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
4378c88f2d44SBarry Smith {
4379c88f2d44SBarry Smith   PetscErrorCode    ierr;
4380c88f2d44SBarry Smith 
4381c88f2d44SBarry Smith   PetscFunctionBegin;
4382c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4383c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
438468bece0bSHong Zhang 
4385c88f2d44SBarry Smith   /* reset time step and iteration counters */
4386c88f2d44SBarry Smith   ts->steps             = 0;
4387c88f2d44SBarry Smith   ts->ksp_its           = 0;
4388c88f2d44SBarry Smith   ts->snes_its          = 0;
4389c88f2d44SBarry Smith   ts->num_snes_failures = 0;
4390c88f2d44SBarry Smith   ts->reject            = 0;
4391c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
4392c88f2d44SBarry Smith 
439373b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
4394c88f2d44SBarry Smith 
439573b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
4396c88f2d44SBarry Smith   while (!ts->reason) {
439755c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
43989110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
43996427ac75SLisandro Dalcin     ierr = TSAdjointEventHandler(ts);CHKERRQ(ierr);
4400616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
4401b1cb36f3SHong Zhang     if (ts->vec_costintegral && !ts->costintegralfwd) {
4402b1cb36f3SHong Zhang       ierr = TSAdjointCostIntegral(ts);CHKERRQ(ierr);
4403b1cb36f3SHong Zhang     }
4404c88f2d44SBarry Smith   }
440526656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
440626656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
4407c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
4408e210cd0eSHong Zhang   ierr = TSTrajectoryViewFromOptions(ts->trajectory,NULL,"-ts_trajectory_view");CHKERRQ(ierr);
4409685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
4410c88f2d44SBarry Smith   PetscFunctionReturn(0);
4411c88f2d44SBarry Smith }
4412c88f2d44SBarry Smith 
44137db568b7SBarry Smith /*@C
4414228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
4415228d79bcSJed Brown 
4416228d79bcSJed Brown    Collective on TS
4417228d79bcSJed Brown 
4418228d79bcSJed Brown    Input Parameters:
4419228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
4420228d79bcSJed Brown .  step - step number that has just completed
4421228d79bcSJed Brown .  ptime - model time of the state
44220910c330SBarry Smith -  u - state at the current model time
4423228d79bcSJed Brown 
4424228d79bcSJed Brown    Notes:
44257db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
44267db568b7SBarry Smith    Users would almost never call this routine directly.
4427228d79bcSJed Brown 
442863e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
442963e21af5SBarry Smith 
44307db568b7SBarry Smith    Level: developer
4431228d79bcSJed Brown 
4432228d79bcSJed Brown .keywords: TS, timestep
4433228d79bcSJed Brown @*/
44340910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
4435d763cef2SBarry Smith {
4436d6152f81SLisandro Dalcin   DM             dm;
4437a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
4438d6152f81SLisandro Dalcin   PetscErrorCode ierr;
4439d763cef2SBarry Smith 
4440d763cef2SBarry Smith   PetscFunctionBegin;
4441b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4442b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4443d6152f81SLisandro Dalcin 
4444d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
4445d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
4446d6152f81SLisandro Dalcin 
44475edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
4448d763cef2SBarry Smith   for (i=0; i<n; i++) {
44490910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
4450d763cef2SBarry Smith   }
44515edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
4452d763cef2SBarry Smith   PetscFunctionReturn(0);
4453d763cef2SBarry Smith }
4454d763cef2SBarry Smith 
44557db568b7SBarry Smith /*@C
44569110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
44579110b2e7SHong Zhang 
44589110b2e7SHong Zhang    Collective on TS
44599110b2e7SHong Zhang 
44609110b2e7SHong Zhang    Input Parameters:
44619110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
44629110b2e7SHong Zhang .  step - step number that has just completed
44639110b2e7SHong Zhang .  ptime - model time of the state
44649110b2e7SHong Zhang .  u - state at the current model time
44659110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
44669110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
44679110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
44689110b2e7SHong Zhang 
44699110b2e7SHong Zhang    Notes:
44707db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
44717db568b7SBarry Smith    Users would almost never call this routine directly.
44729110b2e7SHong Zhang 
44737db568b7SBarry Smith    Level: developer
44749110b2e7SHong Zhang 
44759110b2e7SHong Zhang .keywords: TS, timestep
44769110b2e7SHong Zhang @*/
44779110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
44789110b2e7SHong Zhang {
44799110b2e7SHong Zhang   PetscErrorCode ierr;
44809110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
44819110b2e7SHong Zhang 
44829110b2e7SHong Zhang   PetscFunctionBegin;
44839110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44849110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
44859110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
44869110b2e7SHong Zhang   for (i=0; i<n; i++) {
44879110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
44889110b2e7SHong Zhang   }
44899110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
44909110b2e7SHong Zhang   PetscFunctionReturn(0);
44919110b2e7SHong Zhang }
44929110b2e7SHong Zhang 
4493d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
4494d763cef2SBarry Smith /*@C
44957db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
4496a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
4497d763cef2SBarry Smith 
4498d763cef2SBarry Smith    Collective on TS
4499d763cef2SBarry Smith 
4500d763cef2SBarry Smith    Input Parameters:
4501d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
4502d763cef2SBarry Smith .  label - the title to put in the title bar
45037c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
4504a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
4505a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
4506d763cef2SBarry Smith 
4507d763cef2SBarry Smith    Output Parameter:
45080b039ecaSBarry Smith .  ctx - the context
4509d763cef2SBarry Smith 
4510d763cef2SBarry Smith    Options Database Key:
45114f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
45127db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
45137db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
45147db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
45157db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
4516b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
4517d763cef2SBarry Smith 
4518d763cef2SBarry Smith    Notes:
4519a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
4520d763cef2SBarry Smith 
45217db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
45227db568b7SBarry Smith 
45237db568b7SBarry 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
45247db568b7SBarry 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
45257db568b7SBarry Smith    as the first argument.
45267db568b7SBarry Smith 
45277db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
45287db568b7SBarry Smith 
4529d763cef2SBarry Smith    Level: intermediate
4530d763cef2SBarry Smith 
45317db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
4532d763cef2SBarry Smith 
45337db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
45347db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
45357db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
45367db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
45377db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
45387c922b88SBarry Smith 
4539d763cef2SBarry Smith @*/
4540a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
4541d763cef2SBarry Smith {
45427f52daa2SLisandro Dalcin   PetscDraw      draw;
4543dfbe8321SBarry Smith   PetscErrorCode ierr;
4544d763cef2SBarry Smith 
4545d763cef2SBarry Smith   PetscFunctionBegin;
4546b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
45477f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
45487f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
45497f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
4550287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
45517f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
4552a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
4553d763cef2SBarry Smith   PetscFunctionReturn(0);
4554d763cef2SBarry Smith }
4555d763cef2SBarry Smith 
4556b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
4557d763cef2SBarry Smith {
45580b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4559c32365f1SBarry Smith   PetscReal      x   = ptime,y;
4560dfbe8321SBarry Smith   PetscErrorCode ierr;
4561d763cef2SBarry Smith 
4562d763cef2SBarry Smith   PetscFunctionBegin;
456363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
4564b06615a5SLisandro Dalcin   if (!step) {
4565a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4566a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
45676934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time Step");CHKERRQ(ierr);
4568a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4569a9f9c1f6SBarry Smith   }
4570c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
457108763aebSBarry Smith   y =  PetscLog10Real(y);
45720b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
4573b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
45740b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
45756934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
45763923b477SBarry Smith   }
4577d763cef2SBarry Smith   PetscFunctionReturn(0);
4578d763cef2SBarry Smith }
4579d763cef2SBarry Smith 
4580d763cef2SBarry Smith /*@C
4581a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
4582a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
4583d763cef2SBarry Smith 
45840b039ecaSBarry Smith    Collective on TSMonitorLGCtx
4585d763cef2SBarry Smith 
4586d763cef2SBarry Smith    Input Parameter:
45870b039ecaSBarry Smith .  ctx - the monitor context
4588d763cef2SBarry Smith 
4589d763cef2SBarry Smith    Level: intermediate
4590d763cef2SBarry Smith 
4591d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
4592d763cef2SBarry Smith 
45934f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
4594d763cef2SBarry Smith @*/
4595a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
4596d763cef2SBarry Smith {
4597dfbe8321SBarry Smith   PetscErrorCode ierr;
4598d763cef2SBarry Smith 
4599d763cef2SBarry Smith   PetscFunctionBegin;
46007684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
46017684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
46027684fa3eSBarry Smith   }
46030b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
460431152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
4605387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
4606387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
4607387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
46080b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
4609d763cef2SBarry Smith   PetscFunctionReturn(0);
4610d763cef2SBarry Smith }
4611d763cef2SBarry Smith 
4612d763cef2SBarry Smith /*@
4613b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4614d763cef2SBarry Smith 
4615d763cef2SBarry Smith    Not Collective
4616d763cef2SBarry Smith 
4617d763cef2SBarry Smith    Input Parameter:
4618d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4619d763cef2SBarry Smith 
4620d763cef2SBarry Smith    Output Parameter:
462163e21af5SBarry Smith .  t  - the current time. This time may not corresponds to the final time set with TSSetDuration(), use TSGetSolveTime().
4622d763cef2SBarry Smith 
4623d763cef2SBarry Smith    Level: beginner
4624d763cef2SBarry Smith 
4625b8123daeSJed Brown    Note:
4626b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
46279be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4628b8123daeSJed Brown 
462963e21af5SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep(), TSGetSolveTime()
4630d763cef2SBarry Smith 
4631d763cef2SBarry Smith .keywords: TS, get, time
4632d763cef2SBarry Smith @*/
46337087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4634d763cef2SBarry Smith {
4635d763cef2SBarry Smith   PetscFunctionBegin;
46360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4637f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4638d763cef2SBarry Smith   *t = ts->ptime;
4639d763cef2SBarry Smith   PetscFunctionReturn(0);
4640d763cef2SBarry Smith }
4641d763cef2SBarry Smith 
4642e5e524a1SHong Zhang /*@
4643e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4644e5e524a1SHong Zhang 
4645e5e524a1SHong Zhang    Not Collective
4646e5e524a1SHong Zhang 
4647e5e524a1SHong Zhang    Input Parameter:
4648e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4649e5e524a1SHong Zhang 
4650e5e524a1SHong Zhang    Output Parameter:
4651e5e524a1SHong Zhang .  t  - the previous time
4652e5e524a1SHong Zhang 
4653e5e524a1SHong Zhang    Level: beginner
4654e5e524a1SHong Zhang 
4655e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
4656e5e524a1SHong Zhang 
4657e5e524a1SHong Zhang .keywords: TS, get, time
4658e5e524a1SHong Zhang @*/
4659e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4660e5e524a1SHong Zhang {
4661e5e524a1SHong Zhang   PetscFunctionBegin;
4662e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4663e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4664e5e524a1SHong Zhang   *t = ts->ptime_prev;
4665e5e524a1SHong Zhang   PetscFunctionReturn(0);
4666e5e524a1SHong Zhang }
4667e5e524a1SHong Zhang 
46686a4d4014SLisandro Dalcin /*@
46696a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
46706a4d4014SLisandro Dalcin 
46713f9fe445SBarry Smith    Logically Collective on TS
46726a4d4014SLisandro Dalcin 
46736a4d4014SLisandro Dalcin    Input Parameters:
46746a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
46756a4d4014SLisandro Dalcin -  time - the time
46766a4d4014SLisandro Dalcin 
46776a4d4014SLisandro Dalcin    Level: intermediate
46786a4d4014SLisandro Dalcin 
46796a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
46806a4d4014SLisandro Dalcin 
46816a4d4014SLisandro Dalcin .keywords: TS, set, time
46826a4d4014SLisandro Dalcin @*/
46837087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
46846a4d4014SLisandro Dalcin {
46856a4d4014SLisandro Dalcin   PetscFunctionBegin;
46860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4687c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
46886a4d4014SLisandro Dalcin   ts->ptime = t;
46896a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
46906a4d4014SLisandro Dalcin }
46916a4d4014SLisandro Dalcin 
4692d763cef2SBarry Smith /*@C
4693d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4694d763cef2SBarry Smith    TS options in the database.
4695d763cef2SBarry Smith 
46963f9fe445SBarry Smith    Logically Collective on TS
4697d763cef2SBarry Smith 
4698d763cef2SBarry Smith    Input Parameter:
4699d763cef2SBarry Smith +  ts     - The TS context
4700d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4701d763cef2SBarry Smith 
4702d763cef2SBarry Smith    Notes:
4703d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4704d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4705d763cef2SBarry Smith    hyphen.
4706d763cef2SBarry Smith 
4707d763cef2SBarry Smith    Level: advanced
4708d763cef2SBarry Smith 
4709d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4710d763cef2SBarry Smith 
4711d763cef2SBarry Smith .seealso: TSSetFromOptions()
4712d763cef2SBarry Smith 
4713d763cef2SBarry Smith @*/
47147087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4715d763cef2SBarry Smith {
4716dfbe8321SBarry Smith   PetscErrorCode ierr;
4717089b2837SJed Brown   SNES           snes;
4718d763cef2SBarry Smith 
4719d763cef2SBarry Smith   PetscFunctionBegin;
47200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4721d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4722089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4723089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4724d763cef2SBarry Smith   PetscFunctionReturn(0);
4725d763cef2SBarry Smith }
4726d763cef2SBarry Smith 
4727d763cef2SBarry Smith /*@C
4728d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4729d763cef2SBarry Smith    TS options in the database.
4730d763cef2SBarry Smith 
47313f9fe445SBarry Smith    Logically Collective on TS
4732d763cef2SBarry Smith 
4733d763cef2SBarry Smith    Input Parameter:
4734d763cef2SBarry Smith +  ts     - The TS context
4735d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4736d763cef2SBarry Smith 
4737d763cef2SBarry Smith    Notes:
4738d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4739d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4740d763cef2SBarry Smith    hyphen.
4741d763cef2SBarry Smith 
4742d763cef2SBarry Smith    Level: advanced
4743d763cef2SBarry Smith 
4744d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4745d763cef2SBarry Smith 
4746d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4747d763cef2SBarry Smith 
4748d763cef2SBarry Smith @*/
47497087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4750d763cef2SBarry Smith {
4751dfbe8321SBarry Smith   PetscErrorCode ierr;
4752089b2837SJed Brown   SNES           snes;
4753d763cef2SBarry Smith 
4754d763cef2SBarry Smith   PetscFunctionBegin;
47550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4756d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4757089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4758089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4759d763cef2SBarry Smith   PetscFunctionReturn(0);
4760d763cef2SBarry Smith }
4761d763cef2SBarry Smith 
4762d763cef2SBarry Smith /*@C
4763d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4764d763cef2SBarry Smith    TS options in the database.
4765d763cef2SBarry Smith 
4766d763cef2SBarry Smith    Not Collective
4767d763cef2SBarry Smith 
4768d763cef2SBarry Smith    Input Parameter:
4769d763cef2SBarry Smith .  ts - The TS context
4770d763cef2SBarry Smith 
4771d763cef2SBarry Smith    Output Parameter:
4772d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4773d763cef2SBarry Smith 
4774d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
4775d763cef2SBarry Smith    sufficient length to hold the prefix.
4776d763cef2SBarry Smith 
4777d763cef2SBarry Smith    Level: intermediate
4778d763cef2SBarry Smith 
4779d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4780d763cef2SBarry Smith 
4781d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4782d763cef2SBarry Smith @*/
47837087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4784d763cef2SBarry Smith {
4785dfbe8321SBarry Smith   PetscErrorCode ierr;
4786d763cef2SBarry Smith 
4787d763cef2SBarry Smith   PetscFunctionBegin;
47880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47894482741eSBarry Smith   PetscValidPointer(prefix,2);
4790d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4791d763cef2SBarry Smith   PetscFunctionReturn(0);
4792d763cef2SBarry Smith }
4793d763cef2SBarry Smith 
4794d763cef2SBarry Smith /*@C
4795d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4796d763cef2SBarry Smith 
4797d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4798d763cef2SBarry Smith 
4799d763cef2SBarry Smith    Input Parameter:
4800d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4801d763cef2SBarry Smith 
4802d763cef2SBarry Smith    Output Parameters:
4803e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4804e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4805e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4806e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4807d763cef2SBarry Smith 
48080298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
4809d763cef2SBarry Smith 
4810d763cef2SBarry Smith    Level: intermediate
4811d763cef2SBarry Smith 
481226d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
4813d763cef2SBarry Smith 
4814d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4815d763cef2SBarry Smith @*/
4816e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4817d763cef2SBarry Smith {
4818089b2837SJed Brown   PetscErrorCode ierr;
481924989b8cSPeter Brune   DM             dm;
4820089b2837SJed Brown 
4821d763cef2SBarry Smith   PetscFunctionBegin;
482223a57915SBarry Smith   if (Amat || Pmat) {
482323a57915SBarry Smith     SNES snes;
4824089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
482523a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4826e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
482723a57915SBarry Smith   }
482824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
482924989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4830d763cef2SBarry Smith   PetscFunctionReturn(0);
4831d763cef2SBarry Smith }
4832d763cef2SBarry Smith 
48332eca1d9cSJed Brown /*@C
48342eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
48352eca1d9cSJed Brown 
48362eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
48372eca1d9cSJed Brown 
48382eca1d9cSJed Brown    Input Parameter:
48392eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
48402eca1d9cSJed Brown 
48412eca1d9cSJed Brown    Output Parameters:
4842e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4843e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
48442eca1d9cSJed Brown .  f   - The function to compute the matrices
48452eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
48462eca1d9cSJed Brown 
48470298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
48482eca1d9cSJed Brown 
48492eca1d9cSJed Brown    Level: advanced
48502eca1d9cSJed Brown 
48512eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
48522eca1d9cSJed Brown 
48532eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
48542eca1d9cSJed Brown @*/
4855e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
48562eca1d9cSJed Brown {
4857089b2837SJed Brown   PetscErrorCode ierr;
485824989b8cSPeter Brune   DM             dm;
48590910c330SBarry Smith 
48602eca1d9cSJed Brown   PetscFunctionBegin;
4861c0aab802Sstefano_zampini   if (Amat || Pmat) {
4862c0aab802Sstefano_zampini     SNES snes;
4863089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4864f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4865e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4866c0aab802Sstefano_zampini   }
486724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
486824989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
48692eca1d9cSJed Brown   PetscFunctionReturn(0);
48702eca1d9cSJed Brown }
48712eca1d9cSJed Brown 
48721713a123SBarry Smith /*@C
487383a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
48741713a123SBarry Smith    VecView() for the solution at each timestep
48751713a123SBarry Smith 
48761713a123SBarry Smith    Collective on TS
48771713a123SBarry Smith 
48781713a123SBarry Smith    Input Parameters:
48791713a123SBarry Smith +  ts - the TS context
48801713a123SBarry Smith .  step - current time-step
4881142b95e3SSatish Balay .  ptime - current time
48820298fd71SBarry Smith -  dummy - either a viewer or NULL
48831713a123SBarry Smith 
488499fdda47SBarry Smith    Options Database:
488599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
488699fdda47SBarry Smith 
4887387f4636SBarry 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
488899fdda47SBarry Smith        will look bad
488999fdda47SBarry Smith 
48901713a123SBarry Smith    Level: intermediate
48911713a123SBarry Smith 
48921713a123SBarry Smith .keywords: TS,  vector, monitor, view
48931713a123SBarry Smith 
4894a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
48951713a123SBarry Smith @*/
48960910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
48971713a123SBarry Smith {
4898dfbe8321SBarry Smith   PetscErrorCode   ierr;
489983a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4900473a3ab2SBarry Smith   PetscDraw        draw;
49011713a123SBarry Smith 
49021713a123SBarry Smith   PetscFunctionBegin;
49036083293cSBarry Smith   if (!step && ictx->showinitial) {
49046083293cSBarry Smith     if (!ictx->initialsolution) {
49050910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
49061713a123SBarry Smith     }
49070910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
49086083293cSBarry Smith   }
4909b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
49100dcf80beSBarry Smith 
49116083293cSBarry Smith   if (ictx->showinitial) {
49126083293cSBarry Smith     PetscReal pause;
49136083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
49146083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
49156083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
49166083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
49176083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
49186083293cSBarry Smith   }
49190910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4920473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
492151fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4922473a3ab2SBarry Smith     char      time[32];
4923473a3ab2SBarry Smith 
4924473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
492585b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4926473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4927473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
492851fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4929473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4930473a3ab2SBarry Smith   }
4931473a3ab2SBarry Smith 
49326083293cSBarry Smith   if (ictx->showinitial) {
49336083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
49346083293cSBarry Smith   }
49351713a123SBarry Smith   PetscFunctionReturn(0);
49361713a123SBarry Smith }
49371713a123SBarry Smith 
49389110b2e7SHong Zhang /*@C
49399110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
49409110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
49419110b2e7SHong Zhang 
49429110b2e7SHong Zhang    Collective on TS
49439110b2e7SHong Zhang 
49449110b2e7SHong Zhang    Input Parameters:
49459110b2e7SHong Zhang +  ts - the TS context
49469110b2e7SHong Zhang .  step - current time-step
49479110b2e7SHong Zhang .  ptime - current time
49489110b2e7SHong Zhang .  u - current state
49499110b2e7SHong Zhang .  numcost - number of cost functions
49509110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
49519110b2e7SHong Zhang .  mu - sensitivities to parameters
49529110b2e7SHong Zhang -  dummy - either a viewer or NULL
49539110b2e7SHong Zhang 
49549110b2e7SHong Zhang    Level: intermediate
49559110b2e7SHong Zhang 
49569110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
49579110b2e7SHong Zhang 
49589110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
49599110b2e7SHong Zhang @*/
49609110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
49619110b2e7SHong Zhang {
49629110b2e7SHong Zhang   PetscErrorCode   ierr;
49639110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
49649110b2e7SHong Zhang   PetscDraw        draw;
4965a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4966a0046e2cSSatish Balay   char             time[32];
49679110b2e7SHong Zhang 
49689110b2e7SHong Zhang   PetscFunctionBegin;
49699110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
49709110b2e7SHong Zhang 
49719110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
49729110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
49739110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
49749110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
49759110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
49769110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
49779110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
49789110b2e7SHong Zhang   PetscFunctionReturn(0);
49799110b2e7SHong Zhang }
49809110b2e7SHong Zhang 
49812d5ee99bSBarry Smith /*@C
49822d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
49832d5ee99bSBarry Smith 
49842d5ee99bSBarry Smith    Collective on TS
49852d5ee99bSBarry Smith 
49862d5ee99bSBarry Smith    Input Parameters:
49872d5ee99bSBarry Smith +  ts - the TS context
49882d5ee99bSBarry Smith .  step - current time-step
49892d5ee99bSBarry Smith .  ptime - current time
49902d5ee99bSBarry Smith -  dummy - either a viewer or NULL
49912d5ee99bSBarry Smith 
49922d5ee99bSBarry Smith    Level: intermediate
49932d5ee99bSBarry Smith 
49942d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
49952d5ee99bSBarry Smith 
49962d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
49972d5ee99bSBarry Smith @*/
49982d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
49992d5ee99bSBarry Smith {
50002d5ee99bSBarry Smith   PetscErrorCode    ierr;
50012d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
50022d5ee99bSBarry Smith   PetscDraw         draw;
50036934998bSLisandro Dalcin   PetscDrawAxis     axis;
50042d5ee99bSBarry Smith   PetscInt          n;
50052d5ee99bSBarry Smith   PetscMPIInt       size;
50066934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
50072d5ee99bSBarry Smith   char              time[32];
50082d5ee99bSBarry Smith   const PetscScalar *U;
50092d5ee99bSBarry Smith 
50102d5ee99bSBarry Smith   PetscFunctionBegin;
50116934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
50126934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
50132d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
50146934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
50152d5ee99bSBarry Smith 
50162d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
50176934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
50186934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
50196934998bSLisandro Dalcin   if (!step) {
50206934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
50216934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
50226934998bSLisandro Dalcin   }
50232d5ee99bSBarry Smith 
50242d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
50256934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
50266934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
5027a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
50286934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
50292d5ee99bSBarry Smith 
50306934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
50316934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
50322d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
50334b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
503485b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
50352d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
503651fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
50372d5ee99bSBarry Smith   }
50386934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
50392d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
504056d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
50416934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
50422d5ee99bSBarry Smith   PetscFunctionReturn(0);
50432d5ee99bSBarry Smith }
50442d5ee99bSBarry Smith 
50456083293cSBarry Smith /*@C
504683a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
50476083293cSBarry Smith 
50486083293cSBarry Smith    Collective on TS
50496083293cSBarry Smith 
50506083293cSBarry Smith    Input Parameters:
50516083293cSBarry Smith .    ctx - the monitor context
50526083293cSBarry Smith 
50536083293cSBarry Smith    Level: intermediate
50546083293cSBarry Smith 
50556083293cSBarry Smith .keywords: TS,  vector, monitor, view
50566083293cSBarry Smith 
505783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
50586083293cSBarry Smith @*/
505983a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
50606083293cSBarry Smith {
50616083293cSBarry Smith   PetscErrorCode ierr;
50626083293cSBarry Smith 
50636083293cSBarry Smith   PetscFunctionBegin;
506483a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
506583a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
506683a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
50676083293cSBarry Smith   PetscFunctionReturn(0);
50686083293cSBarry Smith }
50696083293cSBarry Smith 
50706083293cSBarry Smith /*@C
507183a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
50726083293cSBarry Smith 
50736083293cSBarry Smith    Collective on TS
50746083293cSBarry Smith 
50756083293cSBarry Smith    Input Parameter:
50766083293cSBarry Smith .    ts - time-step context
50776083293cSBarry Smith 
50786083293cSBarry Smith    Output Patameter:
50796083293cSBarry Smith .    ctx - the monitor context
50806083293cSBarry Smith 
508199fdda47SBarry Smith    Options Database:
508299fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
508399fdda47SBarry Smith 
50846083293cSBarry Smith    Level: intermediate
50856083293cSBarry Smith 
50866083293cSBarry Smith .keywords: TS,  vector, monitor, view
50876083293cSBarry Smith 
508883a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
50896083293cSBarry Smith @*/
509083a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
50916083293cSBarry Smith {
50926083293cSBarry Smith   PetscErrorCode   ierr;
50936083293cSBarry Smith 
50946083293cSBarry Smith   PetscFunctionBegin;
5095b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
509683a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
5097e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
5098bbd56ea5SKarl Rupp 
509983a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
5100473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
5101c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
5102473a3ab2SBarry Smith 
5103473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
5104c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
51056083293cSBarry Smith   PetscFunctionReturn(0);
51066083293cSBarry Smith }
51076083293cSBarry Smith 
51083a471f94SBarry Smith /*@C
510983a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
51103a471f94SBarry Smith    VecView() for the error at each timestep
51113a471f94SBarry Smith 
51123a471f94SBarry Smith    Collective on TS
51133a471f94SBarry Smith 
51143a471f94SBarry Smith    Input Parameters:
51153a471f94SBarry Smith +  ts - the TS context
51163a471f94SBarry Smith .  step - current time-step
51173a471f94SBarry Smith .  ptime - current time
51180298fd71SBarry Smith -  dummy - either a viewer or NULL
51193a471f94SBarry Smith 
51203a471f94SBarry Smith    Level: intermediate
51213a471f94SBarry Smith 
51223a471f94SBarry Smith .keywords: TS,  vector, monitor, view
51233a471f94SBarry Smith 
51243a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
51253a471f94SBarry Smith @*/
51260910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
51273a471f94SBarry Smith {
51283a471f94SBarry Smith   PetscErrorCode   ierr;
512983a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
513083a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
51313a471f94SBarry Smith   Vec              work;
51323a471f94SBarry Smith 
51333a471f94SBarry Smith   PetscFunctionBegin;
5134b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
51350910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
51363a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
51370910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
51383a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
51393a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
51403a471f94SBarry Smith   PetscFunctionReturn(0);
51413a471f94SBarry Smith }
51423a471f94SBarry Smith 
5143af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
51446c699258SBarry Smith /*@
51452a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
51466c699258SBarry Smith 
51473f9fe445SBarry Smith    Logically Collective on TS and DM
51486c699258SBarry Smith 
51496c699258SBarry Smith    Input Parameters:
51502a808120SBarry Smith +  ts - the ODE integrator object
51512a808120SBarry Smith -  dm - the dm, cannot be NULL
51526c699258SBarry Smith 
51536c699258SBarry Smith    Level: intermediate
51546c699258SBarry Smith 
51556c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
51566c699258SBarry Smith @*/
51577087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
51586c699258SBarry Smith {
51596c699258SBarry Smith   PetscErrorCode ierr;
5160089b2837SJed Brown   SNES           snes;
5161942e3340SBarry Smith   DMTS           tsdm;
51626c699258SBarry Smith 
51636c699258SBarry Smith   PetscFunctionBegin;
51640700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
51652a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
516670663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
5167942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
51682a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
5169942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
5170942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
517124989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
517224989b8cSPeter Brune         tsdm->originaldm = dm;
517324989b8cSPeter Brune       }
517424989b8cSPeter Brune     }
51756bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
517624989b8cSPeter Brune   }
51776c699258SBarry Smith   ts->dm = dm;
5178bbd56ea5SKarl Rupp 
5179089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5180089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
51816c699258SBarry Smith   PetscFunctionReturn(0);
51826c699258SBarry Smith }
51836c699258SBarry Smith 
51846c699258SBarry Smith /*@
51856c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
51866c699258SBarry Smith 
51873f9fe445SBarry Smith    Not Collective
51886c699258SBarry Smith 
51896c699258SBarry Smith    Input Parameter:
51906c699258SBarry Smith . ts - the preconditioner context
51916c699258SBarry Smith 
51926c699258SBarry Smith    Output Parameter:
51936c699258SBarry Smith .  dm - the dm
51946c699258SBarry Smith 
51956c699258SBarry Smith    Level: intermediate
51966c699258SBarry Smith 
51976c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
51986c699258SBarry Smith @*/
51997087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
52006c699258SBarry Smith {
5201496e6a7aSJed Brown   PetscErrorCode ierr;
5202496e6a7aSJed Brown 
52036c699258SBarry Smith   PetscFunctionBegin;
52040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5205496e6a7aSJed Brown   if (!ts->dm) {
5206ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
5207496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
5208496e6a7aSJed Brown   }
52096c699258SBarry Smith   *dm = ts->dm;
52106c699258SBarry Smith   PetscFunctionReturn(0);
52116c699258SBarry Smith }
52121713a123SBarry Smith 
52130f5c6efeSJed Brown /*@
52140f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
52150f5c6efeSJed Brown 
52163f9fe445SBarry Smith    Logically Collective on SNES
52170f5c6efeSJed Brown 
52180f5c6efeSJed Brown    Input Parameter:
5219d42a1c89SJed Brown + snes - nonlinear solver
52200910c330SBarry Smith . U - the current state at which to evaluate the residual
5221d42a1c89SJed Brown - ctx - user context, must be a TS
52220f5c6efeSJed Brown 
52230f5c6efeSJed Brown    Output Parameter:
52240f5c6efeSJed Brown . F - the nonlinear residual
52250f5c6efeSJed Brown 
52260f5c6efeSJed Brown    Notes:
52270f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
52280f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
52290f5c6efeSJed Brown 
52300f5c6efeSJed Brown    Level: advanced
52310f5c6efeSJed Brown 
52320f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
52330f5c6efeSJed Brown @*/
52340910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
52350f5c6efeSJed Brown {
52360f5c6efeSJed Brown   TS             ts = (TS)ctx;
52370f5c6efeSJed Brown   PetscErrorCode ierr;
52380f5c6efeSJed Brown 
52390f5c6efeSJed Brown   PetscFunctionBegin;
52400f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
52410910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
52420f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
52430f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
52440910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
52450f5c6efeSJed Brown   PetscFunctionReturn(0);
52460f5c6efeSJed Brown }
52470f5c6efeSJed Brown 
52480f5c6efeSJed Brown /*@
52490f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
52500f5c6efeSJed Brown 
52510f5c6efeSJed Brown    Collective on SNES
52520f5c6efeSJed Brown 
52530f5c6efeSJed Brown    Input Parameter:
52540f5c6efeSJed Brown + snes - nonlinear solver
52550910c330SBarry Smith . U - the current state at which to evaluate the residual
52560f5c6efeSJed Brown - ctx - user context, must be a TS
52570f5c6efeSJed Brown 
52580f5c6efeSJed Brown    Output Parameter:
52590f5c6efeSJed Brown + A - the Jacobian
52600f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
52610f5c6efeSJed Brown - flag - indicates any structure change in the matrix
52620f5c6efeSJed Brown 
52630f5c6efeSJed Brown    Notes:
52640f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
52650f5c6efeSJed Brown 
52660f5c6efeSJed Brown    Level: developer
52670f5c6efeSJed Brown 
52680f5c6efeSJed Brown .seealso: SNESSetJacobian()
52690f5c6efeSJed Brown @*/
5270d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
52710f5c6efeSJed Brown {
52720f5c6efeSJed Brown   TS             ts = (TS)ctx;
52730f5c6efeSJed Brown   PetscErrorCode ierr;
52740f5c6efeSJed Brown 
52750f5c6efeSJed Brown   PetscFunctionBegin;
52760f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
52770910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
52780f5c6efeSJed Brown   PetscValidPointer(A,3);
527994ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
52800f5c6efeSJed Brown   PetscValidPointer(B,4);
528194ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
52820f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
5283d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
52840f5c6efeSJed Brown   PetscFunctionReturn(0);
52850f5c6efeSJed Brown }
5286325fc9f4SBarry Smith 
52870e4ef248SJed Brown /*@C
52889ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
52890e4ef248SJed Brown 
52900e4ef248SJed Brown    Collective on TS
52910e4ef248SJed Brown 
52920e4ef248SJed Brown    Input Arguments:
52930e4ef248SJed Brown +  ts - time stepping context
52940e4ef248SJed Brown .  t - time at which to evaluate
52950910c330SBarry Smith .  U - state at which to evaluate
52960e4ef248SJed Brown -  ctx - context
52970e4ef248SJed Brown 
52980e4ef248SJed Brown    Output Arguments:
52990e4ef248SJed Brown .  F - right hand side
53000e4ef248SJed Brown 
53010e4ef248SJed Brown    Level: intermediate
53020e4ef248SJed Brown 
53030e4ef248SJed Brown    Notes:
53040e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
53050e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
53060e4ef248SJed Brown 
53070e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
53080e4ef248SJed Brown @*/
53090910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
53100e4ef248SJed Brown {
53110e4ef248SJed Brown   PetscErrorCode ierr;
53120e4ef248SJed Brown   Mat            Arhs,Brhs;
53130e4ef248SJed Brown 
53140e4ef248SJed Brown   PetscFunctionBegin;
53150e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
5316d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
53170910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
53180e4ef248SJed Brown   PetscFunctionReturn(0);
53190e4ef248SJed Brown }
53200e4ef248SJed Brown 
53210e4ef248SJed Brown /*@C
53220e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
53230e4ef248SJed Brown 
53240e4ef248SJed Brown    Collective on TS
53250e4ef248SJed Brown 
53260e4ef248SJed Brown    Input Arguments:
53270e4ef248SJed Brown +  ts - time stepping context
53280e4ef248SJed Brown .  t - time at which to evaluate
53290910c330SBarry Smith .  U - state at which to evaluate
53300e4ef248SJed Brown -  ctx - context
53310e4ef248SJed Brown 
53320e4ef248SJed Brown    Output Arguments:
53330e4ef248SJed Brown +  A - pointer to operator
53340e4ef248SJed Brown .  B - pointer to preconditioning matrix
53350e4ef248SJed Brown -  flg - matrix structure flag
53360e4ef248SJed Brown 
53370e4ef248SJed Brown    Level: intermediate
53380e4ef248SJed Brown 
53390e4ef248SJed Brown    Notes:
53400e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
53410e4ef248SJed Brown 
53420e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
53430e4ef248SJed Brown @*/
5344d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
53450e4ef248SJed Brown {
53460e4ef248SJed Brown   PetscFunctionBegin;
53470e4ef248SJed Brown   PetscFunctionReturn(0);
53480e4ef248SJed Brown }
53490e4ef248SJed Brown 
53500026cea9SSean Farley /*@C
53510026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
53520026cea9SSean Farley 
53530026cea9SSean Farley    Collective on TS
53540026cea9SSean Farley 
53550026cea9SSean Farley    Input Arguments:
53560026cea9SSean Farley +  ts - time stepping context
53570026cea9SSean Farley .  t - time at which to evaluate
53580910c330SBarry Smith .  U - state at which to evaluate
53590910c330SBarry Smith .  Udot - time derivative of state vector
53600026cea9SSean Farley -  ctx - context
53610026cea9SSean Farley 
53620026cea9SSean Farley    Output Arguments:
53630026cea9SSean Farley .  F - left hand side
53640026cea9SSean Farley 
53650026cea9SSean Farley    Level: intermediate
53660026cea9SSean Farley 
53670026cea9SSean Farley    Notes:
53680910c330SBarry 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
53690026cea9SSean Farley    user is required to write their own TSComputeIFunction.
53700026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
53710026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
53720026cea9SSean Farley 
53739ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
53749ae8fd06SBarry Smith 
53759ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
53760026cea9SSean Farley @*/
53770910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
53780026cea9SSean Farley {
53790026cea9SSean Farley   PetscErrorCode ierr;
53800026cea9SSean Farley   Mat            A,B;
53810026cea9SSean Farley 
53820026cea9SSean Farley   PetscFunctionBegin;
53830298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
5384d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
53850910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
53860026cea9SSean Farley   PetscFunctionReturn(0);
53870026cea9SSean Farley }
53880026cea9SSean Farley 
53890026cea9SSean Farley /*@C
5390b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
53910026cea9SSean Farley 
53920026cea9SSean Farley    Collective on TS
53930026cea9SSean Farley 
53940026cea9SSean Farley    Input Arguments:
53950026cea9SSean Farley +  ts - time stepping context
53960026cea9SSean Farley .  t - time at which to evaluate
53970910c330SBarry Smith .  U - state at which to evaluate
53980910c330SBarry Smith .  Udot - time derivative of state vector
53990026cea9SSean Farley .  shift - shift to apply
54000026cea9SSean Farley -  ctx - context
54010026cea9SSean Farley 
54020026cea9SSean Farley    Output Arguments:
54030026cea9SSean Farley +  A - pointer to operator
54040026cea9SSean Farley .  B - pointer to preconditioning matrix
54050026cea9SSean Farley -  flg - matrix structure flag
54060026cea9SSean Farley 
5407b41af12eSJed Brown    Level: advanced
54080026cea9SSean Farley 
54090026cea9SSean Farley    Notes:
54100026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
54110026cea9SSean Farley 
5412b41af12eSJed Brown    It is only appropriate for problems of the form
5413b41af12eSJed Brown 
5414b41af12eSJed Brown $     M Udot = F(U,t)
5415b41af12eSJed Brown 
5416b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
5417b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
5418b41af12eSJed Brown   an implicit operator of the form
5419b41af12eSJed Brown 
5420b41af12eSJed Brown $    shift*M + J
5421b41af12eSJed Brown 
5422b41af12eSJed 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
5423b41af12eSJed Brown   a copy of M or reassemble it when requested.
5424b41af12eSJed Brown 
54250026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
54260026cea9SSean Farley @*/
5427d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
54280026cea9SSean Farley {
5429b41af12eSJed Brown   PetscErrorCode ierr;
5430b41af12eSJed Brown 
54310026cea9SSean Farley   PetscFunctionBegin;
543294ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
5433b41af12eSJed Brown   ts->ijacobian.shift = shift;
54340026cea9SSean Farley   PetscFunctionReturn(0);
54350026cea9SSean Farley }
5436b41af12eSJed Brown 
5437e817cc15SEmil Constantinescu /*@
5438e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
5439e817cc15SEmil Constantinescu 
5440e817cc15SEmil Constantinescu    Not Collective
5441e817cc15SEmil Constantinescu 
5442e817cc15SEmil Constantinescu    Input Parameter:
5443e817cc15SEmil Constantinescu .  ts - the TS context
5444e817cc15SEmil Constantinescu 
5445e817cc15SEmil Constantinescu    Output Parameter:
54464e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
5447e817cc15SEmil Constantinescu 
5448e817cc15SEmil Constantinescu    Level: beginner
5449e817cc15SEmil Constantinescu 
5450e817cc15SEmil Constantinescu .keywords: TS, equation type
5451e817cc15SEmil Constantinescu 
5452e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
5453e817cc15SEmil Constantinescu @*/
5454e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
5455e817cc15SEmil Constantinescu {
5456e817cc15SEmil Constantinescu   PetscFunctionBegin;
5457e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5458e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
5459e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
5460e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5461e817cc15SEmil Constantinescu }
5462e817cc15SEmil Constantinescu 
5463e817cc15SEmil Constantinescu /*@
5464e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
5465e817cc15SEmil Constantinescu 
5466e817cc15SEmil Constantinescu    Not Collective
5467e817cc15SEmil Constantinescu 
5468e817cc15SEmil Constantinescu    Input Parameter:
5469e817cc15SEmil Constantinescu +  ts - the TS context
54701297b224SEmil Constantinescu -  equation_type - see TSEquationType
5471e817cc15SEmil Constantinescu 
5472e817cc15SEmil Constantinescu    Level: advanced
5473e817cc15SEmil Constantinescu 
5474e817cc15SEmil Constantinescu .keywords: TS, equation type
5475e817cc15SEmil Constantinescu 
5476e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
5477e817cc15SEmil Constantinescu @*/
5478e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
5479e817cc15SEmil Constantinescu {
5480e817cc15SEmil Constantinescu   PetscFunctionBegin;
5481e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5482e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
5483e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
5484e817cc15SEmil Constantinescu }
54850026cea9SSean Farley 
54864af1b03aSJed Brown /*@
54874af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
54884af1b03aSJed Brown 
54894af1b03aSJed Brown    Not Collective
54904af1b03aSJed Brown 
54914af1b03aSJed Brown    Input Parameter:
54924af1b03aSJed Brown .  ts - the TS context
54934af1b03aSJed Brown 
54944af1b03aSJed Brown    Output Parameter:
54954af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
54964af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
54974af1b03aSJed Brown 
5498487e0bb9SJed Brown    Level: beginner
54994af1b03aSJed Brown 
5500cd652676SJed Brown    Notes:
5501cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
55024af1b03aSJed Brown 
55034af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
55044af1b03aSJed Brown 
55054af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
55064af1b03aSJed Brown @*/
55074af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
55084af1b03aSJed Brown {
55094af1b03aSJed Brown   PetscFunctionBegin;
55104af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55114af1b03aSJed Brown   PetscValidPointer(reason,2);
55124af1b03aSJed Brown   *reason = ts->reason;
55134af1b03aSJed Brown   PetscFunctionReturn(0);
55144af1b03aSJed Brown }
55154af1b03aSJed Brown 
5516d6ad946cSShri Abhyankar /*@
5517d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
5518d6ad946cSShri Abhyankar 
5519d6ad946cSShri Abhyankar    Not Collective
5520d6ad946cSShri Abhyankar 
5521d6ad946cSShri Abhyankar    Input Parameter:
5522d6ad946cSShri Abhyankar +  ts - the TS context
5523d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
5524d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
5525d6ad946cSShri Abhyankar 
5526f5abba47SShri Abhyankar    Level: advanced
5527d6ad946cSShri Abhyankar 
5528d6ad946cSShri Abhyankar    Notes:
5529d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
5530d6ad946cSShri Abhyankar 
5531d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
5532d6ad946cSShri Abhyankar 
5533d6ad946cSShri Abhyankar .seealso: TSConvergedReason
5534d6ad946cSShri Abhyankar @*/
5535d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
5536d6ad946cSShri Abhyankar {
5537d6ad946cSShri Abhyankar   PetscFunctionBegin;
5538d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5539d6ad946cSShri Abhyankar   ts->reason = reason;
5540d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
5541d6ad946cSShri Abhyankar }
5542d6ad946cSShri Abhyankar 
5543cc708dedSBarry Smith /*@
5544cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
5545cc708dedSBarry Smith 
5546cc708dedSBarry Smith    Not Collective
5547cc708dedSBarry Smith 
5548cc708dedSBarry Smith    Input Parameter:
5549cc708dedSBarry Smith .  ts - the TS context
5550cc708dedSBarry Smith 
5551cc708dedSBarry Smith    Output Parameter:
555263e21af5SBarry Smith .  ftime - the final time. This time corresponds to the final time set with TSSetDuration()
5553cc708dedSBarry Smith 
5554487e0bb9SJed Brown    Level: beginner
5555cc708dedSBarry Smith 
5556cc708dedSBarry Smith    Notes:
5557cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
5558cc708dedSBarry Smith 
5559cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
5560cc708dedSBarry Smith 
5561cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
5562cc708dedSBarry Smith @*/
5563cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
5564cc708dedSBarry Smith {
5565cc708dedSBarry Smith   PetscFunctionBegin;
5566cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5567cc708dedSBarry Smith   PetscValidPointer(ftime,2);
5568cc708dedSBarry Smith   *ftime = ts->solvetime;
5569cc708dedSBarry Smith   PetscFunctionReturn(0);
5570cc708dedSBarry Smith }
5571cc708dedSBarry Smith 
55722c18e0fdSBarry Smith /*@
55732c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
55742c18e0fdSBarry Smith 
55752c18e0fdSBarry Smith    Not Collective
55762c18e0fdSBarry Smith 
55772c18e0fdSBarry Smith    Input Parameter:
55782c18e0fdSBarry Smith .  ts - the TS context
55792c18e0fdSBarry Smith 
55802c18e0fdSBarry Smith    Output Parameter:
55812c18e0fdSBarry Smith .  steps - the number of steps
55822c18e0fdSBarry Smith 
55832c18e0fdSBarry Smith    Level: beginner
55842c18e0fdSBarry Smith 
55852c18e0fdSBarry Smith    Notes:
55862c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
55872c18e0fdSBarry Smith 
55882c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
55892c18e0fdSBarry Smith 
55902c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
55912c18e0fdSBarry Smith @*/
55922c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
55932c18e0fdSBarry Smith {
55942c18e0fdSBarry Smith   PetscFunctionBegin;
55952c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55962c18e0fdSBarry Smith   PetscValidPointer(steps,2);
55972c18e0fdSBarry Smith   *steps = ts->total_steps;
55982c18e0fdSBarry Smith   PetscFunctionReturn(0);
55992c18e0fdSBarry Smith }
56002c18e0fdSBarry Smith 
56019f67acb7SJed Brown /*@
56025ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
56039f67acb7SJed Brown    used by the time integrator.
56049f67acb7SJed Brown 
56059f67acb7SJed Brown    Not Collective
56069f67acb7SJed Brown 
56079f67acb7SJed Brown    Input Parameter:
56089f67acb7SJed Brown .  ts - TS context
56099f67acb7SJed Brown 
56109f67acb7SJed Brown    Output Parameter:
56119f67acb7SJed Brown .  nits - number of nonlinear iterations
56129f67acb7SJed Brown 
56139f67acb7SJed Brown    Notes:
56149f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
56159f67acb7SJed Brown 
56169f67acb7SJed Brown    Level: intermediate
56179f67acb7SJed Brown 
56189f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
56199f67acb7SJed Brown 
56205ef26d82SJed Brown .seealso:  TSGetKSPIterations()
56219f67acb7SJed Brown @*/
56225ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
56239f67acb7SJed Brown {
56249f67acb7SJed Brown   PetscFunctionBegin;
56259f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56269f67acb7SJed Brown   PetscValidIntPointer(nits,2);
56275ef26d82SJed Brown   *nits = ts->snes_its;
56289f67acb7SJed Brown   PetscFunctionReturn(0);
56299f67acb7SJed Brown }
56309f67acb7SJed Brown 
56319f67acb7SJed Brown /*@
56325ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
56339f67acb7SJed Brown    used by the time integrator.
56349f67acb7SJed Brown 
56359f67acb7SJed Brown    Not Collective
56369f67acb7SJed Brown 
56379f67acb7SJed Brown    Input Parameter:
56389f67acb7SJed Brown .  ts - TS context
56399f67acb7SJed Brown 
56409f67acb7SJed Brown    Output Parameter:
56419f67acb7SJed Brown .  lits - number of linear iterations
56429f67acb7SJed Brown 
56439f67acb7SJed Brown    Notes:
56449f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
56459f67acb7SJed Brown 
56469f67acb7SJed Brown    Level: intermediate
56479f67acb7SJed Brown 
56489f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
56499f67acb7SJed Brown 
56505ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
56519f67acb7SJed Brown @*/
56525ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
56539f67acb7SJed Brown {
56549f67acb7SJed Brown   PetscFunctionBegin;
56559f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56569f67acb7SJed Brown   PetscValidIntPointer(lits,2);
56575ef26d82SJed Brown   *lits = ts->ksp_its;
56589f67acb7SJed Brown   PetscFunctionReturn(0);
56599f67acb7SJed Brown }
56609f67acb7SJed Brown 
5661cef5090cSJed Brown /*@
5662cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5663cef5090cSJed Brown 
5664cef5090cSJed Brown    Not Collective
5665cef5090cSJed Brown 
5666cef5090cSJed Brown    Input Parameter:
5667cef5090cSJed Brown .  ts - TS context
5668cef5090cSJed Brown 
5669cef5090cSJed Brown    Output Parameter:
5670cef5090cSJed Brown .  rejects - number of steps rejected
5671cef5090cSJed Brown 
5672cef5090cSJed Brown    Notes:
5673cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5674cef5090cSJed Brown 
5675cef5090cSJed Brown    Level: intermediate
5676cef5090cSJed Brown 
5677cef5090cSJed Brown .keywords: TS, get, number
5678cef5090cSJed Brown 
56795ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5680cef5090cSJed Brown @*/
5681cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5682cef5090cSJed Brown {
5683cef5090cSJed Brown   PetscFunctionBegin;
5684cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5685cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5686cef5090cSJed Brown   *rejects = ts->reject;
5687cef5090cSJed Brown   PetscFunctionReturn(0);
5688cef5090cSJed Brown }
5689cef5090cSJed Brown 
5690cef5090cSJed Brown /*@
5691cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5692cef5090cSJed Brown 
5693cef5090cSJed Brown    Not Collective
5694cef5090cSJed Brown 
5695cef5090cSJed Brown    Input Parameter:
5696cef5090cSJed Brown .  ts - TS context
5697cef5090cSJed Brown 
5698cef5090cSJed Brown    Output Parameter:
5699cef5090cSJed Brown .  fails - number of failed nonlinear solves
5700cef5090cSJed Brown 
5701cef5090cSJed Brown    Notes:
5702cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5703cef5090cSJed Brown 
5704cef5090cSJed Brown    Level: intermediate
5705cef5090cSJed Brown 
5706cef5090cSJed Brown .keywords: TS, get, number
5707cef5090cSJed Brown 
57085ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5709cef5090cSJed Brown @*/
5710cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5711cef5090cSJed Brown {
5712cef5090cSJed Brown   PetscFunctionBegin;
5713cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5714cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5715cef5090cSJed Brown   *fails = ts->num_snes_failures;
5716cef5090cSJed Brown   PetscFunctionReturn(0);
5717cef5090cSJed Brown }
5718cef5090cSJed Brown 
5719cef5090cSJed Brown /*@
5720cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5721cef5090cSJed Brown 
5722cef5090cSJed Brown    Not Collective
5723cef5090cSJed Brown 
5724cef5090cSJed Brown    Input Parameter:
5725cef5090cSJed Brown +  ts - TS context
5726cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5727cef5090cSJed Brown 
5728cef5090cSJed Brown    Notes:
5729cef5090cSJed Brown    The counter is reset to zero for each step
5730cef5090cSJed Brown 
5731cef5090cSJed Brown    Options Database Key:
5732cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5733cef5090cSJed Brown 
5734cef5090cSJed Brown    Level: intermediate
5735cef5090cSJed Brown 
5736cef5090cSJed Brown .keywords: TS, set, maximum, number
5737cef5090cSJed Brown 
57385ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5739cef5090cSJed Brown @*/
5740cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5741cef5090cSJed Brown {
5742cef5090cSJed Brown   PetscFunctionBegin;
5743cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5744cef5090cSJed Brown   ts->max_reject = rejects;
5745cef5090cSJed Brown   PetscFunctionReturn(0);
5746cef5090cSJed Brown }
5747cef5090cSJed Brown 
5748cef5090cSJed Brown /*@
5749cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5750cef5090cSJed Brown 
5751cef5090cSJed Brown    Not Collective
5752cef5090cSJed Brown 
5753cef5090cSJed Brown    Input Parameter:
5754cef5090cSJed Brown +  ts - TS context
5755cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5756cef5090cSJed Brown 
5757cef5090cSJed Brown    Notes:
5758cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5759cef5090cSJed Brown 
5760cef5090cSJed Brown    Options Database Key:
5761cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5762cef5090cSJed Brown 
5763cef5090cSJed Brown    Level: intermediate
5764cef5090cSJed Brown 
5765cef5090cSJed Brown .keywords: TS, set, maximum, number
5766cef5090cSJed Brown 
57675ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5768cef5090cSJed Brown @*/
5769cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5770cef5090cSJed Brown {
5771cef5090cSJed Brown   PetscFunctionBegin;
5772cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5773cef5090cSJed Brown   ts->max_snes_failures = fails;
5774cef5090cSJed Brown   PetscFunctionReturn(0);
5775cef5090cSJed Brown }
5776cef5090cSJed Brown 
5777cef5090cSJed Brown /*@
5778cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5779cef5090cSJed Brown 
5780cef5090cSJed Brown    Not Collective
5781cef5090cSJed Brown 
5782cef5090cSJed Brown    Input Parameter:
5783cef5090cSJed Brown +  ts - TS context
5784cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5785cef5090cSJed Brown 
5786cef5090cSJed Brown    Options Database Key:
5787cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5788cef5090cSJed Brown 
5789cef5090cSJed Brown    Level: intermediate
5790cef5090cSJed Brown 
5791cef5090cSJed Brown .keywords: TS, set, error
5792cef5090cSJed Brown 
57935ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5794cef5090cSJed Brown @*/
5795cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5796cef5090cSJed Brown {
5797cef5090cSJed Brown   PetscFunctionBegin;
5798cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5799cef5090cSJed Brown   ts->errorifstepfailed = err;
5800cef5090cSJed Brown   PetscFunctionReturn(0);
5801cef5090cSJed Brown }
5802cef5090cSJed Brown 
5803fb1732b5SBarry Smith /*@C
5804fde5950dSBarry 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
5805fb1732b5SBarry Smith 
5806fb1732b5SBarry Smith    Collective on TS
5807fb1732b5SBarry Smith 
5808fb1732b5SBarry Smith    Input Parameters:
5809fb1732b5SBarry Smith +  ts - the TS context
5810fb1732b5SBarry Smith .  step - current time-step
5811fb1732b5SBarry Smith .  ptime - current time
58120910c330SBarry Smith .  u - current state
5813721cd6eeSBarry Smith -  vf - viewer and its format
5814fb1732b5SBarry Smith 
5815fb1732b5SBarry Smith    Level: intermediate
5816fb1732b5SBarry Smith 
5817fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5818fb1732b5SBarry Smith 
5819fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5820fb1732b5SBarry Smith @*/
5821721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5822fb1732b5SBarry Smith {
5823fb1732b5SBarry Smith   PetscErrorCode ierr;
5824fb1732b5SBarry Smith 
5825fb1732b5SBarry Smith   PetscFunctionBegin;
5826721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5827721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5828721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5829ed81e22dSJed Brown   PetscFunctionReturn(0);
5830ed81e22dSJed Brown }
5831ed81e22dSJed Brown 
5832ed81e22dSJed Brown /*@C
5833ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5834ed81e22dSJed Brown 
5835ed81e22dSJed Brown    Collective on TS
5836ed81e22dSJed Brown 
5837ed81e22dSJed Brown    Input Parameters:
5838ed81e22dSJed Brown +  ts - the TS context
5839ed81e22dSJed Brown .  step - current time-step
5840ed81e22dSJed Brown .  ptime - current time
58410910c330SBarry Smith .  u - current state
5842ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5843ed81e22dSJed Brown 
5844ed81e22dSJed Brown    Level: intermediate
5845ed81e22dSJed Brown 
5846ed81e22dSJed Brown    Notes:
5847ed81e22dSJed 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.
5848ed81e22dSJed Brown    These are named according to the file name template.
5849ed81e22dSJed Brown 
5850ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5851ed81e22dSJed Brown 
5852ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5853ed81e22dSJed Brown 
5854ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5855ed81e22dSJed Brown @*/
58560910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5857ed81e22dSJed Brown {
5858ed81e22dSJed Brown   PetscErrorCode ierr;
5859ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5860ed81e22dSJed Brown   PetscViewer    viewer;
5861ed81e22dSJed Brown 
5862ed81e22dSJed Brown   PetscFunctionBegin;
586363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
58648caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5865ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
58660910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5867ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5868ed81e22dSJed Brown   PetscFunctionReturn(0);
5869ed81e22dSJed Brown }
5870ed81e22dSJed Brown 
5871ed81e22dSJed Brown /*@C
5872ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5873ed81e22dSJed Brown 
5874ed81e22dSJed Brown    Collective on TS
5875ed81e22dSJed Brown 
5876ed81e22dSJed Brown    Input Parameters:
5877ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5878ed81e22dSJed Brown 
5879ed81e22dSJed Brown    Level: intermediate
5880ed81e22dSJed Brown 
5881ed81e22dSJed Brown    Note:
5882ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5883ed81e22dSJed Brown 
5884ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5885ed81e22dSJed Brown 
5886ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5887ed81e22dSJed Brown @*/
5888ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5889ed81e22dSJed Brown {
5890ed81e22dSJed Brown   PetscErrorCode ierr;
5891ed81e22dSJed Brown 
5892ed81e22dSJed Brown   PetscFunctionBegin;
5893ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5894fb1732b5SBarry Smith   PetscFunctionReturn(0);
5895fb1732b5SBarry Smith }
5896fb1732b5SBarry Smith 
589784df9cb4SJed Brown /*@
5898552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
589984df9cb4SJed Brown 
5900ed81e22dSJed Brown    Collective on TS if controller has not been created yet
590184df9cb4SJed Brown 
590284df9cb4SJed Brown    Input Arguments:
5903ed81e22dSJed Brown .  ts - time stepping context
590484df9cb4SJed Brown 
590584df9cb4SJed Brown    Output Arguments:
5906ed81e22dSJed Brown .  adapt - adaptive controller
590784df9cb4SJed Brown 
590884df9cb4SJed Brown    Level: intermediate
590984df9cb4SJed Brown 
5910ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
591184df9cb4SJed Brown @*/
5912552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
591384df9cb4SJed Brown {
591484df9cb4SJed Brown   PetscErrorCode ierr;
591584df9cb4SJed Brown 
591684df9cb4SJed Brown   PetscFunctionBegin;
591784df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5918bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
591984df9cb4SJed Brown   if (!ts->adapt) {
5920ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
59213bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
59221c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
592384df9cb4SJed Brown   }
5924bec58848SLisandro Dalcin   *adapt = ts->adapt;
592584df9cb4SJed Brown   PetscFunctionReturn(0);
592684df9cb4SJed Brown }
5927d6ebe24aSShri Abhyankar 
59281c3436cfSJed Brown /*@
59291c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
59301c3436cfSJed Brown 
59311c3436cfSJed Brown    Logically Collective
59321c3436cfSJed Brown 
59331c3436cfSJed Brown    Input Arguments:
59341c3436cfSJed Brown +  ts - time integration context
59351c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
59360298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
59371c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
59380298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
59391c3436cfSJed Brown 
5940a3cdaa26SBarry Smith    Options Database keys:
5941a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5942a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5943a3cdaa26SBarry Smith 
59443ff766beSShri Abhyankar    Notes:
59453ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
59463ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
59473ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
59483ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
59493ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
59503ff766beSShri Abhyankar    differential variables.
59513ff766beSShri Abhyankar 
59521c3436cfSJed Brown    Level: beginner
59531c3436cfSJed Brown 
5954c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
59551c3436cfSJed Brown @*/
59561c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
59571c3436cfSJed Brown {
59581c3436cfSJed Brown   PetscErrorCode ierr;
59591c3436cfSJed Brown 
59601c3436cfSJed Brown   PetscFunctionBegin;
5961c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
59621c3436cfSJed Brown   if (vatol) {
59631c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
59641c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
59651c3436cfSJed Brown     ts->vatol = vatol;
59661c3436cfSJed Brown   }
5967c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
59681c3436cfSJed Brown   if (vrtol) {
59691c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
59701c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
59711c3436cfSJed Brown     ts->vrtol = vrtol;
59721c3436cfSJed Brown   }
59731c3436cfSJed Brown   PetscFunctionReturn(0);
59741c3436cfSJed Brown }
59751c3436cfSJed Brown 
5976c5033834SJed Brown /*@
5977c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5978c5033834SJed Brown 
5979c5033834SJed Brown    Logically Collective
5980c5033834SJed Brown 
5981c5033834SJed Brown    Input Arguments:
5982c5033834SJed Brown .  ts - time integration context
5983c5033834SJed Brown 
5984c5033834SJed Brown    Output Arguments:
59850298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
59860298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
59870298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
59880298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5989c5033834SJed Brown 
5990c5033834SJed Brown    Level: beginner
5991c5033834SJed Brown 
5992c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5993c5033834SJed Brown @*/
5994c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5995c5033834SJed Brown {
5996c5033834SJed Brown   PetscFunctionBegin;
5997c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5998c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5999c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
6000c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
6001c5033834SJed Brown   PetscFunctionReturn(0);
6002c5033834SJed Brown }
6003c5033834SJed Brown 
60049c6b16b5SShri Abhyankar /*@
6005a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
60069c6b16b5SShri Abhyankar 
60079c6b16b5SShri Abhyankar    Collective on TS
60089c6b16b5SShri Abhyankar 
60099c6b16b5SShri Abhyankar    Input Arguments:
60109c6b16b5SShri Abhyankar +  ts - time stepping context
6011a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6012a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
60139c6b16b5SShri Abhyankar 
60149c6b16b5SShri Abhyankar    Output Arguments:
60157453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
60167453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
60177453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
60189c6b16b5SShri Abhyankar 
60199c6b16b5SShri Abhyankar    Level: developer
60209c6b16b5SShri Abhyankar 
6021deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
60229c6b16b5SShri Abhyankar @*/
60237453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
60249c6b16b5SShri Abhyankar {
60259c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
60269c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
60277453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
60287453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
60299c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
60307453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
60317453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
60327453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
60339c6b16b5SShri Abhyankar 
60349c6b16b5SShri Abhyankar   PetscFunctionBegin;
60359c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6036a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6037a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6038a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6039a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6040a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6041a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
60428a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
60438a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6044a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
60459c6b16b5SShri Abhyankar 
60469c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
60479c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
60489c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
60499c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
60509c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
60517453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
60527453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
60537453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
60549c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
60559c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
60569c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60579c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60589c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
60597453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
60607453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
60617453f775SEmil Constantinescu       if(tola>0.){
60627453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
60637453f775SEmil Constantinescu         na_loc++;
60647453f775SEmil Constantinescu       }
60657453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60667453f775SEmil Constantinescu       if(tolr>0.){
60677453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
60687453f775SEmil Constantinescu         nr_loc++;
60697453f775SEmil Constantinescu       }
60707453f775SEmil Constantinescu       tol=tola+tolr;
60717453f775SEmil Constantinescu       if(tol>0.){
60727453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
60737453f775SEmil Constantinescu         n_loc++;
60747453f775SEmil Constantinescu       }
60759c6b16b5SShri Abhyankar     }
60769c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60779c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60789c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
60799c6b16b5SShri Abhyankar     const PetscScalar *atol;
60809c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60819c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
60827453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
60837453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
60847453f775SEmil Constantinescu       if(tola>0.){
60857453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
60867453f775SEmil Constantinescu         na_loc++;
60877453f775SEmil Constantinescu       }
60887453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60897453f775SEmil Constantinescu       if(tolr>0.){
60907453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
60917453f775SEmil Constantinescu         nr_loc++;
60927453f775SEmil Constantinescu       }
60937453f775SEmil Constantinescu       tol=tola+tolr;
60947453f775SEmil Constantinescu       if(tol>0.){
60957453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
60967453f775SEmil Constantinescu         n_loc++;
60977453f775SEmil Constantinescu       }
60989c6b16b5SShri Abhyankar     }
60999c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
61009c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
61019c6b16b5SShri Abhyankar     const PetscScalar *rtol;
61029c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61039c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61047453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61057453f775SEmil Constantinescu       tola = ts->atol;
61067453f775SEmil Constantinescu       if(tola>0.){
61077453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
61087453f775SEmil Constantinescu         na_loc++;
61097453f775SEmil Constantinescu       }
61107453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61117453f775SEmil Constantinescu       if(tolr>0.){
61127453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
61137453f775SEmil Constantinescu         nr_loc++;
61147453f775SEmil Constantinescu       }
61157453f775SEmil Constantinescu       tol=tola+tolr;
61167453f775SEmil Constantinescu       if(tol>0.){
61177453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
61187453f775SEmil Constantinescu         n_loc++;
61197453f775SEmil Constantinescu       }
61209c6b16b5SShri Abhyankar     }
61219c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
61229c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
61239c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
61247453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
61257453f775SEmil Constantinescu      tola = ts->atol;
61267453f775SEmil Constantinescu       if(tola>0.){
61277453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
61287453f775SEmil Constantinescu         na_loc++;
61297453f775SEmil Constantinescu       }
61307453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
61317453f775SEmil Constantinescu       if(tolr>0.){
61327453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
61337453f775SEmil Constantinescu         nr_loc++;
61347453f775SEmil Constantinescu       }
61357453f775SEmil Constantinescu       tol=tola+tolr;
61367453f775SEmil Constantinescu       if(tol>0.){
61377453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
61387453f775SEmil Constantinescu         n_loc++;
61397453f775SEmil Constantinescu       }
61409c6b16b5SShri Abhyankar     }
61419c6b16b5SShri Abhyankar   }
61429c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
61439c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
61449c6b16b5SShri Abhyankar 
61457453f775SEmil Constantinescu   err_loc[0] = sum;
61467453f775SEmil Constantinescu   err_loc[1] = suma;
61477453f775SEmil Constantinescu   err_loc[2] = sumr;
61487453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
61497453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
61507453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
61517453f775SEmil Constantinescu 
6152a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
61537453f775SEmil Constantinescu 
61547453f775SEmil Constantinescu   gsum   = err_glb[0];
61557453f775SEmil Constantinescu   gsuma  = err_glb[1];
61567453f775SEmil Constantinescu   gsumr  = err_glb[2];
61577453f775SEmil Constantinescu   n_glb  = err_glb[3];
61587453f775SEmil Constantinescu   na_glb = err_glb[4];
61597453f775SEmil Constantinescu   nr_glb = err_glb[5];
61607453f775SEmil Constantinescu 
6161b1316ef9SEmil Constantinescu   *norm  = 0.;
6162b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
6163b1316ef9SEmil Constantinescu   *norma = 0.;
6164b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
6165b1316ef9SEmil Constantinescu   *normr = 0.;
6166b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
61679c6b16b5SShri Abhyankar 
61689c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
61697453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
61707453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
61719c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
61729c6b16b5SShri Abhyankar }
61739c6b16b5SShri Abhyankar 
61749c6b16b5SShri Abhyankar /*@
6175a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
61769c6b16b5SShri Abhyankar 
61779c6b16b5SShri Abhyankar    Collective on TS
61789c6b16b5SShri Abhyankar 
61799c6b16b5SShri Abhyankar    Input Arguments:
61809c6b16b5SShri Abhyankar +  ts - time stepping context
6181a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6182a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
61839c6b16b5SShri Abhyankar 
61849c6b16b5SShri Abhyankar    Output Arguments:
61857453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
61867453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
61877453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
61889c6b16b5SShri Abhyankar 
61899c6b16b5SShri Abhyankar    Level: developer
61909c6b16b5SShri Abhyankar 
6191deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
61929c6b16b5SShri Abhyankar @*/
61937453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61949c6b16b5SShri Abhyankar {
61959c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
61967453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
61979c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
61987453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
61997453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
62007453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
62019c6b16b5SShri Abhyankar 
62029c6b16b5SShri Abhyankar   PetscFunctionBegin;
62039c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6204a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
6205a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
6206a4868fbcSLisandro Dalcin   PetscValidType(U,2);
6207a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
6208a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
6209a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
62108a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
62118a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
6212a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
62139c6b16b5SShri Abhyankar 
62149c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
62159c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
62169c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
62179c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
62189c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
62197453f775SEmil Constantinescu 
62207453f775SEmil Constantinescu   max=0.;
62217453f775SEmil Constantinescu   maxa=0.;
62227453f775SEmil Constantinescu   maxr=0.;
62237453f775SEmil Constantinescu 
62247453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
62259c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
62269c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62279c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62287453f775SEmil Constantinescu 
62297453f775SEmil Constantinescu     for (i=0; i<n; i++) {
62307453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62317453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
62327453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62337453f775SEmil Constantinescu       tol  = tola+tolr;
62347453f775SEmil Constantinescu       if(tola>0.){
62357453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
62367453f775SEmil Constantinescu       }
62377453f775SEmil Constantinescu       if(tolr>0.){
62387453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
62397453f775SEmil Constantinescu       }
62407453f775SEmil Constantinescu       if(tol>0.){
62417453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
62427453f775SEmil Constantinescu       }
62439c6b16b5SShri Abhyankar     }
62449c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62459c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62469c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
62479c6b16b5SShri Abhyankar     const PetscScalar *atol;
62489c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62497453f775SEmil Constantinescu     for (i=0; i<n; i++) {
62507453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62517453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
62527453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62537453f775SEmil Constantinescu       tol  = tola+tolr;
62547453f775SEmil Constantinescu       if(tola>0.){
62557453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
62567453f775SEmil Constantinescu       }
62577453f775SEmil Constantinescu       if(tolr>0.){
62587453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
62597453f775SEmil Constantinescu       }
62607453f775SEmil Constantinescu       if(tol>0.){
62617453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
62627453f775SEmil Constantinescu       }
62639c6b16b5SShri Abhyankar     }
62649c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
62659c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
62669c6b16b5SShri Abhyankar     const PetscScalar *rtol;
62679c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62687453f775SEmil Constantinescu 
62697453f775SEmil Constantinescu     for (i=0; i<n; i++) {
62707453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62717453f775SEmil Constantinescu       tola = ts->atol;
62727453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62737453f775SEmil Constantinescu       tol  = tola+tolr;
62747453f775SEmil Constantinescu       if(tola>0.){
62757453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
62767453f775SEmil Constantinescu       }
62777453f775SEmil Constantinescu       if(tolr>0.){
62787453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
62797453f775SEmil Constantinescu       }
62807453f775SEmil Constantinescu       if(tol>0.){
62817453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
62827453f775SEmil Constantinescu       }
62839c6b16b5SShri Abhyankar     }
62849c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
62859c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
62867453f775SEmil Constantinescu 
62877453f775SEmil Constantinescu     for (i=0; i<n; i++) {
62887453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
62897453f775SEmil Constantinescu       tola = ts->atol;
62907453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
62917453f775SEmil Constantinescu       tol  = tola+tolr;
62927453f775SEmil Constantinescu       if(tola>0.){
62937453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
62947453f775SEmil Constantinescu       }
62957453f775SEmil Constantinescu       if(tolr>0.){
62967453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
62977453f775SEmil Constantinescu       }
62987453f775SEmil Constantinescu       if(tol>0.){
62997453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
63007453f775SEmil Constantinescu       }
63019c6b16b5SShri Abhyankar     }
63029c6b16b5SShri Abhyankar   }
63039c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
63049c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
63057453f775SEmil Constantinescu   err_loc[0] = max;
63067453f775SEmil Constantinescu   err_loc[1] = maxa;
63077453f775SEmil Constantinescu   err_loc[2] = maxr;
6308a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
63097453f775SEmil Constantinescu   gmax   = err_glb[0];
63107453f775SEmil Constantinescu   gmaxa  = err_glb[1];
63117453f775SEmil Constantinescu   gmaxr  = err_glb[2];
63129c6b16b5SShri Abhyankar 
63139c6b16b5SShri Abhyankar   *norm = gmax;
63147453f775SEmil Constantinescu   *norma = gmaxa;
63157453f775SEmil Constantinescu   *normr = gmaxr;
63169c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
63177453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
63187453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
63199c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
63209c6b16b5SShri Abhyankar }
63219c6b16b5SShri Abhyankar 
63221c3436cfSJed Brown /*@
63238a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
63241c3436cfSJed Brown 
63251c3436cfSJed Brown    Collective on TS
63261c3436cfSJed Brown 
63271c3436cfSJed Brown    Input Arguments:
63281c3436cfSJed Brown +  ts - time stepping context
6329a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
6330a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
6331a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
63327619abb3SShri 
63331c3436cfSJed Brown    Output Arguments:
63348a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
63358a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
63368a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
6337a4868fbcSLisandro Dalcin 
6338a4868fbcSLisandro Dalcin    Options Database Keys:
6339a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
6340a4868fbcSLisandro Dalcin 
63411c3436cfSJed Brown    Level: developer
63421c3436cfSJed Brown 
63438a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
63441c3436cfSJed Brown @*/
63457453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
63461c3436cfSJed Brown {
63478beabaa1SBarry Smith   PetscErrorCode ierr;
63481c3436cfSJed Brown 
63491c3436cfSJed Brown   PetscFunctionBegin;
6350a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
63517453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6352a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
63537453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
6354a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
63551c3436cfSJed Brown   PetscFunctionReturn(0);
63561c3436cfSJed Brown }
63571c3436cfSJed Brown 
63588a175baeSEmil Constantinescu 
63598a175baeSEmil Constantinescu /*@
63608a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
63618a175baeSEmil Constantinescu 
63628a175baeSEmil Constantinescu    Collective on TS
63638a175baeSEmil Constantinescu 
63648a175baeSEmil Constantinescu    Input Arguments:
63658a175baeSEmil Constantinescu +  ts - time stepping context
63668a175baeSEmil Constantinescu .  E - error vector
63678a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
63688a175baeSEmil Constantinescu -  Y - state vector, previous time step
63698a175baeSEmil Constantinescu 
63708a175baeSEmil Constantinescu    Output Arguments:
63718a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
63728a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
63738a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
63748a175baeSEmil Constantinescu 
63758a175baeSEmil Constantinescu    Level: developer
63768a175baeSEmil Constantinescu 
63778a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
63788a175baeSEmil Constantinescu @*/
63798a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
63808a175baeSEmil Constantinescu {
63818a175baeSEmil Constantinescu   PetscErrorCode    ierr;
63828a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
63838a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
63848a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
63858a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
63868a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
63878a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
63888a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
63898a175baeSEmil Constantinescu 
63908a175baeSEmil Constantinescu   PetscFunctionBegin;
63918a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
63928a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
63938a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
63948a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
63958a175baeSEmil Constantinescu   PetscValidType(E,2);
63968a175baeSEmil Constantinescu   PetscValidType(U,3);
63978a175baeSEmil Constantinescu   PetscValidType(Y,4);
63988a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
63998a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
64008a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
64018a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
64028a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
64038a175baeSEmil Constantinescu 
64048a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
64058a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
64068a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
64078a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
64088a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
64098a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
64108a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
64118a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
64128a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
64138a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
64148a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
64158a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64168a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64178a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
64188a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
64198a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
64208a175baeSEmil Constantinescu       if(tola>0.){
64218a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
64228a175baeSEmil Constantinescu         na_loc++;
64238a175baeSEmil Constantinescu       }
64248a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64258a175baeSEmil Constantinescu       if(tolr>0.){
64268a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
64278a175baeSEmil Constantinescu         nr_loc++;
64288a175baeSEmil Constantinescu       }
64298a175baeSEmil Constantinescu       tol=tola+tolr;
64308a175baeSEmil Constantinescu       if(tol>0.){
64318a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
64328a175baeSEmil Constantinescu         n_loc++;
64338a175baeSEmil Constantinescu       }
64348a175baeSEmil Constantinescu     }
64358a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64368a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64378a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
64388a175baeSEmil Constantinescu     const PetscScalar *atol;
64398a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64408a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
64418a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
64428a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
64438a175baeSEmil Constantinescu       if(tola>0.){
64448a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
64458a175baeSEmil Constantinescu         na_loc++;
64468a175baeSEmil Constantinescu       }
64478a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64488a175baeSEmil Constantinescu       if(tolr>0.){
64498a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
64508a175baeSEmil Constantinescu         nr_loc++;
64518a175baeSEmil Constantinescu       }
64528a175baeSEmil Constantinescu       tol=tola+tolr;
64538a175baeSEmil Constantinescu       if(tol>0.){
64548a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
64558a175baeSEmil Constantinescu         n_loc++;
64568a175baeSEmil Constantinescu       }
64578a175baeSEmil Constantinescu     }
64588a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
64598a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
64608a175baeSEmil Constantinescu     const PetscScalar *rtol;
64618a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64628a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
64638a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
64648a175baeSEmil Constantinescu       tola = ts->atol;
64658a175baeSEmil Constantinescu       if(tola>0.){
64668a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
64678a175baeSEmil Constantinescu         na_loc++;
64688a175baeSEmil Constantinescu       }
64698a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64708a175baeSEmil Constantinescu       if(tolr>0.){
64718a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
64728a175baeSEmil Constantinescu         nr_loc++;
64738a175baeSEmil Constantinescu       }
64748a175baeSEmil Constantinescu       tol=tola+tolr;
64758a175baeSEmil Constantinescu       if(tol>0.){
64768a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
64778a175baeSEmil Constantinescu         n_loc++;
64788a175baeSEmil Constantinescu       }
64798a175baeSEmil Constantinescu     }
64808a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
64818a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
64828a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
64838a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
64848a175baeSEmil Constantinescu      tola = ts->atol;
64858a175baeSEmil Constantinescu       if(tola>0.){
64868a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
64878a175baeSEmil Constantinescu         na_loc++;
64888a175baeSEmil Constantinescu       }
64898a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
64908a175baeSEmil Constantinescu       if(tolr>0.){
64918a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
64928a175baeSEmil Constantinescu         nr_loc++;
64938a175baeSEmil Constantinescu       }
64948a175baeSEmil Constantinescu       tol=tola+tolr;
64958a175baeSEmil Constantinescu       if(tol>0.){
64968a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
64978a175baeSEmil Constantinescu         n_loc++;
64988a175baeSEmil Constantinescu       }
64998a175baeSEmil Constantinescu     }
65008a175baeSEmil Constantinescu   }
65018a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
65028a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
65038a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
65048a175baeSEmil Constantinescu 
65058a175baeSEmil Constantinescu   err_loc[0] = sum;
65068a175baeSEmil Constantinescu   err_loc[1] = suma;
65078a175baeSEmil Constantinescu   err_loc[2] = sumr;
65088a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
65098a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
65108a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
65118a175baeSEmil Constantinescu 
6512a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
65138a175baeSEmil Constantinescu 
65148a175baeSEmil Constantinescu   gsum   = err_glb[0];
65158a175baeSEmil Constantinescu   gsuma  = err_glb[1];
65168a175baeSEmil Constantinescu   gsumr  = err_glb[2];
65178a175baeSEmil Constantinescu   n_glb  = err_glb[3];
65188a175baeSEmil Constantinescu   na_glb = err_glb[4];
65198a175baeSEmil Constantinescu   nr_glb = err_glb[5];
65208a175baeSEmil Constantinescu 
65218a175baeSEmil Constantinescu   *norm  = 0.;
65228a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
65238a175baeSEmil Constantinescu   *norma = 0.;
65248a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
65258a175baeSEmil Constantinescu   *normr = 0.;
65268a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
65278a175baeSEmil Constantinescu 
65288a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
65298a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
65308a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
65318a175baeSEmil Constantinescu   PetscFunctionReturn(0);
65328a175baeSEmil Constantinescu }
65338a175baeSEmil Constantinescu 
65348a175baeSEmil Constantinescu /*@
65358a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
65368a175baeSEmil Constantinescu    Collective on TS
65378a175baeSEmil Constantinescu 
65388a175baeSEmil Constantinescu    Input Arguments:
65398a175baeSEmil Constantinescu +  ts - time stepping context
65408a175baeSEmil Constantinescu .  E - error vector
65418a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
65428a175baeSEmil Constantinescu -  Y - state vector, previous time step
65438a175baeSEmil Constantinescu 
65448a175baeSEmil Constantinescu    Output Arguments:
65458a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
65468a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
65478a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
65488a175baeSEmil Constantinescu 
65498a175baeSEmil Constantinescu    Level: developer
65508a175baeSEmil Constantinescu 
65518a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
65528a175baeSEmil Constantinescu @*/
65538a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
65548a175baeSEmil Constantinescu {
65558a175baeSEmil Constantinescu   PetscErrorCode    ierr;
65568a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
65578a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
65588a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
65598a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
65608a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
65618a175baeSEmil Constantinescu 
65628a175baeSEmil Constantinescu   PetscFunctionBegin;
65638a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
65648a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
65658a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
65668a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
65678a175baeSEmil Constantinescu   PetscValidType(E,2);
65688a175baeSEmil Constantinescu   PetscValidType(U,3);
65698a175baeSEmil Constantinescu   PetscValidType(Y,4);
65708a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
65718a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
65728a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
65738a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
65748a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
65758a175baeSEmil Constantinescu 
65768a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
65778a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
65788a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
65798a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
65808a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
65818a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
65828a175baeSEmil Constantinescu 
65838a175baeSEmil Constantinescu   max=0.;
65848a175baeSEmil Constantinescu   maxa=0.;
65858a175baeSEmil Constantinescu   maxr=0.;
65868a175baeSEmil Constantinescu 
65878a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
65888a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
65898a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
65908a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
65918a175baeSEmil Constantinescu 
65928a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
65938a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
65948a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
65958a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
65968a175baeSEmil Constantinescu       tol  = tola+tolr;
65978a175baeSEmil Constantinescu       if(tola>0.){
65988a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
65998a175baeSEmil Constantinescu       }
66008a175baeSEmil Constantinescu       if(tolr>0.){
66018a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
66028a175baeSEmil Constantinescu       }
66038a175baeSEmil Constantinescu       if(tol>0.){
66048a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
66058a175baeSEmil Constantinescu       }
66068a175baeSEmil Constantinescu     }
66078a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
66088a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
66098a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
66108a175baeSEmil Constantinescu     const PetscScalar *atol;
66118a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
66128a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
66138a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
66148a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
66158a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
66168a175baeSEmil Constantinescu       tol  = tola+tolr;
66178a175baeSEmil Constantinescu       if(tola>0.){
66188a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
66198a175baeSEmil Constantinescu       }
66208a175baeSEmil Constantinescu       if(tolr>0.){
66218a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
66228a175baeSEmil Constantinescu       }
66238a175baeSEmil Constantinescu       if(tol>0.){
66248a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
66258a175baeSEmil Constantinescu       }
66268a175baeSEmil Constantinescu     }
66278a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
66288a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
66298a175baeSEmil Constantinescu     const PetscScalar *rtol;
66308a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
66318a175baeSEmil Constantinescu 
66328a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
66338a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
66348a175baeSEmil Constantinescu       tola = ts->atol;
66358a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
66368a175baeSEmil Constantinescu       tol  = tola+tolr;
66378a175baeSEmil Constantinescu       if(tola>0.){
66388a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
66398a175baeSEmil Constantinescu       }
66408a175baeSEmil Constantinescu       if(tolr>0.){
66418a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
66428a175baeSEmil Constantinescu       }
66438a175baeSEmil Constantinescu       if(tol>0.){
66448a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
66458a175baeSEmil Constantinescu       }
66468a175baeSEmil Constantinescu     }
66478a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
66488a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
66498a175baeSEmil Constantinescu 
66508a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
66518a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
66528a175baeSEmil Constantinescu       tola = ts->atol;
66538a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
66548a175baeSEmil Constantinescu       tol  = tola+tolr;
66558a175baeSEmil Constantinescu       if(tola>0.){
66568a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
66578a175baeSEmil Constantinescu       }
66588a175baeSEmil Constantinescu       if(tolr>0.){
66598a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
66608a175baeSEmil Constantinescu       }
66618a175baeSEmil Constantinescu       if(tol>0.){
66628a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
66638a175baeSEmil Constantinescu       }
66648a175baeSEmil Constantinescu     }
66658a175baeSEmil Constantinescu   }
66668a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
66678a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
66688a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
66698a175baeSEmil Constantinescu   err_loc[0] = max;
66708a175baeSEmil Constantinescu   err_loc[1] = maxa;
66718a175baeSEmil Constantinescu   err_loc[2] = maxr;
6672a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
66738a175baeSEmil Constantinescu   gmax   = err_glb[0];
66748a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
66758a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
66768a175baeSEmil Constantinescu 
66778a175baeSEmil Constantinescu   *norm = gmax;
66788a175baeSEmil Constantinescu   *norma = gmaxa;
66798a175baeSEmil Constantinescu   *normr = gmaxr;
66808a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
66818a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
66828a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
66838a175baeSEmil Constantinescu   PetscFunctionReturn(0);
66848a175baeSEmil Constantinescu }
66858a175baeSEmil Constantinescu 
66868a175baeSEmil Constantinescu /*@
66878a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
66888a175baeSEmil Constantinescu 
66898a175baeSEmil Constantinescu    Collective on TS
66908a175baeSEmil Constantinescu 
66918a175baeSEmil Constantinescu    Input Arguments:
66928a175baeSEmil Constantinescu +  ts - time stepping context
66938a175baeSEmil Constantinescu .  E - error vector
66948a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
66958a175baeSEmil Constantinescu .  Y - state vector, previous time step
66968a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
66978a175baeSEmil Constantinescu 
66988a175baeSEmil Constantinescu    Output Arguments:
66998a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
67008a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
67018a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
67028a175baeSEmil Constantinescu 
67038a175baeSEmil Constantinescu    Options Database Keys:
67048a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
67058a175baeSEmil Constantinescu 
67068a175baeSEmil Constantinescu    Level: developer
67078a175baeSEmil Constantinescu 
67088a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
67098a175baeSEmil Constantinescu @*/
67108a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
67118a175baeSEmil Constantinescu {
67128a175baeSEmil Constantinescu   PetscErrorCode ierr;
67138a175baeSEmil Constantinescu 
67148a175baeSEmil Constantinescu   PetscFunctionBegin;
67158a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
67168a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
67178a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
67188a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
67198a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
67208a175baeSEmil Constantinescu   PetscFunctionReturn(0);
67218a175baeSEmil Constantinescu }
67228a175baeSEmil Constantinescu 
67238a175baeSEmil Constantinescu 
67248d59e960SJed Brown /*@
67258d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
67268d59e960SJed Brown 
67278d59e960SJed Brown    Logically Collective on TS
67288d59e960SJed Brown 
67298d59e960SJed Brown    Input Arguments:
67308d59e960SJed Brown +  ts - time stepping context
67318d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
67328d59e960SJed Brown 
67338d59e960SJed Brown    Note:
67348d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
67358d59e960SJed Brown 
67368d59e960SJed Brown    Level: intermediate
67378d59e960SJed Brown 
67388d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
67398d59e960SJed Brown @*/
67408d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
67418d59e960SJed Brown {
67428d59e960SJed Brown   PetscFunctionBegin;
67438d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
67448d59e960SJed Brown   ts->cfltime_local = cfltime;
67458d59e960SJed Brown   ts->cfltime       = -1.;
67468d59e960SJed Brown   PetscFunctionReturn(0);
67478d59e960SJed Brown }
67488d59e960SJed Brown 
67498d59e960SJed Brown /*@
67508d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
67518d59e960SJed Brown 
67528d59e960SJed Brown    Collective on TS
67538d59e960SJed Brown 
67548d59e960SJed Brown    Input Arguments:
67558d59e960SJed Brown .  ts - time stepping context
67568d59e960SJed Brown 
67578d59e960SJed Brown    Output Arguments:
67588d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
67598d59e960SJed Brown 
67608d59e960SJed Brown    Level: advanced
67618d59e960SJed Brown 
67628d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
67638d59e960SJed Brown @*/
67648d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
67658d59e960SJed Brown {
67668d59e960SJed Brown   PetscErrorCode ierr;
67678d59e960SJed Brown 
67688d59e960SJed Brown   PetscFunctionBegin;
67698d59e960SJed Brown   if (ts->cfltime < 0) {
6770b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
67718d59e960SJed Brown   }
67728d59e960SJed Brown   *cfltime = ts->cfltime;
67738d59e960SJed Brown   PetscFunctionReturn(0);
67748d59e960SJed Brown }
67758d59e960SJed Brown 
6776d6ebe24aSShri Abhyankar /*@
6777d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6778d6ebe24aSShri Abhyankar 
6779d6ebe24aSShri Abhyankar    Input Parameters:
6780d6ebe24aSShri Abhyankar .  ts   - the TS context.
6781d6ebe24aSShri Abhyankar .  xl   - lower bound.
6782d6ebe24aSShri Abhyankar .  xu   - upper bound.
6783d6ebe24aSShri Abhyankar 
6784d6ebe24aSShri Abhyankar    Notes:
6785d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6786e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6787d6ebe24aSShri Abhyankar 
67882bd2b0e6SSatish Balay    Level: advanced
67892bd2b0e6SSatish Balay 
6790d6ebe24aSShri Abhyankar @*/
6791d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6792d6ebe24aSShri Abhyankar {
6793d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6794d6ebe24aSShri Abhyankar   SNES           snes;
6795d6ebe24aSShri Abhyankar 
6796d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6797d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6798d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6799d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6800d6ebe24aSShri Abhyankar }
6801d6ebe24aSShri Abhyankar 
6802325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6803c6db04a5SJed Brown #include <mex.h>
6804325fc9f4SBarry Smith 
6805325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6806325fc9f4SBarry Smith 
6807325fc9f4SBarry Smith /*
6808325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6809325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6810325fc9f4SBarry Smith 
6811325fc9f4SBarry Smith    Collective on TS
6812325fc9f4SBarry Smith 
6813325fc9f4SBarry Smith    Input Parameters:
6814325fc9f4SBarry Smith +  snes - the TS context
68150910c330SBarry Smith -  u - input vector
6816325fc9f4SBarry Smith 
6817325fc9f4SBarry Smith    Output Parameter:
6818325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6819325fc9f4SBarry Smith 
6820325fc9f4SBarry Smith    Notes:
6821325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6822325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6823325fc9f4SBarry Smith    themselves.
6824325fc9f4SBarry Smith 
6825325fc9f4SBarry Smith    Level: developer
6826325fc9f4SBarry Smith 
6827325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6828325fc9f4SBarry Smith 
6829325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6830325fc9f4SBarry Smith */
68310910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6832325fc9f4SBarry Smith {
6833325fc9f4SBarry Smith   PetscErrorCode  ierr;
6834325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6835325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6836325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6837325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6838325fc9f4SBarry Smith 
6839325fc9f4SBarry Smith   PetscFunctionBegin;
6840325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
68410910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
68420910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6843325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
68440910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6845325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6846325fc9f4SBarry Smith 
6847325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
68480910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
68490910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
68500910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6851bbd56ea5SKarl Rupp 
6852325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6853325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6854325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6855325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6856325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6857325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6858325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6859325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6860325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6861325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6862325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6863325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6864325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6865325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6866325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6867325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6868325fc9f4SBarry Smith   PetscFunctionReturn(0);
6869325fc9f4SBarry Smith }
6870325fc9f4SBarry Smith 
6871325fc9f4SBarry Smith /*
6872325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6873325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6874e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6875325fc9f4SBarry Smith 
6876325fc9f4SBarry Smith    Logically Collective on TS
6877325fc9f4SBarry Smith 
6878325fc9f4SBarry Smith    Input Parameters:
6879325fc9f4SBarry Smith +  ts - the TS context
6880325fc9f4SBarry Smith -  func - function evaluation routine
6881325fc9f4SBarry Smith 
6882325fc9f4SBarry Smith    Calling sequence of func:
68830910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6884325fc9f4SBarry Smith 
6885325fc9f4SBarry Smith    Level: beginner
6886325fc9f4SBarry Smith 
6887325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6888325fc9f4SBarry Smith 
6889325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6890325fc9f4SBarry Smith */
6891cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
6892325fc9f4SBarry Smith {
6893325fc9f4SBarry Smith   PetscErrorCode  ierr;
6894325fc9f4SBarry Smith   TSMatlabContext *sctx;
6895325fc9f4SBarry Smith 
6896325fc9f4SBarry Smith   PetscFunctionBegin;
6897325fc9f4SBarry Smith   /* currently sctx is memory bleed */
689895dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6899325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6900325fc9f4SBarry Smith   /*
6901325fc9f4SBarry Smith      This should work, but it doesn't
6902325fc9f4SBarry Smith   sctx->ctx = ctx;
6903325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6904325fc9f4SBarry Smith   */
6905325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6906bbd56ea5SKarl Rupp 
69070298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
6908325fc9f4SBarry Smith   PetscFunctionReturn(0);
6909325fc9f4SBarry Smith }
6910325fc9f4SBarry Smith 
6911325fc9f4SBarry Smith /*
6912325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
6913325fc9f4SBarry Smith                          TSSetJacobianMatlab().
6914325fc9f4SBarry Smith 
6915325fc9f4SBarry Smith    Collective on TS
6916325fc9f4SBarry Smith 
6917325fc9f4SBarry Smith    Input Parameters:
6918cdcf91faSSean Farley +  ts - the TS context
69190910c330SBarry Smith .  u - input vector
6920325fc9f4SBarry Smith .  A, B - the matrices
6921325fc9f4SBarry Smith -  ctx - user context
6922325fc9f4SBarry Smith 
6923325fc9f4SBarry Smith    Level: developer
6924325fc9f4SBarry Smith 
6925325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6926325fc9f4SBarry Smith 
6927325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6928325fc9f4SBarry Smith @*/
6929f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
6930325fc9f4SBarry Smith {
6931325fc9f4SBarry Smith   PetscErrorCode  ierr;
6932325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6933325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
6934325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
6935325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
6936325fc9f4SBarry Smith 
6937325fc9f4SBarry Smith   PetscFunctionBegin;
6938cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
69390910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
6940325fc9f4SBarry Smith 
69410910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
6942325fc9f4SBarry Smith 
6943cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
69440910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
69450910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
69460910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
69470910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
6948bbd56ea5SKarl Rupp 
6949325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6950325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
6951325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6952325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6953325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
6954325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
6955325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
6956325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
6957325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
6958325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
6959325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6960325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6961325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6962325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6963325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6964325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6965325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6966325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
6967325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
6968325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6969325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
6970325fc9f4SBarry Smith   PetscFunctionReturn(0);
6971325fc9f4SBarry Smith }
6972325fc9f4SBarry Smith 
6973325fc9f4SBarry Smith /*
6974325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
6975e3c5b3baSBarry 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
6976325fc9f4SBarry Smith 
6977325fc9f4SBarry Smith    Logically Collective on TS
6978325fc9f4SBarry Smith 
6979325fc9f4SBarry Smith    Input Parameters:
6980cdcf91faSSean Farley +  ts - the TS context
6981325fc9f4SBarry Smith .  A,B - Jacobian matrices
6982325fc9f4SBarry Smith .  func - function evaluation routine
6983325fc9f4SBarry Smith -  ctx - user context
6984325fc9f4SBarry Smith 
6985325fc9f4SBarry Smith    Calling sequence of func:
69860910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
6987325fc9f4SBarry Smith 
6988325fc9f4SBarry Smith    Level: developer
6989325fc9f4SBarry Smith 
6990325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6991325fc9f4SBarry Smith 
6992325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6993325fc9f4SBarry Smith */
6994cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
6995325fc9f4SBarry Smith {
6996325fc9f4SBarry Smith   PetscErrorCode  ierr;
6997325fc9f4SBarry Smith   TSMatlabContext *sctx;
6998325fc9f4SBarry Smith 
6999325fc9f4SBarry Smith   PetscFunctionBegin;
7000325fc9f4SBarry Smith   /* currently sctx is memory bleed */
700195dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7002325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7003325fc9f4SBarry Smith   /*
7004325fc9f4SBarry Smith      This should work, but it doesn't
7005325fc9f4SBarry Smith   sctx->ctx = ctx;
7006325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7007325fc9f4SBarry Smith   */
7008325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7009bbd56ea5SKarl Rupp 
7010cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
7011325fc9f4SBarry Smith   PetscFunctionReturn(0);
7012325fc9f4SBarry Smith }
7013325fc9f4SBarry Smith 
7014b5b1a830SBarry Smith /*
7015b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
7016b5b1a830SBarry Smith 
7017b5b1a830SBarry Smith    Collective on TS
7018b5b1a830SBarry Smith 
7019b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
7020b5b1a830SBarry Smith @*/
70210910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
7022b5b1a830SBarry Smith {
7023b5b1a830SBarry Smith   PetscErrorCode  ierr;
7024b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
7025a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
7026b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
7027b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
7028b5b1a830SBarry Smith 
7029b5b1a830SBarry Smith   PetscFunctionBegin;
7030cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
70310910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
7032b5b1a830SBarry Smith 
7033cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
70340910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
7035bbd56ea5SKarl Rupp 
7036b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
7037b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
7038b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
7039b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
7040b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
7041b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
7042b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
7043b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
7044b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
7045b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
7046b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
7047b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
7048b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
7049b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
7050b5b1a830SBarry Smith   PetscFunctionReturn(0);
7051b5b1a830SBarry Smith }
7052b5b1a830SBarry Smith 
7053b5b1a830SBarry Smith /*
7054b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
7055b5b1a830SBarry Smith 
7056b5b1a830SBarry Smith    Level: developer
7057b5b1a830SBarry Smith 
7058b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
7059b5b1a830SBarry Smith 
7060b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
7061b5b1a830SBarry Smith */
7062cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
7063b5b1a830SBarry Smith {
7064b5b1a830SBarry Smith   PetscErrorCode  ierr;
7065b5b1a830SBarry Smith   TSMatlabContext *sctx;
7066b5b1a830SBarry Smith 
7067b5b1a830SBarry Smith   PetscFunctionBegin;
7068b5b1a830SBarry Smith   /* currently sctx is memory bleed */
706995dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
7070b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
7071b5b1a830SBarry Smith   /*
7072b5b1a830SBarry Smith      This should work, but it doesn't
7073b5b1a830SBarry Smith   sctx->ctx = ctx;
7074b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
7075b5b1a830SBarry Smith   */
7076b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
7077bbd56ea5SKarl Rupp 
70780298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
7079b5b1a830SBarry Smith   PetscFunctionReturn(0);
7080b5b1a830SBarry Smith }
7081325fc9f4SBarry Smith #endif
7082b3603a34SBarry Smith 
7083b3603a34SBarry Smith /*@C
70844f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
7085b3603a34SBarry Smith        in a time based line graph
7086b3603a34SBarry Smith 
7087b3603a34SBarry Smith    Collective on TS
7088b3603a34SBarry Smith 
7089b3603a34SBarry Smith    Input Parameters:
7090b3603a34SBarry Smith +  ts - the TS context
7091b3603a34SBarry Smith .  step - current time-step
7092b3603a34SBarry Smith .  ptime - current time
70937db568b7SBarry Smith .  u - current solution
70947db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
7095b3603a34SBarry Smith 
7096b3d3934dSBarry Smith    Options Database:
70979ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
7098b3d3934dSBarry Smith 
7099b3603a34SBarry Smith    Level: intermediate
7100b3603a34SBarry Smith 
71016934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component solutions in a separate window
7102b3603a34SBarry Smith 
7103b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
7104b3603a34SBarry Smith 
71057db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
71067db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
71077db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
71087db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
7109b3603a34SBarry Smith @*/
71107db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7111b3603a34SBarry Smith {
7112b3603a34SBarry Smith   PetscErrorCode    ierr;
71137db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
7114b3603a34SBarry Smith   const PetscScalar *yy;
711580666b62SBarry Smith   Vec               v;
7116b3603a34SBarry Smith 
7117b3603a34SBarry Smith   PetscFunctionBegin;
711863e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
711958ff32f7SBarry Smith   if (!step) {
7120a9f9c1f6SBarry Smith     PetscDrawAxis axis;
71216934998bSLisandro Dalcin     PetscInt      dim;
7122a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7123a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
7124bab0a581SBarry Smith     if (!ctx->names) {
7125bab0a581SBarry Smith       PetscBool flg;
7126bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
7127bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
7128bab0a581SBarry Smith       if (flg) {
7129bab0a581SBarry Smith         PetscInt i,n;
7130bab0a581SBarry Smith         char     **names;
7131bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
7132bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
7133bab0a581SBarry Smith         for (i=0; i<n; i++) {
7134bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
7135bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
7136bab0a581SBarry Smith         }
7137bab0a581SBarry Smith         names[n] = NULL;
7138bab0a581SBarry Smith         ctx->names = names;
7139bab0a581SBarry Smith       }
7140bab0a581SBarry Smith     }
7141387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
7142387f4636SBarry Smith       char      **displaynames;
7143387f4636SBarry Smith       PetscBool flg;
7144387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
714595dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
7146387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
7147c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
7148387f4636SBarry Smith       if (flg) {
7149a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
7150387f4636SBarry Smith       }
7151387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
7152387f4636SBarry Smith     }
7153387f4636SBarry Smith     if (ctx->displaynames) {
7154387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
7155387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
7156387f4636SBarry Smith     } else if (ctx->names) {
71570910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
71580b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7159387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
7160b0bc92c6SBarry Smith     } else {
7161b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7162b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7163387f4636SBarry Smith     }
71640b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
716558ff32f7SBarry Smith   }
71666934998bSLisandro Dalcin 
71676934998bSLisandro Dalcin   if (!ctx->transform) v = u;
71686934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
716980666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
71706934998bSLisandro Dalcin   if (ctx->displaynames) {
71716934998bSLisandro Dalcin     PetscInt i;
71726934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
71736934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
71746934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
71756934998bSLisandro Dalcin   } else {
7176e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7177e3efe391SJed Brown     PetscInt  i,n;
71786934998bSLisandro Dalcin     PetscReal *yreal;
717980666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
7180785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7181e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
71820b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7183e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7184e3efe391SJed Brown #else
71850b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7186e3efe391SJed Brown #endif
718780666b62SBarry Smith   }
71886934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
71896934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
71906934998bSLisandro Dalcin 
7191b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
71920b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
71936934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
71943923b477SBarry Smith   }
7195b3603a34SBarry Smith   PetscFunctionReturn(0);
7196b3603a34SBarry Smith }
7197b3603a34SBarry Smith 
7198b037adc7SBarry Smith /*@C
719931152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7200b037adc7SBarry Smith 
7201b037adc7SBarry Smith    Collective on TS
7202b037adc7SBarry Smith 
7203b037adc7SBarry Smith    Input Parameters:
7204b037adc7SBarry Smith +  ts - the TS context
7205b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
7206b037adc7SBarry Smith 
7207b037adc7SBarry Smith    Level: intermediate
7208b037adc7SBarry Smith 
72097db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
72107db568b7SBarry Smith 
7211b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
7212b037adc7SBarry Smith 
7213a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
7214b037adc7SBarry Smith @*/
721531152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
7216b037adc7SBarry Smith {
7217b037adc7SBarry Smith   PetscErrorCode    ierr;
7218b037adc7SBarry Smith   PetscInt          i;
7219b037adc7SBarry Smith 
7220b037adc7SBarry Smith   PetscFunctionBegin;
7221b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7222b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
72235537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
7224b3d3934dSBarry Smith       break;
7225b3d3934dSBarry Smith     }
7226b3d3934dSBarry Smith   }
7227b3d3934dSBarry Smith   PetscFunctionReturn(0);
7228b3d3934dSBarry Smith }
7229b3d3934dSBarry Smith 
7230e673d494SBarry Smith /*@C
7231e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
7232e673d494SBarry Smith 
7233e673d494SBarry Smith    Collective on TS
7234e673d494SBarry Smith 
7235e673d494SBarry Smith    Input Parameters:
7236e673d494SBarry Smith +  ts - the TS context
7237e673d494SBarry Smith -  names - the names of the components, final string must be NULL
7238e673d494SBarry Smith 
7239e673d494SBarry Smith    Level: intermediate
7240e673d494SBarry Smith 
7241e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7242e673d494SBarry Smith 
7243a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
7244e673d494SBarry Smith @*/
7245e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
7246e673d494SBarry Smith {
7247e673d494SBarry Smith   PetscErrorCode    ierr;
7248e673d494SBarry Smith 
7249e673d494SBarry Smith   PetscFunctionBegin;
7250e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
7251e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
7252e673d494SBarry Smith   PetscFunctionReturn(0);
7253e673d494SBarry Smith }
7254e673d494SBarry Smith 
7255b3d3934dSBarry Smith /*@C
7256b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
7257b3d3934dSBarry Smith 
7258b3d3934dSBarry Smith    Collective on TS
7259b3d3934dSBarry Smith 
7260b3d3934dSBarry Smith    Input Parameter:
7261b3d3934dSBarry Smith .  ts - the TS context
7262b3d3934dSBarry Smith 
7263b3d3934dSBarry Smith    Output Parameter:
7264b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
7265b3d3934dSBarry Smith 
7266b3d3934dSBarry Smith    Level: intermediate
7267b3d3934dSBarry Smith 
72687db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
72697db568b7SBarry Smith 
7270b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7271b3d3934dSBarry Smith 
7272b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7273b3d3934dSBarry Smith @*/
7274b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
7275b3d3934dSBarry Smith {
7276b3d3934dSBarry Smith   PetscInt       i;
7277b3d3934dSBarry Smith 
7278b3d3934dSBarry Smith   PetscFunctionBegin;
7279b3d3934dSBarry Smith   *names = NULL;
7280b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7281b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
72825537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
7283b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
7284b3d3934dSBarry Smith       break;
7285387f4636SBarry Smith     }
7286387f4636SBarry Smith   }
7287387f4636SBarry Smith   PetscFunctionReturn(0);
7288387f4636SBarry Smith }
7289387f4636SBarry Smith 
7290a66092f1SBarry Smith /*@C
7291a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
7292a66092f1SBarry Smith 
7293a66092f1SBarry Smith    Collective on TS
7294a66092f1SBarry Smith 
7295a66092f1SBarry Smith    Input Parameters:
7296a66092f1SBarry Smith +  ctx - the TSMonitorLG context
7297a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
7298a66092f1SBarry Smith 
7299a66092f1SBarry Smith    Level: intermediate
7300a66092f1SBarry Smith 
7301a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
7302a66092f1SBarry Smith 
7303a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7304a66092f1SBarry Smith @*/
7305a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
7306a66092f1SBarry Smith {
7307a66092f1SBarry Smith   PetscInt          j = 0,k;
7308a66092f1SBarry Smith   PetscErrorCode    ierr;
7309a66092f1SBarry Smith 
7310a66092f1SBarry Smith   PetscFunctionBegin;
7311a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
7312a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
7313a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
7314a66092f1SBarry Smith   while (displaynames[j]) j++;
7315a66092f1SBarry Smith   ctx->ndisplayvariables = j;
7316a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
7317a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
7318a66092f1SBarry Smith   j = 0;
7319a66092f1SBarry Smith   while (displaynames[j]) {
7320a66092f1SBarry Smith     k = 0;
7321a66092f1SBarry Smith     while (ctx->names[k]) {
7322a66092f1SBarry Smith       PetscBool flg;
7323a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
7324a66092f1SBarry Smith       if (flg) {
7325a66092f1SBarry Smith         ctx->displayvariables[j] = k;
7326a66092f1SBarry Smith         break;
7327a66092f1SBarry Smith       }
7328a66092f1SBarry Smith       k++;
7329a66092f1SBarry Smith     }
7330a66092f1SBarry Smith     j++;
7331a66092f1SBarry Smith   }
7332a66092f1SBarry Smith   PetscFunctionReturn(0);
7333a66092f1SBarry Smith }
7334a66092f1SBarry Smith 
7335387f4636SBarry Smith /*@C
7336387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
7337387f4636SBarry Smith 
7338387f4636SBarry Smith    Collective on TS
7339387f4636SBarry Smith 
7340387f4636SBarry Smith    Input Parameters:
7341387f4636SBarry Smith +  ts - the TS context
7342387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
7343387f4636SBarry Smith 
73447db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73457db568b7SBarry Smith 
7346387f4636SBarry Smith    Level: intermediate
7347387f4636SBarry Smith 
7348387f4636SBarry Smith .keywords: TS,  vector, monitor, view
7349387f4636SBarry Smith 
7350387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
7351387f4636SBarry Smith @*/
7352387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
7353387f4636SBarry Smith {
7354a66092f1SBarry Smith   PetscInt          i;
7355387f4636SBarry Smith   PetscErrorCode    ierr;
7356387f4636SBarry Smith 
7357387f4636SBarry Smith   PetscFunctionBegin;
7358387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7359387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73605537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
7361b3d3934dSBarry Smith       break;
7362b037adc7SBarry Smith     }
7363b037adc7SBarry Smith   }
7364b037adc7SBarry Smith   PetscFunctionReturn(0);
7365b037adc7SBarry Smith }
7366b037adc7SBarry Smith 
736780666b62SBarry Smith /*@C
736880666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
736980666b62SBarry Smith 
737080666b62SBarry Smith    Collective on TS
737180666b62SBarry Smith 
737280666b62SBarry Smith    Input Parameters:
737380666b62SBarry Smith +  ts - the TS context
737480666b62SBarry Smith .  transform - the transform function
73757684fa3eSBarry Smith .  destroy - function to destroy the optional context
737680666b62SBarry Smith -  ctx - optional context used by transform function
737780666b62SBarry Smith 
73787db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
73797db568b7SBarry Smith 
738080666b62SBarry Smith    Level: intermediate
738180666b62SBarry Smith 
738280666b62SBarry Smith .keywords: TS,  vector, monitor, view
738380666b62SBarry Smith 
7384a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
738580666b62SBarry Smith @*/
73867684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
738780666b62SBarry Smith {
738880666b62SBarry Smith   PetscInt          i;
7389a66092f1SBarry Smith   PetscErrorCode    ierr;
739080666b62SBarry Smith 
739180666b62SBarry Smith   PetscFunctionBegin;
739280666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
739380666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
73945537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
739580666b62SBarry Smith     }
739680666b62SBarry Smith   }
739780666b62SBarry Smith   PetscFunctionReturn(0);
739880666b62SBarry Smith }
739980666b62SBarry Smith 
7400e673d494SBarry Smith /*@C
7401e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
7402e673d494SBarry Smith 
7403e673d494SBarry Smith    Collective on TSLGCtx
7404e673d494SBarry Smith 
7405e673d494SBarry Smith    Input Parameters:
7406e673d494SBarry Smith +  ts - the TS context
7407e673d494SBarry Smith .  transform - the transform function
74087684fa3eSBarry Smith .  destroy - function to destroy the optional context
7409e673d494SBarry Smith -  ctx - optional context used by transform function
7410e673d494SBarry Smith 
7411e673d494SBarry Smith    Level: intermediate
7412e673d494SBarry Smith 
7413e673d494SBarry Smith .keywords: TS,  vector, monitor, view
7414e673d494SBarry Smith 
7415a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
7416e673d494SBarry Smith @*/
74177684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
7418e673d494SBarry Smith {
7419e673d494SBarry Smith   PetscFunctionBegin;
7420e673d494SBarry Smith   ctx->transform    = transform;
74217684fa3eSBarry Smith   ctx->transformdestroy = destroy;
7422e673d494SBarry Smith   ctx->transformctx = tctx;
7423e673d494SBarry Smith   PetscFunctionReturn(0);
7424e673d494SBarry Smith }
7425e673d494SBarry Smith 
7426ef20d060SBarry Smith /*@C
74274f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
7428ef20d060SBarry Smith        in a time based line graph
7429ef20d060SBarry Smith 
7430ef20d060SBarry Smith    Collective on TS
7431ef20d060SBarry Smith 
7432ef20d060SBarry Smith    Input Parameters:
7433ef20d060SBarry Smith +  ts - the TS context
7434ef20d060SBarry Smith .  step - current time-step
7435ef20d060SBarry Smith .  ptime - current time
74367db568b7SBarry Smith .  u - current solution
74377db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
7438ef20d060SBarry Smith 
7439ef20d060SBarry Smith    Level: intermediate
7440ef20d060SBarry Smith 
74416934998bSLisandro Dalcin    Notes: Each process in a parallel run displays its component errors in a separate window
7442abd5a294SJed Brown 
7443abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
7444abd5a294SJed Brown 
7445abd5a294SJed Brown    Options Database Keys:
74464f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
7447ef20d060SBarry Smith 
7448ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
7449ef20d060SBarry Smith 
7450abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
7451ef20d060SBarry Smith @*/
74520910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
7453ef20d060SBarry Smith {
7454ef20d060SBarry Smith   PetscErrorCode    ierr;
74550b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
7456ef20d060SBarry Smith   const PetscScalar *yy;
7457ef20d060SBarry Smith   Vec               y;
7458ef20d060SBarry Smith 
7459ef20d060SBarry Smith   PetscFunctionBegin;
7460a9f9c1f6SBarry Smith   if (!step) {
7461a9f9c1f6SBarry Smith     PetscDrawAxis axis;
74626934998bSLisandro Dalcin     PetscInt      dim;
7463a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
74641ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
74650910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
7466a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
7467a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7468a9f9c1f6SBarry Smith   }
74690910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
7470ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
74710910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
7472ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
7473e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
7474e3efe391SJed Brown   {
7475e3efe391SJed Brown     PetscReal *yreal;
7476e3efe391SJed Brown     PetscInt  i,n;
7477e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
7478785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
7479e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
74800b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
7481e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
7482e3efe391SJed Brown   }
7483e3efe391SJed Brown #else
74840b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
7485e3efe391SJed Brown #endif
7486ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
7487ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
7488b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
74890b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
74906934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
74913923b477SBarry Smith   }
7492ef20d060SBarry Smith   PetscFunctionReturn(0);
7493ef20d060SBarry Smith }
7494ef20d060SBarry Smith 
7495201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7496201da799SBarry Smith {
7497201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7498201da799SBarry Smith   PetscReal      x   = ptime,y;
7499201da799SBarry Smith   PetscErrorCode ierr;
7500201da799SBarry Smith   PetscInt       its;
7501201da799SBarry Smith 
7502201da799SBarry Smith   PetscFunctionBegin;
750363e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7504201da799SBarry Smith   if (!n) {
7505201da799SBarry Smith     PetscDrawAxis axis;
7506201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7507201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7508201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7509201da799SBarry Smith     ctx->snes_its = 0;
7510201da799SBarry Smith   }
7511201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7512201da799SBarry Smith   y    = its - ctx->snes_its;
7513201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
75143fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7515201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
75166934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7517201da799SBarry Smith   }
7518201da799SBarry Smith   ctx->snes_its = its;
7519201da799SBarry Smith   PetscFunctionReturn(0);
7520201da799SBarry Smith }
7521201da799SBarry Smith 
7522201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7523201da799SBarry Smith {
7524201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7525201da799SBarry Smith   PetscReal      x   = ptime,y;
7526201da799SBarry Smith   PetscErrorCode ierr;
7527201da799SBarry Smith   PetscInt       its;
7528201da799SBarry Smith 
7529201da799SBarry Smith   PetscFunctionBegin;
753063e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7531201da799SBarry Smith   if (!n) {
7532201da799SBarry Smith     PetscDrawAxis axis;
7533201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7534201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7535201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7536201da799SBarry Smith     ctx->ksp_its = 0;
7537201da799SBarry Smith   }
7538201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7539201da799SBarry Smith   y    = its - ctx->ksp_its;
7540201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
754199fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7542201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
75436934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7544201da799SBarry Smith   }
7545201da799SBarry Smith   ctx->ksp_its = its;
7546201da799SBarry Smith   PetscFunctionReturn(0);
7547201da799SBarry Smith }
7548f9c1d6abSBarry Smith 
7549f9c1d6abSBarry Smith /*@
7550f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7551f9c1d6abSBarry Smith 
7552f9c1d6abSBarry Smith    Collective on TS and Vec
7553f9c1d6abSBarry Smith 
7554f9c1d6abSBarry Smith    Input Parameters:
7555f9c1d6abSBarry Smith +  ts - the TS context
7556f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7557f9c1d6abSBarry Smith 
7558f9c1d6abSBarry Smith    Output Parameters:
7559f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7560f9c1d6abSBarry Smith 
7561f9c1d6abSBarry Smith    Level: developer
7562f9c1d6abSBarry Smith 
7563f9c1d6abSBarry Smith .keywords: TS, compute
7564f9c1d6abSBarry Smith 
7565f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7566f9c1d6abSBarry Smith @*/
7567f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7568f9c1d6abSBarry Smith {
7569f9c1d6abSBarry Smith   PetscErrorCode ierr;
7570f9c1d6abSBarry Smith 
7571f9c1d6abSBarry Smith   PetscFunctionBegin;
7572f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7573ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7574f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7575f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7576f9c1d6abSBarry Smith }
757724655328SShri 
7578b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7579b3d3934dSBarry Smith /*@C
7580b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7581b3d3934dSBarry Smith 
7582b3d3934dSBarry Smith    Collective on TS
7583b3d3934dSBarry Smith 
7584b3d3934dSBarry Smith    Input Parameters:
7585b3d3934dSBarry Smith .  ts  - the ODE solver object
7586b3d3934dSBarry Smith 
7587b3d3934dSBarry Smith    Output Parameter:
7588b3d3934dSBarry Smith .  ctx - the context
7589b3d3934dSBarry Smith 
7590b3d3934dSBarry Smith    Level: intermediate
7591b3d3934dSBarry Smith 
7592b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7593b3d3934dSBarry Smith 
7594b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7595b3d3934dSBarry Smith 
7596b3d3934dSBarry Smith @*/
7597b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7598b3d3934dSBarry Smith {
7599b3d3934dSBarry Smith   PetscErrorCode ierr;
7600b3d3934dSBarry Smith 
7601b3d3934dSBarry Smith   PetscFunctionBegin;
7602a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7603b3d3934dSBarry Smith   PetscFunctionReturn(0);
7604b3d3934dSBarry Smith }
7605b3d3934dSBarry Smith 
7606b3d3934dSBarry Smith /*@C
7607b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7608b3d3934dSBarry Smith 
7609b3d3934dSBarry Smith    Collective on TS
7610b3d3934dSBarry Smith 
7611b3d3934dSBarry Smith    Input Parameters:
7612b3d3934dSBarry Smith +  ts - the TS context
7613b3d3934dSBarry Smith .  step - current time-step
7614b3d3934dSBarry Smith .  ptime - current time
76157db568b7SBarry Smith .  u  - current solution
76167db568b7SBarry Smith -  dctx - the envelope context
7617b3d3934dSBarry Smith 
7618b3d3934dSBarry Smith    Options Database:
7619b3d3934dSBarry Smith .  -ts_monitor_envelope
7620b3d3934dSBarry Smith 
7621b3d3934dSBarry Smith    Level: intermediate
7622b3d3934dSBarry Smith 
7623b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7624b3d3934dSBarry Smith 
7625b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7626b3d3934dSBarry Smith 
76277db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7628b3d3934dSBarry Smith @*/
76297db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7630b3d3934dSBarry Smith {
7631b3d3934dSBarry Smith   PetscErrorCode       ierr;
76327db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7633b3d3934dSBarry Smith 
7634b3d3934dSBarry Smith   PetscFunctionBegin;
7635b3d3934dSBarry Smith   if (!ctx->max) {
7636b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7637b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7638b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7639b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7640b3d3934dSBarry Smith   } else {
7641b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7642b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7643b3d3934dSBarry Smith   }
7644b3d3934dSBarry Smith   PetscFunctionReturn(0);
7645b3d3934dSBarry Smith }
7646b3d3934dSBarry Smith 
7647b3d3934dSBarry Smith /*@C
7648b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7649b3d3934dSBarry Smith 
7650b3d3934dSBarry Smith    Collective on TS
7651b3d3934dSBarry Smith 
7652b3d3934dSBarry Smith    Input Parameter:
7653b3d3934dSBarry Smith .  ts - the TS context
7654b3d3934dSBarry Smith 
7655b3d3934dSBarry Smith    Output Parameter:
7656b3d3934dSBarry Smith +  max - the maximum values
7657b3d3934dSBarry Smith -  min - the minimum values
7658b3d3934dSBarry Smith 
76597db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
76607db568b7SBarry Smith 
7661b3d3934dSBarry Smith    Level: intermediate
7662b3d3934dSBarry Smith 
7663b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7664b3d3934dSBarry Smith 
7665b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7666b3d3934dSBarry Smith @*/
7667b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7668b3d3934dSBarry Smith {
7669b3d3934dSBarry Smith   PetscInt i;
7670b3d3934dSBarry Smith 
7671b3d3934dSBarry Smith   PetscFunctionBegin;
7672b3d3934dSBarry Smith   if (max) *max = NULL;
7673b3d3934dSBarry Smith   if (min) *min = NULL;
7674b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7675b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
76765537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7677b3d3934dSBarry Smith       if (max) *max = ctx->max;
7678b3d3934dSBarry Smith       if (min) *min = ctx->min;
7679b3d3934dSBarry Smith       break;
7680b3d3934dSBarry Smith     }
7681b3d3934dSBarry Smith   }
7682b3d3934dSBarry Smith   PetscFunctionReturn(0);
7683b3d3934dSBarry Smith }
7684b3d3934dSBarry Smith 
7685b3d3934dSBarry Smith /*@C
7686b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7687b3d3934dSBarry Smith 
7688b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7689b3d3934dSBarry Smith 
7690b3d3934dSBarry Smith    Input Parameter:
7691b3d3934dSBarry Smith .  ctx - the monitor context
7692b3d3934dSBarry Smith 
7693b3d3934dSBarry Smith    Level: intermediate
7694b3d3934dSBarry Smith 
7695b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7696b3d3934dSBarry Smith 
76977db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7698b3d3934dSBarry Smith @*/
7699b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7700b3d3934dSBarry Smith {
7701b3d3934dSBarry Smith   PetscErrorCode ierr;
7702b3d3934dSBarry Smith 
7703b3d3934dSBarry Smith   PetscFunctionBegin;
7704b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7705b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7706b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7707b3d3934dSBarry Smith   PetscFunctionReturn(0);
7708b3d3934dSBarry Smith }
7709f2dee214SBarry Smith 
771024655328SShri /*@
771124655328SShri    TSRollBack - Rolls back one time step
771224655328SShri 
771324655328SShri    Collective on TS
771424655328SShri 
771524655328SShri    Input Parameter:
771624655328SShri .  ts - the TS context obtained from TSCreate()
771724655328SShri 
771824655328SShri    Level: advanced
771924655328SShri 
772024655328SShri .keywords: TS, timestep, rollback
772124655328SShri 
772224655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
772324655328SShri @*/
772424655328SShri PetscErrorCode  TSRollBack(TS ts)
772524655328SShri {
772624655328SShri   PetscErrorCode ierr;
772724655328SShri 
772824655328SShri   PetscFunctionBegin;
772924655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7730b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
773124655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
773224655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
773324655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
773424655328SShri   ts->ptime = ts->ptime_prev;
7735be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
7736be5899b3SLisandro Dalcin   ts->steps--; ts->total_steps--;
773710b82f12SShri Abhyankar   ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
7738b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
773924655328SShri   PetscFunctionReturn(0);
774024655328SShri }
7741aeb4809dSShri Abhyankar 
7742ff22ae23SHong Zhang /*@
7743ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7744ff22ae23SHong Zhang 
7745ff22ae23SHong Zhang    Input Parameter:
7746ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7747ff22ae23SHong Zhang 
7748ff22ae23SHong Zhang    Level: advanced
7749ff22ae23SHong Zhang 
7750ff22ae23SHong Zhang .keywords: TS, getstages
7751ff22ae23SHong Zhang 
7752ff22ae23SHong Zhang .seealso: TSCreate()
7753ff22ae23SHong Zhang @*/
7754ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7755ff22ae23SHong Zhang {
7756ff22ae23SHong Zhang   PetscErrorCode ierr;
7757ff22ae23SHong Zhang 
7758ff22ae23SHong Zhang   PetscFunctionBegin;
7759ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7760ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7761ff22ae23SHong Zhang 
7762ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7763ff22ae23SHong Zhang   else {
7764ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7765ff22ae23SHong Zhang   }
7766ff22ae23SHong Zhang   PetscFunctionReturn(0);
7767ff22ae23SHong Zhang }
7768ff22ae23SHong Zhang 
7769847ff0e1SMatthew G. Knepley /*@C
7770847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7771847ff0e1SMatthew G. Knepley 
7772847ff0e1SMatthew G. Knepley   Collective on SNES
7773847ff0e1SMatthew G. Knepley 
7774847ff0e1SMatthew G. Knepley   Input Parameters:
7775847ff0e1SMatthew G. Knepley + ts - the TS context
7776847ff0e1SMatthew G. Knepley . t - current timestep
7777847ff0e1SMatthew G. Knepley . U - state vector
7778847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7779847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7780847ff0e1SMatthew G. Knepley - ctx - an optional user context
7781847ff0e1SMatthew G. Knepley 
7782847ff0e1SMatthew G. Knepley   Output Parameters:
7783847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7784847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7785847ff0e1SMatthew G. Knepley 
7786847ff0e1SMatthew G. Knepley   Level: intermediate
7787847ff0e1SMatthew G. Knepley 
7788847ff0e1SMatthew G. Knepley   Notes:
7789847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7790847ff0e1SMatthew G. Knepley 
7791847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7792847ff0e1SMatthew G. Knepley 
7793847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7794847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7795847ff0e1SMatthew G. Knepley 
7796847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7797847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7798847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7799847ff0e1SMatthew G. Knepley 
7800847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7801847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7802847ff0e1SMatthew G. Knepley @*/
7803847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7804847ff0e1SMatthew G. Knepley {
7805847ff0e1SMatthew G. Knepley   SNES           snes;
7806847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7807847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7808847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7809847ff0e1SMatthew G. Knepley 
7810847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7811c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7812847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7813847ff0e1SMatthew G. Knepley   if (!color) {
7814847ff0e1SMatthew G. Knepley     DM         dm;
7815847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7816847ff0e1SMatthew G. Knepley 
7817847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7818847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7819847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7820847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7821847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7822847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7823847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7824847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7825847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7826847ff0e1SMatthew G. Knepley     } else {
7827847ff0e1SMatthew G. Knepley       MatColoring mc;
7828847ff0e1SMatthew G. Knepley 
7829847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7830847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7831847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7832847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7833847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7834847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7835847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7836847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7837847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7838847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7839847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7840847ff0e1SMatthew G. Knepley     }
7841847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7842847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7843847ff0e1SMatthew G. Knepley   }
7844847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7845847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7846847ff0e1SMatthew G. Knepley   if (J != B) {
7847847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7848847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7849847ff0e1SMatthew G. Knepley   }
7850847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7851847ff0e1SMatthew G. Knepley }
785293b34091SDebojyoti Ghosh 
7853cb9d8021SPierre Barbier de Reuille /*@
7854cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7855cb9d8021SPierre Barbier de Reuille 
7856cb9d8021SPierre Barbier de Reuille     Input Parameters:
7857cb9d8021SPierre Barbier de Reuille     ts - the TS context
7858cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
7859cb9d8021SPierre Barbier de Reuille 
7860cb9d8021SPierre Barbier de Reuille     Level: intermediate
7861cb9d8021SPierre Barbier de Reuille 
7862cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
7863cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
7864cb9d8021SPierre Barbier de Reuille @*/
7865cb9d8021SPierre Barbier de Reuille 
7866d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7867cb9d8021SPierre Barbier de Reuille {
7868cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7869cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7870cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7871cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7872cb9d8021SPierre Barbier de Reuille }
7873cb9d8021SPierre Barbier de Reuille 
7874cb9d8021SPierre Barbier de Reuille /*@
7875cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
7876cb9d8021SPierre Barbier de Reuille 
7877cb9d8021SPierre Barbier de Reuille     Input Parameters:
7878cb9d8021SPierre Barbier de Reuille     ts - the TS context
7879cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
7880d183316bSPierre Barbier de Reuille     Y - state vector to check.
7881cb9d8021SPierre Barbier de Reuille 
7882cb9d8021SPierre Barbier de Reuille     Output Parameter:
7883cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
7884cb9d8021SPierre Barbier de Reuille 
7885cb9d8021SPierre Barbier de Reuille     Note:
7886cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
7887cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
788896a0c994SBarry Smith 
788996a0c994SBarry Smith     Level: advanced
7890cb9d8021SPierre Barbier de Reuille @*/
7891d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7892cb9d8021SPierre Barbier de Reuille {
7893cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
7894cb9d8021SPierre Barbier de Reuille 
7895cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7896cb9d8021SPierre Barbier de Reuille 
7897cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7898cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7899cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7900d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7901cb9d8021SPierre Barbier de Reuille   }
7902cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7903cb9d8021SPierre Barbier de Reuille }
79041ceb14c0SBarry Smith 
790593b34091SDebojyoti Ghosh /*@C
7906e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
790793b34091SDebojyoti Ghosh 
790893b34091SDebojyoti Ghosh   Collective on MPI_Comm
790993b34091SDebojyoti Ghosh 
791093b34091SDebojyoti Ghosh   Input Parameter:
791193b34091SDebojyoti Ghosh . tsin    - The input TS
791293b34091SDebojyoti Ghosh 
791393b34091SDebojyoti Ghosh   Output Parameter:
7914e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
791593b34091SDebojyoti Ghosh 
79165eca1a21SEmil Constantinescu   Notes:
79175eca1a21SEmil 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.
79185eca1a21SEmil Constantinescu 
7919baa10174SEmil 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);
79205eca1a21SEmil Constantinescu 
79215eca1a21SEmil Constantinescu   Level: developer
792293b34091SDebojyoti Ghosh 
7923e5168f73SEmil Constantinescu .keywords: TS, clone
7924e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
792593b34091SDebojyoti Ghosh @*/
7926baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
792793b34091SDebojyoti Ghosh {
792893b34091SDebojyoti Ghosh   TS             t;
792993b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7930dc846ba4SSatish Balay   SNES           snes_start;
7931dc846ba4SSatish Balay   DM             dm;
7932dc846ba4SSatish Balay   TSType         type;
793393b34091SDebojyoti Ghosh 
793493b34091SDebojyoti Ghosh   PetscFunctionBegin;
793593b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
793693b34091SDebojyoti Ghosh   *tsout = NULL;
793793b34091SDebojyoti Ghosh 
79387a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
793993b34091SDebojyoti Ghosh 
794093b34091SDebojyoti Ghosh   /* General TS description */
794193b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
794293b34091SDebojyoti Ghosh   t->setupcalled       = 0;
794393b34091SDebojyoti Ghosh   t->ksp_its           = 0;
794493b34091SDebojyoti Ghosh   t->snes_its          = 0;
794593b34091SDebojyoti Ghosh   t->nwork             = 0;
794693b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
794793b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
794893b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
794993b34091SDebojyoti Ghosh 
795034561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
795134561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7952d15a3a53SEmil Constantinescu 
795393b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
795493b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
795593b34091SDebojyoti Ghosh 
795693b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
795751699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
795893b34091SDebojyoti Ghosh 
7959e7069c78SShri   t->trajectory = tsin->trajectory;
7960e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7961e7069c78SShri 
7962e7069c78SShri   t->event = tsin->event;
79636b10a48eSSatish Balay   if (t->event) t->event->refct++;
7964e7069c78SShri 
796593b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
796693b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7967e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
796893b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
796993b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
797093b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
7971e7069c78SShri   t->total_steps       = tsin->total_steps;
797293b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
797393b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
797493b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
797593b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
797693b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
797793b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
797893b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
797993b34091SDebojyoti Ghosh 
798093b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
798193b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
798293b34091SDebojyoti Ghosh 
798393b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
798493b34091SDebojyoti Ghosh 
798593b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
798693b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
798793b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
798893b34091SDebojyoti Ghosh 
798993b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
799093b34091SDebojyoti Ghosh 
79910d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
79920d4fed19SBarry Smith     PetscInt i;
79930d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
79940d4fed19SBarry Smith     for (i=0; i<10; i++) {
79950d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
79960d4fed19SBarry Smith     }
79970d4fed19SBarry Smith   }
799893b34091SDebojyoti Ghosh   *tsout = t;
799993b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
800093b34091SDebojyoti Ghosh }
8001