xref: /petsc/src/ts/interface/ts.c (revision 0ec8ee2b52da190cc39cdcef263b0345c8f10973)
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;
9a05bf03eSHong Zhang PetscLogEvent 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 
13fde5950dSBarry Smith /*@C
14fde5950dSBarry Smith    TSMonitorSetFromOptions - Sets a monitor function and viewer appropriate for the type indicated by the user
15fde5950dSBarry Smith 
16fde5950dSBarry Smith    Collective on TS
17fde5950dSBarry Smith 
18fde5950dSBarry Smith    Input Parameters:
19fde5950dSBarry Smith +  ts - TS object you wish to monitor
20fde5950dSBarry Smith .  name - the monitor type one is seeking
21fde5950dSBarry Smith .  help - message indicating what monitoring is done
22fde5950dSBarry Smith .  manual - manual page for the monitor
23fde5950dSBarry Smith .  monitor - the monitor function
24fde5950dSBarry 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
25fde5950dSBarry Smith 
26fde5950dSBarry Smith    Level: developer
27fde5950dSBarry Smith 
28fde5950dSBarry Smith .seealso: PetscOptionsGetViewer(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(),
29fde5950dSBarry Smith           PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
30fde5950dSBarry Smith           PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
31fde5950dSBarry Smith           PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
32fde5950dSBarry Smith           PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
33fde5950dSBarry Smith           PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
34fde5950dSBarry Smith           PetscOptionsFList(), PetscOptionsEList()
35fde5950dSBarry Smith @*/
36721cd6eeSBarry 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*))
37fde5950dSBarry Smith {
38fde5950dSBarry Smith   PetscErrorCode    ierr;
39fde5950dSBarry Smith   PetscViewer       viewer;
40fde5950dSBarry Smith   PetscViewerFormat format;
41fde5950dSBarry Smith   PetscBool         flg;
42fde5950dSBarry Smith 
43fde5950dSBarry Smith   PetscFunctionBegin;
44fde5950dSBarry Smith   ierr = PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts),((PetscObject)ts)->prefix,name,&viewer,&format,&flg);CHKERRQ(ierr);
45fde5950dSBarry Smith   if (flg) {
46721cd6eeSBarry Smith     PetscViewerAndFormat *vf;
47721cd6eeSBarry Smith     ierr = PetscViewerAndFormatCreate(viewer,format,&vf);CHKERRQ(ierr);
48721cd6eeSBarry Smith     ierr = PetscObjectDereference((PetscObject)viewer);CHKERRQ(ierr);
49fde5950dSBarry Smith     if (monitorsetup) {
50721cd6eeSBarry Smith       ierr = (*monitorsetup)(ts,vf);CHKERRQ(ierr);
51fde5950dSBarry Smith     }
52721cd6eeSBarry Smith     ierr = TSMonitorSet(ts,(PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,void*))monitor,vf,(PetscErrorCode (*)(void**))PetscViewerAndFormatDestroy);CHKERRQ(ierr);
53fde5950dSBarry Smith   }
54fde5950dSBarry Smith   PetscFunctionReturn(0);
55fde5950dSBarry Smith }
56fde5950dSBarry Smith 
572ffb9264SLisandro Dalcin static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt,TSAdaptType default_type)
582ffb9264SLisandro Dalcin {
592ffb9264SLisandro Dalcin   PetscErrorCode ierr;
602ffb9264SLisandro Dalcin 
612ffb9264SLisandro Dalcin   PetscFunctionBegin;
62b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt,TSADAPT_CLASSID,1);
63b92453a8SLisandro Dalcin   PetscValidCharPointer(default_type,2);
642ffb9264SLisandro Dalcin   if (!((PetscObject)adapt)->type_name) {
652ffb9264SLisandro Dalcin     ierr = TSAdaptSetType(adapt,default_type);CHKERRQ(ierr);
662ffb9264SLisandro Dalcin   }
672ffb9264SLisandro Dalcin   PetscFunctionReturn(0);
682ffb9264SLisandro Dalcin }
692ffb9264SLisandro Dalcin 
70bdad233fSMatthew Knepley /*@
71bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
72bdad233fSMatthew Knepley 
73bdad233fSMatthew Knepley    Collective on TS
74bdad233fSMatthew Knepley 
75bdad233fSMatthew Knepley    Input Parameter:
76bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
77bdad233fSMatthew Knepley 
78bdad233fSMatthew Knepley    Options Database Keys:
79e49d4f37SHong Zhang +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSALPHA, TSGLLE, TSSSP, TSGLEE, TSBSYMP
80ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
81ef85077eSLisandro Dalcin .  -ts_max_time <time> - maximum time to compute to
82ef85077eSLisandro Dalcin .  -ts_max_steps <steps> - maximum number of time-steps to take
83ef85077eSLisandro Dalcin .  -ts_init_time <time> - initial time to start computation
84ef85077eSLisandro Dalcin .  -ts_final_time <time> - final time to compute to
853e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
86a3cdaa26SBarry 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
87a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
88a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
89a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
90a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
91a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
92f3b1f45cSBarry Smith .  -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - test the Jacobian at each iteration against finite difference with RHS function
93f3b1f45cSBarry Smith .  -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - test the Jacobian at each iteration against finite difference with RHS function
94ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
95847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
96bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
97de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
98de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
997cf37e64SBarry Smith .  -ts_monitor_error - Monitors norm of error
1006934998bSLisandro Dalcin .  -ts_monitor_lg_timestep - Monitor timestep size graphically
1018b668821SLisandro Dalcin .  -ts_monitor_lg_timestep_log - Monitor log timestep size graphically
102de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
103de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
104de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
105de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
1063e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
1073e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
108fde5950dSBarry Smith .  -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
109e4160dc7SJulian Andrej .  -ts_monitor_solution_vtk <filename.vts,filename.vtu> - Save each time step to a binary file, use filename-%%03D.vts (filename-%%03D.vtu)
110110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
11153ea634cSHong Zhang 
11291b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
113bdad233fSMatthew Knepley 
114bdad233fSMatthew Knepley    Level: beginner
115bdad233fSMatthew Knepley 
116bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
117bdad233fSMatthew Knepley 
118a313700dSBarry Smith .seealso: TSGetType()
119bdad233fSMatthew Knepley @*/
1207087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
121bdad233fSMatthew Knepley {
122bc952696SBarry Smith   PetscBool              opt,flg,tflg;
123dfbe8321SBarry Smith   PetscErrorCode         ierr;
124eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
12531748224SBarry Smith   PetscReal              time_step;
12649354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
127d1212d36SBarry Smith   char                   dir[16];
128cd11d68dSLisandro Dalcin   TSIFunction            ifun;
1296991f827SBarry Smith   const char             *defaultType;
1306991f827SBarry Smith   char                   typeName[256];
131bdad233fSMatthew Knepley 
132bdad233fSMatthew Knepley   PetscFunctionBegin;
1330700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1346991f827SBarry Smith 
1356991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
136cd11d68dSLisandro Dalcin   ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
137cd11d68dSLisandro Dalcin 
138cd11d68dSLisandro Dalcin   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
139cd11d68dSLisandro Dalcin   if (((PetscObject)ts)->type_name)
140cd11d68dSLisandro Dalcin     defaultType = ((PetscObject)ts)->type_name;
141cd11d68dSLisandro Dalcin   else
142cd11d68dSLisandro Dalcin     defaultType = ifun ? TSBEULER : TSEULER;
1436991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type","TS method","TSSetType",TSList,defaultType,typeName,256,&opt);CHKERRQ(ierr);
1446991f827SBarry Smith   if (opt) {
1456991f827SBarry Smith     ierr = TSSetType(ts,typeName);CHKERRQ(ierr);
1466991f827SBarry Smith   } else {
1476991f827SBarry Smith     ierr = TSSetType(ts,defaultType);CHKERRQ(ierr);
1486991f827SBarry Smith   }
149bdad233fSMatthew Knepley 
150bdad233fSMatthew Knepley   /* Handle generic TS options */
151ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_max_time","Maximum time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
15219eac22cSLisandro Dalcin   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetMaxSteps",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1530298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
154ef85077eSLisandro Dalcin   ierr = PetscOptionsReal("-ts_final_time","Final time to run to","TSSetMaxTime",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
15531748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
156cd11d68dSLisandro Dalcin   if (flg) {ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);}
15749354f04SShri 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);
15849354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1590298fd71SBarry 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);
1600298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1610298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1620298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1630298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
164bdad233fSMatthew Knepley 
165f3b1f45cSBarry Smith   ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult","Test the RHS Jacobian for consistency with RHS at each solve ","None",ts->testjacobian,&ts->testjacobian,NULL);CHKERRQ(ierr);
166f3b1f45cSBarry Smith   ierr = PetscOptionsBool("-ts_rhs_jacobian_test_mult_transpose","Test the RHS Jacobian transpose for consistency with RHS at each solve ","None",ts->testjacobiantranspose,&ts->testjacobiantranspose,NULL);CHKERRQ(ierr);
16756f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
16856f85f32SBarry Smith   {
16956f85f32SBarry Smith   PetscBool set;
17056f85f32SBarry Smith   flg  = PETSC_FALSE;
17156f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
17256f85f32SBarry Smith   if (set) {
17356f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
17456f85f32SBarry Smith   }
17556f85f32SBarry Smith   }
17656f85f32SBarry Smith #endif
17756f85f32SBarry Smith 
178bdad233fSMatthew Knepley   /* Monitor options */
179cd11d68dSLisandro Dalcin   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor","Monitor time and timestep size","TSMonitorDefault",TSMonitorDefault,NULL);CHKERRQ(ierr);
180cc9c3a59SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_extreme","Monitor extreme values of the solution","TSMonitorExtreme",TSMonitorExtreme,NULL);CHKERRQ(ierr);
181fde5950dSBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_solution","View the solution at each timestep","TSMonitorSolution",TSMonitorSolution,NULL);CHKERRQ(ierr);
182fde5950dSBarry Smith 
1835180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1845180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1855180491cSLisandro Dalcin 
1864f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
187b3603a34SBarry Smith   if (opt) {
1880b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1893923b477SBarry Smith     PetscInt       howoften = 1;
190b3603a34SBarry Smith 
1910298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
1926ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
1934f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
194bdad233fSMatthew Knepley   }
1956ba87a44SLisandro Dalcin 
1964f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
197ef20d060SBarry Smith   if (opt) {
1980b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1993923b477SBarry Smith     PetscInt       howoften = 1;
200ef20d060SBarry Smith 
2010298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
2026ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2034f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
204ef20d060SBarry Smith   }
205edbaebb3SBarry Smith   ierr = TSMonitorSetFromOptions(ts,"-ts_monitor_error","View the error at each timestep","TSMonitorError",TSMonitorError,NULL);CHKERRQ(ierr);
2067cf37e64SBarry Smith 
2076934998bSLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2086934998bSLisandro Dalcin   if (opt) {
2096934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
2106934998bSLisandro Dalcin     PetscInt       howoften = 1;
2116934998bSLisandro Dalcin 
2126934998bSLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2136ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2146934998bSLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2156934998bSLisandro Dalcin   }
2168b668821SLisandro Dalcin   ierr = PetscOptionsName("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
2178b668821SLisandro Dalcin   if (opt) {
2188b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
2198b668821SLisandro Dalcin     PetscInt       howoften = 1;
2208b668821SLisandro Dalcin 
2218b668821SLisandro Dalcin     ierr = PetscOptionsInt("-ts_monitor_lg_timestep_log","Monitor log timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
2228b668821SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
2238b668821SLisandro Dalcin     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
2248b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
2258b668821SLisandro Dalcin   }
2268b668821SLisandro Dalcin 
227201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
228201da799SBarry Smith   if (opt) {
229201da799SBarry Smith     TSMonitorLGCtx ctx;
230201da799SBarry Smith     PetscInt       howoften = 1;
231201da799SBarry Smith 
2320298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2336ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
234201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
235201da799SBarry Smith   }
236201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
237201da799SBarry Smith   if (opt) {
238201da799SBarry Smith     TSMonitorLGCtx ctx;
239201da799SBarry Smith     PetscInt       howoften = 1;
240201da799SBarry Smith 
2410298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
2426ba87a44SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,400,300,howoften,&ctx);CHKERRQ(ierr);
243201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
244201da799SBarry Smith   }
2458189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2468189c53fSBarry Smith   if (opt) {
2478189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2488189c53fSBarry Smith     PetscInt          howoften = 1;
2498189c53fSBarry Smith 
2500298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
2516934998bSLisandro Dalcin     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
2528189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2538189c53fSBarry Smith   }
254*0ec8ee2bSJoseph Pusztay   ierr = PetscOptionsName("-ts_monitor_sp_swarm","Display particle phase from the DMSwarm","TSMonitorSPSwarm",&opt);CHKERRQ(ierr);
2551b575b74SJoseph Pusztay   if (opt) {
2561b575b74SJoseph Pusztay     TSMonitorSPCtx  ctx;
2571b575b74SJoseph Pusztay     PetscInt        howoften = 1;
258*0ec8ee2bSJoseph Pusztay     ierr = PetscOptionsInt("-ts_monitor_sp_swarm","Display particles phase from the DMSwarm","TSMonitorSPSwarm",howoften,&howoften,NULL);CHKERRQ(ierr);
2591b575b74SJoseph Pusztay     ierr = TSMonitorSPCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx);CHKERRQ(ierr);
260*0ec8ee2bSJoseph Pusztay     ierr = TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode (*)(void**))TSMonitorSPCtxDestroy);CHKERRQ(ierr);
2611b575b74SJoseph Pusztay   }
262ef20d060SBarry Smith   opt  = PETSC_FALSE;
2630dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
264a7cc72afSBarry Smith   if (opt) {
26583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
26683a4ac43SBarry Smith     PetscInt         howoften = 1;
267a80ad3e0SBarry Smith 
2680298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
2690ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Computed Solution",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
27083a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
271bdad233fSMatthew Knepley   }
272fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2732d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2742d5ee99bSBarry Smith   if (opt) {
2752d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2762d5ee99bSBarry Smith     PetscReal        bounds[4];
2772d5ee99bSBarry Smith     PetscInt         n = 4;
2782d5ee99bSBarry Smith     PetscDraw        draw;
2796934998bSLisandro Dalcin     PetscDrawAxis    axis;
2802d5ee99bSBarry Smith 
2812d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2822d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2836934998bSLisandro Dalcin     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,1,&ctx);CHKERRQ(ierr);
2842d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2856934998bSLisandro Dalcin     ierr = PetscViewerDrawGetDrawAxis(ctx->viewer,0,&axis);CHKERRQ(ierr);
2866934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLimits(axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
2876934998bSLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2882d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2892d5ee99bSBarry Smith   }
2902d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2910dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2923a471f94SBarry Smith   if (opt) {
29383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
29483a4ac43SBarry Smith     PetscInt         howoften = 1;
2953a471f94SBarry Smith 
2960298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
2970ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Error",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
29883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2993a471f94SBarry Smith   }
3000ed3bfb6SBarry Smith   opt  = PETSC_FALSE;
3010ed3bfb6SBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",&opt);CHKERRQ(ierr);
3020ed3bfb6SBarry Smith   if (opt) {
3030ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3040ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3050ed3bfb6SBarry Smith 
3060ed3bfb6SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution_function","Monitor solution provided by TSMonitorSetSolutionFunction() graphically","TSMonitorDrawSolutionFunction",howoften,&howoften,NULL);CHKERRQ(ierr);
3070ed3bfb6SBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,"Solution provided by user function",PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
3080ed3bfb6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionFunction,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
3090ed3bfb6SBarry Smith   }
310fde5950dSBarry Smith 
311ed81e22dSJed Brown   opt  = PETSC_FALSE;
31291b97e58SBarry 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);
313ed81e22dSJed Brown   if (flg) {
314ed81e22dSJed Brown     const char *ptr,*ptr2;
315ed81e22dSJed Brown     char       *filetemplate;
316ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
317ed81e22dSJed Brown     /* Do some cursory validation of the input. */
318ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
319ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
320ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
321ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
322ce94432eSBarry 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");
323ed81e22dSJed Brown       if (ptr2) break;
324ed81e22dSJed Brown     }
325ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
326ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
327ed81e22dSJed Brown   }
328bdad233fSMatthew Knepley 
329d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
330d1212d36SBarry Smith   if (flg) {
331d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
332d1212d36SBarry Smith     int                  ray = 0;
333d1212d36SBarry Smith     DMDADirection        ddir;
334d1212d36SBarry Smith     DM                   da;
335d1212d36SBarry Smith     PetscMPIInt          rank;
336d1212d36SBarry Smith 
337ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
338d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
339d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
340ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
341d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
342d1212d36SBarry Smith 
343d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
344b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
345d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
346d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
347ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
348d1212d36SBarry Smith     if (!rank) {
349d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
350d1212d36SBarry Smith     }
35151b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
352d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
353d1212d36SBarry Smith   }
35451b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
35551b4a12fSMatthew G. Knepley   if (flg) {
35651b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
35751b4a12fSMatthew G. Knepley     int                 ray = 0;
35851b4a12fSMatthew G. Knepley     DMDADirection       ddir;
35951b4a12fSMatthew G. Knepley     DM                  da;
36051b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
361d1212d36SBarry Smith 
36251b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
36351b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
36451b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
36551b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
36651b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3671c3436cfSJed Brown 
36851b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
369b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
37051b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
37151b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
37251b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
37351b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
37451b4a12fSMatthew G. Knepley   }
375a7a1495cSBarry Smith 
376b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
377b3d3934dSBarry Smith   if (opt) {
378b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
379b3d3934dSBarry Smith 
380b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
381b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
382b3d3934dSBarry Smith   }
383b3d3934dSBarry Smith 
384847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
385847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
386847ff0e1SMatthew G. Knepley   if (flg) {
387847ff0e1SMatthew G. Knepley     DM   dm;
388847ff0e1SMatthew G. Knepley     DMTS tdm;
389847ff0e1SMatthew G. Knepley 
390847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
391847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
392847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
393847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
394847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
395847ff0e1SMatthew G. Knepley   }
396847ff0e1SMatthew G. Knepley 
397d763cef2SBarry Smith   /* Handle specific TS options */
398d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
3996991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
400d763cef2SBarry Smith   }
401fbc52257SHong Zhang 
402a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
403a7bdc993SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
404a7bdc993SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
405a7bdc993SLisandro Dalcin   ierr = TSAdaptSetFromOptions(PetscOptionsObject,ts->adapt);CHKERRQ(ierr);
406a7bdc993SLisandro Dalcin 
40768bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4084f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
40968bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
41068bece0bSHong Zhang   if (tflg) {
41168bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
41268bece0bSHong Zhang   }
413a05bf03eSHong Zhang 
414a05bf03eSHong Zhang   ierr = TSAdjointSetFromOptions(PetscOptionsObject,ts);CHKERRQ(ierr);
415d763cef2SBarry Smith 
416d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
4170633abcbSJed Brown   ierr = PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)ts);CHKERRQ(ierr);
418fbc52257SHong Zhang   ierr = PetscOptionsEnd();CHKERRQ(ierr);
419d763cef2SBarry Smith 
4204f122a70SLisandro Dalcin   if (ts->trajectory) {
4214f122a70SLisandro Dalcin     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
422d763cef2SBarry Smith   }
42368bece0bSHong Zhang 
4244f122a70SLisandro Dalcin   ierr = TSGetSNES(ts,&ts->snes);CHKERRQ(ierr);
4254f122a70SLisandro Dalcin   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);}
4264f122a70SLisandro Dalcin   ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
427d763cef2SBarry Smith   PetscFunctionReturn(0);
428d763cef2SBarry Smith }
429d763cef2SBarry Smith 
430d2daff3dSHong Zhang /*@
43178fbdcc8SBarry Smith    TSGetTrajectory - Gets the trajectory from a TS if it exists
43278fbdcc8SBarry Smith 
43378fbdcc8SBarry Smith    Collective on TS
43478fbdcc8SBarry Smith 
43578fbdcc8SBarry Smith    Input Parameters:
43678fbdcc8SBarry Smith .  ts - the TS context obtained from TSCreate()
43778fbdcc8SBarry Smith 
43878fbdcc8SBarry Smith    Output Parameters;
43978fbdcc8SBarry Smith .  tr - the TSTrajectory object, if it exists
44078fbdcc8SBarry Smith 
44178fbdcc8SBarry Smith    Note: This routine should be called after all TS options have been set
44278fbdcc8SBarry Smith 
44378fbdcc8SBarry Smith    Level: advanced
44478fbdcc8SBarry Smith 
44578fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectory, TSTrajectoryCreate()
44678fbdcc8SBarry Smith 
44778fbdcc8SBarry Smith .keywords: TS, set, checkpoint,
44878fbdcc8SBarry Smith @*/
44978fbdcc8SBarry Smith PetscErrorCode  TSGetTrajectory(TS ts,TSTrajectory *tr)
45078fbdcc8SBarry Smith {
45178fbdcc8SBarry Smith   PetscFunctionBegin;
45278fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45378fbdcc8SBarry Smith   *tr = ts->trajectory;
45478fbdcc8SBarry Smith   PetscFunctionReturn(0);
45578fbdcc8SBarry Smith }
45678fbdcc8SBarry Smith 
45778fbdcc8SBarry Smith /*@
458bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
459d2daff3dSHong Zhang 
460d2daff3dSHong Zhang    Collective on TS
461d2daff3dSHong Zhang 
462d2daff3dSHong Zhang    Input Parameters:
463bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
464bc952696SBarry Smith 
46578fbdcc8SBarry Smith    Options Database:
46678fbdcc8SBarry Smith +  -ts_save_trajectory - saves the trajectory to a file
46778fbdcc8SBarry Smith -  -ts_trajectory_type type
46878fbdcc8SBarry Smith 
46968bece0bSHong Zhang Note: This routine should be called after all TS options have been set
470d2daff3dSHong Zhang 
471c3a89c15SBarry Smith     The TSTRAJECTORYVISUALIZATION files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and
47278fbdcc8SBarry Smith    MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
47378fbdcc8SBarry Smith 
474d2daff3dSHong Zhang    Level: intermediate
475d2daff3dSHong Zhang 
47678fbdcc8SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve(), TSTrajectoryType, TSSetTrajectoryType()
477d2daff3dSHong Zhang 
478bc952696SBarry Smith .keywords: TS, set, checkpoint,
479d2daff3dSHong Zhang @*/
480bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
481d2daff3dSHong Zhang {
482bc952696SBarry Smith   PetscErrorCode ierr;
483bc952696SBarry Smith 
484d2daff3dSHong Zhang   PetscFunctionBegin;
485d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
486bc952696SBarry Smith   if (!ts->trajectory) {
487bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
488bc952696SBarry Smith   }
489d2daff3dSHong Zhang   PetscFunctionReturn(0);
490d2daff3dSHong Zhang }
491d2daff3dSHong Zhang 
492a7a1495cSBarry Smith /*@
493a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
494a7a1495cSBarry Smith       set with TSSetRHSJacobian().
495a7a1495cSBarry Smith 
496a7a1495cSBarry Smith    Collective on TS and Vec
497a7a1495cSBarry Smith 
498a7a1495cSBarry Smith    Input Parameters:
499316643e7SJed Brown +  ts - the TS context
500a7a1495cSBarry Smith .  t - current timestep
5010910c330SBarry Smith -  U - input vector
502a7a1495cSBarry Smith 
503a7a1495cSBarry Smith    Output Parameters:
504a7a1495cSBarry Smith +  A - Jacobian matrix
505a7a1495cSBarry Smith .  B - optional preconditioning matrix
506a7a1495cSBarry Smith -  flag - flag indicating matrix structure
507a7a1495cSBarry Smith 
508a7a1495cSBarry Smith    Notes:
509a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
510a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
511a7a1495cSBarry Smith 
51294b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
513a7a1495cSBarry Smith    flag parameter.
514a7a1495cSBarry Smith 
515a7a1495cSBarry Smith    Level: developer
516a7a1495cSBarry Smith 
517a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
518a7a1495cSBarry Smith 
51994b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
520a7a1495cSBarry Smith @*/
521d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
522a7a1495cSBarry Smith {
523dfbe8321SBarry Smith   PetscErrorCode   ierr;
524270bf2e7SJed Brown   PetscObjectState Ustate;
5256c1e1eecSBarry Smith   PetscObjectId    Uid;
52624989b8cSPeter Brune   DM               dm;
527942e3340SBarry Smith   DMTS             tsdm;
52824989b8cSPeter Brune   TSRHSJacobian    rhsjacobianfunc;
52924989b8cSPeter Brune   void             *ctx;
53024989b8cSPeter Brune   TSIJacobian      ijacobianfunc;
531b2df71adSDebojyoti Ghosh   TSRHSFunction    rhsfunction;
532a7a1495cSBarry Smith 
533a7a1495cSBarry Smith   PetscFunctionBegin;
5340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5350910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5360910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
53724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
538942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
53924989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
5400298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
541b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
54259e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
5436c1e1eecSBarry Smith   ierr = PetscObjectGetId((PetscObject)U,&Uid);CHKERRQ(ierr);
5446c1e1eecSBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
5450e4ef248SJed Brown     PetscFunctionReturn(0);
546f8ede8e7SJed Brown   }
547d90be118SSean Farley 
548ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
549d90be118SSean Farley 
550e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
55194ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
55294ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
553303f9b21SStefano Zampini     if (B && A != B) {
55494ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
55594ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
556e1244c69SJed Brown     }
557e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
558e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
559e1244c69SJed Brown   }
560e1244c69SJed Brown 
56124989b8cSPeter Brune   if (rhsjacobianfunc) {
5626cd88445SBarry Smith     PetscBool missing;
56394ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
564a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
565d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
566a7a1495cSBarry Smith     PetscStackPop;
56794ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
5686cd88445SBarry Smith     if (A) {
5696cd88445SBarry Smith       ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
5706cd88445SBarry 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");
5716cd88445SBarry Smith     }
5726cd88445SBarry Smith     if (B && B != A) {
5736cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
5746cd88445SBarry 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");
5756cd88445SBarry Smith     }
576ef66eb69SBarry Smith   } else {
57794ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
57894ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
579ef66eb69SBarry Smith   }
5800e4ef248SJed Brown   ts->rhsjacobian.time       = t;
5817f79407eSBarry Smith   ierr                       = PetscObjectGetId((PetscObject)U,&ts->rhsjacobian.Xid);CHKERRQ(ierr);
58259e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
583a7a1495cSBarry Smith   PetscFunctionReturn(0);
584a7a1495cSBarry Smith }
585a7a1495cSBarry Smith 
586316643e7SJed Brown /*@
587d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
588d763cef2SBarry Smith 
589316643e7SJed Brown    Collective on TS and Vec
590316643e7SJed Brown 
591316643e7SJed Brown    Input Parameters:
592316643e7SJed Brown +  ts - the TS context
593316643e7SJed Brown .  t - current time
5940910c330SBarry Smith -  U - state vector
595316643e7SJed Brown 
596316643e7SJed Brown    Output Parameter:
597316643e7SJed Brown .  y - right hand side
598316643e7SJed Brown 
599316643e7SJed Brown    Note:
600316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
601316643e7SJed Brown    is used internally within the nonlinear solvers.
602316643e7SJed Brown 
603316643e7SJed Brown    Level: developer
604316643e7SJed Brown 
605316643e7SJed Brown .keywords: TS, compute
606316643e7SJed Brown 
607316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
608316643e7SJed Brown @*/
6090910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
610d763cef2SBarry Smith {
611dfbe8321SBarry Smith   PetscErrorCode ierr;
61224989b8cSPeter Brune   TSRHSFunction  rhsfunction;
61324989b8cSPeter Brune   TSIFunction    ifunction;
61424989b8cSPeter Brune   void           *ctx;
61524989b8cSPeter Brune   DM             dm;
61624989b8cSPeter Brune 
617d763cef2SBarry Smith   PetscFunctionBegin;
6180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6190910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6200700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
62124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
62224989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
6230298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
624d763cef2SBarry Smith 
625ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
626d763cef2SBarry Smith 
6270910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
62824989b8cSPeter Brune   if (rhsfunction) {
629d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
6300910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
631d763cef2SBarry Smith     PetscStackPop;
632214bc6a2SJed Brown   } else {
633214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
634b2cd27e8SJed Brown   }
63544a41b28SSean Farley 
6360910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
637d763cef2SBarry Smith   PetscFunctionReturn(0);
638d763cef2SBarry Smith }
639d763cef2SBarry Smith 
640ef20d060SBarry Smith /*@
641ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
642ef20d060SBarry Smith 
643ef20d060SBarry Smith    Collective on TS and Vec
644ef20d060SBarry Smith 
645ef20d060SBarry Smith    Input Parameters:
646ef20d060SBarry Smith +  ts - the TS context
647ef20d060SBarry Smith -  t - current time
648ef20d060SBarry Smith 
649ef20d060SBarry Smith    Output Parameter:
6500910c330SBarry Smith .  U - the solution
651ef20d060SBarry Smith 
652ef20d060SBarry Smith    Note:
653ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
654ef20d060SBarry Smith    is used internally within the nonlinear solvers.
655ef20d060SBarry Smith 
656ef20d060SBarry Smith    Level: developer
657ef20d060SBarry Smith 
658ef20d060SBarry Smith .keywords: TS, compute
659ef20d060SBarry Smith 
660abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
661ef20d060SBarry Smith @*/
6620910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
663ef20d060SBarry Smith {
664ef20d060SBarry Smith   PetscErrorCode     ierr;
665ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
666ef20d060SBarry Smith   void               *ctx;
667ef20d060SBarry Smith   DM                 dm;
668ef20d060SBarry Smith 
669ef20d060SBarry Smith   PetscFunctionBegin;
670ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6710910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
672ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
673ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
674ef20d060SBarry Smith 
675ef20d060SBarry Smith   if (solutionfunction) {
6769b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6770910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
678ef20d060SBarry Smith     PetscStackPop;
679ef20d060SBarry Smith   }
680ef20d060SBarry Smith   PetscFunctionReturn(0);
681ef20d060SBarry Smith }
6829b7cd975SBarry Smith /*@
6839b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6849b7cd975SBarry Smith 
6859b7cd975SBarry Smith    Collective on TS and Vec
6869b7cd975SBarry Smith 
6879b7cd975SBarry Smith    Input Parameters:
6889b7cd975SBarry Smith +  ts - the TS context
6899b7cd975SBarry Smith -  t - current time
6909b7cd975SBarry Smith 
6919b7cd975SBarry Smith    Output Parameter:
6929b7cd975SBarry Smith .  U - the function value
6939b7cd975SBarry Smith 
6949b7cd975SBarry Smith    Note:
6959b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6969b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6979b7cd975SBarry Smith 
6989b7cd975SBarry Smith    Level: developer
6999b7cd975SBarry Smith 
7009b7cd975SBarry Smith .keywords: TS, compute
7019b7cd975SBarry Smith 
7029b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
7039b7cd975SBarry Smith @*/
7049b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
7059b7cd975SBarry Smith {
7069b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
7079b7cd975SBarry Smith   void               *ctx;
7089b7cd975SBarry Smith   DM                 dm;
7099b7cd975SBarry Smith 
7109b7cd975SBarry Smith   PetscFunctionBegin;
7119b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7129b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7139b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
7149b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
7159b7cd975SBarry Smith 
7169b7cd975SBarry Smith   if (forcing) {
7179b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
7189b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
7199b7cd975SBarry Smith     PetscStackPop;
7209b7cd975SBarry Smith   }
7219b7cd975SBarry Smith   PetscFunctionReturn(0);
7229b7cd975SBarry Smith }
723ef20d060SBarry Smith 
724214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
725214bc6a2SJed Brown {
7262dd45cf8SJed Brown   Vec            F;
727214bc6a2SJed Brown   PetscErrorCode ierr;
728214bc6a2SJed Brown 
729214bc6a2SJed Brown   PetscFunctionBegin;
7300298fd71SBarry Smith   *Frhs = NULL;
7310298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
732214bc6a2SJed Brown   if (!ts->Frhs) {
7332dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
734214bc6a2SJed Brown   }
735214bc6a2SJed Brown   *Frhs = ts->Frhs;
736214bc6a2SJed Brown   PetscFunctionReturn(0);
737214bc6a2SJed Brown }
738214bc6a2SJed Brown 
739214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
740214bc6a2SJed Brown {
741214bc6a2SJed Brown   Mat            A,B;
7422dd45cf8SJed Brown   PetscErrorCode ierr;
74341a1d4d2SBarry Smith   TSIJacobian    ijacobian;
744214bc6a2SJed Brown 
745214bc6a2SJed Brown   PetscFunctionBegin;
746c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
747c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
74841a1d4d2SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,&ijacobian,NULL);CHKERRQ(ierr);
749214bc6a2SJed Brown   if (Arhs) {
750214bc6a2SJed Brown     if (!ts->Arhs) {
75141a1d4d2SBarry Smith       if (ijacobian) {
752214bc6a2SJed Brown         ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
75341a1d4d2SBarry Smith       } else {
75441a1d4d2SBarry Smith         ts->Arhs = A;
75541a1d4d2SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
75641a1d4d2SBarry Smith       }
7573565c898SBarry Smith     } else {
7583565c898SBarry Smith       PetscBool flg;
7593565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
7603565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
7613565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs){
7623565c898SBarry Smith         ierr = PetscObjectDereference((PetscObject)ts->Arhs);CHKERRQ(ierr);
7633565c898SBarry Smith         ts->Arhs = A;
7643565c898SBarry Smith         ierr = PetscObjectReference((PetscObject)A);CHKERRQ(ierr);
7653565c898SBarry Smith       }
766214bc6a2SJed Brown     }
767214bc6a2SJed Brown     *Arhs = ts->Arhs;
768214bc6a2SJed Brown   }
769214bc6a2SJed Brown   if (Brhs) {
770214bc6a2SJed Brown     if (!ts->Brhs) {
771bdb70873SJed Brown       if (A != B) {
77241a1d4d2SBarry Smith         if (ijacobian) {
773214bc6a2SJed Brown           ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
774bdb70873SJed Brown         } else {
77541a1d4d2SBarry Smith           ts->Brhs = B;
77641a1d4d2SBarry Smith           ierr = PetscObjectReference((PetscObject)B);CHKERRQ(ierr);
77741a1d4d2SBarry Smith         }
77841a1d4d2SBarry Smith       } else {
779bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
78051699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
781bdb70873SJed Brown       }
782214bc6a2SJed Brown     }
783214bc6a2SJed Brown     *Brhs = ts->Brhs;
784214bc6a2SJed Brown   }
785214bc6a2SJed Brown   PetscFunctionReturn(0);
786214bc6a2SJed Brown }
787214bc6a2SJed Brown 
788316643e7SJed Brown /*@
7890910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
790316643e7SJed Brown 
791316643e7SJed Brown    Collective on TS and Vec
792316643e7SJed Brown 
793316643e7SJed Brown    Input Parameters:
794316643e7SJed Brown +  ts - the TS context
795316643e7SJed Brown .  t - current time
7960910c330SBarry Smith .  U - state vector
7970910c330SBarry Smith .  Udot - time derivative of state vector
798214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
799316643e7SJed Brown 
800316643e7SJed Brown    Output Parameter:
801316643e7SJed Brown .  Y - right hand side
802316643e7SJed Brown 
803316643e7SJed Brown    Note:
804316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
805316643e7SJed Brown    is used internally within the nonlinear solvers.
806316643e7SJed Brown 
807316643e7SJed Brown    If the user did did not write their equations in implicit form, this
808316643e7SJed Brown    function recasts them in implicit form.
809316643e7SJed Brown 
810316643e7SJed Brown    Level: developer
811316643e7SJed Brown 
812316643e7SJed Brown .keywords: TS, compute
813316643e7SJed Brown 
814316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
815316643e7SJed Brown @*/
8160910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
817316643e7SJed Brown {
818316643e7SJed Brown   PetscErrorCode ierr;
81924989b8cSPeter Brune   TSIFunction    ifunction;
82024989b8cSPeter Brune   TSRHSFunction  rhsfunction;
82124989b8cSPeter Brune   void           *ctx;
82224989b8cSPeter Brune   DM             dm;
823316643e7SJed Brown 
824316643e7SJed Brown   PetscFunctionBegin;
8250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8260910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8270910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
8280700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
829316643e7SJed Brown 
83024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
83124989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
8320298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
83324989b8cSPeter Brune 
834ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
835d90be118SSean Farley 
8360910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
83724989b8cSPeter Brune   if (ifunction) {
838316643e7SJed Brown     PetscStackPush("TS user implicit function");
8390910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
840316643e7SJed Brown     PetscStackPop;
841214bc6a2SJed Brown   }
842214bc6a2SJed Brown   if (imex) {
84324989b8cSPeter Brune     if (!ifunction) {
8440910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
8452dd45cf8SJed Brown     }
84624989b8cSPeter Brune   } else if (rhsfunction) {
84724989b8cSPeter Brune     if (ifunction) {
848214bc6a2SJed Brown       Vec Frhs;
849214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
8500910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
851214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
8522dd45cf8SJed Brown     } else {
8530910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
8540910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
855316643e7SJed Brown     }
8564a6899ffSJed Brown   }
8570910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
858316643e7SJed Brown   PetscFunctionReturn(0);
859316643e7SJed Brown }
860316643e7SJed Brown 
861316643e7SJed Brown /*@
862316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
863316643e7SJed Brown 
864316643e7SJed Brown    Collective on TS and Vec
865316643e7SJed Brown 
866316643e7SJed Brown    Input
867316643e7SJed Brown       Input Parameters:
868316643e7SJed Brown +  ts - the TS context
869316643e7SJed Brown .  t - current timestep
8700910c330SBarry Smith .  U - state vector
8710910c330SBarry Smith .  Udot - time derivative of state vector
872214bc6a2SJed Brown .  shift - shift to apply, see note below
873214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
874316643e7SJed Brown 
875316643e7SJed Brown    Output Parameters:
876316643e7SJed Brown +  A - Jacobian matrix
8773565c898SBarry Smith -  B - matrix from which the preconditioner is constructed; often the same as A
878316643e7SJed Brown 
879316643e7SJed Brown    Notes:
8800910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
881316643e7SJed Brown 
8820910c330SBarry Smith    dF/dU + shift*dF/dUdot
883316643e7SJed Brown 
884316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
885316643e7SJed Brown    is used internally within the nonlinear solvers.
886316643e7SJed Brown 
887316643e7SJed Brown    Level: developer
888316643e7SJed Brown 
889316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
890316643e7SJed Brown 
891316643e7SJed Brown .seealso:  TSSetIJacobian()
89263495f91SJed Brown @*/
893d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
894316643e7SJed Brown {
895316643e7SJed Brown   PetscErrorCode ierr;
89624989b8cSPeter Brune   TSIJacobian    ijacobian;
89724989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
89824989b8cSPeter Brune   DM             dm;
89924989b8cSPeter Brune   void           *ctx;
900316643e7SJed Brown 
901316643e7SJed Brown   PetscFunctionBegin;
9020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9030910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
9040910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
905316643e7SJed Brown   PetscValidPointer(A,6);
90694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
907316643e7SJed Brown   PetscValidPointer(B,7);
90894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
90924989b8cSPeter Brune 
91024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
9120298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
91324989b8cSPeter Brune 
914ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
915316643e7SJed Brown 
91694ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
91724989b8cSPeter Brune   if (ijacobian) {
9186cd88445SBarry Smith     PetscBool missing;
919316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
920d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
921316643e7SJed Brown     PetscStackPop;
9226cd88445SBarry Smith     ierr = MatMissingDiagonal(A,&missing,NULL);CHKERRQ(ierr);
9236cd88445SBarry 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");
9243565c898SBarry Smith     if (B != A) {
9256cd88445SBarry Smith       ierr = MatMissingDiagonal(B,&missing,NULL);CHKERRQ(ierr);
9266cd88445SBarry 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");
9276cd88445SBarry Smith     }
9284a6899ffSJed Brown   }
929214bc6a2SJed Brown   if (imex) {
930b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
9314c26be97Sstefano_zampini       PetscBool assembled;
93294ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
9334c26be97Sstefano_zampini       ierr = MatAssembled(A,&assembled);CHKERRQ(ierr);
9344c26be97Sstefano_zampini       if (!assembled) {
9354c26be97Sstefano_zampini         ierr = MatAssemblyBegin(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9364c26be97Sstefano_zampini         ierr = MatAssemblyEnd(A,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9374c26be97Sstefano_zampini       }
93894ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
93994ab13aaSBarry Smith       if (A != B) {
94094ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
9414c26be97Sstefano_zampini         ierr = MatAssembled(B,&assembled);CHKERRQ(ierr);
9424c26be97Sstefano_zampini         if (!assembled) {
9434c26be97Sstefano_zampini           ierr = MatAssemblyBegin(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9444c26be97Sstefano_zampini           ierr = MatAssemblyEnd(B,MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
9454c26be97Sstefano_zampini         }
94694ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
947214bc6a2SJed Brown       }
948214bc6a2SJed Brown     }
949214bc6a2SJed Brown   } else {
950e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
951e1244c69SJed Brown     if (rhsjacobian) {
952214bc6a2SJed Brown       ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
953d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
954e1244c69SJed Brown     }
95594ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
9563565c898SBarry Smith       PetscBool flg;
957e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
958e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
9593565c898SBarry Smith       ierr = SNESGetUseMatrixFree(ts->snes,NULL,&flg);CHKERRQ(ierr);
9603565c898SBarry Smith       /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
9613565c898SBarry Smith       if (!flg) {
96294ab13aaSBarry Smith         ierr = MatScale(A,-1);CHKERRQ(ierr);
96394ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
9643565c898SBarry Smith       }
96594ab13aaSBarry Smith       if (A != B) {
96694ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
96794ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
968316643e7SJed Brown       }
969e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
970e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
971e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
97294ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
97394ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
97494ab13aaSBarry Smith         if (A != B) {
97594ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
97694ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
977214bc6a2SJed Brown         }
978316643e7SJed Brown       }
97994ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
98094ab13aaSBarry Smith       if (A != B) {
98194ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
982316643e7SJed Brown       }
983316643e7SJed Brown     }
984316643e7SJed Brown   }
98594ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
986316643e7SJed Brown   PetscFunctionReturn(0);
987316643e7SJed Brown }
988316643e7SJed Brown 
989d763cef2SBarry Smith /*@C
990d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
991b5abc632SBarry Smith     where U_t = G(t,u).
992d763cef2SBarry Smith 
9933f9fe445SBarry Smith     Logically Collective on TS
994d763cef2SBarry Smith 
995d763cef2SBarry Smith     Input Parameters:
996d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
9970298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
998d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
999d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
10000298fd71SBarry Smith           function evaluation routine (may be NULL)
1001d763cef2SBarry Smith 
1002d763cef2SBarry Smith     Calling sequence of func:
100387828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
1004d763cef2SBarry Smith 
1005d763cef2SBarry Smith +   t - current timestep
1006d763cef2SBarry Smith .   u - input vector
1007d763cef2SBarry Smith .   F - function vector
1008d763cef2SBarry Smith -   ctx - [optional] user-defined function context
1009d763cef2SBarry Smith 
1010d763cef2SBarry Smith     Level: beginner
1011d763cef2SBarry Smith 
101295452b02SPatrick Sanan     Notes:
101395452b02SPatrick Sanan     You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
10142bbac0d3SBarry Smith 
1015d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1016d763cef2SBarry Smith 
1017ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
1018d763cef2SBarry Smith @*/
1019089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
1020d763cef2SBarry Smith {
1021089b2837SJed Brown   PetscErrorCode ierr;
1022089b2837SJed Brown   SNES           snes;
10230298fd71SBarry Smith   Vec            ralloc = NULL;
102424989b8cSPeter Brune   DM             dm;
1025d763cef2SBarry Smith 
1026089b2837SJed Brown   PetscFunctionBegin;
10270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1028ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
102924989b8cSPeter Brune 
103024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
103124989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
1032089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1033e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
1034e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
1035e856ceecSJed Brown     r = ralloc;
1036e856ceecSJed Brown   }
1037089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
1038e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1039d763cef2SBarry Smith   PetscFunctionReturn(0);
1040d763cef2SBarry Smith }
1041d763cef2SBarry Smith 
1042ef20d060SBarry Smith /*@C
1043abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1044ef20d060SBarry Smith 
1045ef20d060SBarry Smith     Logically Collective on TS
1046ef20d060SBarry Smith 
1047ef20d060SBarry Smith     Input Parameters:
1048ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
1049ef20d060SBarry Smith .   f - routine for evaluating the solution
1050ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
10510298fd71SBarry Smith           function evaluation routine (may be NULL)
1052ef20d060SBarry Smith 
1053ef20d060SBarry Smith     Calling sequence of func:
1054ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
1055ef20d060SBarry Smith 
1056ef20d060SBarry Smith +   t - current timestep
1057ef20d060SBarry Smith .   u - output vector
1058ef20d060SBarry Smith -   ctx - [optional] user-defined function context
1059ef20d060SBarry Smith 
10600ed3bfb6SBarry Smith     Options Database:
10610ed3bfb6SBarry Smith +  -ts_monitor_lg_error - create a graphical monitor of error history, requires user to have provided TSSetSolutionFunction()
10620ed3bfb6SBarry Smith -  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
10630ed3bfb6SBarry Smith 
1064abd5a294SJed Brown     Notes:
1065abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
1066abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1067abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
1068abd5a294SJed Brown 
10694f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
1070abd5a294SJed Brown 
1071ef20d060SBarry Smith     Level: beginner
1072ef20d060SBarry Smith 
1073ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
1074ef20d060SBarry Smith 
10750ed3bfb6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction(), TSSetSolution(), TSGetSolution(), TSMonitorLGError(), TSMonitorDrawError()
1076ef20d060SBarry Smith @*/
1077ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
1078ef20d060SBarry Smith {
1079ef20d060SBarry Smith   PetscErrorCode ierr;
1080ef20d060SBarry Smith   DM             dm;
1081ef20d060SBarry Smith 
1082ef20d060SBarry Smith   PetscFunctionBegin;
1083ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1084ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1085ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
1086ef20d060SBarry Smith   PetscFunctionReturn(0);
1087ef20d060SBarry Smith }
1088ef20d060SBarry Smith 
10899b7cd975SBarry Smith /*@C
10909b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10919b7cd975SBarry Smith 
10929b7cd975SBarry Smith     Logically Collective on TS
10939b7cd975SBarry Smith 
10949b7cd975SBarry Smith     Input Parameters:
10959b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
1096e162b725SBarry Smith .   func - routine for evaluating the forcing function
10979b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
10980298fd71SBarry Smith           function evaluation routine (may be NULL)
10999b7cd975SBarry Smith 
11009b7cd975SBarry Smith     Calling sequence of func:
1101e162b725SBarry Smith $     func (TS ts,PetscReal t,Vec f,void *ctx);
11029b7cd975SBarry Smith 
11039b7cd975SBarry Smith +   t - current timestep
1104e162b725SBarry Smith .   f - output vector
11059b7cd975SBarry Smith -   ctx - [optional] user-defined function context
11069b7cd975SBarry Smith 
11079b7cd975SBarry Smith     Notes:
11089b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1109e162b725SBarry 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
1110e162b725SBarry Smith     definition of the problem you are solving and hence possibly introducing bugs.
1111e162b725SBarry Smith 
1112e162b725SBarry Smith     This replaces the ODE F(u,u_t,t) = 0 the TS is solving with F(u,u_t,t) - func(t) = 0
1113e162b725SBarry Smith 
1114e162b725SBarry 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
1115e162b725SBarry Smith     parameters can be passed in the ctx variable.
11169b7cd975SBarry Smith 
11179b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
11189b7cd975SBarry Smith 
11199b7cd975SBarry Smith     Level: beginner
11209b7cd975SBarry Smith 
11219b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
11229b7cd975SBarry Smith 
11239b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
11249b7cd975SBarry Smith @*/
1125e162b725SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,TSForcingFunction func,void *ctx)
11269b7cd975SBarry Smith {
11279b7cd975SBarry Smith   PetscErrorCode ierr;
11289b7cd975SBarry Smith   DM             dm;
11299b7cd975SBarry Smith 
11309b7cd975SBarry Smith   PetscFunctionBegin;
11319b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
11329b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1133e162b725SBarry Smith   ierr = DMTSSetForcingFunction(dm,func,ctx);CHKERRQ(ierr);
11349b7cd975SBarry Smith   PetscFunctionReturn(0);
11359b7cd975SBarry Smith }
11369b7cd975SBarry Smith 
1137d763cef2SBarry Smith /*@C
1138f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1139b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1140d763cef2SBarry Smith 
11413f9fe445SBarry Smith    Logically Collective on TS
1142d763cef2SBarry Smith 
1143d763cef2SBarry Smith    Input Parameters:
1144d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1145e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1146e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1147d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1148d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
11490298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1150d763cef2SBarry Smith 
1151f7ab8db6SBarry Smith    Calling sequence of f:
1152ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1153d763cef2SBarry Smith 
1154d763cef2SBarry Smith +  t - current timestep
1155d763cef2SBarry Smith .  u - input vector
1156e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1157e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1158d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1159d763cef2SBarry Smith 
11606cd88445SBarry Smith    Notes:
11616cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11626cd88445SBarry Smith 
11636cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1164ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1165d763cef2SBarry Smith 
1166d763cef2SBarry Smith    Level: beginner
1167d763cef2SBarry Smith 
1168d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1169d763cef2SBarry Smith 
1170ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1171d763cef2SBarry Smith 
1172d763cef2SBarry Smith @*/
1173e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1174d763cef2SBarry Smith {
1175277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1176089b2837SJed Brown   SNES           snes;
117724989b8cSPeter Brune   DM             dm;
117824989b8cSPeter Brune   TSIJacobian    ijacobian;
1179277b19d0SLisandro Dalcin 
1180d763cef2SBarry Smith   PetscFunctionBegin;
11810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1182e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1183e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1184e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1185e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1186d763cef2SBarry Smith 
118724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
118824989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1189e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1190e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1191e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1192e1244c69SJed Brown   }
11930298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1194089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11955f659677SPeter Brune   if (!ijacobian) {
1196e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
11970e4ef248SJed Brown   }
1198e5d3d808SBarry Smith   if (Amat) {
1199e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
12000e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1201e5d3d808SBarry Smith     ts->Arhs = Amat;
12020e4ef248SJed Brown   }
1203e5d3d808SBarry Smith   if (Pmat) {
1204e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
12050e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1206e5d3d808SBarry Smith     ts->Brhs = Pmat;
12070e4ef248SJed Brown   }
1208d763cef2SBarry Smith   PetscFunctionReturn(0);
1209d763cef2SBarry Smith }
1210d763cef2SBarry Smith 
1211316643e7SJed Brown /*@C
1212b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1213316643e7SJed Brown 
12143f9fe445SBarry Smith    Logically Collective on TS
1215316643e7SJed Brown 
1216316643e7SJed Brown    Input Parameters:
1217316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
12180298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1219316643e7SJed Brown .  f   - the function evaluation routine
12200298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1221316643e7SJed Brown 
1222316643e7SJed Brown    Calling sequence of f:
1223316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1224316643e7SJed Brown 
1225316643e7SJed Brown +  t   - time at step/stage being solved
1226316643e7SJed Brown .  u   - state vector
1227316643e7SJed Brown .  u_t - time derivative of state vector
1228316643e7SJed Brown .  F   - function vector
1229316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1230316643e7SJed Brown 
1231316643e7SJed Brown    Important:
12322bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1233316643e7SJed Brown 
1234316643e7SJed Brown    Level: beginner
1235316643e7SJed Brown 
1236316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1237316643e7SJed Brown 
1238d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1239316643e7SJed Brown @*/
124051699248SLisandro Dalcin PetscErrorCode  TSSetIFunction(TS ts,Vec r,TSIFunction f,void *ctx)
1241316643e7SJed Brown {
1242089b2837SJed Brown   PetscErrorCode ierr;
1243089b2837SJed Brown   SNES           snes;
124451699248SLisandro Dalcin   Vec            ralloc = NULL;
124524989b8cSPeter Brune   DM             dm;
1246316643e7SJed Brown 
1247316643e7SJed Brown   PetscFunctionBegin;
12480700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
124951699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
125024989b8cSPeter Brune 
125124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
125224989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
125324989b8cSPeter Brune 
1254089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
125551699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
125651699248SLisandro Dalcin     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
125751699248SLisandro Dalcin     r  = ralloc;
1258e856ceecSJed Brown   }
125951699248SLisandro Dalcin   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
126051699248SLisandro Dalcin   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
1261089b2837SJed Brown   PetscFunctionReturn(0);
1262089b2837SJed Brown }
1263089b2837SJed Brown 
1264089b2837SJed Brown /*@C
1265089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1266089b2837SJed Brown 
1267089b2837SJed Brown    Not Collective
1268089b2837SJed Brown 
1269089b2837SJed Brown    Input Parameter:
1270089b2837SJed Brown .  ts - the TS context
1271089b2837SJed Brown 
1272089b2837SJed Brown    Output Parameter:
12730298fd71SBarry Smith +  r - vector to hold residual (or NULL)
12740298fd71SBarry Smith .  func - the function to compute residual (or NULL)
12750298fd71SBarry Smith -  ctx - the function context (or NULL)
1276089b2837SJed Brown 
1277089b2837SJed Brown    Level: advanced
1278089b2837SJed Brown 
1279089b2837SJed Brown .keywords: TS, nonlinear, get, function
1280089b2837SJed Brown 
1281089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1282089b2837SJed Brown @*/
1283089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1284089b2837SJed Brown {
1285089b2837SJed Brown   PetscErrorCode ierr;
1286089b2837SJed Brown   SNES           snes;
128724989b8cSPeter Brune   DM             dm;
1288089b2837SJed Brown 
1289089b2837SJed Brown   PetscFunctionBegin;
1290089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1291089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12920298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
129324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
129424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1295089b2837SJed Brown   PetscFunctionReturn(0);
1296089b2837SJed Brown }
1297089b2837SJed Brown 
1298089b2837SJed Brown /*@C
1299089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1300089b2837SJed Brown 
1301089b2837SJed Brown    Not Collective
1302089b2837SJed Brown 
1303089b2837SJed Brown    Input Parameter:
1304089b2837SJed Brown .  ts - the TS context
1305089b2837SJed Brown 
1306089b2837SJed Brown    Output Parameter:
13070298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
13080298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
13090298fd71SBarry Smith -  ctx - the function context (or NULL)
1310089b2837SJed Brown 
1311089b2837SJed Brown    Level: advanced
1312089b2837SJed Brown 
1313089b2837SJed Brown .keywords: TS, nonlinear, get, function
1314089b2837SJed Brown 
13152bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1316089b2837SJed Brown @*/
1317089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1318089b2837SJed Brown {
1319089b2837SJed Brown   PetscErrorCode ierr;
1320089b2837SJed Brown   SNES           snes;
132124989b8cSPeter Brune   DM             dm;
1322089b2837SJed Brown 
1323089b2837SJed Brown   PetscFunctionBegin;
1324089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1325089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
13260298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
132724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
132824989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1329316643e7SJed Brown   PetscFunctionReturn(0);
1330316643e7SJed Brown }
1331316643e7SJed Brown 
1332316643e7SJed Brown /*@C
1333a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1334ae8867d6SBarry Smith         provided with TSSetIFunction().
1335316643e7SJed Brown 
13363f9fe445SBarry Smith    Logically Collective on TS
1337316643e7SJed Brown 
1338316643e7SJed Brown    Input Parameters:
1339316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1340e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1341e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1342316643e7SJed Brown .  f   - the Jacobian evaluation routine
13430298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1344316643e7SJed Brown 
1345316643e7SJed Brown    Calling sequence of f:
1346ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1347316643e7SJed Brown 
1348316643e7SJed Brown +  t    - time at step/stage being solved
13491b4a444bSJed Brown .  U    - state vector
13501b4a444bSJed Brown .  U_t  - time derivative of state vector
1351316643e7SJed Brown .  a    - shift
1352e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1353e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1354316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1355316643e7SJed Brown 
1356316643e7SJed Brown    Notes:
1357e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1358316643e7SJed Brown 
1359895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1360895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1361895c21f2SBarry Smith 
1362a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1363b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1364a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1365a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1366a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1367a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1368a4f0a591SBarry Smith 
13696cd88445SBarry Smith    You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13706cd88445SBarry Smith 
13716cd88445SBarry Smith    The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1372ca5f011dSBarry Smith    You should not assume the values are the same in the next call to f() as you set them in the previous call.
1373ca5f011dSBarry Smith 
1374316643e7SJed Brown    Level: beginner
1375316643e7SJed Brown 
1376316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1377316643e7SJed Brown 
1378ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1379316643e7SJed Brown 
1380316643e7SJed Brown @*/
1381e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1382316643e7SJed Brown {
1383316643e7SJed Brown   PetscErrorCode ierr;
1384089b2837SJed Brown   SNES           snes;
138524989b8cSPeter Brune   DM             dm;
1386316643e7SJed Brown 
1387316643e7SJed Brown   PetscFunctionBegin;
13880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1389e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1390e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1391e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1392e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
139324989b8cSPeter Brune 
139424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
139524989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
139624989b8cSPeter Brune 
1397089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1398e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1399316643e7SJed Brown   PetscFunctionReturn(0);
1400316643e7SJed Brown }
1401316643e7SJed Brown 
1402e1244c69SJed Brown /*@
1403e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1404e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1405e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1406e1244c69SJed Brown    not been changed by the TS.
1407e1244c69SJed Brown 
1408e1244c69SJed Brown    Logically Collective
1409e1244c69SJed Brown 
1410e1244c69SJed Brown    Input Arguments:
1411e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1412e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1413e1244c69SJed Brown 
1414e1244c69SJed Brown    Level: intermediate
1415e1244c69SJed Brown 
1416e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1417e1244c69SJed Brown @*/
1418e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1419e1244c69SJed Brown {
1420e1244c69SJed Brown   PetscFunctionBegin;
1421e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1422e1244c69SJed Brown   PetscFunctionReturn(0);
1423e1244c69SJed Brown }
1424e1244c69SJed Brown 
1425efe9872eSLisandro Dalcin /*@C
1426efe9872eSLisandro Dalcin    TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1427efe9872eSLisandro Dalcin 
1428efe9872eSLisandro Dalcin    Logically Collective on TS
1429efe9872eSLisandro Dalcin 
1430efe9872eSLisandro Dalcin    Input Parameters:
1431efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1432efe9872eSLisandro Dalcin .  F   - vector to hold the residual (or NULL to have it created internally)
1433efe9872eSLisandro Dalcin .  fun - the function evaluation routine
1434efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1435efe9872eSLisandro Dalcin 
1436efe9872eSLisandro Dalcin    Calling sequence of fun:
1437efe9872eSLisandro Dalcin $  fun(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,Vec F,ctx);
1438efe9872eSLisandro Dalcin 
1439efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1440efe9872eSLisandro Dalcin .  U    - state vector
1441efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1442efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1443efe9872eSLisandro Dalcin .  F    - function vector
1444efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine (may be NULL)
1445efe9872eSLisandro Dalcin 
1446efe9872eSLisandro Dalcin    Level: beginner
1447efe9872eSLisandro Dalcin 
1448efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Function
1449efe9872eSLisandro Dalcin 
1450efe9872eSLisandro Dalcin .seealso: TSSetI2Jacobian()
1451efe9872eSLisandro Dalcin @*/
1452efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Function(TS ts,Vec F,TSI2Function fun,void *ctx)
1453efe9872eSLisandro Dalcin {
1454efe9872eSLisandro Dalcin   DM             dm;
1455efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1456efe9872eSLisandro Dalcin 
1457efe9872eSLisandro Dalcin   PetscFunctionBegin;
1458efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1459efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F,VEC_CLASSID,2);
1460efe9872eSLisandro Dalcin   ierr = TSSetIFunction(ts,F,NULL,NULL);CHKERRQ(ierr);
1461efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1462efe9872eSLisandro Dalcin   ierr = DMTSSetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1463efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1464efe9872eSLisandro Dalcin }
1465efe9872eSLisandro Dalcin 
1466efe9872eSLisandro Dalcin /*@C
1467efe9872eSLisandro Dalcin   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1468efe9872eSLisandro Dalcin 
1469efe9872eSLisandro Dalcin   Not Collective
1470efe9872eSLisandro Dalcin 
1471efe9872eSLisandro Dalcin   Input Parameter:
1472efe9872eSLisandro Dalcin . ts - the TS context
1473efe9872eSLisandro Dalcin 
1474efe9872eSLisandro Dalcin   Output Parameter:
1475efe9872eSLisandro Dalcin + r - vector to hold residual (or NULL)
1476efe9872eSLisandro Dalcin . fun - the function to compute residual (or NULL)
1477efe9872eSLisandro Dalcin - ctx - the function context (or NULL)
1478efe9872eSLisandro Dalcin 
1479efe9872eSLisandro Dalcin   Level: advanced
1480efe9872eSLisandro Dalcin 
1481efe9872eSLisandro Dalcin .keywords: TS, nonlinear, get, function
1482efe9872eSLisandro Dalcin 
1483efe9872eSLisandro Dalcin .seealso: TSSetI2Function(), SNESGetFunction()
1484efe9872eSLisandro Dalcin @*/
1485efe9872eSLisandro Dalcin PetscErrorCode TSGetI2Function(TS ts,Vec *r,TSI2Function *fun,void **ctx)
1486efe9872eSLisandro Dalcin {
1487efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1488efe9872eSLisandro Dalcin   SNES           snes;
1489efe9872eSLisandro Dalcin   DM             dm;
1490efe9872eSLisandro Dalcin 
1491efe9872eSLisandro Dalcin   PetscFunctionBegin;
1492efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1493efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1494efe9872eSLisandro Dalcin   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
1495efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1496efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,fun,ctx);CHKERRQ(ierr);
1497efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1498efe9872eSLisandro Dalcin }
1499efe9872eSLisandro Dalcin 
1500efe9872eSLisandro Dalcin /*@C
1501bc77d74cSLisandro Dalcin    TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1502efe9872eSLisandro Dalcin         where F(t,U,U_t,U_tt) is the function you provided with TSSetI2Function().
1503efe9872eSLisandro Dalcin 
1504efe9872eSLisandro Dalcin    Logically Collective on TS
1505efe9872eSLisandro Dalcin 
1506efe9872eSLisandro Dalcin    Input Parameters:
1507efe9872eSLisandro Dalcin +  ts  - the TS context obtained from TSCreate()
1508efe9872eSLisandro Dalcin .  J   - Jacobian matrix
1509efe9872eSLisandro Dalcin .  P   - preconditioning matrix for J (may be same as J)
1510efe9872eSLisandro Dalcin .  jac - the Jacobian evaluation routine
1511efe9872eSLisandro Dalcin -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1512efe9872eSLisandro Dalcin 
1513efe9872eSLisandro Dalcin    Calling sequence of jac:
1514bc77d74cSLisandro Dalcin $  jac(TS ts,PetscReal t,Vec U,Vec U_t,Vec U_tt,PetscReal v,PetscReal a,Mat J,Mat P,void *ctx);
1515efe9872eSLisandro Dalcin 
1516efe9872eSLisandro Dalcin +  t    - time at step/stage being solved
1517efe9872eSLisandro Dalcin .  U    - state vector
1518efe9872eSLisandro Dalcin .  U_t  - time derivative of state vector
1519efe9872eSLisandro Dalcin .  U_tt - second time derivative of state vector
1520efe9872eSLisandro Dalcin .  v    - shift for U_t
1521efe9872eSLisandro Dalcin .  a    - shift for U_tt
1522efe9872eSLisandro 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
1523efe9872eSLisandro Dalcin .  P    - preconditioning matrix for J, may be same as J
1524efe9872eSLisandro Dalcin -  ctx  - [optional] user-defined context for matrix evaluation routine
1525efe9872eSLisandro Dalcin 
1526efe9872eSLisandro Dalcin    Notes:
1527efe9872eSLisandro Dalcin    The matrices J and P are exactly the matrices that are used by SNES for the nonlinear solve.
1528efe9872eSLisandro Dalcin 
1529efe9872eSLisandro Dalcin    The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1530efe9872eSLisandro 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.
1531efe9872eSLisandro Dalcin    The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1532bc77d74cSLisandro Dalcin    parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1533efe9872eSLisandro Dalcin 
1534efe9872eSLisandro Dalcin    Level: beginner
1535efe9872eSLisandro Dalcin 
1536efe9872eSLisandro Dalcin .keywords: TS, timestep, set, ODE, DAE, Jacobian
1537efe9872eSLisandro Dalcin 
1538efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1539efe9872eSLisandro Dalcin @*/
1540efe9872eSLisandro Dalcin PetscErrorCode TSSetI2Jacobian(TS ts,Mat J,Mat P,TSI2Jacobian jac,void *ctx)
1541efe9872eSLisandro Dalcin {
1542efe9872eSLisandro Dalcin   DM             dm;
1543efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1544efe9872eSLisandro Dalcin 
1545efe9872eSLisandro Dalcin   PetscFunctionBegin;
1546efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1547efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J,MAT_CLASSID,2);
1548efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P,MAT_CLASSID,3);
1549efe9872eSLisandro Dalcin   ierr = TSSetIJacobian(ts,J,P,NULL,NULL);CHKERRQ(ierr);
1550efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1551efe9872eSLisandro Dalcin   ierr = DMTSSetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1552efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1553efe9872eSLisandro Dalcin }
1554efe9872eSLisandro Dalcin 
1555efe9872eSLisandro Dalcin /*@C
1556efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1557efe9872eSLisandro Dalcin 
1558efe9872eSLisandro Dalcin   Not Collective, but parallel objects are returned if TS is parallel
1559efe9872eSLisandro Dalcin 
1560efe9872eSLisandro Dalcin   Input Parameter:
1561efe9872eSLisandro Dalcin . ts  - The TS context obtained from TSCreate()
1562efe9872eSLisandro Dalcin 
1563efe9872eSLisandro Dalcin   Output Parameters:
1564efe9872eSLisandro Dalcin + J  - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1565efe9872eSLisandro Dalcin . P - The matrix from which the preconditioner is constructed, often the same as J
1566efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1567efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1568efe9872eSLisandro Dalcin 
156995452b02SPatrick Sanan   Notes:
157095452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
1571efe9872eSLisandro Dalcin 
1572efe9872eSLisandro Dalcin   Level: advanced
1573efe9872eSLisandro Dalcin 
157480275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
1575efe9872eSLisandro Dalcin 
1576efe9872eSLisandro Dalcin .keywords: TS, timestep, get, matrix, Jacobian
1577efe9872eSLisandro Dalcin @*/
1578efe9872eSLisandro Dalcin PetscErrorCode  TSGetI2Jacobian(TS ts,Mat *J,Mat *P,TSI2Jacobian *jac,void **ctx)
1579efe9872eSLisandro Dalcin {
1580efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1581efe9872eSLisandro Dalcin   SNES           snes;
1582efe9872eSLisandro Dalcin   DM             dm;
1583efe9872eSLisandro Dalcin 
1584efe9872eSLisandro Dalcin   PetscFunctionBegin;
1585efe9872eSLisandro Dalcin   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1586efe9872eSLisandro Dalcin   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
1587efe9872eSLisandro Dalcin   ierr = SNESGetJacobian(snes,J,P,NULL,NULL);CHKERRQ(ierr);
1588efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1589efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,jac,ctx);CHKERRQ(ierr);
1590efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1591efe9872eSLisandro Dalcin }
1592efe9872eSLisandro Dalcin 
1593efe9872eSLisandro Dalcin /*@
1594efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1595efe9872eSLisandro Dalcin 
1596efe9872eSLisandro Dalcin   Collective on TS and Vec
1597efe9872eSLisandro Dalcin 
1598efe9872eSLisandro Dalcin   Input Parameters:
1599efe9872eSLisandro Dalcin + ts - the TS context
1600efe9872eSLisandro Dalcin . t - current time
1601efe9872eSLisandro Dalcin . U - state vector
1602efe9872eSLisandro Dalcin . V - time derivative of state vector (U_t)
1603efe9872eSLisandro Dalcin - A - second time derivative of state vector (U_tt)
1604efe9872eSLisandro Dalcin 
1605efe9872eSLisandro Dalcin   Output Parameter:
1606efe9872eSLisandro Dalcin . F - the residual vector
1607efe9872eSLisandro Dalcin 
1608efe9872eSLisandro Dalcin   Note:
1609efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1610efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1611efe9872eSLisandro Dalcin 
1612efe9872eSLisandro Dalcin   Level: developer
1613efe9872eSLisandro Dalcin 
1614efe9872eSLisandro Dalcin .keywords: TS, compute, function, vector
1615efe9872eSLisandro Dalcin 
1616efe9872eSLisandro Dalcin .seealso: TSSetI2Function()
1617efe9872eSLisandro Dalcin @*/
1618efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Function(TS ts,PetscReal t,Vec U,Vec V,Vec A,Vec F)
1619efe9872eSLisandro Dalcin {
1620efe9872eSLisandro Dalcin   DM             dm;
1621efe9872eSLisandro Dalcin   TSI2Function   I2Function;
1622efe9872eSLisandro Dalcin   void           *ctx;
1623efe9872eSLisandro Dalcin   TSRHSFunction  rhsfunction;
1624efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1625efe9872eSLisandro Dalcin 
1626efe9872eSLisandro Dalcin   PetscFunctionBegin;
1627efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1628efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1629efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1630efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1631efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F,VEC_CLASSID,6);
1632efe9872eSLisandro Dalcin 
1633efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1634efe9872eSLisandro Dalcin   ierr = DMTSGetI2Function(dm,&I2Function,&ctx);CHKERRQ(ierr);
1635efe9872eSLisandro Dalcin   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
1636efe9872eSLisandro Dalcin 
1637efe9872eSLisandro Dalcin   if (!I2Function) {
1638efe9872eSLisandro Dalcin     ierr = TSComputeIFunction(ts,t,U,A,F,PETSC_FALSE);CHKERRQ(ierr);
1639efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1640efe9872eSLisandro Dalcin   }
1641efe9872eSLisandro Dalcin 
1642efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1643efe9872eSLisandro Dalcin 
1644efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit function");
1645efe9872eSLisandro Dalcin   ierr = I2Function(ts,t,U,V,A,F,ctx);CHKERRQ(ierr);
1646efe9872eSLisandro Dalcin   PetscStackPop;
1647efe9872eSLisandro Dalcin 
1648efe9872eSLisandro Dalcin   if (rhsfunction) {
1649efe9872eSLisandro Dalcin     Vec Frhs;
1650efe9872eSLisandro Dalcin     ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
1651efe9872eSLisandro Dalcin     ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
1652efe9872eSLisandro Dalcin     ierr = VecAXPY(F,-1,Frhs);CHKERRQ(ierr);
1653efe9872eSLisandro Dalcin   }
1654efe9872eSLisandro Dalcin 
1655efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,V,F);CHKERRQ(ierr);
1656efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1657efe9872eSLisandro Dalcin }
1658efe9872eSLisandro Dalcin 
1659efe9872eSLisandro Dalcin /*@
1660efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1661efe9872eSLisandro Dalcin 
1662efe9872eSLisandro Dalcin   Collective on TS and Vec
1663efe9872eSLisandro Dalcin 
1664efe9872eSLisandro Dalcin   Input Parameters:
1665efe9872eSLisandro Dalcin + ts - the TS context
1666efe9872eSLisandro Dalcin . t - current timestep
1667efe9872eSLisandro Dalcin . U - state vector
1668efe9872eSLisandro Dalcin . V - time derivative of state vector
1669efe9872eSLisandro Dalcin . A - second time derivative of state vector
1670efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1671efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1672efe9872eSLisandro Dalcin 
1673efe9872eSLisandro Dalcin   Output Parameters:
1674efe9872eSLisandro Dalcin + J - Jacobian matrix
1675efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1676efe9872eSLisandro Dalcin 
1677efe9872eSLisandro Dalcin   Notes:
1678efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1679efe9872eSLisandro Dalcin 
1680efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1681efe9872eSLisandro Dalcin 
1682efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1683efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1684efe9872eSLisandro Dalcin 
1685efe9872eSLisandro Dalcin   Level: developer
1686efe9872eSLisandro Dalcin 
1687efe9872eSLisandro Dalcin .keywords: TS, compute, Jacobian, matrix
1688efe9872eSLisandro Dalcin 
1689efe9872eSLisandro Dalcin .seealso:  TSSetI2Jacobian()
1690efe9872eSLisandro Dalcin @*/
1691efe9872eSLisandro Dalcin PetscErrorCode TSComputeI2Jacobian(TS ts,PetscReal t,Vec U,Vec V,Vec A,PetscReal shiftV,PetscReal shiftA,Mat J,Mat P)
1692efe9872eSLisandro Dalcin {
1693efe9872eSLisandro Dalcin   DM             dm;
1694efe9872eSLisandro Dalcin   TSI2Jacobian   I2Jacobian;
1695efe9872eSLisandro Dalcin   void           *ctx;
1696efe9872eSLisandro Dalcin   TSRHSJacobian  rhsjacobian;
1697efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1698efe9872eSLisandro Dalcin 
1699efe9872eSLisandro Dalcin   PetscFunctionBegin;
1700efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1701efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
1702efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V,VEC_CLASSID,4);
1703efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A,VEC_CLASSID,5);
1704efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J,MAT_CLASSID,8);
1705efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P,MAT_CLASSID,9);
1706efe9872eSLisandro Dalcin 
1707efe9872eSLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
1708efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&I2Jacobian,&ctx);CHKERRQ(ierr);
1709efe9872eSLisandro Dalcin   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
1710efe9872eSLisandro Dalcin 
1711efe9872eSLisandro Dalcin   if (!I2Jacobian) {
1712efe9872eSLisandro Dalcin     ierr = TSComputeIJacobian(ts,t,U,A,shiftA,J,P,PETSC_FALSE);CHKERRQ(ierr);
1713efe9872eSLisandro Dalcin     PetscFunctionReturn(0);
1714efe9872eSLisandro Dalcin   }
1715efe9872eSLisandro Dalcin 
1716efe9872eSLisandro Dalcin   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1717efe9872eSLisandro Dalcin 
1718efe9872eSLisandro Dalcin   PetscStackPush("TS user implicit Jacobian");
1719efe9872eSLisandro Dalcin   ierr = I2Jacobian(ts,t,U,V,A,shiftV,shiftA,J,P,ctx);CHKERRQ(ierr);
1720efe9872eSLisandro Dalcin   PetscStackPop;
1721efe9872eSLisandro Dalcin 
1722efe9872eSLisandro Dalcin   if (rhsjacobian) {
1723efe9872eSLisandro Dalcin     Mat Jrhs,Prhs; MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
1724efe9872eSLisandro Dalcin     ierr = TSGetRHSMats_Private(ts,&Jrhs,&Prhs);CHKERRQ(ierr);
1725efe9872eSLisandro Dalcin     ierr = TSComputeRHSJacobian(ts,t,U,Jrhs,Prhs);CHKERRQ(ierr);
1726efe9872eSLisandro Dalcin     ierr = MatAXPY(J,-1,Jrhs,axpy);CHKERRQ(ierr);
1727efe9872eSLisandro Dalcin     if (P != J) {ierr = MatAXPY(P,-1,Prhs,axpy);CHKERRQ(ierr);}
1728efe9872eSLisandro Dalcin   }
1729efe9872eSLisandro Dalcin 
1730efe9872eSLisandro Dalcin   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,J,P);CHKERRQ(ierr);
1731efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1732efe9872eSLisandro Dalcin }
1733efe9872eSLisandro Dalcin 
1734efe9872eSLisandro Dalcin /*@
1735efe9872eSLisandro Dalcin    TS2SetSolution - Sets the initial solution and time derivative vectors
1736efe9872eSLisandro Dalcin    for use by the TS routines handling second order equations.
1737efe9872eSLisandro Dalcin 
1738efe9872eSLisandro Dalcin    Logically Collective on TS and Vec
1739efe9872eSLisandro Dalcin 
1740efe9872eSLisandro Dalcin    Input Parameters:
1741efe9872eSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
1742efe9872eSLisandro Dalcin .  u - the solution vector
1743efe9872eSLisandro Dalcin -  v - the time derivative vector
1744efe9872eSLisandro Dalcin 
1745efe9872eSLisandro Dalcin    Level: beginner
1746efe9872eSLisandro Dalcin 
1747efe9872eSLisandro Dalcin .keywords: TS, timestep, set, solution, initial conditions
1748efe9872eSLisandro Dalcin @*/
1749efe9872eSLisandro Dalcin PetscErrorCode  TS2SetSolution(TS ts,Vec u,Vec v)
1750efe9872eSLisandro Dalcin {
1751efe9872eSLisandro Dalcin   PetscErrorCode ierr;
1752efe9872eSLisandro Dalcin 
1753efe9872eSLisandro Dalcin   PetscFunctionBegin;
1754efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1755efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
1756efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v,VEC_CLASSID,3);
1757efe9872eSLisandro Dalcin   ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
1758efe9872eSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)v);CHKERRQ(ierr);
1759efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
1760efe9872eSLisandro Dalcin   ts->vec_dot = v;
1761efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1762efe9872eSLisandro Dalcin }
1763efe9872eSLisandro Dalcin 
1764efe9872eSLisandro Dalcin /*@
1765efe9872eSLisandro Dalcin    TS2GetSolution - Returns the solution and time derivative at the present timestep
1766efe9872eSLisandro Dalcin    for second order equations. It is valid to call this routine inside the function
1767efe9872eSLisandro Dalcin    that you are evaluating in order to move to the new timestep. This vector not
1768efe9872eSLisandro Dalcin    changed until the solution at the next timestep has been calculated.
1769efe9872eSLisandro Dalcin 
1770efe9872eSLisandro Dalcin    Not Collective, but Vec returned is parallel if TS is parallel
1771efe9872eSLisandro Dalcin 
1772efe9872eSLisandro Dalcin    Input Parameter:
1773efe9872eSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1774efe9872eSLisandro Dalcin 
1775efe9872eSLisandro Dalcin    Output Parameter:
1776efe9872eSLisandro Dalcin +  u - the vector containing the solution
1777efe9872eSLisandro Dalcin -  v - the vector containing the time derivative
1778efe9872eSLisandro Dalcin 
1779efe9872eSLisandro Dalcin    Level: intermediate
1780efe9872eSLisandro Dalcin 
1781efe9872eSLisandro Dalcin .seealso: TS2SetSolution(), TSGetTimeStep(), TSGetTime()
1782efe9872eSLisandro Dalcin 
1783efe9872eSLisandro Dalcin .keywords: TS, timestep, get, solution
1784efe9872eSLisandro Dalcin @*/
1785efe9872eSLisandro Dalcin PetscErrorCode  TS2GetSolution(TS ts,Vec *u,Vec *v)
1786efe9872eSLisandro Dalcin {
1787efe9872eSLisandro Dalcin   PetscFunctionBegin;
1788efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1789efe9872eSLisandro Dalcin   if (u) PetscValidPointer(u,2);
1790efe9872eSLisandro Dalcin   if (v) PetscValidPointer(v,3);
1791efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1792efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
1793efe9872eSLisandro Dalcin   PetscFunctionReturn(0);
1794efe9872eSLisandro Dalcin }
1795efe9872eSLisandro Dalcin 
179655849f57SBarry Smith /*@C
179755849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
179855849f57SBarry Smith 
179955849f57SBarry Smith   Collective on PetscViewer
180055849f57SBarry Smith 
180155849f57SBarry Smith   Input Parameters:
180255849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
180355849f57SBarry Smith            some related function before a call to TSLoad().
180455849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
180555849f57SBarry Smith 
180655849f57SBarry Smith    Level: intermediate
180755849f57SBarry Smith 
180855849f57SBarry Smith   Notes:
180955849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
181055849f57SBarry Smith 
181155849f57SBarry Smith   Notes for advanced users:
181255849f57SBarry Smith   Most users should not need to know the details of the binary storage
181355849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
181455849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
181555849f57SBarry Smith   format is
181655849f57SBarry Smith .vb
181755849f57SBarry Smith      has not yet been determined
181855849f57SBarry Smith .ve
181955849f57SBarry Smith 
182055849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
182155849f57SBarry Smith @*/
1822f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
182355849f57SBarry Smith {
182455849f57SBarry Smith   PetscErrorCode ierr;
182555849f57SBarry Smith   PetscBool      isbinary;
182655849f57SBarry Smith   PetscInt       classid;
182755849f57SBarry Smith   char           type[256];
18282d53ad75SBarry Smith   DMTS           sdm;
1829ad6bc421SBarry Smith   DM             dm;
183055849f57SBarry Smith 
183155849f57SBarry Smith   PetscFunctionBegin;
1832f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
183355849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
183455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
183555849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
183655849f57SBarry Smith 
1837060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1838ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1839060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1840f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1841f2c2a1b9SBarry Smith   if (ts->ops->load) {
1842f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1843f2c2a1b9SBarry Smith   }
1844ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1845ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1846ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1847f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1848f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
18492d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
18502d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
185155849f57SBarry Smith   PetscFunctionReturn(0);
185255849f57SBarry Smith }
185355849f57SBarry Smith 
18549804daf3SBarry Smith #include <petscdraw.h>
1855e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1856e04113cfSBarry Smith #include <petscviewersaws.h>
1857f05ece33SBarry Smith #endif
18587e2c5f70SBarry Smith /*@C
1859d763cef2SBarry Smith     TSView - Prints the TS data structure.
1860d763cef2SBarry Smith 
18614c49b128SBarry Smith     Collective on TS
1862d763cef2SBarry Smith 
1863d763cef2SBarry Smith     Input Parameters:
1864d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1865d763cef2SBarry Smith -   viewer - visualization context
1866d763cef2SBarry Smith 
1867d763cef2SBarry Smith     Options Database Key:
1868d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1869d763cef2SBarry Smith 
1870d763cef2SBarry Smith     Notes:
1871d763cef2SBarry Smith     The available visualization contexts include
1872b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1873b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1874d763cef2SBarry Smith          output where only the first processor opens
1875d763cef2SBarry Smith          the file.  All other processors send their
1876d763cef2SBarry Smith          data to the first processor to print.
1877d763cef2SBarry Smith 
1878d763cef2SBarry Smith     The user can open an alternative visualization context with
1879b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1880d763cef2SBarry Smith 
1881d763cef2SBarry Smith     Level: beginner
1882d763cef2SBarry Smith 
1883d763cef2SBarry Smith .keywords: TS, timestep, view
1884d763cef2SBarry Smith 
1885b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1886d763cef2SBarry Smith @*/
18877087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1888d763cef2SBarry Smith {
1889dfbe8321SBarry Smith   PetscErrorCode ierr;
189019fd82e9SBarry Smith   TSType         type;
18912b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
18922d53ad75SBarry Smith   DMTS           sdm;
1893e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1894536b137fSBarry Smith   PetscBool      issaws;
1895f05ece33SBarry Smith #endif
1896d763cef2SBarry Smith 
1897d763cef2SBarry Smith   PetscFunctionBegin;
18980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
18993050cee2SBarry Smith   if (!viewer) {
1900ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
19013050cee2SBarry Smith   }
19020700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1903c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1904fd16b177SBarry Smith 
1905251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1906251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
190755849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
19082b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1909e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1910536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1911f05ece33SBarry Smith #endif
191232077d6dSBarry Smith   if (iascii) {
1913dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
1914efd4aadfSBarry Smith     if (ts->ops->view) {
1915efd4aadfSBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1916efd4aadfSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1917efd4aadfSBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1918efd4aadfSBarry Smith     }
1919ef85077eSLisandro Dalcin     if (ts->max_steps < PETSC_MAX_INT) {
192077431f27SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
1921ef85077eSLisandro Dalcin     }
1922ef85077eSLisandro Dalcin     if (ts->max_time < PETSC_MAX_REAL) {
19237c8652ddSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1924ef85077eSLisandro Dalcin     }
1925efd4aadfSBarry Smith     if (ts->usessnes) {
1926efd4aadfSBarry Smith       PetscBool lin;
1927d763cef2SBarry Smith       if (ts->problem_type == TS_NONLINEAR) {
19285ef26d82SJed Brown         ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1929d763cef2SBarry Smith       }
19305ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1931efd4aadfSBarry Smith       ierr = PetscObjectTypeCompare((PetscObject)ts->snes,SNESKSPONLY,&lin);CHKERRQ(ierr);
1932efd4aadfSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  total number of %slinear solve failures=%D\n",lin ? "" : "non",ts->num_snes_failures);CHKERRQ(ierr);
1933efd4aadfSBarry Smith     }
1934193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
1935a0af407cSBarry Smith     if (ts->vrtol) {
1936a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of relative error tolerances, ");CHKERRQ(ierr);
1937a0af407cSBarry Smith     } else {
1938a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using relative error tolerance of %g, ",(double)ts->rtol);CHKERRQ(ierr);
1939a0af407cSBarry Smith     }
1940a0af407cSBarry Smith     if (ts->vatol) {
1941a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using vector of absolute error tolerances\n");CHKERRQ(ierr);
1942a0af407cSBarry Smith     } else {
1943a0af407cSBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"  using absolute error tolerance of %g\n",(double)ts->atol);CHKERRQ(ierr);
1944a0af407cSBarry Smith     }
1945825ab935SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1946efd4aadfSBarry Smith     ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);
1947825ab935SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1948825ab935SBarry Smith     if (ts->snes && ts->usessnes)  {
1949825ab935SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1950825ab935SBarry Smith       ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);
1951825ab935SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1952825ab935SBarry Smith     }
19532d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19542d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
19550f5bd95cSBarry Smith   } else if (isstring) {
1956a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1957b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
195855849f57SBarry Smith   } else if (isbinary) {
195955849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
196055849f57SBarry Smith     MPI_Comm    comm;
196155849f57SBarry Smith     PetscMPIInt rank;
196255849f57SBarry Smith     char        type[256];
196355849f57SBarry Smith 
196455849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
196555849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
196655849f57SBarry Smith     if (!rank) {
196755849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
196855849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
196955849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
197055849f57SBarry Smith     }
197155849f57SBarry Smith     if (ts->ops->view) {
197255849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
197355849f57SBarry Smith     }
1974efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
1975f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1976f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
19772d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
19782d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
19792b0a91c0SBarry Smith   } else if (isdraw) {
19802b0a91c0SBarry Smith     PetscDraw draw;
19812b0a91c0SBarry Smith     char      str[36];
198289fd9fafSBarry Smith     PetscReal x,y,bottom,h;
19832b0a91c0SBarry Smith 
19842b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
19852b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
19862b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
19872b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
198851fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
198989fd9fafSBarry Smith     bottom = y - h;
19902b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
19912b0a91c0SBarry Smith     if (ts->ops->view) {
19922b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
19932b0a91c0SBarry Smith     }
1994efd4aadfSBarry Smith     if (ts->adapt) {ierr = TSAdaptView(ts->adapt,viewer);CHKERRQ(ierr);}
1995efd4aadfSBarry Smith     if (ts->snes)  {ierr = SNESView(ts->snes,viewer);CHKERRQ(ierr);}
19962b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1997e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1998536b137fSBarry Smith   } else if (issaws) {
1999d45a07a7SBarry Smith     PetscMPIInt rank;
20002657e9d9SBarry Smith     const char  *name;
20012657e9d9SBarry Smith 
20022657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
2003d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
2004d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
2005d45a07a7SBarry Smith       char       dir[1024];
2006d45a07a7SBarry Smith 
2007e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
2008a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
20092657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
20102657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
20112657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
2012d763cef2SBarry Smith     }
20130acecf5bSBarry Smith     if (ts->ops->view) {
20140acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
20150acecf5bSBarry Smith     }
2016f05ece33SBarry Smith #endif
2017f05ece33SBarry Smith   }
2018f05ece33SBarry Smith 
2019b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
2020251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
2021b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
2022d763cef2SBarry Smith   PetscFunctionReturn(0);
2023d763cef2SBarry Smith }
2024d763cef2SBarry Smith 
2025b07ff414SBarry Smith /*@
2026d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
2027d763cef2SBarry Smith    the timesteppers.
2028d763cef2SBarry Smith 
20293f9fe445SBarry Smith    Logically Collective on TS
2030d763cef2SBarry Smith 
2031d763cef2SBarry Smith    Input Parameters:
2032d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2033d763cef2SBarry Smith -  usrP - optional user context
2034d763cef2SBarry Smith 
203595452b02SPatrick Sanan    Fortran Notes:
203695452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2037daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2038daf670e6SBarry Smith 
2039d763cef2SBarry Smith    Level: intermediate
2040d763cef2SBarry Smith 
2041d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
2042d763cef2SBarry Smith 
2043d763cef2SBarry Smith .seealso: TSGetApplicationContext()
2044d763cef2SBarry Smith @*/
20457087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
2046d763cef2SBarry Smith {
2047d763cef2SBarry Smith   PetscFunctionBegin;
20480700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2049d763cef2SBarry Smith   ts->user = usrP;
2050d763cef2SBarry Smith   PetscFunctionReturn(0);
2051d763cef2SBarry Smith }
2052d763cef2SBarry Smith 
2053b07ff414SBarry Smith /*@
2054d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
2055d763cef2SBarry Smith     timestepper.
2056d763cef2SBarry Smith 
2057d763cef2SBarry Smith     Not Collective
2058d763cef2SBarry Smith 
2059d763cef2SBarry Smith     Input Parameter:
2060d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
2061d763cef2SBarry Smith 
2062d763cef2SBarry Smith     Output Parameter:
2063d763cef2SBarry Smith .   usrP - user context
2064d763cef2SBarry Smith 
206595452b02SPatrick Sanan    Fortran Notes:
206695452b02SPatrick Sanan     To use this from Fortran you must write a Fortran interface definition for this
2067daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
2068daf670e6SBarry Smith 
2069d763cef2SBarry Smith     Level: intermediate
2070d763cef2SBarry Smith 
2071d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
2072d763cef2SBarry Smith 
2073d763cef2SBarry Smith .seealso: TSSetApplicationContext()
2074d763cef2SBarry Smith @*/
2075e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
2076d763cef2SBarry Smith {
2077d763cef2SBarry Smith   PetscFunctionBegin;
20780700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2079e71120c6SJed Brown   *(void**)usrP = ts->user;
2080d763cef2SBarry Smith   PetscFunctionReturn(0);
2081d763cef2SBarry Smith }
2082d763cef2SBarry Smith 
2083d763cef2SBarry Smith /*@
208480275a0aSLisandro Dalcin    TSGetStepNumber - Gets the number of steps completed.
2085d763cef2SBarry Smith 
2086d763cef2SBarry Smith    Not Collective
2087d763cef2SBarry Smith 
2088d763cef2SBarry Smith    Input Parameter:
2089d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2090d763cef2SBarry Smith 
2091d763cef2SBarry Smith    Output Parameter:
209280275a0aSLisandro Dalcin .  steps - number of steps completed so far
2093d763cef2SBarry Smith 
2094d763cef2SBarry Smith    Level: intermediate
2095d763cef2SBarry Smith 
2096d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
20979be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
2098d763cef2SBarry Smith @*/
209980275a0aSLisandro Dalcin PetscErrorCode TSGetStepNumber(TS ts,PetscInt *steps)
2100d763cef2SBarry Smith {
2101d763cef2SBarry Smith   PetscFunctionBegin;
21020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
210380275a0aSLisandro Dalcin   PetscValidIntPointer(steps,2);
210480275a0aSLisandro Dalcin   *steps = ts->steps;
210580275a0aSLisandro Dalcin   PetscFunctionReturn(0);
210680275a0aSLisandro Dalcin }
210780275a0aSLisandro Dalcin 
210880275a0aSLisandro Dalcin /*@
210980275a0aSLisandro Dalcin    TSSetStepNumber - Sets the number of steps completed.
211080275a0aSLisandro Dalcin 
211180275a0aSLisandro Dalcin    Logically Collective on TS
211280275a0aSLisandro Dalcin 
211380275a0aSLisandro Dalcin    Input Parameters:
211480275a0aSLisandro Dalcin +  ts - the TS context
211580275a0aSLisandro Dalcin -  steps - number of steps completed so far
211680275a0aSLisandro Dalcin 
211780275a0aSLisandro Dalcin    Notes:
211880275a0aSLisandro Dalcin    For most uses of the TS solvers the user need not explicitly call
211980275a0aSLisandro Dalcin    TSSetStepNumber(), as the step counter is appropriately updated in
212080275a0aSLisandro Dalcin    TSSolve()/TSStep()/TSRollBack(). Power users may call this routine to
212180275a0aSLisandro Dalcin    reinitialize timestepping by setting the step counter to zero (and time
212280275a0aSLisandro Dalcin    to the initial time) to solve a similar problem with different initial
212380275a0aSLisandro Dalcin    conditions or parameters. Other possible use case is to continue
212480275a0aSLisandro Dalcin    timestepping from a previously interrupted run in such a way that TS
212580275a0aSLisandro Dalcin    monitors will be called with a initial nonzero step counter.
212680275a0aSLisandro Dalcin 
212780275a0aSLisandro Dalcin    Level: advanced
212880275a0aSLisandro Dalcin 
212980275a0aSLisandro Dalcin .keywords: TS, timestep, set, iteration, number
213080275a0aSLisandro Dalcin .seealso: TSGetStepNumber(), TSSetTime(), TSSetTimeStep(), TSSetSolution()
213180275a0aSLisandro Dalcin @*/
213280275a0aSLisandro Dalcin PetscErrorCode TSSetStepNumber(TS ts,PetscInt steps)
213380275a0aSLisandro Dalcin {
213480275a0aSLisandro Dalcin   PetscFunctionBegin;
213580275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
213680275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,steps,2);
213780275a0aSLisandro Dalcin   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Step number must be non-negative");
213880275a0aSLisandro Dalcin   ts->steps = steps;
2139d763cef2SBarry Smith   PetscFunctionReturn(0);
2140d763cef2SBarry Smith }
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith /*@
2143d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
2144d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
2145d763cef2SBarry Smith 
21463f9fe445SBarry Smith    Logically Collective on TS
2147d763cef2SBarry Smith 
2148d763cef2SBarry Smith    Input Parameters:
2149d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2150d763cef2SBarry Smith -  time_step - the size of the timestep
2151d763cef2SBarry Smith 
2152d763cef2SBarry Smith    Level: intermediate
2153d763cef2SBarry Smith 
2154aaa6c58dSLisandro Dalcin .seealso: TSGetTimeStep(), TSSetTime()
2155d763cef2SBarry Smith 
2156d763cef2SBarry Smith .keywords: TS, set, timestep
2157d763cef2SBarry Smith @*/
21587087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
2159d763cef2SBarry Smith {
2160d763cef2SBarry Smith   PetscFunctionBegin;
21610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2162c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
2163d763cef2SBarry Smith   ts->time_step = time_step;
2164d763cef2SBarry Smith   PetscFunctionReturn(0);
2165d763cef2SBarry Smith }
2166d763cef2SBarry Smith 
2167a43b19c4SJed Brown /*@
216849354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
216949354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
217049354f04SShri Abhyankar      or just return at the final time TS computed.
2171a43b19c4SJed Brown 
2172a43b19c4SJed Brown   Logically Collective on TS
2173a43b19c4SJed Brown 
2174a43b19c4SJed Brown    Input Parameter:
2175a43b19c4SJed Brown +   ts - the time-step context
217649354f04SShri Abhyankar -   eftopt - exact final time option
2177a43b19c4SJed Brown 
2178feed9e9dSBarry Smith $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2179feed9e9dSBarry Smith $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2180feed9e9dSBarry Smith $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2181feed9e9dSBarry Smith 
2182feed9e9dSBarry Smith    Options Database:
2183feed9e9dSBarry Smith .   -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2184feed9e9dSBarry Smith 
2185ee346746SBarry Smith    Warning: If you use the option TS_EXACTFINALTIME_STEPOVER the solution may be at a very different time
2186ee346746SBarry Smith     then the final time you selected.
2187ee346746SBarry Smith 
2188a43b19c4SJed Brown    Level: beginner
2189a43b19c4SJed Brown 
2190f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSGetExactFinalTime()
2191a43b19c4SJed Brown @*/
219249354f04SShri Abhyankar PetscErrorCode TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
2193a43b19c4SJed Brown {
2194a43b19c4SJed Brown   PetscFunctionBegin;
2195a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
219649354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
219749354f04SShri Abhyankar   ts->exact_final_time = eftopt;
2198a43b19c4SJed Brown   PetscFunctionReturn(0);
2199a43b19c4SJed Brown }
2200a43b19c4SJed Brown 
2201d763cef2SBarry Smith /*@
2202f6953c82SLisandro Dalcin    TSGetExactFinalTime - Gets the exact final time option.
2203f6953c82SLisandro Dalcin 
2204f6953c82SLisandro Dalcin    Not Collective
2205f6953c82SLisandro Dalcin 
2206f6953c82SLisandro Dalcin    Input Parameter:
2207f6953c82SLisandro Dalcin .  ts - the TS context
2208f6953c82SLisandro Dalcin 
2209f6953c82SLisandro Dalcin    Output Parameter:
2210f6953c82SLisandro Dalcin .  eftopt - exact final time option
2211f6953c82SLisandro Dalcin 
2212f6953c82SLisandro Dalcin    Level: beginner
2213f6953c82SLisandro Dalcin 
2214f6953c82SLisandro Dalcin .seealso: TSExactFinalTimeOption, TSSetExactFinalTime()
2215f6953c82SLisandro Dalcin @*/
2216f6953c82SLisandro Dalcin PetscErrorCode TSGetExactFinalTime(TS ts,TSExactFinalTimeOption *eftopt)
2217f6953c82SLisandro Dalcin {
2218f6953c82SLisandro Dalcin   PetscFunctionBegin;
2219f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2220f6953c82SLisandro Dalcin   PetscValidPointer(eftopt,2);
2221f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
2222f6953c82SLisandro Dalcin   PetscFunctionReturn(0);
2223f6953c82SLisandro Dalcin }
2224f6953c82SLisandro Dalcin 
2225f6953c82SLisandro Dalcin /*@
2226d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
2227d763cef2SBarry Smith 
2228d763cef2SBarry Smith    Not Collective
2229d763cef2SBarry Smith 
2230d763cef2SBarry Smith    Input Parameter:
2231d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2232d763cef2SBarry Smith 
2233d763cef2SBarry Smith    Output Parameter:
2234d763cef2SBarry Smith .  dt - the current timestep size
2235d763cef2SBarry Smith 
2236d763cef2SBarry Smith    Level: intermediate
2237d763cef2SBarry Smith 
2238aaa6c58dSLisandro Dalcin .seealso: TSSetTimeStep(), TSGetTime()
2239d763cef2SBarry Smith 
2240d763cef2SBarry Smith .keywords: TS, get, timestep
2241d763cef2SBarry Smith @*/
22427087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
2243d763cef2SBarry Smith {
2244d763cef2SBarry Smith   PetscFunctionBegin;
22450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2246f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
2247d763cef2SBarry Smith   *dt = ts->time_step;
2248d763cef2SBarry Smith   PetscFunctionReturn(0);
2249d763cef2SBarry Smith }
2250d763cef2SBarry Smith 
2251d8e5e3e6SSatish Balay /*@
2252d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
2253d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
2254d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
2255d763cef2SBarry Smith    the solution at the next timestep has been calculated.
2256d763cef2SBarry Smith 
2257d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
2258d763cef2SBarry Smith 
2259d763cef2SBarry Smith    Input Parameter:
2260d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2261d763cef2SBarry Smith 
2262d763cef2SBarry Smith    Output Parameter:
2263d763cef2SBarry Smith .  v - the vector containing the solution
2264d763cef2SBarry Smith 
226563e21af5SBarry Smith    Note: If you used TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP); this does not return the solution at the requested
226663e21af5SBarry Smith    final time. It returns the solution at the next timestep.
226763e21af5SBarry Smith 
2268d763cef2SBarry Smith    Level: intermediate
2269d763cef2SBarry Smith 
22700ed3bfb6SBarry Smith .seealso: TSGetTimeStep(), TSGetTime(), TSGetSolveTime(), TSGetSolutionComponents(), TSSetSolutionFunction()
2271d763cef2SBarry Smith 
2272d763cef2SBarry Smith .keywords: TS, timestep, get, solution
2273d763cef2SBarry Smith @*/
22747087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
2275d763cef2SBarry Smith {
2276d763cef2SBarry Smith   PetscFunctionBegin;
22770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22784482741eSBarry Smith   PetscValidPointer(v,2);
22798737fe31SLisandro Dalcin   *v = ts->vec_sol;
2280d763cef2SBarry Smith   PetscFunctionReturn(0);
2281d763cef2SBarry Smith }
2282d763cef2SBarry Smith 
228303fe5f5eSDebojyoti Ghosh /*@
2284b2bf4f3aSDebojyoti Ghosh    TSGetSolutionComponents - Returns any solution components at the present
228503fe5f5eSDebojyoti Ghosh    timestep, if available for the time integration method being used.
2286b2bf4f3aSDebojyoti Ghosh    Solution components are quantities that share the same size and
228703fe5f5eSDebojyoti Ghosh    structure as the solution vector.
228803fe5f5eSDebojyoti Ghosh 
228903fe5f5eSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
229003fe5f5eSDebojyoti Ghosh 
229103fe5f5eSDebojyoti Ghosh    Parameters :
229203fe5f5eSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2293b2bf4f3aSDebojyoti Ghosh .  n - If v is PETSC_NULL, then the number of solution components is
2294b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
229503fe5f5eSDebojyoti Ghosh        returned in v.
2296b2bf4f3aSDebojyoti Ghosh .  v - the vector containing the n-th solution component
229703fe5f5eSDebojyoti Ghosh        (may be PETSC_NULL to use this function to find out
2298b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
229903fe5f5eSDebojyoti Ghosh 
23004cdd57e5SDebojyoti Ghosh    Level: advanced
230103fe5f5eSDebojyoti Ghosh 
230203fe5f5eSDebojyoti Ghosh .seealso: TSGetSolution()
230303fe5f5eSDebojyoti Ghosh 
230403fe5f5eSDebojyoti Ghosh .keywords: TS, timestep, get, solution
230503fe5f5eSDebojyoti Ghosh @*/
2306b2bf4f3aSDebojyoti Ghosh PetscErrorCode  TSGetSolutionComponents(TS ts,PetscInt *n,Vec *v)
230703fe5f5eSDebojyoti Ghosh {
230803fe5f5eSDebojyoti Ghosh   PetscErrorCode ierr;
230903fe5f5eSDebojyoti Ghosh 
231003fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
231103fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2312b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
231303fe5f5eSDebojyoti Ghosh   else {
2314b2bf4f3aSDebojyoti Ghosh     ierr = (*ts->ops->getsolutioncomponents)(ts,n,v);CHKERRQ(ierr);
231503fe5f5eSDebojyoti Ghosh   }
231603fe5f5eSDebojyoti Ghosh   PetscFunctionReturn(0);
231703fe5f5eSDebojyoti Ghosh }
231803fe5f5eSDebojyoti Ghosh 
23194cdd57e5SDebojyoti Ghosh /*@
23204cdd57e5SDebojyoti Ghosh    TSGetAuxSolution - Returns an auxiliary solution at the present
23214cdd57e5SDebojyoti Ghosh    timestep, if available for the time integration method being used.
23224cdd57e5SDebojyoti Ghosh 
23234cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23244cdd57e5SDebojyoti Ghosh 
23254cdd57e5SDebojyoti Ghosh    Parameters :
23264cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
23274cdd57e5SDebojyoti Ghosh .  v - the vector containing the auxiliary solution
23284cdd57e5SDebojyoti Ghosh 
23294cdd57e5SDebojyoti Ghosh    Level: intermediate
23304cdd57e5SDebojyoti Ghosh 
23314cdd57e5SDebojyoti Ghosh .seealso: TSGetSolution()
23324cdd57e5SDebojyoti Ghosh 
23334cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, solution
23344cdd57e5SDebojyoti Ghosh @*/
23354cdd57e5SDebojyoti Ghosh PetscErrorCode  TSGetAuxSolution(TS ts,Vec *v)
23364cdd57e5SDebojyoti Ghosh {
23374cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
23384cdd57e5SDebojyoti Ghosh 
23394cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23404cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2341f6356ec7SDebojyoti Ghosh   if (ts->ops->getauxsolution) {
23424cdd57e5SDebojyoti Ghosh     ierr = (*ts->ops->getauxsolution)(ts,v);CHKERRQ(ierr);
2343f6356ec7SDebojyoti Ghosh   } else {
2344f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v); CHKERRQ(ierr);
2345f6356ec7SDebojyoti Ghosh   }
23464cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
23474cdd57e5SDebojyoti Ghosh }
23484cdd57e5SDebojyoti Ghosh 
23494cdd57e5SDebojyoti Ghosh /*@
23504cdd57e5SDebojyoti Ghosh    TSGetTimeError - Returns the estimated error vector, if the chosen
23514cdd57e5SDebojyoti Ghosh    TSType has an error estimation functionality.
23524cdd57e5SDebojyoti Ghosh 
23534cdd57e5SDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
23544cdd57e5SDebojyoti Ghosh 
23559657682dSDebojyoti Ghosh    Note: MUST call after TSSetUp()
23569657682dSDebojyoti Ghosh 
23574cdd57e5SDebojyoti Ghosh    Parameters :
23584cdd57e5SDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
2359657c1e31SEmil Constantinescu .  n - current estimate (n=0) or previous one (n=-1)
23604cdd57e5SDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
23614cdd57e5SDebojyoti Ghosh 
23624cdd57e5SDebojyoti Ghosh    Level: intermediate
23634cdd57e5SDebojyoti Ghosh 
236457df6a1bSDebojyoti Ghosh .seealso: TSGetSolution(), TSSetTimeError()
23654cdd57e5SDebojyoti Ghosh 
23664cdd57e5SDebojyoti Ghosh .keywords: TS, timestep, get, error
23674cdd57e5SDebojyoti Ghosh @*/
23680a01e1b2SEmil Constantinescu PetscErrorCode  TSGetTimeError(TS ts,PetscInt n,Vec *v)
23694cdd57e5SDebojyoti Ghosh {
23704cdd57e5SDebojyoti Ghosh   PetscErrorCode ierr;
23714cdd57e5SDebojyoti Ghosh 
23724cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23734cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2374f6356ec7SDebojyoti Ghosh   if (ts->ops->gettimeerror) {
23750a01e1b2SEmil Constantinescu     ierr = (*ts->ops->gettimeerror)(ts,n,v);CHKERRQ(ierr);
2376f6356ec7SDebojyoti Ghosh   } else {
2377f6356ec7SDebojyoti Ghosh     ierr = VecZeroEntries(*v);CHKERRQ(ierr);
2378f6356ec7SDebojyoti Ghosh   }
23794cdd57e5SDebojyoti Ghosh   PetscFunctionReturn(0);
23804cdd57e5SDebojyoti Ghosh }
23814cdd57e5SDebojyoti Ghosh 
238257df6a1bSDebojyoti Ghosh /*@
238357df6a1bSDebojyoti Ghosh    TSSetTimeError - Sets the estimated error vector, if the chosen
238457df6a1bSDebojyoti Ghosh    TSType has an error estimation functionality. This can be used
238557df6a1bSDebojyoti Ghosh    to restart such a time integrator with a given error vector.
238657df6a1bSDebojyoti Ghosh 
238757df6a1bSDebojyoti Ghosh    Not Collective, but Vec returned is parallel if TS is parallel
238857df6a1bSDebojyoti Ghosh 
238957df6a1bSDebojyoti Ghosh    Parameters :
239057df6a1bSDebojyoti Ghosh .  ts - the TS context obtained from TSCreate() (input parameter).
239157df6a1bSDebojyoti Ghosh .  v - the vector containing the error (same size as the solution).
239257df6a1bSDebojyoti Ghosh 
239357df6a1bSDebojyoti Ghosh    Level: intermediate
239457df6a1bSDebojyoti Ghosh 
239557df6a1bSDebojyoti Ghosh .seealso: TSSetSolution(), TSGetTimeError)
239657df6a1bSDebojyoti Ghosh 
239757df6a1bSDebojyoti Ghosh .keywords: TS, timestep, get, error
239857df6a1bSDebojyoti Ghosh @*/
239957df6a1bSDebojyoti Ghosh PetscErrorCode  TSSetTimeError(TS ts,Vec v)
240057df6a1bSDebojyoti Ghosh {
240157df6a1bSDebojyoti Ghosh   PetscErrorCode ierr;
240257df6a1bSDebojyoti Ghosh 
240357df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
240457df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24059657682dSDebojyoti Ghosh   if (!ts->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetUp() first");
240657df6a1bSDebojyoti Ghosh   if (ts->ops->settimeerror) {
240757df6a1bSDebojyoti Ghosh     ierr = (*ts->ops->settimeerror)(ts,v);CHKERRQ(ierr);
240857df6a1bSDebojyoti Ghosh   }
240957df6a1bSDebojyoti Ghosh   PetscFunctionReturn(0);
241057df6a1bSDebojyoti Ghosh }
241157df6a1bSDebojyoti Ghosh 
2412bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2413d8e5e3e6SSatish Balay /*@
2414bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2415d763cef2SBarry Smith 
2416bdad233fSMatthew Knepley   Not collective
2417d763cef2SBarry Smith 
2418bdad233fSMatthew Knepley   Input Parameters:
2419bdad233fSMatthew Knepley + ts   - The TS
2420bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2421d763cef2SBarry Smith .vb
24220910c330SBarry Smith          U_t - A U = 0      (linear)
24230910c330SBarry Smith          U_t - A(t) U = 0   (linear)
24240910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2425d763cef2SBarry Smith .ve
2426d763cef2SBarry Smith 
2427d763cef2SBarry Smith    Level: beginner
2428d763cef2SBarry Smith 
2429bdad233fSMatthew Knepley .keywords: TS, problem type
2430bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2431d763cef2SBarry Smith @*/
24327087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
2433a7cc72afSBarry Smith {
24349e2a6581SJed Brown   PetscErrorCode ierr;
24359e2a6581SJed Brown 
2436d763cef2SBarry Smith   PetscFunctionBegin;
24370700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2438bdad233fSMatthew Knepley   ts->problem_type = type;
24399e2a6581SJed Brown   if (type == TS_LINEAR) {
24409e2a6581SJed Brown     SNES snes;
24419e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
24429e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
24439e2a6581SJed Brown   }
2444d763cef2SBarry Smith   PetscFunctionReturn(0);
2445d763cef2SBarry Smith }
2446d763cef2SBarry Smith 
2447bdad233fSMatthew Knepley /*@C
2448bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2449bdad233fSMatthew Knepley 
2450bdad233fSMatthew Knepley   Not collective
2451bdad233fSMatthew Knepley 
2452bdad233fSMatthew Knepley   Input Parameter:
2453bdad233fSMatthew Knepley . ts   - The TS
2454bdad233fSMatthew Knepley 
2455bdad233fSMatthew Knepley   Output Parameter:
2456bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
2457bdad233fSMatthew Knepley .vb
2458089b2837SJed Brown          M U_t = A U
2459089b2837SJed Brown          M(t) U_t = A(t) U
2460b5abc632SBarry Smith          F(t,U,U_t)
2461bdad233fSMatthew Knepley .ve
2462bdad233fSMatthew Knepley 
2463bdad233fSMatthew Knepley    Level: beginner
2464bdad233fSMatthew Knepley 
2465bdad233fSMatthew Knepley .keywords: TS, problem type
2466bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
2467bdad233fSMatthew Knepley @*/
24687087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
2469a7cc72afSBarry Smith {
2470bdad233fSMatthew Knepley   PetscFunctionBegin;
24710700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
24724482741eSBarry Smith   PetscValidIntPointer(type,2);
2473bdad233fSMatthew Knepley   *type = ts->problem_type;
2474bdad233fSMatthew Knepley   PetscFunctionReturn(0);
2475bdad233fSMatthew Knepley }
2476d763cef2SBarry Smith 
2477d763cef2SBarry Smith /*@
2478d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
2479d763cef2SBarry Smith    of a timestepper.
2480d763cef2SBarry Smith 
2481d763cef2SBarry Smith    Collective on TS
2482d763cef2SBarry Smith 
2483d763cef2SBarry Smith    Input Parameter:
2484d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2485d763cef2SBarry Smith 
2486d763cef2SBarry Smith    Notes:
2487d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
2488d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
2489141bd67dSStefano Zampini    the call to TSStep() or TSSolve().  However, if one wishes to control this
2490d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
2491141bd67dSStefano Zampini    and optional routines of the form TSSetXXX(), but before TSStep() and TSSolve().
2492d763cef2SBarry Smith 
2493d763cef2SBarry Smith    Level: advanced
2494d763cef2SBarry Smith 
2495d763cef2SBarry Smith .keywords: TS, timestep, setup
2496d763cef2SBarry Smith 
2497141bd67dSStefano Zampini .seealso: TSCreate(), TSStep(), TSDestroy(), TSSolve()
2498d763cef2SBarry Smith @*/
24997087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
2500d763cef2SBarry Smith {
2501dfbe8321SBarry Smith   PetscErrorCode ierr;
25026c6b9e74SPeter Brune   DM             dm;
25036c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
2504d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
2505cd11d68dSLisandro Dalcin   TSIFunction    ifun;
25066c6b9e74SPeter Brune   TSIJacobian    ijac;
2507efe9872eSLisandro Dalcin   TSI2Jacobian   i2jac;
25086c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
25092ffb9264SLisandro Dalcin   PetscBool      isnone;
2510d763cef2SBarry Smith 
2511d763cef2SBarry Smith   PetscFunctionBegin;
25120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2513277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
2514277b19d0SLisandro Dalcin 
25157adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
2516cd11d68dSLisandro Dalcin     ierr = TSGetIFunction(ts,NULL,&ifun,NULL);CHKERRQ(ierr);
2517cd11d68dSLisandro Dalcin     ierr = TSSetType(ts,ifun ? TSBEULER : TSEULER);CHKERRQ(ierr);
2518d763cef2SBarry Smith   }
2519277b19d0SLisandro Dalcin 
2520277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
2521277b19d0SLisandro Dalcin 
2522e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
2523e1244c69SJed Brown     Mat Amat,Pmat;
2524e1244c69SJed Brown     SNES snes;
2525e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2526e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
2527e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2528e1244c69SJed Brown      * have displaced the RHS matrix */
2529e1244c69SJed Brown     if (Amat == ts->Arhs) {
2530abc0d4abSBarry 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 */
2531abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Arhs,MAT_COPY_VALUES,&Amat);CHKERRQ(ierr);
2532e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
2533e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
2534e1244c69SJed Brown     }
2535e1244c69SJed Brown     if (Pmat == ts->Brhs) {
2536abc0d4abSBarry Smith       ierr = MatDuplicate(ts->Brhs,MAT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
2537e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
2538e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
2539e1244c69SJed Brown     }
2540e1244c69SJed Brown   }
25412ffb9264SLisandro Dalcin 
25422ffb9264SLisandro Dalcin   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
25432ffb9264SLisandro Dalcin   ierr = TSAdaptSetDefaultType(ts->adapt,ts->default_adapt_type);CHKERRQ(ierr);
25442ffb9264SLisandro Dalcin 
2545277b19d0SLisandro Dalcin   if (ts->ops->setup) {
2546000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
2547277b19d0SLisandro Dalcin   }
2548277b19d0SLisandro Dalcin 
25492ffb9264SLisandro Dalcin   /* Attempt to check/preset a default value for the exact final time option */
25502ffb9264SLisandro Dalcin   ierr = PetscObjectTypeCompare((PetscObject)ts->adapt,TSADAPTNONE,&isnone);CHKERRQ(ierr);
25512ffb9264SLisandro Dalcin   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED)
25522ffb9264SLisandro Dalcin     ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
25532ffb9264SLisandro Dalcin 
2554a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
25556c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
25566c6b9e74SPeter Brune    */
25576c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
25580298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
25596c6b9e74SPeter Brune   if (!func) {
25606c6b9e74SPeter Brune     ierr = DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
25616c6b9e74SPeter Brune   }
2562a6772fa2SLisandro 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.
25636c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
25646c6b9e74SPeter Brune    */
25650298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
25660298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
2567efe9872eSLisandro Dalcin   ierr = DMTSGetI2Jacobian(dm,&i2jac,NULL);CHKERRQ(ierr);
25680298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
2569efe9872eSLisandro Dalcin   if (!jac && (ijac || i2jac || rhsjac)) {
25706c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
25716c6b9e74SPeter Brune   }
2572c0517034SDebojyoti Ghosh 
2573c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2574c0517034SDebojyoti Ghosh   if (ts->ops->startingmethod) {
2575c0517034SDebojyoti Ghosh     ierr = (*ts->ops->startingmethod)(ts);CHKERRQ(ierr);
2576c0517034SDebojyoti Ghosh   }
2577c0517034SDebojyoti Ghosh 
2578277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
2579277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
2580277b19d0SLisandro Dalcin }
2581277b19d0SLisandro Dalcin 
2582f6a906c0SBarry Smith /*@
2583277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
2584277b19d0SLisandro Dalcin 
2585277b19d0SLisandro Dalcin    Collective on TS
2586277b19d0SLisandro Dalcin 
2587277b19d0SLisandro Dalcin    Input Parameter:
2588277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2589277b19d0SLisandro Dalcin 
2590277b19d0SLisandro Dalcin    Level: beginner
2591277b19d0SLisandro Dalcin 
2592277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2593277b19d0SLisandro Dalcin 
2594277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2595277b19d0SLisandro Dalcin @*/
2596277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2597277b19d0SLisandro Dalcin {
25981d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit,next;
2599277b19d0SLisandro Dalcin   PetscErrorCode  ierr;
2600277b19d0SLisandro Dalcin 
2601277b19d0SLisandro Dalcin   PetscFunctionBegin;
2602277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2603b18ea86cSHong Zhang 
2604277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2605277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2606277b19d0SLisandro Dalcin   }
2607277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2608e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2609bbd56ea5SKarl Rupp 
26104e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
26114e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2612214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
26136bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2614efe9872eSLisandro Dalcin   ierr = VecDestroy(&ts->vec_dot);CHKERRQ(ierr);
2615e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2616e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
261738637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2618bbd56ea5SKarl Rupp 
2619d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2620d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2621715f1b00SHong Zhang 
2622ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
26232c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
262436eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
262513b1b0ffSHong Zhang   ierr = MatDestroy(&ts->mat_sensip);CHKERRQ(ierr);
2626022c081aSHong Zhang 
26271d06f6b3SHong Zhang   while (ilink) {
26281d06f6b3SHong Zhang     next = ilink->next;
26291d06f6b3SHong Zhang     ierr = TSDestroy(&ilink->ts);CHKERRQ(ierr);
26301d06f6b3SHong Zhang     ierr = PetscFree(ilink->splitname);CHKERRQ(ierr);
26311d06f6b3SHong Zhang     ierr = ISDestroy(&ilink->is);CHKERRQ(ierr);
26321d06f6b3SHong Zhang     ierr = PetscFree(ilink);CHKERRQ(ierr);
26331d06f6b3SHong Zhang     ilink = next;
263487f4e208SHong Zhang   }
2635545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
2636277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2637d763cef2SBarry Smith   PetscFunctionReturn(0);
2638d763cef2SBarry Smith }
2639d763cef2SBarry Smith 
2640d8e5e3e6SSatish Balay /*@
2641d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2642d763cef2SBarry Smith    with TSCreate().
2643d763cef2SBarry Smith 
2644d763cef2SBarry Smith    Collective on TS
2645d763cef2SBarry Smith 
2646d763cef2SBarry Smith    Input Parameter:
2647d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2648d763cef2SBarry Smith 
2649d763cef2SBarry Smith    Level: beginner
2650d763cef2SBarry Smith 
2651d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2652d763cef2SBarry Smith 
2653d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2654d763cef2SBarry Smith @*/
26556bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2656d763cef2SBarry Smith {
26576849ba73SBarry Smith   PetscErrorCode ierr;
2658d763cef2SBarry Smith 
2659d763cef2SBarry Smith   PetscFunctionBegin;
26606bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
26616bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
26626bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2663d763cef2SBarry Smith 
26646bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2665277b19d0SLisandro Dalcin 
2666e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2667e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
26686bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
26696d4c513bSLisandro Dalcin 
2670bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2671bc952696SBarry Smith 
267284df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
26736427ac75SLisandro Dalcin   ierr = TSEventDestroy(&(*ts)->event);CHKERRQ(ierr);
26746427ac75SLisandro Dalcin 
26756bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
26766bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
26776bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
26780dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
26796d4c513bSLisandro Dalcin 
2680a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2681d763cef2SBarry Smith   PetscFunctionReturn(0);
2682d763cef2SBarry Smith }
2683d763cef2SBarry Smith 
2684d8e5e3e6SSatish Balay /*@
2685d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2686d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2687d763cef2SBarry Smith 
2688d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2689d763cef2SBarry Smith 
2690d763cef2SBarry Smith    Input Parameter:
2691d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2692d763cef2SBarry Smith 
2693d763cef2SBarry Smith    Output Parameter:
2694d763cef2SBarry Smith .  snes - the nonlinear solver context
2695d763cef2SBarry Smith 
2696d763cef2SBarry Smith    Notes:
2697d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2698d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
269994b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2700d763cef2SBarry Smith 
2701d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
27020298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2703d763cef2SBarry Smith 
2704d763cef2SBarry Smith    Level: beginner
2705d763cef2SBarry Smith 
2706d763cef2SBarry Smith .keywords: timestep, get, SNES
2707d763cef2SBarry Smith @*/
27087087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2709d763cef2SBarry Smith {
2710d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2711d372ba47SLisandro Dalcin 
2712d763cef2SBarry Smith   PetscFunctionBegin;
27130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27144482741eSBarry Smith   PetscValidPointer(snes,2);
2715d372ba47SLisandro Dalcin   if (!ts->snes) {
2716ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
27170298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
27183bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2719d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2720496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
27219e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
27229e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
27239e2a6581SJed Brown     }
2724d372ba47SLisandro Dalcin   }
2725d763cef2SBarry Smith   *snes = ts->snes;
2726d763cef2SBarry Smith   PetscFunctionReturn(0);
2727d763cef2SBarry Smith }
2728d763cef2SBarry Smith 
2729deb2cd25SJed Brown /*@
2730deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2731deb2cd25SJed Brown 
2732deb2cd25SJed Brown    Collective
2733deb2cd25SJed Brown 
2734deb2cd25SJed Brown    Input Parameter:
2735deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2736deb2cd25SJed Brown -  snes - the nonlinear solver context
2737deb2cd25SJed Brown 
2738deb2cd25SJed Brown    Notes:
2739deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2740deb2cd25SJed Brown 
2741deb2cd25SJed Brown    Level: developer
2742deb2cd25SJed Brown 
2743deb2cd25SJed Brown .keywords: timestep, set, SNES
2744deb2cd25SJed Brown @*/
2745deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2746deb2cd25SJed Brown {
2747deb2cd25SJed Brown   PetscErrorCode ierr;
2748d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2749deb2cd25SJed Brown 
2750deb2cd25SJed Brown   PetscFunctionBegin;
2751deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2752deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2753deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2754deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2755bbd56ea5SKarl Rupp 
2756deb2cd25SJed Brown   ts->snes = snes;
2757bbd56ea5SKarl Rupp 
27580298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
27590298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2760740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
27610298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2762740132f1SEmil Constantinescu   }
2763deb2cd25SJed Brown   PetscFunctionReturn(0);
2764deb2cd25SJed Brown }
2765deb2cd25SJed Brown 
2766d8e5e3e6SSatish Balay /*@
276794b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2768d763cef2SBarry Smith    a TS (timestepper) context.
2769d763cef2SBarry Smith 
277094b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2771d763cef2SBarry Smith 
2772d763cef2SBarry Smith    Input Parameter:
2773d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2774d763cef2SBarry Smith 
2775d763cef2SBarry Smith    Output Parameter:
277694b7f48cSBarry Smith .  ksp - the nonlinear solver context
2777d763cef2SBarry Smith 
2778d763cef2SBarry Smith    Notes:
277994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2780d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2781d763cef2SBarry Smith    KSP and PC contexts as well.
2782d763cef2SBarry Smith 
278394b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
27840298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2785d763cef2SBarry Smith 
2786d763cef2SBarry Smith    Level: beginner
2787d763cef2SBarry Smith 
278894b7f48cSBarry Smith .keywords: timestep, get, KSP
2789d763cef2SBarry Smith @*/
27907087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2791d763cef2SBarry Smith {
2792d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2793089b2837SJed Brown   SNES           snes;
2794d372ba47SLisandro Dalcin 
2795d763cef2SBarry Smith   PetscFunctionBegin;
27960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27974482741eSBarry Smith   PetscValidPointer(ksp,2);
279817186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2799e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2800089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2801089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2802d763cef2SBarry Smith   PetscFunctionReturn(0);
2803d763cef2SBarry Smith }
2804d763cef2SBarry Smith 
2805d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2806d763cef2SBarry Smith 
2807adb62b0dSMatthew Knepley /*@
2808618ce8baSLisandro Dalcin    TSSetMaxSteps - Sets the maximum number of steps to use.
2809618ce8baSLisandro Dalcin 
2810618ce8baSLisandro Dalcin    Logically Collective on TS
2811618ce8baSLisandro Dalcin 
2812618ce8baSLisandro Dalcin    Input Parameters:
2813618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2814618ce8baSLisandro Dalcin -  maxsteps - maximum number of steps to use
2815618ce8baSLisandro Dalcin 
2816618ce8baSLisandro Dalcin    Options Database Keys:
2817618ce8baSLisandro Dalcin .  -ts_max_steps <maxsteps> - Sets maxsteps
2818618ce8baSLisandro Dalcin 
2819618ce8baSLisandro Dalcin    Notes:
2820618ce8baSLisandro Dalcin    The default maximum number of steps is 5000
2821618ce8baSLisandro Dalcin 
2822618ce8baSLisandro Dalcin    Level: intermediate
2823618ce8baSLisandro Dalcin 
2824618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, steps
2825618ce8baSLisandro Dalcin 
2826618ce8baSLisandro Dalcin .seealso: TSGetMaxSteps(), TSSetMaxTime(), TSSetExactFinalTime()
2827618ce8baSLisandro Dalcin @*/
2828618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxSteps(TS ts,PetscInt maxsteps)
2829618ce8baSLisandro Dalcin {
2830618ce8baSLisandro Dalcin   PetscFunctionBegin;
2831618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2832618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2833618ce8baSLisandro Dalcin   if (maxsteps < 0 ) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Maximum number of steps must be non-negative");
2834618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
2835618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2836618ce8baSLisandro Dalcin }
2837618ce8baSLisandro Dalcin 
2838618ce8baSLisandro Dalcin /*@
2839618ce8baSLisandro Dalcin    TSGetMaxSteps - Gets the maximum number of steps to use.
2840618ce8baSLisandro Dalcin 
2841618ce8baSLisandro Dalcin    Not Collective
2842618ce8baSLisandro Dalcin 
2843618ce8baSLisandro Dalcin    Input Parameters:
2844618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2845618ce8baSLisandro Dalcin 
2846618ce8baSLisandro Dalcin    Output Parameter:
2847618ce8baSLisandro Dalcin .  maxsteps - maximum number of steps to use
2848618ce8baSLisandro Dalcin 
2849618ce8baSLisandro Dalcin    Level: advanced
2850618ce8baSLisandro Dalcin 
2851618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, steps
2852618ce8baSLisandro Dalcin 
2853618ce8baSLisandro Dalcin .seealso: TSSetMaxSteps(), TSGetMaxTime(), TSSetMaxTime()
2854618ce8baSLisandro Dalcin @*/
2855618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxSteps(TS ts,PetscInt *maxsteps)
2856618ce8baSLisandro Dalcin {
2857618ce8baSLisandro Dalcin   PetscFunctionBegin;
2858618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2859618ce8baSLisandro Dalcin   PetscValidIntPointer(maxsteps,2);
2860618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
2861618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2862618ce8baSLisandro Dalcin }
2863618ce8baSLisandro Dalcin 
2864618ce8baSLisandro Dalcin /*@
2865618ce8baSLisandro Dalcin    TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2866618ce8baSLisandro Dalcin 
2867618ce8baSLisandro Dalcin    Logically Collective on TS
2868618ce8baSLisandro Dalcin 
2869618ce8baSLisandro Dalcin    Input Parameters:
2870618ce8baSLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2871618ce8baSLisandro Dalcin -  maxtime - final time to step to
2872618ce8baSLisandro Dalcin 
2873618ce8baSLisandro Dalcin    Options Database Keys:
2874ef85077eSLisandro Dalcin .  -ts_max_time <maxtime> - Sets maxtime
2875618ce8baSLisandro Dalcin 
2876618ce8baSLisandro Dalcin    Notes:
2877618ce8baSLisandro Dalcin    The default maximum time is 5.0
2878618ce8baSLisandro Dalcin 
2879618ce8baSLisandro Dalcin    Level: intermediate
2880618ce8baSLisandro Dalcin 
2881618ce8baSLisandro Dalcin .keywords: TS, timestep, set, maximum, time
2882618ce8baSLisandro Dalcin 
2883618ce8baSLisandro Dalcin .seealso: TSGetMaxTime(), TSSetMaxSteps(), TSSetExactFinalTime()
2884618ce8baSLisandro Dalcin @*/
2885618ce8baSLisandro Dalcin PetscErrorCode TSSetMaxTime(TS ts,PetscReal maxtime)
2886618ce8baSLisandro Dalcin {
2887618ce8baSLisandro Dalcin   PetscFunctionBegin;
2888618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2889618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts,maxtime,2);
2890618ce8baSLisandro Dalcin   ts->max_time = maxtime;
2891618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2892618ce8baSLisandro Dalcin }
2893618ce8baSLisandro Dalcin 
2894618ce8baSLisandro Dalcin /*@
2895618ce8baSLisandro Dalcin    TSGetMaxTime - Gets the maximum (or final) time for timestepping.
2896618ce8baSLisandro Dalcin 
2897618ce8baSLisandro Dalcin    Not Collective
2898618ce8baSLisandro Dalcin 
2899618ce8baSLisandro Dalcin    Input Parameters:
2900618ce8baSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2901618ce8baSLisandro Dalcin 
2902618ce8baSLisandro Dalcin    Output Parameter:
2903618ce8baSLisandro Dalcin .  maxtime - final time to step to
2904618ce8baSLisandro Dalcin 
2905618ce8baSLisandro Dalcin    Level: advanced
2906618ce8baSLisandro Dalcin 
2907618ce8baSLisandro Dalcin .keywords: TS, timestep, get, maximum, time
2908618ce8baSLisandro Dalcin 
2909618ce8baSLisandro Dalcin .seealso: TSSetMaxTime(), TSGetMaxSteps(), TSSetMaxSteps()
2910618ce8baSLisandro Dalcin @*/
2911618ce8baSLisandro Dalcin PetscErrorCode TSGetMaxTime(TS ts,PetscReal *maxtime)
2912618ce8baSLisandro Dalcin {
2913618ce8baSLisandro Dalcin   PetscFunctionBegin;
2914618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2915618ce8baSLisandro Dalcin   PetscValidRealPointer(maxtime,2);
2916618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
2917618ce8baSLisandro Dalcin   PetscFunctionReturn(0);
2918618ce8baSLisandro Dalcin }
2919618ce8baSLisandro Dalcin 
2920618ce8baSLisandro Dalcin /*@
2921aaa6c58dSLisandro Dalcin    TSSetInitialTimeStep - Deprecated, use TSSetTime() and TSSetTimeStep().
2922edc382c3SSatish Balay 
2923edc382c3SSatish Balay    Level: deprecated
2924edc382c3SSatish Balay 
2925aaa6c58dSLisandro Dalcin @*/
2926aaa6c58dSLisandro Dalcin PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
2927aaa6c58dSLisandro Dalcin {
2928aaa6c58dSLisandro Dalcin   PetscErrorCode ierr;
2929aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
2930aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2931aaa6c58dSLisandro Dalcin   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
2932aaa6c58dSLisandro Dalcin   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
2933aaa6c58dSLisandro Dalcin   PetscFunctionReturn(0);
2934aaa6c58dSLisandro Dalcin }
2935aaa6c58dSLisandro Dalcin 
2936aaa6c58dSLisandro Dalcin /*@
293719eac22cSLisandro Dalcin    TSGetDuration - Deprecated, use TSGetMaxSteps() and TSGetMaxTime().
2938edc382c3SSatish Balay 
2939edc382c3SSatish Balay    Level: deprecated
2940edc382c3SSatish Balay 
2941adb62b0dSMatthew Knepley @*/
29427087cfbeSBarry Smith PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2943adb62b0dSMatthew Knepley {
2944adb62b0dSMatthew Knepley   PetscFunctionBegin;
29450700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2946abc0a331SBarry Smith   if (maxsteps) {
29474482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2948adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2949adb62b0dSMatthew Knepley   }
2950abc0a331SBarry Smith   if (maxtime) {
29514482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2952adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2953adb62b0dSMatthew Knepley   }
2954adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2955adb62b0dSMatthew Knepley }
2956adb62b0dSMatthew Knepley 
2957d763cef2SBarry Smith /*@
295819eac22cSLisandro Dalcin    TSSetDuration - Deprecated, use TSSetMaxSteps() and TSSetMaxTime().
2959edc382c3SSatish Balay 
2960edc382c3SSatish Balay    Level: deprecated
2961edc382c3SSatish Balay 
2962d763cef2SBarry Smith @*/
29637087cfbeSBarry Smith PetscErrorCode TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2964d763cef2SBarry Smith {
2965d763cef2SBarry Smith   PetscFunctionBegin;
29660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2967c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2968c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
296939b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
297039b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2971d763cef2SBarry Smith   PetscFunctionReturn(0);
2972d763cef2SBarry Smith }
2973d763cef2SBarry Smith 
2974d763cef2SBarry Smith /*@
29755c5f5948SLisandro Dalcin    TSGetTimeStepNumber - Deprecated, use TSGetStepNumber().
2976edc382c3SSatish Balay 
2977edc382c3SSatish Balay    Level: deprecated
2978edc382c3SSatish Balay 
29795c5f5948SLisandro Dalcin @*/
2980e193eaafSLisandro Dalcin PetscErrorCode TSGetTimeStepNumber(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
29815c5f5948SLisandro Dalcin 
298219eac22cSLisandro Dalcin /*@
29834f4e0956SLisandro Dalcin    TSGetTotalSteps - Deprecated, use TSGetStepNumber().
2984edc382c3SSatish Balay 
2985edc382c3SSatish Balay    Level: deprecated
2986edc382c3SSatish Balay 
29874f4e0956SLisandro Dalcin @*/
29884f4e0956SLisandro Dalcin PetscErrorCode TSGetTotalSteps(TS ts,PetscInt *steps) { return TSGetStepNumber(ts,steps); }
29894f4e0956SLisandro Dalcin 
29904f4e0956SLisandro Dalcin /*@
2991d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2992d763cef2SBarry Smith    for use by the TS routines.
2993d763cef2SBarry Smith 
29943f9fe445SBarry Smith    Logically Collective on TS and Vec
2995d763cef2SBarry Smith 
2996d763cef2SBarry Smith    Input Parameters:
2997d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
29980910c330SBarry Smith -  u - the solution vector
2999d763cef2SBarry Smith 
3000d763cef2SBarry Smith    Level: beginner
3001d763cef2SBarry Smith 
3002715f1b00SHong Zhang .keywords: TS, timestep, set, solution, initial values
30030ed3bfb6SBarry Smith 
30040ed3bfb6SBarry Smith .seealso: TSSetSolutionFunction(), TSGetSolution(), TSCreate()
3005d763cef2SBarry Smith @*/
30060910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
3007d763cef2SBarry Smith {
30088737fe31SLisandro Dalcin   PetscErrorCode ierr;
3009496e6a7aSJed Brown   DM             dm;
30108737fe31SLisandro Dalcin 
3011d763cef2SBarry Smith   PetscFunctionBegin;
30120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30130910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
30140910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
30156bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
30160910c330SBarry Smith   ts->vec_sol = u;
3017bbd56ea5SKarl Rupp 
3018496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
30190910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
3020d763cef2SBarry Smith   PetscFunctionReturn(0);
3021d763cef2SBarry Smith }
3022d763cef2SBarry Smith 
3023ac226902SBarry Smith /*@C
3024000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
30253f2090d5SJed Brown   called once at the beginning of each time step.
3026000e7ae3SMatthew Knepley 
30273f9fe445SBarry Smith   Logically Collective on TS
3028000e7ae3SMatthew Knepley 
3029000e7ae3SMatthew Knepley   Input Parameters:
3030000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3031000e7ae3SMatthew Knepley - func - The function
3032000e7ae3SMatthew Knepley 
3033000e7ae3SMatthew Knepley   Calling sequence of func:
3034000e7ae3SMatthew Knepley . func (TS ts);
3035000e7ae3SMatthew Knepley 
3036000e7ae3SMatthew Knepley   Level: intermediate
3037000e7ae3SMatthew Knepley 
3038000e7ae3SMatthew Knepley .keywords: TS, timestep
3039dcb233daSLisandro Dalcin .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep(), TSRestartStep()
3040000e7ae3SMatthew Knepley @*/
30417087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
3042000e7ae3SMatthew Knepley {
3043000e7ae3SMatthew Knepley   PetscFunctionBegin;
30440700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3045ae60f76fSBarry Smith   ts->prestep = func;
3046000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3047000e7ae3SMatthew Knepley }
3048000e7ae3SMatthew Knepley 
304909ee8438SJed Brown /*@
30503f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
30513f2090d5SJed Brown 
30523f2090d5SJed Brown   Collective on TS
30533f2090d5SJed Brown 
30543f2090d5SJed Brown   Input Parameters:
30553f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
30563f2090d5SJed Brown 
30573f2090d5SJed Brown   Notes:
30583f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
30593f2090d5SJed Brown   so most users would not generally call this routine themselves.
30603f2090d5SJed Brown 
30613f2090d5SJed Brown   Level: developer
30623f2090d5SJed Brown 
30633f2090d5SJed Brown .keywords: TS, timestep
30649be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
30653f2090d5SJed Brown @*/
30667087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
30673f2090d5SJed Brown {
30683f2090d5SJed Brown   PetscErrorCode ierr;
30693f2090d5SJed Brown 
30703f2090d5SJed Brown   PetscFunctionBegin;
30710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3072ae60f76fSBarry Smith   if (ts->prestep) {
30735efd42a4SStefano Zampini     Vec              U;
30745efd42a4SStefano Zampini     PetscObjectState sprev,spost;
30755efd42a4SStefano Zampini 
30765efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
30775efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3078ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
30795efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3080dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3081312ce896SJed Brown   }
30823f2090d5SJed Brown   PetscFunctionReturn(0);
30833f2090d5SJed Brown }
30843f2090d5SJed Brown 
3085b8123daeSJed Brown /*@C
3086b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3087b8123daeSJed Brown   called once at the beginning of each stage.
3088b8123daeSJed Brown 
3089b8123daeSJed Brown   Logically Collective on TS
3090b8123daeSJed Brown 
3091b8123daeSJed Brown   Input Parameters:
3092b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
3093b8123daeSJed Brown - func - The function
3094b8123daeSJed Brown 
3095b8123daeSJed Brown   Calling sequence of func:
3096b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
3097b8123daeSJed Brown 
3098b8123daeSJed Brown   Level: intermediate
3099b8123daeSJed Brown 
3100b8123daeSJed Brown   Note:
3101b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
310280275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
3103b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
3104b8123daeSJed Brown 
3105b8123daeSJed Brown .keywords: TS, timestep
31069be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3107b8123daeSJed Brown @*/
3108b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
3109b8123daeSJed Brown {
3110b8123daeSJed Brown   PetscFunctionBegin;
3111b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3112ae60f76fSBarry Smith   ts->prestage = func;
3113b8123daeSJed Brown   PetscFunctionReturn(0);
3114b8123daeSJed Brown }
3115b8123daeSJed Brown 
31169be3e283SDebojyoti Ghosh /*@C
31179be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
31189be3e283SDebojyoti Ghosh   called once at the end of each stage.
31199be3e283SDebojyoti Ghosh 
31209be3e283SDebojyoti Ghosh   Logically Collective on TS
31219be3e283SDebojyoti Ghosh 
31229be3e283SDebojyoti Ghosh   Input Parameters:
31239be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
31249be3e283SDebojyoti Ghosh - func - The function
31259be3e283SDebojyoti Ghosh 
31269be3e283SDebojyoti Ghosh   Calling sequence of func:
31279be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
31289be3e283SDebojyoti Ghosh 
31299be3e283SDebojyoti Ghosh   Level: intermediate
31309be3e283SDebojyoti Ghosh 
31319be3e283SDebojyoti Ghosh   Note:
31329be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
313380275a0aSLisandro Dalcin   The time step number being computed can be queried using TSGetStepNumber() and the total size of the step being
31349be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
31359be3e283SDebojyoti Ghosh 
31369be3e283SDebojyoti Ghosh .keywords: TS, timestep
31379be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
31389be3e283SDebojyoti Ghosh @*/
31399be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
31409be3e283SDebojyoti Ghosh {
31419be3e283SDebojyoti Ghosh   PetscFunctionBegin;
31429be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
31439be3e283SDebojyoti Ghosh   ts->poststage = func;
31449be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
31459be3e283SDebojyoti Ghosh }
31469be3e283SDebojyoti Ghosh 
3147c688d042SShri Abhyankar /*@C
3148c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3149c688d042SShri Abhyankar   called once at the end of each step evaluation.
3150c688d042SShri Abhyankar 
3151c688d042SShri Abhyankar   Logically Collective on TS
3152c688d042SShri Abhyankar 
3153c688d042SShri Abhyankar   Input Parameters:
3154c688d042SShri Abhyankar + ts   - The TS context obtained from TSCreate()
3155c688d042SShri Abhyankar - func - The function
3156c688d042SShri Abhyankar 
3157c688d042SShri Abhyankar   Calling sequence of func:
3158c688d042SShri Abhyankar . PetscErrorCode func(TS ts);
3159c688d042SShri Abhyankar 
3160c688d042SShri Abhyankar   Level: intermediate
3161c688d042SShri Abhyankar 
3162c688d042SShri Abhyankar   Note:
31631785ff2aSShri Abhyankar   Semantically, TSSetPostEvaluate() differs from TSSetPostStep() since the function it sets is called before event-handling
31641785ff2aSShri Abhyankar   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, TSPostStep()
3165e7e94ed4SShri Abhyankar   may be passed a different solution, possibly changed by the event handler. TSPostEvaluate() is called after the next step
3166e7e94ed4SShri Abhyankar   solution is evaluated allowing to modify it, if need be. The solution can be obtained with TSGetSolution(), the time step
3167e7e94ed4SShri Abhyankar   with TSGetTimeStep(), and the time at the start of the step is available via TSGetTime()
3168c688d042SShri Abhyankar 
3169c688d042SShri Abhyankar .keywords: TS, timestep
3170c688d042SShri Abhyankar .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
3171c688d042SShri Abhyankar @*/
3172c688d042SShri Abhyankar PetscErrorCode  TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS))
3173c688d042SShri Abhyankar {
3174c688d042SShri Abhyankar   PetscFunctionBegin;
3175c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3176c688d042SShri Abhyankar   ts->postevaluate = func;
3177c688d042SShri Abhyankar   PetscFunctionReturn(0);
3178c688d042SShri Abhyankar }
3179c688d042SShri Abhyankar 
3180b8123daeSJed Brown /*@
3181b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
3182b8123daeSJed Brown 
3183b8123daeSJed Brown   Collective on TS
3184b8123daeSJed Brown 
3185b8123daeSJed Brown   Input Parameters:
3186b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
31879be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
3188b8123daeSJed Brown 
3189b8123daeSJed Brown   Notes:
3190b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
3191b8123daeSJed Brown   most users would not generally call this routine themselves.
3192b8123daeSJed Brown 
3193b8123daeSJed Brown   Level: developer
3194b8123daeSJed Brown 
3195b8123daeSJed Brown .keywords: TS, timestep
31969be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
3197b8123daeSJed Brown @*/
3198b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
3199b8123daeSJed Brown {
3200b8123daeSJed Brown   PetscErrorCode ierr;
3201b8123daeSJed Brown 
3202b8123daeSJed Brown   PetscFunctionBegin;
3203b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3204ae60f76fSBarry Smith   if (ts->prestage) {
3205ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
3206b8123daeSJed Brown   }
3207b8123daeSJed Brown   PetscFunctionReturn(0);
3208b8123daeSJed Brown }
3209b8123daeSJed Brown 
32109be3e283SDebojyoti Ghosh /*@
32119be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
32129be3e283SDebojyoti Ghosh 
32139be3e283SDebojyoti Ghosh   Collective on TS
32149be3e283SDebojyoti Ghosh 
32159be3e283SDebojyoti Ghosh   Input Parameters:
32169be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
32179be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
32189be3e283SDebojyoti Ghosh   stageindex  - Stage number
32199be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
32209be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
32219be3e283SDebojyoti Ghosh 
32229be3e283SDebojyoti Ghosh   Notes:
32239be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
32249be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
32259be3e283SDebojyoti Ghosh 
32269be3e283SDebojyoti Ghosh   Level: developer
32279be3e283SDebojyoti Ghosh 
32289be3e283SDebojyoti Ghosh .keywords: TS, timestep
32299be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
32309be3e283SDebojyoti Ghosh @*/
32319be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
32329be3e283SDebojyoti Ghosh {
32339be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
32349be3e283SDebojyoti Ghosh 
32359be3e283SDebojyoti Ghosh   PetscFunctionBegin;
32369be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32374beae5d8SLisandro Dalcin   if (ts->poststage) {
32389be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
32399be3e283SDebojyoti Ghosh   }
32409be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
32419be3e283SDebojyoti Ghosh }
32429be3e283SDebojyoti Ghosh 
3243c688d042SShri Abhyankar /*@
3244c688d042SShri Abhyankar   TSPostEvaluate - Runs the user-defined post-evaluate function set using TSSetPostEvaluate()
3245c688d042SShri Abhyankar 
3246c688d042SShri Abhyankar   Collective on TS
3247c688d042SShri Abhyankar 
3248c688d042SShri Abhyankar   Input Parameters:
3249c688d042SShri Abhyankar . ts          - The TS context obtained from TSCreate()
3250c688d042SShri Abhyankar 
3251c688d042SShri Abhyankar   Notes:
3252c688d042SShri Abhyankar   TSPostEvaluate() is typically used within time stepping implementations,
3253c688d042SShri Abhyankar   most users would not generally call this routine themselves.
3254c688d042SShri Abhyankar 
3255c688d042SShri Abhyankar   Level: developer
3256c688d042SShri Abhyankar 
3257c688d042SShri Abhyankar .keywords: TS, timestep
3258c688d042SShri Abhyankar .seealso: TSSetPostEvaluate(), TSSetPreStep(), TSPreStep(), TSPostStep()
3259c688d042SShri Abhyankar @*/
3260c688d042SShri Abhyankar PetscErrorCode  TSPostEvaluate(TS ts)
3261c688d042SShri Abhyankar {
3262c688d042SShri Abhyankar   PetscErrorCode ierr;
3263c688d042SShri Abhyankar 
3264c688d042SShri Abhyankar   PetscFunctionBegin;
3265c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3266c688d042SShri Abhyankar   if (ts->postevaluate) {
3267dcb233daSLisandro Dalcin     Vec              U;
3268dcb233daSLisandro Dalcin     PetscObjectState sprev,spost;
3269dcb233daSLisandro Dalcin 
3270dcb233daSLisandro Dalcin     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
3271dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3272c688d042SShri Abhyankar     PetscStackCallStandard((*ts->postevaluate),(ts));
3273dcb233daSLisandro Dalcin     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3274dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
3275c688d042SShri Abhyankar   }
3276c688d042SShri Abhyankar   PetscFunctionReturn(0);
3277c688d042SShri Abhyankar }
3278c688d042SShri Abhyankar 
3279ac226902SBarry Smith /*@C
3280000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
32813f2090d5SJed Brown   called once at the end of each time step.
3282000e7ae3SMatthew Knepley 
32833f9fe445SBarry Smith   Logically Collective on TS
3284000e7ae3SMatthew Knepley 
3285000e7ae3SMatthew Knepley   Input Parameters:
3286000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
3287000e7ae3SMatthew Knepley - func - The function
3288000e7ae3SMatthew Knepley 
3289000e7ae3SMatthew Knepley   Calling sequence of func:
3290b8123daeSJed Brown $ func (TS ts);
3291000e7ae3SMatthew Knepley 
32921785ff2aSShri Abhyankar   Notes:
32931785ff2aSShri Abhyankar   The function set by TSSetPostStep() is called after each successful step. The solution vector X
32941785ff2aSShri Abhyankar   obtained by TSGetSolution() may be different than that computed at the step end if the event handler
32951785ff2aSShri Abhyankar   locates an event and TSPostEvent() modifies it. Use TSSetPostEvaluate() if an unmodified solution is needed instead.
32961785ff2aSShri Abhyankar 
3297000e7ae3SMatthew Knepley   Level: intermediate
3298000e7ae3SMatthew Knepley 
3299000e7ae3SMatthew Knepley .keywords: TS, timestep
3300dcb233daSLisandro Dalcin .seealso: TSSetPreStep(), TSSetPreStage(), TSSetPostEvaluate(), TSGetTimeStep(), TSGetStepNumber(), TSGetTime(), TSRestartStep()
3301000e7ae3SMatthew Knepley @*/
33027087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
3303000e7ae3SMatthew Knepley {
3304000e7ae3SMatthew Knepley   PetscFunctionBegin;
33050700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3306ae60f76fSBarry Smith   ts->poststep = func;
3307000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
3308000e7ae3SMatthew Knepley }
3309000e7ae3SMatthew Knepley 
331009ee8438SJed Brown /*@
33113f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
33123f2090d5SJed Brown 
33133f2090d5SJed Brown   Collective on TS
33143f2090d5SJed Brown 
33153f2090d5SJed Brown   Input Parameters:
33163f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
33173f2090d5SJed Brown 
33183f2090d5SJed Brown   Notes:
33193f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
33203f2090d5SJed Brown   so most users would not generally call this routine themselves.
33213f2090d5SJed Brown 
33223f2090d5SJed Brown   Level: developer
33233f2090d5SJed Brown 
33243f2090d5SJed Brown .keywords: TS, timestep
33253f2090d5SJed Brown @*/
33267087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
33273f2090d5SJed Brown {
33283f2090d5SJed Brown   PetscErrorCode ierr;
33293f2090d5SJed Brown 
33303f2090d5SJed Brown   PetscFunctionBegin;
33310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3332ae60f76fSBarry Smith   if (ts->poststep) {
33335efd42a4SStefano Zampini     Vec              U;
33345efd42a4SStefano Zampini     PetscObjectState sprev,spost;
33355efd42a4SStefano Zampini 
33365efd42a4SStefano Zampini     ierr = TSGetSolution(ts,&U);CHKERRQ(ierr);
33375efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&sprev);CHKERRQ(ierr);
3338ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
33395efd42a4SStefano Zampini     ierr = PetscObjectStateGet((PetscObject)U,&spost);CHKERRQ(ierr);
3340dcb233daSLisandro Dalcin     if (sprev != spost) {ierr = TSRestartStep(ts);CHKERRQ(ierr);}
334172ac3e02SJed Brown   }
33423f2090d5SJed Brown   PetscFunctionReturn(0);
33433f2090d5SJed Brown }
33443f2090d5SJed Brown 
3345d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
3346d763cef2SBarry Smith 
3347d763cef2SBarry Smith /*@C
3348a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
3349d763cef2SBarry Smith    timestep to display the iteration's  progress.
3350d763cef2SBarry Smith 
33513f9fe445SBarry Smith    Logically Collective on TS
3352d763cef2SBarry Smith 
3353d763cef2SBarry Smith    Input Parameters:
3354d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3355e213d8f1SJed Brown .  monitor - monitoring routine
3356329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
33570298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
3358b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
33590298fd71SBarry Smith           (may be NULL)
3360d763cef2SBarry Smith 
3361e213d8f1SJed Brown    Calling sequence of monitor:
3362dcb233daSLisandro Dalcin $    PetscErrorCode monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
3363d763cef2SBarry Smith 
3364d763cef2SBarry Smith +    ts - the TS context
336563e21af5SBarry 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)
33661f06c33eSBarry Smith .    time - current time
33670910c330SBarry Smith .    u - current iterate
3368d763cef2SBarry Smith -    mctx - [optional] monitoring context
3369d763cef2SBarry Smith 
3370d763cef2SBarry Smith    Notes:
3371d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
3372d763cef2SBarry Smith    already has been loaded.
3373d763cef2SBarry Smith 
337495452b02SPatrick Sanan    Fortran Notes:
337595452b02SPatrick Sanan     Only a single monitor function can be set for each TS object
3376025f1a04SBarry Smith 
3377d763cef2SBarry Smith    Level: intermediate
3378d763cef2SBarry Smith 
3379d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3380d763cef2SBarry Smith 
3381a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
3382d763cef2SBarry Smith @*/
3383c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
3384d763cef2SBarry Smith {
338578064530SBarry Smith   PetscErrorCode ierr;
338678064530SBarry Smith   PetscInt       i;
338778064530SBarry Smith   PetscBool      identical;
338878064530SBarry Smith 
3389d763cef2SBarry Smith   PetscFunctionBegin;
33900700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
339178064530SBarry Smith   for (i=0; i<ts->numbermonitors;i++) {
339278064530SBarry Smith     ierr = PetscMonitorCompare((PetscErrorCode (*)(void))monitor,mctx,mdestroy,(PetscErrorCode (*)(void))ts->monitor[i],ts->monitorcontext[i],ts->monitordestroy[i],&identical);CHKERRQ(ierr);
339378064530SBarry Smith     if (identical) PetscFunctionReturn(0);
339478064530SBarry Smith   }
339517186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
3396d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
33978704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
3398d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
3399d763cef2SBarry Smith   PetscFunctionReturn(0);
3400d763cef2SBarry Smith }
3401d763cef2SBarry Smith 
3402d763cef2SBarry Smith /*@C
3403a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
3404d763cef2SBarry Smith 
34053f9fe445SBarry Smith    Logically Collective on TS
3406d763cef2SBarry Smith 
3407d763cef2SBarry Smith    Input Parameters:
3408d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3409d763cef2SBarry Smith 
3410d763cef2SBarry Smith    Notes:
3411d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
3412d763cef2SBarry Smith 
3413d763cef2SBarry Smith    Level: intermediate
3414d763cef2SBarry Smith 
3415d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
3416d763cef2SBarry Smith 
3417a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
3418d763cef2SBarry Smith @*/
34197087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
3420d763cef2SBarry Smith {
3421d952e501SBarry Smith   PetscErrorCode ierr;
3422d952e501SBarry Smith   PetscInt       i;
3423d952e501SBarry Smith 
3424d763cef2SBarry Smith   PetscFunctionBegin;
34250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3426d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
34278704b422SBarry Smith     if (ts->monitordestroy[i]) {
34288704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
3429d952e501SBarry Smith     }
3430d952e501SBarry Smith   }
3431d763cef2SBarry Smith   ts->numbermonitors = 0;
3432d763cef2SBarry Smith   PetscFunctionReturn(0);
3433d763cef2SBarry Smith }
3434d763cef2SBarry Smith 
3435721cd6eeSBarry Smith /*@C
3436721cd6eeSBarry Smith    TSMonitorDefault - The Default monitor, prints the timestep and time for each step
34375516499fSSatish Balay 
34385516499fSSatish Balay    Level: intermediate
343941251cbbSSatish Balay 
34405516499fSSatish Balay .keywords: TS, set, monitor
34415516499fSSatish Balay 
344263e21af5SBarry Smith .seealso:  TSMonitorSet()
344341251cbbSSatish Balay @*/
3444721cd6eeSBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3445d763cef2SBarry Smith {
3446dfbe8321SBarry Smith   PetscErrorCode ierr;
3447721cd6eeSBarry Smith   PetscViewer    viewer =  vf->viewer;
344841aca3d6SBarry Smith   PetscBool      iascii,ibinary;
3449d132466eSBarry Smith 
3450d763cef2SBarry Smith   PetscFunctionBegin;
34514d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
345241aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
345341aca3d6SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
3454721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
345541aca3d6SBarry Smith   if (iascii) {
3456649052a6SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
345763e21af5SBarry Smith     if (step == -1){ /* this indicates it is an interpolated solution */
345863e21af5SBarry Smith       ierr = PetscViewerASCIIPrintf(viewer,"Interpolated solution at time %g between steps %D and %D\n",(double)ptime,ts->steps-1,ts->steps);CHKERRQ(ierr);
345963e21af5SBarry Smith     } else {
34608392e04aSShri 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);
346163e21af5SBarry Smith     }
3462649052a6SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
346341aca3d6SBarry Smith   } else if (ibinary) {
346441aca3d6SBarry Smith     PetscMPIInt rank;
346541aca3d6SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)viewer),&rank);CHKERRQ(ierr);
346641aca3d6SBarry Smith     if (!rank) {
3467450a797fSBarry Smith       PetscBool skipHeader;
3468450a797fSBarry Smith       PetscInt  classid = REAL_FILE_CLASSID;
3469450a797fSBarry Smith 
3470450a797fSBarry Smith       ierr = PetscViewerBinaryGetSkipHeader(viewer,&skipHeader);CHKERRQ(ierr);
3471450a797fSBarry Smith       if (!skipHeader) {
3472450a797fSBarry Smith          ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
3473450a797fSBarry Smith        }
347441aca3d6SBarry Smith       ierr = PetscRealView(1,&ptime,viewer);CHKERRQ(ierr);
347541aca3d6SBarry Smith     } else {
347641aca3d6SBarry Smith       ierr = PetscRealView(0,&ptime,viewer);CHKERRQ(ierr);
347741aca3d6SBarry Smith     }
347841aca3d6SBarry Smith   }
3479721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3480d763cef2SBarry Smith   PetscFunctionReturn(0);
3481d763cef2SBarry Smith }
3482d763cef2SBarry Smith 
3483cc9c3a59SBarry Smith /*@C
3484cc9c3a59SBarry Smith    TSMonitorExtreme - Prints the extreme values of the solution at each timestep
3485cc9c3a59SBarry Smith 
3486cc9c3a59SBarry Smith    Level: intermediate
3487cc9c3a59SBarry Smith 
3488cc9c3a59SBarry Smith .keywords: TS, set, monitor
3489cc9c3a59SBarry Smith 
3490cc9c3a59SBarry Smith .seealso:  TSMonitorSet()
3491cc9c3a59SBarry Smith @*/
3492cc9c3a59SBarry Smith PetscErrorCode TSMonitorExtreme(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscViewerAndFormat *vf)
3493cc9c3a59SBarry Smith {
3494cc9c3a59SBarry Smith   PetscErrorCode ierr;
3495cc9c3a59SBarry Smith   PetscViewer    viewer =  vf->viewer;
3496cc9c3a59SBarry Smith   PetscBool      iascii;
3497cc9c3a59SBarry Smith   PetscReal      max,min;
3498cc9c3a59SBarry Smith 
3499cc9c3a59SBarry Smith 
3500cc9c3a59SBarry Smith   PetscFunctionBegin;
3501cc9c3a59SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3502cc9c3a59SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
3503cc9c3a59SBarry Smith   ierr = PetscViewerPushFormat(viewer,vf->format);CHKERRQ(ierr);
3504cc9c3a59SBarry Smith   if (iascii) {
3505cc9c3a59SBarry Smith     ierr = VecMax(v,NULL,&max);CHKERRQ(ierr);
3506cc9c3a59SBarry Smith     ierr = VecMin(v,NULL,&min);CHKERRQ(ierr);
3507cc9c3a59SBarry Smith     ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
35085132926bSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s max %g min %g\n",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)" : "",(double)max,(double)min);CHKERRQ(ierr);
3509cc9c3a59SBarry Smith     ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3510cc9c3a59SBarry Smith   }
3511cc9c3a59SBarry Smith   ierr = PetscViewerPopFormat(viewer);CHKERRQ(ierr);
3512cc9c3a59SBarry Smith   PetscFunctionReturn(0);
3513cc9c3a59SBarry Smith }
3514cc9c3a59SBarry Smith 
3515cd652676SJed Brown /*@
3516cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3517cd652676SJed Brown 
3518cd652676SJed Brown    Collective on TS
3519cd652676SJed Brown 
3520cd652676SJed Brown    Input Argument:
3521cd652676SJed Brown +  ts - time stepping context
3522cd652676SJed Brown -  t - time to interpolate to
3523cd652676SJed Brown 
3524cd652676SJed Brown    Output Argument:
35250910c330SBarry Smith .  U - state at given time
3526cd652676SJed Brown 
3527cd652676SJed Brown    Level: intermediate
3528cd652676SJed Brown 
3529cd652676SJed Brown    Developer Notes:
3530cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3531cd652676SJed Brown 
3532cd652676SJed Brown .keywords: TS, set
3533cd652676SJed Brown 
3534874c02e6SLisandro Dalcin .seealso: TSSetExactFinalTime(), TSSolve()
3535cd652676SJed Brown @*/
35360910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3537cd652676SJed Brown {
3538cd652676SJed Brown   PetscErrorCode ierr;
3539cd652676SJed Brown 
3540cd652676SJed Brown   PetscFunctionBegin;
3541cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3542b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3543be5899b3SLisandro 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);
3544ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
35450910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3546cd652676SJed Brown   PetscFunctionReturn(0);
3547cd652676SJed Brown }
3548cd652676SJed Brown 
3549d763cef2SBarry Smith /*@
35506d9e5789SSean Farley    TSStep - Steps one time step
3551d763cef2SBarry Smith 
3552d763cef2SBarry Smith    Collective on TS
3553d763cef2SBarry Smith 
3554d763cef2SBarry Smith    Input Parameter:
3555d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3556d763cef2SBarry Smith 
355727829d71SBarry Smith    Level: developer
3558d763cef2SBarry Smith 
3559b8123daeSJed Brown    Notes:
356027829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
356127829d71SBarry Smith 
3562b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3563b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3564b8123daeSJed Brown 
356519eac22cSLisandro Dalcin    This may over-step the final time provided in TSSetMaxTime() depending on the time-step used. TSSolve() interpolates to exactly the
356619eac22cSLisandro Dalcin    time provided in TSSetMaxTime(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
356725cb2221SBarry Smith 
3568d763cef2SBarry Smith .keywords: TS, timestep, solve
3569d763cef2SBarry Smith 
35709be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3571d763cef2SBarry Smith @*/
3572193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3573d763cef2SBarry Smith {
3574dfbe8321SBarry Smith   PetscErrorCode   ierr;
3575fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3576be5899b3SLisandro Dalcin   PetscReal        ptime;
3577d763cef2SBarry Smith 
3578d763cef2SBarry Smith   PetscFunctionBegin;
35790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3580fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3581fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3582fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3583fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3584fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3585fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3586302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3587fffbeea8SBarry Smith 
3588d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
358968bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3590d405a339SMatthew Knepley 
3591ef85077eSLisandro Dalcin   if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
3592a6772fa2SLisandro 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()");
3593be5899b3SLisandro 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");
3594a6772fa2SLisandro Dalcin 
3595be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
3596be5899b3SLisandro Dalcin   ptime = ts->ptime; ts->ptime_prev_rollback = ts->ptime_prev;
35972808aa04SLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
3598e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3599d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3600193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3601d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3602be5899b3SLisandro Dalcin   ts->ptime_prev = ptime;
36032808aa04SLisandro Dalcin   ts->steps++;
3604be5899b3SLisandro Dalcin   ts->steprollback = PETSC_FALSE;
360528d5b5d6SLisandro Dalcin   ts->steprestart  = PETSC_FALSE;
3606362cd11cSLisandro Dalcin 
3607362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3608cef5090cSJed Brown     if (ts->errorifstepfailed) {
360908c7845fSBarry 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]);
361008c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3611d2daff3dSHong Zhang     }
361208c7845fSBarry Smith   } else if (!ts->reason) {
361308c7845fSBarry Smith     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
361408c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
361508c7845fSBarry Smith   }
361608c7845fSBarry Smith   PetscFunctionReturn(0);
361708c7845fSBarry Smith }
361808c7845fSBarry Smith 
361908c7845fSBarry Smith /*@
36207cbde773SLisandro Dalcin    TSEvaluateWLTE - Evaluate the weighted local truncation error norm
36217cbde773SLisandro Dalcin    at the end of a time step with a given order of accuracy.
36227cbde773SLisandro Dalcin 
36237cbde773SLisandro Dalcin    Collective on TS
36247cbde773SLisandro Dalcin 
36257cbde773SLisandro Dalcin    Input Arguments:
36267cbde773SLisandro Dalcin +  ts - time stepping context
36277cbde773SLisandro Dalcin .  wnormtype - norm type, either NORM_2 or NORM_INFINITY
36287cbde773SLisandro Dalcin -  order - optional, desired order for the error evaluation or PETSC_DECIDE
36297cbde773SLisandro Dalcin 
36307cbde773SLisandro Dalcin    Output Arguments:
36317cbde773SLisandro Dalcin +  order - optional, the actual order of the error evaluation
36327cbde773SLisandro Dalcin -  wlte - the weighted local truncation error norm
36337cbde773SLisandro Dalcin 
36347cbde773SLisandro Dalcin    Level: advanced
36357cbde773SLisandro Dalcin 
36367cbde773SLisandro Dalcin    Notes:
36377cbde773SLisandro Dalcin    If the timestepper cannot evaluate the error in a particular step
36387cbde773SLisandro Dalcin    (eg. in the first step or restart steps after event handling),
36397cbde773SLisandro Dalcin    this routine returns wlte=-1.0 .
36407cbde773SLisandro Dalcin 
36417cbde773SLisandro Dalcin .seealso: TSStep(), TSAdapt, TSErrorWeightedNorm()
36427cbde773SLisandro Dalcin @*/
36437cbde773SLisandro Dalcin PetscErrorCode TSEvaluateWLTE(TS ts,NormType wnormtype,PetscInt *order,PetscReal *wlte)
36447cbde773SLisandro Dalcin {
36457cbde773SLisandro Dalcin   PetscErrorCode ierr;
36467cbde773SLisandro Dalcin 
36477cbde773SLisandro Dalcin   PetscFunctionBegin;
36487cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36497cbde773SLisandro Dalcin   PetscValidType(ts,1);
36507cbde773SLisandro Dalcin   PetscValidLogicalCollectiveEnum(ts,wnormtype,4);
36517cbde773SLisandro Dalcin   if (order) PetscValidIntPointer(order,3);
36527cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts,*order,3);
36537cbde773SLisandro Dalcin   PetscValidRealPointer(wlte,4);
36547cbde773SLisandro Dalcin   if (wnormtype != NORM_2 && wnormtype != NORM_INFINITY) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
36557cbde773SLisandro Dalcin   if (!ts->ops->evaluatewlte) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateWLTE not implemented for type '%s'",((PetscObject)ts)->type_name);
36567cbde773SLisandro Dalcin   ierr = (*ts->ops->evaluatewlte)(ts,wnormtype,order,wlte);CHKERRQ(ierr);
36577cbde773SLisandro Dalcin   PetscFunctionReturn(0);
36587cbde773SLisandro Dalcin }
36597cbde773SLisandro Dalcin 
366005175c85SJed Brown /*@
366105175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
366205175c85SJed Brown 
36631c3436cfSJed Brown    Collective on TS
366405175c85SJed Brown 
366505175c85SJed Brown    Input Arguments:
36661c3436cfSJed Brown +  ts - time stepping context
36671c3436cfSJed Brown .  order - desired order of accuracy
36680298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
366905175c85SJed Brown 
367005175c85SJed Brown    Output Arguments:
36710910c330SBarry Smith .  U - state at the end of the current step
367205175c85SJed Brown 
367305175c85SJed Brown    Level: advanced
367405175c85SJed Brown 
3675108c343cSJed Brown    Notes:
3676108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3677108c343cSJed 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.
3678108c343cSJed Brown 
36791c3436cfSJed Brown .seealso: TSStep(), TSAdapt
368005175c85SJed Brown @*/
36810910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
368205175c85SJed Brown {
368305175c85SJed Brown   PetscErrorCode ierr;
368405175c85SJed Brown 
368505175c85SJed Brown   PetscFunctionBegin;
368605175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
368705175c85SJed Brown   PetscValidType(ts,1);
36880910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3689ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
36900910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
369105175c85SJed Brown   PetscFunctionReturn(0);
369205175c85SJed Brown }
369305175c85SJed Brown 
3694b1cb36f3SHong Zhang /*@
36956a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
36966a4d4014SLisandro Dalcin 
36976a4d4014SLisandro Dalcin    Collective on TS
36986a4d4014SLisandro Dalcin 
36996a4d4014SLisandro Dalcin    Input Parameter:
37006a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
370163e21af5SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used and TSSetExactFinalTime(ts,TS_EXACTFINALTIME_MATCHSTEP) was not used,
370263e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
37035a3a76d0SJed Brown 
37046a4d4014SLisandro Dalcin    Level: beginner
37056a4d4014SLisandro Dalcin 
37065a3a76d0SJed Brown    Notes:
37075a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
37085a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
37095a3a76d0SJed Brown    stepped over the final time.
37105a3a76d0SJed Brown 
37116a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
37126a4d4014SLisandro Dalcin 
371363e21af5SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep(), TSGetTime(), TSGetSolveTime()
37146a4d4014SLisandro Dalcin @*/
3715cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
37166a4d4014SLisandro Dalcin {
3717b06615a5SLisandro Dalcin   Vec               solution;
37186a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
3719f22f69f0SBarry Smith 
37206a4d4014SLisandro Dalcin   PetscFunctionBegin;
37210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3722f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3723feed9e9dSBarry Smith 
3724ee41a567SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && u) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
37250910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3726b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3727b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3728b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
37295a3a76d0SJed Brown     }
37300910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3731715f1b00SHong Zhang     if (ts->forward_solve) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
3732bbd56ea5SKarl Rupp   } else if (u) {
37330910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
37345a3a76d0SJed Brown   }
3735b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
373668bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3737a6772fa2SLisandro Dalcin 
3738ef85077eSLisandro Dalcin   if (ts->max_time >= PETSC_MAX_REAL && ts->max_steps == PETSC_MAX_INT) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
3739a6772fa2SLisandro 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()");
3740a6772fa2SLisandro 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");
3741a6772fa2SLisandro Dalcin 
3742715f1b00SHong Zhang   if (ts->forward_solve) {
3743715f1b00SHong Zhang     ierr = TSForwardSetUp(ts);CHKERRQ(ierr);
3744715f1b00SHong Zhang   }
3745715f1b00SHong Zhang 
3746e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
3747715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
3748e7069c78SShri      TSTrajectory to incorrectly save the output files
3749e7069c78SShri   */
3750715f1b00SHong Zhang   /* reset time step and iteration counters */
37512808aa04SLisandro Dalcin   if (!ts->steps) {
37525ef26d82SJed Brown     ts->ksp_its           = 0;
37535ef26d82SJed Brown     ts->snes_its          = 0;
3754c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
3755c610991cSLisandro Dalcin     ts->reject            = 0;
37562808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
37572808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
37582808aa04SLisandro Dalcin   }
375910bc0e4dSStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP && ts->ptime + ts->time_step > ts->max_time) ts->time_step = ts->max_time - ts->ptime;
3760193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
3761193ac0bcSJed Brown 
3762ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3763f05ece33SBarry Smith 
3764193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
3765193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
3766a6772fa2SLisandro Dalcin     if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3767cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3768a6772fa2SLisandro Dalcin     solution = ts->vec_sol;
3769be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
3770db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
3771db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3772e7069c78SShri 
37732808aa04SLisandro Dalcin     if (!ts->steps) {
37742808aa04SLisandro Dalcin       ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
37756427ac75SLisandro Dalcin       ierr = TSEventInitialize(ts->event,ts,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
37762808aa04SLisandro Dalcin     }
37776427ac75SLisandro Dalcin 
3778e1a7a14fSJed Brown     while (!ts->reason) {
37792808aa04SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
37809687d888SLisandro Dalcin       if (!ts->steprollback) {
37819687d888SLisandro Dalcin         ierr = TSPreStep(ts);CHKERRQ(ierr);
37829687d888SLisandro Dalcin       }
3783193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3784f3b1f45cSBarry Smith       if (ts->testjacobian) {
3785f3b1f45cSBarry Smith         ierr = TSRHSJacobianTest(ts,NULL);CHKERRQ(ierr);
3786f3b1f45cSBarry Smith       }
3787f3b1f45cSBarry Smith       if (ts->testjacobiantranspose) {
3788f3b1f45cSBarry Smith         ierr = TSRHSJacobianTestTranspose(ts,NULL);CHKERRQ(ierr);
3789f3b1f45cSBarry Smith       }
3790e783b05fSHong 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. */
3791b1cb36f3SHong Zhang         ierr = TSForwardCostIntegral(ts);CHKERRQ(ierr);
3792b1cb36f3SHong Zhang       }
379358818c2dSLisandro Dalcin       if (ts->forward_solve) { /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
3794715f1b00SHong Zhang         ierr = TSForwardStep(ts);CHKERRQ(ierr);
3795715f1b00SHong Zhang       }
379610b82f12SShri Abhyankar       ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
3797e783b05fSHong 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. */
379858818c2dSLisandro Dalcin       if (ts->steprollback) {
379958818c2dSLisandro Dalcin         ierr = TSPostEvaluate(ts);CHKERRQ(ierr);
380058818c2dSLisandro Dalcin       }
3801e783b05fSHong Zhang       if (!ts->steprollback) {
38022808aa04SLisandro Dalcin         ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
38031eda64f1SShri Abhyankar         ierr = TSPostStep(ts);CHKERRQ(ierr);
3804aeb4809dSShri Abhyankar       }
3805193ac0bcSJed Brown     }
38062808aa04SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
38076427ac75SLisandro Dalcin 
380849354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
38090910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3810cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3811b06615a5SLisandro Dalcin       solution = u;
381263e21af5SBarry Smith       ierr = TSMonitor(ts,-1,ts->solvetime,solution);CHKERRQ(ierr);
38130574a7fbSJed Brown     } else {
3814ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3815cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3816b06615a5SLisandro Dalcin       solution = ts->vec_sol;
38170574a7fbSJed Brown     }
3818193ac0bcSJed Brown   }
3819d2daff3dSHong Zhang 
3820ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
382163e21af5SBarry Smith   ierr = VecViewFromOptions(solution,NULL,"-ts_view_solution");CHKERRQ(ierr);
382256f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3823ef222394SBarry Smith   if (ts->adjoint_solve) {
3824ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
38252b0a91c0SBarry Smith   }
38266a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
38276a4d4014SLisandro Dalcin }
38286a4d4014SLisandro Dalcin 
38297db568b7SBarry Smith /*@C
3830228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3831228d79bcSJed Brown 
3832228d79bcSJed Brown    Collective on TS
3833228d79bcSJed Brown 
3834228d79bcSJed Brown    Input Parameters:
3835228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3836228d79bcSJed Brown .  step - step number that has just completed
3837228d79bcSJed Brown .  ptime - model time of the state
38380910c330SBarry Smith -  u - state at the current model time
3839228d79bcSJed Brown 
3840228d79bcSJed Brown    Notes:
38417db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
38427db568b7SBarry Smith    Users would almost never call this routine directly.
3843228d79bcSJed Brown 
384463e21af5SBarry Smith    A step of -1 indicates that the monitor is being called on a solution obtained by interpolating from computed solutions
384563e21af5SBarry Smith 
38467db568b7SBarry Smith    Level: developer
3847228d79bcSJed Brown 
3848228d79bcSJed Brown .keywords: TS, timestep
3849228d79bcSJed Brown @*/
38500910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3851d763cef2SBarry Smith {
3852d6152f81SLisandro Dalcin   DM             dm;
3853a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3854d6152f81SLisandro Dalcin   PetscErrorCode ierr;
3855d763cef2SBarry Smith 
3856d763cef2SBarry Smith   PetscFunctionBegin;
3857b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3858b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
3859d6152f81SLisandro Dalcin 
3860d6152f81SLisandro Dalcin   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
3861d6152f81SLisandro Dalcin   ierr = DMSetOutputSequenceNumber(dm,step,ptime);CHKERRQ(ierr);
3862d6152f81SLisandro Dalcin 
38635edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3864d763cef2SBarry Smith   for (i=0; i<n; i++) {
38650910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3866d763cef2SBarry Smith   }
38675edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3868d763cef2SBarry Smith   PetscFunctionReturn(0);
3869d763cef2SBarry Smith }
3870d763cef2SBarry Smith 
3871d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
3872d763cef2SBarry Smith /*@C
38737db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
3874a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3875d763cef2SBarry Smith 
3876d763cef2SBarry Smith    Collective on TS
3877d763cef2SBarry Smith 
3878d763cef2SBarry Smith    Input Parameters:
3879d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3880d763cef2SBarry Smith .  label - the title to put in the title bar
38817c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3882a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3883a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3884d763cef2SBarry Smith 
3885d763cef2SBarry Smith    Output Parameter:
38860b039ecaSBarry Smith .  ctx - the context
3887d763cef2SBarry Smith 
3888d763cef2SBarry Smith    Options Database Key:
38894f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
38908b668821SLisandro Dalcin +  -ts_monitor_lg_timestep_log - automatically sets line graph monitor
38917db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
38927db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
38937db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
38947db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
3895b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3896d763cef2SBarry Smith 
3897d763cef2SBarry Smith    Notes:
3898a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3899d763cef2SBarry Smith 
39007db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
39017db568b7SBarry Smith 
39027db568b7SBarry 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
39037db568b7SBarry 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
39047db568b7SBarry Smith    as the first argument.
39057db568b7SBarry Smith 
39067db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
39077db568b7SBarry Smith 
3908d763cef2SBarry Smith    Level: intermediate
3909d763cef2SBarry Smith 
39107db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
3911d763cef2SBarry Smith 
39127db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
39137db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
39147db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
39157db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
39167db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
39177c922b88SBarry Smith 
3918d763cef2SBarry Smith @*/
3919a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3920d763cef2SBarry Smith {
39217f52daa2SLisandro Dalcin   PetscDraw      draw;
3922dfbe8321SBarry Smith   PetscErrorCode ierr;
3923d763cef2SBarry Smith 
3924d763cef2SBarry Smith   PetscFunctionBegin;
3925b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
39267f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
39277f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
39287f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
3929287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
39307f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3931a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3932d763cef2SBarry Smith   PetscFunctionReturn(0);
3933d763cef2SBarry Smith }
3934d763cef2SBarry Smith 
3935b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3936d763cef2SBarry Smith {
39370b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3938c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3939dfbe8321SBarry Smith   PetscErrorCode ierr;
3940d763cef2SBarry Smith 
3941d763cef2SBarry Smith   PetscFunctionBegin;
394263e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates an interpolated solution */
3943b06615a5SLisandro Dalcin   if (!step) {
3944a9f9c1f6SBarry Smith     PetscDrawAxis axis;
39458b668821SLisandro Dalcin     const char *ylabel = ctx->semilogy ? "Log Time Step" : "Time Step";
3946a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
39478b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time",ylabel);CHKERRQ(ierr);
3948a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3949a9f9c1f6SBarry Smith   }
3950c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
39518b668821SLisandro Dalcin   if (ctx->semilogy) y = PetscLog10Real(y);
39520b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3953b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
39540b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
39556934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
39563923b477SBarry Smith   }
3957d763cef2SBarry Smith   PetscFunctionReturn(0);
3958d763cef2SBarry Smith }
3959d763cef2SBarry Smith 
3960d763cef2SBarry Smith /*@C
3961a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3962a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3963d763cef2SBarry Smith 
39640b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3965d763cef2SBarry Smith 
3966d763cef2SBarry Smith    Input Parameter:
39670b039ecaSBarry Smith .  ctx - the monitor context
3968d763cef2SBarry Smith 
3969d763cef2SBarry Smith    Level: intermediate
3970d763cef2SBarry Smith 
3971d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3972d763cef2SBarry Smith 
39734f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3974d763cef2SBarry Smith @*/
3975a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3976d763cef2SBarry Smith {
3977dfbe8321SBarry Smith   PetscErrorCode ierr;
3978d763cef2SBarry Smith 
3979d763cef2SBarry Smith   PetscFunctionBegin;
39807684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
39817684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
39827684fa3eSBarry Smith   }
39830b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
398431152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3985387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3986387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3987387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
39880b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3989d763cef2SBarry Smith   PetscFunctionReturn(0);
3990d763cef2SBarry Smith }
3991d763cef2SBarry Smith 
39921b575b74SJoseph Pusztay /*
39931b575b74SJoseph Pusztay 
39941b575b74SJoseph Pusztay   Creates a TS Monitor SPCtx for use with DM Swarm particle visualizations
39951b575b74SJoseph Pusztay 
39961b575b74SJoseph Pusztay */
39971b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorSPCtx *ctx)
39981b575b74SJoseph Pusztay {
39991b575b74SJoseph Pusztay   PetscDraw      draw;
40001b575b74SJoseph Pusztay   PetscErrorCode ierr;
40011b575b74SJoseph Pusztay 
40021b575b74SJoseph Pusztay   PetscFunctionBegin;
40031b575b74SJoseph Pusztay   ierr = PetscNew(ctx);CHKERRQ(ierr);
40041b575b74SJoseph Pusztay   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
40051b575b74SJoseph Pusztay   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
40061b575b74SJoseph Pusztay   ierr = PetscDrawSPCreate(draw,1,&(*ctx)->sp);CHKERRQ(ierr);
40071b575b74SJoseph Pusztay   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
40081b575b74SJoseph Pusztay   (*ctx)->howoften = howoften;
40091b575b74SJoseph Pusztay   PetscFunctionReturn(0);
40101b575b74SJoseph Pusztay 
40111b575b74SJoseph Pusztay }
40121b575b74SJoseph Pusztay 
40131b575b74SJoseph Pusztay /*
40141b575b74SJoseph Pusztay   Destroys a TSMonitorSPCtx that was created with TSMonitorSPCtxCreate
40151b575b74SJoseph Pusztay */
40161b575b74SJoseph Pusztay PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *ctx)
40171b575b74SJoseph Pusztay {
40181b575b74SJoseph Pusztay   PetscErrorCode ierr;
40191b575b74SJoseph Pusztay 
40201b575b74SJoseph Pusztay   PetscFunctionBegin;
40211b575b74SJoseph Pusztay 
40221b575b74SJoseph Pusztay   ierr = PetscDrawSPDestroy(&(*ctx)->sp);CHKERRQ(ierr);
40231b575b74SJoseph Pusztay   ierr = PetscFree(*ctx);CHKERRQ(ierr);
40241b575b74SJoseph Pusztay 
40251b575b74SJoseph Pusztay   PetscFunctionReturn(0);
40261b575b74SJoseph Pusztay 
40271b575b74SJoseph Pusztay }
40281b575b74SJoseph Pusztay 
4029d763cef2SBarry Smith /*@
4030b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
4031d763cef2SBarry Smith 
4032d763cef2SBarry Smith    Not Collective
4033d763cef2SBarry Smith 
4034d763cef2SBarry Smith    Input Parameter:
4035d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
4036d763cef2SBarry Smith 
4037d763cef2SBarry Smith    Output Parameter:
403819eac22cSLisandro Dalcin .  t  - the current time. This time may not corresponds to the final time set with TSSetMaxTime(), use TSGetSolveTime().
4039d763cef2SBarry Smith 
4040d763cef2SBarry Smith    Level: beginner
4041d763cef2SBarry Smith 
4042b8123daeSJed Brown    Note:
4043b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
40449be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
4045b8123daeSJed Brown 
4046aaa6c58dSLisandro Dalcin .seealso:  TSGetSolveTime(), TSSetTime(), TSGetTimeStep()
4047d763cef2SBarry Smith 
4048d763cef2SBarry Smith .keywords: TS, get, time
4049d763cef2SBarry Smith @*/
40507087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
4051d763cef2SBarry Smith {
4052d763cef2SBarry Smith   PetscFunctionBegin;
40530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4054f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
4055d763cef2SBarry Smith   *t = ts->ptime;
4056d763cef2SBarry Smith   PetscFunctionReturn(0);
4057d763cef2SBarry Smith }
4058d763cef2SBarry Smith 
4059e5e524a1SHong Zhang /*@
4060e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
4061e5e524a1SHong Zhang 
4062e5e524a1SHong Zhang    Not Collective
4063e5e524a1SHong Zhang 
4064e5e524a1SHong Zhang    Input Parameter:
4065e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
4066e5e524a1SHong Zhang 
4067e5e524a1SHong Zhang    Output Parameter:
4068e5e524a1SHong Zhang .  t  - the previous time
4069e5e524a1SHong Zhang 
4070e5e524a1SHong Zhang    Level: beginner
4071e5e524a1SHong Zhang 
4072aaa6c58dSLisandro Dalcin .seealso: TSGetTime(), TSGetSolveTime(), TSGetTimeStep()
4073e5e524a1SHong Zhang 
4074e5e524a1SHong Zhang .keywords: TS, get, time
4075e5e524a1SHong Zhang @*/
4076e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
4077e5e524a1SHong Zhang {
4078e5e524a1SHong Zhang   PetscFunctionBegin;
4079e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4080e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
4081e5e524a1SHong Zhang   *t = ts->ptime_prev;
4082e5e524a1SHong Zhang   PetscFunctionReturn(0);
4083e5e524a1SHong Zhang }
4084e5e524a1SHong Zhang 
40856a4d4014SLisandro Dalcin /*@
40866a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
40876a4d4014SLisandro Dalcin 
40883f9fe445SBarry Smith    Logically Collective on TS
40896a4d4014SLisandro Dalcin 
40906a4d4014SLisandro Dalcin    Input Parameters:
40916a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
40926a4d4014SLisandro Dalcin -  time - the time
40936a4d4014SLisandro Dalcin 
40946a4d4014SLisandro Dalcin    Level: intermediate
40956a4d4014SLisandro Dalcin 
409619eac22cSLisandro Dalcin .seealso: TSGetTime(), TSSetMaxSteps()
40976a4d4014SLisandro Dalcin 
40986a4d4014SLisandro Dalcin .keywords: TS, set, time
40996a4d4014SLisandro Dalcin @*/
41007087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
41016a4d4014SLisandro Dalcin {
41026a4d4014SLisandro Dalcin   PetscFunctionBegin;
41030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4104c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
41056a4d4014SLisandro Dalcin   ts->ptime = t;
41066a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
41076a4d4014SLisandro Dalcin }
41086a4d4014SLisandro Dalcin 
4109d763cef2SBarry Smith /*@C
4110d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
4111d763cef2SBarry Smith    TS options in the database.
4112d763cef2SBarry Smith 
41133f9fe445SBarry Smith    Logically Collective on TS
4114d763cef2SBarry Smith 
4115d763cef2SBarry Smith    Input Parameter:
4116d763cef2SBarry Smith +  ts     - The TS context
4117d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4118d763cef2SBarry Smith 
4119d763cef2SBarry Smith    Notes:
4120d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4121d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4122d763cef2SBarry Smith    hyphen.
4123d763cef2SBarry Smith 
4124d763cef2SBarry Smith    Level: advanced
4125d763cef2SBarry Smith 
4126d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
4127d763cef2SBarry Smith 
4128d763cef2SBarry Smith .seealso: TSSetFromOptions()
4129d763cef2SBarry Smith 
4130d763cef2SBarry Smith @*/
41317087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
4132d763cef2SBarry Smith {
4133dfbe8321SBarry Smith   PetscErrorCode ierr;
4134089b2837SJed Brown   SNES           snes;
4135d763cef2SBarry Smith 
4136d763cef2SBarry Smith   PetscFunctionBegin;
41370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4138d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4139089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4140089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4141d763cef2SBarry Smith   PetscFunctionReturn(0);
4142d763cef2SBarry Smith }
4143d763cef2SBarry Smith 
4144d763cef2SBarry Smith /*@C
4145d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4146d763cef2SBarry Smith    TS options in the database.
4147d763cef2SBarry Smith 
41483f9fe445SBarry Smith    Logically Collective on TS
4149d763cef2SBarry Smith 
4150d763cef2SBarry Smith    Input Parameter:
4151d763cef2SBarry Smith +  ts     - The TS context
4152d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
4153d763cef2SBarry Smith 
4154d763cef2SBarry Smith    Notes:
4155d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
4156d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
4157d763cef2SBarry Smith    hyphen.
4158d763cef2SBarry Smith 
4159d763cef2SBarry Smith    Level: advanced
4160d763cef2SBarry Smith 
4161d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
4162d763cef2SBarry Smith 
4163d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
4164d763cef2SBarry Smith 
4165d763cef2SBarry Smith @*/
41667087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
4167d763cef2SBarry Smith {
4168dfbe8321SBarry Smith   PetscErrorCode ierr;
4169089b2837SJed Brown   SNES           snes;
4170d763cef2SBarry Smith 
4171d763cef2SBarry Smith   PetscFunctionBegin;
41720700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4173d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4174089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4175089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
4176d763cef2SBarry Smith   PetscFunctionReturn(0);
4177d763cef2SBarry Smith }
4178d763cef2SBarry Smith 
4179d763cef2SBarry Smith /*@C
4180d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
4181d763cef2SBarry Smith    TS options in the database.
4182d763cef2SBarry Smith 
4183d763cef2SBarry Smith    Not Collective
4184d763cef2SBarry Smith 
4185d763cef2SBarry Smith    Input Parameter:
4186d763cef2SBarry Smith .  ts - The TS context
4187d763cef2SBarry Smith 
4188d763cef2SBarry Smith    Output Parameter:
4189d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
4190d763cef2SBarry Smith 
419195452b02SPatrick Sanan    Notes:
419295452b02SPatrick Sanan     On the fortran side, the user should pass in a string 'prifix' of
4193d763cef2SBarry Smith    sufficient length to hold the prefix.
4194d763cef2SBarry Smith 
4195d763cef2SBarry Smith    Level: intermediate
4196d763cef2SBarry Smith 
4197d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
4198d763cef2SBarry Smith 
4199d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
4200d763cef2SBarry Smith @*/
42017087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
4202d763cef2SBarry Smith {
4203dfbe8321SBarry Smith   PetscErrorCode ierr;
4204d763cef2SBarry Smith 
4205d763cef2SBarry Smith   PetscFunctionBegin;
42060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
42074482741eSBarry Smith   PetscValidPointer(prefix,2);
4208d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
4209d763cef2SBarry Smith   PetscFunctionReturn(0);
4210d763cef2SBarry Smith }
4211d763cef2SBarry Smith 
4212d763cef2SBarry Smith /*@C
4213d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4214d763cef2SBarry Smith 
4215d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
4216d763cef2SBarry Smith 
4217d763cef2SBarry Smith    Input Parameter:
4218d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
4219d763cef2SBarry Smith 
4220d763cef2SBarry Smith    Output Parameters:
4221e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
4222e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
4223e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
4224e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
4225d763cef2SBarry Smith 
422695452b02SPatrick Sanan    Notes:
422795452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
4228d763cef2SBarry Smith 
4229d763cef2SBarry Smith    Level: intermediate
4230d763cef2SBarry Smith 
423180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
4232d763cef2SBarry Smith 
4233d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
4234d763cef2SBarry Smith @*/
4235e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
4236d763cef2SBarry Smith {
4237089b2837SJed Brown   PetscErrorCode ierr;
423824989b8cSPeter Brune   DM             dm;
4239089b2837SJed Brown 
4240d763cef2SBarry Smith   PetscFunctionBegin;
424123a57915SBarry Smith   if (Amat || Pmat) {
424223a57915SBarry Smith     SNES snes;
4243089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
424423a57915SBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4245e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
424623a57915SBarry Smith   }
424724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
424824989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
4249d763cef2SBarry Smith   PetscFunctionReturn(0);
4250d763cef2SBarry Smith }
4251d763cef2SBarry Smith 
42522eca1d9cSJed Brown /*@C
42532eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
42542eca1d9cSJed Brown 
42552eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
42562eca1d9cSJed Brown 
42572eca1d9cSJed Brown    Input Parameter:
42582eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
42592eca1d9cSJed Brown 
42602eca1d9cSJed Brown    Output Parameters:
4261e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
4262e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
42632eca1d9cSJed Brown .  f   - The function to compute the matrices
42642eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
42652eca1d9cSJed Brown 
426695452b02SPatrick Sanan    Notes:
426795452b02SPatrick Sanan     You can pass in NULL for any return argument you do not need.
42682eca1d9cSJed Brown 
42692eca1d9cSJed Brown    Level: advanced
42702eca1d9cSJed Brown 
427180275a0aSLisandro Dalcin .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetStepNumber()
42722eca1d9cSJed Brown 
42732eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
42742eca1d9cSJed Brown @*/
4275e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
42762eca1d9cSJed Brown {
4277089b2837SJed Brown   PetscErrorCode ierr;
427824989b8cSPeter Brune   DM             dm;
42790910c330SBarry Smith 
42802eca1d9cSJed Brown   PetscFunctionBegin;
4281c0aab802Sstefano_zampini   if (Amat || Pmat) {
4282c0aab802Sstefano_zampini     SNES snes;
4283089b2837SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4284f7d39f7aSBarry Smith     ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
4285e4357dc4SBarry Smith     ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
4286c0aab802Sstefano_zampini   }
428724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
428824989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
42892eca1d9cSJed Brown   PetscFunctionReturn(0);
42902eca1d9cSJed Brown }
42912eca1d9cSJed Brown 
42921713a123SBarry Smith /*@C
429383a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
42941713a123SBarry Smith    VecView() for the solution at each timestep
42951713a123SBarry Smith 
42961713a123SBarry Smith    Collective on TS
42971713a123SBarry Smith 
42981713a123SBarry Smith    Input Parameters:
42991713a123SBarry Smith +  ts - the TS context
43001713a123SBarry Smith .  step - current time-step
4301142b95e3SSatish Balay .  ptime - current time
43020298fd71SBarry Smith -  dummy - either a viewer or NULL
43031713a123SBarry Smith 
430499fdda47SBarry Smith    Options Database:
430599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
430699fdda47SBarry Smith 
430795452b02SPatrick Sanan    Notes:
430895452b02SPatrick Sanan     the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
430999fdda47SBarry Smith        will look bad
431099fdda47SBarry Smith 
43111713a123SBarry Smith    Level: intermediate
43121713a123SBarry Smith 
43131713a123SBarry Smith .keywords: TS,  vector, monitor, view
43141713a123SBarry Smith 
4315a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
43161713a123SBarry Smith @*/
43170910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
43181713a123SBarry Smith {
4319dfbe8321SBarry Smith   PetscErrorCode   ierr;
432083a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4321473a3ab2SBarry Smith   PetscDraw        draw;
43221713a123SBarry Smith 
43231713a123SBarry Smith   PetscFunctionBegin;
43246083293cSBarry Smith   if (!step && ictx->showinitial) {
43256083293cSBarry Smith     if (!ictx->initialsolution) {
43260910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
43271713a123SBarry Smith     }
43280910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
43296083293cSBarry Smith   }
4330b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
43310dcf80beSBarry Smith 
43326083293cSBarry Smith   if (ictx->showinitial) {
43336083293cSBarry Smith     PetscReal pause;
43346083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
43356083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
43366083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
43376083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
43386083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
43396083293cSBarry Smith   }
43400910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4341473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
434251fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4343473a3ab2SBarry Smith     char      time[32];
4344473a3ab2SBarry Smith 
4345473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
434685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4347473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4348473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
434951fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4350473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4351473a3ab2SBarry Smith   }
4352473a3ab2SBarry Smith 
43536083293cSBarry Smith   if (ictx->showinitial) {
43546083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
43556083293cSBarry Smith   }
43561713a123SBarry Smith   PetscFunctionReturn(0);
43571713a123SBarry Smith }
43581713a123SBarry Smith 
43599110b2e7SHong Zhang /*@C
43602d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
43612d5ee99bSBarry Smith 
43622d5ee99bSBarry Smith    Collective on TS
43632d5ee99bSBarry Smith 
43642d5ee99bSBarry Smith    Input Parameters:
43652d5ee99bSBarry Smith +  ts - the TS context
43662d5ee99bSBarry Smith .  step - current time-step
43672d5ee99bSBarry Smith .  ptime - current time
43682d5ee99bSBarry Smith -  dummy - either a viewer or NULL
43692d5ee99bSBarry Smith 
43702d5ee99bSBarry Smith    Level: intermediate
43712d5ee99bSBarry Smith 
43722d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
43732d5ee99bSBarry Smith 
43742d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
43752d5ee99bSBarry Smith @*/
43762d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
43772d5ee99bSBarry Smith {
43782d5ee99bSBarry Smith   PetscErrorCode    ierr;
43792d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
43802d5ee99bSBarry Smith   PetscDraw         draw;
43816934998bSLisandro Dalcin   PetscDrawAxis     axis;
43822d5ee99bSBarry Smith   PetscInt          n;
43832d5ee99bSBarry Smith   PetscMPIInt       size;
43846934998bSLisandro Dalcin   PetscReal         U0,U1,xl,yl,xr,yr,h;
43852d5ee99bSBarry Smith   char              time[32];
43862d5ee99bSBarry Smith   const PetscScalar *U;
43872d5ee99bSBarry Smith 
43882d5ee99bSBarry Smith   PetscFunctionBegin;
43896934998bSLisandro Dalcin   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)ts),&size);CHKERRQ(ierr);
43906934998bSLisandro Dalcin   if (size != 1) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only allowed for sequential runs");
43912d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
43926934998bSLisandro Dalcin   if (n != 2) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Only for ODEs with two unknowns");
43932d5ee99bSBarry Smith 
43942d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
43956934998bSLisandro Dalcin   ierr = PetscViewerDrawGetDrawAxis(ictx->viewer,0,&axis);CHKERRQ(ierr);
43966934998bSLisandro Dalcin   ierr = PetscDrawAxisGetLimits(axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
43976934998bSLisandro Dalcin   if (!step) {
43986934998bSLisandro Dalcin     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
43996934998bSLisandro Dalcin     ierr = PetscDrawAxisDraw(axis);CHKERRQ(ierr);
44006934998bSLisandro Dalcin   }
44012d5ee99bSBarry Smith 
44022d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
44036934998bSLisandro Dalcin   U0 = PetscRealPart(U[0]);
44046934998bSLisandro Dalcin   U1 = PetscRealPart(U[1]);
4405a4494fc1SBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
44066934998bSLisandro Dalcin   if ((U0 < xl) || (U1 < yl) || (U0 > xr) || (U1 > yr)) PetscFunctionReturn(0);
44072d5ee99bSBarry Smith 
44086934998bSLisandro Dalcin   ierr = PetscDrawCollectiveBegin(draw);CHKERRQ(ierr);
44096934998bSLisandro Dalcin   ierr = PetscDrawPoint(draw,U0,U1,PETSC_DRAW_BLACK);CHKERRQ(ierr);
44102d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
44114b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
441285b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
44132d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
441451fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
44152d5ee99bSBarry Smith   }
44166934998bSLisandro Dalcin   ierr = PetscDrawCollectiveEnd(draw);CHKERRQ(ierr);
44172d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
441856d62c8fSLisandro Dalcin   ierr = PetscDrawPause(draw);CHKERRQ(ierr);
44196934998bSLisandro Dalcin   ierr = PetscDrawSave(draw);CHKERRQ(ierr);
44202d5ee99bSBarry Smith   PetscFunctionReturn(0);
44212d5ee99bSBarry Smith }
44222d5ee99bSBarry Smith 
44236083293cSBarry Smith /*@C
442483a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
44256083293cSBarry Smith 
44266083293cSBarry Smith    Collective on TS
44276083293cSBarry Smith 
44286083293cSBarry Smith    Input Parameters:
44296083293cSBarry Smith .    ctx - the monitor context
44306083293cSBarry Smith 
44316083293cSBarry Smith    Level: intermediate
44326083293cSBarry Smith 
44336083293cSBarry Smith .keywords: TS,  vector, monitor, view
44346083293cSBarry Smith 
443583a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
44366083293cSBarry Smith @*/
443783a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
44386083293cSBarry Smith {
44396083293cSBarry Smith   PetscErrorCode ierr;
44406083293cSBarry Smith 
44416083293cSBarry Smith   PetscFunctionBegin;
444283a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
444383a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
444483a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
44456083293cSBarry Smith   PetscFunctionReturn(0);
44466083293cSBarry Smith }
44476083293cSBarry Smith 
44486083293cSBarry Smith /*@C
444983a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
44506083293cSBarry Smith 
44516083293cSBarry Smith    Collective on TS
44526083293cSBarry Smith 
44536083293cSBarry Smith    Input Parameter:
44546083293cSBarry Smith .    ts - time-step context
44556083293cSBarry Smith 
44566083293cSBarry Smith    Output Patameter:
44576083293cSBarry Smith .    ctx - the monitor context
44586083293cSBarry Smith 
445999fdda47SBarry Smith    Options Database:
446099fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
446199fdda47SBarry Smith 
44626083293cSBarry Smith    Level: intermediate
44636083293cSBarry Smith 
44646083293cSBarry Smith .keywords: TS,  vector, monitor, view
44656083293cSBarry Smith 
446683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
44676083293cSBarry Smith @*/
446883a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
44696083293cSBarry Smith {
44706083293cSBarry Smith   PetscErrorCode   ierr;
44716083293cSBarry Smith 
44726083293cSBarry Smith   PetscFunctionBegin;
4473b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
447483a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4475e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4476bbd56ea5SKarl Rupp 
447783a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4478473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
4479c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4480473a3ab2SBarry Smith 
4481473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
4482c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
44836083293cSBarry Smith   PetscFunctionReturn(0);
44846083293cSBarry Smith }
44856083293cSBarry Smith 
44863a471f94SBarry Smith /*@C
44870ed3bfb6SBarry Smith    TSMonitorDrawSolutionFunction - Monitors progress of the TS solvers by calling
44880ed3bfb6SBarry Smith    VecView() for the solution provided by TSSetSolutionFunction() at each timestep
44890ed3bfb6SBarry Smith 
44900ed3bfb6SBarry Smith    Collective on TS
44910ed3bfb6SBarry Smith 
44920ed3bfb6SBarry Smith    Input Parameters:
44930ed3bfb6SBarry Smith +  ts - the TS context
44940ed3bfb6SBarry Smith .  step - current time-step
44950ed3bfb6SBarry Smith .  ptime - current time
44960ed3bfb6SBarry Smith -  dummy - either a viewer or NULL
44970ed3bfb6SBarry Smith 
44980ed3bfb6SBarry Smith    Options Database:
44990ed3bfb6SBarry Smith .  -ts_monitor_draw_solution_function - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
45000ed3bfb6SBarry Smith 
45010ed3bfb6SBarry Smith    Level: intermediate
45020ed3bfb6SBarry Smith 
45030ed3bfb6SBarry Smith .keywords: TS,  vector, monitor, view
45040ed3bfb6SBarry Smith 
45050ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
45060ed3bfb6SBarry Smith @*/
45070ed3bfb6SBarry Smith PetscErrorCode  TSMonitorDrawSolutionFunction(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
45080ed3bfb6SBarry Smith {
45090ed3bfb6SBarry Smith   PetscErrorCode   ierr;
45100ed3bfb6SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
45110ed3bfb6SBarry Smith   PetscViewer      viewer = ctx->viewer;
45120ed3bfb6SBarry Smith   Vec              work;
45130ed3bfb6SBarry Smith 
45140ed3bfb6SBarry Smith   PetscFunctionBegin;
45150ed3bfb6SBarry Smith   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
45160ed3bfb6SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
45170ed3bfb6SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
45180ed3bfb6SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
45190ed3bfb6SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
45200ed3bfb6SBarry Smith   PetscFunctionReturn(0);
45210ed3bfb6SBarry Smith }
45220ed3bfb6SBarry Smith 
45230ed3bfb6SBarry Smith /*@C
452483a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
45253a471f94SBarry Smith    VecView() for the error at each timestep
45263a471f94SBarry Smith 
45273a471f94SBarry Smith    Collective on TS
45283a471f94SBarry Smith 
45293a471f94SBarry Smith    Input Parameters:
45303a471f94SBarry Smith +  ts - the TS context
45313a471f94SBarry Smith .  step - current time-step
45323a471f94SBarry Smith .  ptime - current time
45330298fd71SBarry Smith -  dummy - either a viewer or NULL
45343a471f94SBarry Smith 
45350ed3bfb6SBarry Smith    Options Database:
45360ed3bfb6SBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires user to have provided TSSetSolutionFunction()
45370ed3bfb6SBarry Smith 
45383a471f94SBarry Smith    Level: intermediate
45393a471f94SBarry Smith 
45403a471f94SBarry Smith .keywords: TS,  vector, monitor, view
45413a471f94SBarry Smith 
45420ed3bfb6SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
45433a471f94SBarry Smith @*/
45440910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
45453a471f94SBarry Smith {
45463a471f94SBarry Smith   PetscErrorCode   ierr;
454783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
454883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
45493a471f94SBarry Smith   Vec              work;
45503a471f94SBarry Smith 
45513a471f94SBarry Smith   PetscFunctionBegin;
4552b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
45530910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
45543a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
45550910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
45563a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
45573a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
45583a471f94SBarry Smith   PetscFunctionReturn(0);
45593a471f94SBarry Smith }
45603a471f94SBarry Smith 
4561af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
45626c699258SBarry Smith /*@
45632a808120SBarry Smith    TSSetDM - Sets the DM that may be used by some nonlinear solvers or preconditioners under the TS
45646c699258SBarry Smith 
45653f9fe445SBarry Smith    Logically Collective on TS and DM
45666c699258SBarry Smith 
45676c699258SBarry Smith    Input Parameters:
45682a808120SBarry Smith +  ts - the ODE integrator object
45692a808120SBarry Smith -  dm - the dm, cannot be NULL
45706c699258SBarry Smith 
4571e03a659cSJed Brown    Notes:
4572e03a659cSJed Brown    A DM can only be used for solving one problem at a time because information about the problem is stored on the DM,
4573e03a659cSJed Brown    even when not using interfaces like DMTSSetIFunction().  Use DMClone() to get a distinct DM when solving
4574e03a659cSJed Brown    different problems using the same function space.
4575e03a659cSJed Brown 
45766c699258SBarry Smith    Level: intermediate
45776c699258SBarry Smith 
45786c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
45796c699258SBarry Smith @*/
45807087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
45816c699258SBarry Smith {
45826c699258SBarry Smith   PetscErrorCode ierr;
4583089b2837SJed Brown   SNES           snes;
4584942e3340SBarry Smith   DMTS           tsdm;
45856c699258SBarry Smith 
45866c699258SBarry Smith   PetscFunctionBegin;
45870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45882a808120SBarry Smith   PetscValidHeaderSpecific(dm,DM_CLASSID,2);
458970663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4590942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
45912a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4592942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4593942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
459424989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
459524989b8cSPeter Brune         tsdm->originaldm = dm;
459624989b8cSPeter Brune       }
459724989b8cSPeter Brune     }
45986bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
459924989b8cSPeter Brune   }
46006c699258SBarry Smith   ts->dm = dm;
4601bbd56ea5SKarl Rupp 
4602089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4603089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
46046c699258SBarry Smith   PetscFunctionReturn(0);
46056c699258SBarry Smith }
46066c699258SBarry Smith 
46076c699258SBarry Smith /*@
46086c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
46096c699258SBarry Smith 
46103f9fe445SBarry Smith    Not Collective
46116c699258SBarry Smith 
46126c699258SBarry Smith    Input Parameter:
46136c699258SBarry Smith . ts - the preconditioner context
46146c699258SBarry Smith 
46156c699258SBarry Smith    Output Parameter:
46166c699258SBarry Smith .  dm - the dm
46176c699258SBarry Smith 
46186c699258SBarry Smith    Level: intermediate
46196c699258SBarry Smith 
46206c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
46216c699258SBarry Smith @*/
46227087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
46236c699258SBarry Smith {
4624496e6a7aSJed Brown   PetscErrorCode ierr;
4625496e6a7aSJed Brown 
46266c699258SBarry Smith   PetscFunctionBegin;
46270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4628496e6a7aSJed Brown   if (!ts->dm) {
4629ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4630496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4631496e6a7aSJed Brown   }
46326c699258SBarry Smith   *dm = ts->dm;
46336c699258SBarry Smith   PetscFunctionReturn(0);
46346c699258SBarry Smith }
46351713a123SBarry Smith 
46360f5c6efeSJed Brown /*@
46370f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
46380f5c6efeSJed Brown 
46393f9fe445SBarry Smith    Logically Collective on SNES
46400f5c6efeSJed Brown 
46410f5c6efeSJed Brown    Input Parameter:
4642d42a1c89SJed Brown + snes - nonlinear solver
46430910c330SBarry Smith . U - the current state at which to evaluate the residual
4644d42a1c89SJed Brown - ctx - user context, must be a TS
46450f5c6efeSJed Brown 
46460f5c6efeSJed Brown    Output Parameter:
46470f5c6efeSJed Brown . F - the nonlinear residual
46480f5c6efeSJed Brown 
46490f5c6efeSJed Brown    Notes:
46500f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
46510f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
46520f5c6efeSJed Brown 
46530f5c6efeSJed Brown    Level: advanced
46540f5c6efeSJed Brown 
46550f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
46560f5c6efeSJed Brown @*/
46570910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
46580f5c6efeSJed Brown {
46590f5c6efeSJed Brown   TS             ts = (TS)ctx;
46600f5c6efeSJed Brown   PetscErrorCode ierr;
46610f5c6efeSJed Brown 
46620f5c6efeSJed Brown   PetscFunctionBegin;
46630f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
46640910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
46650f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
46660f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
46670910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
46680f5c6efeSJed Brown   PetscFunctionReturn(0);
46690f5c6efeSJed Brown }
46700f5c6efeSJed Brown 
46710f5c6efeSJed Brown /*@
46720f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
46730f5c6efeSJed Brown 
46740f5c6efeSJed Brown    Collective on SNES
46750f5c6efeSJed Brown 
46760f5c6efeSJed Brown    Input Parameter:
46770f5c6efeSJed Brown + snes - nonlinear solver
46780910c330SBarry Smith . U - the current state at which to evaluate the residual
46790f5c6efeSJed Brown - ctx - user context, must be a TS
46800f5c6efeSJed Brown 
46810f5c6efeSJed Brown    Output Parameter:
46820f5c6efeSJed Brown + A - the Jacobian
46830f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
46840f5c6efeSJed Brown - flag - indicates any structure change in the matrix
46850f5c6efeSJed Brown 
46860f5c6efeSJed Brown    Notes:
46870f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
46880f5c6efeSJed Brown 
46890f5c6efeSJed Brown    Level: developer
46900f5c6efeSJed Brown 
46910f5c6efeSJed Brown .seealso: SNESSetJacobian()
46920f5c6efeSJed Brown @*/
4693d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
46940f5c6efeSJed Brown {
46950f5c6efeSJed Brown   TS             ts = (TS)ctx;
46960f5c6efeSJed Brown   PetscErrorCode ierr;
46970f5c6efeSJed Brown 
46980f5c6efeSJed Brown   PetscFunctionBegin;
46990f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
47000910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
47010f5c6efeSJed Brown   PetscValidPointer(A,3);
470294ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
47030f5c6efeSJed Brown   PetscValidPointer(B,4);
470494ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
47050f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4706d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
47070f5c6efeSJed Brown   PetscFunctionReturn(0);
47080f5c6efeSJed Brown }
4709325fc9f4SBarry Smith 
47100e4ef248SJed Brown /*@C
47119ae8fd06SBarry Smith    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
47120e4ef248SJed Brown 
47130e4ef248SJed Brown    Collective on TS
47140e4ef248SJed Brown 
47150e4ef248SJed Brown    Input Arguments:
47160e4ef248SJed Brown +  ts - time stepping context
47170e4ef248SJed Brown .  t - time at which to evaluate
47180910c330SBarry Smith .  U - state at which to evaluate
47190e4ef248SJed Brown -  ctx - context
47200e4ef248SJed Brown 
47210e4ef248SJed Brown    Output Arguments:
47220e4ef248SJed Brown .  F - right hand side
47230e4ef248SJed Brown 
47240e4ef248SJed Brown    Level: intermediate
47250e4ef248SJed Brown 
47260e4ef248SJed Brown    Notes:
47270e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
47280e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
47290e4ef248SJed Brown 
47300e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
47310e4ef248SJed Brown @*/
47320910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
47330e4ef248SJed Brown {
47340e4ef248SJed Brown   PetscErrorCode ierr;
47350e4ef248SJed Brown   Mat            Arhs,Brhs;
47360e4ef248SJed Brown 
47370e4ef248SJed Brown   PetscFunctionBegin;
47380e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4739d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
47400910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
47410e4ef248SJed Brown   PetscFunctionReturn(0);
47420e4ef248SJed Brown }
47430e4ef248SJed Brown 
47440e4ef248SJed Brown /*@C
47450e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
47460e4ef248SJed Brown 
47470e4ef248SJed Brown    Collective on TS
47480e4ef248SJed Brown 
47490e4ef248SJed Brown    Input Arguments:
47500e4ef248SJed Brown +  ts - time stepping context
47510e4ef248SJed Brown .  t - time at which to evaluate
47520910c330SBarry Smith .  U - state at which to evaluate
47530e4ef248SJed Brown -  ctx - context
47540e4ef248SJed Brown 
47550e4ef248SJed Brown    Output Arguments:
47560e4ef248SJed Brown +  A - pointer to operator
47570e4ef248SJed Brown .  B - pointer to preconditioning matrix
47580e4ef248SJed Brown -  flg - matrix structure flag
47590e4ef248SJed Brown 
47600e4ef248SJed Brown    Level: intermediate
47610e4ef248SJed Brown 
47620e4ef248SJed Brown    Notes:
47630e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
47640e4ef248SJed Brown 
47650e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
47660e4ef248SJed Brown @*/
4767d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
47680e4ef248SJed Brown {
47690e4ef248SJed Brown   PetscFunctionBegin;
47700e4ef248SJed Brown   PetscFunctionReturn(0);
47710e4ef248SJed Brown }
47720e4ef248SJed Brown 
47730026cea9SSean Farley /*@C
47740026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
47750026cea9SSean Farley 
47760026cea9SSean Farley    Collective on TS
47770026cea9SSean Farley 
47780026cea9SSean Farley    Input Arguments:
47790026cea9SSean Farley +  ts - time stepping context
47800026cea9SSean Farley .  t - time at which to evaluate
47810910c330SBarry Smith .  U - state at which to evaluate
47820910c330SBarry Smith .  Udot - time derivative of state vector
47830026cea9SSean Farley -  ctx - context
47840026cea9SSean Farley 
47850026cea9SSean Farley    Output Arguments:
47860026cea9SSean Farley .  F - left hand side
47870026cea9SSean Farley 
47880026cea9SSean Farley    Level: intermediate
47890026cea9SSean Farley 
47900026cea9SSean Farley    Notes:
47910910c330SBarry 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
47920026cea9SSean Farley    user is required to write their own TSComputeIFunction.
47930026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
47940026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
47950026cea9SSean Farley 
47969ae8fd06SBarry Smith    Note that using this function is NOT equivalent to using TSComputeRHSFunctionLinear() since that solves Udot = A U
47979ae8fd06SBarry Smith 
47989ae8fd06SBarry Smith .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant(), TSComputeRHSFunctionLinear()
47990026cea9SSean Farley @*/
48000910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
48010026cea9SSean Farley {
48020026cea9SSean Farley   PetscErrorCode ierr;
48030026cea9SSean Farley   Mat            A,B;
48040026cea9SSean Farley 
48050026cea9SSean Farley   PetscFunctionBegin;
48060298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4807d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
48080910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
48090026cea9SSean Farley   PetscFunctionReturn(0);
48100026cea9SSean Farley }
48110026cea9SSean Farley 
48120026cea9SSean Farley /*@C
4813b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
48140026cea9SSean Farley 
48150026cea9SSean Farley    Collective on TS
48160026cea9SSean Farley 
48170026cea9SSean Farley    Input Arguments:
48180026cea9SSean Farley +  ts - time stepping context
48190026cea9SSean Farley .  t - time at which to evaluate
48200910c330SBarry Smith .  U - state at which to evaluate
48210910c330SBarry Smith .  Udot - time derivative of state vector
48220026cea9SSean Farley .  shift - shift to apply
48230026cea9SSean Farley -  ctx - context
48240026cea9SSean Farley 
48250026cea9SSean Farley    Output Arguments:
48260026cea9SSean Farley +  A - pointer to operator
48270026cea9SSean Farley .  B - pointer to preconditioning matrix
48280026cea9SSean Farley -  flg - matrix structure flag
48290026cea9SSean Farley 
4830b41af12eSJed Brown    Level: advanced
48310026cea9SSean Farley 
48320026cea9SSean Farley    Notes:
48330026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
48340026cea9SSean Farley 
4835b41af12eSJed Brown    It is only appropriate for problems of the form
4836b41af12eSJed Brown 
4837b41af12eSJed Brown $     M Udot = F(U,t)
4838b41af12eSJed Brown 
4839b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4840b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4841b41af12eSJed Brown   an implicit operator of the form
4842b41af12eSJed Brown 
4843b41af12eSJed Brown $    shift*M + J
4844b41af12eSJed Brown 
4845b41af12eSJed 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
4846b41af12eSJed Brown   a copy of M or reassemble it when requested.
4847b41af12eSJed Brown 
48480026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
48490026cea9SSean Farley @*/
4850d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
48510026cea9SSean Farley {
4852b41af12eSJed Brown   PetscErrorCode ierr;
4853b41af12eSJed Brown 
48540026cea9SSean Farley   PetscFunctionBegin;
485594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4856b41af12eSJed Brown   ts->ijacobian.shift = shift;
48570026cea9SSean Farley   PetscFunctionReturn(0);
48580026cea9SSean Farley }
4859b41af12eSJed Brown 
4860e817cc15SEmil Constantinescu /*@
4861e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4862e817cc15SEmil Constantinescu 
4863e817cc15SEmil Constantinescu    Not Collective
4864e817cc15SEmil Constantinescu 
4865e817cc15SEmil Constantinescu    Input Parameter:
4866e817cc15SEmil Constantinescu .  ts - the TS context
4867e817cc15SEmil Constantinescu 
4868e817cc15SEmil Constantinescu    Output Parameter:
48694e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4870e817cc15SEmil Constantinescu 
4871e817cc15SEmil Constantinescu    Level: beginner
4872e817cc15SEmil Constantinescu 
4873e817cc15SEmil Constantinescu .keywords: TS, equation type
4874e817cc15SEmil Constantinescu 
4875e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4876e817cc15SEmil Constantinescu @*/
4877e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4878e817cc15SEmil Constantinescu {
4879e817cc15SEmil Constantinescu   PetscFunctionBegin;
4880e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4881e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4882e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4883e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4884e817cc15SEmil Constantinescu }
4885e817cc15SEmil Constantinescu 
4886e817cc15SEmil Constantinescu /*@
4887e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4888e817cc15SEmil Constantinescu 
4889e817cc15SEmil Constantinescu    Not Collective
4890e817cc15SEmil Constantinescu 
4891e817cc15SEmil Constantinescu    Input Parameter:
4892e817cc15SEmil Constantinescu +  ts - the TS context
48931297b224SEmil Constantinescu -  equation_type - see TSEquationType
4894e817cc15SEmil Constantinescu 
4895e817cc15SEmil Constantinescu    Level: advanced
4896e817cc15SEmil Constantinescu 
4897e817cc15SEmil Constantinescu .keywords: TS, equation type
4898e817cc15SEmil Constantinescu 
4899e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4900e817cc15SEmil Constantinescu @*/
4901e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4902e817cc15SEmil Constantinescu {
4903e817cc15SEmil Constantinescu   PetscFunctionBegin;
4904e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4905e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4906e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4907e817cc15SEmil Constantinescu }
49080026cea9SSean Farley 
49094af1b03aSJed Brown /*@
49104af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
49114af1b03aSJed Brown 
49124af1b03aSJed Brown    Not Collective
49134af1b03aSJed Brown 
49144af1b03aSJed Brown    Input Parameter:
49154af1b03aSJed Brown .  ts - the TS context
49164af1b03aSJed Brown 
49174af1b03aSJed Brown    Output Parameter:
49184af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
49194af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
49204af1b03aSJed Brown 
4921487e0bb9SJed Brown    Level: beginner
49224af1b03aSJed Brown 
4923cd652676SJed Brown    Notes:
4924cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
49254af1b03aSJed Brown 
49264af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
49274af1b03aSJed Brown 
49284af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
49294af1b03aSJed Brown @*/
49304af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
49314af1b03aSJed Brown {
49324af1b03aSJed Brown   PetscFunctionBegin;
49334af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49344af1b03aSJed Brown   PetscValidPointer(reason,2);
49354af1b03aSJed Brown   *reason = ts->reason;
49364af1b03aSJed Brown   PetscFunctionReturn(0);
49374af1b03aSJed Brown }
49384af1b03aSJed Brown 
4939d6ad946cSShri Abhyankar /*@
4940d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4941d6ad946cSShri Abhyankar 
4942d6ad946cSShri Abhyankar    Not Collective
4943d6ad946cSShri Abhyankar 
4944d6ad946cSShri Abhyankar    Input Parameter:
4945d6ad946cSShri Abhyankar +  ts - the TS context
4946d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4947d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4948d6ad946cSShri Abhyankar 
4949f5abba47SShri Abhyankar    Level: advanced
4950d6ad946cSShri Abhyankar 
4951d6ad946cSShri Abhyankar    Notes:
4952d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4953d6ad946cSShri Abhyankar 
4954d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4955d6ad946cSShri Abhyankar 
4956d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4957d6ad946cSShri Abhyankar @*/
4958d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4959d6ad946cSShri Abhyankar {
4960d6ad946cSShri Abhyankar   PetscFunctionBegin;
4961d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4962d6ad946cSShri Abhyankar   ts->reason = reason;
4963d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4964d6ad946cSShri Abhyankar }
4965d6ad946cSShri Abhyankar 
4966cc708dedSBarry Smith /*@
4967cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4968cc708dedSBarry Smith 
4969cc708dedSBarry Smith    Not Collective
4970cc708dedSBarry Smith 
4971cc708dedSBarry Smith    Input Parameter:
4972cc708dedSBarry Smith .  ts - the TS context
4973cc708dedSBarry Smith 
4974cc708dedSBarry Smith    Output Parameter:
497519eac22cSLisandro Dalcin .  ftime - the final time. This time corresponds to the final time set with TSSetMaxTime()
4976cc708dedSBarry Smith 
4977487e0bb9SJed Brown    Level: beginner
4978cc708dedSBarry Smith 
4979cc708dedSBarry Smith    Notes:
4980cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4981cc708dedSBarry Smith 
4982cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4983cc708dedSBarry Smith 
4984cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4985cc708dedSBarry Smith @*/
4986cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4987cc708dedSBarry Smith {
4988cc708dedSBarry Smith   PetscFunctionBegin;
4989cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4990cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4991cc708dedSBarry Smith   *ftime = ts->solvetime;
4992cc708dedSBarry Smith   PetscFunctionReturn(0);
4993cc708dedSBarry Smith }
4994cc708dedSBarry Smith 
49952c18e0fdSBarry Smith /*@
49965ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
49979f67acb7SJed Brown    used by the time integrator.
49989f67acb7SJed Brown 
49999f67acb7SJed Brown    Not Collective
50009f67acb7SJed Brown 
50019f67acb7SJed Brown    Input Parameter:
50029f67acb7SJed Brown .  ts - TS context
50039f67acb7SJed Brown 
50049f67acb7SJed Brown    Output Parameter:
50059f67acb7SJed Brown .  nits - number of nonlinear iterations
50069f67acb7SJed Brown 
50079f67acb7SJed Brown    Notes:
50089f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
50099f67acb7SJed Brown 
50109f67acb7SJed Brown    Level: intermediate
50119f67acb7SJed Brown 
50129f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
50139f67acb7SJed Brown 
50145ef26d82SJed Brown .seealso:  TSGetKSPIterations()
50159f67acb7SJed Brown @*/
50165ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
50179f67acb7SJed Brown {
50189f67acb7SJed Brown   PetscFunctionBegin;
50199f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50209f67acb7SJed Brown   PetscValidIntPointer(nits,2);
50215ef26d82SJed Brown   *nits = ts->snes_its;
50229f67acb7SJed Brown   PetscFunctionReturn(0);
50239f67acb7SJed Brown }
50249f67acb7SJed Brown 
50259f67acb7SJed Brown /*@
50265ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
50279f67acb7SJed Brown    used by the time integrator.
50289f67acb7SJed Brown 
50299f67acb7SJed Brown    Not Collective
50309f67acb7SJed Brown 
50319f67acb7SJed Brown    Input Parameter:
50329f67acb7SJed Brown .  ts - TS context
50339f67acb7SJed Brown 
50349f67acb7SJed Brown    Output Parameter:
50359f67acb7SJed Brown .  lits - number of linear iterations
50369f67acb7SJed Brown 
50379f67acb7SJed Brown    Notes:
50389f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
50399f67acb7SJed Brown 
50409f67acb7SJed Brown    Level: intermediate
50419f67acb7SJed Brown 
50429f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
50439f67acb7SJed Brown 
50445ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
50459f67acb7SJed Brown @*/
50465ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
50479f67acb7SJed Brown {
50489f67acb7SJed Brown   PetscFunctionBegin;
50499f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50509f67acb7SJed Brown   PetscValidIntPointer(lits,2);
50515ef26d82SJed Brown   *lits = ts->ksp_its;
50529f67acb7SJed Brown   PetscFunctionReturn(0);
50539f67acb7SJed Brown }
50549f67acb7SJed Brown 
5055cef5090cSJed Brown /*@
5056cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
5057cef5090cSJed Brown 
5058cef5090cSJed Brown    Not Collective
5059cef5090cSJed Brown 
5060cef5090cSJed Brown    Input Parameter:
5061cef5090cSJed Brown .  ts - TS context
5062cef5090cSJed Brown 
5063cef5090cSJed Brown    Output Parameter:
5064cef5090cSJed Brown .  rejects - number of steps rejected
5065cef5090cSJed Brown 
5066cef5090cSJed Brown    Notes:
5067cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5068cef5090cSJed Brown 
5069cef5090cSJed Brown    Level: intermediate
5070cef5090cSJed Brown 
5071cef5090cSJed Brown .keywords: TS, get, number
5072cef5090cSJed Brown 
50735ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
5074cef5090cSJed Brown @*/
5075cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
5076cef5090cSJed Brown {
5077cef5090cSJed Brown   PetscFunctionBegin;
5078cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5079cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
5080cef5090cSJed Brown   *rejects = ts->reject;
5081cef5090cSJed Brown   PetscFunctionReturn(0);
5082cef5090cSJed Brown }
5083cef5090cSJed Brown 
5084cef5090cSJed Brown /*@
5085cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
5086cef5090cSJed Brown 
5087cef5090cSJed Brown    Not Collective
5088cef5090cSJed Brown 
5089cef5090cSJed Brown    Input Parameter:
5090cef5090cSJed Brown .  ts - TS context
5091cef5090cSJed Brown 
5092cef5090cSJed Brown    Output Parameter:
5093cef5090cSJed Brown .  fails - number of failed nonlinear solves
5094cef5090cSJed Brown 
5095cef5090cSJed Brown    Notes:
5096cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
5097cef5090cSJed Brown 
5098cef5090cSJed Brown    Level: intermediate
5099cef5090cSJed Brown 
5100cef5090cSJed Brown .keywords: TS, get, number
5101cef5090cSJed Brown 
51025ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
5103cef5090cSJed Brown @*/
5104cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
5105cef5090cSJed Brown {
5106cef5090cSJed Brown   PetscFunctionBegin;
5107cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5108cef5090cSJed Brown   PetscValidIntPointer(fails,2);
5109cef5090cSJed Brown   *fails = ts->num_snes_failures;
5110cef5090cSJed Brown   PetscFunctionReturn(0);
5111cef5090cSJed Brown }
5112cef5090cSJed Brown 
5113cef5090cSJed Brown /*@
5114cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
5115cef5090cSJed Brown 
5116cef5090cSJed Brown    Not Collective
5117cef5090cSJed Brown 
5118cef5090cSJed Brown    Input Parameter:
5119cef5090cSJed Brown +  ts - TS context
5120cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
5121cef5090cSJed Brown 
5122cef5090cSJed Brown    Notes:
5123cef5090cSJed Brown    The counter is reset to zero for each step
5124cef5090cSJed Brown 
5125cef5090cSJed Brown    Options Database Key:
5126cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
5127cef5090cSJed Brown 
5128cef5090cSJed Brown    Level: intermediate
5129cef5090cSJed Brown 
5130cef5090cSJed Brown .keywords: TS, set, maximum, number
5131cef5090cSJed Brown 
51325ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5133cef5090cSJed Brown @*/
5134cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
5135cef5090cSJed Brown {
5136cef5090cSJed Brown   PetscFunctionBegin;
5137cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5138cef5090cSJed Brown   ts->max_reject = rejects;
5139cef5090cSJed Brown   PetscFunctionReturn(0);
5140cef5090cSJed Brown }
5141cef5090cSJed Brown 
5142cef5090cSJed Brown /*@
5143cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
5144cef5090cSJed Brown 
5145cef5090cSJed Brown    Not Collective
5146cef5090cSJed Brown 
5147cef5090cSJed Brown    Input Parameter:
5148cef5090cSJed Brown +  ts - TS context
5149cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
5150cef5090cSJed Brown 
5151cef5090cSJed Brown    Notes:
5152cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
5153cef5090cSJed Brown 
5154cef5090cSJed Brown    Options Database Key:
5155cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
5156cef5090cSJed Brown 
5157cef5090cSJed Brown    Level: intermediate
5158cef5090cSJed Brown 
5159cef5090cSJed Brown .keywords: TS, set, maximum, number
5160cef5090cSJed Brown 
51615ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
5162cef5090cSJed Brown @*/
5163cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
5164cef5090cSJed Brown {
5165cef5090cSJed Brown   PetscFunctionBegin;
5166cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5167cef5090cSJed Brown   ts->max_snes_failures = fails;
5168cef5090cSJed Brown   PetscFunctionReturn(0);
5169cef5090cSJed Brown }
5170cef5090cSJed Brown 
5171cef5090cSJed Brown /*@
5172cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
5173cef5090cSJed Brown 
5174cef5090cSJed Brown    Not Collective
5175cef5090cSJed Brown 
5176cef5090cSJed Brown    Input Parameter:
5177cef5090cSJed Brown +  ts - TS context
5178cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
5179cef5090cSJed Brown 
5180cef5090cSJed Brown    Options Database Key:
5181cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
5182cef5090cSJed Brown 
5183cef5090cSJed Brown    Level: intermediate
5184cef5090cSJed Brown 
5185cef5090cSJed Brown .keywords: TS, set, error
5186cef5090cSJed Brown 
51875ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
5188cef5090cSJed Brown @*/
5189cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
5190cef5090cSJed Brown {
5191cef5090cSJed Brown   PetscFunctionBegin;
5192cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5193cef5090cSJed Brown   ts->errorifstepfailed = err;
5194cef5090cSJed Brown   PetscFunctionReturn(0);
5195cef5090cSJed Brown }
5196cef5090cSJed Brown 
5197fb1732b5SBarry Smith /*@C
5198fde5950dSBarry 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
5199fb1732b5SBarry Smith 
5200fb1732b5SBarry Smith    Collective on TS
5201fb1732b5SBarry Smith 
5202fb1732b5SBarry Smith    Input Parameters:
5203fb1732b5SBarry Smith +  ts - the TS context
5204fb1732b5SBarry Smith .  step - current time-step
5205fb1732b5SBarry Smith .  ptime - current time
52060910c330SBarry Smith .  u - current state
5207721cd6eeSBarry Smith -  vf - viewer and its format
5208fb1732b5SBarry Smith 
5209fb1732b5SBarry Smith    Level: intermediate
5210fb1732b5SBarry Smith 
5211fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
5212fb1732b5SBarry Smith 
5213fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5214fb1732b5SBarry Smith @*/
5215721cd6eeSBarry Smith PetscErrorCode  TSMonitorSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
5216fb1732b5SBarry Smith {
5217fb1732b5SBarry Smith   PetscErrorCode ierr;
5218fb1732b5SBarry Smith 
5219fb1732b5SBarry Smith   PetscFunctionBegin;
5220721cd6eeSBarry Smith   ierr = PetscViewerPushFormat(vf->viewer,vf->format);CHKERRQ(ierr);
5221721cd6eeSBarry Smith   ierr = VecView(u,vf->viewer);CHKERRQ(ierr);
5222721cd6eeSBarry Smith   ierr = PetscViewerPopFormat(vf->viewer);CHKERRQ(ierr);
5223ed81e22dSJed Brown   PetscFunctionReturn(0);
5224ed81e22dSJed Brown }
5225ed81e22dSJed Brown 
5226ed81e22dSJed Brown /*@C
5227ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5228ed81e22dSJed Brown 
5229ed81e22dSJed Brown    Collective on TS
5230ed81e22dSJed Brown 
5231ed81e22dSJed Brown    Input Parameters:
5232ed81e22dSJed Brown +  ts - the TS context
5233ed81e22dSJed Brown .  step - current time-step
5234ed81e22dSJed Brown .  ptime - current time
52350910c330SBarry Smith .  u - current state
5236ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5237ed81e22dSJed Brown 
5238ed81e22dSJed Brown    Level: intermediate
5239ed81e22dSJed Brown 
5240ed81e22dSJed Brown    Notes:
5241ed81e22dSJed 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.
5242ed81e22dSJed Brown    These are named according to the file name template.
5243ed81e22dSJed Brown 
5244ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5245ed81e22dSJed Brown 
5246ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5247ed81e22dSJed Brown 
5248ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5249ed81e22dSJed Brown @*/
52500910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5251ed81e22dSJed Brown {
5252ed81e22dSJed Brown   PetscErrorCode ierr;
5253ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5254ed81e22dSJed Brown   PetscViewer    viewer;
5255ed81e22dSJed Brown 
5256ed81e22dSJed Brown   PetscFunctionBegin;
525763e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
52588caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5259ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
52600910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5261ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5262ed81e22dSJed Brown   PetscFunctionReturn(0);
5263ed81e22dSJed Brown }
5264ed81e22dSJed Brown 
5265ed81e22dSJed Brown /*@C
5266ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5267ed81e22dSJed Brown 
5268ed81e22dSJed Brown    Collective on TS
5269ed81e22dSJed Brown 
5270ed81e22dSJed Brown    Input Parameters:
5271ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5272ed81e22dSJed Brown 
5273ed81e22dSJed Brown    Level: intermediate
5274ed81e22dSJed Brown 
5275ed81e22dSJed Brown    Note:
5276ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5277ed81e22dSJed Brown 
5278ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5279ed81e22dSJed Brown 
5280ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5281ed81e22dSJed Brown @*/
5282ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5283ed81e22dSJed Brown {
5284ed81e22dSJed Brown   PetscErrorCode ierr;
5285ed81e22dSJed Brown 
5286ed81e22dSJed Brown   PetscFunctionBegin;
5287ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5288fb1732b5SBarry Smith   PetscFunctionReturn(0);
5289fb1732b5SBarry Smith }
5290fb1732b5SBarry Smith 
529184df9cb4SJed Brown /*@
5292552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
529384df9cb4SJed Brown 
5294ed81e22dSJed Brown    Collective on TS if controller has not been created yet
529584df9cb4SJed Brown 
529684df9cb4SJed Brown    Input Arguments:
5297ed81e22dSJed Brown .  ts - time stepping context
529884df9cb4SJed Brown 
529984df9cb4SJed Brown    Output Arguments:
5300ed81e22dSJed Brown .  adapt - adaptive controller
530184df9cb4SJed Brown 
530284df9cb4SJed Brown    Level: intermediate
530384df9cb4SJed Brown 
5304ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
530584df9cb4SJed Brown @*/
5306552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
530784df9cb4SJed Brown {
530884df9cb4SJed Brown   PetscErrorCode ierr;
530984df9cb4SJed Brown 
531084df9cb4SJed Brown   PetscFunctionBegin;
531184df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5312bec58848SLisandro Dalcin   PetscValidPointer(adapt,2);
531384df9cb4SJed Brown   if (!ts->adapt) {
5314ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
53153bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
53161c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
531784df9cb4SJed Brown   }
5318bec58848SLisandro Dalcin   *adapt = ts->adapt;
531984df9cb4SJed Brown   PetscFunctionReturn(0);
532084df9cb4SJed Brown }
5321d6ebe24aSShri Abhyankar 
53221c3436cfSJed Brown /*@
53231c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
53241c3436cfSJed Brown 
53251c3436cfSJed Brown    Logically Collective
53261c3436cfSJed Brown 
53271c3436cfSJed Brown    Input Arguments:
53281c3436cfSJed Brown +  ts - time integration context
53291c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
53300298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
53311c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
53320298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
53331c3436cfSJed Brown 
5334a3cdaa26SBarry Smith    Options Database keys:
5335a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5336a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5337a3cdaa26SBarry Smith 
53383ff766beSShri Abhyankar    Notes:
53393ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
53403ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
53413ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
53423ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
53433ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
53443ff766beSShri Abhyankar    differential variables.
53453ff766beSShri Abhyankar 
53461c3436cfSJed Brown    Level: beginner
53471c3436cfSJed Brown 
5348c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
53491c3436cfSJed Brown @*/
53501c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
53511c3436cfSJed Brown {
53521c3436cfSJed Brown   PetscErrorCode ierr;
53531c3436cfSJed Brown 
53541c3436cfSJed Brown   PetscFunctionBegin;
5355c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
53561c3436cfSJed Brown   if (vatol) {
53571c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
53581c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
53591c3436cfSJed Brown     ts->vatol = vatol;
53601c3436cfSJed Brown   }
5361c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
53621c3436cfSJed Brown   if (vrtol) {
53631c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
53641c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
53651c3436cfSJed Brown     ts->vrtol = vrtol;
53661c3436cfSJed Brown   }
53671c3436cfSJed Brown   PetscFunctionReturn(0);
53681c3436cfSJed Brown }
53691c3436cfSJed Brown 
5370c5033834SJed Brown /*@
5371c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5372c5033834SJed Brown 
5373c5033834SJed Brown    Logically Collective
5374c5033834SJed Brown 
5375c5033834SJed Brown    Input Arguments:
5376c5033834SJed Brown .  ts - time integration context
5377c5033834SJed Brown 
5378c5033834SJed Brown    Output Arguments:
53790298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
53800298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
53810298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
53820298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5383c5033834SJed Brown 
5384c5033834SJed Brown    Level: beginner
5385c5033834SJed Brown 
5386c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5387c5033834SJed Brown @*/
5388c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5389c5033834SJed Brown {
5390c5033834SJed Brown   PetscFunctionBegin;
5391c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5392c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5393c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5394c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5395c5033834SJed Brown   PetscFunctionReturn(0);
5396c5033834SJed Brown }
5397c5033834SJed Brown 
53989c6b16b5SShri Abhyankar /*@
5399a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
54009c6b16b5SShri Abhyankar 
54019c6b16b5SShri Abhyankar    Collective on TS
54029c6b16b5SShri Abhyankar 
54039c6b16b5SShri Abhyankar    Input Arguments:
54049c6b16b5SShri Abhyankar +  ts - time stepping context
5405a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5406a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
54079c6b16b5SShri Abhyankar 
54089c6b16b5SShri Abhyankar    Output Arguments:
54097453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
54107453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
54117453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
54129c6b16b5SShri Abhyankar 
54139c6b16b5SShri Abhyankar    Level: developer
54149c6b16b5SShri Abhyankar 
5415deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
54169c6b16b5SShri Abhyankar @*/
54177453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
54189c6b16b5SShri Abhyankar {
54199c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
54209c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
54217453f775SEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
54227453f775SEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
54239c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
54247453f775SEmil Constantinescu   PetscReal         sum,suma,sumr,gsum,gsuma,gsumr,diff;
54257453f775SEmil Constantinescu   PetscReal         tol,tola,tolr;
54267453f775SEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
54279c6b16b5SShri Abhyankar 
54289c6b16b5SShri Abhyankar   PetscFunctionBegin;
54299c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5430a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5431a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5432a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5433a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5434a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5435a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
54368a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
54378a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5438a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
54399c6b16b5SShri Abhyankar 
54409c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
54419c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
54429c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
54439c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
54449c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
54457453f775SEmil Constantinescu   sum  = 0.; n_loc  = 0;
54467453f775SEmil Constantinescu   suma = 0.; na_loc = 0;
54477453f775SEmil Constantinescu   sumr = 0.; nr_loc = 0;
54489c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
54499c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
54509c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54519c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54529c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54537453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
54547453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
54557453f775SEmil Constantinescu       if(tola>0.){
54567453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
54577453f775SEmil Constantinescu         na_loc++;
54587453f775SEmil Constantinescu       }
54597453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54607453f775SEmil Constantinescu       if(tolr>0.){
54617453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
54627453f775SEmil Constantinescu         nr_loc++;
54637453f775SEmil Constantinescu       }
54647453f775SEmil Constantinescu       tol=tola+tolr;
54657453f775SEmil Constantinescu       if(tol>0.){
54667453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
54677453f775SEmil Constantinescu         n_loc++;
54687453f775SEmil Constantinescu       }
54699c6b16b5SShri Abhyankar     }
54709c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54719c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54729c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
54739c6b16b5SShri Abhyankar     const PetscScalar *atol;
54749c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54759c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54767453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
54777453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
54787453f775SEmil Constantinescu       if(tola>0.){
54797453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
54807453f775SEmil Constantinescu         na_loc++;
54817453f775SEmil Constantinescu       }
54827453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
54837453f775SEmil Constantinescu       if(tolr>0.){
54847453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
54857453f775SEmil Constantinescu         nr_loc++;
54867453f775SEmil Constantinescu       }
54877453f775SEmil Constantinescu       tol=tola+tolr;
54887453f775SEmil Constantinescu       if(tol>0.){
54897453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
54907453f775SEmil Constantinescu         n_loc++;
54917453f775SEmil Constantinescu       }
54929c6b16b5SShri Abhyankar     }
54939c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
54949c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
54959c6b16b5SShri Abhyankar     const PetscScalar *rtol;
54969c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
54979c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
54987453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
54997453f775SEmil Constantinescu       tola = ts->atol;
55007453f775SEmil Constantinescu       if(tola>0.){
55017453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
55027453f775SEmil Constantinescu         na_loc++;
55037453f775SEmil Constantinescu       }
55047453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55057453f775SEmil Constantinescu       if(tolr>0.){
55067453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
55077453f775SEmil Constantinescu         nr_loc++;
55087453f775SEmil Constantinescu       }
55097453f775SEmil Constantinescu       tol=tola+tolr;
55107453f775SEmil Constantinescu       if(tol>0.){
55117453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
55127453f775SEmil Constantinescu         n_loc++;
55137453f775SEmil Constantinescu       }
55149c6b16b5SShri Abhyankar     }
55159c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
55169c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
55179c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
55187453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
55197453f775SEmil Constantinescu      tola = ts->atol;
55207453f775SEmil Constantinescu       if(tola>0.){
55217453f775SEmil Constantinescu         suma  += PetscSqr(diff/tola);
55227453f775SEmil Constantinescu         na_loc++;
55237453f775SEmil Constantinescu       }
55247453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
55257453f775SEmil Constantinescu       if(tolr>0.){
55267453f775SEmil Constantinescu         sumr  += PetscSqr(diff/tolr);
55277453f775SEmil Constantinescu         nr_loc++;
55287453f775SEmil Constantinescu       }
55297453f775SEmil Constantinescu       tol=tola+tolr;
55307453f775SEmil Constantinescu       if(tol>0.){
55317453f775SEmil Constantinescu         sum  += PetscSqr(diff/tol);
55327453f775SEmil Constantinescu         n_loc++;
55337453f775SEmil Constantinescu       }
55349c6b16b5SShri Abhyankar     }
55359c6b16b5SShri Abhyankar   }
55369c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
55379c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
55389c6b16b5SShri Abhyankar 
55397453f775SEmil Constantinescu   err_loc[0] = sum;
55407453f775SEmil Constantinescu   err_loc[1] = suma;
55417453f775SEmil Constantinescu   err_loc[2] = sumr;
55427453f775SEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
55437453f775SEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
55447453f775SEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
55457453f775SEmil Constantinescu 
5546a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
55477453f775SEmil Constantinescu 
55487453f775SEmil Constantinescu   gsum   = err_glb[0];
55497453f775SEmil Constantinescu   gsuma  = err_glb[1];
55507453f775SEmil Constantinescu   gsumr  = err_glb[2];
55517453f775SEmil Constantinescu   n_glb  = err_glb[3];
55527453f775SEmil Constantinescu   na_glb = err_glb[4];
55537453f775SEmil Constantinescu   nr_glb = err_glb[5];
55547453f775SEmil Constantinescu 
5555b1316ef9SEmil Constantinescu   *norm  = 0.;
5556b1316ef9SEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
5557b1316ef9SEmil Constantinescu   *norma = 0.;
5558b1316ef9SEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
5559b1316ef9SEmil Constantinescu   *normr = 0.;
5560b1316ef9SEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
55619c6b16b5SShri Abhyankar 
55629c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
55637453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
55647453f775SEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
55659c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
55669c6b16b5SShri Abhyankar }
55679c6b16b5SShri Abhyankar 
55689c6b16b5SShri Abhyankar /*@
5569a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
55709c6b16b5SShri Abhyankar 
55719c6b16b5SShri Abhyankar    Collective on TS
55729c6b16b5SShri Abhyankar 
55739c6b16b5SShri Abhyankar    Input Arguments:
55749c6b16b5SShri Abhyankar +  ts - time stepping context
5575a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5576a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
55779c6b16b5SShri Abhyankar 
55789c6b16b5SShri Abhyankar    Output Arguments:
55797453f775SEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
55807453f775SEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
55817453f775SEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
55829c6b16b5SShri Abhyankar 
55839c6b16b5SShri Abhyankar    Level: developer
55849c6b16b5SShri Abhyankar 
5585deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
55869c6b16b5SShri Abhyankar @*/
55877453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
55889c6b16b5SShri Abhyankar {
55899c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
55907453f775SEmil Constantinescu   PetscInt          i,n,N,rstart;
55919c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
55927453f775SEmil Constantinescu   PetscReal         max,gmax,maxa,gmaxa,maxr,gmaxr;
55937453f775SEmil Constantinescu   PetscReal         tol,tola,tolr,diff;
55947453f775SEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
55959c6b16b5SShri Abhyankar 
55969c6b16b5SShri Abhyankar   PetscFunctionBegin;
55979c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5598a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5599a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5600a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5601a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5602a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5603a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
56048a175baeSEmil Constantinescu   PetscValidPointer(norma,5);
56058a175baeSEmil Constantinescu   PetscValidPointer(normr,6);
5606a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
56079c6b16b5SShri Abhyankar 
56089c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
56099c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
56109c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
56119c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
56129c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
56137453f775SEmil Constantinescu 
56147453f775SEmil Constantinescu   max=0.;
56157453f775SEmil Constantinescu   maxa=0.;
56167453f775SEmil Constantinescu   maxr=0.;
56177453f775SEmil Constantinescu 
56187453f775SEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
56199c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
56209c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56219c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56227453f775SEmil Constantinescu 
56237453f775SEmil Constantinescu     for (i=0; i<n; i++) {
56247453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56257453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
56267453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56277453f775SEmil Constantinescu       tol  = tola+tolr;
56287453f775SEmil Constantinescu       if(tola>0.){
56297453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
56307453f775SEmil Constantinescu       }
56317453f775SEmil Constantinescu       if(tolr>0.){
56327453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
56337453f775SEmil Constantinescu       }
56347453f775SEmil Constantinescu       if(tol>0.){
56357453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
56367453f775SEmil Constantinescu       }
56379c6b16b5SShri Abhyankar     }
56389c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56399c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56409c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
56419c6b16b5SShri Abhyankar     const PetscScalar *atol;
56429c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56437453f775SEmil Constantinescu     for (i=0; i<n; i++) {
56447453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56457453f775SEmil Constantinescu       tola = PetscRealPart(atol[i]);
56467453f775SEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56477453f775SEmil Constantinescu       tol  = tola+tolr;
56487453f775SEmil Constantinescu       if(tola>0.){
56497453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
56507453f775SEmil Constantinescu       }
56517453f775SEmil Constantinescu       if(tolr>0.){
56527453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
56537453f775SEmil Constantinescu       }
56547453f775SEmil Constantinescu       if(tol>0.){
56557453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
56567453f775SEmil Constantinescu       }
56579c6b16b5SShri Abhyankar     }
56589c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
56599c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
56609c6b16b5SShri Abhyankar     const PetscScalar *rtol;
56619c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56627453f775SEmil Constantinescu 
56637453f775SEmil Constantinescu     for (i=0; i<n; i++) {
56647453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56657453f775SEmil Constantinescu       tola = ts->atol;
56667453f775SEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56677453f775SEmil Constantinescu       tol  = tola+tolr;
56687453f775SEmil Constantinescu       if(tola>0.){
56697453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
56707453f775SEmil Constantinescu       }
56717453f775SEmil Constantinescu       if(tolr>0.){
56727453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
56737453f775SEmil Constantinescu       }
56747453f775SEmil Constantinescu       if(tol>0.){
56757453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
56767453f775SEmil Constantinescu       }
56779c6b16b5SShri Abhyankar     }
56789c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
56799c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
56807453f775SEmil Constantinescu 
56817453f775SEmil Constantinescu     for (i=0; i<n; i++) {
56827453f775SEmil Constantinescu       diff = PetscAbsScalar(y[i] - u[i]);
56837453f775SEmil Constantinescu       tola = ts->atol;
56847453f775SEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
56857453f775SEmil Constantinescu       tol  = tola+tolr;
56867453f775SEmil Constantinescu       if(tola>0.){
56877453f775SEmil Constantinescu         maxa = PetscMax(maxa,diff / tola);
56887453f775SEmil Constantinescu       }
56897453f775SEmil Constantinescu       if(tolr>0.){
56907453f775SEmil Constantinescu         maxr = PetscMax(maxr,diff / tolr);
56917453f775SEmil Constantinescu       }
56927453f775SEmil Constantinescu       if(tol>0.){
56937453f775SEmil Constantinescu         max = PetscMax(max,diff / tol);
56947453f775SEmil Constantinescu       }
56959c6b16b5SShri Abhyankar     }
56969c6b16b5SShri Abhyankar   }
56979c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
56989c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
56997453f775SEmil Constantinescu   err_loc[0] = max;
57007453f775SEmil Constantinescu   err_loc[1] = maxa;
57017453f775SEmil Constantinescu   err_loc[2] = maxr;
5702a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
57037453f775SEmil Constantinescu   gmax   = err_glb[0];
57047453f775SEmil Constantinescu   gmaxa  = err_glb[1];
57057453f775SEmil Constantinescu   gmaxr  = err_glb[2];
57069c6b16b5SShri Abhyankar 
57079c6b16b5SShri Abhyankar   *norm = gmax;
57087453f775SEmil Constantinescu   *norma = gmaxa;
57097453f775SEmil Constantinescu   *normr = gmaxr;
57109c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
57117453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
57127453f775SEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
57139c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
57149c6b16b5SShri Abhyankar }
57159c6b16b5SShri Abhyankar 
57161c3436cfSJed Brown /*@
57178a175baeSEmil Constantinescu    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
57181c3436cfSJed Brown 
57191c3436cfSJed Brown    Collective on TS
57201c3436cfSJed Brown 
57211c3436cfSJed Brown    Input Arguments:
57221c3436cfSJed Brown +  ts - time stepping context
5723a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5724a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5725a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
57267619abb3SShri 
57271c3436cfSJed Brown    Output Arguments:
57288a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
57298a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
57308a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
5731a4868fbcSLisandro Dalcin 
5732a4868fbcSLisandro Dalcin    Options Database Keys:
5733a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5734a4868fbcSLisandro Dalcin 
57351c3436cfSJed Brown    Level: developer
57361c3436cfSJed Brown 
57378a175baeSEmil Constantinescu .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2(), TSErrorWeightedENorm
57381c3436cfSJed Brown @*/
57397453f775SEmil Constantinescu PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
57401c3436cfSJed Brown {
57418beabaa1SBarry Smith   PetscErrorCode ierr;
57421c3436cfSJed Brown 
57431c3436cfSJed Brown   PetscFunctionBegin;
5744a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
57457453f775SEmil Constantinescu     ierr = TSErrorWeightedNorm2(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
5746a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
57477453f775SEmil Constantinescu     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm,norma,normr);CHKERRQ(ierr);
5748a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
57491c3436cfSJed Brown   PetscFunctionReturn(0);
57501c3436cfSJed Brown }
57511c3436cfSJed Brown 
57528a175baeSEmil Constantinescu 
57538a175baeSEmil Constantinescu /*@
57548a175baeSEmil Constantinescu    TSErrorWeightedENorm2 - compute a weighted 2 error norm based on supplied absolute and relative tolerances
57558a175baeSEmil Constantinescu 
57568a175baeSEmil Constantinescu    Collective on TS
57578a175baeSEmil Constantinescu 
57588a175baeSEmil Constantinescu    Input Arguments:
57598a175baeSEmil Constantinescu +  ts - time stepping context
57608a175baeSEmil Constantinescu .  E - error vector
57618a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
57628a175baeSEmil Constantinescu -  Y - state vector, previous time step
57638a175baeSEmil Constantinescu 
57648a175baeSEmil Constantinescu    Output Arguments:
57658a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
57668a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
57678a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
57688a175baeSEmil Constantinescu 
57698a175baeSEmil Constantinescu    Level: developer
57708a175baeSEmil Constantinescu 
57718a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENormInfinity()
57728a175baeSEmil Constantinescu @*/
57738a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm2(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
57748a175baeSEmil Constantinescu {
57758a175baeSEmil Constantinescu   PetscErrorCode    ierr;
57768a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
57778a175baeSEmil Constantinescu   PetscInt          n_loc,na_loc,nr_loc;
57788a175baeSEmil Constantinescu   PetscReal         n_glb,na_glb,nr_glb;
57798a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
57808a175baeSEmil Constantinescu   PetscReal         err,sum,suma,sumr,gsum,gsuma,gsumr;
57818a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
57828a175baeSEmil Constantinescu   PetscReal         err_loc[6],err_glb[6];
57838a175baeSEmil Constantinescu 
57848a175baeSEmil Constantinescu   PetscFunctionBegin;
57858a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57868a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
57878a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
57888a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
57898a175baeSEmil Constantinescu   PetscValidType(E,2);
57908a175baeSEmil Constantinescu   PetscValidType(U,3);
57918a175baeSEmil Constantinescu   PetscValidType(Y,4);
57928a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
57938a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
57948a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
57958a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
57968a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
57978a175baeSEmil Constantinescu 
57988a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
57998a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
58008a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
58018a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
58028a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
58038a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
58048a175baeSEmil Constantinescu   sum  = 0.; n_loc  = 0;
58058a175baeSEmil Constantinescu   suma = 0.; na_loc = 0;
58068a175baeSEmil Constantinescu   sumr = 0.; nr_loc = 0;
58078a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {
58088a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
58098a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58108a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58118a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
58128a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
58138a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
58148a175baeSEmil Constantinescu       if(tola>0.){
58158a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
58168a175baeSEmil Constantinescu         na_loc++;
58178a175baeSEmil Constantinescu       }
58188a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58198a175baeSEmil Constantinescu       if(tolr>0.){
58208a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
58218a175baeSEmil Constantinescu         nr_loc++;
58228a175baeSEmil Constantinescu       }
58238a175baeSEmil Constantinescu       tol=tola+tolr;
58248a175baeSEmil Constantinescu       if(tol>0.){
58258a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
58268a175baeSEmil Constantinescu         n_loc++;
58278a175baeSEmil Constantinescu       }
58288a175baeSEmil Constantinescu     }
58298a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58308a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58318a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
58328a175baeSEmil Constantinescu     const PetscScalar *atol;
58338a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58348a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
58358a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
58368a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
58378a175baeSEmil Constantinescu       if(tola>0.){
58388a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
58398a175baeSEmil Constantinescu         na_loc++;
58408a175baeSEmil Constantinescu       }
58418a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58428a175baeSEmil Constantinescu       if(tolr>0.){
58438a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
58448a175baeSEmil Constantinescu         nr_loc++;
58458a175baeSEmil Constantinescu       }
58468a175baeSEmil Constantinescu       tol=tola+tolr;
58478a175baeSEmil Constantinescu       if(tol>0.){
58488a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
58498a175baeSEmil Constantinescu         n_loc++;
58508a175baeSEmil Constantinescu       }
58518a175baeSEmil Constantinescu     }
58528a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
58538a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
58548a175baeSEmil Constantinescu     const PetscScalar *rtol;
58558a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58568a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
58578a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
58588a175baeSEmil Constantinescu       tola = ts->atol;
58598a175baeSEmil Constantinescu       if(tola>0.){
58608a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
58618a175baeSEmil Constantinescu         na_loc++;
58628a175baeSEmil Constantinescu       }
58638a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58648a175baeSEmil Constantinescu       if(tolr>0.){
58658a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
58668a175baeSEmil Constantinescu         nr_loc++;
58678a175baeSEmil Constantinescu       }
58688a175baeSEmil Constantinescu       tol=tola+tolr;
58698a175baeSEmil Constantinescu       if(tol>0.){
58708a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
58718a175baeSEmil Constantinescu         n_loc++;
58728a175baeSEmil Constantinescu       }
58738a175baeSEmil Constantinescu     }
58748a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
58758a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
58768a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
58778a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
58788a175baeSEmil Constantinescu      tola = ts->atol;
58798a175baeSEmil Constantinescu       if(tola>0.){
58808a175baeSEmil Constantinescu         suma  += PetscSqr(err/tola);
58818a175baeSEmil Constantinescu         na_loc++;
58828a175baeSEmil Constantinescu       }
58838a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
58848a175baeSEmil Constantinescu       if(tolr>0.){
58858a175baeSEmil Constantinescu         sumr  += PetscSqr(err/tolr);
58868a175baeSEmil Constantinescu         nr_loc++;
58878a175baeSEmil Constantinescu       }
58888a175baeSEmil Constantinescu       tol=tola+tolr;
58898a175baeSEmil Constantinescu       if(tol>0.){
58908a175baeSEmil Constantinescu         sum  += PetscSqr(err/tol);
58918a175baeSEmil Constantinescu         n_loc++;
58928a175baeSEmil Constantinescu       }
58938a175baeSEmil Constantinescu     }
58948a175baeSEmil Constantinescu   }
58958a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
58968a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
58978a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
58988a175baeSEmil Constantinescu 
58998a175baeSEmil Constantinescu   err_loc[0] = sum;
59008a175baeSEmil Constantinescu   err_loc[1] = suma;
59018a175baeSEmil Constantinescu   err_loc[2] = sumr;
59028a175baeSEmil Constantinescu   err_loc[3] = (PetscReal)n_loc;
59038a175baeSEmil Constantinescu   err_loc[4] = (PetscReal)na_loc;
59048a175baeSEmil Constantinescu   err_loc[5] = (PetscReal)nr_loc;
59058a175baeSEmil Constantinescu 
5906a88a9d1dSSatish Balay   ierr = MPIU_Allreduce(err_loc,err_glb,6,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
59078a175baeSEmil Constantinescu 
59088a175baeSEmil Constantinescu   gsum   = err_glb[0];
59098a175baeSEmil Constantinescu   gsuma  = err_glb[1];
59108a175baeSEmil Constantinescu   gsumr  = err_glb[2];
59118a175baeSEmil Constantinescu   n_glb  = err_glb[3];
59128a175baeSEmil Constantinescu   na_glb = err_glb[4];
59138a175baeSEmil Constantinescu   nr_glb = err_glb[5];
59148a175baeSEmil Constantinescu 
59158a175baeSEmil Constantinescu   *norm  = 0.;
59168a175baeSEmil Constantinescu   if(n_glb>0. ){*norm  = PetscSqrtReal(gsum  / n_glb );}
59178a175baeSEmil Constantinescu   *norma = 0.;
59188a175baeSEmil Constantinescu   if(na_glb>0.){*norma = PetscSqrtReal(gsuma / na_glb);}
59198a175baeSEmil Constantinescu   *normr = 0.;
59208a175baeSEmil Constantinescu   if(nr_glb>0.){*normr = PetscSqrtReal(gsumr / nr_glb);}
59218a175baeSEmil Constantinescu 
59228a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
59238a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
59248a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
59258a175baeSEmil Constantinescu   PetscFunctionReturn(0);
59268a175baeSEmil Constantinescu }
59278a175baeSEmil Constantinescu 
59288a175baeSEmil Constantinescu /*@
59298a175baeSEmil Constantinescu    TSErrorWeightedENormInfinity - compute a weighted infinity error norm based on supplied absolute and relative tolerances
59308a175baeSEmil Constantinescu    Collective on TS
59318a175baeSEmil Constantinescu 
59328a175baeSEmil Constantinescu    Input Arguments:
59338a175baeSEmil Constantinescu +  ts - time stepping context
59348a175baeSEmil Constantinescu .  E - error vector
59358a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
59368a175baeSEmil Constantinescu -  Y - state vector, previous time step
59378a175baeSEmil Constantinescu 
59388a175baeSEmil Constantinescu    Output Arguments:
59398a175baeSEmil Constantinescu .  norm - weighted norm, a value of 1.0 means that the error matches the tolerances
59408a175baeSEmil Constantinescu .  norma - weighted norm based on the absolute tolerance, a value of 1.0 means that the error matches the tolerances
59418a175baeSEmil Constantinescu .  normr - weighted norm based on the relative tolerance, a value of 1.0 means that the error matches the tolerances
59428a175baeSEmil Constantinescu 
59438a175baeSEmil Constantinescu    Level: developer
59448a175baeSEmil Constantinescu 
59458a175baeSEmil Constantinescu .seealso: TSErrorWeightedENorm(), TSErrorWeightedENorm2()
59468a175baeSEmil Constantinescu @*/
59478a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENormInfinity(TS ts,Vec E,Vec U,Vec Y,PetscReal *norm,PetscReal *norma,PetscReal *normr)
59488a175baeSEmil Constantinescu {
59498a175baeSEmil Constantinescu   PetscErrorCode    ierr;
59508a175baeSEmil Constantinescu   PetscInt          i,n,N,rstart;
59518a175baeSEmil Constantinescu   const PetscScalar *e,*u,*y;
59528a175baeSEmil Constantinescu   PetscReal         err,max,gmax,maxa,gmaxa,maxr,gmaxr;
59538a175baeSEmil Constantinescu   PetscReal         tol,tola,tolr;
59548a175baeSEmil Constantinescu   PetscReal         err_loc[3],err_glb[3];
59558a175baeSEmil Constantinescu 
59568a175baeSEmil Constantinescu   PetscFunctionBegin;
59578a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
59588a175baeSEmil Constantinescu   PetscValidHeaderSpecific(E,VEC_CLASSID,2);
59598a175baeSEmil Constantinescu   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
59608a175baeSEmil Constantinescu   PetscValidHeaderSpecific(Y,VEC_CLASSID,4);
59618a175baeSEmil Constantinescu   PetscValidType(E,2);
59628a175baeSEmil Constantinescu   PetscValidType(U,3);
59638a175baeSEmil Constantinescu   PetscValidType(Y,4);
59648a175baeSEmil Constantinescu   PetscCheckSameComm(E,2,U,3);
59658a175baeSEmil Constantinescu   PetscCheckSameComm(U,2,Y,3);
59668a175baeSEmil Constantinescu   PetscValidPointer(norm,5);
59678a175baeSEmil Constantinescu   PetscValidPointer(norma,6);
59688a175baeSEmil Constantinescu   PetscValidPointer(normr,7);
59698a175baeSEmil Constantinescu 
59708a175baeSEmil Constantinescu   ierr = VecGetSize(E,&N);CHKERRQ(ierr);
59718a175baeSEmil Constantinescu   ierr = VecGetLocalSize(E,&n);CHKERRQ(ierr);
59728a175baeSEmil Constantinescu   ierr = VecGetOwnershipRange(E,&rstart,NULL);CHKERRQ(ierr);
59738a175baeSEmil Constantinescu   ierr = VecGetArrayRead(E,&e);CHKERRQ(ierr);
59748a175baeSEmil Constantinescu   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
59758a175baeSEmil Constantinescu   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
59768a175baeSEmil Constantinescu 
59778a175baeSEmil Constantinescu   max=0.;
59788a175baeSEmil Constantinescu   maxa=0.;
59798a175baeSEmil Constantinescu   maxr=0.;
59808a175baeSEmil Constantinescu 
59818a175baeSEmil Constantinescu   if (ts->vatol && ts->vrtol) {     /* vector atol, vector rtol */
59828a175baeSEmil Constantinescu     const PetscScalar *atol,*rtol;
59838a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
59848a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
59858a175baeSEmil Constantinescu 
59868a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
59878a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
59888a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
59898a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
59908a175baeSEmil Constantinescu       tol  = tola+tolr;
59918a175baeSEmil Constantinescu       if(tola>0.){
59928a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
59938a175baeSEmil Constantinescu       }
59948a175baeSEmil Constantinescu       if(tolr>0.){
59958a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
59968a175baeSEmil Constantinescu       }
59978a175baeSEmil Constantinescu       if(tol>0.){
59988a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
59998a175baeSEmil Constantinescu       }
60008a175baeSEmil Constantinescu     }
60018a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60028a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60038a175baeSEmil Constantinescu   } else if (ts->vatol) {       /* vector atol, scalar rtol */
60048a175baeSEmil Constantinescu     const PetscScalar *atol;
60058a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60068a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
60078a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
60088a175baeSEmil Constantinescu       tola = PetscRealPart(atol[i]);
60098a175baeSEmil Constantinescu       tolr = ts->rtol  * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60108a175baeSEmil Constantinescu       tol  = tola+tolr;
60118a175baeSEmil Constantinescu       if(tola>0.){
60128a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
60138a175baeSEmil Constantinescu       }
60148a175baeSEmil Constantinescu       if(tolr>0.){
60158a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
60168a175baeSEmil Constantinescu       }
60178a175baeSEmil Constantinescu       if(tol>0.){
60188a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
60198a175baeSEmil Constantinescu       }
60208a175baeSEmil Constantinescu     }
60218a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
60228a175baeSEmil Constantinescu   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
60238a175baeSEmil Constantinescu     const PetscScalar *rtol;
60248a175baeSEmil Constantinescu     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60258a175baeSEmil Constantinescu 
60268a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
60278a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
60288a175baeSEmil Constantinescu       tola = ts->atol;
60298a175baeSEmil Constantinescu       tolr = PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60308a175baeSEmil Constantinescu       tol  = tola+tolr;
60318a175baeSEmil Constantinescu       if(tola>0.){
60328a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
60338a175baeSEmil Constantinescu       }
60348a175baeSEmil Constantinescu       if(tolr>0.){
60358a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
60368a175baeSEmil Constantinescu       }
60378a175baeSEmil Constantinescu       if(tol>0.){
60388a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
60398a175baeSEmil Constantinescu       }
60408a175baeSEmil Constantinescu     }
60418a175baeSEmil Constantinescu     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
60428a175baeSEmil Constantinescu   } else {                      /* scalar atol, scalar rtol */
60438a175baeSEmil Constantinescu 
60448a175baeSEmil Constantinescu     for (i=0; i<n; i++) {
60458a175baeSEmil Constantinescu       err = PetscAbsScalar(e[i]);
60468a175baeSEmil Constantinescu       tola = ts->atol;
60478a175baeSEmil Constantinescu       tolr = ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
60488a175baeSEmil Constantinescu       tol  = tola+tolr;
60498a175baeSEmil Constantinescu       if(tola>0.){
60508a175baeSEmil Constantinescu         maxa = PetscMax(maxa,err / tola);
60518a175baeSEmil Constantinescu       }
60528a175baeSEmil Constantinescu       if(tolr>0.){
60538a175baeSEmil Constantinescu         maxr = PetscMax(maxr,err / tolr);
60548a175baeSEmil Constantinescu       }
60558a175baeSEmil Constantinescu       if(tol>0.){
60568a175baeSEmil Constantinescu         max = PetscMax(max,err / tol);
60578a175baeSEmil Constantinescu       }
60588a175baeSEmil Constantinescu     }
60598a175baeSEmil Constantinescu   }
60608a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(E,&e);CHKERRQ(ierr);
60618a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
60628a175baeSEmil Constantinescu   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
60638a175baeSEmil Constantinescu   err_loc[0] = max;
60648a175baeSEmil Constantinescu   err_loc[1] = maxa;
60658a175baeSEmil Constantinescu   err_loc[2] = maxr;
6066a88a9d1dSSatish Balay   ierr  = MPIU_Allreduce(err_loc,err_glb,3,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
60678a175baeSEmil Constantinescu   gmax   = err_glb[0];
60688a175baeSEmil Constantinescu   gmaxa  = err_glb[1];
60698a175baeSEmil Constantinescu   gmaxr  = err_glb[2];
60708a175baeSEmil Constantinescu 
60718a175baeSEmil Constantinescu   *norm = gmax;
60728a175baeSEmil Constantinescu   *norma = gmaxa;
60738a175baeSEmil Constantinescu   *normr = gmaxr;
60748a175baeSEmil Constantinescu   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
60758a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*norma)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norma");
60768a175baeSEmil Constantinescu     if (PetscIsInfOrNanScalar(*normr)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in normr");
60778a175baeSEmil Constantinescu   PetscFunctionReturn(0);
60788a175baeSEmil Constantinescu }
60798a175baeSEmil Constantinescu 
60808a175baeSEmil Constantinescu /*@
60818a175baeSEmil Constantinescu    TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
60828a175baeSEmil Constantinescu 
60838a175baeSEmil Constantinescu    Collective on TS
60848a175baeSEmil Constantinescu 
60858a175baeSEmil Constantinescu    Input Arguments:
60868a175baeSEmil Constantinescu +  ts - time stepping context
60878a175baeSEmil Constantinescu .  E - error vector
60888a175baeSEmil Constantinescu .  U - state vector, usually ts->vec_sol
60898a175baeSEmil Constantinescu .  Y - state vector, previous time step
60908a175baeSEmil Constantinescu -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
60918a175baeSEmil Constantinescu 
60928a175baeSEmil Constantinescu    Output Arguments:
60938a175baeSEmil Constantinescu .  norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
60948a175baeSEmil Constantinescu .  norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
60958a175baeSEmil Constantinescu .  normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
60968a175baeSEmil Constantinescu 
60978a175baeSEmil Constantinescu    Options Database Keys:
60988a175baeSEmil Constantinescu .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
60998a175baeSEmil Constantinescu 
61008a175baeSEmil Constantinescu    Level: developer
61018a175baeSEmil Constantinescu 
61028a175baeSEmil Constantinescu .seealso: TSErrorWeightedENormInfinity(), TSErrorWeightedENorm2(), TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
61038a175baeSEmil Constantinescu @*/
61048a175baeSEmil Constantinescu PetscErrorCode TSErrorWeightedENorm(TS ts,Vec E,Vec U,Vec Y,NormType wnormtype,PetscReal *norm,PetscReal *norma,PetscReal *normr)
61058a175baeSEmil Constantinescu {
61068a175baeSEmil Constantinescu   PetscErrorCode ierr;
61078a175baeSEmil Constantinescu 
61088a175baeSEmil Constantinescu   PetscFunctionBegin;
61098a175baeSEmil Constantinescu   if (wnormtype == NORM_2) {
61108a175baeSEmil Constantinescu     ierr = TSErrorWeightedENorm2(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
61118a175baeSEmil Constantinescu   } else if(wnormtype == NORM_INFINITY) {
61128a175baeSEmil Constantinescu     ierr = TSErrorWeightedENormInfinity(ts,E,U,Y,norm,norma,normr);CHKERRQ(ierr);
61138a175baeSEmil Constantinescu   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
61148a175baeSEmil Constantinescu   PetscFunctionReturn(0);
61158a175baeSEmil Constantinescu }
61168a175baeSEmil Constantinescu 
61178a175baeSEmil Constantinescu 
61188d59e960SJed Brown /*@
61198d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
61208d59e960SJed Brown 
61218d59e960SJed Brown    Logically Collective on TS
61228d59e960SJed Brown 
61238d59e960SJed Brown    Input Arguments:
61248d59e960SJed Brown +  ts - time stepping context
61258d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
61268d59e960SJed Brown 
61278d59e960SJed Brown    Note:
61288d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
61298d59e960SJed Brown 
61308d59e960SJed Brown    Level: intermediate
61318d59e960SJed Brown 
61328d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
61338d59e960SJed Brown @*/
61348d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
61358d59e960SJed Brown {
61368d59e960SJed Brown   PetscFunctionBegin;
61378d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
61388d59e960SJed Brown   ts->cfltime_local = cfltime;
61398d59e960SJed Brown   ts->cfltime       = -1.;
61408d59e960SJed Brown   PetscFunctionReturn(0);
61418d59e960SJed Brown }
61428d59e960SJed Brown 
61438d59e960SJed Brown /*@
61448d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
61458d59e960SJed Brown 
61468d59e960SJed Brown    Collective on TS
61478d59e960SJed Brown 
61488d59e960SJed Brown    Input Arguments:
61498d59e960SJed Brown .  ts - time stepping context
61508d59e960SJed Brown 
61518d59e960SJed Brown    Output Arguments:
61528d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
61538d59e960SJed Brown 
61548d59e960SJed Brown    Level: advanced
61558d59e960SJed Brown 
61568d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
61578d59e960SJed Brown @*/
61588d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
61598d59e960SJed Brown {
61608d59e960SJed Brown   PetscErrorCode ierr;
61618d59e960SJed Brown 
61628d59e960SJed Brown   PetscFunctionBegin;
61638d59e960SJed Brown   if (ts->cfltime < 0) {
6164b2566f29SBarry Smith     ierr = MPIU_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
61658d59e960SJed Brown   }
61668d59e960SJed Brown   *cfltime = ts->cfltime;
61678d59e960SJed Brown   PetscFunctionReturn(0);
61688d59e960SJed Brown }
61698d59e960SJed Brown 
6170d6ebe24aSShri Abhyankar /*@
6171d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
6172d6ebe24aSShri Abhyankar 
6173d6ebe24aSShri Abhyankar    Input Parameters:
6174d6ebe24aSShri Abhyankar .  ts   - the TS context.
6175d6ebe24aSShri Abhyankar .  xl   - lower bound.
6176d6ebe24aSShri Abhyankar .  xu   - upper bound.
6177d6ebe24aSShri Abhyankar 
6178d6ebe24aSShri Abhyankar    Notes:
6179d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
6180e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
6181d6ebe24aSShri Abhyankar 
61822bd2b0e6SSatish Balay    Level: advanced
61832bd2b0e6SSatish Balay 
6184d6ebe24aSShri Abhyankar @*/
6185d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
6186d6ebe24aSShri Abhyankar {
6187d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
6188d6ebe24aSShri Abhyankar   SNES           snes;
6189d6ebe24aSShri Abhyankar 
6190d6ebe24aSShri Abhyankar   PetscFunctionBegin;
6191d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
6192d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
6193d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
6194d6ebe24aSShri Abhyankar }
6195d6ebe24aSShri Abhyankar 
6196325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
6197c6db04a5SJed Brown #include <mex.h>
6198325fc9f4SBarry Smith 
6199325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
6200325fc9f4SBarry Smith 
6201325fc9f4SBarry Smith /*
6202325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
6203325fc9f4SBarry Smith                          TSSetFunctionMatlab().
6204325fc9f4SBarry Smith 
6205325fc9f4SBarry Smith    Collective on TS
6206325fc9f4SBarry Smith 
6207325fc9f4SBarry Smith    Input Parameters:
6208325fc9f4SBarry Smith +  snes - the TS context
62090910c330SBarry Smith -  u - input vector
6210325fc9f4SBarry Smith 
6211325fc9f4SBarry Smith    Output Parameter:
6212325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
6213325fc9f4SBarry Smith 
6214325fc9f4SBarry Smith    Notes:
6215325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
6216325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
6217325fc9f4SBarry Smith    themselves.
6218325fc9f4SBarry Smith 
6219325fc9f4SBarry Smith    Level: developer
6220325fc9f4SBarry Smith 
6221325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6222325fc9f4SBarry Smith 
6223325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6224325fc9f4SBarry Smith */
62250910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
6226325fc9f4SBarry Smith {
6227325fc9f4SBarry Smith   PetscErrorCode  ierr;
6228325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6229325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
6230325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
6231325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
6232325fc9f4SBarry Smith 
6233325fc9f4SBarry Smith   PetscFunctionBegin;
6234325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
62350910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
62360910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
6237325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
62380910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
6239325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
6240325fc9f4SBarry Smith 
6241325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
62420910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
62430910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
62440910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
6245bbd56ea5SKarl Rupp 
6246325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6247325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
6248325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6249325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6250325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
6251325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
6252325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
6253325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
6254325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6255325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6256325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6257325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6258325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6259325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6260325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6261325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6262325fc9f4SBarry Smith   PetscFunctionReturn(0);
6263325fc9f4SBarry Smith }
6264325fc9f4SBarry Smith 
6265325fc9f4SBarry Smith /*
6266325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
6267325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
6268e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
6269325fc9f4SBarry Smith 
6270325fc9f4SBarry Smith    Logically Collective on TS
6271325fc9f4SBarry Smith 
6272325fc9f4SBarry Smith    Input Parameters:
6273325fc9f4SBarry Smith +  ts - the TS context
6274325fc9f4SBarry Smith -  func - function evaluation routine
6275325fc9f4SBarry Smith 
6276325fc9f4SBarry Smith    Calling sequence of func:
62770910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
6278325fc9f4SBarry Smith 
6279325fc9f4SBarry Smith    Level: beginner
6280325fc9f4SBarry Smith 
6281325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6282325fc9f4SBarry Smith 
6283325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6284325fc9f4SBarry Smith */
6285cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
6286325fc9f4SBarry Smith {
6287325fc9f4SBarry Smith   PetscErrorCode  ierr;
6288325fc9f4SBarry Smith   TSMatlabContext *sctx;
6289325fc9f4SBarry Smith 
6290325fc9f4SBarry Smith   PetscFunctionBegin;
6291325fc9f4SBarry Smith   /* currently sctx is memory bleed */
629295dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6293325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6294325fc9f4SBarry Smith   /*
6295325fc9f4SBarry Smith      This should work, but it doesn't
6296325fc9f4SBarry Smith   sctx->ctx = ctx;
6297325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6298325fc9f4SBarry Smith   */
6299325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6300bbd56ea5SKarl Rupp 
63010298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
6302325fc9f4SBarry Smith   PetscFunctionReturn(0);
6303325fc9f4SBarry Smith }
6304325fc9f4SBarry Smith 
6305325fc9f4SBarry Smith /*
6306325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
6307325fc9f4SBarry Smith                          TSSetJacobianMatlab().
6308325fc9f4SBarry Smith 
6309325fc9f4SBarry Smith    Collective on TS
6310325fc9f4SBarry Smith 
6311325fc9f4SBarry Smith    Input Parameters:
6312cdcf91faSSean Farley +  ts - the TS context
63130910c330SBarry Smith .  u - input vector
6314325fc9f4SBarry Smith .  A, B - the matrices
6315325fc9f4SBarry Smith -  ctx - user context
6316325fc9f4SBarry Smith 
6317325fc9f4SBarry Smith    Level: developer
6318325fc9f4SBarry Smith 
6319325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
6320325fc9f4SBarry Smith 
6321325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6322325fc9f4SBarry Smith @*/
6323f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
6324325fc9f4SBarry Smith {
6325325fc9f4SBarry Smith   PetscErrorCode  ierr;
6326325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6327325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
6328325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
6329325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
6330325fc9f4SBarry Smith 
6331325fc9f4SBarry Smith   PetscFunctionBegin;
6332cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
63330910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
6334325fc9f4SBarry Smith 
63350910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
6336325fc9f4SBarry Smith 
6337cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
63380910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
63390910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
63400910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
63410910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
6342bbd56ea5SKarl Rupp 
6343325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6344325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
6345325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
6346325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
6347325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
6348325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
6349325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
6350325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
6351325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
6352325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
6353325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6354325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
6355325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
6356325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
6357325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
6358325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
6359325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
6360325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
6361325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
6362325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
6363325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
6364325fc9f4SBarry Smith   PetscFunctionReturn(0);
6365325fc9f4SBarry Smith }
6366325fc9f4SBarry Smith 
6367325fc9f4SBarry Smith /*
6368325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
6369e3c5b3baSBarry 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
6370325fc9f4SBarry Smith 
6371325fc9f4SBarry Smith    Logically Collective on TS
6372325fc9f4SBarry Smith 
6373325fc9f4SBarry Smith    Input Parameters:
6374cdcf91faSSean Farley +  ts - the TS context
6375325fc9f4SBarry Smith .  A,B - Jacobian matrices
6376325fc9f4SBarry Smith .  func - function evaluation routine
6377325fc9f4SBarry Smith -  ctx - user context
6378325fc9f4SBarry Smith 
6379325fc9f4SBarry Smith    Calling sequence of func:
63800910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
6381325fc9f4SBarry Smith 
6382325fc9f4SBarry Smith    Level: developer
6383325fc9f4SBarry Smith 
6384325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
6385325fc9f4SBarry Smith 
6386325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6387325fc9f4SBarry Smith */
6388cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
6389325fc9f4SBarry Smith {
6390325fc9f4SBarry Smith   PetscErrorCode  ierr;
6391325fc9f4SBarry Smith   TSMatlabContext *sctx;
6392325fc9f4SBarry Smith 
6393325fc9f4SBarry Smith   PetscFunctionBegin;
6394325fc9f4SBarry Smith   /* currently sctx is memory bleed */
639595dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6396325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6397325fc9f4SBarry Smith   /*
6398325fc9f4SBarry Smith      This should work, but it doesn't
6399325fc9f4SBarry Smith   sctx->ctx = ctx;
6400325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6401325fc9f4SBarry Smith   */
6402325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6403bbd56ea5SKarl Rupp 
6404cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
6405325fc9f4SBarry Smith   PetscFunctionReturn(0);
6406325fc9f4SBarry Smith }
6407325fc9f4SBarry Smith 
6408b5b1a830SBarry Smith /*
6409b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
6410b5b1a830SBarry Smith 
6411b5b1a830SBarry Smith    Collective on TS
6412b5b1a830SBarry Smith 
6413b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
6414b5b1a830SBarry Smith @*/
64150910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
6416b5b1a830SBarry Smith {
6417b5b1a830SBarry Smith   PetscErrorCode  ierr;
6418b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
6419a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
6420b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
6421b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
6422b5b1a830SBarry Smith 
6423b5b1a830SBarry Smith   PetscFunctionBegin;
6424cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
64250910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
6426b5b1a830SBarry Smith 
6427cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
64280910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
6429bbd56ea5SKarl Rupp 
6430b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
6431b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
6432b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
6433b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
6434b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
6435b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
6436b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
6437b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
6438b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
6439b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
6440b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
6441b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
6442b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
6443b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
6444b5b1a830SBarry Smith   PetscFunctionReturn(0);
6445b5b1a830SBarry Smith }
6446b5b1a830SBarry Smith 
6447b5b1a830SBarry Smith /*
6448b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
6449b5b1a830SBarry Smith 
6450b5b1a830SBarry Smith    Level: developer
6451b5b1a830SBarry Smith 
6452b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
6453b5b1a830SBarry Smith 
6454b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
6455b5b1a830SBarry Smith */
6456cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
6457b5b1a830SBarry Smith {
6458b5b1a830SBarry Smith   PetscErrorCode  ierr;
6459b5b1a830SBarry Smith   TSMatlabContext *sctx;
6460b5b1a830SBarry Smith 
6461b5b1a830SBarry Smith   PetscFunctionBegin;
6462b5b1a830SBarry Smith   /* currently sctx is memory bleed */
646395dccacaSBarry Smith   ierr = PetscNew(&sctx);CHKERRQ(ierr);
6464b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
6465b5b1a830SBarry Smith   /*
6466b5b1a830SBarry Smith      This should work, but it doesn't
6467b5b1a830SBarry Smith   sctx->ctx = ctx;
6468b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
6469b5b1a830SBarry Smith   */
6470b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
6471bbd56ea5SKarl Rupp 
64720298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
6473b5b1a830SBarry Smith   PetscFunctionReturn(0);
6474b5b1a830SBarry Smith }
6475325fc9f4SBarry Smith #endif
6476b3603a34SBarry Smith 
6477b3603a34SBarry Smith /*@C
64784f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
6479b3603a34SBarry Smith        in a time based line graph
6480b3603a34SBarry Smith 
6481b3603a34SBarry Smith    Collective on TS
6482b3603a34SBarry Smith 
6483b3603a34SBarry Smith    Input Parameters:
6484b3603a34SBarry Smith +  ts - the TS context
6485b3603a34SBarry Smith .  step - current time-step
6486b3603a34SBarry Smith .  ptime - current time
64877db568b7SBarry Smith .  u - current solution
64887db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
6489b3603a34SBarry Smith 
6490b3d3934dSBarry Smith    Options Database:
64919ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
6492b3d3934dSBarry Smith 
6493b3603a34SBarry Smith    Level: intermediate
6494b3603a34SBarry Smith 
649595452b02SPatrick Sanan    Notes:
649695452b02SPatrick Sanan     Each process in a parallel run displays its component solutions in a separate window
6497b3603a34SBarry Smith 
6498b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
6499b3603a34SBarry Smith 
65007db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
65017db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
65027db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
65037db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
6504b3603a34SBarry Smith @*/
65057db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6506b3603a34SBarry Smith {
6507b3603a34SBarry Smith   PetscErrorCode    ierr;
65087db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
6509b3603a34SBarry Smith   const PetscScalar *yy;
651080666b62SBarry Smith   Vec               v;
6511b3603a34SBarry Smith 
6512b3603a34SBarry Smith   PetscFunctionBegin;
651363e21af5SBarry Smith   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
651458ff32f7SBarry Smith   if (!step) {
6515a9f9c1f6SBarry Smith     PetscDrawAxis axis;
65166934998bSLisandro Dalcin     PetscInt      dim;
6517a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6518*0ec8ee2bSJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
6519bab0a581SBarry Smith     if (!ctx->names) {
6520bab0a581SBarry Smith       PetscBool flg;
6521bab0a581SBarry Smith       /* user provides names of variables to plot but no names has been set so assume names are integer values */
6522bab0a581SBarry Smith       ierr = PetscOptionsHasName(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",&flg);CHKERRQ(ierr);
6523bab0a581SBarry Smith       if (flg) {
6524bab0a581SBarry Smith         PetscInt i,n;
6525bab0a581SBarry Smith         char     **names;
6526bab0a581SBarry Smith         ierr = VecGetSize(u,&n);CHKERRQ(ierr);
6527bab0a581SBarry Smith         ierr = PetscMalloc1(n+1,&names);CHKERRQ(ierr);
6528bab0a581SBarry Smith         for (i=0; i<n; i++) {
6529bab0a581SBarry Smith           ierr = PetscMalloc1(5,&names[i]);CHKERRQ(ierr);
6530bab0a581SBarry Smith           ierr = PetscSNPrintf(names[i],5,"%D",i);CHKERRQ(ierr);
6531bab0a581SBarry Smith         }
6532bab0a581SBarry Smith         names[n] = NULL;
6533bab0a581SBarry Smith         ctx->names = names;
6534bab0a581SBarry Smith       }
6535bab0a581SBarry Smith     }
6536387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
6537387f4636SBarry Smith       char      **displaynames;
6538387f4636SBarry Smith       PetscBool flg;
6539387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
654095dccacaSBarry Smith       ierr = PetscMalloc1(dim+1,&displaynames);CHKERRQ(ierr);
6541387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
6542c5929fdfSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->options,((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
6543387f4636SBarry Smith       if (flg) {
6544a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
6545387f4636SBarry Smith       }
6546387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
6547387f4636SBarry Smith     }
6548387f4636SBarry Smith     if (ctx->displaynames) {
6549387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
6550387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
6551387f4636SBarry Smith     } else if (ctx->names) {
65520910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
65530b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6554387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
6555b0bc92c6SBarry Smith     } else {
6556b0bc92c6SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6557b0bc92c6SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6558387f4636SBarry Smith     }
65590b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
656058ff32f7SBarry Smith   }
65616934998bSLisandro Dalcin 
65626934998bSLisandro Dalcin   if (!ctx->transform) v = u;
65636934998bSLisandro Dalcin   else {ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);}
656480666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
65656934998bSLisandro Dalcin   if (ctx->displaynames) {
65666934998bSLisandro Dalcin     PetscInt i;
65676934998bSLisandro Dalcin     for (i=0; i<ctx->ndisplayvariables; i++)
65686934998bSLisandro Dalcin       ctx->displayvalues[i] = PetscRealPart(yy[ctx->displayvariables[i]]);
65696934998bSLisandro Dalcin     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
65706934998bSLisandro Dalcin   } else {
6571e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6572e3efe391SJed Brown     PetscInt  i,n;
65736934998bSLisandro Dalcin     PetscReal *yreal;
657480666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
6575785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6576e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
65770b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6578e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6579e3efe391SJed Brown #else
65800b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6581e3efe391SJed Brown #endif
658280666b62SBarry Smith   }
65836934998bSLisandro Dalcin   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
65846934998bSLisandro Dalcin   if (ctx->transform) {ierr = VecDestroy(&v);CHKERRQ(ierr);}
65856934998bSLisandro Dalcin 
6586b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
65870b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
65886934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
65893923b477SBarry Smith   }
6590b3603a34SBarry Smith   PetscFunctionReturn(0);
6591b3603a34SBarry Smith }
6592b3603a34SBarry Smith 
6593b037adc7SBarry Smith /*@C
659431152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6595b037adc7SBarry Smith 
6596b037adc7SBarry Smith    Collective on TS
6597b037adc7SBarry Smith 
6598b037adc7SBarry Smith    Input Parameters:
6599b037adc7SBarry Smith +  ts - the TS context
6600b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
6601b037adc7SBarry Smith 
6602b037adc7SBarry Smith    Level: intermediate
6603b037adc7SBarry Smith 
660495452b02SPatrick Sanan    Notes:
660595452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66067db568b7SBarry Smith 
6607b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
6608b037adc7SBarry Smith 
6609a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
6610b037adc7SBarry Smith @*/
661131152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
6612b037adc7SBarry Smith {
6613b037adc7SBarry Smith   PetscErrorCode    ierr;
6614b037adc7SBarry Smith   PetscInt          i;
6615b037adc7SBarry Smith 
6616b037adc7SBarry Smith   PetscFunctionBegin;
6617b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6618b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66195537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
6620b3d3934dSBarry Smith       break;
6621b3d3934dSBarry Smith     }
6622b3d3934dSBarry Smith   }
6623b3d3934dSBarry Smith   PetscFunctionReturn(0);
6624b3d3934dSBarry Smith }
6625b3d3934dSBarry Smith 
6626e673d494SBarry Smith /*@C
6627e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
6628e673d494SBarry Smith 
6629e673d494SBarry Smith    Collective on TS
6630e673d494SBarry Smith 
6631e673d494SBarry Smith    Input Parameters:
6632e673d494SBarry Smith +  ts - the TS context
6633e673d494SBarry Smith -  names - the names of the components, final string must be NULL
6634e673d494SBarry Smith 
6635e673d494SBarry Smith    Level: intermediate
6636e673d494SBarry Smith 
6637e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6638e673d494SBarry Smith 
6639a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
6640e673d494SBarry Smith @*/
6641e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
6642e673d494SBarry Smith {
6643e673d494SBarry Smith   PetscErrorCode    ierr;
6644e673d494SBarry Smith 
6645e673d494SBarry Smith   PetscFunctionBegin;
6646e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
6647e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
6648e673d494SBarry Smith   PetscFunctionReturn(0);
6649e673d494SBarry Smith }
6650e673d494SBarry Smith 
6651b3d3934dSBarry Smith /*@C
6652b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
6653b3d3934dSBarry Smith 
6654b3d3934dSBarry Smith    Collective on TS
6655b3d3934dSBarry Smith 
6656b3d3934dSBarry Smith    Input Parameter:
6657b3d3934dSBarry Smith .  ts - the TS context
6658b3d3934dSBarry Smith 
6659b3d3934dSBarry Smith    Output Parameter:
6660b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
6661b3d3934dSBarry Smith 
6662b3d3934dSBarry Smith    Level: intermediate
6663b3d3934dSBarry Smith 
666495452b02SPatrick Sanan    Notes:
666595452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
66667db568b7SBarry Smith 
6667b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6668b3d3934dSBarry Smith 
6669b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6670b3d3934dSBarry Smith @*/
6671b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
6672b3d3934dSBarry Smith {
6673b3d3934dSBarry Smith   PetscInt       i;
6674b3d3934dSBarry Smith 
6675b3d3934dSBarry Smith   PetscFunctionBegin;
6676b3d3934dSBarry Smith   *names = NULL;
6677b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6678b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
66795537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
6680b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
6681b3d3934dSBarry Smith       break;
6682387f4636SBarry Smith     }
6683387f4636SBarry Smith   }
6684387f4636SBarry Smith   PetscFunctionReturn(0);
6685387f4636SBarry Smith }
6686387f4636SBarry Smith 
6687a66092f1SBarry Smith /*@C
6688a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
6689a66092f1SBarry Smith 
6690a66092f1SBarry Smith    Collective on TS
6691a66092f1SBarry Smith 
6692a66092f1SBarry Smith    Input Parameters:
6693a66092f1SBarry Smith +  ctx - the TSMonitorLG context
6694a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
6695a66092f1SBarry Smith 
6696a66092f1SBarry Smith    Level: intermediate
6697a66092f1SBarry Smith 
6698a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6699a66092f1SBarry Smith 
6700a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6701a66092f1SBarry Smith @*/
6702a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6703a66092f1SBarry Smith {
6704a66092f1SBarry Smith   PetscInt          j = 0,k;
6705a66092f1SBarry Smith   PetscErrorCode    ierr;
6706a66092f1SBarry Smith 
6707a66092f1SBarry Smith   PetscFunctionBegin;
6708a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6709a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6710a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6711a66092f1SBarry Smith   while (displaynames[j]) j++;
6712a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6713a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6714a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6715a66092f1SBarry Smith   j = 0;
6716a66092f1SBarry Smith   while (displaynames[j]) {
6717a66092f1SBarry Smith     k = 0;
6718a66092f1SBarry Smith     while (ctx->names[k]) {
6719a66092f1SBarry Smith       PetscBool flg;
6720a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6721a66092f1SBarry Smith       if (flg) {
6722a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6723a66092f1SBarry Smith         break;
6724a66092f1SBarry Smith       }
6725a66092f1SBarry Smith       k++;
6726a66092f1SBarry Smith     }
6727a66092f1SBarry Smith     j++;
6728a66092f1SBarry Smith   }
6729a66092f1SBarry Smith   PetscFunctionReturn(0);
6730a66092f1SBarry Smith }
6731a66092f1SBarry Smith 
6732387f4636SBarry Smith /*@C
6733387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6734387f4636SBarry Smith 
6735387f4636SBarry Smith    Collective on TS
6736387f4636SBarry Smith 
6737387f4636SBarry Smith    Input Parameters:
6738387f4636SBarry Smith +  ts - the TS context
6739387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6740387f4636SBarry Smith 
674195452b02SPatrick Sanan    Notes:
674295452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67437db568b7SBarry Smith 
6744387f4636SBarry Smith    Level: intermediate
6745387f4636SBarry Smith 
6746387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6747387f4636SBarry Smith 
6748387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6749387f4636SBarry Smith @*/
6750387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6751387f4636SBarry Smith {
6752a66092f1SBarry Smith   PetscInt          i;
6753387f4636SBarry Smith   PetscErrorCode    ierr;
6754387f4636SBarry Smith 
6755387f4636SBarry Smith   PetscFunctionBegin;
6756387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6757387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67585537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6759b3d3934dSBarry Smith       break;
6760b037adc7SBarry Smith     }
6761b037adc7SBarry Smith   }
6762b037adc7SBarry Smith   PetscFunctionReturn(0);
6763b037adc7SBarry Smith }
6764b037adc7SBarry Smith 
676580666b62SBarry Smith /*@C
676680666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
676780666b62SBarry Smith 
676880666b62SBarry Smith    Collective on TS
676980666b62SBarry Smith 
677080666b62SBarry Smith    Input Parameters:
677180666b62SBarry Smith +  ts - the TS context
677280666b62SBarry Smith .  transform - the transform function
67737684fa3eSBarry Smith .  destroy - function to destroy the optional context
677480666b62SBarry Smith -  ctx - optional context used by transform function
677580666b62SBarry Smith 
677695452b02SPatrick Sanan    Notes:
677795452b02SPatrick Sanan     If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
67787db568b7SBarry Smith 
677980666b62SBarry Smith    Level: intermediate
678080666b62SBarry Smith 
678180666b62SBarry Smith .keywords: TS,  vector, monitor, view
678280666b62SBarry Smith 
6783a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
678480666b62SBarry Smith @*/
67857684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
678680666b62SBarry Smith {
678780666b62SBarry Smith   PetscInt          i;
6788a66092f1SBarry Smith   PetscErrorCode    ierr;
678980666b62SBarry Smith 
679080666b62SBarry Smith   PetscFunctionBegin;
679180666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
679280666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
67935537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
679480666b62SBarry Smith     }
679580666b62SBarry Smith   }
679680666b62SBarry Smith   PetscFunctionReturn(0);
679780666b62SBarry Smith }
679880666b62SBarry Smith 
6799e673d494SBarry Smith /*@C
6800e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6801e673d494SBarry Smith 
6802e673d494SBarry Smith    Collective on TSLGCtx
6803e673d494SBarry Smith 
6804e673d494SBarry Smith    Input Parameters:
6805e673d494SBarry Smith +  ts - the TS context
6806e673d494SBarry Smith .  transform - the transform function
68077684fa3eSBarry Smith .  destroy - function to destroy the optional context
6808e673d494SBarry Smith -  ctx - optional context used by transform function
6809e673d494SBarry Smith 
6810e673d494SBarry Smith    Level: intermediate
6811e673d494SBarry Smith 
6812e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6813e673d494SBarry Smith 
6814a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6815e673d494SBarry Smith @*/
68167684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6817e673d494SBarry Smith {
6818e673d494SBarry Smith   PetscFunctionBegin;
6819e673d494SBarry Smith   ctx->transform    = transform;
68207684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6821e673d494SBarry Smith   ctx->transformctx = tctx;
6822e673d494SBarry Smith   PetscFunctionReturn(0);
6823e673d494SBarry Smith }
6824e673d494SBarry Smith 
6825ef20d060SBarry Smith /*@C
68268b668821SLisandro Dalcin    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the error
6827ef20d060SBarry Smith        in a time based line graph
6828ef20d060SBarry Smith 
6829ef20d060SBarry Smith    Collective on TS
6830ef20d060SBarry Smith 
6831ef20d060SBarry Smith    Input Parameters:
6832ef20d060SBarry Smith +  ts - the TS context
6833ef20d060SBarry Smith .  step - current time-step
6834ef20d060SBarry Smith .  ptime - current time
68357db568b7SBarry Smith .  u - current solution
68367db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6837ef20d060SBarry Smith 
6838ef20d060SBarry Smith    Level: intermediate
6839ef20d060SBarry Smith 
684095452b02SPatrick Sanan    Notes:
684195452b02SPatrick Sanan     Each process in a parallel run displays its component errors in a separate window
6842abd5a294SJed Brown 
6843abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6844abd5a294SJed Brown 
6845abd5a294SJed Brown    Options Database Keys:
68464f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6847ef20d060SBarry Smith 
6848ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6849ef20d060SBarry Smith 
6850abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6851ef20d060SBarry Smith @*/
68520910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6853ef20d060SBarry Smith {
6854ef20d060SBarry Smith   PetscErrorCode    ierr;
68550b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6856ef20d060SBarry Smith   const PetscScalar *yy;
6857ef20d060SBarry Smith   Vec               y;
6858ef20d060SBarry Smith 
6859ef20d060SBarry Smith   PetscFunctionBegin;
6860a9f9c1f6SBarry Smith   if (!step) {
6861a9f9c1f6SBarry Smith     PetscDrawAxis axis;
68626934998bSLisandro Dalcin     PetscInt      dim;
6863a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
68648b668821SLisandro Dalcin     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Error");CHKERRQ(ierr);
68650910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6866a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6867a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6868a9f9c1f6SBarry Smith   }
68690910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6870ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
68710910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6872ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6873e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6874e3efe391SJed Brown   {
6875e3efe391SJed Brown     PetscReal *yreal;
6876e3efe391SJed Brown     PetscInt  i,n;
6877e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6878785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6879e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
68800b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6881e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6882e3efe391SJed Brown   }
6883e3efe391SJed Brown #else
68840b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6885e3efe391SJed Brown #endif
6886ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6887ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6888b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
68890b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
68906934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
68913923b477SBarry Smith   }
6892ef20d060SBarry Smith   PetscFunctionReturn(0);
6893ef20d060SBarry Smith }
6894ef20d060SBarry Smith 
6895*0ec8ee2bSJoseph Pusztay PetscErrorCode TSMonitorSPSwarmSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
68961b575b74SJoseph Pusztay {
68971b575b74SJoseph Pusztay   PetscErrorCode    ierr;
68981b575b74SJoseph Pusztay   TSMonitorSPCtx    ctx = (TSMonitorSPCtx)dctx;
68991b575b74SJoseph Pusztay   const PetscScalar *yy;
69001b575b74SJoseph Pusztay   PetscScalar       *y,*x;
69011b575b74SJoseph Pusztay   PetscInt          Np, p, dim=2;
69021b575b74SJoseph Pusztay   DM                dm;
69031b575b74SJoseph Pusztay 
69041b575b74SJoseph Pusztay   PetscFunctionBegin;
69051b575b74SJoseph Pusztay 
69061b575b74SJoseph Pusztay   if (step < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
69071b575b74SJoseph Pusztay   if (!step) {
69081b575b74SJoseph Pusztay     PetscDrawAxis axis;
69091b575b74SJoseph Pusztay     ierr = PetscDrawSPGetAxis(ctx->sp,&axis);CHKERRQ(ierr);
69101b575b74SJoseph Pusztay     ierr = PetscDrawAxisSetLabels(axis,"Particles","X","Y");CHKERRQ(ierr);
6911895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetLimits(axis, -5, 5, -5, 5);CHKERRQ(ierr);
6912895f37d5SJoseph Pusztay     ierr = PetscDrawAxisSetHoldLimits(axis, PETSC_TRUE);CHKERRQ(ierr);
69131b575b74SJoseph Pusztay     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
69141b575b74SJoseph Pusztay     ierr = DMGetDimension(dm, &dim);
69151b575b74SJoseph Pusztay     if(dim!=2) SETERRQ(PETSC_COMM_SELF, ierr, "Dimensions improper for monitor arguments! Current support: two dimensions.");CHKERRQ(ierr);
69161b575b74SJoseph Pusztay     ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69171b575b74SJoseph Pusztay     Np /= 2*dim;
69181b575b74SJoseph Pusztay     ierr = PetscDrawSPSetDimension(ctx->sp, Np);CHKERRQ(ierr);
69191b575b74SJoseph Pusztay     ierr = PetscDrawSPReset(ctx->sp);CHKERRQ(ierr);
69201b575b74SJoseph Pusztay   }
69211b575b74SJoseph Pusztay 
69221b575b74SJoseph Pusztay   ierr = VecGetLocalSize(u, &Np);CHKERRQ(ierr);
69231b575b74SJoseph Pusztay   Np /= 2*dim;
69241b575b74SJoseph Pusztay   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
6925895f37d5SJoseph Pusztay   ierr = PetscMalloc2(Np, &x, Np, &y);CHKERRQ(ierr);
69261b575b74SJoseph Pusztay   /* get points from solution vector */
69271b575b74SJoseph Pusztay   for (p=0; p<Np; ++p){
69281b575b74SJoseph Pusztay     x[p] = yy[2*dim*p];
69291b575b74SJoseph Pusztay     y[p] = yy[2*dim*p+1];
6930895f37d5SJoseph Pusztay   }
69311b575b74SJoseph Pusztay   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
69321b575b74SJoseph Pusztay 
69331b575b74SJoseph Pusztay   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
69341b575b74SJoseph Pusztay     ierr = PetscDrawSPAddPoint(ctx->sp,x,y);CHKERRQ(ierr);
69351b575b74SJoseph Pusztay     ierr = PetscDrawSPDraw(ctx->sp,PETSC_FALSE);CHKERRQ(ierr);
69361b575b74SJoseph Pusztay     ierr = PetscDrawSPSave(ctx->sp);CHKERRQ(ierr);
69371b575b74SJoseph Pusztay   }
69381b575b74SJoseph Pusztay 
69391b575b74SJoseph Pusztay   PetscFunctionReturn(0);
69401b575b74SJoseph Pusztay }
69411b575b74SJoseph Pusztay 
69421b575b74SJoseph Pusztay 
69431b575b74SJoseph Pusztay 
69447cf37e64SBarry Smith /*@C
69457cf37e64SBarry Smith    TSMonitorError - Monitors progress of the TS solvers by printing the 2 norm of the error at each timestep
69467cf37e64SBarry Smith 
69477cf37e64SBarry Smith    Collective on TS
69487cf37e64SBarry Smith 
69497cf37e64SBarry Smith    Input Parameters:
69507cf37e64SBarry Smith +  ts - the TS context
69517cf37e64SBarry Smith .  step - current time-step
69527cf37e64SBarry Smith .  ptime - current time
69537cf37e64SBarry Smith .  u - current solution
69547cf37e64SBarry Smith -  dctx - unused context
69557cf37e64SBarry Smith 
69567cf37e64SBarry Smith    Level: intermediate
69577cf37e64SBarry Smith 
69587cf37e64SBarry Smith    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
69597cf37e64SBarry Smith 
69607cf37e64SBarry Smith    Options Database Keys:
69617cf37e64SBarry Smith .  -ts_monitor_error - create a graphical monitor of error history
69627cf37e64SBarry Smith 
69637cf37e64SBarry Smith .keywords: TS,  vector, monitor, view
69647cf37e64SBarry Smith 
69657cf37e64SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
69667cf37e64SBarry Smith @*/
6967edbaebb3SBarry Smith PetscErrorCode  TSMonitorError(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscViewerAndFormat *vf)
69687cf37e64SBarry Smith {
69697cf37e64SBarry Smith   PetscErrorCode    ierr;
69707cf37e64SBarry Smith   Vec               y;
69717cf37e64SBarry Smith   PetscReal         nrm;
6972edbaebb3SBarry Smith   PetscBool         flg;
69737cf37e64SBarry Smith 
69747cf37e64SBarry Smith   PetscFunctionBegin;
69757cf37e64SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
69767cf37e64SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
69777cf37e64SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6978edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERASCII,&flg);CHKERRQ(ierr);
6979edbaebb3SBarry Smith   if (flg) {
69807cf37e64SBarry Smith     ierr = VecNorm(y,NORM_2,&nrm);CHKERRQ(ierr);
6981edbaebb3SBarry Smith     ierr = PetscViewerASCIIPrintf(vf->viewer,"2-norm of error %g\n",(double)nrm);CHKERRQ(ierr);
6982edbaebb3SBarry Smith   }
6983edbaebb3SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)vf->viewer,PETSCVIEWERDRAW,&flg);CHKERRQ(ierr);
6984edbaebb3SBarry Smith   if (flg) {
6985edbaebb3SBarry Smith     ierr = VecView(y,vf->viewer);CHKERRQ(ierr);
6986edbaebb3SBarry Smith   }
6987edbaebb3SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
69887cf37e64SBarry Smith   PetscFunctionReturn(0);
69897cf37e64SBarry Smith }
69907cf37e64SBarry Smith 
6991201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6992201da799SBarry Smith {
6993201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6994201da799SBarry Smith   PetscReal      x   = ptime,y;
6995201da799SBarry Smith   PetscErrorCode ierr;
6996201da799SBarry Smith   PetscInt       its;
6997201da799SBarry Smith 
6998201da799SBarry Smith   PetscFunctionBegin;
699963e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7000201da799SBarry Smith   if (!n) {
7001201da799SBarry Smith     PetscDrawAxis axis;
7002201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7003201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
7004201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7005201da799SBarry Smith     ctx->snes_its = 0;
7006201da799SBarry Smith   }
7007201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
7008201da799SBarry Smith   y    = its - ctx->snes_its;
7009201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
70103fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7011201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70126934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7013201da799SBarry Smith   }
7014201da799SBarry Smith   ctx->snes_its = its;
7015201da799SBarry Smith   PetscFunctionReturn(0);
7016201da799SBarry Smith }
7017201da799SBarry Smith 
7018201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
7019201da799SBarry Smith {
7020201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
7021201da799SBarry Smith   PetscReal      x   = ptime,y;
7022201da799SBarry Smith   PetscErrorCode ierr;
7023201da799SBarry Smith   PetscInt       its;
7024201da799SBarry Smith 
7025201da799SBarry Smith   PetscFunctionBegin;
702663e21af5SBarry Smith   if (n < 0) PetscFunctionReturn(0); /* -1 indicates interpolated solution */
7027201da799SBarry Smith   if (!n) {
7028201da799SBarry Smith     PetscDrawAxis axis;
7029201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
7030201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
7031201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
7032201da799SBarry Smith     ctx->ksp_its = 0;
7033201da799SBarry Smith   }
7034201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
7035201da799SBarry Smith   y    = its - ctx->ksp_its;
7036201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
703799fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
7038201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
70396934998bSLisandro Dalcin     ierr = PetscDrawLGSave(ctx->lg);CHKERRQ(ierr);
7040201da799SBarry Smith   }
7041201da799SBarry Smith   ctx->ksp_its = its;
7042201da799SBarry Smith   PetscFunctionReturn(0);
7043201da799SBarry Smith }
7044f9c1d6abSBarry Smith 
7045f9c1d6abSBarry Smith /*@
7046f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
7047f9c1d6abSBarry Smith 
7048f9c1d6abSBarry Smith    Collective on TS and Vec
7049f9c1d6abSBarry Smith 
7050f9c1d6abSBarry Smith    Input Parameters:
7051f9c1d6abSBarry Smith +  ts - the TS context
7052f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
7053f9c1d6abSBarry Smith 
7054f9c1d6abSBarry Smith    Output Parameters:
7055f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
7056f9c1d6abSBarry Smith 
7057f9c1d6abSBarry Smith    Level: developer
7058f9c1d6abSBarry Smith 
7059f9c1d6abSBarry Smith .keywords: TS, compute
7060f9c1d6abSBarry Smith 
7061f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
7062f9c1d6abSBarry Smith @*/
7063f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
7064f9c1d6abSBarry Smith {
7065f9c1d6abSBarry Smith   PetscErrorCode ierr;
7066f9c1d6abSBarry Smith 
7067f9c1d6abSBarry Smith   PetscFunctionBegin;
7068f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7069ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
7070f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
7071f9c1d6abSBarry Smith   PetscFunctionReturn(0);
7072f9c1d6abSBarry Smith }
707324655328SShri 
7074b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
7075b3d3934dSBarry Smith /*@C
7076b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
7077b3d3934dSBarry Smith 
7078b3d3934dSBarry Smith    Collective on TS
7079b3d3934dSBarry Smith 
7080b3d3934dSBarry Smith    Input Parameters:
7081b3d3934dSBarry Smith .  ts  - the ODE solver object
7082b3d3934dSBarry Smith 
7083b3d3934dSBarry Smith    Output Parameter:
7084b3d3934dSBarry Smith .  ctx - the context
7085b3d3934dSBarry Smith 
7086b3d3934dSBarry Smith    Level: intermediate
7087b3d3934dSBarry Smith 
7088b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
7089b3d3934dSBarry Smith 
7090b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
7091b3d3934dSBarry Smith 
7092b3d3934dSBarry Smith @*/
7093b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
7094b3d3934dSBarry Smith {
7095b3d3934dSBarry Smith   PetscErrorCode ierr;
7096b3d3934dSBarry Smith 
7097b3d3934dSBarry Smith   PetscFunctionBegin;
7098a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
7099b3d3934dSBarry Smith   PetscFunctionReturn(0);
7100b3d3934dSBarry Smith }
7101b3d3934dSBarry Smith 
7102b3d3934dSBarry Smith /*@C
7103b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
7104b3d3934dSBarry Smith 
7105b3d3934dSBarry Smith    Collective on TS
7106b3d3934dSBarry Smith 
7107b3d3934dSBarry Smith    Input Parameters:
7108b3d3934dSBarry Smith +  ts - the TS context
7109b3d3934dSBarry Smith .  step - current time-step
7110b3d3934dSBarry Smith .  ptime - current time
71117db568b7SBarry Smith .  u  - current solution
71127db568b7SBarry Smith -  dctx - the envelope context
7113b3d3934dSBarry Smith 
7114b3d3934dSBarry Smith    Options Database:
7115b3d3934dSBarry Smith .  -ts_monitor_envelope
7116b3d3934dSBarry Smith 
7117b3d3934dSBarry Smith    Level: intermediate
7118b3d3934dSBarry Smith 
711995452b02SPatrick Sanan    Notes:
712095452b02SPatrick Sanan     after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
7121b3d3934dSBarry Smith 
7122b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7123b3d3934dSBarry Smith 
71247db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
7125b3d3934dSBarry Smith @*/
71267db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
7127b3d3934dSBarry Smith {
7128b3d3934dSBarry Smith   PetscErrorCode       ierr;
71297db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
7130b3d3934dSBarry Smith 
7131b3d3934dSBarry Smith   PetscFunctionBegin;
7132b3d3934dSBarry Smith   if (!ctx->max) {
7133b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
7134b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
7135b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
7136b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
7137b3d3934dSBarry Smith   } else {
7138b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
7139b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
7140b3d3934dSBarry Smith   }
7141b3d3934dSBarry Smith   PetscFunctionReturn(0);
7142b3d3934dSBarry Smith }
7143b3d3934dSBarry Smith 
7144b3d3934dSBarry Smith /*@C
7145b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
7146b3d3934dSBarry Smith 
7147b3d3934dSBarry Smith    Collective on TS
7148b3d3934dSBarry Smith 
7149b3d3934dSBarry Smith    Input Parameter:
7150b3d3934dSBarry Smith .  ts - the TS context
7151b3d3934dSBarry Smith 
7152b3d3934dSBarry Smith    Output Parameter:
7153b3d3934dSBarry Smith +  max - the maximum values
7154b3d3934dSBarry Smith -  min - the minimum values
7155b3d3934dSBarry Smith 
715695452b02SPatrick Sanan    Notes:
715795452b02SPatrick Sanan     If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
71587db568b7SBarry Smith 
7159b3d3934dSBarry Smith    Level: intermediate
7160b3d3934dSBarry Smith 
7161b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
7162b3d3934dSBarry Smith 
7163b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
7164b3d3934dSBarry Smith @*/
7165b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
7166b3d3934dSBarry Smith {
7167b3d3934dSBarry Smith   PetscInt i;
7168b3d3934dSBarry Smith 
7169b3d3934dSBarry Smith   PetscFunctionBegin;
7170b3d3934dSBarry Smith   if (max) *max = NULL;
7171b3d3934dSBarry Smith   if (min) *min = NULL;
7172b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
7173b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
71745537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
7175b3d3934dSBarry Smith       if (max) *max = ctx->max;
7176b3d3934dSBarry Smith       if (min) *min = ctx->min;
7177b3d3934dSBarry Smith       break;
7178b3d3934dSBarry Smith     }
7179b3d3934dSBarry Smith   }
7180b3d3934dSBarry Smith   PetscFunctionReturn(0);
7181b3d3934dSBarry Smith }
7182b3d3934dSBarry Smith 
7183b3d3934dSBarry Smith /*@C
7184b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
7185b3d3934dSBarry Smith 
7186b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
7187b3d3934dSBarry Smith 
7188b3d3934dSBarry Smith    Input Parameter:
7189b3d3934dSBarry Smith .  ctx - the monitor context
7190b3d3934dSBarry Smith 
7191b3d3934dSBarry Smith    Level: intermediate
7192b3d3934dSBarry Smith 
7193b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
7194b3d3934dSBarry Smith 
71957db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
7196b3d3934dSBarry Smith @*/
7197b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
7198b3d3934dSBarry Smith {
7199b3d3934dSBarry Smith   PetscErrorCode ierr;
7200b3d3934dSBarry Smith 
7201b3d3934dSBarry Smith   PetscFunctionBegin;
7202b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
7203b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
7204b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
7205b3d3934dSBarry Smith   PetscFunctionReturn(0);
7206b3d3934dSBarry Smith }
7207f2dee214SBarry Smith 
720824655328SShri /*@
7209dcb233daSLisandro Dalcin    TSRestartStep - Flags the solver to restart the next step
7210dcb233daSLisandro Dalcin 
7211dcb233daSLisandro Dalcin    Collective on TS
7212dcb233daSLisandro Dalcin 
7213dcb233daSLisandro Dalcin    Input Parameter:
7214dcb233daSLisandro Dalcin .  ts - the TS context obtained from TSCreate()
7215dcb233daSLisandro Dalcin 
7216dcb233daSLisandro Dalcin    Level: advanced
7217dcb233daSLisandro Dalcin 
7218dcb233daSLisandro Dalcin    Notes:
7219dcb233daSLisandro Dalcin    Multistep methods like BDF or Runge-Kutta methods with FSAL property require restarting the solver in the event of
7220dcb233daSLisandro Dalcin    discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
7221dcb233daSLisandro Dalcin    vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
7222dcb233daSLisandro Dalcin    the sake of correctness and maximum safety, users are expected to call TSRestart() whenever they introduce
7223dcb233daSLisandro Dalcin    discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
7224dcb233daSLisandro Dalcin    discontinuous source terms).
7225dcb233daSLisandro Dalcin 
7226dcb233daSLisandro Dalcin .keywords: TS, timestep, restart
7227dcb233daSLisandro Dalcin 
7228dcb233daSLisandro Dalcin .seealso: TSSolve(), TSSetPreStep(), TSSetPostStep()
7229dcb233daSLisandro Dalcin @*/
7230dcb233daSLisandro Dalcin PetscErrorCode TSRestartStep(TS ts)
7231dcb233daSLisandro Dalcin {
7232dcb233daSLisandro Dalcin   PetscFunctionBegin;
7233dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7234dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
7235dcb233daSLisandro Dalcin   PetscFunctionReturn(0);
7236dcb233daSLisandro Dalcin }
7237dcb233daSLisandro Dalcin 
7238dcb233daSLisandro Dalcin /*@
723924655328SShri    TSRollBack - Rolls back one time step
724024655328SShri 
724124655328SShri    Collective on TS
724224655328SShri 
724324655328SShri    Input Parameter:
724424655328SShri .  ts - the TS context obtained from TSCreate()
724524655328SShri 
724624655328SShri    Level: advanced
724724655328SShri 
724824655328SShri .keywords: TS, timestep, rollback
724924655328SShri 
725024655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
725124655328SShri @*/
725224655328SShri PetscErrorCode  TSRollBack(TS ts)
725324655328SShri {
725424655328SShri   PetscErrorCode ierr;
725524655328SShri 
725624655328SShri   PetscFunctionBegin;
725724655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7258b3de5cdeSLisandro Dalcin   if (ts->steprollback) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONGSTATE,"TSRollBack already called");
725924655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
726024655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
726124655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
726224655328SShri   ts->ptime = ts->ptime_prev;
7263be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
72642808aa04SLisandro Dalcin   ts->steps--;
7265b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
726624655328SShri   PetscFunctionReturn(0);
726724655328SShri }
7268aeb4809dSShri Abhyankar 
7269ff22ae23SHong Zhang /*@
7270ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
7271ff22ae23SHong Zhang 
7272ff22ae23SHong Zhang    Input Parameter:
7273ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
7274ff22ae23SHong Zhang 
7275ff22ae23SHong Zhang    Level: advanced
7276ff22ae23SHong Zhang 
7277ff22ae23SHong Zhang .keywords: TS, getstages
7278ff22ae23SHong Zhang 
7279ff22ae23SHong Zhang .seealso: TSCreate()
7280ff22ae23SHong Zhang @*/
7281ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns,Vec **Y)
7282ff22ae23SHong Zhang {
7283ff22ae23SHong Zhang   PetscErrorCode ierr;
7284ff22ae23SHong Zhang 
7285ff22ae23SHong Zhang   PetscFunctionBegin;
7286ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7287ff22ae23SHong Zhang   PetscValidPointer(ns,2);
7288ff22ae23SHong Zhang 
7289ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
7290ff22ae23SHong Zhang   else {
7291ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
7292ff22ae23SHong Zhang   }
7293ff22ae23SHong Zhang   PetscFunctionReturn(0);
7294ff22ae23SHong Zhang }
7295ff22ae23SHong Zhang 
7296847ff0e1SMatthew G. Knepley /*@C
7297847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
7298847ff0e1SMatthew G. Knepley 
7299847ff0e1SMatthew G. Knepley   Collective on SNES
7300847ff0e1SMatthew G. Knepley 
7301847ff0e1SMatthew G. Knepley   Input Parameters:
7302847ff0e1SMatthew G. Knepley + ts - the TS context
7303847ff0e1SMatthew G. Knepley . t - current timestep
7304847ff0e1SMatthew G. Knepley . U - state vector
7305847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
7306847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
7307847ff0e1SMatthew G. Knepley - ctx - an optional user context
7308847ff0e1SMatthew G. Knepley 
7309847ff0e1SMatthew G. Knepley   Output Parameters:
7310847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
7311847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
7312847ff0e1SMatthew G. Knepley 
7313847ff0e1SMatthew G. Knepley   Level: intermediate
7314847ff0e1SMatthew G. Knepley 
7315847ff0e1SMatthew G. Knepley   Notes:
7316847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
7317847ff0e1SMatthew G. Knepley 
7318847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
7319847ff0e1SMatthew G. Knepley 
7320847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
7321847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
7322847ff0e1SMatthew G. Knepley 
7323847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
7324847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
7325847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
7326847ff0e1SMatthew G. Knepley 
7327847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
7328847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
7329847ff0e1SMatthew G. Knepley @*/
7330847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
7331847ff0e1SMatthew G. Knepley {
7332847ff0e1SMatthew G. Knepley   SNES           snes;
7333847ff0e1SMatthew G. Knepley   MatFDColoring  color;
7334847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
7335847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
7336847ff0e1SMatthew G. Knepley 
7337847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
7338c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(((PetscObject)ts)->options,((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
7339847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
7340847ff0e1SMatthew G. Knepley   if (!color) {
7341847ff0e1SMatthew G. Knepley     DM         dm;
7342847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
7343847ff0e1SMatthew G. Knepley 
7344847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
7345847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
7346847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
7347847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
7348847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7349847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7350847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7351847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7352847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7353847ff0e1SMatthew G. Knepley     } else {
7354847ff0e1SMatthew G. Knepley       MatColoring mc;
7355847ff0e1SMatthew G. Knepley 
7356847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
7357847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
7358847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
7359847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
7360847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
7361847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
7362847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
7363847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
7364847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
7365847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
7366847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
7367847ff0e1SMatthew G. Knepley     }
7368847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
7369847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
7370847ff0e1SMatthew G. Knepley   }
7371847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
7372847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
7373847ff0e1SMatthew G. Knepley   if (J != B) {
7374847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7375847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
7376847ff0e1SMatthew G. Knepley   }
7377847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
7378847ff0e1SMatthew G. Knepley }
737993b34091SDebojyoti Ghosh 
7380cb9d8021SPierre Barbier de Reuille /*@
7381cb9d8021SPierre Barbier de Reuille     TSSetFunctionDomainError - Set the function testing if the current state vector is valid
7382cb9d8021SPierre Barbier de Reuille 
7383cb9d8021SPierre Barbier de Reuille     Input Parameters:
7384cb9d8021SPierre Barbier de Reuille     ts - the TS context
7385cb9d8021SPierre Barbier de Reuille     func - function called within TSFunctionDomainError
7386cb9d8021SPierre Barbier de Reuille 
7387cb9d8021SPierre Barbier de Reuille     Level: intermediate
7388cb9d8021SPierre Barbier de Reuille 
7389cb9d8021SPierre Barbier de Reuille .keywords: TS, state, domain
7390cb9d8021SPierre Barbier de Reuille .seealso: TSAdaptCheckStage(), TSFunctionDomainError()
7391cb9d8021SPierre Barbier de Reuille @*/
7392cb9d8021SPierre Barbier de Reuille 
7393d183316bSPierre Barbier de Reuille PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS,PetscReal,Vec,PetscBool*))
7394cb9d8021SPierre Barbier de Reuille {
7395cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7396cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
7397cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
7398cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7399cb9d8021SPierre Barbier de Reuille }
7400cb9d8021SPierre Barbier de Reuille 
7401cb9d8021SPierre Barbier de Reuille /*@
7402cb9d8021SPierre Barbier de Reuille     TSFunctionDomainError - Check if the current state is valid
7403cb9d8021SPierre Barbier de Reuille 
7404cb9d8021SPierre Barbier de Reuille     Input Parameters:
7405cb9d8021SPierre Barbier de Reuille     ts - the TS context
7406cb9d8021SPierre Barbier de Reuille     stagetime - time of the simulation
7407d183316bSPierre Barbier de Reuille     Y - state vector to check.
7408cb9d8021SPierre Barbier de Reuille 
7409cb9d8021SPierre Barbier de Reuille     Output Parameter:
7410cb9d8021SPierre Barbier de Reuille     accept - Set to PETSC_FALSE if the current state vector is valid.
7411cb9d8021SPierre Barbier de Reuille 
7412cb9d8021SPierre Barbier de Reuille     Note:
7413cb9d8021SPierre Barbier de Reuille     This function should be used to ensure the state is in a valid part of the space.
7414cb9d8021SPierre Barbier de Reuille     For example, one can ensure here all values are positive.
741596a0c994SBarry Smith 
741696a0c994SBarry Smith     Level: advanced
7417cb9d8021SPierre Barbier de Reuille @*/
7418d183316bSPierre Barbier de Reuille PetscErrorCode TSFunctionDomainError(TS ts,PetscReal stagetime,Vec Y,PetscBool* accept)
7419cb9d8021SPierre Barbier de Reuille {
7420cb9d8021SPierre Barbier de Reuille   PetscErrorCode ierr;
7421cb9d8021SPierre Barbier de Reuille 
7422cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
7423cb9d8021SPierre Barbier de Reuille 
7424cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7425cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
7426cb9d8021SPierre Barbier de Reuille   if (ts->functiondomainerror) {
7427d183316bSPierre Barbier de Reuille     PetscStackCallStandard((*ts->functiondomainerror),(ts,stagetime,Y,accept));
7428cb9d8021SPierre Barbier de Reuille   }
7429cb9d8021SPierre Barbier de Reuille   PetscFunctionReturn(0);
7430cb9d8021SPierre Barbier de Reuille }
74311ceb14c0SBarry Smith 
743293b34091SDebojyoti Ghosh /*@C
7433e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
743493b34091SDebojyoti Ghosh 
743593b34091SDebojyoti Ghosh   Collective on MPI_Comm
743693b34091SDebojyoti Ghosh 
743793b34091SDebojyoti Ghosh   Input Parameter:
743893b34091SDebojyoti Ghosh . tsin    - The input TS
743993b34091SDebojyoti Ghosh 
744093b34091SDebojyoti Ghosh   Output Parameter:
7441e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
744293b34091SDebojyoti Ghosh 
74435eca1a21SEmil Constantinescu   Notes:
74445eca1a21SEmil 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.
74455eca1a21SEmil Constantinescu 
7446928bb9adSStefano Zampini   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); TSSetSNES(ts,snes_dup);
74475eca1a21SEmil Constantinescu 
74485eca1a21SEmil Constantinescu   Level: developer
744993b34091SDebojyoti Ghosh 
7450e5168f73SEmil Constantinescu .keywords: TS, clone
7451e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
745293b34091SDebojyoti Ghosh @*/
7453baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
745493b34091SDebojyoti Ghosh {
745593b34091SDebojyoti Ghosh   TS             t;
745693b34091SDebojyoti Ghosh   PetscErrorCode ierr;
7457dc846ba4SSatish Balay   SNES           snes_start;
7458dc846ba4SSatish Balay   DM             dm;
7459dc846ba4SSatish Balay   TSType         type;
746093b34091SDebojyoti Ghosh 
746193b34091SDebojyoti Ghosh   PetscFunctionBegin;
746293b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
746393b34091SDebojyoti Ghosh   *tsout = NULL;
746493b34091SDebojyoti Ghosh 
74657a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
746693b34091SDebojyoti Ghosh 
746793b34091SDebojyoti Ghosh   /* General TS description */
746893b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
746993b34091SDebojyoti Ghosh   t->setupcalled       = 0;
747093b34091SDebojyoti Ghosh   t->ksp_its           = 0;
747193b34091SDebojyoti Ghosh   t->snes_its          = 0;
747293b34091SDebojyoti Ghosh   t->nwork             = 0;
747393b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
747493b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
747593b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
747693b34091SDebojyoti Ghosh 
747734561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);CHKERRQ(ierr);
747834561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);CHKERRQ(ierr);
7479d15a3a53SEmil Constantinescu 
748093b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);CHKERRQ(ierr);
748193b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);CHKERRQ(ierr);
748293b34091SDebojyoti Ghosh 
748393b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
748451699248SLisandro Dalcin   ierr = PetscObjectReference((PetscObject)t->adapt);CHKERRQ(ierr);
748593b34091SDebojyoti Ghosh 
7486e7069c78SShri   t->trajectory = tsin->trajectory;
7487e7069c78SShri   ierr = PetscObjectReference((PetscObject)t->trajectory);CHKERRQ(ierr);
7488e7069c78SShri 
7489e7069c78SShri   t->event = tsin->event;
74906b10a48eSSatish Balay   if (t->event) t->event->refct++;
7491e7069c78SShri 
749293b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
749393b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
7494e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
749593b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
749693b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
749793b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
749893b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
749993b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
750093b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
750193b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
750293b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
750393b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
750493b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
750593b34091SDebojyoti Ghosh 
750693b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type);CHKERRQ(ierr);
750793b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);CHKERRQ(ierr);
750893b34091SDebojyoti Ghosh 
750993b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
751093b34091SDebojyoti Ghosh 
751193b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
751293b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
751393b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
751493b34091SDebojyoti Ghosh 
751593b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
751693b34091SDebojyoti Ghosh 
75170d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
75180d4fed19SBarry Smith     PetscInt i;
75190d4fed19SBarry Smith     ierr = PetscMalloc((10)*sizeof(void(*)(void)),&((PetscObject)t)->fortran_func_pointers);CHKERRQ(ierr);
75200d4fed19SBarry Smith     for (i=0; i<10; i++) {
75210d4fed19SBarry Smith       ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
75220d4fed19SBarry Smith     }
75230d4fed19SBarry Smith   }
752493b34091SDebojyoti Ghosh   *tsout = t;
752593b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
752693b34091SDebojyoti Ghosh }
7527f3b1f45cSBarry Smith 
7528f3b1f45cSBarry Smith static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void* ctx,Vec x,Vec y)
7529f3b1f45cSBarry Smith {
7530f3b1f45cSBarry Smith   PetscErrorCode ierr;
7531f3b1f45cSBarry Smith   TS             ts = (TS) ctx;
7532f3b1f45cSBarry Smith 
7533f3b1f45cSBarry Smith   PetscFunctionBegin;
7534f3b1f45cSBarry Smith   ierr = TSComputeRHSFunction(ts,0,x,y);CHKERRQ(ierr);
7535f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7536f3b1f45cSBarry Smith }
7537f3b1f45cSBarry Smith 
7538f3b1f45cSBarry Smith /*@
7539f3b1f45cSBarry Smith     TSRHSJacobianTest - Compares the multiply routine provided to the MATSHELL with differencing on the TS given RHS function.
7540f3b1f45cSBarry Smith 
7541f3b1f45cSBarry Smith    Logically Collective on TS and Mat
7542f3b1f45cSBarry Smith 
7543f3b1f45cSBarry Smith     Input Parameters:
7544f3b1f45cSBarry Smith     TS - the time stepping routine
7545f3b1f45cSBarry Smith 
7546f3b1f45cSBarry Smith    Output Parameter:
7547f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7548f3b1f45cSBarry Smith 
7549f3b1f45cSBarry Smith    Options Database:
7550f3b1f45cSBarry Smith  .   -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
7551f3b1f45cSBarry Smith 
7552f3b1f45cSBarry Smith    Level: advanced
7553f3b1f45cSBarry Smith 
755495452b02SPatrick Sanan    Notes:
755595452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7556f3b1f45cSBarry Smith 
7557f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTestTranspose()
7558f3b1f45cSBarry Smith @*/
7559f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTest(TS ts,PetscBool *flg)
7560f3b1f45cSBarry Smith {
7561f3b1f45cSBarry Smith   Mat            J,B;
7562f3b1f45cSBarry Smith   PetscErrorCode ierr;
7563f3b1f45cSBarry Smith   TSRHSJacobian  func;
7564f3b1f45cSBarry Smith   void*          ctx;
7565f3b1f45cSBarry Smith 
7566f3b1f45cSBarry Smith   PetscFunctionBegin;
7567f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7568f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7569f3b1f45cSBarry Smith   ierr = MatShellTestMult(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7570f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7571f3b1f45cSBarry Smith }
7572f3b1f45cSBarry Smith 
7573f3b1f45cSBarry Smith /*@C
7574f3b1f45cSBarry Smith     TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the MATSHELL with differencing on the TS given RHS function.
7575f3b1f45cSBarry Smith 
7576f3b1f45cSBarry Smith    Logically Collective on TS and Mat
7577f3b1f45cSBarry Smith 
7578f3b1f45cSBarry Smith     Input Parameters:
7579f3b1f45cSBarry Smith     TS - the time stepping routine
7580f3b1f45cSBarry Smith 
7581f3b1f45cSBarry Smith    Output Parameter:
7582f3b1f45cSBarry Smith .   flg - PETSC_TRUE if the multiply is likely correct
7583f3b1f45cSBarry Smith 
7584f3b1f45cSBarry Smith    Options Database:
7585f3b1f45cSBarry Smith .   -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
7586f3b1f45cSBarry Smith 
758795452b02SPatrick Sanan    Notes:
758895452b02SPatrick Sanan     This only works for problems defined only the RHS function and Jacobian NOT IFunction and IJacobian
7589f3b1f45cSBarry Smith 
7590f3b1f45cSBarry Smith    Level: advanced
7591f3b1f45cSBarry Smith 
7592f3b1f45cSBarry Smith .seealso: MatCreateShell(), MatShellGetContext(), MatShellGetOperation(), MatShellTestMultTranspose(), TSRHSJacobianTest()
7593f3b1f45cSBarry Smith @*/
7594f3b1f45cSBarry Smith PetscErrorCode  TSRHSJacobianTestTranspose(TS ts,PetscBool *flg)
7595f3b1f45cSBarry Smith {
7596f3b1f45cSBarry Smith   Mat            J,B;
7597f3b1f45cSBarry Smith   PetscErrorCode ierr;
7598f3b1f45cSBarry Smith   void           *ctx;
7599f3b1f45cSBarry Smith   TSRHSJacobian  func;
7600f3b1f45cSBarry Smith 
7601f3b1f45cSBarry Smith   PetscFunctionBegin;
7602f3b1f45cSBarry Smith   ierr = TSGetRHSJacobian(ts,&J,&B,&func,&ctx);CHKERRQ(ierr);
7603f3b1f45cSBarry Smith   ierr = (*func)(ts,0.0,ts->vec_sol,J,B,ctx);CHKERRQ(ierr);
7604f3b1f45cSBarry Smith   ierr = MatShellTestMultTranspose(J,RHSWrapperFunction_TSRHSJacobianTest,ts->vec_sol,ts,flg);CHKERRQ(ierr);
7605f3b1f45cSBarry Smith   PetscFunctionReturn(0);
7606f3b1f45cSBarry Smith }
7607