xref: /petsc/src/ts/interface/ts.c (revision 27829d713138cf416b29c88583fe2f9d07b4113a)
163dd3a1aSKris Buschelman 
2b45d2f2cSJed Brown #include <petsc-private/tsimpl.h>        /*I "petscts.h"  I*/
3496e6a7aSJed Brown #include <petscdmshell.h>
41e25c274SJed Brown #include <petscdmda.h>
52d5ee99bSBarry Smith #include <petscviewer.h>
62d5ee99bSBarry Smith #include <petscdraw.h>
7d763cef2SBarry Smith 
8d5ba7fb7SMatthew Knepley /* Logging support */
9d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
10166c7f25SBarry Smith PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
11d405a339SMatthew Knepley 
1249354f04SShri Abhyankar const char *const TSExactFinalTimeOptions[] = {"STEPOVER","INTERPOLATE","MATCHSTEP","TSExactFinalTimeOption","TS_EXACTFINALTIME_",0};
1349354f04SShri Abhyankar 
144a2ae208SSatish Balay #undef __FUNCT__
15e55864a3SBarry Smith #define __FUNCT__ "TSSetTypeFromOptions_Private"
16bdad233fSMatthew Knepley /*
17bdad233fSMatthew Knepley   TSSetTypeFromOptions - Sets the type of ts from user options.
18bdad233fSMatthew Knepley 
19bdad233fSMatthew Knepley   Collective on TS
20bdad233fSMatthew Knepley 
21bdad233fSMatthew Knepley   Input Parameter:
22bdad233fSMatthew Knepley . ts - The ts
23bdad233fSMatthew Knepley 
24bdad233fSMatthew Knepley   Level: intermediate
25bdad233fSMatthew Knepley 
26bdad233fSMatthew Knepley .keywords: TS, set, options, database, type
27bdad233fSMatthew Knepley .seealso: TSSetFromOptions(), TSSetType()
28bdad233fSMatthew Knepley */
298c34d3f5SBarry Smith static PetscErrorCode TSSetTypeFromOptions_Private(PetscOptions *PetscOptionsObject,TS ts)
30bdad233fSMatthew Knepley {
31ace3abfcSBarry Smith   PetscBool      opt;
322fc52814SBarry Smith   const char     *defaultType;
33bdad233fSMatthew Knepley   char           typeName[256];
34dfbe8321SBarry Smith   PetscErrorCode ierr;
35bdad233fSMatthew Knepley 
36bdad233fSMatthew Knepley   PetscFunctionBegin;
37bbd56ea5SKarl Rupp   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
38bbd56ea5SKarl Rupp   else defaultType = TSEULER;
39bdad233fSMatthew Knepley 
40607a6623SBarry Smith   if (!TSRegisterAllCalled) {ierr = TSRegisterAll();CHKERRQ(ierr);}
41a264d7a6SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
42a7cc72afSBarry Smith   if (opt) {
43bdad233fSMatthew Knepley     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
44bdad233fSMatthew Knepley   } else {
45bdad233fSMatthew Knepley     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
46bdad233fSMatthew Knepley   }
47bdad233fSMatthew Knepley   PetscFunctionReturn(0);
48bdad233fSMatthew Knepley }
49bdad233fSMatthew Knepley 
502d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
512d5ee99bSBarry Smith   PetscViewer   viewer;
524b363babSBarry Smith   PetscDrawAxis axis;
532d5ee99bSBarry Smith   Vec           initialsolution;
542d5ee99bSBarry Smith   PetscBool     showinitial;
552d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
562d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
572d5ee99bSBarry Smith   int           color;
582d5ee99bSBarry Smith };
592d5ee99bSBarry Smith 
60bdad233fSMatthew Knepley #undef __FUNCT__
61bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
62bdad233fSMatthew Knepley /*@
63bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
64bdad233fSMatthew Knepley 
65bdad233fSMatthew Knepley    Collective on TS
66bdad233fSMatthew Knepley 
67bdad233fSMatthew Knepley    Input Parameter:
68bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
69bdad233fSMatthew Knepley 
70bdad233fSMatthew Knepley    Options Database Keys:
714d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
72bdad233fSMatthew Knepley .  -ts_max_steps maxsteps - maximum number of time-steps to take
733bca7d26SBarry Smith .  -ts_final_time time - maximum time to compute to
74bdad233fSMatthew Knepley .  -ts_dt dt - initial time step
75a3cdaa26SBarry 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
76a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
77a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
78a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
79a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
80a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
81bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
82de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
83de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
84de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
85de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
86de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
87de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
88de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
892d5ee99bSBarry Smith .  -ts_monitor_draw_solution_phase - Monitor solution graphically with phase diagram
90de06c3feSJed Brown .  -ts_monitor_draw_error - Monitor error graphically
9191b97e58SBarry Smith .  -ts_monitor_solution_binary <filename> - Save each solution to a binary file
9291b97e58SBarry Smith -  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
9391b97e58SBarry Smith 
9491b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
95bdad233fSMatthew Knepley 
96bdad233fSMatthew Knepley    Level: beginner
97bdad233fSMatthew Knepley 
98bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
99bdad233fSMatthew Knepley 
100a313700dSBarry Smith .seealso: TSGetType()
101bdad233fSMatthew Knepley @*/
1027087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
103bdad233fSMatthew Knepley {
104ace3abfcSBarry Smith   PetscBool              opt,flg;
105dfbe8321SBarry Smith   PetscErrorCode         ierr;
106649052a6SBarry Smith   PetscViewer            monviewer;
107eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
108089b2837SJed Brown   SNES                   snes;
1091c3436cfSJed Brown   TSAdapt                adapt;
11031748224SBarry Smith   PetscReal              time_step;
11149354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
112d1212d36SBarry Smith   char                   dir[16];
113bdad233fSMatthew Knepley 
114bdad233fSMatthew Knepley   PetscFunctionBegin;
1150700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1163194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
117a43b19c4SJed Brown   /* Handle TS type options */
118e55864a3SBarry Smith   ierr = TSSetTypeFromOptions_Private(PetscOptionsObject,ts);CHKERRQ(ierr);
119bdad233fSMatthew Knepley 
120bdad233fSMatthew Knepley   /* Handle generic TS options */
1210298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1220298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1230298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
12431748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
12531748224SBarry Smith   if (flg) {
12631748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
12731748224SBarry Smith   }
12849354f04SShri 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);
12949354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1300298fd71SBarry 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);
1310298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1320298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1330298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1340298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
135bdad233fSMatthew Knepley 
13656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
13756f85f32SBarry Smith   {
13856f85f32SBarry Smith   PetscBool set;
13956f85f32SBarry Smith   flg  = PETSC_FALSE;
14056f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
14156f85f32SBarry Smith   if (set) {
14256f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
14356f85f32SBarry Smith   }
14456f85f32SBarry Smith   }
14556f85f32SBarry Smith #endif
14656f85f32SBarry Smith 
147bdad233fSMatthew Knepley   /* Monitor options */
148a6570f20SBarry Smith   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
149eabae89aSBarry Smith   if (flg) {
150ce94432eSBarry Smith     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
151649052a6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
152bdad233fSMatthew Knepley   }
1535180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1545180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1555180491cSLisandro Dalcin 
1564f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
157a7cc72afSBarry Smith   if (opt) {
1580b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1593923b477SBarry Smith     PetscInt       howoften = 1;
160a80ad3e0SBarry Smith 
1610298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
162ce94432eSBarry Smith     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1634f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
164b3603a34SBarry Smith   }
1654f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
166b3603a34SBarry Smith   if (opt) {
1670b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1683923b477SBarry Smith     PetscInt       howoften = 1;
169b3603a34SBarry Smith 
1700298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
17122d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1724f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
173bdad233fSMatthew Knepley   }
1744f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
175ef20d060SBarry Smith   if (opt) {
1760b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1773923b477SBarry Smith     PetscInt       howoften = 1;
178ef20d060SBarry Smith 
1790298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
18022d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1814f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
182ef20d060SBarry Smith   }
183201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
184201da799SBarry Smith   if (opt) {
185201da799SBarry Smith     TSMonitorLGCtx ctx;
186201da799SBarry Smith     PetscInt       howoften = 1;
187201da799SBarry Smith 
1880298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
18922d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
190201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
191201da799SBarry Smith   }
192201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
193201da799SBarry Smith   if (opt) {
194201da799SBarry Smith     TSMonitorLGCtx ctx;
195201da799SBarry Smith     PetscInt       howoften = 1;
196201da799SBarry Smith 
1970298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
19822d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
199201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
200201da799SBarry Smith   }
2018189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2028189c53fSBarry Smith   if (opt) {
2038189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2048189c53fSBarry Smith     PetscInt          howoften = 1;
2058189c53fSBarry Smith 
2060298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
20722d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2088189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2098189c53fSBarry Smith   }
210ef20d060SBarry Smith   opt  = PETSC_FALSE;
2110dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
212a7cc72afSBarry Smith   if (opt) {
21383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
21483a4ac43SBarry Smith     PetscInt         howoften = 1;
215a80ad3e0SBarry Smith 
2160298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
217ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
21883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
219bdad233fSMatthew Knepley   }
220fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2212d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2222d5ee99bSBarry Smith   if (opt) {
2232d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2242d5ee99bSBarry Smith     PetscReal        bounds[4];
2252d5ee99bSBarry Smith     PetscInt         n = 4;
2262d5ee99bSBarry Smith     PetscDraw        draw;
2272d5ee99bSBarry Smith 
2282d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2292d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2302d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
2312d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2322d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
2334b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
2344b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
235f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2364b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
23707995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
2382d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2392d5ee99bSBarry Smith   }
2402d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2410dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2423a471f94SBarry Smith   if (opt) {
24383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
24483a4ac43SBarry Smith     PetscInt         howoften = 1;
2453a471f94SBarry Smith 
2460298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
247ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
24883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2493a471f94SBarry Smith   }
2503a471f94SBarry Smith   opt  = PETSC_FALSE;
25191b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
252fb1732b5SBarry Smith   if (flg) {
253fb1732b5SBarry Smith     PetscViewer ctx;
254fb1732b5SBarry Smith     if (monfilename[0]) {
255ce94432eSBarry Smith       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
256c2fbc07fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
257fb1732b5SBarry Smith     } else {
258ce94432eSBarry Smith       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
2590298fd71SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
260fb1732b5SBarry Smith     }
261fb1732b5SBarry Smith   }
262ed81e22dSJed Brown   opt  = PETSC_FALSE;
26391b97e58SBarry 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);
264ed81e22dSJed Brown   if (flg) {
265ed81e22dSJed Brown     const char *ptr,*ptr2;
266ed81e22dSJed Brown     char       *filetemplate;
267ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
268ed81e22dSJed Brown     /* Do some cursory validation of the input. */
269ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
270ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
271ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
272ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
273ce94432eSBarry 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");
274ed81e22dSJed Brown       if (ptr2) break;
275ed81e22dSJed Brown     }
276ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
277ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
278ed81e22dSJed Brown   }
279bdad233fSMatthew Knepley 
280d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
281d1212d36SBarry Smith   if (flg) {
282d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
283d1212d36SBarry Smith     int                  ray = 0;
284d1212d36SBarry Smith     DMDADirection        ddir;
285d1212d36SBarry Smith     DM                   da;
286d1212d36SBarry Smith     PetscMPIInt          rank;
287d1212d36SBarry Smith 
288ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
289d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
290d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
291ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
292d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
293d1212d36SBarry Smith 
294d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
295b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
296d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
297d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
298ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
299d1212d36SBarry Smith     if (!rank) {
300d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
301d1212d36SBarry Smith     }
30251b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
303d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
304d1212d36SBarry Smith   }
30551b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
30651b4a12fSMatthew G. Knepley   if (flg) {
30751b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
30851b4a12fSMatthew G. Knepley     int                 ray = 0;
30951b4a12fSMatthew G. Knepley     DMDADirection       ddir;
31051b4a12fSMatthew G. Knepley     DM                  da;
31151b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
312d1212d36SBarry Smith 
31351b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
31451b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
31551b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
31651b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
31751b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
31851b4a12fSMatthew G. Knepley 
31951b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
320b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
32151b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
32251b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
32351b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
32451b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
32551b4a12fSMatthew G. Knepley   }
326a7a1495cSBarry Smith 
3277781c08eSBarry Smith   /*
3287781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
3297781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
3307781c08eSBarry Smith   */
331552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
332e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
333d763cef2SBarry Smith 
334d763cef2SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
335d763cef2SBarry Smith   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
336d763cef2SBarry Smith 
337d763cef2SBarry Smith   /* Handle specific TS options */
338d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
339e55864a3SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
340d763cef2SBarry Smith   }
341d763cef2SBarry Smith 
342d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
343d763cef2SBarry Smith   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
344d763cef2SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
345d763cef2SBarry Smith   PetscFunctionReturn(0);
346d763cef2SBarry Smith }
347d763cef2SBarry Smith 
348d763cef2SBarry Smith #undef __FUNCT__
349a7a1495cSBarry Smith #undef __FUNCT__
350a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
351a7a1495cSBarry Smith /*@
352a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
353a7a1495cSBarry Smith       set with TSSetRHSJacobian().
354a7a1495cSBarry Smith 
355a7a1495cSBarry Smith    Collective on TS and Vec
356a7a1495cSBarry Smith 
357a7a1495cSBarry Smith    Input Parameters:
358316643e7SJed Brown +  ts - the TS context
359a7a1495cSBarry Smith .  t - current timestep
3600910c330SBarry Smith -  U - input vector
361a7a1495cSBarry Smith 
362a7a1495cSBarry Smith    Output Parameters:
363a7a1495cSBarry Smith +  A - Jacobian matrix
364a7a1495cSBarry Smith .  B - optional preconditioning matrix
365a7a1495cSBarry Smith -  flag - flag indicating matrix structure
366a7a1495cSBarry Smith 
367a7a1495cSBarry Smith    Notes:
368a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
369a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
370a7a1495cSBarry Smith 
37194b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
372a7a1495cSBarry Smith    flag parameter.
373a7a1495cSBarry Smith 
374a7a1495cSBarry Smith    Level: developer
375a7a1495cSBarry Smith 
376a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
377a7a1495cSBarry Smith 
37894b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
379a7a1495cSBarry Smith @*/
380d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
381a7a1495cSBarry Smith {
382dfbe8321SBarry Smith   PetscErrorCode ierr;
383270bf2e7SJed Brown   PetscObjectState Ustate;
38424989b8cSPeter Brune   DM             dm;
385942e3340SBarry Smith   DMTS           tsdm;
38624989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
38724989b8cSPeter Brune   void           *ctx;
38824989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
389a7a1495cSBarry Smith 
390a7a1495cSBarry Smith   PetscFunctionBegin;
3910700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3920910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3930910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
39424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
395942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
39624989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
3970298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
39859e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
3990910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4000e4ef248SJed Brown     PetscFunctionReturn(0);
401f8ede8e7SJed Brown   }
402d90be118SSean Farley 
403ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
404d90be118SSean Farley 
405e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
40694ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
40794ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
40894ab13aaSBarry Smith     if (A != B) {
40994ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
41094ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
411e1244c69SJed Brown     }
412e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
413e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
414e1244c69SJed Brown   }
415e1244c69SJed Brown 
41624989b8cSPeter Brune   if (rhsjacobianfunc) {
41794ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
418a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
419d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
420a7a1495cSBarry Smith     PetscStackPop;
42194ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
422a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
42394ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
42494ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
425ef66eb69SBarry Smith   } else {
42694ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
42794ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
428ef66eb69SBarry Smith   }
4290e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4300910c330SBarry Smith   ts->rhsjacobian.X          = U;
43159e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
432a7a1495cSBarry Smith   PetscFunctionReturn(0);
433a7a1495cSBarry Smith }
434a7a1495cSBarry Smith 
4354a2ae208SSatish Balay #undef __FUNCT__
4364a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
437316643e7SJed Brown /*@
438d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
439d763cef2SBarry Smith 
440316643e7SJed Brown    Collective on TS and Vec
441316643e7SJed Brown 
442316643e7SJed Brown    Input Parameters:
443316643e7SJed Brown +  ts - the TS context
444316643e7SJed Brown .  t - current time
4450910c330SBarry Smith -  U - state vector
446316643e7SJed Brown 
447316643e7SJed Brown    Output Parameter:
448316643e7SJed Brown .  y - right hand side
449316643e7SJed Brown 
450316643e7SJed Brown    Note:
451316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
452316643e7SJed Brown    is used internally within the nonlinear solvers.
453316643e7SJed Brown 
454316643e7SJed Brown    Level: developer
455316643e7SJed Brown 
456316643e7SJed Brown .keywords: TS, compute
457316643e7SJed Brown 
458316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
459316643e7SJed Brown @*/
4600910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
461d763cef2SBarry Smith {
462dfbe8321SBarry Smith   PetscErrorCode ierr;
46324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
46424989b8cSPeter Brune   TSIFunction    ifunction;
46524989b8cSPeter Brune   void           *ctx;
46624989b8cSPeter Brune   DM             dm;
46724989b8cSPeter Brune 
468d763cef2SBarry Smith   PetscFunctionBegin;
4690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4700910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4710700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
47224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
47324989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
4740298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
475d763cef2SBarry Smith 
476ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
477d763cef2SBarry Smith 
4780910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
47924989b8cSPeter Brune   if (rhsfunction) {
480d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
4810910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
482d763cef2SBarry Smith     PetscStackPop;
483214bc6a2SJed Brown   } else {
484214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
485b2cd27e8SJed Brown   }
48644a41b28SSean Farley 
4870910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
488d763cef2SBarry Smith   PetscFunctionReturn(0);
489d763cef2SBarry Smith }
490d763cef2SBarry Smith 
4914a2ae208SSatish Balay #undef __FUNCT__
492ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
493ef20d060SBarry Smith /*@
494ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
495ef20d060SBarry Smith 
496ef20d060SBarry Smith    Collective on TS and Vec
497ef20d060SBarry Smith 
498ef20d060SBarry Smith    Input Parameters:
499ef20d060SBarry Smith +  ts - the TS context
500ef20d060SBarry Smith -  t - current time
501ef20d060SBarry Smith 
502ef20d060SBarry Smith    Output Parameter:
5030910c330SBarry Smith .  U - the solution
504ef20d060SBarry Smith 
505ef20d060SBarry Smith    Note:
506ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
507ef20d060SBarry Smith    is used internally within the nonlinear solvers.
508ef20d060SBarry Smith 
509ef20d060SBarry Smith    Level: developer
510ef20d060SBarry Smith 
511ef20d060SBarry Smith .keywords: TS, compute
512ef20d060SBarry Smith 
513abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
514ef20d060SBarry Smith @*/
5150910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
516ef20d060SBarry Smith {
517ef20d060SBarry Smith   PetscErrorCode     ierr;
518ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
519ef20d060SBarry Smith   void               *ctx;
520ef20d060SBarry Smith   DM                 dm;
521ef20d060SBarry Smith 
522ef20d060SBarry Smith   PetscFunctionBegin;
523ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5240910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
525ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
526ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
527ef20d060SBarry Smith 
528ef20d060SBarry Smith   if (solutionfunction) {
5299b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5300910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
531ef20d060SBarry Smith     PetscStackPop;
532ef20d060SBarry Smith   }
533ef20d060SBarry Smith   PetscFunctionReturn(0);
534ef20d060SBarry Smith }
5359b7cd975SBarry Smith #undef __FUNCT__
5369b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5379b7cd975SBarry Smith /*@
5389b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5399b7cd975SBarry Smith 
5409b7cd975SBarry Smith    Collective on TS and Vec
5419b7cd975SBarry Smith 
5429b7cd975SBarry Smith    Input Parameters:
5439b7cd975SBarry Smith +  ts - the TS context
5449b7cd975SBarry Smith -  t - current time
5459b7cd975SBarry Smith 
5469b7cd975SBarry Smith    Output Parameter:
5479b7cd975SBarry Smith .  U - the function value
5489b7cd975SBarry Smith 
5499b7cd975SBarry Smith    Note:
5509b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
5519b7cd975SBarry Smith    is used internally within the nonlinear solvers.
5529b7cd975SBarry Smith 
5539b7cd975SBarry Smith    Level: developer
5549b7cd975SBarry Smith 
5559b7cd975SBarry Smith .keywords: TS, compute
5569b7cd975SBarry Smith 
5579b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
5589b7cd975SBarry Smith @*/
5599b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
5609b7cd975SBarry Smith {
5619b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
5629b7cd975SBarry Smith   void               *ctx;
5639b7cd975SBarry Smith   DM                 dm;
5649b7cd975SBarry Smith 
5659b7cd975SBarry Smith   PetscFunctionBegin;
5669b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5679b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5689b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
5699b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
5709b7cd975SBarry Smith 
5719b7cd975SBarry Smith   if (forcing) {
5729b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
5739b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
5749b7cd975SBarry Smith     PetscStackPop;
5759b7cd975SBarry Smith   }
5769b7cd975SBarry Smith   PetscFunctionReturn(0);
5779b7cd975SBarry Smith }
578ef20d060SBarry Smith 
579ef20d060SBarry Smith #undef __FUNCT__
580214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
581214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
582214bc6a2SJed Brown {
5832dd45cf8SJed Brown   Vec            F;
584214bc6a2SJed Brown   PetscErrorCode ierr;
585214bc6a2SJed Brown 
586214bc6a2SJed Brown   PetscFunctionBegin;
5870298fd71SBarry Smith   *Frhs = NULL;
5880298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
589214bc6a2SJed Brown   if (!ts->Frhs) {
5902dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
591214bc6a2SJed Brown   }
592214bc6a2SJed Brown   *Frhs = ts->Frhs;
593214bc6a2SJed Brown   PetscFunctionReturn(0);
594214bc6a2SJed Brown }
595214bc6a2SJed Brown 
596214bc6a2SJed Brown #undef __FUNCT__
597214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
598214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
599214bc6a2SJed Brown {
600214bc6a2SJed Brown   Mat            A,B;
6012dd45cf8SJed Brown   PetscErrorCode ierr;
602214bc6a2SJed Brown 
603214bc6a2SJed Brown   PetscFunctionBegin;
604c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
605c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6060298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
607214bc6a2SJed Brown   if (Arhs) {
608214bc6a2SJed Brown     if (!ts->Arhs) {
609214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
610214bc6a2SJed Brown     }
611214bc6a2SJed Brown     *Arhs = ts->Arhs;
612214bc6a2SJed Brown   }
613214bc6a2SJed Brown   if (Brhs) {
614214bc6a2SJed Brown     if (!ts->Brhs) {
615bdb70873SJed Brown       if (A != B) {
616214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
617bdb70873SJed Brown       } else {
618bdb70873SJed Brown         ts->Brhs = ts->Arhs;
619bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
620bdb70873SJed Brown       }
621214bc6a2SJed Brown     }
622214bc6a2SJed Brown     *Brhs = ts->Brhs;
623214bc6a2SJed Brown   }
624214bc6a2SJed Brown   PetscFunctionReturn(0);
625214bc6a2SJed Brown }
626214bc6a2SJed Brown 
627214bc6a2SJed Brown #undef __FUNCT__
628316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
629316643e7SJed Brown /*@
6300910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
631316643e7SJed Brown 
632316643e7SJed Brown    Collective on TS and Vec
633316643e7SJed Brown 
634316643e7SJed Brown    Input Parameters:
635316643e7SJed Brown +  ts - the TS context
636316643e7SJed Brown .  t - current time
6370910c330SBarry Smith .  U - state vector
6380910c330SBarry Smith .  Udot - time derivative of state vector
639214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
640316643e7SJed Brown 
641316643e7SJed Brown    Output Parameter:
642316643e7SJed Brown .  Y - right hand side
643316643e7SJed Brown 
644316643e7SJed Brown    Note:
645316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
646316643e7SJed Brown    is used internally within the nonlinear solvers.
647316643e7SJed Brown 
648316643e7SJed Brown    If the user did did not write their equations in implicit form, this
649316643e7SJed Brown    function recasts them in implicit form.
650316643e7SJed Brown 
651316643e7SJed Brown    Level: developer
652316643e7SJed Brown 
653316643e7SJed Brown .keywords: TS, compute
654316643e7SJed Brown 
655316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
656316643e7SJed Brown @*/
6570910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
658316643e7SJed Brown {
659316643e7SJed Brown   PetscErrorCode ierr;
66024989b8cSPeter Brune   TSIFunction    ifunction;
66124989b8cSPeter Brune   TSRHSFunction  rhsfunction;
66224989b8cSPeter Brune   void           *ctx;
66324989b8cSPeter Brune   DM             dm;
664316643e7SJed Brown 
665316643e7SJed Brown   PetscFunctionBegin;
6660700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6670910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6680910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
6690700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
670316643e7SJed Brown 
67124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
67224989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
6730298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
67424989b8cSPeter Brune 
675ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
676d90be118SSean Farley 
6770910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
67824989b8cSPeter Brune   if (ifunction) {
679316643e7SJed Brown     PetscStackPush("TS user implicit function");
6800910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
681316643e7SJed Brown     PetscStackPop;
682214bc6a2SJed Brown   }
683214bc6a2SJed Brown   if (imex) {
68424989b8cSPeter Brune     if (!ifunction) {
6850910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
6862dd45cf8SJed Brown     }
68724989b8cSPeter Brune   } else if (rhsfunction) {
68824989b8cSPeter Brune     if (ifunction) {
689214bc6a2SJed Brown       Vec Frhs;
690214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
6910910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
692214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
6932dd45cf8SJed Brown     } else {
6940910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
6950910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
696316643e7SJed Brown     }
6974a6899ffSJed Brown   }
6980910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
699316643e7SJed Brown   PetscFunctionReturn(0);
700316643e7SJed Brown }
701316643e7SJed Brown 
702316643e7SJed Brown #undef __FUNCT__
703316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
704316643e7SJed Brown /*@
705316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
706316643e7SJed Brown 
707316643e7SJed Brown    Collective on TS and Vec
708316643e7SJed Brown 
709316643e7SJed Brown    Input
710316643e7SJed Brown       Input Parameters:
711316643e7SJed Brown +  ts - the TS context
712316643e7SJed Brown .  t - current timestep
7130910c330SBarry Smith .  U - state vector
7140910c330SBarry Smith .  Udot - time derivative of state vector
715214bc6a2SJed Brown .  shift - shift to apply, see note below
716214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
717316643e7SJed Brown 
718316643e7SJed Brown    Output Parameters:
719316643e7SJed Brown +  A - Jacobian matrix
720316643e7SJed Brown .  B - optional preconditioning matrix
721316643e7SJed Brown -  flag - flag indicating matrix structure
722316643e7SJed Brown 
723316643e7SJed Brown    Notes:
7240910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
725316643e7SJed Brown 
7260910c330SBarry Smith    dF/dU + shift*dF/dUdot
727316643e7SJed Brown 
728316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
729316643e7SJed Brown    is used internally within the nonlinear solvers.
730316643e7SJed Brown 
731316643e7SJed Brown    Level: developer
732316643e7SJed Brown 
733316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
734316643e7SJed Brown 
735316643e7SJed Brown .seealso:  TSSetIJacobian()
73663495f91SJed Brown @*/
737d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
738316643e7SJed Brown {
739316643e7SJed Brown   PetscErrorCode ierr;
74024989b8cSPeter Brune   TSIJacobian    ijacobian;
74124989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
74224989b8cSPeter Brune   DM             dm;
74324989b8cSPeter Brune   void           *ctx;
744316643e7SJed Brown 
745316643e7SJed Brown   PetscFunctionBegin;
7460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7470910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7480910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
749316643e7SJed Brown   PetscValidPointer(A,6);
75094ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
751316643e7SJed Brown   PetscValidPointer(B,7);
75294ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
75324989b8cSPeter Brune 
75424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
75524989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
7560298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
75724989b8cSPeter Brune 
758ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
759316643e7SJed Brown 
76094ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
76124989b8cSPeter Brune   if (ijacobian) {
762316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
763d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
764316643e7SJed Brown     PetscStackPop;
765214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
76694ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
76794ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
7684a6899ffSJed Brown   }
769214bc6a2SJed Brown   if (imex) {
770b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
77194ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
77294ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
77394ab13aaSBarry Smith       if (A != B) {
77494ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
77594ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
776214bc6a2SJed Brown       }
777214bc6a2SJed Brown     }
778214bc6a2SJed Brown   } else {
779e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
780e1244c69SJed Brown     if (rhsjacobian) {
781bd373395SBarry Smith       if (ijacobian) {
782e1244c69SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
783bd373395SBarry Smith       } else {
784bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
785e1244c69SJed Brown       }
786d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
787e1244c69SJed Brown     }
78894ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
789e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
790e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
79194ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
79294ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
79394ab13aaSBarry Smith       if (A != B) {
79494ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
79594ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
796316643e7SJed Brown       }
797e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
798e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
799e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
80094ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
80194ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
80294ab13aaSBarry Smith         if (A != B) {
80394ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
80494ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
805e1244c69SJed Brown         }
806e1244c69SJed Brown       }
80794ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
80894ab13aaSBarry Smith       if (A != B) {
80994ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
810214bc6a2SJed Brown       }
811316643e7SJed Brown     }
812316643e7SJed Brown   }
81394ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
814316643e7SJed Brown   PetscFunctionReturn(0);
815316643e7SJed Brown }
816316643e7SJed Brown 
817316643e7SJed Brown #undef __FUNCT__
8184a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
819d763cef2SBarry Smith /*@C
820d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
821b5abc632SBarry Smith     where U_t = G(t,u).
822d763cef2SBarry Smith 
8233f9fe445SBarry Smith     Logically Collective on TS
824d763cef2SBarry Smith 
825d763cef2SBarry Smith     Input Parameters:
826d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8270298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
828d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
829d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8300298fd71SBarry Smith           function evaluation routine (may be NULL)
831d763cef2SBarry Smith 
832d763cef2SBarry Smith     Calling sequence of func:
83387828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
834d763cef2SBarry Smith 
835d763cef2SBarry Smith +   t - current timestep
836d763cef2SBarry Smith .   u - input vector
837d763cef2SBarry Smith .   F - function vector
838d763cef2SBarry Smith -   ctx - [optional] user-defined function context
839d763cef2SBarry Smith 
840d763cef2SBarry Smith     Level: beginner
841d763cef2SBarry Smith 
8422bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
8432bbac0d3SBarry Smith 
844d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
845d763cef2SBarry Smith 
846ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
847d763cef2SBarry Smith @*/
848089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
849d763cef2SBarry Smith {
850089b2837SJed Brown   PetscErrorCode ierr;
851089b2837SJed Brown   SNES           snes;
8520298fd71SBarry Smith   Vec            ralloc = NULL;
85324989b8cSPeter Brune   DM             dm;
854d763cef2SBarry Smith 
855089b2837SJed Brown   PetscFunctionBegin;
8560700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
857ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
85824989b8cSPeter Brune 
85924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
86024989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
861089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
862e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
863e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
864e856ceecSJed Brown     r    = ralloc;
865e856ceecSJed Brown   }
866089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
867e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
868d763cef2SBarry Smith   PetscFunctionReturn(0);
869d763cef2SBarry Smith }
870d763cef2SBarry Smith 
8714a2ae208SSatish Balay #undef __FUNCT__
872ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
873ef20d060SBarry Smith /*@C
874abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
875ef20d060SBarry Smith 
876ef20d060SBarry Smith     Logically Collective on TS
877ef20d060SBarry Smith 
878ef20d060SBarry Smith     Input Parameters:
879ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
880ef20d060SBarry Smith .   f - routine for evaluating the solution
881ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
8820298fd71SBarry Smith           function evaluation routine (may be NULL)
883ef20d060SBarry Smith 
884ef20d060SBarry Smith     Calling sequence of func:
885ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
886ef20d060SBarry Smith 
887ef20d060SBarry Smith +   t - current timestep
888ef20d060SBarry Smith .   u - output vector
889ef20d060SBarry Smith -   ctx - [optional] user-defined function context
890ef20d060SBarry Smith 
891abd5a294SJed Brown     Notes:
892abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
893abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
894abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
895abd5a294SJed Brown 
8964f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
897abd5a294SJed Brown 
898ef20d060SBarry Smith     Level: beginner
899ef20d060SBarry Smith 
900ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
901ef20d060SBarry Smith 
9029b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
903ef20d060SBarry Smith @*/
904ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
905ef20d060SBarry Smith {
906ef20d060SBarry Smith   PetscErrorCode ierr;
907ef20d060SBarry Smith   DM             dm;
908ef20d060SBarry Smith 
909ef20d060SBarry Smith   PetscFunctionBegin;
910ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
911ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
912ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
913ef20d060SBarry Smith   PetscFunctionReturn(0);
914ef20d060SBarry Smith }
915ef20d060SBarry Smith 
916ef20d060SBarry Smith #undef __FUNCT__
9179b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9189b7cd975SBarry Smith /*@C
9199b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9209b7cd975SBarry Smith 
9219b7cd975SBarry Smith     Logically Collective on TS
9229b7cd975SBarry Smith 
9239b7cd975SBarry Smith     Input Parameters:
9249b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9259b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9269b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9270298fd71SBarry Smith           function evaluation routine (may be NULL)
9289b7cd975SBarry Smith 
9299b7cd975SBarry Smith     Calling sequence of func:
9309b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9319b7cd975SBarry Smith 
9329b7cd975SBarry Smith +   t - current timestep
9339b7cd975SBarry Smith .   u - output vector
9349b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9359b7cd975SBarry Smith 
9369b7cd975SBarry Smith     Notes:
9379b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9389b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9399b7cd975SBarry Smith 
9409b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9419b7cd975SBarry Smith 
9429b7cd975SBarry Smith     Level: beginner
9439b7cd975SBarry Smith 
9449b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9459b7cd975SBarry Smith 
9469b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
9479b7cd975SBarry Smith @*/
9489b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
9499b7cd975SBarry Smith {
9509b7cd975SBarry Smith   PetscErrorCode ierr;
9519b7cd975SBarry Smith   DM             dm;
9529b7cd975SBarry Smith 
9539b7cd975SBarry Smith   PetscFunctionBegin;
9549b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9559b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
9569b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
9579b7cd975SBarry Smith   PetscFunctionReturn(0);
9589b7cd975SBarry Smith }
9599b7cd975SBarry Smith 
9609b7cd975SBarry Smith #undef __FUNCT__
9614a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
962d763cef2SBarry Smith /*@C
963f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
964b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
965d763cef2SBarry Smith 
9663f9fe445SBarry Smith    Logically Collective on TS
967d763cef2SBarry Smith 
968d763cef2SBarry Smith    Input Parameters:
969d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
970e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
971e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
972d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
973d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
9740298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
975d763cef2SBarry Smith 
976f7ab8db6SBarry Smith    Calling sequence of f:
977ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
978d763cef2SBarry Smith 
979d763cef2SBarry Smith +  t - current timestep
980d763cef2SBarry Smith .  u - input vector
981e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
982e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
983d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
984d763cef2SBarry Smith 
985d763cef2SBarry Smith 
986d763cef2SBarry Smith    Level: beginner
987d763cef2SBarry Smith 
988d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
989d763cef2SBarry Smith 
990ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
991d763cef2SBarry Smith 
992d763cef2SBarry Smith @*/
993e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
994d763cef2SBarry Smith {
995277b19d0SLisandro Dalcin   PetscErrorCode ierr;
996089b2837SJed Brown   SNES           snes;
99724989b8cSPeter Brune   DM             dm;
99824989b8cSPeter Brune   TSIJacobian    ijacobian;
999277b19d0SLisandro Dalcin 
1000d763cef2SBarry Smith   PetscFunctionBegin;
10010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1002e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1003e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1004e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1005e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1006d763cef2SBarry Smith 
100724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
100824989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1009e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1010e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1011e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1012e1244c69SJed Brown   }
10130298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1014089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10155f659677SPeter Brune   if (!ijacobian) {
1016e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10170e4ef248SJed Brown   }
1018e5d3d808SBarry Smith   if (Amat) {
1019e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10200e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1021bbd56ea5SKarl Rupp 
1022e5d3d808SBarry Smith     ts->Arhs = Amat;
10230e4ef248SJed Brown   }
1024e5d3d808SBarry Smith   if (Pmat) {
1025e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10260e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1027bbd56ea5SKarl Rupp 
1028e5d3d808SBarry Smith     ts->Brhs = Pmat;
10290e4ef248SJed Brown   }
1030d763cef2SBarry Smith   PetscFunctionReturn(0);
1031d763cef2SBarry Smith }
1032d763cef2SBarry Smith 
1033316643e7SJed Brown 
1034316643e7SJed Brown #undef __FUNCT__
1035316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1036316643e7SJed Brown /*@C
1037b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1038316643e7SJed Brown 
10393f9fe445SBarry Smith    Logically Collective on TS
1040316643e7SJed Brown 
1041316643e7SJed Brown    Input Parameters:
1042316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10430298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1044316643e7SJed Brown .  f   - the function evaluation routine
10450298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1046316643e7SJed Brown 
1047316643e7SJed Brown    Calling sequence of f:
1048316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1049316643e7SJed Brown 
1050316643e7SJed Brown +  t   - time at step/stage being solved
1051316643e7SJed Brown .  u   - state vector
1052316643e7SJed Brown .  u_t - time derivative of state vector
1053316643e7SJed Brown .  F   - function vector
1054316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1055316643e7SJed Brown 
1056316643e7SJed Brown    Important:
10572bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1058316643e7SJed Brown 
1059316643e7SJed Brown    Level: beginner
1060316643e7SJed Brown 
1061316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1062316643e7SJed Brown 
1063d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1064316643e7SJed Brown @*/
1065089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1066316643e7SJed Brown {
1067089b2837SJed Brown   PetscErrorCode ierr;
1068089b2837SJed Brown   SNES           snes;
10690298fd71SBarry Smith   Vec            resalloc = NULL;
107024989b8cSPeter Brune   DM             dm;
1071316643e7SJed Brown 
1072316643e7SJed Brown   PetscFunctionBegin;
10730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1074ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
107524989b8cSPeter Brune 
107624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
107724989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
107824989b8cSPeter Brune 
1079089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1080e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1081e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1082e856ceecSJed Brown     res  = resalloc;
1083e856ceecSJed Brown   }
1084089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1085e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1086089b2837SJed Brown   PetscFunctionReturn(0);
1087089b2837SJed Brown }
1088089b2837SJed Brown 
1089089b2837SJed Brown #undef __FUNCT__
1090089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1091089b2837SJed Brown /*@C
1092089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1093089b2837SJed Brown 
1094089b2837SJed Brown    Not Collective
1095089b2837SJed Brown 
1096089b2837SJed Brown    Input Parameter:
1097089b2837SJed Brown .  ts - the TS context
1098089b2837SJed Brown 
1099089b2837SJed Brown    Output Parameter:
11000298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11010298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11020298fd71SBarry Smith -  ctx - the function context (or NULL)
1103089b2837SJed Brown 
1104089b2837SJed Brown    Level: advanced
1105089b2837SJed Brown 
1106089b2837SJed Brown .keywords: TS, nonlinear, get, function
1107089b2837SJed Brown 
1108089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1109089b2837SJed Brown @*/
1110089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1111089b2837SJed Brown {
1112089b2837SJed Brown   PetscErrorCode ierr;
1113089b2837SJed Brown   SNES           snes;
111424989b8cSPeter Brune   DM             dm;
1115089b2837SJed Brown 
1116089b2837SJed Brown   PetscFunctionBegin;
1117089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1118089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11190298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
112024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
112124989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1122089b2837SJed Brown   PetscFunctionReturn(0);
1123089b2837SJed Brown }
1124089b2837SJed Brown 
1125089b2837SJed Brown #undef __FUNCT__
1126089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1127089b2837SJed Brown /*@C
1128089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1129089b2837SJed Brown 
1130089b2837SJed Brown    Not Collective
1131089b2837SJed Brown 
1132089b2837SJed Brown    Input Parameter:
1133089b2837SJed Brown .  ts - the TS context
1134089b2837SJed Brown 
1135089b2837SJed Brown    Output Parameter:
11360298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11370298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11380298fd71SBarry Smith -  ctx - the function context (or NULL)
1139089b2837SJed Brown 
1140089b2837SJed Brown    Level: advanced
1141089b2837SJed Brown 
1142089b2837SJed Brown .keywords: TS, nonlinear, get, function
1143089b2837SJed Brown 
11442bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1145089b2837SJed Brown @*/
1146089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1147089b2837SJed Brown {
1148089b2837SJed Brown   PetscErrorCode ierr;
1149089b2837SJed Brown   SNES           snes;
115024989b8cSPeter Brune   DM             dm;
1151089b2837SJed Brown 
1152089b2837SJed Brown   PetscFunctionBegin;
1153089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1154089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11550298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
115624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
115724989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1158316643e7SJed Brown   PetscFunctionReturn(0);
1159316643e7SJed Brown }
1160316643e7SJed Brown 
1161316643e7SJed Brown #undef __FUNCT__
1162316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1163316643e7SJed Brown /*@C
1164a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1165ae8867d6SBarry Smith         provided with TSSetIFunction().
1166316643e7SJed Brown 
11673f9fe445SBarry Smith    Logically Collective on TS
1168316643e7SJed Brown 
1169316643e7SJed Brown    Input Parameters:
1170316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1171e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1172e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1173316643e7SJed Brown .  f   - the Jacobian evaluation routine
11740298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1175316643e7SJed Brown 
1176316643e7SJed Brown    Calling sequence of f:
1177ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1178316643e7SJed Brown 
1179316643e7SJed Brown +  t    - time at step/stage being solved
11801b4a444bSJed Brown .  U    - state vector
11811b4a444bSJed Brown .  U_t  - time derivative of state vector
1182316643e7SJed Brown .  a    - shift
1183e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1184e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1185316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1186316643e7SJed Brown 
1187316643e7SJed Brown    Notes:
1188e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1189316643e7SJed Brown 
1190a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1191b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1192a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1193a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1194a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1195a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1196a4f0a591SBarry Smith 
1197316643e7SJed Brown    Level: beginner
1198316643e7SJed Brown 
1199316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1200316643e7SJed Brown 
1201ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1202316643e7SJed Brown 
1203316643e7SJed Brown @*/
1204e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1205316643e7SJed Brown {
1206316643e7SJed Brown   PetscErrorCode ierr;
1207089b2837SJed Brown   SNES           snes;
120824989b8cSPeter Brune   DM             dm;
1209316643e7SJed Brown 
1210316643e7SJed Brown   PetscFunctionBegin;
12110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1212e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1213e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1214e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1215e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
121624989b8cSPeter Brune 
121724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
121824989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
121924989b8cSPeter Brune 
1220089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1221e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1222316643e7SJed Brown   PetscFunctionReturn(0);
1223316643e7SJed Brown }
1224316643e7SJed Brown 
12254a2ae208SSatish Balay #undef __FUNCT__
1226e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1227e1244c69SJed Brown /*@
1228e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1229e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1230e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1231e1244c69SJed Brown    not been changed by the TS.
1232e1244c69SJed Brown 
1233e1244c69SJed Brown    Logically Collective
1234e1244c69SJed Brown 
1235e1244c69SJed Brown    Input Arguments:
1236e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1237e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1238e1244c69SJed Brown 
1239e1244c69SJed Brown    Level: intermediate
1240e1244c69SJed Brown 
1241e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1242e1244c69SJed Brown @*/
1243e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1244e1244c69SJed Brown {
1245e1244c69SJed Brown   PetscFunctionBegin;
1246e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1247e1244c69SJed Brown   PetscFunctionReturn(0);
1248e1244c69SJed Brown }
1249e1244c69SJed Brown 
1250e1244c69SJed Brown #undef __FUNCT__
125155849f57SBarry Smith #define __FUNCT__ "TSLoad"
125255849f57SBarry Smith /*@C
125355849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
125455849f57SBarry Smith 
125555849f57SBarry Smith   Collective on PetscViewer
125655849f57SBarry Smith 
125755849f57SBarry Smith   Input Parameters:
125855849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
125955849f57SBarry Smith            some related function before a call to TSLoad().
126055849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
126155849f57SBarry Smith 
126255849f57SBarry Smith    Level: intermediate
126355849f57SBarry Smith 
126455849f57SBarry Smith   Notes:
126555849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
126655849f57SBarry Smith 
126755849f57SBarry Smith   Notes for advanced users:
126855849f57SBarry Smith   Most users should not need to know the details of the binary storage
126955849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
127055849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
127155849f57SBarry Smith   format is
127255849f57SBarry Smith .vb
127355849f57SBarry Smith      has not yet been determined
127455849f57SBarry Smith .ve
127555849f57SBarry Smith 
127655849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
127755849f57SBarry Smith @*/
1278f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
127955849f57SBarry Smith {
128055849f57SBarry Smith   PetscErrorCode ierr;
128155849f57SBarry Smith   PetscBool      isbinary;
128255849f57SBarry Smith   PetscInt       classid;
128355849f57SBarry Smith   char           type[256];
12842d53ad75SBarry Smith   DMTS           sdm;
1285ad6bc421SBarry Smith   DM             dm;
128655849f57SBarry Smith 
128755849f57SBarry Smith   PetscFunctionBegin;
1288f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
128955849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
129055849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
129155849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
129255849f57SBarry Smith 
129355849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1294ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
129555849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1296f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1297f2c2a1b9SBarry Smith   if (ts->ops->load) {
1298f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1299f2c2a1b9SBarry Smith   }
1300ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1301ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1302ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1303f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1304f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13052d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13062d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
130755849f57SBarry Smith   PetscFunctionReturn(0);
130855849f57SBarry Smith }
130955849f57SBarry Smith 
13109804daf3SBarry Smith #include <petscdraw.h>
1311e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1312e04113cfSBarry Smith #include <petscviewersaws.h>
1313f05ece33SBarry Smith #endif
131455849f57SBarry Smith #undef __FUNCT__
13154a2ae208SSatish Balay #define __FUNCT__ "TSView"
13167e2c5f70SBarry Smith /*@C
1317d763cef2SBarry Smith     TSView - Prints the TS data structure.
1318d763cef2SBarry Smith 
13194c49b128SBarry Smith     Collective on TS
1320d763cef2SBarry Smith 
1321d763cef2SBarry Smith     Input Parameters:
1322d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1323d763cef2SBarry Smith -   viewer - visualization context
1324d763cef2SBarry Smith 
1325d763cef2SBarry Smith     Options Database Key:
1326d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1327d763cef2SBarry Smith 
1328d763cef2SBarry Smith     Notes:
1329d763cef2SBarry Smith     The available visualization contexts include
1330b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1331b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1332d763cef2SBarry Smith          output where only the first processor opens
1333d763cef2SBarry Smith          the file.  All other processors send their
1334d763cef2SBarry Smith          data to the first processor to print.
1335d763cef2SBarry Smith 
1336d763cef2SBarry Smith     The user can open an alternative visualization context with
1337b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1338d763cef2SBarry Smith 
1339d763cef2SBarry Smith     Level: beginner
1340d763cef2SBarry Smith 
1341d763cef2SBarry Smith .keywords: TS, timestep, view
1342d763cef2SBarry Smith 
1343b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1344d763cef2SBarry Smith @*/
13457087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1346d763cef2SBarry Smith {
1347dfbe8321SBarry Smith   PetscErrorCode ierr;
134819fd82e9SBarry Smith   TSType         type;
13492b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
13502d53ad75SBarry Smith   DMTS           sdm;
1351e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1352f05ece33SBarry Smith   PetscBool      isams;
1353f05ece33SBarry Smith #endif
1354d763cef2SBarry Smith 
1355d763cef2SBarry Smith   PetscFunctionBegin;
13560700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13573050cee2SBarry Smith   if (!viewer) {
1358ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
13593050cee2SBarry Smith   }
13600700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1361c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1362fd16b177SBarry Smith 
1363251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1364251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
136555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
13662b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1367e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1368e04113cfSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr);
1369f05ece33SBarry Smith #endif
137032077d6dSBarry Smith   if (iascii) {
1371dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
137277431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
13737c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1374d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
13755ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1376c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1377d763cef2SBarry Smith     }
13785ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1379193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
13802d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13812d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1382d52bd9f3SBarry Smith     if (ts->ops->view) {
1383d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1384d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1385d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1386d52bd9f3SBarry Smith     }
13870f5bd95cSBarry Smith   } else if (isstring) {
1388a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1389b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
139055849f57SBarry Smith   } else if (isbinary) {
139155849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
139255849f57SBarry Smith     MPI_Comm    comm;
139355849f57SBarry Smith     PetscMPIInt rank;
139455849f57SBarry Smith     char        type[256];
139555849f57SBarry Smith 
139655849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
139755849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
139855849f57SBarry Smith     if (!rank) {
139955849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
140055849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
140155849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
140255849f57SBarry Smith     }
140355849f57SBarry Smith     if (ts->ops->view) {
140455849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
140555849f57SBarry Smith     }
1406f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1407f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14082d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14092d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14102b0a91c0SBarry Smith   } else if (isdraw) {
14112b0a91c0SBarry Smith     PetscDraw draw;
14122b0a91c0SBarry Smith     char      str[36];
141389fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14142b0a91c0SBarry Smith 
14152b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14162b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14172b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14182b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
14190298fd71SBarry Smith     ierr   = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
142089fd9fafSBarry Smith     bottom = y - h;
14212b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14222b0a91c0SBarry Smith     if (ts->ops->view) {
14232b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14242b0a91c0SBarry Smith     }
14252b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1426e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1427f05ece33SBarry Smith   } else if (isams) {
1428d45a07a7SBarry Smith     PetscMPIInt rank;
14292657e9d9SBarry Smith     const char  *name;
14302657e9d9SBarry Smith 
14312657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1432d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1433d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1434d45a07a7SBarry Smith       char       dir[1024];
1435d45a07a7SBarry Smith 
1436e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1437a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14382657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14392657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14402657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1441d763cef2SBarry Smith     }
14420acecf5bSBarry Smith     if (ts->ops->view) {
14430acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14440acecf5bSBarry Smith     }
1445f05ece33SBarry Smith #endif
1446f05ece33SBarry Smith   }
1447f05ece33SBarry Smith 
1448b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1449251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1450b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1451d763cef2SBarry Smith   PetscFunctionReturn(0);
1452d763cef2SBarry Smith }
1453d763cef2SBarry Smith 
1454d763cef2SBarry Smith 
14554a2ae208SSatish Balay #undef __FUNCT__
14564a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1457b07ff414SBarry Smith /*@
1458d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1459d763cef2SBarry Smith    the timesteppers.
1460d763cef2SBarry Smith 
14613f9fe445SBarry Smith    Logically Collective on TS
1462d763cef2SBarry Smith 
1463d763cef2SBarry Smith    Input Parameters:
1464d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1465d763cef2SBarry Smith -  usrP - optional user context
1466d763cef2SBarry Smith 
1467d763cef2SBarry Smith    Level: intermediate
1468d763cef2SBarry Smith 
1469d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1470d763cef2SBarry Smith 
1471d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1472d763cef2SBarry Smith @*/
14737087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1474d763cef2SBarry Smith {
1475d763cef2SBarry Smith   PetscFunctionBegin;
14760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1477d763cef2SBarry Smith   ts->user = usrP;
1478d763cef2SBarry Smith   PetscFunctionReturn(0);
1479d763cef2SBarry Smith }
1480d763cef2SBarry Smith 
14814a2ae208SSatish Balay #undef __FUNCT__
14824a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1483b07ff414SBarry Smith /*@
1484d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1485d763cef2SBarry Smith     timestepper.
1486d763cef2SBarry Smith 
1487d763cef2SBarry Smith     Not Collective
1488d763cef2SBarry Smith 
1489d763cef2SBarry Smith     Input Parameter:
1490d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1491d763cef2SBarry Smith 
1492d763cef2SBarry Smith     Output Parameter:
1493d763cef2SBarry Smith .   usrP - user context
1494d763cef2SBarry Smith 
1495d763cef2SBarry Smith     Level: intermediate
1496d763cef2SBarry Smith 
1497d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1498d763cef2SBarry Smith 
1499d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1500d763cef2SBarry Smith @*/
1501e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1502d763cef2SBarry Smith {
1503d763cef2SBarry Smith   PetscFunctionBegin;
15040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1505e71120c6SJed Brown   *(void**)usrP = ts->user;
1506d763cef2SBarry Smith   PetscFunctionReturn(0);
1507d763cef2SBarry Smith }
1508d763cef2SBarry Smith 
15094a2ae208SSatish Balay #undef __FUNCT__
15104a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1511d763cef2SBarry Smith /*@
1512b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1513d763cef2SBarry Smith 
1514d763cef2SBarry Smith    Not Collective
1515d763cef2SBarry Smith 
1516d763cef2SBarry Smith    Input Parameter:
1517d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1518d763cef2SBarry Smith 
1519d763cef2SBarry Smith    Output Parameter:
1520b8123daeSJed Brown .  iter - number of steps completed so far
1521d763cef2SBarry Smith 
1522d763cef2SBarry Smith    Level: intermediate
1523d763cef2SBarry Smith 
1524d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15259be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1526d763cef2SBarry Smith @*/
15277087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1528d763cef2SBarry Smith {
1529d763cef2SBarry Smith   PetscFunctionBegin;
15300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15314482741eSBarry Smith   PetscValidIntPointer(iter,2);
1532d763cef2SBarry Smith   *iter = ts->steps;
1533d763cef2SBarry Smith   PetscFunctionReturn(0);
1534d763cef2SBarry Smith }
1535d763cef2SBarry Smith 
15364a2ae208SSatish Balay #undef __FUNCT__
15374a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1538d763cef2SBarry Smith /*@
1539d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1540d763cef2SBarry Smith    as well as the initial time.
1541d763cef2SBarry Smith 
15423f9fe445SBarry Smith    Logically Collective on TS
1543d763cef2SBarry Smith 
1544d763cef2SBarry Smith    Input Parameters:
1545d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1546d763cef2SBarry Smith .  initial_time - the initial time
1547d763cef2SBarry Smith -  time_step - the size of the timestep
1548d763cef2SBarry Smith 
1549d763cef2SBarry Smith    Level: intermediate
1550d763cef2SBarry Smith 
1551d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1552d763cef2SBarry Smith 
1553d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1554d763cef2SBarry Smith @*/
15557087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1556d763cef2SBarry Smith {
1557e144a568SJed Brown   PetscErrorCode ierr;
1558e144a568SJed Brown 
1559d763cef2SBarry Smith   PetscFunctionBegin;
15600700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1561e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1562d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1563d763cef2SBarry Smith   PetscFunctionReturn(0);
1564d763cef2SBarry Smith }
1565d763cef2SBarry Smith 
15664a2ae208SSatish Balay #undef __FUNCT__
15674a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1568d763cef2SBarry Smith /*@
1569d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1570d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1571d763cef2SBarry Smith 
15723f9fe445SBarry Smith    Logically Collective on TS
1573d763cef2SBarry Smith 
1574d763cef2SBarry Smith    Input Parameters:
1575d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1576d763cef2SBarry Smith -  time_step - the size of the timestep
1577d763cef2SBarry Smith 
1578d763cef2SBarry Smith    Level: intermediate
1579d763cef2SBarry Smith 
1580d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1581d763cef2SBarry Smith 
1582d763cef2SBarry Smith .keywords: TS, set, timestep
1583d763cef2SBarry Smith @*/
15847087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1585d763cef2SBarry Smith {
1586d763cef2SBarry Smith   PetscFunctionBegin;
15870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1588c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1589d763cef2SBarry Smith   ts->time_step      = time_step;
159031748224SBarry Smith   ts->time_step_orig = time_step;
1591d763cef2SBarry Smith   PetscFunctionReturn(0);
1592d763cef2SBarry Smith }
1593d763cef2SBarry Smith 
15944a2ae208SSatish Balay #undef __FUNCT__
1595a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1596a43b19c4SJed Brown /*@
159749354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
159849354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
159949354f04SShri Abhyankar      or just return at the final time TS computed.
1600a43b19c4SJed Brown 
1601a43b19c4SJed Brown   Logically Collective on TS
1602a43b19c4SJed Brown 
1603a43b19c4SJed Brown    Input Parameter:
1604a43b19c4SJed Brown +   ts - the time-step context
160549354f04SShri Abhyankar -   eftopt - exact final time option
1606a43b19c4SJed Brown 
1607a43b19c4SJed Brown    Level: beginner
1608a43b19c4SJed Brown 
1609a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1610a43b19c4SJed Brown @*/
161149354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1612a43b19c4SJed Brown {
1613a43b19c4SJed Brown   PetscFunctionBegin;
1614a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
161549354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
161649354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1617a43b19c4SJed Brown   PetscFunctionReturn(0);
1618a43b19c4SJed Brown }
1619a43b19c4SJed Brown 
1620a43b19c4SJed Brown #undef __FUNCT__
16214a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1622d763cef2SBarry Smith /*@
1623d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1624d763cef2SBarry Smith 
1625d763cef2SBarry Smith    Not Collective
1626d763cef2SBarry Smith 
1627d763cef2SBarry Smith    Input Parameter:
1628d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1629d763cef2SBarry Smith 
1630d763cef2SBarry Smith    Output Parameter:
1631d763cef2SBarry Smith .  dt - the current timestep size
1632d763cef2SBarry Smith 
1633d763cef2SBarry Smith    Level: intermediate
1634d763cef2SBarry Smith 
1635d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1636d763cef2SBarry Smith 
1637d763cef2SBarry Smith .keywords: TS, get, timestep
1638d763cef2SBarry Smith @*/
16397087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1640d763cef2SBarry Smith {
1641d763cef2SBarry Smith   PetscFunctionBegin;
16420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1643f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1644d763cef2SBarry Smith   *dt = ts->time_step;
1645d763cef2SBarry Smith   PetscFunctionReturn(0);
1646d763cef2SBarry Smith }
1647d763cef2SBarry Smith 
16484a2ae208SSatish Balay #undef __FUNCT__
16494a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1650d8e5e3e6SSatish Balay /*@
1651d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1652d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1653d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1654d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1655d763cef2SBarry Smith 
1656d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1657d763cef2SBarry Smith 
1658d763cef2SBarry Smith    Input Parameter:
1659d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1660d763cef2SBarry Smith 
1661d763cef2SBarry Smith    Output Parameter:
1662d763cef2SBarry Smith .  v - the vector containing the solution
1663d763cef2SBarry Smith 
1664d763cef2SBarry Smith    Level: intermediate
1665d763cef2SBarry Smith 
1666d763cef2SBarry Smith .seealso: TSGetTimeStep()
1667d763cef2SBarry Smith 
1668d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1669d763cef2SBarry Smith @*/
16707087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1671d763cef2SBarry Smith {
1672d763cef2SBarry Smith   PetscFunctionBegin;
16730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16744482741eSBarry Smith   PetscValidPointer(v,2);
16758737fe31SLisandro Dalcin   *v = ts->vec_sol;
1676d763cef2SBarry Smith   PetscFunctionReturn(0);
1677d763cef2SBarry Smith }
1678d763cef2SBarry Smith 
1679bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
16804a2ae208SSatish Balay #undef __FUNCT__
1681bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1682d8e5e3e6SSatish Balay /*@
1683bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1684d763cef2SBarry Smith 
1685bdad233fSMatthew Knepley   Not collective
1686d763cef2SBarry Smith 
1687bdad233fSMatthew Knepley   Input Parameters:
1688bdad233fSMatthew Knepley + ts   - The TS
1689bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1690d763cef2SBarry Smith .vb
16910910c330SBarry Smith          U_t - A U = 0      (linear)
16920910c330SBarry Smith          U_t - A(t) U = 0   (linear)
16930910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1694d763cef2SBarry Smith .ve
1695d763cef2SBarry Smith 
1696d763cef2SBarry Smith    Level: beginner
1697d763cef2SBarry Smith 
1698bdad233fSMatthew Knepley .keywords: TS, problem type
1699bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1700d763cef2SBarry Smith @*/
17017087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1702a7cc72afSBarry Smith {
17039e2a6581SJed Brown   PetscErrorCode ierr;
17049e2a6581SJed Brown 
1705d763cef2SBarry Smith   PetscFunctionBegin;
17060700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1707bdad233fSMatthew Knepley   ts->problem_type = type;
17089e2a6581SJed Brown   if (type == TS_LINEAR) {
17099e2a6581SJed Brown     SNES snes;
17109e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17119e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17129e2a6581SJed Brown   }
1713d763cef2SBarry Smith   PetscFunctionReturn(0);
1714d763cef2SBarry Smith }
1715d763cef2SBarry Smith 
1716bdad233fSMatthew Knepley #undef __FUNCT__
1717bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1718bdad233fSMatthew Knepley /*@C
1719bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1720bdad233fSMatthew Knepley 
1721bdad233fSMatthew Knepley   Not collective
1722bdad233fSMatthew Knepley 
1723bdad233fSMatthew Knepley   Input Parameter:
1724bdad233fSMatthew Knepley . ts   - The TS
1725bdad233fSMatthew Knepley 
1726bdad233fSMatthew Knepley   Output Parameter:
1727bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1728bdad233fSMatthew Knepley .vb
1729089b2837SJed Brown          M U_t = A U
1730089b2837SJed Brown          M(t) U_t = A(t) U
1731b5abc632SBarry Smith          F(t,U,U_t)
1732bdad233fSMatthew Knepley .ve
1733bdad233fSMatthew Knepley 
1734bdad233fSMatthew Knepley    Level: beginner
1735bdad233fSMatthew Knepley 
1736bdad233fSMatthew Knepley .keywords: TS, problem type
1737bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1738bdad233fSMatthew Knepley @*/
17397087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1740a7cc72afSBarry Smith {
1741bdad233fSMatthew Knepley   PetscFunctionBegin;
17420700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
17434482741eSBarry Smith   PetscValidIntPointer(type,2);
1744bdad233fSMatthew Knepley   *type = ts->problem_type;
1745bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1746bdad233fSMatthew Knepley }
1747d763cef2SBarry Smith 
17484a2ae208SSatish Balay #undef __FUNCT__
17494a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1750d763cef2SBarry Smith /*@
1751d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1752d763cef2SBarry Smith    of a timestepper.
1753d763cef2SBarry Smith 
1754d763cef2SBarry Smith    Collective on TS
1755d763cef2SBarry Smith 
1756d763cef2SBarry Smith    Input Parameter:
1757d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1758d763cef2SBarry Smith 
1759d763cef2SBarry Smith    Notes:
1760d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1761d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1762d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1763d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1764d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1765d763cef2SBarry Smith 
1766d763cef2SBarry Smith    Level: advanced
1767d763cef2SBarry Smith 
1768d763cef2SBarry Smith .keywords: TS, timestep, setup
1769d763cef2SBarry Smith 
1770d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1771d763cef2SBarry Smith @*/
17727087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1773d763cef2SBarry Smith {
1774dfbe8321SBarry Smith   PetscErrorCode ierr;
17756c6b9e74SPeter Brune   DM             dm;
17766c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1777d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
17786c6b9e74SPeter Brune   TSIJacobian    ijac;
17796c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1780d763cef2SBarry Smith 
1781d763cef2SBarry Smith   PetscFunctionBegin;
17820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1783277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1784277b19d0SLisandro Dalcin 
17857adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
17869596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1787d763cef2SBarry Smith   }
1788277b19d0SLisandro Dalcin 
1789277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1790277b19d0SLisandro Dalcin 
1791552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
17921c3436cfSJed Brown 
1793e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1794e1244c69SJed Brown     Mat Amat,Pmat;
1795e1244c69SJed Brown     SNES snes;
1796e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1797e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1798e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1799e1244c69SJed Brown      * have displaced the RHS matrix */
1800e1244c69SJed Brown     if (Amat == ts->Arhs) {
1801e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1802e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1803e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1804e1244c69SJed Brown     }
1805e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1806e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1807e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1808e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1809e1244c69SJed Brown     }
1810e1244c69SJed Brown   }
1811e1244c69SJed Brown 
1812277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1813000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1814277b19d0SLisandro Dalcin   }
1815277b19d0SLisandro Dalcin 
18166c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
18176c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
18186c6b9e74SPeter Brune    */
18196c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
18200298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
18216c6b9e74SPeter Brune   if (!func) {
18226c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
18236c6b9e74SPeter Brune   }
18246c6b9e74SPeter Brune   /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
18256c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
18266c6b9e74SPeter Brune    */
18270298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
18280298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
18290298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
18306c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
18316c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
18326c6b9e74SPeter Brune   }
1833277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1834277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1835277b19d0SLisandro Dalcin }
1836277b19d0SLisandro Dalcin 
1837277b19d0SLisandro Dalcin #undef __FUNCT__
1838277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1839277b19d0SLisandro Dalcin /*@
1840277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1841277b19d0SLisandro Dalcin 
1842277b19d0SLisandro Dalcin    Collective on TS
1843277b19d0SLisandro Dalcin 
1844277b19d0SLisandro Dalcin    Input Parameter:
1845277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1846277b19d0SLisandro Dalcin 
1847277b19d0SLisandro Dalcin    Level: beginner
1848277b19d0SLisandro Dalcin 
1849277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1850277b19d0SLisandro Dalcin 
1851277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1852277b19d0SLisandro Dalcin @*/
1853277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1854277b19d0SLisandro Dalcin {
1855277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1856277b19d0SLisandro Dalcin 
1857277b19d0SLisandro Dalcin   PetscFunctionBegin;
1858277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1859277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1860277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1861277b19d0SLisandro Dalcin   }
1862277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1863bbd56ea5SKarl Rupp 
18644e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
18654e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1866214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
18676bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1868e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1869e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
187038637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1871bbd56ea5SKarl Rupp 
1872277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1873d763cef2SBarry Smith   PetscFunctionReturn(0);
1874d763cef2SBarry Smith }
1875d763cef2SBarry Smith 
18764a2ae208SSatish Balay #undef __FUNCT__
18774a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1878d8e5e3e6SSatish Balay /*@
1879d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1880d763cef2SBarry Smith    with TSCreate().
1881d763cef2SBarry Smith 
1882d763cef2SBarry Smith    Collective on TS
1883d763cef2SBarry Smith 
1884d763cef2SBarry Smith    Input Parameter:
1885d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1886d763cef2SBarry Smith 
1887d763cef2SBarry Smith    Level: beginner
1888d763cef2SBarry Smith 
1889d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1890d763cef2SBarry Smith 
1891d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1892d763cef2SBarry Smith @*/
18936bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1894d763cef2SBarry Smith {
18956849ba73SBarry Smith   PetscErrorCode ierr;
1896d763cef2SBarry Smith 
1897d763cef2SBarry Smith   PetscFunctionBegin;
18986bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
18996bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
19006bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1901d763cef2SBarry Smith 
19026bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1903277b19d0SLisandro Dalcin 
1904e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
1905e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
19066bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
19076d4c513bSLisandro Dalcin 
190884df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
1909aeb4809dSShri Abhyankar   if ((*ts)->event) {
1910aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
1911aeb4809dSShri Abhyankar   }
19126bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
19136bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
19146bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
19156d4c513bSLisandro Dalcin 
1916a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
1917d763cef2SBarry Smith   PetscFunctionReturn(0);
1918d763cef2SBarry Smith }
1919d763cef2SBarry Smith 
19204a2ae208SSatish Balay #undef __FUNCT__
19214a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
1922d8e5e3e6SSatish Balay /*@
1923d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
1924d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
1925d763cef2SBarry Smith 
1926d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
1927d763cef2SBarry Smith 
1928d763cef2SBarry Smith    Input Parameter:
1929d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1930d763cef2SBarry Smith 
1931d763cef2SBarry Smith    Output Parameter:
1932d763cef2SBarry Smith .  snes - the nonlinear solver context
1933d763cef2SBarry Smith 
1934d763cef2SBarry Smith    Notes:
1935d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
1936d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
193794b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
1938d763cef2SBarry Smith 
1939d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
19400298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
1941d763cef2SBarry Smith 
1942d763cef2SBarry Smith    Level: beginner
1943d763cef2SBarry Smith 
1944d763cef2SBarry Smith .keywords: timestep, get, SNES
1945d763cef2SBarry Smith @*/
19467087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
1947d763cef2SBarry Smith {
1948d372ba47SLisandro Dalcin   PetscErrorCode ierr;
1949d372ba47SLisandro Dalcin 
1950d763cef2SBarry Smith   PetscFunctionBegin;
19510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
19524482741eSBarry Smith   PetscValidPointer(snes,2);
1953d372ba47SLisandro Dalcin   if (!ts->snes) {
1954ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
19550298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
19563bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
1957d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
1958496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
19599e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
19609e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
19619e2a6581SJed Brown     }
1962d372ba47SLisandro Dalcin   }
1963d763cef2SBarry Smith   *snes = ts->snes;
1964d763cef2SBarry Smith   PetscFunctionReturn(0);
1965d763cef2SBarry Smith }
1966d763cef2SBarry Smith 
19674a2ae208SSatish Balay #undef __FUNCT__
1968deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
1969deb2cd25SJed Brown /*@
1970deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
1971deb2cd25SJed Brown 
1972deb2cd25SJed Brown    Collective
1973deb2cd25SJed Brown 
1974deb2cd25SJed Brown    Input Parameter:
1975deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
1976deb2cd25SJed Brown -  snes - the nonlinear solver context
1977deb2cd25SJed Brown 
1978deb2cd25SJed Brown    Notes:
1979deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
1980deb2cd25SJed Brown 
1981deb2cd25SJed Brown    Level: developer
1982deb2cd25SJed Brown 
1983deb2cd25SJed Brown .keywords: timestep, set, SNES
1984deb2cd25SJed Brown @*/
1985deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
1986deb2cd25SJed Brown {
1987deb2cd25SJed Brown   PetscErrorCode ierr;
1988d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
1989deb2cd25SJed Brown 
1990deb2cd25SJed Brown   PetscFunctionBegin;
1991deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1992deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
1993deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
1994deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
1995bbd56ea5SKarl Rupp 
1996deb2cd25SJed Brown   ts->snes = snes;
1997bbd56ea5SKarl Rupp 
19980298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
19990298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2000740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
20010298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2002740132f1SEmil Constantinescu   }
2003deb2cd25SJed Brown   PetscFunctionReturn(0);
2004deb2cd25SJed Brown }
2005deb2cd25SJed Brown 
2006deb2cd25SJed Brown #undef __FUNCT__
200794b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2008d8e5e3e6SSatish Balay /*@
200994b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2010d763cef2SBarry Smith    a TS (timestepper) context.
2011d763cef2SBarry Smith 
201294b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2013d763cef2SBarry Smith 
2014d763cef2SBarry Smith    Input Parameter:
2015d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2016d763cef2SBarry Smith 
2017d763cef2SBarry Smith    Output Parameter:
201894b7f48cSBarry Smith .  ksp - the nonlinear solver context
2019d763cef2SBarry Smith 
2020d763cef2SBarry Smith    Notes:
202194b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2022d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2023d763cef2SBarry Smith    KSP and PC contexts as well.
2024d763cef2SBarry Smith 
202594b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
20260298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2027d763cef2SBarry Smith 
2028d763cef2SBarry Smith    Level: beginner
2029d763cef2SBarry Smith 
203094b7f48cSBarry Smith .keywords: timestep, get, KSP
2031d763cef2SBarry Smith @*/
20327087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2033d763cef2SBarry Smith {
2034d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2035089b2837SJed Brown   SNES           snes;
2036d372ba47SLisandro Dalcin 
2037d763cef2SBarry Smith   PetscFunctionBegin;
20380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20394482741eSBarry Smith   PetscValidPointer(ksp,2);
204017186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2041e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2042089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2043089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2044d763cef2SBarry Smith   PetscFunctionReturn(0);
2045d763cef2SBarry Smith }
2046d763cef2SBarry Smith 
2047d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2048d763cef2SBarry Smith 
20494a2ae208SSatish Balay #undef __FUNCT__
2050adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2051adb62b0dSMatthew Knepley /*@
2052adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2053adb62b0dSMatthew Knepley    maximum time for iteration.
2054adb62b0dSMatthew Knepley 
20553f9fe445SBarry Smith    Not Collective
2056adb62b0dSMatthew Knepley 
2057adb62b0dSMatthew Knepley    Input Parameters:
2058adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
20590298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
20600298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2061adb62b0dSMatthew Knepley 
2062adb62b0dSMatthew Knepley    Level: intermediate
2063adb62b0dSMatthew Knepley 
2064adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2065adb62b0dSMatthew Knepley @*/
20667087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2067adb62b0dSMatthew Knepley {
2068adb62b0dSMatthew Knepley   PetscFunctionBegin;
20690700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2070abc0a331SBarry Smith   if (maxsteps) {
20714482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2072adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2073adb62b0dSMatthew Knepley   }
2074abc0a331SBarry Smith   if (maxtime) {
20754482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2076adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2077adb62b0dSMatthew Knepley   }
2078adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2079adb62b0dSMatthew Knepley }
2080adb62b0dSMatthew Knepley 
2081adb62b0dSMatthew Knepley #undef __FUNCT__
20824a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2083d763cef2SBarry Smith /*@
2084d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2085d763cef2SBarry Smith    maximum time for iteration.
2086d763cef2SBarry Smith 
20873f9fe445SBarry Smith    Logically Collective on TS
2088d763cef2SBarry Smith 
2089d763cef2SBarry Smith    Input Parameters:
2090d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2091d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2092d763cef2SBarry Smith -  maxtime - final time to iterate to
2093d763cef2SBarry Smith 
2094d763cef2SBarry Smith    Options Database Keys:
2095d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
20963bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2097d763cef2SBarry Smith 
2098d763cef2SBarry Smith    Notes:
2099d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2100d763cef2SBarry Smith 
2101d763cef2SBarry Smith    Level: intermediate
2102d763cef2SBarry Smith 
2103d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2104a43b19c4SJed Brown 
2105a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2106d763cef2SBarry Smith @*/
21077087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2108d763cef2SBarry Smith {
2109d763cef2SBarry Smith   PetscFunctionBegin;
21100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2111c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2112c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
211339b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
211439b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2115d763cef2SBarry Smith   PetscFunctionReturn(0);
2116d763cef2SBarry Smith }
2117d763cef2SBarry Smith 
21184a2ae208SSatish Balay #undef __FUNCT__
21194a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2120d763cef2SBarry Smith /*@
2121d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2122d763cef2SBarry Smith    for use by the TS routines.
2123d763cef2SBarry Smith 
21243f9fe445SBarry Smith    Logically Collective on TS and Vec
2125d763cef2SBarry Smith 
2126d763cef2SBarry Smith    Input Parameters:
2127d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
21280910c330SBarry Smith -  u - the solution vector
2129d763cef2SBarry Smith 
2130d763cef2SBarry Smith    Level: beginner
2131d763cef2SBarry Smith 
2132d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2133d763cef2SBarry Smith @*/
21340910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2135d763cef2SBarry Smith {
21368737fe31SLisandro Dalcin   PetscErrorCode ierr;
2137496e6a7aSJed Brown   DM             dm;
21388737fe31SLisandro Dalcin 
2139d763cef2SBarry Smith   PetscFunctionBegin;
21400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21410910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
21420910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
21436bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2144bbd56ea5SKarl Rupp 
21450910c330SBarry Smith   ts->vec_sol = u;
2146bbd56ea5SKarl Rupp 
2147496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
21480910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2149d763cef2SBarry Smith   PetscFunctionReturn(0);
2150d763cef2SBarry Smith }
2151d763cef2SBarry Smith 
2152e74ef692SMatthew Knepley #undef __FUNCT__
2153e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2154ac226902SBarry Smith /*@C
2155000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
21563f2090d5SJed Brown   called once at the beginning of each time step.
2157000e7ae3SMatthew Knepley 
21583f9fe445SBarry Smith   Logically Collective on TS
2159000e7ae3SMatthew Knepley 
2160000e7ae3SMatthew Knepley   Input Parameters:
2161000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2162000e7ae3SMatthew Knepley - func - The function
2163000e7ae3SMatthew Knepley 
2164000e7ae3SMatthew Knepley   Calling sequence of func:
2165000e7ae3SMatthew Knepley . func (TS ts);
2166000e7ae3SMatthew Knepley 
2167000e7ae3SMatthew Knepley   Level: intermediate
2168000e7ae3SMatthew Knepley 
2169b8123daeSJed Brown   Note:
2170b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2171b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2172b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2173b8123daeSJed Brown 
2174000e7ae3SMatthew Knepley .keywords: TS, timestep
21759be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2176000e7ae3SMatthew Knepley @*/
21777087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2178000e7ae3SMatthew Knepley {
2179000e7ae3SMatthew Knepley   PetscFunctionBegin;
21800700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2181ae60f76fSBarry Smith   ts->prestep = func;
2182000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2183000e7ae3SMatthew Knepley }
2184000e7ae3SMatthew Knepley 
2185e74ef692SMatthew Knepley #undef __FUNCT__
21863f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
218709ee8438SJed Brown /*@
21883f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
21893f2090d5SJed Brown 
21903f2090d5SJed Brown   Collective on TS
21913f2090d5SJed Brown 
21923f2090d5SJed Brown   Input Parameters:
21933f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
21943f2090d5SJed Brown 
21953f2090d5SJed Brown   Notes:
21963f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
21973f2090d5SJed Brown   so most users would not generally call this routine themselves.
21983f2090d5SJed Brown 
21993f2090d5SJed Brown   Level: developer
22003f2090d5SJed Brown 
22013f2090d5SJed Brown .keywords: TS, timestep
22029be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
22033f2090d5SJed Brown @*/
22047087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
22053f2090d5SJed Brown {
22063f2090d5SJed Brown   PetscErrorCode ierr;
22073f2090d5SJed Brown 
22083f2090d5SJed Brown   PetscFunctionBegin;
22090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2210ae60f76fSBarry Smith   if (ts->prestep) {
2211ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2212312ce896SJed Brown   }
22133f2090d5SJed Brown   PetscFunctionReturn(0);
22143f2090d5SJed Brown }
22153f2090d5SJed Brown 
22163f2090d5SJed Brown #undef __FUNCT__
2217b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2218b8123daeSJed Brown /*@C
2219b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2220b8123daeSJed Brown   called once at the beginning of each stage.
2221b8123daeSJed Brown 
2222b8123daeSJed Brown   Logically Collective on TS
2223b8123daeSJed Brown 
2224b8123daeSJed Brown   Input Parameters:
2225b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2226b8123daeSJed Brown - func - The function
2227b8123daeSJed Brown 
2228b8123daeSJed Brown   Calling sequence of func:
2229b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2230b8123daeSJed Brown 
2231b8123daeSJed Brown   Level: intermediate
2232b8123daeSJed Brown 
2233b8123daeSJed Brown   Note:
2234b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2235b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2236b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2237b8123daeSJed Brown 
2238b8123daeSJed Brown .keywords: TS, timestep
22399be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2240b8123daeSJed Brown @*/
2241b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2242b8123daeSJed Brown {
2243b8123daeSJed Brown   PetscFunctionBegin;
2244b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2245ae60f76fSBarry Smith   ts->prestage = func;
2246b8123daeSJed Brown   PetscFunctionReturn(0);
2247b8123daeSJed Brown }
2248b8123daeSJed Brown 
2249b8123daeSJed Brown #undef __FUNCT__
22509be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
22519be3e283SDebojyoti Ghosh /*@C
22529be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
22539be3e283SDebojyoti Ghosh   called once at the end of each stage.
22549be3e283SDebojyoti Ghosh 
22559be3e283SDebojyoti Ghosh   Logically Collective on TS
22569be3e283SDebojyoti Ghosh 
22579be3e283SDebojyoti Ghosh   Input Parameters:
22589be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
22599be3e283SDebojyoti Ghosh - func - The function
22609be3e283SDebojyoti Ghosh 
22619be3e283SDebojyoti Ghosh   Calling sequence of func:
22629be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
22639be3e283SDebojyoti Ghosh 
22649be3e283SDebojyoti Ghosh   Level: intermediate
22659be3e283SDebojyoti Ghosh 
22669be3e283SDebojyoti Ghosh   Note:
22679be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
22689be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
22699be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
22709be3e283SDebojyoti Ghosh 
22719be3e283SDebojyoti Ghosh .keywords: TS, timestep
22729be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
22739be3e283SDebojyoti Ghosh @*/
22749be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
22759be3e283SDebojyoti Ghosh {
22769be3e283SDebojyoti Ghosh   PetscFunctionBegin;
22779be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
22789be3e283SDebojyoti Ghosh   ts->poststage = func;
22799be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
22809be3e283SDebojyoti Ghosh }
22819be3e283SDebojyoti Ghosh 
22829be3e283SDebojyoti Ghosh #undef __FUNCT__
2283b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2284b8123daeSJed Brown /*@
2285b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2286b8123daeSJed Brown 
2287b8123daeSJed Brown   Collective on TS
2288b8123daeSJed Brown 
2289b8123daeSJed Brown   Input Parameters:
2290b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
22919be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2292b8123daeSJed Brown 
2293b8123daeSJed Brown   Notes:
2294b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2295b8123daeSJed Brown   most users would not generally call this routine themselves.
2296b8123daeSJed Brown 
2297b8123daeSJed Brown   Level: developer
2298b8123daeSJed Brown 
2299b8123daeSJed Brown .keywords: TS, timestep
23009be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2301b8123daeSJed Brown @*/
2302b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2303b8123daeSJed Brown {
2304b8123daeSJed Brown   PetscErrorCode ierr;
2305b8123daeSJed Brown 
2306b8123daeSJed Brown   PetscFunctionBegin;
2307b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2308ae60f76fSBarry Smith   if (ts->prestage) {
2309ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2310b8123daeSJed Brown   }
2311b8123daeSJed Brown   PetscFunctionReturn(0);
2312b8123daeSJed Brown }
2313b8123daeSJed Brown 
2314b8123daeSJed Brown #undef __FUNCT__
23159be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
23169be3e283SDebojyoti Ghosh /*@
23179be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
23189be3e283SDebojyoti Ghosh 
23199be3e283SDebojyoti Ghosh   Collective on TS
23209be3e283SDebojyoti Ghosh 
23219be3e283SDebojyoti Ghosh   Input Parameters:
23229be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
23239be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
23249be3e283SDebojyoti Ghosh   stageindex  - Stage number
23259be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
23269be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
23279be3e283SDebojyoti Ghosh 
23289be3e283SDebojyoti Ghosh   Notes:
23299be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
23309be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
23319be3e283SDebojyoti Ghosh 
23329be3e283SDebojyoti Ghosh   Level: developer
23339be3e283SDebojyoti Ghosh 
23349be3e283SDebojyoti Ghosh .keywords: TS, timestep
23359be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
23369be3e283SDebojyoti Ghosh @*/
23379be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
23389be3e283SDebojyoti Ghosh {
23399be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
23409be3e283SDebojyoti Ghosh 
23419be3e283SDebojyoti Ghosh   PetscFunctionBegin;
23429be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23434beae5d8SLisandro Dalcin   if (ts->poststage) {
23449be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
23459be3e283SDebojyoti Ghosh   }
23469be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
23479be3e283SDebojyoti Ghosh }
23489be3e283SDebojyoti Ghosh 
23499be3e283SDebojyoti Ghosh #undef __FUNCT__
2350e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2351ac226902SBarry Smith /*@C
2352000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
23533f2090d5SJed Brown   called once at the end of each time step.
2354000e7ae3SMatthew Knepley 
23553f9fe445SBarry Smith   Logically Collective on TS
2356000e7ae3SMatthew Knepley 
2357000e7ae3SMatthew Knepley   Input Parameters:
2358000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2359000e7ae3SMatthew Knepley - func - The function
2360000e7ae3SMatthew Knepley 
2361000e7ae3SMatthew Knepley   Calling sequence of func:
2362b8123daeSJed Brown $ func (TS ts);
2363000e7ae3SMatthew Knepley 
2364000e7ae3SMatthew Knepley   Level: intermediate
2365000e7ae3SMatthew Knepley 
2366000e7ae3SMatthew Knepley .keywords: TS, timestep
2367b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2368000e7ae3SMatthew Knepley @*/
23697087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2370000e7ae3SMatthew Knepley {
2371000e7ae3SMatthew Knepley   PetscFunctionBegin;
23720700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2373ae60f76fSBarry Smith   ts->poststep = func;
2374000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2375000e7ae3SMatthew Knepley }
2376000e7ae3SMatthew Knepley 
2377e74ef692SMatthew Knepley #undef __FUNCT__
23783f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
237909ee8438SJed Brown /*@
23803f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
23813f2090d5SJed Brown 
23823f2090d5SJed Brown   Collective on TS
23833f2090d5SJed Brown 
23843f2090d5SJed Brown   Input Parameters:
23853f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
23863f2090d5SJed Brown 
23873f2090d5SJed Brown   Notes:
23883f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
23893f2090d5SJed Brown   so most users would not generally call this routine themselves.
23903f2090d5SJed Brown 
23913f2090d5SJed Brown   Level: developer
23923f2090d5SJed Brown 
23933f2090d5SJed Brown .keywords: TS, timestep
23943f2090d5SJed Brown @*/
23957087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
23963f2090d5SJed Brown {
23973f2090d5SJed Brown   PetscErrorCode ierr;
23983f2090d5SJed Brown 
23993f2090d5SJed Brown   PetscFunctionBegin;
24000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2401ae60f76fSBarry Smith   if (ts->poststep) {
2402ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
240372ac3e02SJed Brown   }
24043f2090d5SJed Brown   PetscFunctionReturn(0);
24053f2090d5SJed Brown }
24063f2090d5SJed Brown 
2407d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2408d763cef2SBarry Smith 
24094a2ae208SSatish Balay #undef __FUNCT__
2410a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2411d763cef2SBarry Smith /*@C
2412a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2413d763cef2SBarry Smith    timestep to display the iteration's  progress.
2414d763cef2SBarry Smith 
24153f9fe445SBarry Smith    Logically Collective on TS
2416d763cef2SBarry Smith 
2417d763cef2SBarry Smith    Input Parameters:
2418d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2419e213d8f1SJed Brown .  monitor - monitoring routine
2420329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
24210298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2422b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
24230298fd71SBarry Smith           (may be NULL)
2424d763cef2SBarry Smith 
2425e213d8f1SJed Brown    Calling sequence of monitor:
24260910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2427d763cef2SBarry Smith 
2428d763cef2SBarry Smith +    ts - the TS context
242988c05cc5SBarry Smith .    steps - iteration number (after the final time step the monitor routine is called with a step of -1, this is at the final time which may have
243088c05cc5SBarry Smith                                been interpolated to)
24311f06c33eSBarry Smith .    time - current time
24320910c330SBarry Smith .    u - current iterate
2433d763cef2SBarry Smith -    mctx - [optional] monitoring context
2434d763cef2SBarry Smith 
2435d763cef2SBarry Smith    Notes:
2436d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2437d763cef2SBarry Smith    already has been loaded.
2438d763cef2SBarry Smith 
2439025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2440025f1a04SBarry Smith 
2441d763cef2SBarry Smith    Level: intermediate
2442d763cef2SBarry Smith 
2443d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2444d763cef2SBarry Smith 
2445a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2446d763cef2SBarry Smith @*/
2447c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2448d763cef2SBarry Smith {
2449d763cef2SBarry Smith   PetscFunctionBegin;
24500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
245117186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2452d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
24538704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2454d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2455d763cef2SBarry Smith   PetscFunctionReturn(0);
2456d763cef2SBarry Smith }
2457d763cef2SBarry Smith 
24584a2ae208SSatish Balay #undef __FUNCT__
2459a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2460d763cef2SBarry Smith /*@C
2461a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2462d763cef2SBarry Smith 
24633f9fe445SBarry Smith    Logically Collective on TS
2464d763cef2SBarry Smith 
2465d763cef2SBarry Smith    Input Parameters:
2466d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2467d763cef2SBarry Smith 
2468d763cef2SBarry Smith    Notes:
2469d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2470d763cef2SBarry Smith 
2471d763cef2SBarry Smith    Level: intermediate
2472d763cef2SBarry Smith 
2473d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2474d763cef2SBarry Smith 
2475a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2476d763cef2SBarry Smith @*/
24777087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2478d763cef2SBarry Smith {
2479d952e501SBarry Smith   PetscErrorCode ierr;
2480d952e501SBarry Smith   PetscInt       i;
2481d952e501SBarry Smith 
2482d763cef2SBarry Smith   PetscFunctionBegin;
24830700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2484d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
24858704b422SBarry Smith     if (ts->monitordestroy[i]) {
24868704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2487d952e501SBarry Smith     }
2488d952e501SBarry Smith   }
2489d763cef2SBarry Smith   ts->numbermonitors = 0;
2490d763cef2SBarry Smith   PetscFunctionReturn(0);
2491d763cef2SBarry Smith }
2492d763cef2SBarry Smith 
24934a2ae208SSatish Balay #undef __FUNCT__
2494a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2495d8e5e3e6SSatish Balay /*@
2496a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
24975516499fSSatish Balay 
24985516499fSSatish Balay    Level: intermediate
249941251cbbSSatish Balay 
25005516499fSSatish Balay .keywords: TS, set, monitor
25015516499fSSatish Balay 
250241251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
250341251cbbSSatish Balay @*/
2504649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2505d763cef2SBarry Smith {
2506dfbe8321SBarry Smith   PetscErrorCode ierr;
2507ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2508d132466eSBarry Smith 
2509d763cef2SBarry Smith   PetscFunctionBegin;
2510649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2511971832b6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr);
2512649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2513d763cef2SBarry Smith   PetscFunctionReturn(0);
2514d763cef2SBarry Smith }
2515d763cef2SBarry Smith 
25164a2ae208SSatish Balay #undef __FUNCT__
2517cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2518cd652676SJed Brown /*@
2519cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2520cd652676SJed Brown 
2521cd652676SJed Brown    Logically Collective on TS
2522cd652676SJed Brown 
2523cd652676SJed Brown    Input Argument:
2524cd652676SJed Brown .  ts - time stepping context
2525cd652676SJed Brown 
2526cd652676SJed Brown    Output Argument:
2527cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2528cd652676SJed Brown 
2529cd652676SJed Brown    Level: intermediate
2530cd652676SJed Brown 
2531cd652676SJed Brown .keywords: TS, set
2532cd652676SJed Brown 
2533cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
2534cd652676SJed Brown @*/
2535cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2536cd652676SJed Brown {
2537cd652676SJed Brown   PetscFunctionBegin;
2538cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2539cd652676SJed Brown   ts->retain_stages = flg;
2540cd652676SJed Brown   PetscFunctionReturn(0);
2541cd652676SJed Brown }
2542cd652676SJed Brown 
2543cd652676SJed Brown #undef __FUNCT__
2544cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
2545cd652676SJed Brown /*@
2546cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2547cd652676SJed Brown 
2548cd652676SJed Brown    Collective on TS
2549cd652676SJed Brown 
2550cd652676SJed Brown    Input Argument:
2551cd652676SJed Brown +  ts - time stepping context
2552cd652676SJed Brown -  t - time to interpolate to
2553cd652676SJed Brown 
2554cd652676SJed Brown    Output Argument:
25550910c330SBarry Smith .  U - state at given time
2556cd652676SJed Brown 
2557cd652676SJed Brown    Notes:
2558cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
2559cd652676SJed Brown 
2560cd652676SJed Brown    Level: intermediate
2561cd652676SJed Brown 
2562cd652676SJed Brown    Developer Notes:
2563cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
2564cd652676SJed Brown 
2565cd652676SJed Brown .keywords: TS, set
2566cd652676SJed Brown 
2567cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
2568cd652676SJed Brown @*/
25690910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
2570cd652676SJed Brown {
2571cd652676SJed Brown   PetscErrorCode ierr;
2572cd652676SJed Brown 
2573cd652676SJed Brown   PetscFunctionBegin;
2574cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2575b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
25766712e2f1SBarry Smith   if (t < ts->ptime - ts->time_step_prev || t > ts->ptime) SETERRQ3(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Requested time %g not in last time steps [%g,%g]",t,(double)(ts->ptime-ts->time_step_prev),(double)ts->ptime);
2577ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
25780910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
2579cd652676SJed Brown   PetscFunctionReturn(0);
2580cd652676SJed Brown }
2581cd652676SJed Brown 
2582cd652676SJed Brown #undef __FUNCT__
25834a2ae208SSatish Balay #define __FUNCT__ "TSStep"
2584d763cef2SBarry Smith /*@
25856d9e5789SSean Farley    TSStep - Steps one time step
2586d763cef2SBarry Smith 
2587d763cef2SBarry Smith    Collective on TS
2588d763cef2SBarry Smith 
2589d763cef2SBarry Smith    Input Parameter:
2590d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2591d763cef2SBarry Smith 
2592*27829d71SBarry Smith    Level: developer
2593d763cef2SBarry Smith 
2594b8123daeSJed Brown    Notes:
2595*27829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
2596*27829d71SBarry Smith 
2597b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
2598b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
2599b8123daeSJed Brown 
260025cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
260125cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
260225cb2221SBarry Smith 
2603d763cef2SBarry Smith .keywords: TS, timestep, solve
2604d763cef2SBarry Smith 
26059be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
2606d763cef2SBarry Smith @*/
2607193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
2608d763cef2SBarry Smith {
26092fb8446cSMatthew G. Knepley   DM               dm;
2610dfbe8321SBarry Smith   PetscErrorCode   ierr;
2611fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
2612d763cef2SBarry Smith 
2613d763cef2SBarry Smith   PetscFunctionBegin;
26140700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2615fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
2616fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
2617fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
2618fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
2619fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
2620fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
2621fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
2622fffbeea8SBarry Smith 
26232fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
2624d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
2625d405a339SMatthew Knepley 
2626362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
262724655328SShri   ts->ptime_prev = ts->ptime;
2628cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
2629bbd56ea5SKarl Rupp 
2630e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
2631d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2632193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
2633d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2634bbd56ea5SKarl Rupp 
263524655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
2636cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
2637362cd11cSLisandro Dalcin 
2638362cd11cSLisandro Dalcin   if (ts->reason < 0) {
2639cef5090cSJed Brown     if (ts->errorifstepfailed) {
2640cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
2641ce94432eSBarry Smith         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]);
26422a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
26432a3a10ceSLisandro Dalcin         SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_reject or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
2644ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
2645cef5090cSJed Brown     }
2646362cd11cSLisandro Dalcin   } else if (!ts->reason) {
2647db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
2648db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
2649362cd11cSLisandro Dalcin   }
2650d763cef2SBarry Smith   PetscFunctionReturn(0);
2651d763cef2SBarry Smith }
2652d763cef2SBarry Smith 
26534a2ae208SSatish Balay #undef __FUNCT__
265405175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
265505175c85SJed Brown /*@
265605175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
265705175c85SJed Brown 
26581c3436cfSJed Brown    Collective on TS
265905175c85SJed Brown 
266005175c85SJed Brown    Input Arguments:
26611c3436cfSJed Brown +  ts - time stepping context
26621c3436cfSJed Brown .  order - desired order of accuracy
26630298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
266405175c85SJed Brown 
266505175c85SJed Brown    Output Arguments:
26660910c330SBarry Smith .  U - state at the end of the current step
266705175c85SJed Brown 
266805175c85SJed Brown    Level: advanced
266905175c85SJed Brown 
2670108c343cSJed Brown    Notes:
2671108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
2672108c343cSJed 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.
2673108c343cSJed Brown 
26741c3436cfSJed Brown .seealso: TSStep(), TSAdapt
267505175c85SJed Brown @*/
26760910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
267705175c85SJed Brown {
267805175c85SJed Brown   PetscErrorCode ierr;
267905175c85SJed Brown 
268005175c85SJed Brown   PetscFunctionBegin;
268105175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
268205175c85SJed Brown   PetscValidType(ts,1);
26830910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
2684ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
26850910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
268605175c85SJed Brown   PetscFunctionReturn(0);
268705175c85SJed Brown }
268805175c85SJed Brown 
268905175c85SJed Brown #undef __FUNCT__
26906a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
26916a4d4014SLisandro Dalcin /*@
26926a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
26936a4d4014SLisandro Dalcin 
26946a4d4014SLisandro Dalcin    Collective on TS
26956a4d4014SLisandro Dalcin 
26966a4d4014SLisandro Dalcin    Input Parameter:
26976a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2698cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
26995a3a76d0SJed Brown 
27006a4d4014SLisandro Dalcin    Level: beginner
27016a4d4014SLisandro Dalcin 
27025a3a76d0SJed Brown    Notes:
27035a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
27045a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
27055a3a76d0SJed Brown    stepped over the final time.
27065a3a76d0SJed Brown 
27076a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
27086a4d4014SLisandro Dalcin 
27096a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
27106a4d4014SLisandro Dalcin @*/
2711cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
27126a4d4014SLisandro Dalcin {
2713b06615a5SLisandro Dalcin   Vec               solution;
27146a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
2715f22f69f0SBarry Smith 
27166a4d4014SLisandro Dalcin   PetscFunctionBegin;
27170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2718f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
271949354f04SShri Abhyankar   if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
2720b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
27210910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
2722b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
2723b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
2724b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
27255a3a76d0SJed Brown     }
27260910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
2727bbd56ea5SKarl Rupp   } else if (u) {
27280910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
27295a3a76d0SJed Brown   }
2730b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
27316a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
2732193ac0bcSJed Brown   ts->steps             = 0;
27335ef26d82SJed Brown   ts->ksp_its           = 0;
27345ef26d82SJed Brown   ts->snes_its          = 0;
2735c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
2736c610991cSLisandro Dalcin   ts->reject            = 0;
2737193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
2738193ac0bcSJed Brown 
2739ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
2740f05ece33SBarry Smith 
2741193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
2742193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
27430910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
2744cc708dedSBarry Smith     ts->solvetime = ts->ptime;
2745193ac0bcSJed Brown   } else {
27466a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
2747db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
2748db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
2749e1a7a14fSJed Brown     while (!ts->reason) {
2750b06615a5SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2751193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
2752aeb4809dSShri Abhyankar       if (ts->event) {
2753aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
27541eda64f1SShri Abhyankar 	if (ts->event->status != TSEVENT_PROCESSING) {
27551eda64f1SShri Abhyankar 	  ierr = TSPostStep(ts);CHKERRQ(ierr);
27561eda64f1SShri Abhyankar 	}
27571eda64f1SShri Abhyankar       } else {
27581eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
2759aeb4809dSShri Abhyankar       }
2760193ac0bcSJed Brown     }
276149354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
27620910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
2763cc708dedSBarry Smith       ts->solvetime = ts->max_time;
2764b06615a5SLisandro Dalcin       solution = u;
27650574a7fbSJed Brown     } else {
2766ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
2767cc708dedSBarry Smith       ts->solvetime = ts->ptime;
2768b06615a5SLisandro Dalcin       solution = ts->vec_sol;
27690574a7fbSJed Brown     }
2770b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
2771*27829d71SBarry Smith     ierr = VecViewFromOptions(solution, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
2772193ac0bcSJed Brown   }
2773ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
277456f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
27756a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
27766a4d4014SLisandro Dalcin }
27776a4d4014SLisandro Dalcin 
27786a4d4014SLisandro Dalcin #undef __FUNCT__
27794a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
2780228d79bcSJed Brown /*@
2781228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
2782228d79bcSJed Brown 
2783228d79bcSJed Brown    Collective on TS
2784228d79bcSJed Brown 
2785228d79bcSJed Brown    Input Parameters:
2786228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
2787228d79bcSJed Brown .  step - step number that has just completed
2788228d79bcSJed Brown .  ptime - model time of the state
27890910c330SBarry Smith -  u - state at the current model time
2790228d79bcSJed Brown 
2791228d79bcSJed Brown    Notes:
2792228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
2793228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
2794228d79bcSJed Brown 
2795228d79bcSJed Brown    Level: advanced
2796228d79bcSJed Brown 
2797228d79bcSJed Brown .keywords: TS, timestep
2798228d79bcSJed Brown @*/
27990910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
2800d763cef2SBarry Smith {
28016849ba73SBarry Smith   PetscErrorCode ierr;
2802a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
2803d763cef2SBarry Smith 
2804d763cef2SBarry Smith   PetscFunctionBegin;
2805b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2806b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
28075edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
2808d763cef2SBarry Smith   for (i=0; i<n; i++) {
28090910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
2810d763cef2SBarry Smith   }
28115edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
2812d763cef2SBarry Smith   PetscFunctionReturn(0);
2813d763cef2SBarry Smith }
2814d763cef2SBarry Smith 
2815d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
28164a2ae208SSatish Balay #undef __FUNCT__
2817a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
2818d763cef2SBarry Smith /*@C
2819a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
2820a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
2821d763cef2SBarry Smith 
2822d763cef2SBarry Smith    Collective on TS
2823d763cef2SBarry Smith 
2824d763cef2SBarry Smith    Input Parameters:
2825d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
2826d763cef2SBarry Smith .  label - the title to put in the title bar
28277c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
2828a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
2829a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
2830d763cef2SBarry Smith 
2831d763cef2SBarry Smith    Output Parameter:
28320b039ecaSBarry Smith .  ctx - the context
2833d763cef2SBarry Smith 
2834d763cef2SBarry Smith    Options Database Key:
28354f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
28364f09c107SBarry Smith .  -ts_monitor_lg_solution -
283799fdda47SBarry Smith .  -ts_monitor_lg_error -
283899fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
283999fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
284099fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
2841d763cef2SBarry Smith 
2842d763cef2SBarry Smith    Notes:
2843a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
2844d763cef2SBarry Smith 
2845d763cef2SBarry Smith    Level: intermediate
2846d763cef2SBarry Smith 
28477c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
2848d763cef2SBarry Smith 
28494f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
28507c922b88SBarry Smith 
2851d763cef2SBarry Smith @*/
2852a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
2853d763cef2SBarry Smith {
2854b0a32e0cSBarry Smith   PetscDraw      win;
2855dfbe8321SBarry Smith   PetscErrorCode ierr;
2856d763cef2SBarry Smith 
2857d763cef2SBarry Smith   PetscFunctionBegin;
2858b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
2859a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
28603fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
28610b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
28623bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
2863287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
2864287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
2865a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
2866d763cef2SBarry Smith   PetscFunctionReturn(0);
2867d763cef2SBarry Smith }
2868d763cef2SBarry Smith 
28694a2ae208SSatish Balay #undef __FUNCT__
28704f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
2871b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
2872d763cef2SBarry Smith {
28730b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
2874c32365f1SBarry Smith   PetscReal      x   = ptime,y;
2875dfbe8321SBarry Smith   PetscErrorCode ierr;
2876d763cef2SBarry Smith 
2877d763cef2SBarry Smith   PetscFunctionBegin;
2878b06615a5SLisandro Dalcin   if (!step) {
2879a9f9c1f6SBarry Smith     PetscDrawAxis axis;
2880a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
2881a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
2882a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
2883287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
2884a9f9c1f6SBarry Smith   }
2885c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
28860b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
2887b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
28880b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
28893923b477SBarry Smith   }
2890d763cef2SBarry Smith   PetscFunctionReturn(0);
2891d763cef2SBarry Smith }
2892d763cef2SBarry Smith 
28934a2ae208SSatish Balay #undef __FUNCT__
2894a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
2895d763cef2SBarry Smith /*@C
2896a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
2897a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
2898d763cef2SBarry Smith 
28990b039ecaSBarry Smith    Collective on TSMonitorLGCtx
2900d763cef2SBarry Smith 
2901d763cef2SBarry Smith    Input Parameter:
29020b039ecaSBarry Smith .  ctx - the monitor context
2903d763cef2SBarry Smith 
2904d763cef2SBarry Smith    Level: intermediate
2905d763cef2SBarry Smith 
2906d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
2907d763cef2SBarry Smith 
29084f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
2909d763cef2SBarry Smith @*/
2910a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
2911d763cef2SBarry Smith {
2912b0a32e0cSBarry Smith   PetscDraw      draw;
2913dfbe8321SBarry Smith   PetscErrorCode ierr;
2914d763cef2SBarry Smith 
2915d763cef2SBarry Smith   PetscFunctionBegin;
29160b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
29176bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
29180b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
29190b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
2920d763cef2SBarry Smith   PetscFunctionReturn(0);
2921d763cef2SBarry Smith }
2922d763cef2SBarry Smith 
29234a2ae208SSatish Balay #undef __FUNCT__
29244a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
2925d763cef2SBarry Smith /*@
2926b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
2927d763cef2SBarry Smith 
2928d763cef2SBarry Smith    Not Collective
2929d763cef2SBarry Smith 
2930d763cef2SBarry Smith    Input Parameter:
2931d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2932d763cef2SBarry Smith 
2933d763cef2SBarry Smith    Output Parameter:
2934d763cef2SBarry Smith .  t  - the current time
2935d763cef2SBarry Smith 
2936d763cef2SBarry Smith    Level: beginner
2937d763cef2SBarry Smith 
2938b8123daeSJed Brown    Note:
2939b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
29409be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
2941b8123daeSJed Brown 
2942d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
2943d763cef2SBarry Smith 
2944d763cef2SBarry Smith .keywords: TS, get, time
2945d763cef2SBarry Smith @*/
29467087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
2947d763cef2SBarry Smith {
2948d763cef2SBarry Smith   PetscFunctionBegin;
29490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2950f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
2951d763cef2SBarry Smith   *t = ts->ptime;
2952d763cef2SBarry Smith   PetscFunctionReturn(0);
2953d763cef2SBarry Smith }
2954d763cef2SBarry Smith 
29554a2ae208SSatish Balay #undef __FUNCT__
29566a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
29576a4d4014SLisandro Dalcin /*@
29586a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
29596a4d4014SLisandro Dalcin 
29603f9fe445SBarry Smith    Logically Collective on TS
29616a4d4014SLisandro Dalcin 
29626a4d4014SLisandro Dalcin    Input Parameters:
29636a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
29646a4d4014SLisandro Dalcin -  time - the time
29656a4d4014SLisandro Dalcin 
29666a4d4014SLisandro Dalcin    Level: intermediate
29676a4d4014SLisandro Dalcin 
29686a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
29696a4d4014SLisandro Dalcin 
29706a4d4014SLisandro Dalcin .keywords: TS, set, time
29716a4d4014SLisandro Dalcin @*/
29727087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
29736a4d4014SLisandro Dalcin {
29746a4d4014SLisandro Dalcin   PetscFunctionBegin;
29750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2976c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
29776a4d4014SLisandro Dalcin   ts->ptime = t;
29786a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
29796a4d4014SLisandro Dalcin }
29806a4d4014SLisandro Dalcin 
29816a4d4014SLisandro Dalcin #undef __FUNCT__
29824a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
2983d763cef2SBarry Smith /*@C
2984d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
2985d763cef2SBarry Smith    TS options in the database.
2986d763cef2SBarry Smith 
29873f9fe445SBarry Smith    Logically Collective on TS
2988d763cef2SBarry Smith 
2989d763cef2SBarry Smith    Input Parameter:
2990d763cef2SBarry Smith +  ts     - The TS context
2991d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
2992d763cef2SBarry Smith 
2993d763cef2SBarry Smith    Notes:
2994d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
2995d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
2996d763cef2SBarry Smith    hyphen.
2997d763cef2SBarry Smith 
2998d763cef2SBarry Smith    Level: advanced
2999d763cef2SBarry Smith 
3000d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3001d763cef2SBarry Smith 
3002d763cef2SBarry Smith .seealso: TSSetFromOptions()
3003d763cef2SBarry Smith 
3004d763cef2SBarry Smith @*/
30057087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3006d763cef2SBarry Smith {
3007dfbe8321SBarry Smith   PetscErrorCode ierr;
3008089b2837SJed Brown   SNES           snes;
3009d763cef2SBarry Smith 
3010d763cef2SBarry Smith   PetscFunctionBegin;
30110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3012d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3013089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3014089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3015d763cef2SBarry Smith   PetscFunctionReturn(0);
3016d763cef2SBarry Smith }
3017d763cef2SBarry Smith 
3018d763cef2SBarry Smith 
30194a2ae208SSatish Balay #undef __FUNCT__
30204a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3021d763cef2SBarry Smith /*@C
3022d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3023d763cef2SBarry Smith    TS options in the database.
3024d763cef2SBarry Smith 
30253f9fe445SBarry Smith    Logically Collective on TS
3026d763cef2SBarry Smith 
3027d763cef2SBarry Smith    Input Parameter:
3028d763cef2SBarry Smith +  ts     - The TS context
3029d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3030d763cef2SBarry Smith 
3031d763cef2SBarry Smith    Notes:
3032d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3033d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3034d763cef2SBarry Smith    hyphen.
3035d763cef2SBarry Smith 
3036d763cef2SBarry Smith    Level: advanced
3037d763cef2SBarry Smith 
3038d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3039d763cef2SBarry Smith 
3040d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3041d763cef2SBarry Smith 
3042d763cef2SBarry Smith @*/
30437087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3044d763cef2SBarry Smith {
3045dfbe8321SBarry Smith   PetscErrorCode ierr;
3046089b2837SJed Brown   SNES           snes;
3047d763cef2SBarry Smith 
3048d763cef2SBarry Smith   PetscFunctionBegin;
30490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3050d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3051089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3052089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3053d763cef2SBarry Smith   PetscFunctionReturn(0);
3054d763cef2SBarry Smith }
3055d763cef2SBarry Smith 
30564a2ae208SSatish Balay #undef __FUNCT__
30574a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3058d763cef2SBarry Smith /*@C
3059d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3060d763cef2SBarry Smith    TS options in the database.
3061d763cef2SBarry Smith 
3062d763cef2SBarry Smith    Not Collective
3063d763cef2SBarry Smith 
3064d763cef2SBarry Smith    Input Parameter:
3065d763cef2SBarry Smith .  ts - The TS context
3066d763cef2SBarry Smith 
3067d763cef2SBarry Smith    Output Parameter:
3068d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3069d763cef2SBarry Smith 
3070d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3071d763cef2SBarry Smith    sufficient length to hold the prefix.
3072d763cef2SBarry Smith 
3073d763cef2SBarry Smith    Level: intermediate
3074d763cef2SBarry Smith 
3075d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3076d763cef2SBarry Smith 
3077d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3078d763cef2SBarry Smith @*/
30797087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3080d763cef2SBarry Smith {
3081dfbe8321SBarry Smith   PetscErrorCode ierr;
3082d763cef2SBarry Smith 
3083d763cef2SBarry Smith   PetscFunctionBegin;
30840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30854482741eSBarry Smith   PetscValidPointer(prefix,2);
3086d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3087d763cef2SBarry Smith   PetscFunctionReturn(0);
3088d763cef2SBarry Smith }
3089d763cef2SBarry Smith 
30904a2ae208SSatish Balay #undef __FUNCT__
30914a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3092d763cef2SBarry Smith /*@C
3093d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3094d763cef2SBarry Smith 
3095d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3096d763cef2SBarry Smith 
3097d763cef2SBarry Smith    Input Parameter:
3098d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3099d763cef2SBarry Smith 
3100d763cef2SBarry Smith    Output Parameters:
3101e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3102e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3103e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3104e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3105d763cef2SBarry Smith 
31060298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3107d763cef2SBarry Smith 
3108d763cef2SBarry Smith    Level: intermediate
3109d763cef2SBarry Smith 
311026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3111d763cef2SBarry Smith 
3112d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3113d763cef2SBarry Smith @*/
3114e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3115d763cef2SBarry Smith {
3116089b2837SJed Brown   PetscErrorCode ierr;
3117089b2837SJed Brown   SNES           snes;
311824989b8cSPeter Brune   DM             dm;
3119089b2837SJed Brown 
3120d763cef2SBarry Smith   PetscFunctionBegin;
3121089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3122e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
312324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
312424989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3125d763cef2SBarry Smith   PetscFunctionReturn(0);
3126d763cef2SBarry Smith }
3127d763cef2SBarry Smith 
31281713a123SBarry Smith #undef __FUNCT__
31292eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
31302eca1d9cSJed Brown /*@C
31312eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
31322eca1d9cSJed Brown 
31332eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
31342eca1d9cSJed Brown 
31352eca1d9cSJed Brown    Input Parameter:
31362eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
31372eca1d9cSJed Brown 
31382eca1d9cSJed Brown    Output Parameters:
3139e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3140e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
31412eca1d9cSJed Brown .  f   - The function to compute the matrices
31422eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
31432eca1d9cSJed Brown 
31440298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
31452eca1d9cSJed Brown 
31462eca1d9cSJed Brown    Level: advanced
31472eca1d9cSJed Brown 
31482eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
31492eca1d9cSJed Brown 
31502eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
31512eca1d9cSJed Brown @*/
3152e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
31532eca1d9cSJed Brown {
3154089b2837SJed Brown   PetscErrorCode ierr;
3155089b2837SJed Brown   SNES           snes;
315624989b8cSPeter Brune   DM             dm;
31570910c330SBarry Smith 
31582eca1d9cSJed Brown   PetscFunctionBegin;
3159089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3160f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3161e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
316224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
316324989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
31642eca1d9cSJed Brown   PetscFunctionReturn(0);
31652eca1d9cSJed Brown }
31662eca1d9cSJed Brown 
31676083293cSBarry Smith 
31682eca1d9cSJed Brown #undef __FUNCT__
316983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
31701713a123SBarry Smith /*@C
317183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
31721713a123SBarry Smith    VecView() for the solution at each timestep
31731713a123SBarry Smith 
31741713a123SBarry Smith    Collective on TS
31751713a123SBarry Smith 
31761713a123SBarry Smith    Input Parameters:
31771713a123SBarry Smith +  ts - the TS context
31781713a123SBarry Smith .  step - current time-step
3179142b95e3SSatish Balay .  ptime - current time
31800298fd71SBarry Smith -  dummy - either a viewer or NULL
31811713a123SBarry Smith 
318299fdda47SBarry Smith    Options Database:
318399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
318499fdda47SBarry Smith 
318599fdda47SBarry Smith    Notes: the initial solution and current solution are not displayed with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
318699fdda47SBarry Smith        will look bad
318799fdda47SBarry Smith 
31881713a123SBarry Smith    Level: intermediate
31891713a123SBarry Smith 
31901713a123SBarry Smith .keywords: TS,  vector, monitor, view
31911713a123SBarry Smith 
3192a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
31931713a123SBarry Smith @*/
31940910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
31951713a123SBarry Smith {
3196dfbe8321SBarry Smith   PetscErrorCode   ierr;
319783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3198473a3ab2SBarry Smith   PetscDraw        draw;
31991713a123SBarry Smith 
32001713a123SBarry Smith   PetscFunctionBegin;
32016083293cSBarry Smith   if (!step && ictx->showinitial) {
32026083293cSBarry Smith     if (!ictx->initialsolution) {
32030910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
32041713a123SBarry Smith     }
32050910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
32066083293cSBarry Smith   }
3207b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
32080dcf80beSBarry Smith 
32096083293cSBarry Smith   if (ictx->showinitial) {
32106083293cSBarry Smith     PetscReal pause;
32116083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
32126083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
32136083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
32146083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
32156083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
32166083293cSBarry Smith   }
32170910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3218473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3219473a3ab2SBarry Smith     PetscReal xl,yl,xr,yr,tw,w,h;
3220473a3ab2SBarry Smith     char      time[32];
3221473a3ab2SBarry Smith     size_t    len;
3222473a3ab2SBarry Smith 
3223473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3224473a3ab2SBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
3225473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3226473a3ab2SBarry Smith     ierr =  PetscStrlen(time,&len);CHKERRQ(ierr);
32270298fd71SBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3228473a3ab2SBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
3229473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3230473a3ab2SBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3231473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3232473a3ab2SBarry Smith   }
3233473a3ab2SBarry Smith 
32346083293cSBarry Smith   if (ictx->showinitial) {
32356083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
32366083293cSBarry Smith   }
32371713a123SBarry Smith   PetscFunctionReturn(0);
32381713a123SBarry Smith }
32391713a123SBarry Smith 
32402d5ee99bSBarry Smith #undef __FUNCT__
32412d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
32422d5ee99bSBarry Smith /*@C
32432d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
32442d5ee99bSBarry Smith 
32452d5ee99bSBarry Smith    Collective on TS
32462d5ee99bSBarry Smith 
32472d5ee99bSBarry Smith    Input Parameters:
32482d5ee99bSBarry Smith +  ts - the TS context
32492d5ee99bSBarry Smith .  step - current time-step
32502d5ee99bSBarry Smith .  ptime - current time
32512d5ee99bSBarry Smith -  dummy - either a viewer or NULL
32522d5ee99bSBarry Smith 
32532d5ee99bSBarry Smith    Level: intermediate
32542d5ee99bSBarry Smith 
32552d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
32562d5ee99bSBarry Smith 
32572d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
32582d5ee99bSBarry Smith @*/
32592d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
32602d5ee99bSBarry Smith {
32612d5ee99bSBarry Smith   PetscErrorCode    ierr;
32622d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
32632d5ee99bSBarry Smith   PetscDraw         draw;
32642d5ee99bSBarry Smith   MPI_Comm          comm;
32652d5ee99bSBarry Smith   PetscInt          n;
32662d5ee99bSBarry Smith   PetscMPIInt       size;
32672d5ee99bSBarry Smith   PetscReal         xl,yl,xr,yr,tw,w,h;
32682d5ee99bSBarry Smith   char              time[32];
32692d5ee99bSBarry Smith   size_t            len;
32702d5ee99bSBarry Smith   const PetscScalar *U;
32712d5ee99bSBarry Smith 
32722d5ee99bSBarry Smith   PetscFunctionBegin;
32732d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
32742d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
32752d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
32762d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
32772d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
32782d5ee99bSBarry Smith 
32792d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
32802d5ee99bSBarry Smith 
32812d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
32824b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3283ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3284a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3285a4494fc1SBarry Smith       PetscFunctionReturn(0);
3286a4494fc1SBarry Smith   }
32872d5ee99bSBarry Smith   if (!step) ictx->color++;
32882d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
32892d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
32902d5ee99bSBarry Smith 
32912d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
32924b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
32932d5ee99bSBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
32942d5ee99bSBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
32952d5ee99bSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
32962d5ee99bSBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
32972d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
32982d5ee99bSBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
32992d5ee99bSBarry Smith   }
33002d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
33012d5ee99bSBarry Smith   PetscFunctionReturn(0);
33022d5ee99bSBarry Smith }
33032d5ee99bSBarry Smith 
33041713a123SBarry Smith 
33056c699258SBarry Smith #undef __FUNCT__
330683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
33076083293cSBarry Smith /*@C
330883a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
33096083293cSBarry Smith 
33106083293cSBarry Smith    Collective on TS
33116083293cSBarry Smith 
33126083293cSBarry Smith    Input Parameters:
33136083293cSBarry Smith .    ctx - the monitor context
33146083293cSBarry Smith 
33156083293cSBarry Smith    Level: intermediate
33166083293cSBarry Smith 
33176083293cSBarry Smith .keywords: TS,  vector, monitor, view
33186083293cSBarry Smith 
331983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
33206083293cSBarry Smith @*/
332183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
33226083293cSBarry Smith {
33236083293cSBarry Smith   PetscErrorCode ierr;
33246083293cSBarry Smith 
33256083293cSBarry Smith   PetscFunctionBegin;
33264b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
332783a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
332883a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
332983a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
33306083293cSBarry Smith   PetscFunctionReturn(0);
33316083293cSBarry Smith }
33326083293cSBarry Smith 
33336083293cSBarry Smith #undef __FUNCT__
333483a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
33356083293cSBarry Smith /*@C
333683a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
33376083293cSBarry Smith 
33386083293cSBarry Smith    Collective on TS
33396083293cSBarry Smith 
33406083293cSBarry Smith    Input Parameter:
33416083293cSBarry Smith .    ts - time-step context
33426083293cSBarry Smith 
33436083293cSBarry Smith    Output Patameter:
33446083293cSBarry Smith .    ctx - the monitor context
33456083293cSBarry Smith 
334699fdda47SBarry Smith    Options Database:
334799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
334899fdda47SBarry Smith 
33496083293cSBarry Smith    Level: intermediate
33506083293cSBarry Smith 
33516083293cSBarry Smith .keywords: TS,  vector, monitor, view
33526083293cSBarry Smith 
335383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
33546083293cSBarry Smith @*/
335583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
33566083293cSBarry Smith {
33576083293cSBarry Smith   PetscErrorCode   ierr;
33586083293cSBarry Smith 
33596083293cSBarry Smith   PetscFunctionBegin;
3360b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
336183a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3362e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3363bbd56ea5SKarl Rupp 
336483a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3365473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
33660298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3367473a3ab2SBarry Smith 
3368473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
33690298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
33702d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
33716083293cSBarry Smith   PetscFunctionReturn(0);
33726083293cSBarry Smith }
33736083293cSBarry Smith 
33746083293cSBarry Smith #undef __FUNCT__
337583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
33763a471f94SBarry Smith /*@C
337783a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
33783a471f94SBarry Smith    VecView() for the error at each timestep
33793a471f94SBarry Smith 
33803a471f94SBarry Smith    Collective on TS
33813a471f94SBarry Smith 
33823a471f94SBarry Smith    Input Parameters:
33833a471f94SBarry Smith +  ts - the TS context
33843a471f94SBarry Smith .  step - current time-step
33853a471f94SBarry Smith .  ptime - current time
33860298fd71SBarry Smith -  dummy - either a viewer or NULL
33873a471f94SBarry Smith 
33883a471f94SBarry Smith    Level: intermediate
33893a471f94SBarry Smith 
33903a471f94SBarry Smith .keywords: TS,  vector, monitor, view
33913a471f94SBarry Smith 
33923a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
33933a471f94SBarry Smith @*/
33940910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
33953a471f94SBarry Smith {
33963a471f94SBarry Smith   PetscErrorCode   ierr;
339783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
339883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
33993a471f94SBarry Smith   Vec              work;
34003a471f94SBarry Smith 
34013a471f94SBarry Smith   PetscFunctionBegin;
3402b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
34030910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
34043a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
34050910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
34063a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
34073a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
34083a471f94SBarry Smith   PetscFunctionReturn(0);
34093a471f94SBarry Smith }
34103a471f94SBarry Smith 
34112a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
34123a471f94SBarry Smith #undef __FUNCT__
34136c699258SBarry Smith #define __FUNCT__ "TSSetDM"
34146c699258SBarry Smith /*@
34156c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
34166c699258SBarry Smith 
34173f9fe445SBarry Smith    Logically Collective on TS and DM
34186c699258SBarry Smith 
34196c699258SBarry Smith    Input Parameters:
34206c699258SBarry Smith +  ts - the preconditioner context
34216c699258SBarry Smith -  dm - the dm
34226c699258SBarry Smith 
34236c699258SBarry Smith    Level: intermediate
34246c699258SBarry Smith 
34256c699258SBarry Smith 
34266c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
34276c699258SBarry Smith @*/
34287087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
34296c699258SBarry Smith {
34306c699258SBarry Smith   PetscErrorCode ierr;
3431089b2837SJed Brown   SNES           snes;
3432942e3340SBarry Smith   DMTS           tsdm;
34336c699258SBarry Smith 
34346c699258SBarry Smith   PetscFunctionBegin;
34350700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
343670663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
3437942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
34382a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
3439942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
3440942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
344124989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
344224989b8cSPeter Brune         tsdm->originaldm = dm;
344324989b8cSPeter Brune       }
344424989b8cSPeter Brune     }
34456bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
344624989b8cSPeter Brune   }
34476c699258SBarry Smith   ts->dm = dm;
3448bbd56ea5SKarl Rupp 
3449089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3450089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
34516c699258SBarry Smith   PetscFunctionReturn(0);
34526c699258SBarry Smith }
34536c699258SBarry Smith 
34546c699258SBarry Smith #undef __FUNCT__
34556c699258SBarry Smith #define __FUNCT__ "TSGetDM"
34566c699258SBarry Smith /*@
34576c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
34586c699258SBarry Smith 
34593f9fe445SBarry Smith    Not Collective
34606c699258SBarry Smith 
34616c699258SBarry Smith    Input Parameter:
34626c699258SBarry Smith . ts - the preconditioner context
34636c699258SBarry Smith 
34646c699258SBarry Smith    Output Parameter:
34656c699258SBarry Smith .  dm - the dm
34666c699258SBarry Smith 
34676c699258SBarry Smith    Level: intermediate
34686c699258SBarry Smith 
34696c699258SBarry Smith 
34706c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
34716c699258SBarry Smith @*/
34727087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
34736c699258SBarry Smith {
3474496e6a7aSJed Brown   PetscErrorCode ierr;
3475496e6a7aSJed Brown 
34766c699258SBarry Smith   PetscFunctionBegin;
34770700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3478496e6a7aSJed Brown   if (!ts->dm) {
3479ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
3480496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
3481496e6a7aSJed Brown   }
34826c699258SBarry Smith   *dm = ts->dm;
34836c699258SBarry Smith   PetscFunctionReturn(0);
34846c699258SBarry Smith }
34851713a123SBarry Smith 
34860f5c6efeSJed Brown #undef __FUNCT__
34870f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
34880f5c6efeSJed Brown /*@
34890f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
34900f5c6efeSJed Brown 
34913f9fe445SBarry Smith    Logically Collective on SNES
34920f5c6efeSJed Brown 
34930f5c6efeSJed Brown    Input Parameter:
3494d42a1c89SJed Brown + snes - nonlinear solver
34950910c330SBarry Smith . U - the current state at which to evaluate the residual
3496d42a1c89SJed Brown - ctx - user context, must be a TS
34970f5c6efeSJed Brown 
34980f5c6efeSJed Brown    Output Parameter:
34990f5c6efeSJed Brown . F - the nonlinear residual
35000f5c6efeSJed Brown 
35010f5c6efeSJed Brown    Notes:
35020f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
35030f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
35040f5c6efeSJed Brown 
35050f5c6efeSJed Brown    Level: advanced
35060f5c6efeSJed Brown 
35070f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
35080f5c6efeSJed Brown @*/
35090910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
35100f5c6efeSJed Brown {
35110f5c6efeSJed Brown   TS             ts = (TS)ctx;
35120f5c6efeSJed Brown   PetscErrorCode ierr;
35130f5c6efeSJed Brown 
35140f5c6efeSJed Brown   PetscFunctionBegin;
35150f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35160910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
35170f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
35180f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
35190910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
35200f5c6efeSJed Brown   PetscFunctionReturn(0);
35210f5c6efeSJed Brown }
35220f5c6efeSJed Brown 
35230f5c6efeSJed Brown #undef __FUNCT__
35240f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
35250f5c6efeSJed Brown /*@
35260f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
35270f5c6efeSJed Brown 
35280f5c6efeSJed Brown    Collective on SNES
35290f5c6efeSJed Brown 
35300f5c6efeSJed Brown    Input Parameter:
35310f5c6efeSJed Brown + snes - nonlinear solver
35320910c330SBarry Smith . U - the current state at which to evaluate the residual
35330f5c6efeSJed Brown - ctx - user context, must be a TS
35340f5c6efeSJed Brown 
35350f5c6efeSJed Brown    Output Parameter:
35360f5c6efeSJed Brown + A - the Jacobian
35370f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
35380f5c6efeSJed Brown - flag - indicates any structure change in the matrix
35390f5c6efeSJed Brown 
35400f5c6efeSJed Brown    Notes:
35410f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
35420f5c6efeSJed Brown 
35430f5c6efeSJed Brown    Level: developer
35440f5c6efeSJed Brown 
35450f5c6efeSJed Brown .seealso: SNESSetJacobian()
35460f5c6efeSJed Brown @*/
3547d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
35480f5c6efeSJed Brown {
35490f5c6efeSJed Brown   TS             ts = (TS)ctx;
35500f5c6efeSJed Brown   PetscErrorCode ierr;
35510f5c6efeSJed Brown 
35520f5c6efeSJed Brown   PetscFunctionBegin;
35530f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
35540910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
35550f5c6efeSJed Brown   PetscValidPointer(A,3);
355694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
35570f5c6efeSJed Brown   PetscValidPointer(B,4);
355894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
35590f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
3560d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
35610f5c6efeSJed Brown   PetscFunctionReturn(0);
35620f5c6efeSJed Brown }
3563325fc9f4SBarry Smith 
35640e4ef248SJed Brown #undef __FUNCT__
35650e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
35660e4ef248SJed Brown /*@C
35670e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
35680e4ef248SJed Brown 
35690e4ef248SJed Brown    Collective on TS
35700e4ef248SJed Brown 
35710e4ef248SJed Brown    Input Arguments:
35720e4ef248SJed Brown +  ts - time stepping context
35730e4ef248SJed Brown .  t - time at which to evaluate
35740910c330SBarry Smith .  U - state at which to evaluate
35750e4ef248SJed Brown -  ctx - context
35760e4ef248SJed Brown 
35770e4ef248SJed Brown    Output Arguments:
35780e4ef248SJed Brown .  F - right hand side
35790e4ef248SJed Brown 
35800e4ef248SJed Brown    Level: intermediate
35810e4ef248SJed Brown 
35820e4ef248SJed Brown    Notes:
35830e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
35840e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
35850e4ef248SJed Brown 
35860e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
35870e4ef248SJed Brown @*/
35880910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
35890e4ef248SJed Brown {
35900e4ef248SJed Brown   PetscErrorCode ierr;
35910e4ef248SJed Brown   Mat            Arhs,Brhs;
35920e4ef248SJed Brown 
35930e4ef248SJed Brown   PetscFunctionBegin;
35940e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
3595d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
35960910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
35970e4ef248SJed Brown   PetscFunctionReturn(0);
35980e4ef248SJed Brown }
35990e4ef248SJed Brown 
36000e4ef248SJed Brown #undef __FUNCT__
36010e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
36020e4ef248SJed Brown /*@C
36030e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
36040e4ef248SJed Brown 
36050e4ef248SJed Brown    Collective on TS
36060e4ef248SJed Brown 
36070e4ef248SJed Brown    Input Arguments:
36080e4ef248SJed Brown +  ts - time stepping context
36090e4ef248SJed Brown .  t - time at which to evaluate
36100910c330SBarry Smith .  U - state at which to evaluate
36110e4ef248SJed Brown -  ctx - context
36120e4ef248SJed Brown 
36130e4ef248SJed Brown    Output Arguments:
36140e4ef248SJed Brown +  A - pointer to operator
36150e4ef248SJed Brown .  B - pointer to preconditioning matrix
36160e4ef248SJed Brown -  flg - matrix structure flag
36170e4ef248SJed Brown 
36180e4ef248SJed Brown    Level: intermediate
36190e4ef248SJed Brown 
36200e4ef248SJed Brown    Notes:
36210e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
36220e4ef248SJed Brown 
36230e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
36240e4ef248SJed Brown @*/
3625d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
36260e4ef248SJed Brown {
36270e4ef248SJed Brown   PetscFunctionBegin;
36280e4ef248SJed Brown   PetscFunctionReturn(0);
36290e4ef248SJed Brown }
36300e4ef248SJed Brown 
36310026cea9SSean Farley #undef __FUNCT__
36320026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
36330026cea9SSean Farley /*@C
36340026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
36350026cea9SSean Farley 
36360026cea9SSean Farley    Collective on TS
36370026cea9SSean Farley 
36380026cea9SSean Farley    Input Arguments:
36390026cea9SSean Farley +  ts - time stepping context
36400026cea9SSean Farley .  t - time at which to evaluate
36410910c330SBarry Smith .  U - state at which to evaluate
36420910c330SBarry Smith .  Udot - time derivative of state vector
36430026cea9SSean Farley -  ctx - context
36440026cea9SSean Farley 
36450026cea9SSean Farley    Output Arguments:
36460026cea9SSean Farley .  F - left hand side
36470026cea9SSean Farley 
36480026cea9SSean Farley    Level: intermediate
36490026cea9SSean Farley 
36500026cea9SSean Farley    Notes:
36510910c330SBarry 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
36520026cea9SSean Farley    user is required to write their own TSComputeIFunction.
36530026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
36540026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
36550026cea9SSean Farley 
36560026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
36570026cea9SSean Farley @*/
36580910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
36590026cea9SSean Farley {
36600026cea9SSean Farley   PetscErrorCode ierr;
36610026cea9SSean Farley   Mat            A,B;
36620026cea9SSean Farley 
36630026cea9SSean Farley   PetscFunctionBegin;
36640298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
3665d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
36660910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
36670026cea9SSean Farley   PetscFunctionReturn(0);
36680026cea9SSean Farley }
36690026cea9SSean Farley 
36700026cea9SSean Farley #undef __FUNCT__
36710026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
36720026cea9SSean Farley /*@C
3673b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
36740026cea9SSean Farley 
36750026cea9SSean Farley    Collective on TS
36760026cea9SSean Farley 
36770026cea9SSean Farley    Input Arguments:
36780026cea9SSean Farley +  ts - time stepping context
36790026cea9SSean Farley .  t - time at which to evaluate
36800910c330SBarry Smith .  U - state at which to evaluate
36810910c330SBarry Smith .  Udot - time derivative of state vector
36820026cea9SSean Farley .  shift - shift to apply
36830026cea9SSean Farley -  ctx - context
36840026cea9SSean Farley 
36850026cea9SSean Farley    Output Arguments:
36860026cea9SSean Farley +  A - pointer to operator
36870026cea9SSean Farley .  B - pointer to preconditioning matrix
36880026cea9SSean Farley -  flg - matrix structure flag
36890026cea9SSean Farley 
3690b41af12eSJed Brown    Level: advanced
36910026cea9SSean Farley 
36920026cea9SSean Farley    Notes:
36930026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
36940026cea9SSean Farley 
3695b41af12eSJed Brown    It is only appropriate for problems of the form
3696b41af12eSJed Brown 
3697b41af12eSJed Brown $     M Udot = F(U,t)
3698b41af12eSJed Brown 
3699b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
3700b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
3701b41af12eSJed Brown   an implicit operator of the form
3702b41af12eSJed Brown 
3703b41af12eSJed Brown $    shift*M + J
3704b41af12eSJed Brown 
3705b41af12eSJed 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
3706b41af12eSJed Brown   a copy of M or reassemble it when requested.
3707b41af12eSJed Brown 
37080026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
37090026cea9SSean Farley @*/
3710d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
37110026cea9SSean Farley {
3712b41af12eSJed Brown   PetscErrorCode ierr;
3713b41af12eSJed Brown 
37140026cea9SSean Farley   PetscFunctionBegin;
371594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
3716b41af12eSJed Brown   ts->ijacobian.shift = shift;
37170026cea9SSean Farley   PetscFunctionReturn(0);
37180026cea9SSean Farley }
3719b41af12eSJed Brown 
3720e817cc15SEmil Constantinescu #undef __FUNCT__
3721e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
3722e817cc15SEmil Constantinescu /*@
3723e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
3724e817cc15SEmil Constantinescu 
3725e817cc15SEmil Constantinescu    Not Collective
3726e817cc15SEmil Constantinescu 
3727e817cc15SEmil Constantinescu    Input Parameter:
3728e817cc15SEmil Constantinescu .  ts - the TS context
3729e817cc15SEmil Constantinescu 
3730e817cc15SEmil Constantinescu    Output Parameter:
37314e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
3732e817cc15SEmil Constantinescu 
3733e817cc15SEmil Constantinescu    Level: beginner
3734e817cc15SEmil Constantinescu 
3735e817cc15SEmil Constantinescu .keywords: TS, equation type
3736e817cc15SEmil Constantinescu 
3737e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
3738e817cc15SEmil Constantinescu @*/
3739e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
3740e817cc15SEmil Constantinescu {
3741e817cc15SEmil Constantinescu   PetscFunctionBegin;
3742e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3743e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
3744e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
3745e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
3746e817cc15SEmil Constantinescu }
3747e817cc15SEmil Constantinescu 
3748e817cc15SEmil Constantinescu #undef __FUNCT__
3749e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
3750e817cc15SEmil Constantinescu /*@
3751e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
3752e817cc15SEmil Constantinescu 
3753e817cc15SEmil Constantinescu    Not Collective
3754e817cc15SEmil Constantinescu 
3755e817cc15SEmil Constantinescu    Input Parameter:
3756e817cc15SEmil Constantinescu +  ts - the TS context
37574e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
3758e817cc15SEmil Constantinescu 
3759e817cc15SEmil Constantinescu    Level: advanced
3760e817cc15SEmil Constantinescu 
3761e817cc15SEmil Constantinescu .keywords: TS, equation type
3762e817cc15SEmil Constantinescu 
3763e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
3764e817cc15SEmil Constantinescu @*/
3765e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
3766e817cc15SEmil Constantinescu {
3767e817cc15SEmil Constantinescu   PetscFunctionBegin;
3768e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3769e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
3770e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
3771e817cc15SEmil Constantinescu }
37720026cea9SSean Farley 
37734af1b03aSJed Brown #undef __FUNCT__
37744af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
37754af1b03aSJed Brown /*@
37764af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
37774af1b03aSJed Brown 
37784af1b03aSJed Brown    Not Collective
37794af1b03aSJed Brown 
37804af1b03aSJed Brown    Input Parameter:
37814af1b03aSJed Brown .  ts - the TS context
37824af1b03aSJed Brown 
37834af1b03aSJed Brown    Output Parameter:
37844af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
37854af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
37864af1b03aSJed Brown 
3787487e0bb9SJed Brown    Level: beginner
37884af1b03aSJed Brown 
3789cd652676SJed Brown    Notes:
3790cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
37914af1b03aSJed Brown 
37924af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
37934af1b03aSJed Brown 
37944af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
37954af1b03aSJed Brown @*/
37964af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
37974af1b03aSJed Brown {
37984af1b03aSJed Brown   PetscFunctionBegin;
37994af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
38004af1b03aSJed Brown   PetscValidPointer(reason,2);
38014af1b03aSJed Brown   *reason = ts->reason;
38024af1b03aSJed Brown   PetscFunctionReturn(0);
38034af1b03aSJed Brown }
38044af1b03aSJed Brown 
3805fb1732b5SBarry Smith #undef __FUNCT__
3806d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
3807d6ad946cSShri Abhyankar /*@
3808d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
3809d6ad946cSShri Abhyankar 
3810d6ad946cSShri Abhyankar    Not Collective
3811d6ad946cSShri Abhyankar 
3812d6ad946cSShri Abhyankar    Input Parameter:
3813d6ad946cSShri Abhyankar +  ts - the TS context
3814d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
3815d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
3816d6ad946cSShri Abhyankar 
3817f5abba47SShri Abhyankar    Level: advanced
3818d6ad946cSShri Abhyankar 
3819d6ad946cSShri Abhyankar    Notes:
3820d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
3821d6ad946cSShri Abhyankar 
3822d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
3823d6ad946cSShri Abhyankar 
3824d6ad946cSShri Abhyankar .seealso: TSConvergedReason
3825d6ad946cSShri Abhyankar @*/
3826d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
3827d6ad946cSShri Abhyankar {
3828d6ad946cSShri Abhyankar   PetscFunctionBegin;
3829d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3830d6ad946cSShri Abhyankar   ts->reason = reason;
3831d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
3832d6ad946cSShri Abhyankar }
3833d6ad946cSShri Abhyankar 
3834d6ad946cSShri Abhyankar #undef __FUNCT__
3835cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
3836cc708dedSBarry Smith /*@
3837cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
3838cc708dedSBarry Smith 
3839cc708dedSBarry Smith    Not Collective
3840cc708dedSBarry Smith 
3841cc708dedSBarry Smith    Input Parameter:
3842cc708dedSBarry Smith .  ts - the TS context
3843cc708dedSBarry Smith 
3844cc708dedSBarry Smith    Output Parameter:
3845cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
3846cc708dedSBarry Smith 
3847487e0bb9SJed Brown    Level: beginner
3848cc708dedSBarry Smith 
3849cc708dedSBarry Smith    Notes:
3850cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
3851cc708dedSBarry Smith 
3852cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
3853cc708dedSBarry Smith 
3854cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
3855cc708dedSBarry Smith @*/
3856cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
3857cc708dedSBarry Smith {
3858cc708dedSBarry Smith   PetscFunctionBegin;
3859cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3860cc708dedSBarry Smith   PetscValidPointer(ftime,2);
3861cc708dedSBarry Smith   *ftime = ts->solvetime;
3862cc708dedSBarry Smith   PetscFunctionReturn(0);
3863cc708dedSBarry Smith }
3864cc708dedSBarry Smith 
3865cc708dedSBarry Smith #undef __FUNCT__
38665ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
38679f67acb7SJed Brown /*@
38685ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
38699f67acb7SJed Brown    used by the time integrator.
38709f67acb7SJed Brown 
38719f67acb7SJed Brown    Not Collective
38729f67acb7SJed Brown 
38739f67acb7SJed Brown    Input Parameter:
38749f67acb7SJed Brown .  ts - TS context
38759f67acb7SJed Brown 
38769f67acb7SJed Brown    Output Parameter:
38779f67acb7SJed Brown .  nits - number of nonlinear iterations
38789f67acb7SJed Brown 
38799f67acb7SJed Brown    Notes:
38809f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
38819f67acb7SJed Brown 
38829f67acb7SJed Brown    Level: intermediate
38839f67acb7SJed Brown 
38849f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
38859f67acb7SJed Brown 
38865ef26d82SJed Brown .seealso:  TSGetKSPIterations()
38879f67acb7SJed Brown @*/
38885ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
38899f67acb7SJed Brown {
38909f67acb7SJed Brown   PetscFunctionBegin;
38919f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
38929f67acb7SJed Brown   PetscValidIntPointer(nits,2);
38935ef26d82SJed Brown   *nits = ts->snes_its;
38949f67acb7SJed Brown   PetscFunctionReturn(0);
38959f67acb7SJed Brown }
38969f67acb7SJed Brown 
38979f67acb7SJed Brown #undef __FUNCT__
38985ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
38999f67acb7SJed Brown /*@
39005ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
39019f67acb7SJed Brown    used by the time integrator.
39029f67acb7SJed Brown 
39039f67acb7SJed Brown    Not Collective
39049f67acb7SJed Brown 
39059f67acb7SJed Brown    Input Parameter:
39069f67acb7SJed Brown .  ts - TS context
39079f67acb7SJed Brown 
39089f67acb7SJed Brown    Output Parameter:
39099f67acb7SJed Brown .  lits - number of linear iterations
39109f67acb7SJed Brown 
39119f67acb7SJed Brown    Notes:
39129f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
39139f67acb7SJed Brown 
39149f67acb7SJed Brown    Level: intermediate
39159f67acb7SJed Brown 
39169f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
39179f67acb7SJed Brown 
39185ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
39199f67acb7SJed Brown @*/
39205ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
39219f67acb7SJed Brown {
39229f67acb7SJed Brown   PetscFunctionBegin;
39239f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39249f67acb7SJed Brown   PetscValidIntPointer(lits,2);
39255ef26d82SJed Brown   *lits = ts->ksp_its;
39269f67acb7SJed Brown   PetscFunctionReturn(0);
39279f67acb7SJed Brown }
39289f67acb7SJed Brown 
39299f67acb7SJed Brown #undef __FUNCT__
3930cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
3931cef5090cSJed Brown /*@
3932cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
3933cef5090cSJed Brown 
3934cef5090cSJed Brown    Not Collective
3935cef5090cSJed Brown 
3936cef5090cSJed Brown    Input Parameter:
3937cef5090cSJed Brown .  ts - TS context
3938cef5090cSJed Brown 
3939cef5090cSJed Brown    Output Parameter:
3940cef5090cSJed Brown .  rejects - number of steps rejected
3941cef5090cSJed Brown 
3942cef5090cSJed Brown    Notes:
3943cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
3944cef5090cSJed Brown 
3945cef5090cSJed Brown    Level: intermediate
3946cef5090cSJed Brown 
3947cef5090cSJed Brown .keywords: TS, get, number
3948cef5090cSJed Brown 
39495ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
3950cef5090cSJed Brown @*/
3951cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
3952cef5090cSJed Brown {
3953cef5090cSJed Brown   PetscFunctionBegin;
3954cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3955cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
3956cef5090cSJed Brown   *rejects = ts->reject;
3957cef5090cSJed Brown   PetscFunctionReturn(0);
3958cef5090cSJed Brown }
3959cef5090cSJed Brown 
3960cef5090cSJed Brown #undef __FUNCT__
3961cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
3962cef5090cSJed Brown /*@
3963cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
3964cef5090cSJed Brown 
3965cef5090cSJed Brown    Not Collective
3966cef5090cSJed Brown 
3967cef5090cSJed Brown    Input Parameter:
3968cef5090cSJed Brown .  ts - TS context
3969cef5090cSJed Brown 
3970cef5090cSJed Brown    Output Parameter:
3971cef5090cSJed Brown .  fails - number of failed nonlinear solves
3972cef5090cSJed Brown 
3973cef5090cSJed Brown    Notes:
3974cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
3975cef5090cSJed Brown 
3976cef5090cSJed Brown    Level: intermediate
3977cef5090cSJed Brown 
3978cef5090cSJed Brown .keywords: TS, get, number
3979cef5090cSJed Brown 
39805ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
3981cef5090cSJed Brown @*/
3982cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
3983cef5090cSJed Brown {
3984cef5090cSJed Brown   PetscFunctionBegin;
3985cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3986cef5090cSJed Brown   PetscValidIntPointer(fails,2);
3987cef5090cSJed Brown   *fails = ts->num_snes_failures;
3988cef5090cSJed Brown   PetscFunctionReturn(0);
3989cef5090cSJed Brown }
3990cef5090cSJed Brown 
3991cef5090cSJed Brown #undef __FUNCT__
3992cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
3993cef5090cSJed Brown /*@
3994cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
3995cef5090cSJed Brown 
3996cef5090cSJed Brown    Not Collective
3997cef5090cSJed Brown 
3998cef5090cSJed Brown    Input Parameter:
3999cef5090cSJed Brown +  ts - TS context
4000cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4001cef5090cSJed Brown 
4002cef5090cSJed Brown    Notes:
4003cef5090cSJed Brown    The counter is reset to zero for each step
4004cef5090cSJed Brown 
4005cef5090cSJed Brown    Options Database Key:
4006cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4007cef5090cSJed Brown 
4008cef5090cSJed Brown    Level: intermediate
4009cef5090cSJed Brown 
4010cef5090cSJed Brown .keywords: TS, set, maximum, number
4011cef5090cSJed Brown 
40125ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4013cef5090cSJed Brown @*/
4014cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4015cef5090cSJed Brown {
4016cef5090cSJed Brown   PetscFunctionBegin;
4017cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4018cef5090cSJed Brown   ts->max_reject = rejects;
4019cef5090cSJed Brown   PetscFunctionReturn(0);
4020cef5090cSJed Brown }
4021cef5090cSJed Brown 
4022cef5090cSJed Brown #undef __FUNCT__
4023cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4024cef5090cSJed Brown /*@
4025cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4026cef5090cSJed Brown 
4027cef5090cSJed Brown    Not Collective
4028cef5090cSJed Brown 
4029cef5090cSJed Brown    Input Parameter:
4030cef5090cSJed Brown +  ts - TS context
4031cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4032cef5090cSJed Brown 
4033cef5090cSJed Brown    Notes:
4034cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4035cef5090cSJed Brown 
4036cef5090cSJed Brown    Options Database Key:
4037cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4038cef5090cSJed Brown 
4039cef5090cSJed Brown    Level: intermediate
4040cef5090cSJed Brown 
4041cef5090cSJed Brown .keywords: TS, set, maximum, number
4042cef5090cSJed Brown 
40435ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4044cef5090cSJed Brown @*/
4045cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4046cef5090cSJed Brown {
4047cef5090cSJed Brown   PetscFunctionBegin;
4048cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4049cef5090cSJed Brown   ts->max_snes_failures = fails;
4050cef5090cSJed Brown   PetscFunctionReturn(0);
4051cef5090cSJed Brown }
4052cef5090cSJed Brown 
4053cef5090cSJed Brown #undef __FUNCT__
40544e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4055cef5090cSJed Brown /*@
4056cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4057cef5090cSJed Brown 
4058cef5090cSJed Brown    Not Collective
4059cef5090cSJed Brown 
4060cef5090cSJed Brown    Input Parameter:
4061cef5090cSJed Brown +  ts - TS context
4062cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4063cef5090cSJed Brown 
4064cef5090cSJed Brown    Options Database Key:
4065cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4066cef5090cSJed Brown 
4067cef5090cSJed Brown    Level: intermediate
4068cef5090cSJed Brown 
4069cef5090cSJed Brown .keywords: TS, set, error
4070cef5090cSJed Brown 
40715ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4072cef5090cSJed Brown @*/
4073cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4074cef5090cSJed Brown {
4075cef5090cSJed Brown   PetscFunctionBegin;
4076cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4077cef5090cSJed Brown   ts->errorifstepfailed = err;
4078cef5090cSJed Brown   PetscFunctionReturn(0);
4079cef5090cSJed Brown }
4080cef5090cSJed Brown 
4081cef5090cSJed Brown #undef __FUNCT__
4082fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4083fb1732b5SBarry Smith /*@C
4084fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4085fb1732b5SBarry Smith 
4086fb1732b5SBarry Smith    Collective on TS
4087fb1732b5SBarry Smith 
4088fb1732b5SBarry Smith    Input Parameters:
4089fb1732b5SBarry Smith +  ts - the TS context
4090fb1732b5SBarry Smith .  step - current time-step
4091fb1732b5SBarry Smith .  ptime - current time
40920910c330SBarry Smith .  u - current state
4093fb1732b5SBarry Smith -  viewer - binary viewer
4094fb1732b5SBarry Smith 
4095fb1732b5SBarry Smith    Level: intermediate
4096fb1732b5SBarry Smith 
4097fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4098fb1732b5SBarry Smith 
4099fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4100fb1732b5SBarry Smith @*/
41010910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4102fb1732b5SBarry Smith {
4103fb1732b5SBarry Smith   PetscErrorCode ierr;
4104ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4105fb1732b5SBarry Smith 
4106fb1732b5SBarry Smith   PetscFunctionBegin;
41070910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4108ed81e22dSJed Brown   PetscFunctionReturn(0);
4109ed81e22dSJed Brown }
4110ed81e22dSJed Brown 
4111ed81e22dSJed Brown #undef __FUNCT__
4112ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4113ed81e22dSJed Brown /*@C
4114ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4115ed81e22dSJed Brown 
4116ed81e22dSJed Brown    Collective on TS
4117ed81e22dSJed Brown 
4118ed81e22dSJed Brown    Input Parameters:
4119ed81e22dSJed Brown +  ts - the TS context
4120ed81e22dSJed Brown .  step - current time-step
4121ed81e22dSJed Brown .  ptime - current time
41220910c330SBarry Smith .  u - current state
4123ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4124ed81e22dSJed Brown 
4125ed81e22dSJed Brown    Level: intermediate
4126ed81e22dSJed Brown 
4127ed81e22dSJed Brown    Notes:
4128ed81e22dSJed 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.
4129ed81e22dSJed Brown    These are named according to the file name template.
4130ed81e22dSJed Brown 
4131ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4132ed81e22dSJed Brown 
4133ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4134ed81e22dSJed Brown 
4135ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4136ed81e22dSJed Brown @*/
41370910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4138ed81e22dSJed Brown {
4139ed81e22dSJed Brown   PetscErrorCode ierr;
4140ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4141ed81e22dSJed Brown   PetscViewer    viewer;
4142ed81e22dSJed Brown 
4143ed81e22dSJed Brown   PetscFunctionBegin;
41448caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4145ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
41460910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4147ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4148ed81e22dSJed Brown   PetscFunctionReturn(0);
4149ed81e22dSJed Brown }
4150ed81e22dSJed Brown 
4151ed81e22dSJed Brown #undef __FUNCT__
4152ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4153ed81e22dSJed Brown /*@C
4154ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4155ed81e22dSJed Brown 
4156ed81e22dSJed Brown    Collective on TS
4157ed81e22dSJed Brown 
4158ed81e22dSJed Brown    Input Parameters:
4159ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4160ed81e22dSJed Brown 
4161ed81e22dSJed Brown    Level: intermediate
4162ed81e22dSJed Brown 
4163ed81e22dSJed Brown    Note:
4164ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4165ed81e22dSJed Brown 
4166ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4167ed81e22dSJed Brown 
4168ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4169ed81e22dSJed Brown @*/
4170ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4171ed81e22dSJed Brown {
4172ed81e22dSJed Brown   PetscErrorCode ierr;
4173ed81e22dSJed Brown 
4174ed81e22dSJed Brown   PetscFunctionBegin;
4175ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4176fb1732b5SBarry Smith   PetscFunctionReturn(0);
4177fb1732b5SBarry Smith }
4178fb1732b5SBarry Smith 
417984df9cb4SJed Brown #undef __FUNCT__
4180552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
418184df9cb4SJed Brown /*@
4182552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
418384df9cb4SJed Brown 
4184ed81e22dSJed Brown    Collective on TS if controller has not been created yet
418584df9cb4SJed Brown 
418684df9cb4SJed Brown    Input Arguments:
4187ed81e22dSJed Brown .  ts - time stepping context
418884df9cb4SJed Brown 
418984df9cb4SJed Brown    Output Arguments:
4190ed81e22dSJed Brown .  adapt - adaptive controller
419184df9cb4SJed Brown 
419284df9cb4SJed Brown    Level: intermediate
419384df9cb4SJed Brown 
4194ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
419584df9cb4SJed Brown @*/
4196552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
419784df9cb4SJed Brown {
419884df9cb4SJed Brown   PetscErrorCode ierr;
419984df9cb4SJed Brown 
420084df9cb4SJed Brown   PetscFunctionBegin;
420184df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
420284df9cb4SJed Brown   PetscValidPointer(adapt,2);
420384df9cb4SJed Brown   if (!ts->adapt) {
4204ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
42053bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
42061c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
420784df9cb4SJed Brown   }
420884df9cb4SJed Brown   *adapt = ts->adapt;
420984df9cb4SJed Brown   PetscFunctionReturn(0);
421084df9cb4SJed Brown }
4211d6ebe24aSShri Abhyankar 
4212d6ebe24aSShri Abhyankar #undef __FUNCT__
42131c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
42141c3436cfSJed Brown /*@
42151c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
42161c3436cfSJed Brown 
42171c3436cfSJed Brown    Logically Collective
42181c3436cfSJed Brown 
42191c3436cfSJed Brown    Input Arguments:
42201c3436cfSJed Brown +  ts - time integration context
42211c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
42220298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
42231c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
42240298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
42251c3436cfSJed Brown 
4226a3cdaa26SBarry Smith    Options Database keys:
4227a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4228a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4229a3cdaa26SBarry Smith 
42301c3436cfSJed Brown    Level: beginner
42311c3436cfSJed Brown 
4232c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
42331c3436cfSJed Brown @*/
42341c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
42351c3436cfSJed Brown {
42361c3436cfSJed Brown   PetscErrorCode ierr;
42371c3436cfSJed Brown 
42381c3436cfSJed Brown   PetscFunctionBegin;
4239c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
42401c3436cfSJed Brown   if (vatol) {
42411c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
42421c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4243bbd56ea5SKarl Rupp 
42441c3436cfSJed Brown     ts->vatol = vatol;
42451c3436cfSJed Brown   }
4246c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
42471c3436cfSJed Brown   if (vrtol) {
42481c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
42491c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4250bbd56ea5SKarl Rupp 
42511c3436cfSJed Brown     ts->vrtol = vrtol;
42521c3436cfSJed Brown   }
42531c3436cfSJed Brown   PetscFunctionReturn(0);
42541c3436cfSJed Brown }
42551c3436cfSJed Brown 
42561c3436cfSJed Brown #undef __FUNCT__
4257c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4258c5033834SJed Brown /*@
4259c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4260c5033834SJed Brown 
4261c5033834SJed Brown    Logically Collective
4262c5033834SJed Brown 
4263c5033834SJed Brown    Input Arguments:
4264c5033834SJed Brown .  ts - time integration context
4265c5033834SJed Brown 
4266c5033834SJed Brown    Output Arguments:
42670298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
42680298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
42690298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
42700298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4271c5033834SJed Brown 
4272c5033834SJed Brown    Level: beginner
4273c5033834SJed Brown 
4274c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4275c5033834SJed Brown @*/
4276c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4277c5033834SJed Brown {
4278c5033834SJed Brown   PetscFunctionBegin;
4279c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4280c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4281c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4282c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4283c5033834SJed Brown   PetscFunctionReturn(0);
4284c5033834SJed Brown }
4285c5033834SJed Brown 
4286c5033834SJed Brown #undef __FUNCT__
42871c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
42881c3436cfSJed Brown /*@
42891c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
42901c3436cfSJed Brown 
42911c3436cfSJed Brown    Collective on TS
42921c3436cfSJed Brown 
42931c3436cfSJed Brown    Input Arguments:
42941c3436cfSJed Brown +  ts - time stepping context
42951c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
42961c3436cfSJed Brown 
42971c3436cfSJed Brown    Output Arguments:
42981c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
42991c3436cfSJed Brown 
43001c3436cfSJed Brown    Level: developer
43011c3436cfSJed Brown 
43021c3436cfSJed Brown .seealso: TSSetTolerances()
43031c3436cfSJed Brown @*/
43041c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
43051c3436cfSJed Brown {
43061c3436cfSJed Brown   PetscErrorCode    ierr;
43071c3436cfSJed Brown   PetscInt          i,n,N;
43080910c330SBarry Smith   const PetscScalar *u,*y;
43090910c330SBarry Smith   Vec               U;
43101c3436cfSJed Brown   PetscReal         sum,gsum;
43111c3436cfSJed Brown 
43121c3436cfSJed Brown   PetscFunctionBegin;
43131c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
43141c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
43151c3436cfSJed Brown   PetscValidPointer(norm,3);
43160910c330SBarry Smith   U = ts->vec_sol;
43170910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
4318ce94432eSBarry Smith   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
43191c3436cfSJed Brown 
43200910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
43210910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
43220910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
43231c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
43241c3436cfSJed Brown   sum  = 0.;
4325ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
4326ceefc113SJed Brown     const PetscScalar *atol,*rtol;
4327ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4328ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4329ceefc113SJed Brown     for (i=0; i<n; i++) {
43300910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
43310910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4332ceefc113SJed Brown     }
4333ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4334ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4335ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4336ceefc113SJed Brown     const PetscScalar *atol;
4337ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4338ceefc113SJed Brown     for (i=0; i<n; i++) {
43390910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
43400910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4341ceefc113SJed Brown     }
4342ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4343ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4344ceefc113SJed Brown     const PetscScalar *rtol;
4345ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4346ceefc113SJed Brown     for (i=0; i<n; i++) {
43470910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
43480910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4349ceefc113SJed Brown     }
4350ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4351ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
43521c3436cfSJed Brown     for (i=0; i<n; i++) {
43530910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
43540910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
43551c3436cfSJed Brown     }
4356ceefc113SJed Brown   }
43570910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
43581c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
43591c3436cfSJed Brown 
4360ce94432eSBarry Smith   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
43611c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
4362620fc8aaSSatish Balay   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
43631c3436cfSJed Brown   PetscFunctionReturn(0);
43641c3436cfSJed Brown }
43651c3436cfSJed Brown 
43661c3436cfSJed Brown #undef __FUNCT__
43678d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
43688d59e960SJed Brown /*@
43698d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
43708d59e960SJed Brown 
43718d59e960SJed Brown    Logically Collective on TS
43728d59e960SJed Brown 
43738d59e960SJed Brown    Input Arguments:
43748d59e960SJed Brown +  ts - time stepping context
43758d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
43768d59e960SJed Brown 
43778d59e960SJed Brown    Note:
43788d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
43798d59e960SJed Brown 
43808d59e960SJed Brown    Level: intermediate
43818d59e960SJed Brown 
43828d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
43838d59e960SJed Brown @*/
43848d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
43858d59e960SJed Brown {
43868d59e960SJed Brown   PetscFunctionBegin;
43878d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
43888d59e960SJed Brown   ts->cfltime_local = cfltime;
43898d59e960SJed Brown   ts->cfltime       = -1.;
43908d59e960SJed Brown   PetscFunctionReturn(0);
43918d59e960SJed Brown }
43928d59e960SJed Brown 
43938d59e960SJed Brown #undef __FUNCT__
43948d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
43958d59e960SJed Brown /*@
43968d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
43978d59e960SJed Brown 
43988d59e960SJed Brown    Collective on TS
43998d59e960SJed Brown 
44008d59e960SJed Brown    Input Arguments:
44018d59e960SJed Brown .  ts - time stepping context
44028d59e960SJed Brown 
44038d59e960SJed Brown    Output Arguments:
44048d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
44058d59e960SJed Brown 
44068d59e960SJed Brown    Level: advanced
44078d59e960SJed Brown 
44088d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
44098d59e960SJed Brown @*/
44108d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
44118d59e960SJed Brown {
44128d59e960SJed Brown   PetscErrorCode ierr;
44138d59e960SJed Brown 
44148d59e960SJed Brown   PetscFunctionBegin;
44158d59e960SJed Brown   if (ts->cfltime < 0) {
4416ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
44178d59e960SJed Brown   }
44188d59e960SJed Brown   *cfltime = ts->cfltime;
44198d59e960SJed Brown   PetscFunctionReturn(0);
44208d59e960SJed Brown }
44218d59e960SJed Brown 
44228d59e960SJed Brown #undef __FUNCT__
4423d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
4424d6ebe24aSShri Abhyankar /*@
4425d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
4426d6ebe24aSShri Abhyankar 
4427d6ebe24aSShri Abhyankar    Input Parameters:
4428d6ebe24aSShri Abhyankar .  ts   - the TS context.
4429d6ebe24aSShri Abhyankar .  xl   - lower bound.
4430d6ebe24aSShri Abhyankar .  xu   - upper bound.
4431d6ebe24aSShri Abhyankar 
4432d6ebe24aSShri Abhyankar    Notes:
4433d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
4434e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
4435d6ebe24aSShri Abhyankar 
44362bd2b0e6SSatish Balay    Level: advanced
44372bd2b0e6SSatish Balay 
4438d6ebe24aSShri Abhyankar @*/
4439d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
4440d6ebe24aSShri Abhyankar {
4441d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
4442d6ebe24aSShri Abhyankar   SNES           snes;
4443d6ebe24aSShri Abhyankar 
4444d6ebe24aSShri Abhyankar   PetscFunctionBegin;
4445d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4446d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
4447d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
4448d6ebe24aSShri Abhyankar }
4449d6ebe24aSShri Abhyankar 
4450325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4451c6db04a5SJed Brown #include <mex.h>
4452325fc9f4SBarry Smith 
4453325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
4454325fc9f4SBarry Smith 
4455325fc9f4SBarry Smith #undef __FUNCT__
4456325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
4457325fc9f4SBarry Smith /*
4458325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
4459325fc9f4SBarry Smith                          TSSetFunctionMatlab().
4460325fc9f4SBarry Smith 
4461325fc9f4SBarry Smith    Collective on TS
4462325fc9f4SBarry Smith 
4463325fc9f4SBarry Smith    Input Parameters:
4464325fc9f4SBarry Smith +  snes - the TS context
44650910c330SBarry Smith -  u - input vector
4466325fc9f4SBarry Smith 
4467325fc9f4SBarry Smith    Output Parameter:
4468325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
4469325fc9f4SBarry Smith 
4470325fc9f4SBarry Smith    Notes:
4471325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
4472325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
4473325fc9f4SBarry Smith    themselves.
4474325fc9f4SBarry Smith 
4475325fc9f4SBarry Smith    Level: developer
4476325fc9f4SBarry Smith 
4477325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4478325fc9f4SBarry Smith 
4479325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4480325fc9f4SBarry Smith */
44810910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
4482325fc9f4SBarry Smith {
4483325fc9f4SBarry Smith   PetscErrorCode  ierr;
4484325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4485325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
4486325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
4487325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
4488325fc9f4SBarry Smith 
4489325fc9f4SBarry Smith   PetscFunctionBegin;
4490325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
44910910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
44920910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
4493325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
44940910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
4495325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
4496325fc9f4SBarry Smith 
4497325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
44980910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
44990910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
45000910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
4501bbd56ea5SKarl Rupp 
4502325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4503325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
4504325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4505325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4506325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
4507325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
4508325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
4509325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
4510325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4511325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4512325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4513325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4514325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4515325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4516325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4517325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4518325fc9f4SBarry Smith   PetscFunctionReturn(0);
4519325fc9f4SBarry Smith }
4520325fc9f4SBarry Smith 
4521325fc9f4SBarry Smith 
4522325fc9f4SBarry Smith #undef __FUNCT__
4523325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
4524325fc9f4SBarry Smith /*
4525325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
4526325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
4527e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
4528325fc9f4SBarry Smith 
4529325fc9f4SBarry Smith    Logically Collective on TS
4530325fc9f4SBarry Smith 
4531325fc9f4SBarry Smith    Input Parameters:
4532325fc9f4SBarry Smith +  ts - the TS context
4533325fc9f4SBarry Smith -  func - function evaluation routine
4534325fc9f4SBarry Smith 
4535325fc9f4SBarry Smith    Calling sequence of func:
45360910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
4537325fc9f4SBarry Smith 
4538325fc9f4SBarry Smith    Level: beginner
4539325fc9f4SBarry Smith 
4540325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4541325fc9f4SBarry Smith 
4542325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4543325fc9f4SBarry Smith */
4544cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
4545325fc9f4SBarry Smith {
4546325fc9f4SBarry Smith   PetscErrorCode  ierr;
4547325fc9f4SBarry Smith   TSMatlabContext *sctx;
4548325fc9f4SBarry Smith 
4549325fc9f4SBarry Smith   PetscFunctionBegin;
4550325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4551325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4552325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4553325fc9f4SBarry Smith   /*
4554325fc9f4SBarry Smith      This should work, but it doesn't
4555325fc9f4SBarry Smith   sctx->ctx = ctx;
4556325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4557325fc9f4SBarry Smith   */
4558325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4559bbd56ea5SKarl Rupp 
45600298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
4561325fc9f4SBarry Smith   PetscFunctionReturn(0);
4562325fc9f4SBarry Smith }
4563325fc9f4SBarry Smith 
4564325fc9f4SBarry Smith #undef __FUNCT__
4565325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
4566325fc9f4SBarry Smith /*
4567325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
4568325fc9f4SBarry Smith                          TSSetJacobianMatlab().
4569325fc9f4SBarry Smith 
4570325fc9f4SBarry Smith    Collective on TS
4571325fc9f4SBarry Smith 
4572325fc9f4SBarry Smith    Input Parameters:
4573cdcf91faSSean Farley +  ts - the TS context
45740910c330SBarry Smith .  u - input vector
4575325fc9f4SBarry Smith .  A, B - the matrices
4576325fc9f4SBarry Smith -  ctx - user context
4577325fc9f4SBarry Smith 
4578325fc9f4SBarry Smith    Level: developer
4579325fc9f4SBarry Smith 
4580325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4581325fc9f4SBarry Smith 
4582325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4583325fc9f4SBarry Smith @*/
4584f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
4585325fc9f4SBarry Smith {
4586325fc9f4SBarry Smith   PetscErrorCode  ierr;
4587325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4588325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
4589325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
4590325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
4591325fc9f4SBarry Smith 
4592325fc9f4SBarry Smith   PetscFunctionBegin;
4593cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45940910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
4595325fc9f4SBarry Smith 
45960910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
4597325fc9f4SBarry Smith 
4598cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
45990910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
46000910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
46010910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
46020910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
4603bbd56ea5SKarl Rupp 
4604325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4605325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
4606325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4607325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4608325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
4609325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
4610325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
4611325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
4612325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
4613325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
4614325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4615325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4616325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4617325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4618325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4619325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4620325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4621325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
4622325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
4623325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4624325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
4625325fc9f4SBarry Smith   PetscFunctionReturn(0);
4626325fc9f4SBarry Smith }
4627325fc9f4SBarry Smith 
4628325fc9f4SBarry Smith 
4629325fc9f4SBarry Smith #undef __FUNCT__
4630325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
4631325fc9f4SBarry Smith /*
4632325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
4633e3c5b3baSBarry 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
4634325fc9f4SBarry Smith 
4635325fc9f4SBarry Smith    Logically Collective on TS
4636325fc9f4SBarry Smith 
4637325fc9f4SBarry Smith    Input Parameters:
4638cdcf91faSSean Farley +  ts - the TS context
4639325fc9f4SBarry Smith .  A,B - Jacobian matrices
4640325fc9f4SBarry Smith .  func - function evaluation routine
4641325fc9f4SBarry Smith -  ctx - user context
4642325fc9f4SBarry Smith 
4643325fc9f4SBarry Smith    Calling sequence of func:
46440910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
4645325fc9f4SBarry Smith 
4646325fc9f4SBarry Smith 
4647325fc9f4SBarry Smith    Level: developer
4648325fc9f4SBarry Smith 
4649325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4650325fc9f4SBarry Smith 
4651325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4652325fc9f4SBarry Smith */
4653cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
4654325fc9f4SBarry Smith {
4655325fc9f4SBarry Smith   PetscErrorCode  ierr;
4656325fc9f4SBarry Smith   TSMatlabContext *sctx;
4657325fc9f4SBarry Smith 
4658325fc9f4SBarry Smith   PetscFunctionBegin;
4659325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4660325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4661325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4662325fc9f4SBarry Smith   /*
4663325fc9f4SBarry Smith      This should work, but it doesn't
4664325fc9f4SBarry Smith   sctx->ctx = ctx;
4665325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4666325fc9f4SBarry Smith   */
4667325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4668bbd56ea5SKarl Rupp 
4669cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
4670325fc9f4SBarry Smith   PetscFunctionReturn(0);
4671325fc9f4SBarry Smith }
4672325fc9f4SBarry Smith 
4673b5b1a830SBarry Smith #undef __FUNCT__
4674b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
4675b5b1a830SBarry Smith /*
4676b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
4677b5b1a830SBarry Smith 
4678b5b1a830SBarry Smith    Collective on TS
4679b5b1a830SBarry Smith 
4680b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4681b5b1a830SBarry Smith @*/
46820910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
4683b5b1a830SBarry Smith {
4684b5b1a830SBarry Smith   PetscErrorCode  ierr;
4685b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4686a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
4687b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
4688b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
4689b5b1a830SBarry Smith 
4690b5b1a830SBarry Smith   PetscFunctionBegin;
4691cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46920910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4693b5b1a830SBarry Smith 
4694cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
46950910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
4696bbd56ea5SKarl Rupp 
4697b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4698b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
4699b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
4700b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
4701b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
4702b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
4703b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
4704b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4705b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
4706b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
4707b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
4708b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
4709b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
4710b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
4711b5b1a830SBarry Smith   PetscFunctionReturn(0);
4712b5b1a830SBarry Smith }
4713b5b1a830SBarry Smith 
4714b5b1a830SBarry Smith 
4715b5b1a830SBarry Smith #undef __FUNCT__
4716b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
4717b5b1a830SBarry Smith /*
4718b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
4719b5b1a830SBarry Smith 
4720b5b1a830SBarry Smith    Level: developer
4721b5b1a830SBarry Smith 
4722b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
4723b5b1a830SBarry Smith 
4724b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4725b5b1a830SBarry Smith */
4726cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
4727b5b1a830SBarry Smith {
4728b5b1a830SBarry Smith   PetscErrorCode  ierr;
4729b5b1a830SBarry Smith   TSMatlabContext *sctx;
4730b5b1a830SBarry Smith 
4731b5b1a830SBarry Smith   PetscFunctionBegin;
4732b5b1a830SBarry Smith   /* currently sctx is memory bleed */
4733b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4734b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4735b5b1a830SBarry Smith   /*
4736b5b1a830SBarry Smith      This should work, but it doesn't
4737b5b1a830SBarry Smith   sctx->ctx = ctx;
4738b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4739b5b1a830SBarry Smith   */
4740b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4741bbd56ea5SKarl Rupp 
47420298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
4743b5b1a830SBarry Smith   PetscFunctionReturn(0);
4744b5b1a830SBarry Smith }
4745325fc9f4SBarry Smith #endif
4746b3603a34SBarry Smith 
47470b039ecaSBarry Smith 
47480b039ecaSBarry Smith 
4749b3603a34SBarry Smith #undef __FUNCT__
47504f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
4751b3603a34SBarry Smith /*@C
47524f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
4753b3603a34SBarry Smith        in a time based line graph
4754b3603a34SBarry Smith 
4755b3603a34SBarry Smith    Collective on TS
4756b3603a34SBarry Smith 
4757b3603a34SBarry Smith    Input Parameters:
4758b3603a34SBarry Smith +  ts - the TS context
4759b3603a34SBarry Smith .  step - current time-step
4760b3603a34SBarry Smith .  ptime - current time
4761b3603a34SBarry Smith -  lg - a line graph object
4762b3603a34SBarry Smith 
4763b3603a34SBarry Smith    Level: intermediate
4764b3603a34SBarry Smith 
47650b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
4766b3603a34SBarry Smith 
4767b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
4768b3603a34SBarry Smith 
4769b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4770b3603a34SBarry Smith @*/
47710910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4772b3603a34SBarry Smith {
4773b3603a34SBarry Smith   PetscErrorCode    ierr;
47740b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
4775b3603a34SBarry Smith   const PetscScalar *yy;
477658ff32f7SBarry Smith   PetscInt          dim;
4777b3603a34SBarry Smith 
4778b3603a34SBarry Smith   PetscFunctionBegin;
477958ff32f7SBarry Smith   if (!step) {
4780a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4781a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4782a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
47830910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
47840b039ecaSBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
47850b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
478658ff32f7SBarry Smith   }
47870910c330SBarry Smith   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
4788e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
4789e3efe391SJed Brown   {
4790e3efe391SJed Brown     PetscReal *yreal;
4791e3efe391SJed Brown     PetscInt  i,n;
47920910c330SBarry Smith     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
4793785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
4794e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
47950b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
4796e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
4797e3efe391SJed Brown   }
4798e3efe391SJed Brown #else
47990b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
4800e3efe391SJed Brown #endif
48010910c330SBarry Smith   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
4802b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
48030b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
48043923b477SBarry Smith   }
4805b3603a34SBarry Smith   PetscFunctionReturn(0);
4806b3603a34SBarry Smith }
4807b3603a34SBarry Smith 
4808b3603a34SBarry Smith #undef __FUNCT__
48094f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
4810ef20d060SBarry Smith /*@C
48114f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
4812ef20d060SBarry Smith        in a time based line graph
4813ef20d060SBarry Smith 
4814ef20d060SBarry Smith    Collective on TS
4815ef20d060SBarry Smith 
4816ef20d060SBarry Smith    Input Parameters:
4817ef20d060SBarry Smith +  ts - the TS context
4818ef20d060SBarry Smith .  step - current time-step
4819ef20d060SBarry Smith .  ptime - current time
4820ef20d060SBarry Smith -  lg - a line graph object
4821ef20d060SBarry Smith 
4822ef20d060SBarry Smith    Level: intermediate
4823ef20d060SBarry Smith 
4824abd5a294SJed Brown    Notes:
4825abd5a294SJed Brown    Only for sequential solves.
4826abd5a294SJed Brown 
4827abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
4828abd5a294SJed Brown 
4829abd5a294SJed Brown    Options Database Keys:
48304f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
4831ef20d060SBarry Smith 
4832ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
4833ef20d060SBarry Smith 
4834abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
4835ef20d060SBarry Smith @*/
48360910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4837ef20d060SBarry Smith {
4838ef20d060SBarry Smith   PetscErrorCode    ierr;
48390b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
4840ef20d060SBarry Smith   const PetscScalar *yy;
4841ef20d060SBarry Smith   Vec               y;
4842a9f9c1f6SBarry Smith   PetscInt          dim;
4843ef20d060SBarry Smith 
4844ef20d060SBarry Smith   PetscFunctionBegin;
4845a9f9c1f6SBarry Smith   if (!step) {
4846a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4847a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
48481ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
48490910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
4850a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
4851a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4852a9f9c1f6SBarry Smith   }
48530910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
4854ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
48550910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
4856ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
4857e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
4858e3efe391SJed Brown   {
4859e3efe391SJed Brown     PetscReal *yreal;
4860e3efe391SJed Brown     PetscInt  i,n;
4861e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
4862785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
4863e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
48640b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
4865e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
4866e3efe391SJed Brown   }
4867e3efe391SJed Brown #else
48680b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
4869e3efe391SJed Brown #endif
4870ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
4871ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
4872b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
48730b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
48743923b477SBarry Smith   }
4875ef20d060SBarry Smith   PetscFunctionReturn(0);
4876ef20d060SBarry Smith }
4877ef20d060SBarry Smith 
4878201da799SBarry Smith #undef __FUNCT__
4879201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
4880201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
4881201da799SBarry Smith {
4882201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4883201da799SBarry Smith   PetscReal      x   = ptime,y;
4884201da799SBarry Smith   PetscErrorCode ierr;
4885201da799SBarry Smith   PetscInt       its;
4886201da799SBarry Smith 
4887201da799SBarry Smith   PetscFunctionBegin;
4888201da799SBarry Smith   if (!n) {
4889201da799SBarry Smith     PetscDrawAxis axis;
4890bbd56ea5SKarl Rupp 
4891201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4892201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
4893201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4894bbd56ea5SKarl Rupp 
4895201da799SBarry Smith     ctx->snes_its = 0;
4896201da799SBarry Smith   }
4897201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
4898201da799SBarry Smith   y    = its - ctx->snes_its;
4899201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
49003fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
4901201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
4902201da799SBarry Smith   }
4903201da799SBarry Smith   ctx->snes_its = its;
4904201da799SBarry Smith   PetscFunctionReturn(0);
4905201da799SBarry Smith }
4906201da799SBarry Smith 
4907201da799SBarry Smith #undef __FUNCT__
4908201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
4909201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
4910201da799SBarry Smith {
4911201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
4912201da799SBarry Smith   PetscReal      x   = ptime,y;
4913201da799SBarry Smith   PetscErrorCode ierr;
4914201da799SBarry Smith   PetscInt       its;
4915201da799SBarry Smith 
4916201da799SBarry Smith   PetscFunctionBegin;
4917201da799SBarry Smith   if (!n) {
4918201da799SBarry Smith     PetscDrawAxis axis;
4919bbd56ea5SKarl Rupp 
4920201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4921201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
4922201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
4923bbd56ea5SKarl Rupp 
4924201da799SBarry Smith     ctx->ksp_its = 0;
4925201da799SBarry Smith   }
4926201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
4927201da799SBarry Smith   y    = its - ctx->ksp_its;
4928201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
492999fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
4930201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
4931201da799SBarry Smith   }
4932201da799SBarry Smith   ctx->ksp_its = its;
4933201da799SBarry Smith   PetscFunctionReturn(0);
4934201da799SBarry Smith }
4935f9c1d6abSBarry Smith 
4936f9c1d6abSBarry Smith #undef __FUNCT__
4937f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
4938f9c1d6abSBarry Smith /*@
4939f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
4940f9c1d6abSBarry Smith 
4941f9c1d6abSBarry Smith    Collective on TS and Vec
4942f9c1d6abSBarry Smith 
4943f9c1d6abSBarry Smith    Input Parameters:
4944f9c1d6abSBarry Smith +  ts - the TS context
4945f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
4946f9c1d6abSBarry Smith 
4947f9c1d6abSBarry Smith    Output Parameters:
4948f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
4949f9c1d6abSBarry Smith 
4950f9c1d6abSBarry Smith    Level: developer
4951f9c1d6abSBarry Smith 
4952f9c1d6abSBarry Smith .keywords: TS, compute
4953f9c1d6abSBarry Smith 
4954f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
4955f9c1d6abSBarry Smith @*/
4956f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
4957f9c1d6abSBarry Smith {
4958f9c1d6abSBarry Smith   PetscErrorCode ierr;
4959f9c1d6abSBarry Smith 
4960f9c1d6abSBarry Smith   PetscFunctionBegin;
4961f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4962ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
4963f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
4964f9c1d6abSBarry Smith   PetscFunctionReturn(0);
4965f9c1d6abSBarry Smith }
496624655328SShri 
496724655328SShri #undef __FUNCT__
496824655328SShri #define __FUNCT__ "TSRollBack"
496924655328SShri /*@
497024655328SShri    TSRollBack - Rolls back one time step
497124655328SShri 
497224655328SShri    Collective on TS
497324655328SShri 
497424655328SShri    Input Parameter:
497524655328SShri .  ts - the TS context obtained from TSCreate()
497624655328SShri 
497724655328SShri    Level: advanced
497824655328SShri 
497924655328SShri .keywords: TS, timestep, rollback
498024655328SShri 
498124655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
498224655328SShri @*/
498324655328SShri PetscErrorCode  TSRollBack(TS ts)
498424655328SShri {
498524655328SShri   PetscErrorCode ierr;
498624655328SShri 
498724655328SShri   PetscFunctionBegin;
498824655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
498924655328SShri 
499024655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
499124655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
499224655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
499324655328SShri   ts->ptime = ts->ptime_prev;
499424655328SShri   PetscFunctionReturn(0);
499524655328SShri }
4996aeb4809dSShri Abhyankar 
4997