xref: /petsc/src/ts/interface/ts.c (revision 08c7845f0c2a2e52d986918e331abfc731af709e)
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
72d2daff3dSHong Zhang .  -ts_checkpoint - checkpoint for adjoint sensitivity analysis
73bdad233fSMatthew Knepley .  -ts_max_steps maxsteps - maximum number of time-steps to take
743bca7d26SBarry Smith .  -ts_final_time time - maximum time to compute to
75bdad233fSMatthew Knepley .  -ts_dt dt - initial time step
76a3cdaa26SBarry 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
77a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
78a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
79a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
80a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
81a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
82bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
83de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
84de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
85de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
86de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
87de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
88de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
89de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
902d5ee99bSBarry Smith .  -ts_monitor_draw_solution_phase - Monitor solution graphically with phase diagram
91de06c3feSJed Brown .  -ts_monitor_draw_error - Monitor error graphically
9291b97e58SBarry Smith .  -ts_monitor_solution_binary <filename> - Save each solution to a binary file
9391b97e58SBarry Smith -  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
9491b97e58SBarry Smith 
9591b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
96bdad233fSMatthew Knepley 
97bdad233fSMatthew Knepley    Level: beginner
98bdad233fSMatthew Knepley 
99bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
100bdad233fSMatthew Knepley 
101a313700dSBarry Smith .seealso: TSGetType()
102bdad233fSMatthew Knepley @*/
1037087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
104bdad233fSMatthew Knepley {
105ace3abfcSBarry Smith   PetscBool              opt,flg;
106dfbe8321SBarry Smith   PetscErrorCode         ierr;
107649052a6SBarry Smith   PetscViewer            monviewer;
108eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
109089b2837SJed Brown   SNES                   snes;
1101c3436cfSJed Brown   TSAdapt                adapt;
11131748224SBarry Smith   PetscReal              time_step;
11249354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
113d1212d36SBarry Smith   char                   dir[16];
114bdad233fSMatthew Knepley 
115bdad233fSMatthew Knepley   PetscFunctionBegin;
1160700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1173194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
118a43b19c4SJed Brown   /* Handle TS type options */
119e55864a3SBarry Smith   ierr = TSSetTypeFromOptions_Private(PetscOptionsObject,ts);CHKERRQ(ierr);
120bdad233fSMatthew Knepley 
121bdad233fSMatthew Knepley   /* Handle generic TS options */
122d2daff3dSHong Zhang   ierr = PetscOptionsBool("-ts_checkpoint","Checkpoint for adjoint sensitivity analysis","TSSetCheckpoint",ts->checkpoint,&ts->checkpoint,NULL);CHKERRQ(ierr);
1230298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1240298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1250298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
12631748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
12731748224SBarry Smith   if (flg) {
12831748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
12931748224SBarry Smith   }
13049354f04SShri 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);
13149354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1320298fd71SBarry 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);
1330298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1340298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1350298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1360298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
137bdad233fSMatthew Knepley 
13856f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
13956f85f32SBarry Smith   {
14056f85f32SBarry Smith   PetscBool set;
14156f85f32SBarry Smith   flg  = PETSC_FALSE;
14256f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
14356f85f32SBarry Smith   if (set) {
14456f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
14556f85f32SBarry Smith   }
14656f85f32SBarry Smith   }
14756f85f32SBarry Smith #endif
14856f85f32SBarry Smith 
149bdad233fSMatthew Knepley   /* Monitor options */
150a6570f20SBarry Smith   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
151eabae89aSBarry Smith   if (flg) {
152ce94432eSBarry Smith     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
153649052a6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
154bdad233fSMatthew Knepley   }
1555180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1565180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1575180491cSLisandro Dalcin 
1584f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
159a7cc72afSBarry Smith   if (opt) {
1600b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1613923b477SBarry Smith     PetscInt       howoften = 1;
162a80ad3e0SBarry Smith 
1630298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
164ce94432eSBarry Smith     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1654f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
166b3603a34SBarry Smith   }
1674f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
168b3603a34SBarry Smith   if (opt) {
1690b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1703923b477SBarry Smith     PetscInt       howoften = 1;
171b3603a34SBarry Smith 
1720298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
17322d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1744f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
175bdad233fSMatthew Knepley   }
1764f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
177ef20d060SBarry Smith   if (opt) {
1780b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1793923b477SBarry Smith     PetscInt       howoften = 1;
180ef20d060SBarry Smith 
1810298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
18222d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1834f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
184ef20d060SBarry Smith   }
185201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
186201da799SBarry Smith   if (opt) {
187201da799SBarry Smith     TSMonitorLGCtx ctx;
188201da799SBarry Smith     PetscInt       howoften = 1;
189201da799SBarry Smith 
1900298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
19122d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
192201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
193201da799SBarry Smith   }
194201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
195201da799SBarry Smith   if (opt) {
196201da799SBarry Smith     TSMonitorLGCtx ctx;
197201da799SBarry Smith     PetscInt       howoften = 1;
198201da799SBarry Smith 
1990298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
20022d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
201201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
202201da799SBarry Smith   }
2038189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
2048189c53fSBarry Smith   if (opt) {
2058189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2068189c53fSBarry Smith     PetscInt          howoften = 1;
2078189c53fSBarry Smith 
2080298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
20922d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2108189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
2118189c53fSBarry Smith   }
212ef20d060SBarry Smith   opt  = PETSC_FALSE;
2130dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
214a7cc72afSBarry Smith   if (opt) {
21583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
21683a4ac43SBarry Smith     PetscInt         howoften = 1;
217a80ad3e0SBarry Smith 
2180298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
219ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
22083a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
221bdad233fSMatthew Knepley   }
222fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2232d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2242d5ee99bSBarry Smith   if (opt) {
2252d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2262d5ee99bSBarry Smith     PetscReal        bounds[4];
2272d5ee99bSBarry Smith     PetscInt         n = 4;
2282d5ee99bSBarry Smith     PetscDraw        draw;
2292d5ee99bSBarry Smith 
2302d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2312d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2322d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
2332d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2342d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
2354b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
2364b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
237f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2384b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
23907995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
2402d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2412d5ee99bSBarry Smith   }
2422d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2430dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2443a471f94SBarry Smith   if (opt) {
24583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
24683a4ac43SBarry Smith     PetscInt         howoften = 1;
2473a471f94SBarry Smith 
2480298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
249ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
25083a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2513a471f94SBarry Smith   }
2523a471f94SBarry Smith   opt  = PETSC_FALSE;
25391b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
254fb1732b5SBarry Smith   if (flg) {
255fb1732b5SBarry Smith     PetscViewer ctx;
256fb1732b5SBarry Smith     if (monfilename[0]) {
257ce94432eSBarry Smith       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
258c2fbc07fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
259fb1732b5SBarry Smith     } else {
260ce94432eSBarry Smith       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
2610298fd71SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
262fb1732b5SBarry Smith     }
263fb1732b5SBarry Smith   }
264ed81e22dSJed Brown   opt  = PETSC_FALSE;
26591b97e58SBarry 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);
266ed81e22dSJed Brown   if (flg) {
267ed81e22dSJed Brown     const char *ptr,*ptr2;
268ed81e22dSJed Brown     char       *filetemplate;
269ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
270ed81e22dSJed Brown     /* Do some cursory validation of the input. */
271ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
272ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
273ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
274ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
275ce94432eSBarry 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");
276ed81e22dSJed Brown       if (ptr2) break;
277ed81e22dSJed Brown     }
278ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
279ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
280ed81e22dSJed Brown   }
281bdad233fSMatthew Knepley 
282d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
283d1212d36SBarry Smith   if (flg) {
284d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
285d1212d36SBarry Smith     int                  ray = 0;
286d1212d36SBarry Smith     DMDADirection        ddir;
287d1212d36SBarry Smith     DM                   da;
288d1212d36SBarry Smith     PetscMPIInt          rank;
289d1212d36SBarry Smith 
290ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
291d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
292d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
293ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
294d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
295d1212d36SBarry Smith 
296d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
297b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
298d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
299d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
300ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
301d1212d36SBarry Smith     if (!rank) {
302d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
303d1212d36SBarry Smith     }
30451b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
305d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
306d1212d36SBarry Smith   }
30751b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
30851b4a12fSMatthew G. Knepley   if (flg) {
30951b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
31051b4a12fSMatthew G. Knepley     int                 ray = 0;
31151b4a12fSMatthew G. Knepley     DMDADirection       ddir;
31251b4a12fSMatthew G. Knepley     DM                  da;
31351b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
314d1212d36SBarry Smith 
31551b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
31651b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
31751b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
31851b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
31951b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
32051b4a12fSMatthew G. Knepley 
32151b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
322b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
32351b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
32451b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
32551b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
32651b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
32751b4a12fSMatthew G. Knepley   }
328a7a1495cSBarry Smith 
3297781c08eSBarry Smith   /*
3307781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
3317781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
3327781c08eSBarry Smith   */
333552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
334e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
335d763cef2SBarry Smith 
336d763cef2SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
337d763cef2SBarry Smith   if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
338d763cef2SBarry Smith 
339d763cef2SBarry Smith   /* Handle specific TS options */
340d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
341e55864a3SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
342d763cef2SBarry Smith   }
343d763cef2SBarry Smith 
344d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
345d763cef2SBarry Smith   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
346d763cef2SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
347d763cef2SBarry Smith   PetscFunctionReturn(0);
348d763cef2SBarry Smith }
349d763cef2SBarry Smith 
350d763cef2SBarry Smith #undef __FUNCT__
351d2daff3dSHong Zhang #define __FUNCT__ "TSSetCheckpoint"
352d2daff3dSHong Zhang /*@
353d2daff3dSHong Zhang    TSSetCheckpoint - Allows one to checkpoint the forward run,
354d2daff3dSHong Zhang    useful for adjoint sensitivity analysis.
355d2daff3dSHong Zhang 
356d2daff3dSHong Zhang    Collective on TS
357d2daff3dSHong Zhang 
358d2daff3dSHong Zhang    Input Parameters:
359d2daff3dSHong Zhang +  ts - the TS context obtained from TSCreate()
360d2daff3dSHong Zhang -  checkpoint - flag that indicates if the forward solution will be checkpointed
361d2daff3dSHong Zhang 
362d2daff3dSHong Zhang    Level: intermediate
363d2daff3dSHong Zhang 
364d2daff3dSHong Zhang .seealso:
365d2daff3dSHong Zhang 
366d2daff3dSHong Zhang .keywords: TS, set, checkpoint
367d2daff3dSHong Zhang @*/
368d2daff3dSHong Zhang PetscErrorCode  TSSetCheckpoint(TS ts,PetscBool checkpoint)
369d2daff3dSHong Zhang {
370d2daff3dSHong Zhang   PetscFunctionBegin;
371d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
372d2daff3dSHong Zhang   ts->checkpoint = checkpoint;
373d2daff3dSHong Zhang   PetscFunctionReturn(0);
374d2daff3dSHong Zhang }
375d2daff3dSHong Zhang 
376d2daff3dSHong Zhang #undef __FUNCT__
377a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
378a7a1495cSBarry Smith /*@
379a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
380a7a1495cSBarry Smith       set with TSSetRHSJacobian().
381a7a1495cSBarry Smith 
382a7a1495cSBarry Smith    Collective on TS and Vec
383a7a1495cSBarry Smith 
384a7a1495cSBarry Smith    Input Parameters:
385316643e7SJed Brown +  ts - the TS context
386a7a1495cSBarry Smith .  t - current timestep
3870910c330SBarry Smith -  U - input vector
388a7a1495cSBarry Smith 
389a7a1495cSBarry Smith    Output Parameters:
390a7a1495cSBarry Smith +  A - Jacobian matrix
391a7a1495cSBarry Smith .  B - optional preconditioning matrix
392a7a1495cSBarry Smith -  flag - flag indicating matrix structure
393a7a1495cSBarry Smith 
394a7a1495cSBarry Smith    Notes:
395a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
396a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
397a7a1495cSBarry Smith 
39894b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
399a7a1495cSBarry Smith    flag parameter.
400a7a1495cSBarry Smith 
401a7a1495cSBarry Smith    Level: developer
402a7a1495cSBarry Smith 
403a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
404a7a1495cSBarry Smith 
40594b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
406a7a1495cSBarry Smith @*/
407d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
408a7a1495cSBarry Smith {
409dfbe8321SBarry Smith   PetscErrorCode ierr;
410270bf2e7SJed Brown   PetscObjectState Ustate;
41124989b8cSPeter Brune   DM             dm;
412942e3340SBarry Smith   DMTS           tsdm;
41324989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
41424989b8cSPeter Brune   void           *ctx;
41524989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
416a7a1495cSBarry Smith 
417a7a1495cSBarry Smith   PetscFunctionBegin;
4180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4190910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4200910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
42124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
422942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
42324989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4240298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
42559e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
4260910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4270e4ef248SJed Brown     PetscFunctionReturn(0);
428f8ede8e7SJed Brown   }
429d90be118SSean Farley 
430ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
431d90be118SSean Farley 
432e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
43394ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
43494ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
43594ab13aaSBarry Smith     if (A != B) {
43694ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
43794ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
438e1244c69SJed Brown     }
439e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
440e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
441e1244c69SJed Brown   }
442e1244c69SJed Brown 
44324989b8cSPeter Brune   if (rhsjacobianfunc) {
44494ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
445a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
446d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
447a7a1495cSBarry Smith     PetscStackPop;
44894ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
449a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
45094ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
45194ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
452ef66eb69SBarry Smith   } else {
45394ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
45494ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
455ef66eb69SBarry Smith   }
4560e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4570910c330SBarry Smith   ts->rhsjacobian.X          = U;
45859e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
459a7a1495cSBarry Smith   PetscFunctionReturn(0);
460a7a1495cSBarry Smith }
461a7a1495cSBarry Smith 
4624a2ae208SSatish Balay #undef __FUNCT__
4634a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
464316643e7SJed Brown /*@
465d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
466d763cef2SBarry Smith 
467316643e7SJed Brown    Collective on TS and Vec
468316643e7SJed Brown 
469316643e7SJed Brown    Input Parameters:
470316643e7SJed Brown +  ts - the TS context
471316643e7SJed Brown .  t - current time
4720910c330SBarry Smith -  U - state vector
473316643e7SJed Brown 
474316643e7SJed Brown    Output Parameter:
475316643e7SJed Brown .  y - right hand side
476316643e7SJed Brown 
477316643e7SJed Brown    Note:
478316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
479316643e7SJed Brown    is used internally within the nonlinear solvers.
480316643e7SJed Brown 
481316643e7SJed Brown    Level: developer
482316643e7SJed Brown 
483316643e7SJed Brown .keywords: TS, compute
484316643e7SJed Brown 
485316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
486316643e7SJed Brown @*/
4870910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
488d763cef2SBarry Smith {
489dfbe8321SBarry Smith   PetscErrorCode ierr;
49024989b8cSPeter Brune   TSRHSFunction  rhsfunction;
49124989b8cSPeter Brune   TSIFunction    ifunction;
49224989b8cSPeter Brune   void           *ctx;
49324989b8cSPeter Brune   DM             dm;
49424989b8cSPeter Brune 
495d763cef2SBarry Smith   PetscFunctionBegin;
4960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4970910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4980700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
49924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
50024989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5010298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
502d763cef2SBarry Smith 
503ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
504d763cef2SBarry Smith 
5050910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
50624989b8cSPeter Brune   if (rhsfunction) {
507d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5080910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
509d763cef2SBarry Smith     PetscStackPop;
510214bc6a2SJed Brown   } else {
511214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
512b2cd27e8SJed Brown   }
51344a41b28SSean Farley 
5140910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
515d763cef2SBarry Smith   PetscFunctionReturn(0);
516d763cef2SBarry Smith }
517d763cef2SBarry Smith 
5184a2ae208SSatish Balay #undef __FUNCT__
519ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
520ef20d060SBarry Smith /*@
521ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
522ef20d060SBarry Smith 
523ef20d060SBarry Smith    Collective on TS and Vec
524ef20d060SBarry Smith 
525ef20d060SBarry Smith    Input Parameters:
526ef20d060SBarry Smith +  ts - the TS context
527ef20d060SBarry Smith -  t - current time
528ef20d060SBarry Smith 
529ef20d060SBarry Smith    Output Parameter:
5300910c330SBarry Smith .  U - the solution
531ef20d060SBarry Smith 
532ef20d060SBarry Smith    Note:
533ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
534ef20d060SBarry Smith    is used internally within the nonlinear solvers.
535ef20d060SBarry Smith 
536ef20d060SBarry Smith    Level: developer
537ef20d060SBarry Smith 
538ef20d060SBarry Smith .keywords: TS, compute
539ef20d060SBarry Smith 
540abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
541ef20d060SBarry Smith @*/
5420910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
543ef20d060SBarry Smith {
544ef20d060SBarry Smith   PetscErrorCode     ierr;
545ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
546ef20d060SBarry Smith   void               *ctx;
547ef20d060SBarry Smith   DM                 dm;
548ef20d060SBarry Smith 
549ef20d060SBarry Smith   PetscFunctionBegin;
550ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5510910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
552ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
553ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
554ef20d060SBarry Smith 
555ef20d060SBarry Smith   if (solutionfunction) {
5569b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5570910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
558ef20d060SBarry Smith     PetscStackPop;
559ef20d060SBarry Smith   }
560ef20d060SBarry Smith   PetscFunctionReturn(0);
561ef20d060SBarry Smith }
5629b7cd975SBarry Smith #undef __FUNCT__
5639b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5649b7cd975SBarry Smith /*@
5659b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5669b7cd975SBarry Smith 
5679b7cd975SBarry Smith    Collective on TS and Vec
5689b7cd975SBarry Smith 
5699b7cd975SBarry Smith    Input Parameters:
5709b7cd975SBarry Smith +  ts - the TS context
5719b7cd975SBarry Smith -  t - current time
5729b7cd975SBarry Smith 
5739b7cd975SBarry Smith    Output Parameter:
5749b7cd975SBarry Smith .  U - the function value
5759b7cd975SBarry Smith 
5769b7cd975SBarry Smith    Note:
5779b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
5789b7cd975SBarry Smith    is used internally within the nonlinear solvers.
5799b7cd975SBarry Smith 
5809b7cd975SBarry Smith    Level: developer
5819b7cd975SBarry Smith 
5829b7cd975SBarry Smith .keywords: TS, compute
5839b7cd975SBarry Smith 
5849b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
5859b7cd975SBarry Smith @*/
5869b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
5879b7cd975SBarry Smith {
5889b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
5899b7cd975SBarry Smith   void               *ctx;
5909b7cd975SBarry Smith   DM                 dm;
5919b7cd975SBarry Smith 
5929b7cd975SBarry Smith   PetscFunctionBegin;
5939b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5949b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5959b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
5969b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
5979b7cd975SBarry Smith 
5989b7cd975SBarry Smith   if (forcing) {
5999b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6009b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6019b7cd975SBarry Smith     PetscStackPop;
6029b7cd975SBarry Smith   }
6039b7cd975SBarry Smith   PetscFunctionReturn(0);
6049b7cd975SBarry Smith }
605ef20d060SBarry Smith 
606ef20d060SBarry Smith #undef __FUNCT__
607214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
608214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
609214bc6a2SJed Brown {
6102dd45cf8SJed Brown   Vec            F;
611214bc6a2SJed Brown   PetscErrorCode ierr;
612214bc6a2SJed Brown 
613214bc6a2SJed Brown   PetscFunctionBegin;
6140298fd71SBarry Smith   *Frhs = NULL;
6150298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
616214bc6a2SJed Brown   if (!ts->Frhs) {
6172dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
618214bc6a2SJed Brown   }
619214bc6a2SJed Brown   *Frhs = ts->Frhs;
620214bc6a2SJed Brown   PetscFunctionReturn(0);
621214bc6a2SJed Brown }
622214bc6a2SJed Brown 
623214bc6a2SJed Brown #undef __FUNCT__
624214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
625214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
626214bc6a2SJed Brown {
627214bc6a2SJed Brown   Mat            A,B;
6282dd45cf8SJed Brown   PetscErrorCode ierr;
629214bc6a2SJed Brown 
630214bc6a2SJed Brown   PetscFunctionBegin;
631c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
632c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6330298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
634214bc6a2SJed Brown   if (Arhs) {
635214bc6a2SJed Brown     if (!ts->Arhs) {
636214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
637214bc6a2SJed Brown     }
638214bc6a2SJed Brown     *Arhs = ts->Arhs;
639214bc6a2SJed Brown   }
640214bc6a2SJed Brown   if (Brhs) {
641214bc6a2SJed Brown     if (!ts->Brhs) {
642bdb70873SJed Brown       if (A != B) {
643214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
644bdb70873SJed Brown       } else {
645bdb70873SJed Brown         ts->Brhs = ts->Arhs;
646bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
647bdb70873SJed Brown       }
648214bc6a2SJed Brown     }
649214bc6a2SJed Brown     *Brhs = ts->Brhs;
650214bc6a2SJed Brown   }
651214bc6a2SJed Brown   PetscFunctionReturn(0);
652214bc6a2SJed Brown }
653214bc6a2SJed Brown 
654214bc6a2SJed Brown #undef __FUNCT__
655316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
656316643e7SJed Brown /*@
6570910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
658316643e7SJed Brown 
659316643e7SJed Brown    Collective on TS and Vec
660316643e7SJed Brown 
661316643e7SJed Brown    Input Parameters:
662316643e7SJed Brown +  ts - the TS context
663316643e7SJed Brown .  t - current time
6640910c330SBarry Smith .  U - state vector
6650910c330SBarry Smith .  Udot - time derivative of state vector
666214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
667316643e7SJed Brown 
668316643e7SJed Brown    Output Parameter:
669316643e7SJed Brown .  Y - right hand side
670316643e7SJed Brown 
671316643e7SJed Brown    Note:
672316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
673316643e7SJed Brown    is used internally within the nonlinear solvers.
674316643e7SJed Brown 
675316643e7SJed Brown    If the user did did not write their equations in implicit form, this
676316643e7SJed Brown    function recasts them in implicit form.
677316643e7SJed Brown 
678316643e7SJed Brown    Level: developer
679316643e7SJed Brown 
680316643e7SJed Brown .keywords: TS, compute
681316643e7SJed Brown 
682316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
683316643e7SJed Brown @*/
6840910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
685316643e7SJed Brown {
686316643e7SJed Brown   PetscErrorCode ierr;
68724989b8cSPeter Brune   TSIFunction    ifunction;
68824989b8cSPeter Brune   TSRHSFunction  rhsfunction;
68924989b8cSPeter Brune   void           *ctx;
69024989b8cSPeter Brune   DM             dm;
691316643e7SJed Brown 
692316643e7SJed Brown   PetscFunctionBegin;
6930700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6940910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6950910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
6960700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
697316643e7SJed Brown 
69824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
69924989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7000298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
70124989b8cSPeter Brune 
702ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
703d90be118SSean Farley 
7040910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
70524989b8cSPeter Brune   if (ifunction) {
706316643e7SJed Brown     PetscStackPush("TS user implicit function");
7070910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
708316643e7SJed Brown     PetscStackPop;
709214bc6a2SJed Brown   }
710214bc6a2SJed Brown   if (imex) {
71124989b8cSPeter Brune     if (!ifunction) {
7120910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7132dd45cf8SJed Brown     }
71424989b8cSPeter Brune   } else if (rhsfunction) {
71524989b8cSPeter Brune     if (ifunction) {
716214bc6a2SJed Brown       Vec Frhs;
717214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7180910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
719214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7202dd45cf8SJed Brown     } else {
7210910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7220910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
723316643e7SJed Brown     }
7244a6899ffSJed Brown   }
7250910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
726316643e7SJed Brown   PetscFunctionReturn(0);
727316643e7SJed Brown }
728316643e7SJed Brown 
729316643e7SJed Brown #undef __FUNCT__
730316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
731316643e7SJed Brown /*@
732316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
733316643e7SJed Brown 
734316643e7SJed Brown    Collective on TS and Vec
735316643e7SJed Brown 
736316643e7SJed Brown    Input
737316643e7SJed Brown       Input Parameters:
738316643e7SJed Brown +  ts - the TS context
739316643e7SJed Brown .  t - current timestep
7400910c330SBarry Smith .  U - state vector
7410910c330SBarry Smith .  Udot - time derivative of state vector
742214bc6a2SJed Brown .  shift - shift to apply, see note below
743214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
744316643e7SJed Brown 
745316643e7SJed Brown    Output Parameters:
746316643e7SJed Brown +  A - Jacobian matrix
747316643e7SJed Brown .  B - optional preconditioning matrix
748316643e7SJed Brown -  flag - flag indicating matrix structure
749316643e7SJed Brown 
750316643e7SJed Brown    Notes:
7510910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
752316643e7SJed Brown 
7530910c330SBarry Smith    dF/dU + shift*dF/dUdot
754316643e7SJed Brown 
755316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
756316643e7SJed Brown    is used internally within the nonlinear solvers.
757316643e7SJed Brown 
758316643e7SJed Brown    Level: developer
759316643e7SJed Brown 
760316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
761316643e7SJed Brown 
762316643e7SJed Brown .seealso:  TSSetIJacobian()
76363495f91SJed Brown @*/
764d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
765316643e7SJed Brown {
766316643e7SJed Brown   PetscErrorCode ierr;
76724989b8cSPeter Brune   TSIJacobian    ijacobian;
76824989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
76924989b8cSPeter Brune   DM             dm;
77024989b8cSPeter Brune   void           *ctx;
771316643e7SJed Brown 
772316643e7SJed Brown   PetscFunctionBegin;
7730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7740910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7750910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
776316643e7SJed Brown   PetscValidPointer(A,6);
77794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
778316643e7SJed Brown   PetscValidPointer(B,7);
77994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
78024989b8cSPeter Brune 
78124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
78224989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
7830298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
78424989b8cSPeter Brune 
785ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
786316643e7SJed Brown 
78794ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
78824989b8cSPeter Brune   if (ijacobian) {
789316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
790d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
791316643e7SJed Brown     PetscStackPop;
792214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
79394ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
79494ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
7954a6899ffSJed Brown   }
796214bc6a2SJed Brown   if (imex) {
797b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
79894ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
79994ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
80094ab13aaSBarry Smith       if (A != B) {
80194ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
80294ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
803214bc6a2SJed Brown       }
804214bc6a2SJed Brown     }
805214bc6a2SJed Brown   } else {
806e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
807e1244c69SJed Brown     if (rhsjacobian) {
808bd373395SBarry Smith       if (ijacobian) {
809e1244c69SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
810bd373395SBarry Smith       } else {
811bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
812e1244c69SJed Brown       }
813d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
814e1244c69SJed Brown     }
81594ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
816e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
817e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
81894ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
81994ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
82094ab13aaSBarry Smith       if (A != B) {
82194ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
82294ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
823316643e7SJed Brown       }
824e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
825e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
826e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
82794ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
82894ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
82994ab13aaSBarry Smith         if (A != B) {
83094ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
83194ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
832e1244c69SJed Brown         }
833e1244c69SJed Brown       }
83494ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
83594ab13aaSBarry Smith       if (A != B) {
83694ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
837214bc6a2SJed Brown       }
838316643e7SJed Brown     }
839316643e7SJed Brown   }
84094ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
841316643e7SJed Brown   PetscFunctionReturn(0);
842316643e7SJed Brown }
843316643e7SJed Brown 
844316643e7SJed Brown #undef __FUNCT__
8454a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
846d763cef2SBarry Smith /*@C
847d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
848b5abc632SBarry Smith     where U_t = G(t,u).
849d763cef2SBarry Smith 
8503f9fe445SBarry Smith     Logically Collective on TS
851d763cef2SBarry Smith 
852d763cef2SBarry Smith     Input Parameters:
853d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8540298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
855d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
856d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8570298fd71SBarry Smith           function evaluation routine (may be NULL)
858d763cef2SBarry Smith 
859d763cef2SBarry Smith     Calling sequence of func:
86087828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
861d763cef2SBarry Smith 
862d763cef2SBarry Smith +   t - current timestep
863d763cef2SBarry Smith .   u - input vector
864d763cef2SBarry Smith .   F - function vector
865d763cef2SBarry Smith -   ctx - [optional] user-defined function context
866d763cef2SBarry Smith 
867d763cef2SBarry Smith     Level: beginner
868d763cef2SBarry Smith 
869d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
870d763cef2SBarry Smith 
871ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
872d763cef2SBarry Smith @*/
873089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
874d763cef2SBarry Smith {
875089b2837SJed Brown   PetscErrorCode ierr;
876089b2837SJed Brown   SNES           snes;
8770298fd71SBarry Smith   Vec            ralloc = NULL;
87824989b8cSPeter Brune   DM             dm;
879d763cef2SBarry Smith 
880089b2837SJed Brown   PetscFunctionBegin;
8810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
882ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
88324989b8cSPeter Brune 
88424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
88524989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
886089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
887e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
888e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
889e856ceecSJed Brown     r    = ralloc;
890e856ceecSJed Brown   }
891089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
892e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
893d763cef2SBarry Smith   PetscFunctionReturn(0);
894d763cef2SBarry Smith }
895d763cef2SBarry Smith 
8964a2ae208SSatish Balay #undef __FUNCT__
897ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
898ef20d060SBarry Smith /*@C
899abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
900ef20d060SBarry Smith 
901ef20d060SBarry Smith     Logically Collective on TS
902ef20d060SBarry Smith 
903ef20d060SBarry Smith     Input Parameters:
904ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
905ef20d060SBarry Smith .   f - routine for evaluating the solution
906ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9070298fd71SBarry Smith           function evaluation routine (may be NULL)
908ef20d060SBarry Smith 
909ef20d060SBarry Smith     Calling sequence of func:
910ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
911ef20d060SBarry Smith 
912ef20d060SBarry Smith +   t - current timestep
913ef20d060SBarry Smith .   u - output vector
914ef20d060SBarry Smith -   ctx - [optional] user-defined function context
915ef20d060SBarry Smith 
916abd5a294SJed Brown     Notes:
917abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
918abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
919abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
920abd5a294SJed Brown 
9214f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
922abd5a294SJed Brown 
923ef20d060SBarry Smith     Level: beginner
924ef20d060SBarry Smith 
925ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
926ef20d060SBarry Smith 
9279b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
928ef20d060SBarry Smith @*/
929ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
930ef20d060SBarry Smith {
931ef20d060SBarry Smith   PetscErrorCode ierr;
932ef20d060SBarry Smith   DM             dm;
933ef20d060SBarry Smith 
934ef20d060SBarry Smith   PetscFunctionBegin;
935ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
936ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
937ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
938ef20d060SBarry Smith   PetscFunctionReturn(0);
939ef20d060SBarry Smith }
940ef20d060SBarry Smith 
941ef20d060SBarry Smith #undef __FUNCT__
9429b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9439b7cd975SBarry Smith /*@C
9449b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9459b7cd975SBarry Smith 
9469b7cd975SBarry Smith     Logically Collective on TS
9479b7cd975SBarry Smith 
9489b7cd975SBarry Smith     Input Parameters:
9499b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9509b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9519b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9520298fd71SBarry Smith           function evaluation routine (may be NULL)
9539b7cd975SBarry Smith 
9549b7cd975SBarry Smith     Calling sequence of func:
9559b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9569b7cd975SBarry Smith 
9579b7cd975SBarry Smith +   t - current timestep
9589b7cd975SBarry Smith .   u - output vector
9599b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9609b7cd975SBarry Smith 
9619b7cd975SBarry Smith     Notes:
9629b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9639b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9649b7cd975SBarry Smith 
9659b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9669b7cd975SBarry Smith 
9679b7cd975SBarry Smith     Level: beginner
9689b7cd975SBarry Smith 
9699b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9709b7cd975SBarry Smith 
9719b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
9729b7cd975SBarry Smith @*/
9739b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
9749b7cd975SBarry Smith {
9759b7cd975SBarry Smith   PetscErrorCode ierr;
9769b7cd975SBarry Smith   DM             dm;
9779b7cd975SBarry Smith 
9789b7cd975SBarry Smith   PetscFunctionBegin;
9799b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9809b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
9819b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
9829b7cd975SBarry Smith   PetscFunctionReturn(0);
9839b7cd975SBarry Smith }
9849b7cd975SBarry Smith 
9859b7cd975SBarry Smith #undef __FUNCT__
9864a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
987d763cef2SBarry Smith /*@C
988d763cef2SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of F,
989b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
990d763cef2SBarry Smith 
9913f9fe445SBarry Smith    Logically Collective on TS
992d763cef2SBarry Smith 
993d763cef2SBarry Smith    Input Parameters:
994d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
995e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
996e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
997d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
998d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
9990298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1000d763cef2SBarry Smith 
1001d763cef2SBarry Smith    Calling sequence of func:
1002ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1003d763cef2SBarry Smith 
1004d763cef2SBarry Smith +  t - current timestep
1005d763cef2SBarry Smith .  u - input vector
1006e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1007e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1008d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1009d763cef2SBarry Smith 
1010d763cef2SBarry Smith 
1011d763cef2SBarry Smith    Level: beginner
1012d763cef2SBarry Smith 
1013d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1014d763cef2SBarry Smith 
1015ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1016d763cef2SBarry Smith 
1017d763cef2SBarry Smith @*/
1018e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1019d763cef2SBarry Smith {
1020277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1021089b2837SJed Brown   SNES           snes;
102224989b8cSPeter Brune   DM             dm;
102324989b8cSPeter Brune   TSIJacobian    ijacobian;
1024277b19d0SLisandro Dalcin 
1025d763cef2SBarry Smith   PetscFunctionBegin;
10260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1027e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1028e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1029e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1030e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1031d763cef2SBarry Smith 
103224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
103324989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1034e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1035e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1036e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1037e1244c69SJed Brown   }
10380298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1039089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10405f659677SPeter Brune   if (!ijacobian) {
1041e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10420e4ef248SJed Brown   }
1043e5d3d808SBarry Smith   if (Amat) {
1044e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10450e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1046bbd56ea5SKarl Rupp 
1047e5d3d808SBarry Smith     ts->Arhs = Amat;
10480e4ef248SJed Brown   }
1049e5d3d808SBarry Smith   if (Pmat) {
1050e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10510e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1052bbd56ea5SKarl Rupp 
1053e5d3d808SBarry Smith     ts->Brhs = Pmat;
10540e4ef248SJed Brown   }
1055d763cef2SBarry Smith   PetscFunctionReturn(0);
1056d763cef2SBarry Smith }
1057d763cef2SBarry Smith 
1058316643e7SJed Brown 
1059316643e7SJed Brown #undef __FUNCT__
1060316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1061316643e7SJed Brown /*@C
1062b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1063316643e7SJed Brown 
10643f9fe445SBarry Smith    Logically Collective on TS
1065316643e7SJed Brown 
1066316643e7SJed Brown    Input Parameters:
1067316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10680298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1069316643e7SJed Brown .  f   - the function evaluation routine
10700298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1071316643e7SJed Brown 
1072316643e7SJed Brown    Calling sequence of f:
1073316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1074316643e7SJed Brown 
1075316643e7SJed Brown +  t   - time at step/stage being solved
1076316643e7SJed Brown .  u   - state vector
1077316643e7SJed Brown .  u_t - time derivative of state vector
1078316643e7SJed Brown .  F   - function vector
1079316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1080316643e7SJed Brown 
1081316643e7SJed Brown    Important:
1082d6cbdb99SBarry Smith    The user MUST call either this routine, TSSetRHSFunction().  This routine must be used when not solving an ODE, for example a DAE.
1083316643e7SJed Brown 
1084316643e7SJed Brown    Level: beginner
1085316643e7SJed Brown 
1086316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1087316643e7SJed Brown 
1088d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1089316643e7SJed Brown @*/
1090089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1091316643e7SJed Brown {
1092089b2837SJed Brown   PetscErrorCode ierr;
1093089b2837SJed Brown   SNES           snes;
10940298fd71SBarry Smith   Vec            resalloc = NULL;
109524989b8cSPeter Brune   DM             dm;
1096316643e7SJed Brown 
1097316643e7SJed Brown   PetscFunctionBegin;
10980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1099ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
110024989b8cSPeter Brune 
110124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
110224989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
110324989b8cSPeter Brune 
1104089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1105e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1106e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1107e856ceecSJed Brown     res  = resalloc;
1108e856ceecSJed Brown   }
1109089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1110e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1111089b2837SJed Brown   PetscFunctionReturn(0);
1112089b2837SJed Brown }
1113089b2837SJed Brown 
1114089b2837SJed Brown #undef __FUNCT__
1115089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1116089b2837SJed Brown /*@C
1117089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1118089b2837SJed Brown 
1119089b2837SJed Brown    Not Collective
1120089b2837SJed Brown 
1121089b2837SJed Brown    Input Parameter:
1122089b2837SJed Brown .  ts - the TS context
1123089b2837SJed Brown 
1124089b2837SJed Brown    Output Parameter:
11250298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11260298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11270298fd71SBarry Smith -  ctx - the function context (or NULL)
1128089b2837SJed Brown 
1129089b2837SJed Brown    Level: advanced
1130089b2837SJed Brown 
1131089b2837SJed Brown .keywords: TS, nonlinear, get, function
1132089b2837SJed Brown 
1133089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1134089b2837SJed Brown @*/
1135089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1136089b2837SJed Brown {
1137089b2837SJed Brown   PetscErrorCode ierr;
1138089b2837SJed Brown   SNES           snes;
113924989b8cSPeter Brune   DM             dm;
1140089b2837SJed Brown 
1141089b2837SJed Brown   PetscFunctionBegin;
1142089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1143089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11440298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
114524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
114624989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1147089b2837SJed Brown   PetscFunctionReturn(0);
1148089b2837SJed Brown }
1149089b2837SJed Brown 
1150089b2837SJed Brown #undef __FUNCT__
1151089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1152089b2837SJed Brown /*@C
1153089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1154089b2837SJed Brown 
1155089b2837SJed Brown    Not Collective
1156089b2837SJed Brown 
1157089b2837SJed Brown    Input Parameter:
1158089b2837SJed Brown .  ts - the TS context
1159089b2837SJed Brown 
1160089b2837SJed Brown    Output Parameter:
11610298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11620298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11630298fd71SBarry Smith -  ctx - the function context (or NULL)
1164089b2837SJed Brown 
1165089b2837SJed Brown    Level: advanced
1166089b2837SJed Brown 
1167089b2837SJed Brown .keywords: TS, nonlinear, get, function
1168089b2837SJed Brown 
1169089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction()
1170089b2837SJed Brown @*/
1171089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1172089b2837SJed Brown {
1173089b2837SJed Brown   PetscErrorCode ierr;
1174089b2837SJed Brown   SNES           snes;
117524989b8cSPeter Brune   DM             dm;
1176089b2837SJed Brown 
1177089b2837SJed Brown   PetscFunctionBegin;
1178089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1179089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11800298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
118124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
118224989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1183316643e7SJed Brown   PetscFunctionReturn(0);
1184316643e7SJed Brown }
1185316643e7SJed Brown 
1186316643e7SJed Brown #undef __FUNCT__
1187316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1188316643e7SJed Brown /*@C
1189a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1190ae8867d6SBarry Smith         provided with TSSetIFunction().
1191316643e7SJed Brown 
11923f9fe445SBarry Smith    Logically Collective on TS
1193316643e7SJed Brown 
1194316643e7SJed Brown    Input Parameters:
1195316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1196e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1197e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1198316643e7SJed Brown .  f   - the Jacobian evaluation routine
11990298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1200316643e7SJed Brown 
1201316643e7SJed Brown    Calling sequence of f:
1202ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1203316643e7SJed Brown 
1204316643e7SJed Brown +  t    - time at step/stage being solved
12051b4a444bSJed Brown .  U    - state vector
12061b4a444bSJed Brown .  U_t  - time derivative of state vector
1207316643e7SJed Brown .  a    - shift
1208e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1209e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1210316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1211316643e7SJed Brown 
1212316643e7SJed Brown    Notes:
1213e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1214316643e7SJed Brown 
1215a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1216b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1217a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1218a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1219a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1220a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1221a4f0a591SBarry Smith 
1222316643e7SJed Brown    Level: beginner
1223316643e7SJed Brown 
1224316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1225316643e7SJed Brown 
1226ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1227316643e7SJed Brown 
1228316643e7SJed Brown @*/
1229e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1230316643e7SJed Brown {
1231316643e7SJed Brown   PetscErrorCode ierr;
1232089b2837SJed Brown   SNES           snes;
123324989b8cSPeter Brune   DM             dm;
1234316643e7SJed Brown 
1235316643e7SJed Brown   PetscFunctionBegin;
12360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1237e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1238e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1239e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1240e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
124124989b8cSPeter Brune 
124224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
124324989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
124424989b8cSPeter Brune 
1245089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1246e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1247316643e7SJed Brown   PetscFunctionReturn(0);
1248316643e7SJed Brown }
1249316643e7SJed Brown 
12504a2ae208SSatish Balay #undef __FUNCT__
1251e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1252e1244c69SJed Brown /*@
1253e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1254e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1255e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1256e1244c69SJed Brown    not been changed by the TS.
1257e1244c69SJed Brown 
1258e1244c69SJed Brown    Logically Collective
1259e1244c69SJed Brown 
1260e1244c69SJed Brown    Input Arguments:
1261e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1262e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1263e1244c69SJed Brown 
1264e1244c69SJed Brown    Level: intermediate
1265e1244c69SJed Brown 
1266e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1267e1244c69SJed Brown @*/
1268e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1269e1244c69SJed Brown {
1270e1244c69SJed Brown   PetscFunctionBegin;
1271e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1272e1244c69SJed Brown   PetscFunctionReturn(0);
1273e1244c69SJed Brown }
1274e1244c69SJed Brown 
1275e1244c69SJed Brown #undef __FUNCT__
127655849f57SBarry Smith #define __FUNCT__ "TSLoad"
127755849f57SBarry Smith /*@C
127855849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
127955849f57SBarry Smith 
128055849f57SBarry Smith   Collective on PetscViewer
128155849f57SBarry Smith 
128255849f57SBarry Smith   Input Parameters:
128355849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
128455849f57SBarry Smith            some related function before a call to TSLoad().
128555849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
128655849f57SBarry Smith 
128755849f57SBarry Smith    Level: intermediate
128855849f57SBarry Smith 
128955849f57SBarry Smith   Notes:
129055849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
129155849f57SBarry Smith 
129255849f57SBarry Smith   Notes for advanced users:
129355849f57SBarry Smith   Most users should not need to know the details of the binary storage
129455849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
129555849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
129655849f57SBarry Smith   format is
129755849f57SBarry Smith .vb
129855849f57SBarry Smith      has not yet been determined
129955849f57SBarry Smith .ve
130055849f57SBarry Smith 
130155849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
130255849f57SBarry Smith @*/
1303f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
130455849f57SBarry Smith {
130555849f57SBarry Smith   PetscErrorCode ierr;
130655849f57SBarry Smith   PetscBool      isbinary;
130755849f57SBarry Smith   PetscInt       classid;
130855849f57SBarry Smith   char           type[256];
13092d53ad75SBarry Smith   DMTS           sdm;
1310ad6bc421SBarry Smith   DM             dm;
131155849f57SBarry Smith 
131255849f57SBarry Smith   PetscFunctionBegin;
1313f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
131455849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
131555849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
131655849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
131755849f57SBarry Smith 
131855849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1319ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
132055849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1321f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1322f2c2a1b9SBarry Smith   if (ts->ops->load) {
1323f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1324f2c2a1b9SBarry Smith   }
1325ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1326ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1327ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1328f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1329f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13302d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13312d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
133255849f57SBarry Smith   PetscFunctionReturn(0);
133355849f57SBarry Smith }
133455849f57SBarry Smith 
13359804daf3SBarry Smith #include <petscdraw.h>
1336e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1337e04113cfSBarry Smith #include <petscviewersaws.h>
1338f05ece33SBarry Smith #endif
133955849f57SBarry Smith #undef __FUNCT__
13404a2ae208SSatish Balay #define __FUNCT__ "TSView"
13417e2c5f70SBarry Smith /*@C
1342d763cef2SBarry Smith     TSView - Prints the TS data structure.
1343d763cef2SBarry Smith 
13444c49b128SBarry Smith     Collective on TS
1345d763cef2SBarry Smith 
1346d763cef2SBarry Smith     Input Parameters:
1347d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1348d763cef2SBarry Smith -   viewer - visualization context
1349d763cef2SBarry Smith 
1350d763cef2SBarry Smith     Options Database Key:
1351d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1352d763cef2SBarry Smith 
1353d763cef2SBarry Smith     Notes:
1354d763cef2SBarry Smith     The available visualization contexts include
1355b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1356b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1357d763cef2SBarry Smith          output where only the first processor opens
1358d763cef2SBarry Smith          the file.  All other processors send their
1359d763cef2SBarry Smith          data to the first processor to print.
1360d763cef2SBarry Smith 
1361d763cef2SBarry Smith     The user can open an alternative visualization context with
1362b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1363d763cef2SBarry Smith 
1364d763cef2SBarry Smith     Level: beginner
1365d763cef2SBarry Smith 
1366d763cef2SBarry Smith .keywords: TS, timestep, view
1367d763cef2SBarry Smith 
1368b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1369d763cef2SBarry Smith @*/
13707087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1371d763cef2SBarry Smith {
1372dfbe8321SBarry Smith   PetscErrorCode ierr;
137319fd82e9SBarry Smith   TSType         type;
13742b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
13752d53ad75SBarry Smith   DMTS           sdm;
1376e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1377f05ece33SBarry Smith   PetscBool      isams;
1378f05ece33SBarry Smith #endif
1379d763cef2SBarry Smith 
1380d763cef2SBarry Smith   PetscFunctionBegin;
13810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13823050cee2SBarry Smith   if (!viewer) {
1383ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
13843050cee2SBarry Smith   }
13850700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1386c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1387fd16b177SBarry Smith 
1388251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1389251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
139055849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
13912b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1392e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1393e04113cfSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr);
1394f05ece33SBarry Smith #endif
139532077d6dSBarry Smith   if (iascii) {
1396dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
139777431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
13987c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1399d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14005ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1401c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1402d763cef2SBarry Smith     }
14035ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1404193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14052d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14062d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1407d52bd9f3SBarry Smith     if (ts->ops->view) {
1408d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1409d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1410d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1411d52bd9f3SBarry Smith     }
14120f5bd95cSBarry Smith   } else if (isstring) {
1413a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1414b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
141555849f57SBarry Smith   } else if (isbinary) {
141655849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
141755849f57SBarry Smith     MPI_Comm    comm;
141855849f57SBarry Smith     PetscMPIInt rank;
141955849f57SBarry Smith     char        type[256];
142055849f57SBarry Smith 
142155849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
142255849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
142355849f57SBarry Smith     if (!rank) {
142455849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
142555849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
142655849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
142755849f57SBarry Smith     }
142855849f57SBarry Smith     if (ts->ops->view) {
142955849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
143055849f57SBarry Smith     }
1431f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1432f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14332d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14342d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14352b0a91c0SBarry Smith   } else if (isdraw) {
14362b0a91c0SBarry Smith     PetscDraw draw;
14372b0a91c0SBarry Smith     char      str[36];
143889fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14392b0a91c0SBarry Smith 
14402b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14412b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14422b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14432b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
14440298fd71SBarry Smith     ierr   = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
144589fd9fafSBarry Smith     bottom = y - h;
14462b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14472b0a91c0SBarry Smith     if (ts->ops->view) {
14482b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14492b0a91c0SBarry Smith     }
14502b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1451e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1452f05ece33SBarry Smith   } else if (isams) {
1453d45a07a7SBarry Smith     PetscMPIInt rank;
14542657e9d9SBarry Smith     const char  *name;
14552657e9d9SBarry Smith 
14562657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1457d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1458d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1459d45a07a7SBarry Smith       char       dir[1024];
1460d45a07a7SBarry Smith 
1461e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1462a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14632657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14642657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14652657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1466d763cef2SBarry Smith     }
14670acecf5bSBarry Smith     if (ts->ops->view) {
14680acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14690acecf5bSBarry Smith     }
1470f05ece33SBarry Smith #endif
1471f05ece33SBarry Smith   }
1472f05ece33SBarry Smith 
1473b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1474251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1475b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1476d763cef2SBarry Smith   PetscFunctionReturn(0);
1477d763cef2SBarry Smith }
1478d763cef2SBarry Smith 
1479d763cef2SBarry Smith 
14804a2ae208SSatish Balay #undef __FUNCT__
14814a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1482b07ff414SBarry Smith /*@
1483d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1484d763cef2SBarry Smith    the timesteppers.
1485d763cef2SBarry Smith 
14863f9fe445SBarry Smith    Logically Collective on TS
1487d763cef2SBarry Smith 
1488d763cef2SBarry Smith    Input Parameters:
1489d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1490d763cef2SBarry Smith -  usrP - optional user context
1491d763cef2SBarry Smith 
1492d763cef2SBarry Smith    Level: intermediate
1493d763cef2SBarry Smith 
1494d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1495d763cef2SBarry Smith 
1496d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1497d763cef2SBarry Smith @*/
14987087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1499d763cef2SBarry Smith {
1500d763cef2SBarry Smith   PetscFunctionBegin;
15010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1502d763cef2SBarry Smith   ts->user = usrP;
1503d763cef2SBarry Smith   PetscFunctionReturn(0);
1504d763cef2SBarry Smith }
1505d763cef2SBarry Smith 
15064a2ae208SSatish Balay #undef __FUNCT__
15074a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1508b07ff414SBarry Smith /*@
1509d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1510d763cef2SBarry Smith     timestepper.
1511d763cef2SBarry Smith 
1512d763cef2SBarry Smith     Not Collective
1513d763cef2SBarry Smith 
1514d763cef2SBarry Smith     Input Parameter:
1515d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1516d763cef2SBarry Smith 
1517d763cef2SBarry Smith     Output Parameter:
1518d763cef2SBarry Smith .   usrP - user context
1519d763cef2SBarry Smith 
1520d763cef2SBarry Smith     Level: intermediate
1521d763cef2SBarry Smith 
1522d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1523d763cef2SBarry Smith 
1524d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1525d763cef2SBarry Smith @*/
1526e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1527d763cef2SBarry Smith {
1528d763cef2SBarry Smith   PetscFunctionBegin;
15290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1530e71120c6SJed Brown   *(void**)usrP = ts->user;
1531d763cef2SBarry Smith   PetscFunctionReturn(0);
1532d763cef2SBarry Smith }
1533d763cef2SBarry Smith 
15344a2ae208SSatish Balay #undef __FUNCT__
15354a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1536d763cef2SBarry Smith /*@
1537b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1538d763cef2SBarry Smith 
1539d763cef2SBarry Smith    Not Collective
1540d763cef2SBarry Smith 
1541d763cef2SBarry Smith    Input Parameter:
1542d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1543d763cef2SBarry Smith 
1544d763cef2SBarry Smith    Output Parameter:
1545b8123daeSJed Brown .  iter - number of steps completed so far
1546d763cef2SBarry Smith 
1547d763cef2SBarry Smith    Level: intermediate
1548d763cef2SBarry Smith 
1549d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15509be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1551d763cef2SBarry Smith @*/
15527087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1553d763cef2SBarry Smith {
1554d763cef2SBarry Smith   PetscFunctionBegin;
15550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15564482741eSBarry Smith   PetscValidIntPointer(iter,2);
1557d763cef2SBarry Smith   *iter = ts->steps;
1558d763cef2SBarry Smith   PetscFunctionReturn(0);
1559d763cef2SBarry Smith }
1560d763cef2SBarry Smith 
15614a2ae208SSatish Balay #undef __FUNCT__
15624a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1563d763cef2SBarry Smith /*@
1564d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1565d763cef2SBarry Smith    as well as the initial time.
1566d763cef2SBarry Smith 
15673f9fe445SBarry Smith    Logically Collective on TS
1568d763cef2SBarry Smith 
1569d763cef2SBarry Smith    Input Parameters:
1570d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1571d763cef2SBarry Smith .  initial_time - the initial time
1572d763cef2SBarry Smith -  time_step - the size of the timestep
1573d763cef2SBarry Smith 
1574d763cef2SBarry Smith    Level: intermediate
1575d763cef2SBarry Smith 
1576d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1577d763cef2SBarry Smith 
1578d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1579d763cef2SBarry Smith @*/
15807087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1581d763cef2SBarry Smith {
1582e144a568SJed Brown   PetscErrorCode ierr;
1583e144a568SJed Brown 
1584d763cef2SBarry Smith   PetscFunctionBegin;
15850700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1586e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1587d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1588d763cef2SBarry Smith   PetscFunctionReturn(0);
1589d763cef2SBarry Smith }
1590d763cef2SBarry Smith 
15914a2ae208SSatish Balay #undef __FUNCT__
15924a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1593d763cef2SBarry Smith /*@
1594d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1595d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1596d763cef2SBarry Smith 
15973f9fe445SBarry Smith    Logically Collective on TS
1598d763cef2SBarry Smith 
1599d763cef2SBarry Smith    Input Parameters:
1600d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1601d763cef2SBarry Smith -  time_step - the size of the timestep
1602d763cef2SBarry Smith 
1603d763cef2SBarry Smith    Level: intermediate
1604d763cef2SBarry Smith 
1605d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1606d763cef2SBarry Smith 
1607d763cef2SBarry Smith .keywords: TS, set, timestep
1608d763cef2SBarry Smith @*/
16097087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1610d763cef2SBarry Smith {
1611d763cef2SBarry Smith   PetscFunctionBegin;
16120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1613c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1614d763cef2SBarry Smith   ts->time_step      = time_step;
161531748224SBarry Smith   ts->time_step_orig = time_step;
1616d763cef2SBarry Smith   PetscFunctionReturn(0);
1617d763cef2SBarry Smith }
1618d763cef2SBarry Smith 
16194a2ae208SSatish Balay #undef __FUNCT__
1620a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1621a43b19c4SJed Brown /*@
162249354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
162349354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
162449354f04SShri Abhyankar      or just return at the final time TS computed.
1625a43b19c4SJed Brown 
1626a43b19c4SJed Brown   Logically Collective on TS
1627a43b19c4SJed Brown 
1628a43b19c4SJed Brown    Input Parameter:
1629a43b19c4SJed Brown +   ts - the time-step context
163049354f04SShri Abhyankar -   eftopt - exact final time option
1631a43b19c4SJed Brown 
1632a43b19c4SJed Brown    Level: beginner
1633a43b19c4SJed Brown 
1634a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1635a43b19c4SJed Brown @*/
163649354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1637a43b19c4SJed Brown {
1638a43b19c4SJed Brown   PetscFunctionBegin;
1639a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
164049354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
164149354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1642a43b19c4SJed Brown   PetscFunctionReturn(0);
1643a43b19c4SJed Brown }
1644a43b19c4SJed Brown 
1645a43b19c4SJed Brown #undef __FUNCT__
16464a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1647d763cef2SBarry Smith /*@
1648d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1649d763cef2SBarry Smith 
1650d763cef2SBarry Smith    Not Collective
1651d763cef2SBarry Smith 
1652d763cef2SBarry Smith    Input Parameter:
1653d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1654d763cef2SBarry Smith 
1655d763cef2SBarry Smith    Output Parameter:
1656d763cef2SBarry Smith .  dt - the current timestep size
1657d763cef2SBarry Smith 
1658d763cef2SBarry Smith    Level: intermediate
1659d763cef2SBarry Smith 
1660d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1661d763cef2SBarry Smith 
1662d763cef2SBarry Smith .keywords: TS, get, timestep
1663d763cef2SBarry Smith @*/
16647087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1665d763cef2SBarry Smith {
1666d763cef2SBarry Smith   PetscFunctionBegin;
16670700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1668f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1669d763cef2SBarry Smith   *dt = ts->time_step;
1670d763cef2SBarry Smith   PetscFunctionReturn(0);
1671d763cef2SBarry Smith }
1672d763cef2SBarry Smith 
16734a2ae208SSatish Balay #undef __FUNCT__
16744a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1675d8e5e3e6SSatish Balay /*@
1676d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1677d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1678d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1679d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1680d763cef2SBarry Smith 
1681d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1682d763cef2SBarry Smith 
1683d763cef2SBarry Smith    Input Parameter:
1684d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1685d763cef2SBarry Smith 
1686d763cef2SBarry Smith    Output Parameter:
1687d763cef2SBarry Smith .  v - the vector containing the solution
1688d763cef2SBarry Smith 
1689d763cef2SBarry Smith    Level: intermediate
1690d763cef2SBarry Smith 
1691d763cef2SBarry Smith .seealso: TSGetTimeStep()
1692d763cef2SBarry Smith 
1693d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1694d763cef2SBarry Smith @*/
16957087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1696d763cef2SBarry Smith {
1697d763cef2SBarry Smith   PetscFunctionBegin;
16980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16994482741eSBarry Smith   PetscValidPointer(v,2);
17008737fe31SLisandro Dalcin   *v = ts->vec_sol;
1701d763cef2SBarry Smith   PetscFunctionReturn(0);
1702d763cef2SBarry Smith }
1703d763cef2SBarry Smith 
1704c235aa8dSHong Zhang #undef __FUNCT__
1705d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointGetSensitivity"
1706c235aa8dSHong Zhang /*@
1707d4aa0a58SBarry Smith    TSAdjointGetSensitivity - Returns the sensitivity in the reverse mode.
1708c235aa8dSHong Zhang 
1709c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1710c235aa8dSHong Zhang 
1711c235aa8dSHong Zhang    Input Parameter:
1712c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1713c235aa8dSHong Zhang 
1714c235aa8dSHong Zhang    Output Parameter:
1715c235aa8dSHong Zhang .  v - the vector containing the solution
1716c235aa8dSHong Zhang 
1717c235aa8dSHong Zhang    Level: intermediate
1718c235aa8dSHong Zhang 
1719c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1720c235aa8dSHong Zhang 
1721c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1722c235aa8dSHong Zhang @*/
1723d4aa0a58SBarry Smith PetscErrorCode  TSAdjointGetSensitivity(TS ts,Vec **v,PetscInt *numberadjs)
1724c235aa8dSHong Zhang {
1725c235aa8dSHong Zhang   PetscFunctionBegin;
1726c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1727c235aa8dSHong Zhang   PetscValidPointer(v,2);
1728b18ea86cSHong Zhang   *v          = ts->vecs_sensi;
1729b18ea86cSHong Zhang   if(numberadjs) *numberadjs = ts->numberadjs;
1730c235aa8dSHong Zhang   PetscFunctionReturn(0);
1731c235aa8dSHong Zhang }
1732c235aa8dSHong Zhang 
1733bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17344a2ae208SSatish Balay #undef __FUNCT__
1735bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1736d8e5e3e6SSatish Balay /*@
1737bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1738d763cef2SBarry Smith 
1739bdad233fSMatthew Knepley   Not collective
1740d763cef2SBarry Smith 
1741bdad233fSMatthew Knepley   Input Parameters:
1742bdad233fSMatthew Knepley + ts   - The TS
1743bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1744d763cef2SBarry Smith .vb
17450910c330SBarry Smith          U_t - A U = 0      (linear)
17460910c330SBarry Smith          U_t - A(t) U = 0   (linear)
17470910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1748d763cef2SBarry Smith .ve
1749d763cef2SBarry Smith 
1750d763cef2SBarry Smith    Level: beginner
1751d763cef2SBarry Smith 
1752bdad233fSMatthew Knepley .keywords: TS, problem type
1753bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1754d763cef2SBarry Smith @*/
17557087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1756a7cc72afSBarry Smith {
17579e2a6581SJed Brown   PetscErrorCode ierr;
17589e2a6581SJed Brown 
1759d763cef2SBarry Smith   PetscFunctionBegin;
17600700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1761bdad233fSMatthew Knepley   ts->problem_type = type;
17629e2a6581SJed Brown   if (type == TS_LINEAR) {
17639e2a6581SJed Brown     SNES snes;
17649e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17659e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17669e2a6581SJed Brown   }
1767d763cef2SBarry Smith   PetscFunctionReturn(0);
1768d763cef2SBarry Smith }
1769d763cef2SBarry Smith 
1770bdad233fSMatthew Knepley #undef __FUNCT__
1771bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1772bdad233fSMatthew Knepley /*@C
1773bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1774bdad233fSMatthew Knepley 
1775bdad233fSMatthew Knepley   Not collective
1776bdad233fSMatthew Knepley 
1777bdad233fSMatthew Knepley   Input Parameter:
1778bdad233fSMatthew Knepley . ts   - The TS
1779bdad233fSMatthew Knepley 
1780bdad233fSMatthew Knepley   Output Parameter:
1781bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1782bdad233fSMatthew Knepley .vb
1783089b2837SJed Brown          M U_t = A U
1784089b2837SJed Brown          M(t) U_t = A(t) U
1785b5abc632SBarry Smith          F(t,U,U_t)
1786bdad233fSMatthew Knepley .ve
1787bdad233fSMatthew Knepley 
1788bdad233fSMatthew Knepley    Level: beginner
1789bdad233fSMatthew Knepley 
1790bdad233fSMatthew Knepley .keywords: TS, problem type
1791bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1792bdad233fSMatthew Knepley @*/
17937087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1794a7cc72afSBarry Smith {
1795bdad233fSMatthew Knepley   PetscFunctionBegin;
17960700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
17974482741eSBarry Smith   PetscValidIntPointer(type,2);
1798bdad233fSMatthew Knepley   *type = ts->problem_type;
1799bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1800bdad233fSMatthew Knepley }
1801d763cef2SBarry Smith 
18024a2ae208SSatish Balay #undef __FUNCT__
18034a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1804d763cef2SBarry Smith /*@
1805d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1806d763cef2SBarry Smith    of a timestepper.
1807d763cef2SBarry Smith 
1808d763cef2SBarry Smith    Collective on TS
1809d763cef2SBarry Smith 
1810d763cef2SBarry Smith    Input Parameter:
1811d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1812d763cef2SBarry Smith 
1813d763cef2SBarry Smith    Notes:
1814d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1815d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1816d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1817d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1818d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1819d763cef2SBarry Smith 
1820d763cef2SBarry Smith    Level: advanced
1821d763cef2SBarry Smith 
1822d763cef2SBarry Smith .keywords: TS, timestep, setup
1823d763cef2SBarry Smith 
1824d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1825d763cef2SBarry Smith @*/
18267087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1827d763cef2SBarry Smith {
1828dfbe8321SBarry Smith   PetscErrorCode ierr;
18296c6b9e74SPeter Brune   DM             dm;
18306c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1831d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18326c6b9e74SPeter Brune   TSIJacobian    ijac;
18336c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1834d763cef2SBarry Smith 
1835d763cef2SBarry Smith   PetscFunctionBegin;
18360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1837277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1838277b19d0SLisandro Dalcin 
18397adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18409596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1841d763cef2SBarry Smith   }
1842277b19d0SLisandro Dalcin 
1843277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1844277b19d0SLisandro Dalcin 
1845c235aa8dSHong Zhang 
1846552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
18471c3436cfSJed Brown 
1848e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1849e1244c69SJed Brown     Mat Amat,Pmat;
1850e1244c69SJed Brown     SNES snes;
1851e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1852e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1853e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1854e1244c69SJed Brown      * have displaced the RHS matrix */
1855e1244c69SJed Brown     if (Amat == ts->Arhs) {
1856e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1857e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1858e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1859e1244c69SJed Brown     }
1860e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1861e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1862e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1863e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1864e1244c69SJed Brown     }
1865e1244c69SJed Brown   }
1866277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1867000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1868277b19d0SLisandro Dalcin   }
1869277b19d0SLisandro Dalcin 
18706c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
18716c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
18726c6b9e74SPeter Brune    */
18736c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
18740298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
18756c6b9e74SPeter Brune   if (!func) {
18766c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
18776c6b9e74SPeter Brune   }
18786c6b9e74SPeter 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.
18796c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
18806c6b9e74SPeter Brune    */
18810298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
18820298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
18830298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
18846c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
18856c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
18866c6b9e74SPeter Brune   }
1887277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1888277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1889277b19d0SLisandro Dalcin }
1890277b19d0SLisandro Dalcin 
1891277b19d0SLisandro Dalcin #undef __FUNCT__
1892f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
1893f6a906c0SBarry Smith /*@
1894f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
1895f6a906c0SBarry Smith    of an adjoint solver
1896f6a906c0SBarry Smith 
1897f6a906c0SBarry Smith    Collective on TS
1898f6a906c0SBarry Smith 
1899f6a906c0SBarry Smith    Input Parameter:
1900f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
1901f6a906c0SBarry Smith 
1902f6a906c0SBarry Smith    Notes:
1903f6a906c0SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1904f6a906c0SBarry Smith    TSSetUp(), since these actions will automatically occur during
1905f6a906c0SBarry Smith    the call to TSStep().  However, if one wishes to control this
1906f6a906c0SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1907f6a906c0SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1908f6a906c0SBarry Smith 
1909f6a906c0SBarry Smith    Level: advanced
1910f6a906c0SBarry Smith 
1911f6a906c0SBarry Smith .keywords: TS, timestep, setup
1912f6a906c0SBarry Smith 
1913f6a906c0SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1914f6a906c0SBarry Smith @*/
1915f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
1916f6a906c0SBarry Smith {
1917f6a906c0SBarry Smith   PetscErrorCode ierr;
1918f6a906c0SBarry Smith 
1919f6a906c0SBarry Smith   PetscFunctionBegin;
1920f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1921f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
1922*08c7845fSBarry Smith   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetSensitivity() first");
1923f6a906c0SBarry Smith   if (ts->ops->setupadj) {
1924f6a906c0SBarry Smith     ierr = (*ts->ops->setupadj)(ts);CHKERRQ(ierr);
1925f6a906c0SBarry Smith   }
1926f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
1927f6a906c0SBarry Smith   PetscFunctionReturn(0);
1928f6a906c0SBarry Smith }
1929f6a906c0SBarry Smith 
1930f6a906c0SBarry Smith #undef __FUNCT__
1931277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1932277b19d0SLisandro Dalcin /*@
1933277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1934277b19d0SLisandro Dalcin 
1935277b19d0SLisandro Dalcin    Collective on TS
1936277b19d0SLisandro Dalcin 
1937277b19d0SLisandro Dalcin    Input Parameter:
1938277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1939277b19d0SLisandro Dalcin 
1940277b19d0SLisandro Dalcin    Level: beginner
1941277b19d0SLisandro Dalcin 
1942277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1943277b19d0SLisandro Dalcin 
1944277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1945277b19d0SLisandro Dalcin @*/
1946277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1947277b19d0SLisandro Dalcin {
1948277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1949277b19d0SLisandro Dalcin 
1950277b19d0SLisandro Dalcin   PetscFunctionBegin;
1951277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1952b18ea86cSHong Zhang 
1953277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1954277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1955277b19d0SLisandro Dalcin   }
1956277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1957bbd56ea5SKarl Rupp 
19584e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
19594e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1960214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
19616bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1962e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1963e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
196438637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1965f8fee759SHong Zhang   ts->vecs_sensi = 0;
1966f8fee759SHong Zhang   ts->vecs_sensip = 0;
1967ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
196805755b9cSHong Zhang   ierr = VecDestroy(&ts->vec_costquad);CHKERRQ(ierr);
196936eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
1970277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1971d763cef2SBarry Smith   PetscFunctionReturn(0);
1972d763cef2SBarry Smith }
1973d763cef2SBarry Smith 
19744a2ae208SSatish Balay #undef __FUNCT__
19754a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1976d8e5e3e6SSatish Balay /*@
1977d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1978d763cef2SBarry Smith    with TSCreate().
1979d763cef2SBarry Smith 
1980d763cef2SBarry Smith    Collective on TS
1981d763cef2SBarry Smith 
1982d763cef2SBarry Smith    Input Parameter:
1983d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1984d763cef2SBarry Smith 
1985d763cef2SBarry Smith    Level: beginner
1986d763cef2SBarry Smith 
1987d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1988d763cef2SBarry Smith 
1989d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1990d763cef2SBarry Smith @*/
19916bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1992d763cef2SBarry Smith {
19936849ba73SBarry Smith   PetscErrorCode ierr;
1994d763cef2SBarry Smith 
1995d763cef2SBarry Smith   PetscFunctionBegin;
19966bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
19976bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
19986bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1999d763cef2SBarry Smith 
20006bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2001277b19d0SLisandro Dalcin 
2002e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2003e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20046bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20056d4c513bSLisandro Dalcin 
200684df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2007aeb4809dSShri Abhyankar   if ((*ts)->event) {
2008aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2009aeb4809dSShri Abhyankar   }
20106bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20116bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20126bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20136d4c513bSLisandro Dalcin 
2014a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2015d763cef2SBarry Smith   PetscFunctionReturn(0);
2016d763cef2SBarry Smith }
2017d763cef2SBarry Smith 
20184a2ae208SSatish Balay #undef __FUNCT__
20194a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2020d8e5e3e6SSatish Balay /*@
2021d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2022d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2023d763cef2SBarry Smith 
2024d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2025d763cef2SBarry Smith 
2026d763cef2SBarry Smith    Input Parameter:
2027d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2028d763cef2SBarry Smith 
2029d763cef2SBarry Smith    Output Parameter:
2030d763cef2SBarry Smith .  snes - the nonlinear solver context
2031d763cef2SBarry Smith 
2032d763cef2SBarry Smith    Notes:
2033d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2034d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
203594b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2036d763cef2SBarry Smith 
2037d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20380298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2039d763cef2SBarry Smith 
2040d763cef2SBarry Smith    Level: beginner
2041d763cef2SBarry Smith 
2042d763cef2SBarry Smith .keywords: timestep, get, SNES
2043d763cef2SBarry Smith @*/
20447087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2045d763cef2SBarry Smith {
2046d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2047d372ba47SLisandro Dalcin 
2048d763cef2SBarry Smith   PetscFunctionBegin;
20490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20504482741eSBarry Smith   PetscValidPointer(snes,2);
2051d372ba47SLisandro Dalcin   if (!ts->snes) {
2052ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20530298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20543bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2055d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2056496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20579e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20589e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20599e2a6581SJed Brown     }
2060d372ba47SLisandro Dalcin   }
2061d763cef2SBarry Smith   *snes = ts->snes;
2062d763cef2SBarry Smith   PetscFunctionReturn(0);
2063d763cef2SBarry Smith }
2064d763cef2SBarry Smith 
20654a2ae208SSatish Balay #undef __FUNCT__
2066deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2067deb2cd25SJed Brown /*@
2068deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2069deb2cd25SJed Brown 
2070deb2cd25SJed Brown    Collective
2071deb2cd25SJed Brown 
2072deb2cd25SJed Brown    Input Parameter:
2073deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2074deb2cd25SJed Brown -  snes - the nonlinear solver context
2075deb2cd25SJed Brown 
2076deb2cd25SJed Brown    Notes:
2077deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2078deb2cd25SJed Brown 
2079deb2cd25SJed Brown    Level: developer
2080deb2cd25SJed Brown 
2081deb2cd25SJed Brown .keywords: timestep, set, SNES
2082deb2cd25SJed Brown @*/
2083deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2084deb2cd25SJed Brown {
2085deb2cd25SJed Brown   PetscErrorCode ierr;
2086d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2087deb2cd25SJed Brown 
2088deb2cd25SJed Brown   PetscFunctionBegin;
2089deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2090deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2091deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2092deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2093bbd56ea5SKarl Rupp 
2094deb2cd25SJed Brown   ts->snes = snes;
2095bbd56ea5SKarl Rupp 
20960298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20970298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2098740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
20990298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2100740132f1SEmil Constantinescu   }
2101deb2cd25SJed Brown   PetscFunctionReturn(0);
2102deb2cd25SJed Brown }
2103deb2cd25SJed Brown 
2104deb2cd25SJed Brown #undef __FUNCT__
210594b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2106d8e5e3e6SSatish Balay /*@
210794b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2108d763cef2SBarry Smith    a TS (timestepper) context.
2109d763cef2SBarry Smith 
211094b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2111d763cef2SBarry Smith 
2112d763cef2SBarry Smith    Input Parameter:
2113d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2114d763cef2SBarry Smith 
2115d763cef2SBarry Smith    Output Parameter:
211694b7f48cSBarry Smith .  ksp - the nonlinear solver context
2117d763cef2SBarry Smith 
2118d763cef2SBarry Smith    Notes:
211994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2120d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2121d763cef2SBarry Smith    KSP and PC contexts as well.
2122d763cef2SBarry Smith 
212394b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21240298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2125d763cef2SBarry Smith 
2126d763cef2SBarry Smith    Level: beginner
2127d763cef2SBarry Smith 
212894b7f48cSBarry Smith .keywords: timestep, get, KSP
2129d763cef2SBarry Smith @*/
21307087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2131d763cef2SBarry Smith {
2132d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2133089b2837SJed Brown   SNES           snes;
2134d372ba47SLisandro Dalcin 
2135d763cef2SBarry Smith   PetscFunctionBegin;
21360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21374482741eSBarry Smith   PetscValidPointer(ksp,2);
213817186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2139e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2140089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2141089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2142d763cef2SBarry Smith   PetscFunctionReturn(0);
2143d763cef2SBarry Smith }
2144d763cef2SBarry Smith 
2145d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2146d763cef2SBarry Smith 
21474a2ae208SSatish Balay #undef __FUNCT__
2148adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2149adb62b0dSMatthew Knepley /*@
2150adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2151adb62b0dSMatthew Knepley    maximum time for iteration.
2152adb62b0dSMatthew Knepley 
21533f9fe445SBarry Smith    Not Collective
2154adb62b0dSMatthew Knepley 
2155adb62b0dSMatthew Knepley    Input Parameters:
2156adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21570298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21580298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2159adb62b0dSMatthew Knepley 
2160adb62b0dSMatthew Knepley    Level: intermediate
2161adb62b0dSMatthew Knepley 
2162adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2163adb62b0dSMatthew Knepley @*/
21647087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2165adb62b0dSMatthew Knepley {
2166adb62b0dSMatthew Knepley   PetscFunctionBegin;
21670700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2168abc0a331SBarry Smith   if (maxsteps) {
21694482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2170adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2171adb62b0dSMatthew Knepley   }
2172abc0a331SBarry Smith   if (maxtime) {
21734482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2174adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2175adb62b0dSMatthew Knepley   }
2176adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2177adb62b0dSMatthew Knepley }
2178adb62b0dSMatthew Knepley 
2179adb62b0dSMatthew Knepley #undef __FUNCT__
21804a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2181d763cef2SBarry Smith /*@
2182d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2183d763cef2SBarry Smith    maximum time for iteration.
2184d763cef2SBarry Smith 
21853f9fe445SBarry Smith    Logically Collective on TS
2186d763cef2SBarry Smith 
2187d763cef2SBarry Smith    Input Parameters:
2188d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2189d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2190d763cef2SBarry Smith -  maxtime - final time to iterate to
2191d763cef2SBarry Smith 
2192d763cef2SBarry Smith    Options Database Keys:
2193d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
21943bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2195d763cef2SBarry Smith 
2196d763cef2SBarry Smith    Notes:
2197d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2198d763cef2SBarry Smith 
2199d763cef2SBarry Smith    Level: intermediate
2200d763cef2SBarry Smith 
2201d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2202a43b19c4SJed Brown 
2203a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2204d763cef2SBarry Smith @*/
22057087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2206d763cef2SBarry Smith {
2207d763cef2SBarry Smith   PetscFunctionBegin;
22080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2209c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2210c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
221139b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
221239b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2213d763cef2SBarry Smith   PetscFunctionReturn(0);
2214d763cef2SBarry Smith }
2215d763cef2SBarry Smith 
22164a2ae208SSatish Balay #undef __FUNCT__
22174a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2218d763cef2SBarry Smith /*@
2219d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2220d763cef2SBarry Smith    for use by the TS routines.
2221d763cef2SBarry Smith 
22223f9fe445SBarry Smith    Logically Collective on TS and Vec
2223d763cef2SBarry Smith 
2224d763cef2SBarry Smith    Input Parameters:
2225d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22260910c330SBarry Smith -  u - the solution vector
2227d763cef2SBarry Smith 
2228d763cef2SBarry Smith    Level: beginner
2229d763cef2SBarry Smith 
2230d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2231d763cef2SBarry Smith @*/
22320910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2233d763cef2SBarry Smith {
22348737fe31SLisandro Dalcin   PetscErrorCode ierr;
2235496e6a7aSJed Brown   DM             dm;
22368737fe31SLisandro Dalcin 
2237d763cef2SBarry Smith   PetscFunctionBegin;
22380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22390910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22400910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22416bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2242bbd56ea5SKarl Rupp 
22430910c330SBarry Smith   ts->vec_sol = u;
2244bbd56ea5SKarl Rupp 
2245496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22460910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2247d763cef2SBarry Smith   PetscFunctionReturn(0);
2248d763cef2SBarry Smith }
2249d763cef2SBarry Smith 
2250e74ef692SMatthew Knepley #undef __FUNCT__
2251d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetSensitivity"
2252c235aa8dSHong Zhang /*@
2253d4aa0a58SBarry Smith    TSAdjointSetSensitivity - Sets the initial value of sensitivity (w.r.t. initial conditions)
2254c235aa8dSHong Zhang    for use by the TS routines.
2255c235aa8dSHong Zhang 
2256c235aa8dSHong Zhang    Logically Collective on TS and Vec
2257c235aa8dSHong Zhang 
2258c235aa8dSHong Zhang    Input Parameters:
2259c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2260c235aa8dSHong Zhang -  u - the solution vector
2261c235aa8dSHong Zhang 
2262c235aa8dSHong Zhang    Level: beginner
2263c235aa8dSHong Zhang 
2264c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2265c235aa8dSHong Zhang @*/
2266d4aa0a58SBarry Smith PetscErrorCode  TSAdjointSetSensitivity(TS ts,Vec *u,PetscInt numberadjs)
2267c235aa8dSHong Zhang {
2268c235aa8dSHong Zhang   PetscFunctionBegin;
2269c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2270b18ea86cSHong Zhang   PetscValidPointer(u,2);
2271b18ea86cSHong Zhang   ts->vecs_sensi = u;
2272d4aa0a58SBarry Smith   if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of adjoint variables (3rd parameter) is inconsistent with the one set by TSAdjointSetSensitivityP()");
2273b18ea86cSHong Zhang   ts->numberadjs = numberadjs;
2274c235aa8dSHong Zhang 
2275ad8e2604SHong Zhang   PetscFunctionReturn(0);
2276ad8e2604SHong Zhang }
2277ad8e2604SHong Zhang 
2278ad8e2604SHong Zhang #undef __FUNCT__
2279d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetSensitivityP"
2280ad8e2604SHong Zhang /*@
2281d4aa0a58SBarry Smith    TSAdjointSetSensitivityP - Sets the initial value of sensitivity (w.r.t. parameters)
2282ad8e2604SHong Zhang    for use by the TS routines.
2283ad8e2604SHong Zhang 
2284ad8e2604SHong Zhang    Logically Collective on TS and Vec
2285ad8e2604SHong Zhang 
2286ad8e2604SHong Zhang    Input Parameters:
2287ad8e2604SHong Zhang +  ts - the TS context obtained from TSCreate()
2288ad8e2604SHong Zhang -  u - the solution vector
2289ad8e2604SHong Zhang 
2290ad8e2604SHong Zhang    Level: beginner
2291ad8e2604SHong Zhang 
2292ad8e2604SHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2293ad8e2604SHong Zhang @*/
2294d4aa0a58SBarry Smith PetscErrorCode  TSAdjointSetSensitivityP(TS ts,Vec *u,PetscInt numberadjs)
2295ad8e2604SHong Zhang {
2296ad8e2604SHong Zhang   PetscFunctionBegin;
2297ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2298ad8e2604SHong Zhang   PetscValidPointer(u,2);
2299ad8e2604SHong Zhang   ts->vecs_sensip = u;
2300d4aa0a58SBarry Smith   if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of adjoint variables (3rd parameter) is inconsistent with the one set by TSAdjointSetSensitivity()");
2301ad8e2604SHong Zhang   ts->numberadjs = numberadjs;
2302ad8e2604SHong Zhang 
2303ad8e2604SHong Zhang   PetscFunctionReturn(0);
2304ad8e2604SHong Zhang }
2305ad8e2604SHong Zhang 
2306ad8e2604SHong Zhang #undef __FUNCT__
2307d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobianP"
2308ad8e2604SHong Zhang /*@C
2309d4aa0a58SBarry Smith   TSAdjointSetRHSJacobianP - Sets the function that computes the Jacobian w.r.t. parameters.
2310ad8e2604SHong Zhang 
2311ad8e2604SHong Zhang   Logically Collective on TS
2312ad8e2604SHong Zhang 
2313ad8e2604SHong Zhang   Input Parameters:
2314ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2315ad8e2604SHong Zhang - func - The function
2316ad8e2604SHong Zhang 
2317ad8e2604SHong Zhang   Calling sequence of func:
231805755b9cSHong Zhang $ func (TS ts,PetscReal t,Vec u,Mat A,void *ctx);
231905755b9cSHong Zhang +   t - current timestep
232005755b9cSHong Zhang .   u - input vector
232105755b9cSHong Zhang .   A - output matrix
232205755b9cSHong Zhang -   ctx - [optional] user-defined function context
2323ad8e2604SHong Zhang 
2324ad8e2604SHong Zhang   Level: intermediate
2325ad8e2604SHong Zhang 
2326ad8e2604SHong Zhang .keywords: TS, sensitivity
2327ad8e2604SHong Zhang .seealso:
2328ad8e2604SHong Zhang @*/
2329d4aa0a58SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobianP(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2330ad8e2604SHong Zhang {
2331ad8e2604SHong Zhang   PetscErrorCode ierr;
2332ad8e2604SHong Zhang 
2333ad8e2604SHong Zhang   PetscFunctionBegin;
2334ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2335ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2336ad8e2604SHong Zhang 
2337ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2338ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2339ad8e2604SHong Zhang   if(Amat) {
2340ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2341ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2342ad8e2604SHong Zhang 
2343ad8e2604SHong Zhang     ts->Jacp = Amat;
2344ad8e2604SHong Zhang   }
2345ad8e2604SHong Zhang   PetscFunctionReturn(0);
2346ad8e2604SHong Zhang }
2347ad8e2604SHong Zhang 
2348ad8e2604SHong Zhang #undef __FUNCT__
2349d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobianP"
2350ad8e2604SHong Zhang /*@
2351d4aa0a58SBarry Smith   TSAdjointComputeRHSJacobianP - Runs the user-defined JacobianP function.
2352ad8e2604SHong Zhang 
2353ad8e2604SHong Zhang   Collective on TS
2354ad8e2604SHong Zhang 
2355ad8e2604SHong Zhang   Input Parameters:
2356ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2357ad8e2604SHong Zhang 
2358ad8e2604SHong Zhang   Level: developer
2359ad8e2604SHong Zhang 
2360ad8e2604SHong Zhang .keywords: TS, sensitivity
2361d4aa0a58SBarry Smith .seealso: TSAdjointSetRHSJacobianP()
2362ad8e2604SHong Zhang @*/
2363d4aa0a58SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobianP(TS ts,PetscReal t,Vec X,Mat Amat)
2364ad8e2604SHong Zhang {
2365ad8e2604SHong Zhang   PetscErrorCode ierr;
2366ad8e2604SHong Zhang 
2367ad8e2604SHong Zhang   PetscFunctionBegin;
2368ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2369ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2370ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2371ad8e2604SHong Zhang 
2372ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2373ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2374ad8e2604SHong Zhang   PetscStackPop;
2375ad8e2604SHong Zhang 
2376c235aa8dSHong Zhang   PetscFunctionReturn(0);
2377c235aa8dSHong Zhang }
2378c235aa8dSHong Zhang 
2379c235aa8dSHong Zhang #undef __FUNCT__
2380d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetCostIntegrand"
23816fd0887fSHong Zhang /*@C
2382d4aa0a58SBarry Smith     TSAdjointSetCostIntegrand - Sets the routine for evaluating the quadrature (or integral) term in a cost function,
23836fd0887fSHong Zhang     where Q_t = r(t,u).
23846fd0887fSHong Zhang 
23856fd0887fSHong Zhang     Logically Collective on TS
23866fd0887fSHong Zhang 
23876fd0887fSHong Zhang     Input Parameters:
23886fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
238936eaed60SHong Zhang .   q -  vector to put the computed quadrature term in the cost function (or NULL to have it created)
23906fd0887fSHong Zhang .   fq - routine for evaluating the right-hand-side function
23916fd0887fSHong Zhang -   ctx - [optional] user-defined context for private data for the
23926fd0887fSHong Zhang           function evaluation routine (may be NULL)
23936fd0887fSHong Zhang 
23946fd0887fSHong Zhang     Calling sequence of func:
2395a2ae3dd2SHong Zhang $     TSCostIntegrand(TS ts,PetscReal t,Vec u,PetscReal *f,void *ctx);
23966fd0887fSHong Zhang 
23976fd0887fSHong Zhang +   t - current timestep
23986fd0887fSHong Zhang .   u - input vector
239936eaed60SHong Zhang .   f - function vector
24006fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24016fd0887fSHong Zhang 
24026fd0887fSHong Zhang     Level: beginner
24036fd0887fSHong Zhang 
24046fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24056fd0887fSHong Zhang 
2406d4aa0a58SBarry Smith .seealso: TSAdjointSetRHSJacobianP(),TSAdjointSetSensitivity(),TSAdjointSetSensitivityP()
24076fd0887fSHong Zhang @*/
2408d4aa0a58SBarry Smith PetscErrorCode  TSAdjointSetCostIntegrand(TS ts,PetscInt numberadjs,Vec q,PetscErrorCode (*fq)(TS,PetscReal,Vec,Vec,void*),void *ctx)
24096fd0887fSHong Zhang {
24106fd0887fSHong Zhang   PetscErrorCode ierr;
241136eaed60SHong Zhang   PetscInt size;
24126fd0887fSHong Zhang 
24136fd0887fSHong Zhang   PetscFunctionBegin;
24146fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
241536eaed60SHong Zhang   if (q) {
241636eaed60SHong Zhang     PetscValidHeaderSpecific(q,VEC_CLASSID,2);
241736eaed60SHong Zhang   } else {
2418d4aa0a58SBarry Smith     SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"TSAdjointSetCostIntegrand() requires a vector of size numberajds to hold the value of integrals as 3rd input parameter");
24196fd0887fSHong Zhang   }
2420d4aa0a58SBarry Smith   if (!ts->numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSAdjointSetSensitivity() or TSAdjointSetSensitivityP() first so that the number of cost functions can be determined.");
2421d4aa0a58SBarry Smith   if (ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSAdjointSetCostIntegrand()) is inconsistent with the one set by TSAdjointSetSensitivity() or TSAdjointSetSensitivityP()");
242236eaed60SHong Zhang   ierr = VecGetSize(q,&size);CHKERRQ(ierr);
2423a2ae3dd2SHong Zhang   ierr = VecZeroEntries(q);CHKERRQ(ierr);
2424d4aa0a58SBarry Smith   if (size!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions is inconsistent with the number of integrals (size of the 3rd input vector of TSAdjointSetCostIntegrand()).");
24256fd0887fSHong Zhang 
242636eaed60SHong Zhang   ierr = PetscObjectReference((PetscObject)q);CHKERRQ(ierr);
242736eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costquad);CHKERRQ(ierr);
242836eaed60SHong Zhang   ts->vec_costquad = q;
242936eaed60SHong Zhang 
2430a2ae3dd2SHong Zhang   ierr                  = VecDuplicate(ts->vec_costquad,&ts->vec_costintegrand);CHKERRQ(ierr);
2431e4680132SHong Zhang   ts->costintegrand     = fq;
243205755b9cSHong Zhang   ts->costintegrandctx  = ctx;
24336fd0887fSHong Zhang 
24346fd0887fSHong Zhang   PetscFunctionReturn(0);
24356fd0887fSHong Zhang }
24366fd0887fSHong Zhang 
24376fd0887fSHong Zhang #undef __FUNCT__
2438d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointGetCostQuadrature"
243936eaed60SHong Zhang /*@
2440d4aa0a58SBarry Smith    TSAdjointGetCostQuadrature - Returns the values of the quadrature (or integral) terms in a cost function.
244136eaed60SHong Zhang    It is valid to call the routine after a backward run.
244236eaed60SHong Zhang 
244336eaed60SHong Zhang    Not Collective
244436eaed60SHong Zhang 
244536eaed60SHong Zhang    Input Parameter:
244636eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
244736eaed60SHong Zhang 
244836eaed60SHong Zhang    Output Parameter:
244936eaed60SHong Zhang .  v - the vector containing the solution
245036eaed60SHong Zhang 
245136eaed60SHong Zhang    Level: intermediate
245236eaed60SHong Zhang 
2453d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand()
245436eaed60SHong Zhang 
245536eaed60SHong Zhang .keywords: TS, sensitivity analysis
245636eaed60SHong Zhang @*/
2457d4aa0a58SBarry Smith PetscErrorCode  TSAdjointGetCostQuadrature(TS ts,Vec *v)
245836eaed60SHong Zhang {
245936eaed60SHong Zhang   PetscFunctionBegin;
246036eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
246136eaed60SHong Zhang   PetscValidPointer(v,2);
246236eaed60SHong Zhang   *v = ts->vec_costquad;
246336eaed60SHong Zhang   PetscFunctionReturn(0);
246436eaed60SHong Zhang }
246536eaed60SHong Zhang 
246636eaed60SHong Zhang #undef __FUNCT__
2467d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
24686fd0887fSHong Zhang /*@
2469d4aa0a58SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the quadrature function in the cost functions.
24706fd0887fSHong Zhang 
24716fd0887fSHong Zhang    Input Parameters:
24726fd0887fSHong Zhang +  ts - the TS context
24736fd0887fSHong Zhang .  t - current time
247405755b9cSHong Zhang -  U - state vector
24756fd0887fSHong Zhang 
24766fd0887fSHong Zhang    Output Parameter:
24776fd0887fSHong Zhang .  q - vector of size numberadjs to hold the outputs
24786fd0887fSHong Zhang 
24796fd0887fSHong Zhang    Note:
24806fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
24816fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
24826fd0887fSHong Zhang 
24836fd0887fSHong Zhang    Level: developer
24846fd0887fSHong Zhang 
24856fd0887fSHong Zhang .keywords: TS, compute
24866fd0887fSHong Zhang 
2487d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand()
24886fd0887fSHong Zhang @*/
2489d4aa0a58SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec U,Vec q)
24906fd0887fSHong Zhang {
24916fd0887fSHong Zhang   PetscErrorCode ierr;
24926fd0887fSHong Zhang 
24936fd0887fSHong Zhang   PetscFunctionBegin;
24946fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24956fd0887fSHong Zhang   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
24966fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
24976fd0887fSHong Zhang 
24986fd0887fSHong Zhang   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,q,0);CHKERRQ(ierr);
2499e4680132SHong Zhang   if (ts->costintegrand) {
2500e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
250105755b9cSHong Zhang     ierr = (*ts->costintegrand)(ts,t,U,q,ts->costintegrandctx);CHKERRQ(ierr);
25026fd0887fSHong Zhang     PetscStackPop;
25036fd0887fSHong Zhang   } else {
25046fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25056fd0887fSHong Zhang   }
25066fd0887fSHong Zhang 
25076fd0887fSHong Zhang   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,q,0);CHKERRQ(ierr);
25086fd0887fSHong Zhang   PetscFunctionReturn(0);
25096fd0887fSHong Zhang }
25106fd0887fSHong Zhang 
25116fd0887fSHong Zhang #undef __FUNCT__
2512d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetDRDYFunction"
251305755b9cSHong Zhang /*@C
2514d4aa0a58SBarry Smith   TSAdjointSetDRDYFunction - Sets the function that computes the gradient of the CostIntegrand function r w.r.t. states y.
251505755b9cSHong Zhang 
251605755b9cSHong Zhang   Logically Collective on TS
251705755b9cSHong Zhang 
251805755b9cSHong Zhang   Input Parameters:
251905755b9cSHong Zhang + ts   - The TS context obtained from TSCreate()
252005755b9cSHong Zhang - func - The function
252105755b9cSHong Zhang 
252205755b9cSHong Zhang   Calling sequence of func:
252307658559SBarry Smith . PetscErroCode func(TS ts,PetscReal t,Vec U,Vec *drdy,void *ctx);
252405755b9cSHong Zhang 
252505755b9cSHong Zhang   Level: intermediate
252605755b9cSHong Zhang 
252705755b9cSHong Zhang .keywords: TS, sensitivity
252805755b9cSHong Zhang .seealso:
252905755b9cSHong Zhang @*/
2530d4aa0a58SBarry Smith PetscErrorCode  TSAdjointSetDRDYFunction(TS ts,Vec *drdy,PetscErrorCode (*func)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
253105755b9cSHong Zhang {
253205755b9cSHong Zhang   PetscFunctionBegin;
253305755b9cSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
253405755b9cSHong Zhang 
253505755b9cSHong Zhang   ts->drdyfunction    = func;
253605755b9cSHong Zhang   ts->drdyfunctionctx = ctx;
253705755b9cSHong Zhang   ts->vecs_drdy       = drdy;
253805755b9cSHong Zhang   PetscFunctionReturn(0);
253905755b9cSHong Zhang }
254005755b9cSHong Zhang 
254105755b9cSHong Zhang #undef __FUNCT__
2542d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
254305755b9cSHong Zhang /*@
2544d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
254505755b9cSHong Zhang 
254605755b9cSHong Zhang   Collective on TS
254705755b9cSHong Zhang 
254805755b9cSHong Zhang   Input Parameters:
254905755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
255005755b9cSHong Zhang 
255105755b9cSHong Zhang   Notes:
2552d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
255305755b9cSHong Zhang   so most users would not generally call this routine themselves.
255405755b9cSHong Zhang 
255505755b9cSHong Zhang   Level: developer
255605755b9cSHong Zhang 
255705755b9cSHong Zhang .keywords: TS, sensitivity
2558d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
255905755b9cSHong Zhang @*/
2560d4aa0a58SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec X,Vec *drdy)
256105755b9cSHong Zhang {
256205755b9cSHong Zhang   PetscErrorCode ierr;
256305755b9cSHong Zhang 
256405755b9cSHong Zhang   PetscFunctionBegin;
256505755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
256605755b9cSHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
256705755b9cSHong Zhang 
256805755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
256905755b9cSHong Zhang   ierr = (*ts->drdyfunction)(ts,t,X,drdy,ts->drdyfunctionctx); CHKERRQ(ierr);
257005755b9cSHong Zhang   PetscStackPop;
257105755b9cSHong Zhang   PetscFunctionReturn(0);
257205755b9cSHong Zhang }
257305755b9cSHong Zhang 
257405755b9cSHong Zhang #undef __FUNCT__
2575d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetDRDPFunction"
257605755b9cSHong Zhang /*@C
2577d4aa0a58SBarry Smith   TSAdjointSetDRDPFunction - Sets the function that computes the gradient of the CostIntegrand function w.r.t. parameters.
257805755b9cSHong Zhang 
257905755b9cSHong Zhang   Logically Collective on TS
258005755b9cSHong Zhang 
258105755b9cSHong Zhang   Input Parameters:
258205755b9cSHong Zhang + ts   - The TS context obtained from TSCreate()
258305755b9cSHong Zhang - func - The function
258405755b9cSHong Zhang 
258505755b9cSHong Zhang   Calling sequence of func:
258607658559SBarry Smith . func(TS ts,PetscReal t,Vec U,Vec *drdy,void *ctx);
258705755b9cSHong Zhang 
258805755b9cSHong Zhang   Level: intermediate
258905755b9cSHong Zhang 
259005755b9cSHong Zhang .keywords: TS, sensitivity
259105755b9cSHong Zhang .seealso:
259205755b9cSHong Zhang @*/
2593d4aa0a58SBarry Smith PetscErrorCode  TSAdjointSetDRDPFunction(TS ts,Vec *drdp,PetscErrorCode (*func)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
259405755b9cSHong Zhang {
259505755b9cSHong Zhang   PetscFunctionBegin;
259605755b9cSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
259705755b9cSHong Zhang 
259805755b9cSHong Zhang   ts->drdpfunction    = func;
259905755b9cSHong Zhang   ts->drdpfunctionctx = ctx;
260005755b9cSHong Zhang   ts->vecs_drdp       = drdp;
260105755b9cSHong Zhang 
260205755b9cSHong Zhang   PetscFunctionReturn(0);
260305755b9cSHong Zhang }
260405755b9cSHong Zhang 
260505755b9cSHong Zhang #undef __FUNCT__
2606d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
260705755b9cSHong Zhang /*@
2608d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
260905755b9cSHong Zhang 
261005755b9cSHong Zhang   Collective on TS
261105755b9cSHong Zhang 
261205755b9cSHong Zhang   Input Parameters:
261305755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
261405755b9cSHong Zhang 
261505755b9cSHong Zhang   Notes:
261605755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
261705755b9cSHong Zhang   so most users would not generally call this routine themselves.
261805755b9cSHong Zhang 
261905755b9cSHong Zhang   Level: developer
262005755b9cSHong Zhang 
262105755b9cSHong Zhang .keywords: TS, sensitivity
2622d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
262305755b9cSHong Zhang @*/
2624d4aa0a58SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec X,Vec *drdp)
262505755b9cSHong Zhang {
262605755b9cSHong Zhang   PetscErrorCode ierr;
262705755b9cSHong Zhang 
262805755b9cSHong Zhang   PetscFunctionBegin;
262905755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
263005755b9cSHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
263105755b9cSHong Zhang 
263205755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
263305755b9cSHong Zhang   ierr = (*ts->drdpfunction)(ts,t,X,drdp,ts->drdpfunctionctx); CHKERRQ(ierr);
263405755b9cSHong Zhang   PetscStackPop;
263505755b9cSHong Zhang 
263605755b9cSHong Zhang   PetscFunctionReturn(0);
263705755b9cSHong Zhang }
263805755b9cSHong Zhang 
263905755b9cSHong Zhang #undef __FUNCT__
2640e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2641ac226902SBarry Smith /*@C
2642000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26433f2090d5SJed Brown   called once at the beginning of each time step.
2644000e7ae3SMatthew Knepley 
26453f9fe445SBarry Smith   Logically Collective on TS
2646000e7ae3SMatthew Knepley 
2647000e7ae3SMatthew Knepley   Input Parameters:
2648000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2649000e7ae3SMatthew Knepley - func - The function
2650000e7ae3SMatthew Knepley 
2651000e7ae3SMatthew Knepley   Calling sequence of func:
2652000e7ae3SMatthew Knepley . func (TS ts);
2653000e7ae3SMatthew Knepley 
2654000e7ae3SMatthew Knepley   Level: intermediate
2655000e7ae3SMatthew Knepley 
2656b8123daeSJed Brown   Note:
2657b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2658b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2659b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2660b8123daeSJed Brown 
2661000e7ae3SMatthew Knepley .keywords: TS, timestep
26629be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2663000e7ae3SMatthew Knepley @*/
26647087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2665000e7ae3SMatthew Knepley {
2666000e7ae3SMatthew Knepley   PetscFunctionBegin;
26670700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2668ae60f76fSBarry Smith   ts->prestep = func;
2669000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2670000e7ae3SMatthew Knepley }
2671000e7ae3SMatthew Knepley 
2672e74ef692SMatthew Knepley #undef __FUNCT__
26733f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
267409ee8438SJed Brown /*@
26753f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26763f2090d5SJed Brown 
26773f2090d5SJed Brown   Collective on TS
26783f2090d5SJed Brown 
26793f2090d5SJed Brown   Input Parameters:
26803f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26813f2090d5SJed Brown 
26823f2090d5SJed Brown   Notes:
26833f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
26843f2090d5SJed Brown   so most users would not generally call this routine themselves.
26853f2090d5SJed Brown 
26863f2090d5SJed Brown   Level: developer
26873f2090d5SJed Brown 
26883f2090d5SJed Brown .keywords: TS, timestep
26899be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
26903f2090d5SJed Brown @*/
26917087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
26923f2090d5SJed Brown {
26933f2090d5SJed Brown   PetscErrorCode ierr;
26943f2090d5SJed Brown 
26953f2090d5SJed Brown   PetscFunctionBegin;
26960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2697ae60f76fSBarry Smith   if (ts->prestep) {
2698ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2699312ce896SJed Brown   }
27003f2090d5SJed Brown   PetscFunctionReturn(0);
27013f2090d5SJed Brown }
27023f2090d5SJed Brown 
27033f2090d5SJed Brown #undef __FUNCT__
2704b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2705b8123daeSJed Brown /*@C
2706b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2707b8123daeSJed Brown   called once at the beginning of each stage.
2708b8123daeSJed Brown 
2709b8123daeSJed Brown   Logically Collective on TS
2710b8123daeSJed Brown 
2711b8123daeSJed Brown   Input Parameters:
2712b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2713b8123daeSJed Brown - func - The function
2714b8123daeSJed Brown 
2715b8123daeSJed Brown   Calling sequence of func:
2716b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2717b8123daeSJed Brown 
2718b8123daeSJed Brown   Level: intermediate
2719b8123daeSJed Brown 
2720b8123daeSJed Brown   Note:
2721b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2722b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2723b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2724b8123daeSJed Brown 
2725b8123daeSJed Brown .keywords: TS, timestep
27269be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2727b8123daeSJed Brown @*/
2728b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2729b8123daeSJed Brown {
2730b8123daeSJed Brown   PetscFunctionBegin;
2731b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2732ae60f76fSBarry Smith   ts->prestage = func;
2733b8123daeSJed Brown   PetscFunctionReturn(0);
2734b8123daeSJed Brown }
2735b8123daeSJed Brown 
2736b8123daeSJed Brown #undef __FUNCT__
27379be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27389be3e283SDebojyoti Ghosh /*@C
27399be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27409be3e283SDebojyoti Ghosh   called once at the end of each stage.
27419be3e283SDebojyoti Ghosh 
27429be3e283SDebojyoti Ghosh   Logically Collective on TS
27439be3e283SDebojyoti Ghosh 
27449be3e283SDebojyoti Ghosh   Input Parameters:
27459be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27469be3e283SDebojyoti Ghosh - func - The function
27479be3e283SDebojyoti Ghosh 
27489be3e283SDebojyoti Ghosh   Calling sequence of func:
27499be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27509be3e283SDebojyoti Ghosh 
27519be3e283SDebojyoti Ghosh   Level: intermediate
27529be3e283SDebojyoti Ghosh 
27539be3e283SDebojyoti Ghosh   Note:
27549be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27559be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27569be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27579be3e283SDebojyoti Ghosh 
27589be3e283SDebojyoti Ghosh .keywords: TS, timestep
27599be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27609be3e283SDebojyoti Ghosh @*/
27619be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27629be3e283SDebojyoti Ghosh {
27639be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27649be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27659be3e283SDebojyoti Ghosh   ts->poststage = func;
27669be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27679be3e283SDebojyoti Ghosh }
27689be3e283SDebojyoti Ghosh 
27699be3e283SDebojyoti Ghosh #undef __FUNCT__
2770b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2771b8123daeSJed Brown /*@
2772b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2773b8123daeSJed Brown 
2774b8123daeSJed Brown   Collective on TS
2775b8123daeSJed Brown 
2776b8123daeSJed Brown   Input Parameters:
2777b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27789be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2779b8123daeSJed Brown 
2780b8123daeSJed Brown   Notes:
2781b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2782b8123daeSJed Brown   most users would not generally call this routine themselves.
2783b8123daeSJed Brown 
2784b8123daeSJed Brown   Level: developer
2785b8123daeSJed Brown 
2786b8123daeSJed Brown .keywords: TS, timestep
27879be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2788b8123daeSJed Brown @*/
2789b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2790b8123daeSJed Brown {
2791b8123daeSJed Brown   PetscErrorCode ierr;
2792b8123daeSJed Brown 
2793b8123daeSJed Brown   PetscFunctionBegin;
2794b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2795ae60f76fSBarry Smith   if (ts->prestage) {
2796ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2797b8123daeSJed Brown   }
2798b8123daeSJed Brown   PetscFunctionReturn(0);
2799b8123daeSJed Brown }
2800b8123daeSJed Brown 
2801b8123daeSJed Brown #undef __FUNCT__
28029be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
28039be3e283SDebojyoti Ghosh /*@
28049be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
28059be3e283SDebojyoti Ghosh 
28069be3e283SDebojyoti Ghosh   Collective on TS
28079be3e283SDebojyoti Ghosh 
28089be3e283SDebojyoti Ghosh   Input Parameters:
28099be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
28109be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
28119be3e283SDebojyoti Ghosh   stageindex  - Stage number
28129be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
28139be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
28149be3e283SDebojyoti Ghosh 
28159be3e283SDebojyoti Ghosh   Notes:
28169be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
28179be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
28189be3e283SDebojyoti Ghosh 
28199be3e283SDebojyoti Ghosh   Level: developer
28209be3e283SDebojyoti Ghosh 
28219be3e283SDebojyoti Ghosh .keywords: TS, timestep
28229be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
28239be3e283SDebojyoti Ghosh @*/
28249be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
28259be3e283SDebojyoti Ghosh {
28269be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
28279be3e283SDebojyoti Ghosh 
28289be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28299be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28304beae5d8SLisandro Dalcin   if (ts->poststage) {
28319be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
28329be3e283SDebojyoti Ghosh   }
28339be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28349be3e283SDebojyoti Ghosh }
28359be3e283SDebojyoti Ghosh 
28369be3e283SDebojyoti Ghosh #undef __FUNCT__
2837e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2838ac226902SBarry Smith /*@C
2839000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28403f2090d5SJed Brown   called once at the end of each time step.
2841000e7ae3SMatthew Knepley 
28423f9fe445SBarry Smith   Logically Collective on TS
2843000e7ae3SMatthew Knepley 
2844000e7ae3SMatthew Knepley   Input Parameters:
2845000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2846000e7ae3SMatthew Knepley - func - The function
2847000e7ae3SMatthew Knepley 
2848000e7ae3SMatthew Knepley   Calling sequence of func:
2849b8123daeSJed Brown $ func (TS ts);
2850000e7ae3SMatthew Knepley 
2851000e7ae3SMatthew Knepley   Level: intermediate
2852000e7ae3SMatthew Knepley 
2853000e7ae3SMatthew Knepley .keywords: TS, timestep
2854b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2855000e7ae3SMatthew Knepley @*/
28567087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2857000e7ae3SMatthew Knepley {
2858000e7ae3SMatthew Knepley   PetscFunctionBegin;
28590700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2860ae60f76fSBarry Smith   ts->poststep = func;
2861000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2862000e7ae3SMatthew Knepley }
2863000e7ae3SMatthew Knepley 
2864e74ef692SMatthew Knepley #undef __FUNCT__
28653f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
286609ee8438SJed Brown /*@
28673f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28683f2090d5SJed Brown 
28693f2090d5SJed Brown   Collective on TS
28703f2090d5SJed Brown 
28713f2090d5SJed Brown   Input Parameters:
28723f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28733f2090d5SJed Brown 
28743f2090d5SJed Brown   Notes:
28753f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28763f2090d5SJed Brown   so most users would not generally call this routine themselves.
28773f2090d5SJed Brown 
28783f2090d5SJed Brown   Level: developer
28793f2090d5SJed Brown 
28803f2090d5SJed Brown .keywords: TS, timestep
28813f2090d5SJed Brown @*/
28827087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28833f2090d5SJed Brown {
28843f2090d5SJed Brown   PetscErrorCode ierr;
28853f2090d5SJed Brown 
28863f2090d5SJed Brown   PetscFunctionBegin;
28870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2888ae60f76fSBarry Smith   if (ts->poststep) {
2889ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
289072ac3e02SJed Brown   }
28913f2090d5SJed Brown   PetscFunctionReturn(0);
28923f2090d5SJed Brown }
28933f2090d5SJed Brown 
2894d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2895d763cef2SBarry Smith 
28964a2ae208SSatish Balay #undef __FUNCT__
2897a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2898d763cef2SBarry Smith /*@C
2899a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2900d763cef2SBarry Smith    timestep to display the iteration's  progress.
2901d763cef2SBarry Smith 
29023f9fe445SBarry Smith    Logically Collective on TS
2903d763cef2SBarry Smith 
2904d763cef2SBarry Smith    Input Parameters:
2905d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2906e213d8f1SJed Brown .  monitor - monitoring routine
2907329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
29080298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2909b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
29100298fd71SBarry Smith           (may be NULL)
2911d763cef2SBarry Smith 
2912e213d8f1SJed Brown    Calling sequence of monitor:
29130910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2914d763cef2SBarry Smith 
2915d763cef2SBarry Smith +    ts - the TS context
291688c05cc5SBarry 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
291788c05cc5SBarry Smith                                been interpolated to)
29181f06c33eSBarry Smith .    time - current time
29190910c330SBarry Smith .    u - current iterate
2920d763cef2SBarry Smith -    mctx - [optional] monitoring context
2921d763cef2SBarry Smith 
2922d763cef2SBarry Smith    Notes:
2923d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2924d763cef2SBarry Smith    already has been loaded.
2925d763cef2SBarry Smith 
2926025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2927025f1a04SBarry Smith 
2928d763cef2SBarry Smith    Level: intermediate
2929d763cef2SBarry Smith 
2930d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2931d763cef2SBarry Smith 
2932a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2933d763cef2SBarry Smith @*/
2934c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2935d763cef2SBarry Smith {
2936d763cef2SBarry Smith   PetscFunctionBegin;
29370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
293817186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2939d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29408704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2941d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2942d763cef2SBarry Smith   PetscFunctionReturn(0);
2943d763cef2SBarry Smith }
2944d763cef2SBarry Smith 
29454a2ae208SSatish Balay #undef __FUNCT__
2946a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2947d763cef2SBarry Smith /*@C
2948a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2949d763cef2SBarry Smith 
29503f9fe445SBarry Smith    Logically Collective on TS
2951d763cef2SBarry Smith 
2952d763cef2SBarry Smith    Input Parameters:
2953d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2954d763cef2SBarry Smith 
2955d763cef2SBarry Smith    Notes:
2956d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2957d763cef2SBarry Smith 
2958d763cef2SBarry Smith    Level: intermediate
2959d763cef2SBarry Smith 
2960d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2961d763cef2SBarry Smith 
2962a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2963d763cef2SBarry Smith @*/
29647087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2965d763cef2SBarry Smith {
2966d952e501SBarry Smith   PetscErrorCode ierr;
2967d952e501SBarry Smith   PetscInt       i;
2968d952e501SBarry Smith 
2969d763cef2SBarry Smith   PetscFunctionBegin;
29700700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2971d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29728704b422SBarry Smith     if (ts->monitordestroy[i]) {
29738704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2974d952e501SBarry Smith     }
2975d952e501SBarry Smith   }
2976d763cef2SBarry Smith   ts->numbermonitors = 0;
2977d763cef2SBarry Smith   PetscFunctionReturn(0);
2978d763cef2SBarry Smith }
2979d763cef2SBarry Smith 
29804a2ae208SSatish Balay #undef __FUNCT__
2981a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2982d8e5e3e6SSatish Balay /*@
2983a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
29845516499fSSatish Balay 
29855516499fSSatish Balay    Level: intermediate
298641251cbbSSatish Balay 
29875516499fSSatish Balay .keywords: TS, set, monitor
29885516499fSSatish Balay 
298941251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
299041251cbbSSatish Balay @*/
2991649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2992d763cef2SBarry Smith {
2993dfbe8321SBarry Smith   PetscErrorCode ierr;
2994ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2995d132466eSBarry Smith 
2996d763cef2SBarry Smith   PetscFunctionBegin;
2997649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2998971832b6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr);
2999649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3000d763cef2SBarry Smith   PetscFunctionReturn(0);
3001d763cef2SBarry Smith }
3002d763cef2SBarry Smith 
30034a2ae208SSatish Balay #undef __FUNCT__
3004cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
3005cd652676SJed Brown /*@
3006cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
3007cd652676SJed Brown 
3008cd652676SJed Brown    Logically Collective on TS
3009cd652676SJed Brown 
3010cd652676SJed Brown    Input Argument:
3011cd652676SJed Brown .  ts - time stepping context
3012cd652676SJed Brown 
3013cd652676SJed Brown    Output Argument:
3014cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
3015cd652676SJed Brown 
3016cd652676SJed Brown    Level: intermediate
3017cd652676SJed Brown 
3018cd652676SJed Brown .keywords: TS, set
3019cd652676SJed Brown 
3020cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3021cd652676SJed Brown @*/
3022cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3023cd652676SJed Brown {
3024cd652676SJed Brown   PetscFunctionBegin;
3025cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3026cd652676SJed Brown   ts->retain_stages = flg;
3027cd652676SJed Brown   PetscFunctionReturn(0);
3028cd652676SJed Brown }
3029cd652676SJed Brown 
3030cd652676SJed Brown #undef __FUNCT__
3031cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3032cd652676SJed Brown /*@
3033cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3034cd652676SJed Brown 
3035cd652676SJed Brown    Collective on TS
3036cd652676SJed Brown 
3037cd652676SJed Brown    Input Argument:
3038cd652676SJed Brown +  ts - time stepping context
3039cd652676SJed Brown -  t - time to interpolate to
3040cd652676SJed Brown 
3041cd652676SJed Brown    Output Argument:
30420910c330SBarry Smith .  U - state at given time
3043cd652676SJed Brown 
3044cd652676SJed Brown    Notes:
3045cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3046cd652676SJed Brown 
3047cd652676SJed Brown    Level: intermediate
3048cd652676SJed Brown 
3049cd652676SJed Brown    Developer Notes:
3050cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3051cd652676SJed Brown 
3052cd652676SJed Brown .keywords: TS, set
3053cd652676SJed Brown 
3054cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3055cd652676SJed Brown @*/
30560910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3057cd652676SJed Brown {
3058cd652676SJed Brown   PetscErrorCode ierr;
3059cd652676SJed Brown 
3060cd652676SJed Brown   PetscFunctionBegin;
3061cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3062b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
30636712e2f1SBarry 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);
3064ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
30650910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3066cd652676SJed Brown   PetscFunctionReturn(0);
3067cd652676SJed Brown }
3068cd652676SJed Brown 
3069cd652676SJed Brown #undef __FUNCT__
30704a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3071d763cef2SBarry Smith /*@
30726d9e5789SSean Farley    TSStep - Steps one time step
3073d763cef2SBarry Smith 
3074d763cef2SBarry Smith    Collective on TS
3075d763cef2SBarry Smith 
3076d763cef2SBarry Smith    Input Parameter:
3077d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3078d763cef2SBarry Smith 
30796d9e5789SSean Farley    Level: intermediate
3080d763cef2SBarry Smith 
3081b8123daeSJed Brown    Notes:
3082b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3083b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3084b8123daeSJed Brown 
308525cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
308625cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
308725cb2221SBarry Smith 
3088d763cef2SBarry Smith .keywords: TS, timestep, solve
3089d763cef2SBarry Smith 
30909be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3091d763cef2SBarry Smith @*/
3092193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3093d763cef2SBarry Smith {
30942fb8446cSMatthew G. Knepley   DM               dm;
3095dfbe8321SBarry Smith   PetscErrorCode   ierr;
3096fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3097d763cef2SBarry Smith 
3098d763cef2SBarry Smith   PetscFunctionBegin;
30990700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3100fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3101fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3102fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3103fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3104fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3105fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3106fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
3107fffbeea8SBarry Smith 
31082fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3109d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3110d405a339SMatthew Knepley 
3111362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
311224655328SShri   ts->ptime_prev = ts->ptime;
3113cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
31144e9ba7eeSMatthew G. Knepley   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3115bbd56ea5SKarl Rupp 
3116e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3117d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3118193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3119*08c7845fSBarry Smith   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3120*08c7845fSBarry Smith 
3121*08c7845fSBarry Smith   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3122*08c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3123*08c7845fSBarry Smith 
3124*08c7845fSBarry Smith   if (ts->reason < 0) {
3125*08c7845fSBarry Smith     if (ts->errorifstepfailed) {
3126*08c7845fSBarry Smith       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
3127*08c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3128d2daff3dSHong Zhang     }
3129*08c7845fSBarry Smith   } else if (!ts->reason) {
3130*08c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3131*08c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3132*08c7845fSBarry Smith   }
3133*08c7845fSBarry Smith   PetscFunctionReturn(0);
3134*08c7845fSBarry Smith }
3135*08c7845fSBarry Smith 
3136*08c7845fSBarry Smith #undef __FUNCT__
3137*08c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
3138*08c7845fSBarry Smith /*@
3139*08c7845fSBarry Smith    TSAdjointStep - Steps one time step
3140*08c7845fSBarry Smith 
3141*08c7845fSBarry Smith    Collective on TS
3142*08c7845fSBarry Smith 
3143*08c7845fSBarry Smith    Input Parameter:
3144*08c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
3145*08c7845fSBarry Smith 
3146*08c7845fSBarry Smith    Level: intermediate
3147*08c7845fSBarry Smith 
3148*08c7845fSBarry Smith    Notes:
3149*08c7845fSBarry Smith    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3150*08c7845fSBarry Smith    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3151*08c7845fSBarry Smith 
3152*08c7845fSBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
3153*08c7845fSBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
3154*08c7845fSBarry Smith 
3155*08c7845fSBarry Smith .keywords: TS, timestep, solve
3156*08c7845fSBarry Smith 
3157*08c7845fSBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3158*08c7845fSBarry Smith @*/
3159*08c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
3160*08c7845fSBarry Smith {
3161*08c7845fSBarry Smith   DM               dm;
3162*08c7845fSBarry Smith   PetscErrorCode   ierr;
3163*08c7845fSBarry Smith 
3164*08c7845fSBarry Smith   PetscFunctionBegin;
3165*08c7845fSBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3166*08c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3167*08c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3168*08c7845fSBarry Smith 
3169*08c7845fSBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
3170*08c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
3171*08c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3172*08c7845fSBarry Smith   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3173*08c7845fSBarry Smith 
3174*08c7845fSBarry Smith   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3175*08c7845fSBarry Smith   if (!ts->ops->stepadj) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed because the adjoint of  %s has not been implemented, try other time stepping methods for adjoint sensitivity analysis",((PetscObject)ts)->type_name);
3176*08c7845fSBarry Smith   ierr = (*ts->ops->stepadj)(ts);CHKERRQ(ierr);
3177d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3178bbd56ea5SKarl Rupp 
317924655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3180cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3181362cd11cSLisandro Dalcin 
3182362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3183cef5090cSJed Brown     if (ts->errorifstepfailed) {
3184cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3185ce94432eSBarry 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]);
31862a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
31872a3a10ceSLisandro 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]);
3188ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3189cef5090cSJed Brown     }
3190362cd11cSLisandro Dalcin   } else if (!ts->reason) {
3191db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3192db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3193362cd11cSLisandro Dalcin   }
3194d763cef2SBarry Smith   PetscFunctionReturn(0);
3195d763cef2SBarry Smith }
3196d763cef2SBarry Smith 
31974a2ae208SSatish Balay #undef __FUNCT__
319805175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
319905175c85SJed Brown /*@
320005175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
320105175c85SJed Brown 
32021c3436cfSJed Brown    Collective on TS
320305175c85SJed Brown 
320405175c85SJed Brown    Input Arguments:
32051c3436cfSJed Brown +  ts - time stepping context
32061c3436cfSJed Brown .  order - desired order of accuracy
32070298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
320805175c85SJed Brown 
320905175c85SJed Brown    Output Arguments:
32100910c330SBarry Smith .  U - state at the end of the current step
321105175c85SJed Brown 
321205175c85SJed Brown    Level: advanced
321305175c85SJed Brown 
3214108c343cSJed Brown    Notes:
3215108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3216108c343cSJed 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.
3217108c343cSJed Brown 
32181c3436cfSJed Brown .seealso: TSStep(), TSAdapt
321905175c85SJed Brown @*/
32200910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
322105175c85SJed Brown {
322205175c85SJed Brown   PetscErrorCode ierr;
322305175c85SJed Brown 
322405175c85SJed Brown   PetscFunctionBegin;
322505175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
322605175c85SJed Brown   PetscValidType(ts,1);
32270910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3228ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
32290910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
323005175c85SJed Brown   PetscFunctionReturn(0);
323105175c85SJed Brown }
323205175c85SJed Brown 
323305175c85SJed Brown #undef __FUNCT__
32346a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
32356a4d4014SLisandro Dalcin /*@
32366a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
32376a4d4014SLisandro Dalcin 
32386a4d4014SLisandro Dalcin    Collective on TS
32396a4d4014SLisandro Dalcin 
32406a4d4014SLisandro Dalcin    Input Parameter:
32416a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3242cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
32435a3a76d0SJed Brown 
32446a4d4014SLisandro Dalcin    Level: beginner
32456a4d4014SLisandro Dalcin 
32465a3a76d0SJed Brown    Notes:
32475a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
32485a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
32495a3a76d0SJed Brown    stepped over the final time.
32505a3a76d0SJed Brown 
32516a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
32526a4d4014SLisandro Dalcin 
32536a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
32546a4d4014SLisandro Dalcin @*/
3255cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
32566a4d4014SLisandro Dalcin {
3257b06615a5SLisandro Dalcin   Vec               solution;
32586a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
3259f22f69f0SBarry Smith 
32606a4d4014SLisandro Dalcin   PetscFunctionBegin;
32610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3262f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3263c88f2d44SBarry Smith   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 */
3264b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
32650910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3266b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3267b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3268b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
32695a3a76d0SJed Brown     }
32700910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3271bbd56ea5SKarl Rupp   } else if (u) {
32720910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
32735a3a76d0SJed Brown   }
3274d2daff3dSHong Zhang   ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/
32756a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
3276193ac0bcSJed Brown   ts->steps             = 0;
32775ef26d82SJed Brown   ts->ksp_its           = 0;
32785ef26d82SJed Brown   ts->snes_its          = 0;
3279c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3280c610991cSLisandro Dalcin   ts->reject            = 0;
3281193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3282193ac0bcSJed Brown 
3283ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3284f05ece33SBarry Smith 
3285193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3286193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
32870910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3288cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3289193ac0bcSJed Brown   } else {
32906a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
3291db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3292c88f2d44SBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3293e1a7a14fSJed Brown     while (!ts->reason) {
3294b06615a5SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3295193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3296aeb4809dSShri Abhyankar       if (ts->event) {
3297aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
32981eda64f1SShri Abhyankar 	if (ts->event->status != TSEVENT_PROCESSING) {
32991eda64f1SShri Abhyankar 	  ierr = TSPostStep(ts);CHKERRQ(ierr);
33001eda64f1SShri Abhyankar 	}
33011eda64f1SShri Abhyankar       } else {
33021eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3303aeb4809dSShri Abhyankar       }
3304193ac0bcSJed Brown     }
3305c88f2d44SBarry Smith     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
33060910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3307cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3308b06615a5SLisandro Dalcin       solution = u;
33090574a7fbSJed Brown     } else {
3310ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3311cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3312b06615a5SLisandro Dalcin       solution = ts->vec_sol;
33130574a7fbSJed Brown     }
3314b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
33154e9ba7eeSMatthew G. Knepley     ierr = VecViewFromOptions(u, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3316193ac0bcSJed Brown   }
3317d2daff3dSHong Zhang 
3318ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
331956f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
33206a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
33216a4d4014SLisandro Dalcin }
33226a4d4014SLisandro Dalcin 
33236a4d4014SLisandro Dalcin #undef __FUNCT__
3324c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3325c88f2d44SBarry Smith /*@
3326c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3327c88f2d44SBarry Smith 
3328c88f2d44SBarry Smith    Collective on TS
3329c88f2d44SBarry Smith 
3330c88f2d44SBarry Smith    Input Parameter:
3331c88f2d44SBarry Smith +  ts - the TS context obtained from TSCreate()
3332c88f2d44SBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
3333c88f2d44SBarry Smith 
3334c88f2d44SBarry Smith    Level: intermediate
3335c88f2d44SBarry Smith 
3336c88f2d44SBarry Smith    Notes:
3337c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3338c88f2d44SBarry Smith 
3339c88f2d44SBarry Smith .keywords: TS, timestep, solve
3340c88f2d44SBarry Smith 
3341c88f2d44SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3342c88f2d44SBarry Smith @*/
3343c88f2d44SBarry Smith PetscErrorCode TSAdjointSolve(TS ts,Vec u)
3344c88f2d44SBarry Smith {
3345c88f2d44SBarry Smith   Vec               solution;
3346c88f2d44SBarry Smith   PetscErrorCode    ierr;
3347c88f2d44SBarry Smith 
3348c88f2d44SBarry Smith   PetscFunctionBegin;
3349c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3350c88f2d44SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3351c88f2d44SBarry Smith   if (u) {
3352c88f2d44SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
3353c88f2d44SBarry Smith   }
3354c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3355c88f2d44SBarry Smith   /* reset time step and iteration counters */
3356c88f2d44SBarry Smith   ts->steps             = 0;
3357c88f2d44SBarry Smith   ts->ksp_its           = 0;
3358c88f2d44SBarry Smith   ts->snes_its          = 0;
3359c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3360c88f2d44SBarry Smith   ts->reject            = 0;
3361c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3362c88f2d44SBarry Smith 
3363c88f2d44SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3364c88f2d44SBarry Smith 
3365c88f2d44SBarry Smith   if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3366c88f2d44SBarry Smith   while (!ts->reason) {
3367c88f2d44SBarry Smith     ierr = TSMonitor(ts,ts->max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3368*08c7845fSBarry Smith     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3369c88f2d44SBarry Smith     if (ts->event) {
3370c88f2d44SBarry Smith       ierr = TSEventMonitor(ts);CHKERRQ(ierr);
3371c88f2d44SBarry Smith       if (ts->event->status != TSEVENT_PROCESSING) {
3372c88f2d44SBarry Smith         ierr = TSPostStep(ts);CHKERRQ(ierr);
3373c88f2d44SBarry Smith       }
3374c88f2d44SBarry Smith     } else {
3375c88f2d44SBarry Smith       ierr = TSPostStep(ts);CHKERRQ(ierr);
3376c88f2d44SBarry Smith     }
3377c88f2d44SBarry Smith   }
3378c88f2d44SBarry Smith   if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3379c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3380c88f2d44SBarry Smith   solution = ts->vec_sol;
3381c88f2d44SBarry Smith   ierr = VecViewFromOptions(u, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3382c88f2d44SBarry Smith 
3383c88f2d44SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
3384c88f2d44SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3385c88f2d44SBarry Smith   PetscFunctionReturn(0);
3386c88f2d44SBarry Smith }
3387c88f2d44SBarry Smith 
3388c88f2d44SBarry Smith #undef __FUNCT__
33894a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
3390228d79bcSJed Brown /*@
3391228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3392228d79bcSJed Brown 
3393228d79bcSJed Brown    Collective on TS
3394228d79bcSJed Brown 
3395228d79bcSJed Brown    Input Parameters:
3396228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3397228d79bcSJed Brown .  step - step number that has just completed
3398228d79bcSJed Brown .  ptime - model time of the state
33990910c330SBarry Smith -  u - state at the current model time
3400228d79bcSJed Brown 
3401228d79bcSJed Brown    Notes:
3402228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
3403228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
3404228d79bcSJed Brown 
3405228d79bcSJed Brown    Level: advanced
3406228d79bcSJed Brown 
3407228d79bcSJed Brown .keywords: TS, timestep
3408228d79bcSJed Brown @*/
34090910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3410d763cef2SBarry Smith {
34116849ba73SBarry Smith   PetscErrorCode ierr;
3412a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3413d763cef2SBarry Smith 
3414d763cef2SBarry Smith   PetscFunctionBegin;
3415b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3416b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
34175edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3418d763cef2SBarry Smith   for (i=0; i<n; i++) {
34190910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3420d763cef2SBarry Smith   }
34215edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3422d763cef2SBarry Smith   PetscFunctionReturn(0);
3423d763cef2SBarry Smith }
3424d763cef2SBarry Smith 
3425d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
34264a2ae208SSatish Balay #undef __FUNCT__
3427a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3428d763cef2SBarry Smith /*@C
3429a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
3430a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3431d763cef2SBarry Smith 
3432d763cef2SBarry Smith    Collective on TS
3433d763cef2SBarry Smith 
3434d763cef2SBarry Smith    Input Parameters:
3435d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3436d763cef2SBarry Smith .  label - the title to put in the title bar
34377c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3438a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3439a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3440d763cef2SBarry Smith 
3441d763cef2SBarry Smith    Output Parameter:
34420b039ecaSBarry Smith .  ctx - the context
3443d763cef2SBarry Smith 
3444d763cef2SBarry Smith    Options Database Key:
34454f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
34464f09c107SBarry Smith .  -ts_monitor_lg_solution -
344799fdda47SBarry Smith .  -ts_monitor_lg_error -
344899fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
344999fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
345099fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
3451d763cef2SBarry Smith 
3452d763cef2SBarry Smith    Notes:
3453a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3454d763cef2SBarry Smith 
3455d763cef2SBarry Smith    Level: intermediate
3456d763cef2SBarry Smith 
34577c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
3458d763cef2SBarry Smith 
34594f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
34607c922b88SBarry Smith 
3461d763cef2SBarry Smith @*/
3462a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3463d763cef2SBarry Smith {
3464b0a32e0cSBarry Smith   PetscDraw      win;
3465dfbe8321SBarry Smith   PetscErrorCode ierr;
3466d763cef2SBarry Smith 
3467d763cef2SBarry Smith   PetscFunctionBegin;
3468b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3469a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
34703fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
34710b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
34723bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3473287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3474287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3475a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3476d763cef2SBarry Smith   PetscFunctionReturn(0);
3477d763cef2SBarry Smith }
3478d763cef2SBarry Smith 
34794a2ae208SSatish Balay #undef __FUNCT__
34804f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3481b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3482d763cef2SBarry Smith {
34830b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3484c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3485dfbe8321SBarry Smith   PetscErrorCode ierr;
3486d763cef2SBarry Smith 
3487d763cef2SBarry Smith   PetscFunctionBegin;
3488b06615a5SLisandro Dalcin   if (!step) {
3489a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3490a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3491a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3492a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3493287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3494a9f9c1f6SBarry Smith   }
3495c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
34960b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3497b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
34980b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
34993923b477SBarry Smith   }
3500d763cef2SBarry Smith   PetscFunctionReturn(0);
3501d763cef2SBarry Smith }
3502d763cef2SBarry Smith 
35034a2ae208SSatish Balay #undef __FUNCT__
3504a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3505d763cef2SBarry Smith /*@C
3506a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3507a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3508d763cef2SBarry Smith 
35090b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3510d763cef2SBarry Smith 
3511d763cef2SBarry Smith    Input Parameter:
35120b039ecaSBarry Smith .  ctx - the monitor context
3513d763cef2SBarry Smith 
3514d763cef2SBarry Smith    Level: intermediate
3515d763cef2SBarry Smith 
3516d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3517d763cef2SBarry Smith 
35184f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3519d763cef2SBarry Smith @*/
3520a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3521d763cef2SBarry Smith {
3522b0a32e0cSBarry Smith   PetscDraw      draw;
3523dfbe8321SBarry Smith   PetscErrorCode ierr;
3524d763cef2SBarry Smith 
3525d763cef2SBarry Smith   PetscFunctionBegin;
35260b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
35276bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
35280b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
35290b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3530d763cef2SBarry Smith   PetscFunctionReturn(0);
3531d763cef2SBarry Smith }
3532d763cef2SBarry Smith 
35334a2ae208SSatish Balay #undef __FUNCT__
35344a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3535d763cef2SBarry Smith /*@
3536b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3537d763cef2SBarry Smith 
3538d763cef2SBarry Smith    Not Collective
3539d763cef2SBarry Smith 
3540d763cef2SBarry Smith    Input Parameter:
3541d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3542d763cef2SBarry Smith 
3543d763cef2SBarry Smith    Output Parameter:
3544d763cef2SBarry Smith .  t  - the current time
3545d763cef2SBarry Smith 
3546d763cef2SBarry Smith    Level: beginner
3547d763cef2SBarry Smith 
3548b8123daeSJed Brown    Note:
3549b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
35509be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3551b8123daeSJed Brown 
3552d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3553d763cef2SBarry Smith 
3554d763cef2SBarry Smith .keywords: TS, get, time
3555d763cef2SBarry Smith @*/
35567087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3557d763cef2SBarry Smith {
3558d763cef2SBarry Smith   PetscFunctionBegin;
35590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3560f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3561d763cef2SBarry Smith   *t = ts->ptime;
3562d763cef2SBarry Smith   PetscFunctionReturn(0);
3563d763cef2SBarry Smith }
3564d763cef2SBarry Smith 
35654a2ae208SSatish Balay #undef __FUNCT__
3566e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3567e5e524a1SHong Zhang /*@
3568e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3569e5e524a1SHong Zhang 
3570e5e524a1SHong Zhang    Not Collective
3571e5e524a1SHong Zhang 
3572e5e524a1SHong Zhang    Input Parameter:
3573e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3574e5e524a1SHong Zhang 
3575e5e524a1SHong Zhang    Output Parameter:
3576e5e524a1SHong Zhang .  t  - the previous time
3577e5e524a1SHong Zhang 
3578e5e524a1SHong Zhang    Level: beginner
3579e5e524a1SHong Zhang 
3580e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3581e5e524a1SHong Zhang 
3582e5e524a1SHong Zhang .keywords: TS, get, time
3583e5e524a1SHong Zhang @*/
3584e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3585e5e524a1SHong Zhang {
3586e5e524a1SHong Zhang   PetscFunctionBegin;
3587e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3588e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3589e5e524a1SHong Zhang   *t = ts->ptime_prev;
3590e5e524a1SHong Zhang   PetscFunctionReturn(0);
3591e5e524a1SHong Zhang }
3592e5e524a1SHong Zhang 
3593e5e524a1SHong Zhang #undef __FUNCT__
35946a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
35956a4d4014SLisandro Dalcin /*@
35966a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
35976a4d4014SLisandro Dalcin 
35983f9fe445SBarry Smith    Logically Collective on TS
35996a4d4014SLisandro Dalcin 
36006a4d4014SLisandro Dalcin    Input Parameters:
36016a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
36026a4d4014SLisandro Dalcin -  time - the time
36036a4d4014SLisandro Dalcin 
36046a4d4014SLisandro Dalcin    Level: intermediate
36056a4d4014SLisandro Dalcin 
36066a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
36076a4d4014SLisandro Dalcin 
36086a4d4014SLisandro Dalcin .keywords: TS, set, time
36096a4d4014SLisandro Dalcin @*/
36107087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
36116a4d4014SLisandro Dalcin {
36126a4d4014SLisandro Dalcin   PetscFunctionBegin;
36130700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3614c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
36156a4d4014SLisandro Dalcin   ts->ptime = t;
36166a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
36176a4d4014SLisandro Dalcin }
36186a4d4014SLisandro Dalcin 
36196a4d4014SLisandro Dalcin #undef __FUNCT__
36204a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3621d763cef2SBarry Smith /*@C
3622d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3623d763cef2SBarry Smith    TS options in the database.
3624d763cef2SBarry Smith 
36253f9fe445SBarry Smith    Logically Collective on TS
3626d763cef2SBarry Smith 
3627d763cef2SBarry Smith    Input Parameter:
3628d763cef2SBarry Smith +  ts     - The TS context
3629d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3630d763cef2SBarry Smith 
3631d763cef2SBarry Smith    Notes:
3632d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3633d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3634d763cef2SBarry Smith    hyphen.
3635d763cef2SBarry Smith 
3636d763cef2SBarry Smith    Level: advanced
3637d763cef2SBarry Smith 
3638d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3639d763cef2SBarry Smith 
3640d763cef2SBarry Smith .seealso: TSSetFromOptions()
3641d763cef2SBarry Smith 
3642d763cef2SBarry Smith @*/
36437087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3644d763cef2SBarry Smith {
3645dfbe8321SBarry Smith   PetscErrorCode ierr;
3646089b2837SJed Brown   SNES           snes;
3647d763cef2SBarry Smith 
3648d763cef2SBarry Smith   PetscFunctionBegin;
36490700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3650d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3651089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3652089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3653d763cef2SBarry Smith   PetscFunctionReturn(0);
3654d763cef2SBarry Smith }
3655d763cef2SBarry Smith 
3656d763cef2SBarry Smith 
36574a2ae208SSatish Balay #undef __FUNCT__
36584a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3659d763cef2SBarry Smith /*@C
3660d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3661d763cef2SBarry Smith    TS options in the database.
3662d763cef2SBarry Smith 
36633f9fe445SBarry Smith    Logically Collective on TS
3664d763cef2SBarry Smith 
3665d763cef2SBarry Smith    Input Parameter:
3666d763cef2SBarry Smith +  ts     - The TS context
3667d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3668d763cef2SBarry Smith 
3669d763cef2SBarry Smith    Notes:
3670d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3671d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3672d763cef2SBarry Smith    hyphen.
3673d763cef2SBarry Smith 
3674d763cef2SBarry Smith    Level: advanced
3675d763cef2SBarry Smith 
3676d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3677d763cef2SBarry Smith 
3678d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3679d763cef2SBarry Smith 
3680d763cef2SBarry Smith @*/
36817087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3682d763cef2SBarry Smith {
3683dfbe8321SBarry Smith   PetscErrorCode ierr;
3684089b2837SJed Brown   SNES           snes;
3685d763cef2SBarry Smith 
3686d763cef2SBarry Smith   PetscFunctionBegin;
36870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3688d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3689089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3690089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3691d763cef2SBarry Smith   PetscFunctionReturn(0);
3692d763cef2SBarry Smith }
3693d763cef2SBarry Smith 
36944a2ae208SSatish Balay #undef __FUNCT__
36954a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3696d763cef2SBarry Smith /*@C
3697d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3698d763cef2SBarry Smith    TS options in the database.
3699d763cef2SBarry Smith 
3700d763cef2SBarry Smith    Not Collective
3701d763cef2SBarry Smith 
3702d763cef2SBarry Smith    Input Parameter:
3703d763cef2SBarry Smith .  ts - The TS context
3704d763cef2SBarry Smith 
3705d763cef2SBarry Smith    Output Parameter:
3706d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3707d763cef2SBarry Smith 
3708d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3709d763cef2SBarry Smith    sufficient length to hold the prefix.
3710d763cef2SBarry Smith 
3711d763cef2SBarry Smith    Level: intermediate
3712d763cef2SBarry Smith 
3713d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3714d763cef2SBarry Smith 
3715d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3716d763cef2SBarry Smith @*/
37177087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3718d763cef2SBarry Smith {
3719dfbe8321SBarry Smith   PetscErrorCode ierr;
3720d763cef2SBarry Smith 
3721d763cef2SBarry Smith   PetscFunctionBegin;
37220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37234482741eSBarry Smith   PetscValidPointer(prefix,2);
3724d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3725d763cef2SBarry Smith   PetscFunctionReturn(0);
3726d763cef2SBarry Smith }
3727d763cef2SBarry Smith 
37284a2ae208SSatish Balay #undef __FUNCT__
37294a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3730d763cef2SBarry Smith /*@C
3731d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3732d763cef2SBarry Smith 
3733d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3734d763cef2SBarry Smith 
3735d763cef2SBarry Smith    Input Parameter:
3736d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3737d763cef2SBarry Smith 
3738d763cef2SBarry Smith    Output Parameters:
3739e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3740e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3741e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3742e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3743d763cef2SBarry Smith 
37440298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3745d763cef2SBarry Smith 
3746d763cef2SBarry Smith    Level: intermediate
3747d763cef2SBarry Smith 
374826d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3749d763cef2SBarry Smith 
3750d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3751d763cef2SBarry Smith @*/
3752e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3753d763cef2SBarry Smith {
3754089b2837SJed Brown   PetscErrorCode ierr;
3755089b2837SJed Brown   SNES           snes;
375624989b8cSPeter Brune   DM             dm;
3757089b2837SJed Brown 
3758d763cef2SBarry Smith   PetscFunctionBegin;
3759089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3760e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
376124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
376224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3763d763cef2SBarry Smith   PetscFunctionReturn(0);
3764d763cef2SBarry Smith }
3765d763cef2SBarry Smith 
37661713a123SBarry Smith #undef __FUNCT__
37672eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
37682eca1d9cSJed Brown /*@C
37692eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
37702eca1d9cSJed Brown 
37712eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
37722eca1d9cSJed Brown 
37732eca1d9cSJed Brown    Input Parameter:
37742eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
37752eca1d9cSJed Brown 
37762eca1d9cSJed Brown    Output Parameters:
3777e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3778e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
37792eca1d9cSJed Brown .  f   - The function to compute the matrices
37802eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
37812eca1d9cSJed Brown 
37820298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
37832eca1d9cSJed Brown 
37842eca1d9cSJed Brown    Level: advanced
37852eca1d9cSJed Brown 
37862eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
37872eca1d9cSJed Brown 
37882eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
37892eca1d9cSJed Brown @*/
3790e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
37912eca1d9cSJed Brown {
3792089b2837SJed Brown   PetscErrorCode ierr;
3793089b2837SJed Brown   SNES           snes;
379424989b8cSPeter Brune   DM             dm;
37950910c330SBarry Smith 
37962eca1d9cSJed Brown   PetscFunctionBegin;
3797089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3798f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3799e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
380024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
380124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
38022eca1d9cSJed Brown   PetscFunctionReturn(0);
38032eca1d9cSJed Brown }
38042eca1d9cSJed Brown 
38056083293cSBarry Smith 
38062eca1d9cSJed Brown #undef __FUNCT__
380783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
38081713a123SBarry Smith /*@C
380983a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
38101713a123SBarry Smith    VecView() for the solution at each timestep
38111713a123SBarry Smith 
38121713a123SBarry Smith    Collective on TS
38131713a123SBarry Smith 
38141713a123SBarry Smith    Input Parameters:
38151713a123SBarry Smith +  ts - the TS context
38161713a123SBarry Smith .  step - current time-step
3817142b95e3SSatish Balay .  ptime - current time
38180298fd71SBarry Smith -  dummy - either a viewer or NULL
38191713a123SBarry Smith 
382099fdda47SBarry Smith    Options Database:
382199fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
382299fdda47SBarry Smith 
382399fdda47SBarry 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
382499fdda47SBarry Smith        will look bad
382599fdda47SBarry Smith 
38261713a123SBarry Smith    Level: intermediate
38271713a123SBarry Smith 
38281713a123SBarry Smith .keywords: TS,  vector, monitor, view
38291713a123SBarry Smith 
3830a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38311713a123SBarry Smith @*/
38320910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38331713a123SBarry Smith {
3834dfbe8321SBarry Smith   PetscErrorCode   ierr;
383583a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3836473a3ab2SBarry Smith   PetscDraw        draw;
38371713a123SBarry Smith 
38381713a123SBarry Smith   PetscFunctionBegin;
38396083293cSBarry Smith   if (!step && ictx->showinitial) {
38406083293cSBarry Smith     if (!ictx->initialsolution) {
38410910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
38421713a123SBarry Smith     }
38430910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
38446083293cSBarry Smith   }
3845b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
38460dcf80beSBarry Smith 
38476083293cSBarry Smith   if (ictx->showinitial) {
38486083293cSBarry Smith     PetscReal pause;
38496083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
38506083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
38516083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
38526083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
38536083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
38546083293cSBarry Smith   }
38550910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3856473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3857473a3ab2SBarry Smith     PetscReal xl,yl,xr,yr,tw,w,h;
3858473a3ab2SBarry Smith     char      time[32];
3859473a3ab2SBarry Smith     size_t    len;
3860473a3ab2SBarry Smith 
3861473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3862473a3ab2SBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
3863473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3864473a3ab2SBarry Smith     ierr =  PetscStrlen(time,&len);CHKERRQ(ierr);
38650298fd71SBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3866473a3ab2SBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
3867473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3868473a3ab2SBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3869473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3870473a3ab2SBarry Smith   }
3871473a3ab2SBarry Smith 
38726083293cSBarry Smith   if (ictx->showinitial) {
38736083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
38746083293cSBarry Smith   }
38751713a123SBarry Smith   PetscFunctionReturn(0);
38761713a123SBarry Smith }
38771713a123SBarry Smith 
38782d5ee99bSBarry Smith #undef __FUNCT__
38792d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
38802d5ee99bSBarry Smith /*@C
38812d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
38822d5ee99bSBarry Smith 
38832d5ee99bSBarry Smith    Collective on TS
38842d5ee99bSBarry Smith 
38852d5ee99bSBarry Smith    Input Parameters:
38862d5ee99bSBarry Smith +  ts - the TS context
38872d5ee99bSBarry Smith .  step - current time-step
38882d5ee99bSBarry Smith .  ptime - current time
38892d5ee99bSBarry Smith -  dummy - either a viewer or NULL
38902d5ee99bSBarry Smith 
38912d5ee99bSBarry Smith    Level: intermediate
38922d5ee99bSBarry Smith 
38932d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
38942d5ee99bSBarry Smith 
38952d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38962d5ee99bSBarry Smith @*/
38972d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38982d5ee99bSBarry Smith {
38992d5ee99bSBarry Smith   PetscErrorCode    ierr;
39002d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
39012d5ee99bSBarry Smith   PetscDraw         draw;
39022d5ee99bSBarry Smith   MPI_Comm          comm;
39032d5ee99bSBarry Smith   PetscInt          n;
39042d5ee99bSBarry Smith   PetscMPIInt       size;
39052d5ee99bSBarry Smith   PetscReal         xl,yl,xr,yr,tw,w,h;
39062d5ee99bSBarry Smith   char              time[32];
39072d5ee99bSBarry Smith   size_t            len;
39082d5ee99bSBarry Smith   const PetscScalar *U;
39092d5ee99bSBarry Smith 
39102d5ee99bSBarry Smith   PetscFunctionBegin;
39112d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
39122d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
39132d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
39142d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
39152d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
39162d5ee99bSBarry Smith 
39172d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
39182d5ee99bSBarry Smith 
39192d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
39204b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3921ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3922a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3923a4494fc1SBarry Smith       PetscFunctionReturn(0);
3924a4494fc1SBarry Smith   }
39252d5ee99bSBarry Smith   if (!step) ictx->color++;
39262d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
39272d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
39282d5ee99bSBarry Smith 
39292d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
39304b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
39312d5ee99bSBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
39322d5ee99bSBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
39332d5ee99bSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
39342d5ee99bSBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
39352d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
39362d5ee99bSBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
39372d5ee99bSBarry Smith   }
39382d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
39392d5ee99bSBarry Smith   PetscFunctionReturn(0);
39402d5ee99bSBarry Smith }
39412d5ee99bSBarry Smith 
39421713a123SBarry Smith 
39436c699258SBarry Smith #undef __FUNCT__
394483a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
39456083293cSBarry Smith /*@C
394683a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
39476083293cSBarry Smith 
39486083293cSBarry Smith    Collective on TS
39496083293cSBarry Smith 
39506083293cSBarry Smith    Input Parameters:
39516083293cSBarry Smith .    ctx - the monitor context
39526083293cSBarry Smith 
39536083293cSBarry Smith    Level: intermediate
39546083293cSBarry Smith 
39556083293cSBarry Smith .keywords: TS,  vector, monitor, view
39566083293cSBarry Smith 
395783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
39586083293cSBarry Smith @*/
395983a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
39606083293cSBarry Smith {
39616083293cSBarry Smith   PetscErrorCode ierr;
39626083293cSBarry Smith 
39636083293cSBarry Smith   PetscFunctionBegin;
39644b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
396583a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
396683a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
396783a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
39686083293cSBarry Smith   PetscFunctionReturn(0);
39696083293cSBarry Smith }
39706083293cSBarry Smith 
39716083293cSBarry Smith #undef __FUNCT__
397283a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
39736083293cSBarry Smith /*@C
397483a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
39756083293cSBarry Smith 
39766083293cSBarry Smith    Collective on TS
39776083293cSBarry Smith 
39786083293cSBarry Smith    Input Parameter:
39796083293cSBarry Smith .    ts - time-step context
39806083293cSBarry Smith 
39816083293cSBarry Smith    Output Patameter:
39826083293cSBarry Smith .    ctx - the monitor context
39836083293cSBarry Smith 
398499fdda47SBarry Smith    Options Database:
398599fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
398699fdda47SBarry Smith 
39876083293cSBarry Smith    Level: intermediate
39886083293cSBarry Smith 
39896083293cSBarry Smith .keywords: TS,  vector, monitor, view
39906083293cSBarry Smith 
399183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
39926083293cSBarry Smith @*/
399383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
39946083293cSBarry Smith {
39956083293cSBarry Smith   PetscErrorCode   ierr;
39966083293cSBarry Smith 
39976083293cSBarry Smith   PetscFunctionBegin;
3998b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
399983a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4000e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4001bbd56ea5SKarl Rupp 
400283a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4003473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
40040298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4005473a3ab2SBarry Smith 
4006473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
40070298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
40082d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
40096083293cSBarry Smith   PetscFunctionReturn(0);
40106083293cSBarry Smith }
40116083293cSBarry Smith 
40126083293cSBarry Smith #undef __FUNCT__
401383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
40143a471f94SBarry Smith /*@C
401583a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
40163a471f94SBarry Smith    VecView() for the error at each timestep
40173a471f94SBarry Smith 
40183a471f94SBarry Smith    Collective on TS
40193a471f94SBarry Smith 
40203a471f94SBarry Smith    Input Parameters:
40213a471f94SBarry Smith +  ts - the TS context
40223a471f94SBarry Smith .  step - current time-step
40233a471f94SBarry Smith .  ptime - current time
40240298fd71SBarry Smith -  dummy - either a viewer or NULL
40253a471f94SBarry Smith 
40263a471f94SBarry Smith    Level: intermediate
40273a471f94SBarry Smith 
40283a471f94SBarry Smith .keywords: TS,  vector, monitor, view
40293a471f94SBarry Smith 
40303a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
40313a471f94SBarry Smith @*/
40320910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
40333a471f94SBarry Smith {
40343a471f94SBarry Smith   PetscErrorCode   ierr;
403583a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
403683a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
40373a471f94SBarry Smith   Vec              work;
40383a471f94SBarry Smith 
40393a471f94SBarry Smith   PetscFunctionBegin;
4040b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40410910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
40423a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
40430910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
40443a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
40453a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
40463a471f94SBarry Smith   PetscFunctionReturn(0);
40473a471f94SBarry Smith }
40483a471f94SBarry Smith 
40492a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
40503a471f94SBarry Smith #undef __FUNCT__
40516c699258SBarry Smith #define __FUNCT__ "TSSetDM"
40526c699258SBarry Smith /*@
40536c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
40546c699258SBarry Smith 
40553f9fe445SBarry Smith    Logically Collective on TS and DM
40566c699258SBarry Smith 
40576c699258SBarry Smith    Input Parameters:
40586c699258SBarry Smith +  ts - the preconditioner context
40596c699258SBarry Smith -  dm - the dm
40606c699258SBarry Smith 
40616c699258SBarry Smith    Level: intermediate
40626c699258SBarry Smith 
40636c699258SBarry Smith 
40646c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
40656c699258SBarry Smith @*/
40667087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
40676c699258SBarry Smith {
40686c699258SBarry Smith   PetscErrorCode ierr;
4069089b2837SJed Brown   SNES           snes;
4070942e3340SBarry Smith   DMTS           tsdm;
40716c699258SBarry Smith 
40726c699258SBarry Smith   PetscFunctionBegin;
40730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
407470663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4075942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
40762a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4077942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4078942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
407924989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
408024989b8cSPeter Brune         tsdm->originaldm = dm;
408124989b8cSPeter Brune       }
408224989b8cSPeter Brune     }
40836bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
408424989b8cSPeter Brune   }
40856c699258SBarry Smith   ts->dm = dm;
4086bbd56ea5SKarl Rupp 
4087089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4088089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
40896c699258SBarry Smith   PetscFunctionReturn(0);
40906c699258SBarry Smith }
40916c699258SBarry Smith 
40926c699258SBarry Smith #undef __FUNCT__
40936c699258SBarry Smith #define __FUNCT__ "TSGetDM"
40946c699258SBarry Smith /*@
40956c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
40966c699258SBarry Smith 
40973f9fe445SBarry Smith    Not Collective
40986c699258SBarry Smith 
40996c699258SBarry Smith    Input Parameter:
41006c699258SBarry Smith . ts - the preconditioner context
41016c699258SBarry Smith 
41026c699258SBarry Smith    Output Parameter:
41036c699258SBarry Smith .  dm - the dm
41046c699258SBarry Smith 
41056c699258SBarry Smith    Level: intermediate
41066c699258SBarry Smith 
41076c699258SBarry Smith 
41086c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
41096c699258SBarry Smith @*/
41107087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
41116c699258SBarry Smith {
4112496e6a7aSJed Brown   PetscErrorCode ierr;
4113496e6a7aSJed Brown 
41146c699258SBarry Smith   PetscFunctionBegin;
41150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4116496e6a7aSJed Brown   if (!ts->dm) {
4117ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4118496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4119496e6a7aSJed Brown   }
41206c699258SBarry Smith   *dm = ts->dm;
41216c699258SBarry Smith   PetscFunctionReturn(0);
41226c699258SBarry Smith }
41231713a123SBarry Smith 
41240f5c6efeSJed Brown #undef __FUNCT__
41250f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
41260f5c6efeSJed Brown /*@
41270f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
41280f5c6efeSJed Brown 
41293f9fe445SBarry Smith    Logically Collective on SNES
41300f5c6efeSJed Brown 
41310f5c6efeSJed Brown    Input Parameter:
4132d42a1c89SJed Brown + snes - nonlinear solver
41330910c330SBarry Smith . U - the current state at which to evaluate the residual
4134d42a1c89SJed Brown - ctx - user context, must be a TS
41350f5c6efeSJed Brown 
41360f5c6efeSJed Brown    Output Parameter:
41370f5c6efeSJed Brown . F - the nonlinear residual
41380f5c6efeSJed Brown 
41390f5c6efeSJed Brown    Notes:
41400f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41410f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
41420f5c6efeSJed Brown 
41430f5c6efeSJed Brown    Level: advanced
41440f5c6efeSJed Brown 
41450f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
41460f5c6efeSJed Brown @*/
41470910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
41480f5c6efeSJed Brown {
41490f5c6efeSJed Brown   TS             ts = (TS)ctx;
41500f5c6efeSJed Brown   PetscErrorCode ierr;
41510f5c6efeSJed Brown 
41520f5c6efeSJed Brown   PetscFunctionBegin;
41530f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41540910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41550f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
41560f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
41570910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
41580f5c6efeSJed Brown   PetscFunctionReturn(0);
41590f5c6efeSJed Brown }
41600f5c6efeSJed Brown 
41610f5c6efeSJed Brown #undef __FUNCT__
41620f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
41630f5c6efeSJed Brown /*@
41640f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
41650f5c6efeSJed Brown 
41660f5c6efeSJed Brown    Collective on SNES
41670f5c6efeSJed Brown 
41680f5c6efeSJed Brown    Input Parameter:
41690f5c6efeSJed Brown + snes - nonlinear solver
41700910c330SBarry Smith . U - the current state at which to evaluate the residual
41710f5c6efeSJed Brown - ctx - user context, must be a TS
41720f5c6efeSJed Brown 
41730f5c6efeSJed Brown    Output Parameter:
41740f5c6efeSJed Brown + A - the Jacobian
41750f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
41760f5c6efeSJed Brown - flag - indicates any structure change in the matrix
41770f5c6efeSJed Brown 
41780f5c6efeSJed Brown    Notes:
41790f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41800f5c6efeSJed Brown 
41810f5c6efeSJed Brown    Level: developer
41820f5c6efeSJed Brown 
41830f5c6efeSJed Brown .seealso: SNESSetJacobian()
41840f5c6efeSJed Brown @*/
4185d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
41860f5c6efeSJed Brown {
41870f5c6efeSJed Brown   TS             ts = (TS)ctx;
41880f5c6efeSJed Brown   PetscErrorCode ierr;
41890f5c6efeSJed Brown 
41900f5c6efeSJed Brown   PetscFunctionBegin;
41910f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41920910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41930f5c6efeSJed Brown   PetscValidPointer(A,3);
419494ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
41950f5c6efeSJed Brown   PetscValidPointer(B,4);
419694ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
41970f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4198d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
41990f5c6efeSJed Brown   PetscFunctionReturn(0);
42000f5c6efeSJed Brown }
4201325fc9f4SBarry Smith 
42020e4ef248SJed Brown #undef __FUNCT__
42030e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
42040e4ef248SJed Brown /*@C
42050e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
42060e4ef248SJed Brown 
42070e4ef248SJed Brown    Collective on TS
42080e4ef248SJed Brown 
42090e4ef248SJed Brown    Input Arguments:
42100e4ef248SJed Brown +  ts - time stepping context
42110e4ef248SJed Brown .  t - time at which to evaluate
42120910c330SBarry Smith .  U - state at which to evaluate
42130e4ef248SJed Brown -  ctx - context
42140e4ef248SJed Brown 
42150e4ef248SJed Brown    Output Arguments:
42160e4ef248SJed Brown .  F - right hand side
42170e4ef248SJed Brown 
42180e4ef248SJed Brown    Level: intermediate
42190e4ef248SJed Brown 
42200e4ef248SJed Brown    Notes:
42210e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
42220e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
42230e4ef248SJed Brown 
42240e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
42250e4ef248SJed Brown @*/
42260910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
42270e4ef248SJed Brown {
42280e4ef248SJed Brown   PetscErrorCode ierr;
42290e4ef248SJed Brown   Mat            Arhs,Brhs;
42300e4ef248SJed Brown 
42310e4ef248SJed Brown   PetscFunctionBegin;
42320e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4233d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
42340910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
42350e4ef248SJed Brown   PetscFunctionReturn(0);
42360e4ef248SJed Brown }
42370e4ef248SJed Brown 
42380e4ef248SJed Brown #undef __FUNCT__
42390e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
42400e4ef248SJed Brown /*@C
42410e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
42420e4ef248SJed Brown 
42430e4ef248SJed Brown    Collective on TS
42440e4ef248SJed Brown 
42450e4ef248SJed Brown    Input Arguments:
42460e4ef248SJed Brown +  ts - time stepping context
42470e4ef248SJed Brown .  t - time at which to evaluate
42480910c330SBarry Smith .  U - state at which to evaluate
42490e4ef248SJed Brown -  ctx - context
42500e4ef248SJed Brown 
42510e4ef248SJed Brown    Output Arguments:
42520e4ef248SJed Brown +  A - pointer to operator
42530e4ef248SJed Brown .  B - pointer to preconditioning matrix
42540e4ef248SJed Brown -  flg - matrix structure flag
42550e4ef248SJed Brown 
42560e4ef248SJed Brown    Level: intermediate
42570e4ef248SJed Brown 
42580e4ef248SJed Brown    Notes:
42590e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
42600e4ef248SJed Brown 
42610e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
42620e4ef248SJed Brown @*/
4263d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
42640e4ef248SJed Brown {
42650e4ef248SJed Brown   PetscFunctionBegin;
42660e4ef248SJed Brown   PetscFunctionReturn(0);
42670e4ef248SJed Brown }
42680e4ef248SJed Brown 
42690026cea9SSean Farley #undef __FUNCT__
42700026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
42710026cea9SSean Farley /*@C
42720026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
42730026cea9SSean Farley 
42740026cea9SSean Farley    Collective on TS
42750026cea9SSean Farley 
42760026cea9SSean Farley    Input Arguments:
42770026cea9SSean Farley +  ts - time stepping context
42780026cea9SSean Farley .  t - time at which to evaluate
42790910c330SBarry Smith .  U - state at which to evaluate
42800910c330SBarry Smith .  Udot - time derivative of state vector
42810026cea9SSean Farley -  ctx - context
42820026cea9SSean Farley 
42830026cea9SSean Farley    Output Arguments:
42840026cea9SSean Farley .  F - left hand side
42850026cea9SSean Farley 
42860026cea9SSean Farley    Level: intermediate
42870026cea9SSean Farley 
42880026cea9SSean Farley    Notes:
42890910c330SBarry 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
42900026cea9SSean Farley    user is required to write their own TSComputeIFunction.
42910026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
42920026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
42930026cea9SSean Farley 
42940026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
42950026cea9SSean Farley @*/
42960910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
42970026cea9SSean Farley {
42980026cea9SSean Farley   PetscErrorCode ierr;
42990026cea9SSean Farley   Mat            A,B;
43000026cea9SSean Farley 
43010026cea9SSean Farley   PetscFunctionBegin;
43020298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4303d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
43040910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
43050026cea9SSean Farley   PetscFunctionReturn(0);
43060026cea9SSean Farley }
43070026cea9SSean Farley 
43080026cea9SSean Farley #undef __FUNCT__
43090026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
43100026cea9SSean Farley /*@C
4311b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
43120026cea9SSean Farley 
43130026cea9SSean Farley    Collective on TS
43140026cea9SSean Farley 
43150026cea9SSean Farley    Input Arguments:
43160026cea9SSean Farley +  ts - time stepping context
43170026cea9SSean Farley .  t - time at which to evaluate
43180910c330SBarry Smith .  U - state at which to evaluate
43190910c330SBarry Smith .  Udot - time derivative of state vector
43200026cea9SSean Farley .  shift - shift to apply
43210026cea9SSean Farley -  ctx - context
43220026cea9SSean Farley 
43230026cea9SSean Farley    Output Arguments:
43240026cea9SSean Farley +  A - pointer to operator
43250026cea9SSean Farley .  B - pointer to preconditioning matrix
43260026cea9SSean Farley -  flg - matrix structure flag
43270026cea9SSean Farley 
4328b41af12eSJed Brown    Level: advanced
43290026cea9SSean Farley 
43300026cea9SSean Farley    Notes:
43310026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
43320026cea9SSean Farley 
4333b41af12eSJed Brown    It is only appropriate for problems of the form
4334b41af12eSJed Brown 
4335b41af12eSJed Brown $     M Udot = F(U,t)
4336b41af12eSJed Brown 
4337b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4338b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4339b41af12eSJed Brown   an implicit operator of the form
4340b41af12eSJed Brown 
4341b41af12eSJed Brown $    shift*M + J
4342b41af12eSJed Brown 
4343b41af12eSJed 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
4344b41af12eSJed Brown   a copy of M or reassemble it when requested.
4345b41af12eSJed Brown 
43460026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
43470026cea9SSean Farley @*/
4348d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
43490026cea9SSean Farley {
4350b41af12eSJed Brown   PetscErrorCode ierr;
4351b41af12eSJed Brown 
43520026cea9SSean Farley   PetscFunctionBegin;
435394ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4354b41af12eSJed Brown   ts->ijacobian.shift = shift;
43550026cea9SSean Farley   PetscFunctionReturn(0);
43560026cea9SSean Farley }
4357b41af12eSJed Brown 
4358e817cc15SEmil Constantinescu #undef __FUNCT__
4359e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4360e817cc15SEmil Constantinescu /*@
4361e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4362e817cc15SEmil Constantinescu 
4363e817cc15SEmil Constantinescu    Not Collective
4364e817cc15SEmil Constantinescu 
4365e817cc15SEmil Constantinescu    Input Parameter:
4366e817cc15SEmil Constantinescu .  ts - the TS context
4367e817cc15SEmil Constantinescu 
4368e817cc15SEmil Constantinescu    Output Parameter:
43694e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4370e817cc15SEmil Constantinescu 
4371e817cc15SEmil Constantinescu    Level: beginner
4372e817cc15SEmil Constantinescu 
4373e817cc15SEmil Constantinescu .keywords: TS, equation type
4374e817cc15SEmil Constantinescu 
4375e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4376e817cc15SEmil Constantinescu @*/
4377e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4378e817cc15SEmil Constantinescu {
4379e817cc15SEmil Constantinescu   PetscFunctionBegin;
4380e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4381e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4382e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4383e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4384e817cc15SEmil Constantinescu }
4385e817cc15SEmil Constantinescu 
4386e817cc15SEmil Constantinescu #undef __FUNCT__
4387e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4388e817cc15SEmil Constantinescu /*@
4389e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4390e817cc15SEmil Constantinescu 
4391e817cc15SEmil Constantinescu    Not Collective
4392e817cc15SEmil Constantinescu 
4393e817cc15SEmil Constantinescu    Input Parameter:
4394e817cc15SEmil Constantinescu +  ts - the TS context
43954e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4396e817cc15SEmil Constantinescu 
4397e817cc15SEmil Constantinescu    Level: advanced
4398e817cc15SEmil Constantinescu 
4399e817cc15SEmil Constantinescu .keywords: TS, equation type
4400e817cc15SEmil Constantinescu 
4401e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4402e817cc15SEmil Constantinescu @*/
4403e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4404e817cc15SEmil Constantinescu {
4405e817cc15SEmil Constantinescu   PetscFunctionBegin;
4406e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4407e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4408e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4409e817cc15SEmil Constantinescu }
44100026cea9SSean Farley 
44114af1b03aSJed Brown #undef __FUNCT__
44124af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
44134af1b03aSJed Brown /*@
44144af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
44154af1b03aSJed Brown 
44164af1b03aSJed Brown    Not Collective
44174af1b03aSJed Brown 
44184af1b03aSJed Brown    Input Parameter:
44194af1b03aSJed Brown .  ts - the TS context
44204af1b03aSJed Brown 
44214af1b03aSJed Brown    Output Parameter:
44224af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
44234af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
44244af1b03aSJed Brown 
4425487e0bb9SJed Brown    Level: beginner
44264af1b03aSJed Brown 
4427cd652676SJed Brown    Notes:
4428cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
44294af1b03aSJed Brown 
44304af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
44314af1b03aSJed Brown 
44324af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
44334af1b03aSJed Brown @*/
44344af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
44354af1b03aSJed Brown {
44364af1b03aSJed Brown   PetscFunctionBegin;
44374af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44384af1b03aSJed Brown   PetscValidPointer(reason,2);
44394af1b03aSJed Brown   *reason = ts->reason;
44404af1b03aSJed Brown   PetscFunctionReturn(0);
44414af1b03aSJed Brown }
44424af1b03aSJed Brown 
4443fb1732b5SBarry Smith #undef __FUNCT__
4444d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4445d6ad946cSShri Abhyankar /*@
4446d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4447d6ad946cSShri Abhyankar 
4448d6ad946cSShri Abhyankar    Not Collective
4449d6ad946cSShri Abhyankar 
4450d6ad946cSShri Abhyankar    Input Parameter:
4451d6ad946cSShri Abhyankar +  ts - the TS context
4452d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4453d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4454d6ad946cSShri Abhyankar 
4455f5abba47SShri Abhyankar    Level: advanced
4456d6ad946cSShri Abhyankar 
4457d6ad946cSShri Abhyankar    Notes:
4458d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4459d6ad946cSShri Abhyankar 
4460d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4461d6ad946cSShri Abhyankar 
4462d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4463d6ad946cSShri Abhyankar @*/
4464d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4465d6ad946cSShri Abhyankar {
4466d6ad946cSShri Abhyankar   PetscFunctionBegin;
4467d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4468d6ad946cSShri Abhyankar   ts->reason = reason;
4469d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4470d6ad946cSShri Abhyankar }
4471d6ad946cSShri Abhyankar 
4472d6ad946cSShri Abhyankar #undef __FUNCT__
4473cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4474cc708dedSBarry Smith /*@
4475cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4476cc708dedSBarry Smith 
4477cc708dedSBarry Smith    Not Collective
4478cc708dedSBarry Smith 
4479cc708dedSBarry Smith    Input Parameter:
4480cc708dedSBarry Smith .  ts - the TS context
4481cc708dedSBarry Smith 
4482cc708dedSBarry Smith    Output Parameter:
4483cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4484cc708dedSBarry Smith 
4485487e0bb9SJed Brown    Level: beginner
4486cc708dedSBarry Smith 
4487cc708dedSBarry Smith    Notes:
4488cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4489cc708dedSBarry Smith 
4490cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4491cc708dedSBarry Smith 
4492cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4493cc708dedSBarry Smith @*/
4494cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4495cc708dedSBarry Smith {
4496cc708dedSBarry Smith   PetscFunctionBegin;
4497cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4498cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4499cc708dedSBarry Smith   *ftime = ts->solvetime;
4500cc708dedSBarry Smith   PetscFunctionReturn(0);
4501cc708dedSBarry Smith }
4502cc708dedSBarry Smith 
4503cc708dedSBarry Smith #undef __FUNCT__
45045ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
45059f67acb7SJed Brown /*@
45065ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
45079f67acb7SJed Brown    used by the time integrator.
45089f67acb7SJed Brown 
45099f67acb7SJed Brown    Not Collective
45109f67acb7SJed Brown 
45119f67acb7SJed Brown    Input Parameter:
45129f67acb7SJed Brown .  ts - TS context
45139f67acb7SJed Brown 
45149f67acb7SJed Brown    Output Parameter:
45159f67acb7SJed Brown .  nits - number of nonlinear iterations
45169f67acb7SJed Brown 
45179f67acb7SJed Brown    Notes:
45189f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45199f67acb7SJed Brown 
45209f67acb7SJed Brown    Level: intermediate
45219f67acb7SJed Brown 
45229f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
45239f67acb7SJed Brown 
45245ef26d82SJed Brown .seealso:  TSGetKSPIterations()
45259f67acb7SJed Brown @*/
45265ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
45279f67acb7SJed Brown {
45289f67acb7SJed Brown   PetscFunctionBegin;
45299f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45309f67acb7SJed Brown   PetscValidIntPointer(nits,2);
45315ef26d82SJed Brown   *nits = ts->snes_its;
45329f67acb7SJed Brown   PetscFunctionReturn(0);
45339f67acb7SJed Brown }
45349f67acb7SJed Brown 
45359f67acb7SJed Brown #undef __FUNCT__
45365ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
45379f67acb7SJed Brown /*@
45385ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
45399f67acb7SJed Brown    used by the time integrator.
45409f67acb7SJed Brown 
45419f67acb7SJed Brown    Not Collective
45429f67acb7SJed Brown 
45439f67acb7SJed Brown    Input Parameter:
45449f67acb7SJed Brown .  ts - TS context
45459f67acb7SJed Brown 
45469f67acb7SJed Brown    Output Parameter:
45479f67acb7SJed Brown .  lits - number of linear iterations
45489f67acb7SJed Brown 
45499f67acb7SJed Brown    Notes:
45509f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45519f67acb7SJed Brown 
45529f67acb7SJed Brown    Level: intermediate
45539f67acb7SJed Brown 
45549f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
45559f67acb7SJed Brown 
45565ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
45579f67acb7SJed Brown @*/
45585ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
45599f67acb7SJed Brown {
45609f67acb7SJed Brown   PetscFunctionBegin;
45619f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45629f67acb7SJed Brown   PetscValidIntPointer(lits,2);
45635ef26d82SJed Brown   *lits = ts->ksp_its;
45649f67acb7SJed Brown   PetscFunctionReturn(0);
45659f67acb7SJed Brown }
45669f67acb7SJed Brown 
45679f67acb7SJed Brown #undef __FUNCT__
4568cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4569cef5090cSJed Brown /*@
4570cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4571cef5090cSJed Brown 
4572cef5090cSJed Brown    Not Collective
4573cef5090cSJed Brown 
4574cef5090cSJed Brown    Input Parameter:
4575cef5090cSJed Brown .  ts - TS context
4576cef5090cSJed Brown 
4577cef5090cSJed Brown    Output Parameter:
4578cef5090cSJed Brown .  rejects - number of steps rejected
4579cef5090cSJed Brown 
4580cef5090cSJed Brown    Notes:
4581cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4582cef5090cSJed Brown 
4583cef5090cSJed Brown    Level: intermediate
4584cef5090cSJed Brown 
4585cef5090cSJed Brown .keywords: TS, get, number
4586cef5090cSJed Brown 
45875ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4588cef5090cSJed Brown @*/
4589cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4590cef5090cSJed Brown {
4591cef5090cSJed Brown   PetscFunctionBegin;
4592cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4593cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4594cef5090cSJed Brown   *rejects = ts->reject;
4595cef5090cSJed Brown   PetscFunctionReturn(0);
4596cef5090cSJed Brown }
4597cef5090cSJed Brown 
4598cef5090cSJed Brown #undef __FUNCT__
4599cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4600cef5090cSJed Brown /*@
4601cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4602cef5090cSJed Brown 
4603cef5090cSJed Brown    Not Collective
4604cef5090cSJed Brown 
4605cef5090cSJed Brown    Input Parameter:
4606cef5090cSJed Brown .  ts - TS context
4607cef5090cSJed Brown 
4608cef5090cSJed Brown    Output Parameter:
4609cef5090cSJed Brown .  fails - number of failed nonlinear solves
4610cef5090cSJed Brown 
4611cef5090cSJed Brown    Notes:
4612cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4613cef5090cSJed Brown 
4614cef5090cSJed Brown    Level: intermediate
4615cef5090cSJed Brown 
4616cef5090cSJed Brown .keywords: TS, get, number
4617cef5090cSJed Brown 
46185ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4619cef5090cSJed Brown @*/
4620cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4621cef5090cSJed Brown {
4622cef5090cSJed Brown   PetscFunctionBegin;
4623cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4624cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4625cef5090cSJed Brown   *fails = ts->num_snes_failures;
4626cef5090cSJed Brown   PetscFunctionReturn(0);
4627cef5090cSJed Brown }
4628cef5090cSJed Brown 
4629cef5090cSJed Brown #undef __FUNCT__
4630cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4631cef5090cSJed Brown /*@
4632cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4633cef5090cSJed Brown 
4634cef5090cSJed Brown    Not Collective
4635cef5090cSJed Brown 
4636cef5090cSJed Brown    Input Parameter:
4637cef5090cSJed Brown +  ts - TS context
4638cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4639cef5090cSJed Brown 
4640cef5090cSJed Brown    Notes:
4641cef5090cSJed Brown    The counter is reset to zero for each step
4642cef5090cSJed Brown 
4643cef5090cSJed Brown    Options Database Key:
4644cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4645cef5090cSJed Brown 
4646cef5090cSJed Brown    Level: intermediate
4647cef5090cSJed Brown 
4648cef5090cSJed Brown .keywords: TS, set, maximum, number
4649cef5090cSJed Brown 
46505ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4651cef5090cSJed Brown @*/
4652cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4653cef5090cSJed Brown {
4654cef5090cSJed Brown   PetscFunctionBegin;
4655cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4656cef5090cSJed Brown   ts->max_reject = rejects;
4657cef5090cSJed Brown   PetscFunctionReturn(0);
4658cef5090cSJed Brown }
4659cef5090cSJed Brown 
4660cef5090cSJed Brown #undef __FUNCT__
4661cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4662cef5090cSJed Brown /*@
4663cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4664cef5090cSJed Brown 
4665cef5090cSJed Brown    Not Collective
4666cef5090cSJed Brown 
4667cef5090cSJed Brown    Input Parameter:
4668cef5090cSJed Brown +  ts - TS context
4669cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4670cef5090cSJed Brown 
4671cef5090cSJed Brown    Notes:
4672cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4673cef5090cSJed Brown 
4674cef5090cSJed Brown    Options Database Key:
4675cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4676cef5090cSJed Brown 
4677cef5090cSJed Brown    Level: intermediate
4678cef5090cSJed Brown 
4679cef5090cSJed Brown .keywords: TS, set, maximum, number
4680cef5090cSJed Brown 
46815ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4682cef5090cSJed Brown @*/
4683cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4684cef5090cSJed Brown {
4685cef5090cSJed Brown   PetscFunctionBegin;
4686cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4687cef5090cSJed Brown   ts->max_snes_failures = fails;
4688cef5090cSJed Brown   PetscFunctionReturn(0);
4689cef5090cSJed Brown }
4690cef5090cSJed Brown 
4691cef5090cSJed Brown #undef __FUNCT__
46924e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4693cef5090cSJed Brown /*@
4694cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4695cef5090cSJed Brown 
4696cef5090cSJed Brown    Not Collective
4697cef5090cSJed Brown 
4698cef5090cSJed Brown    Input Parameter:
4699cef5090cSJed Brown +  ts - TS context
4700cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4701cef5090cSJed Brown 
4702cef5090cSJed Brown    Options Database Key:
4703cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4704cef5090cSJed Brown 
4705cef5090cSJed Brown    Level: intermediate
4706cef5090cSJed Brown 
4707cef5090cSJed Brown .keywords: TS, set, error
4708cef5090cSJed Brown 
47095ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4710cef5090cSJed Brown @*/
4711cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4712cef5090cSJed Brown {
4713cef5090cSJed Brown   PetscFunctionBegin;
4714cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4715cef5090cSJed Brown   ts->errorifstepfailed = err;
4716cef5090cSJed Brown   PetscFunctionReturn(0);
4717cef5090cSJed Brown }
4718cef5090cSJed Brown 
4719cef5090cSJed Brown #undef __FUNCT__
4720fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4721fb1732b5SBarry Smith /*@C
4722fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4723fb1732b5SBarry Smith 
4724fb1732b5SBarry Smith    Collective on TS
4725fb1732b5SBarry Smith 
4726fb1732b5SBarry Smith    Input Parameters:
4727fb1732b5SBarry Smith +  ts - the TS context
4728fb1732b5SBarry Smith .  step - current time-step
4729fb1732b5SBarry Smith .  ptime - current time
47300910c330SBarry Smith .  u - current state
4731fb1732b5SBarry Smith -  viewer - binary viewer
4732fb1732b5SBarry Smith 
4733fb1732b5SBarry Smith    Level: intermediate
4734fb1732b5SBarry Smith 
4735fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4736fb1732b5SBarry Smith 
4737fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4738fb1732b5SBarry Smith @*/
47390910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4740fb1732b5SBarry Smith {
4741fb1732b5SBarry Smith   PetscErrorCode ierr;
4742ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4743fb1732b5SBarry Smith 
4744fb1732b5SBarry Smith   PetscFunctionBegin;
47450910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4746ed81e22dSJed Brown   PetscFunctionReturn(0);
4747ed81e22dSJed Brown }
4748ed81e22dSJed Brown 
4749ed81e22dSJed Brown #undef __FUNCT__
4750ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4751ed81e22dSJed Brown /*@C
4752ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4753ed81e22dSJed Brown 
4754ed81e22dSJed Brown    Collective on TS
4755ed81e22dSJed Brown 
4756ed81e22dSJed Brown    Input Parameters:
4757ed81e22dSJed Brown +  ts - the TS context
4758ed81e22dSJed Brown .  step - current time-step
4759ed81e22dSJed Brown .  ptime - current time
47600910c330SBarry Smith .  u - current state
4761ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4762ed81e22dSJed Brown 
4763ed81e22dSJed Brown    Level: intermediate
4764ed81e22dSJed Brown 
4765ed81e22dSJed Brown    Notes:
4766ed81e22dSJed 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.
4767ed81e22dSJed Brown    These are named according to the file name template.
4768ed81e22dSJed Brown 
4769ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4770ed81e22dSJed Brown 
4771ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4772ed81e22dSJed Brown 
4773ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4774ed81e22dSJed Brown @*/
47750910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4776ed81e22dSJed Brown {
4777ed81e22dSJed Brown   PetscErrorCode ierr;
4778ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4779ed81e22dSJed Brown   PetscViewer    viewer;
4780ed81e22dSJed Brown 
4781ed81e22dSJed Brown   PetscFunctionBegin;
47828caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4783ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
47840910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4785ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4786ed81e22dSJed Brown   PetscFunctionReturn(0);
4787ed81e22dSJed Brown }
4788ed81e22dSJed Brown 
4789ed81e22dSJed Brown #undef __FUNCT__
4790ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4791ed81e22dSJed Brown /*@C
4792ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4793ed81e22dSJed Brown 
4794ed81e22dSJed Brown    Collective on TS
4795ed81e22dSJed Brown 
4796ed81e22dSJed Brown    Input Parameters:
4797ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4798ed81e22dSJed Brown 
4799ed81e22dSJed Brown    Level: intermediate
4800ed81e22dSJed Brown 
4801ed81e22dSJed Brown    Note:
4802ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4803ed81e22dSJed Brown 
4804ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4805ed81e22dSJed Brown 
4806ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4807ed81e22dSJed Brown @*/
4808ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4809ed81e22dSJed Brown {
4810ed81e22dSJed Brown   PetscErrorCode ierr;
4811ed81e22dSJed Brown 
4812ed81e22dSJed Brown   PetscFunctionBegin;
4813ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4814fb1732b5SBarry Smith   PetscFunctionReturn(0);
4815fb1732b5SBarry Smith }
4816fb1732b5SBarry Smith 
481784df9cb4SJed Brown #undef __FUNCT__
4818552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
481984df9cb4SJed Brown /*@
4820552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
482184df9cb4SJed Brown 
4822ed81e22dSJed Brown    Collective on TS if controller has not been created yet
482384df9cb4SJed Brown 
482484df9cb4SJed Brown    Input Arguments:
4825ed81e22dSJed Brown .  ts - time stepping context
482684df9cb4SJed Brown 
482784df9cb4SJed Brown    Output Arguments:
4828ed81e22dSJed Brown .  adapt - adaptive controller
482984df9cb4SJed Brown 
483084df9cb4SJed Brown    Level: intermediate
483184df9cb4SJed Brown 
4832ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
483384df9cb4SJed Brown @*/
4834552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
483584df9cb4SJed Brown {
483684df9cb4SJed Brown   PetscErrorCode ierr;
483784df9cb4SJed Brown 
483884df9cb4SJed Brown   PetscFunctionBegin;
483984df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
484084df9cb4SJed Brown   PetscValidPointer(adapt,2);
484184df9cb4SJed Brown   if (!ts->adapt) {
4842ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
48433bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
48441c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
484584df9cb4SJed Brown   }
484684df9cb4SJed Brown   *adapt = ts->adapt;
484784df9cb4SJed Brown   PetscFunctionReturn(0);
484884df9cb4SJed Brown }
4849d6ebe24aSShri Abhyankar 
4850d6ebe24aSShri Abhyankar #undef __FUNCT__
48511c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
48521c3436cfSJed Brown /*@
48531c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
48541c3436cfSJed Brown 
48551c3436cfSJed Brown    Logically Collective
48561c3436cfSJed Brown 
48571c3436cfSJed Brown    Input Arguments:
48581c3436cfSJed Brown +  ts - time integration context
48591c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
48600298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
48611c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
48620298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
48631c3436cfSJed Brown 
4864a3cdaa26SBarry Smith    Options Database keys:
4865a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4866a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4867a3cdaa26SBarry Smith 
48681c3436cfSJed Brown    Level: beginner
48691c3436cfSJed Brown 
4870c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
48711c3436cfSJed Brown @*/
48721c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
48731c3436cfSJed Brown {
48741c3436cfSJed Brown   PetscErrorCode ierr;
48751c3436cfSJed Brown 
48761c3436cfSJed Brown   PetscFunctionBegin;
4877c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
48781c3436cfSJed Brown   if (vatol) {
48791c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
48801c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4881bbd56ea5SKarl Rupp 
48821c3436cfSJed Brown     ts->vatol = vatol;
48831c3436cfSJed Brown   }
4884c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
48851c3436cfSJed Brown   if (vrtol) {
48861c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
48871c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4888bbd56ea5SKarl Rupp 
48891c3436cfSJed Brown     ts->vrtol = vrtol;
48901c3436cfSJed Brown   }
48911c3436cfSJed Brown   PetscFunctionReturn(0);
48921c3436cfSJed Brown }
48931c3436cfSJed Brown 
48941c3436cfSJed Brown #undef __FUNCT__
4895c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4896c5033834SJed Brown /*@
4897c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4898c5033834SJed Brown 
4899c5033834SJed Brown    Logically Collective
4900c5033834SJed Brown 
4901c5033834SJed Brown    Input Arguments:
4902c5033834SJed Brown .  ts - time integration context
4903c5033834SJed Brown 
4904c5033834SJed Brown    Output Arguments:
49050298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
49060298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
49070298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
49080298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4909c5033834SJed Brown 
4910c5033834SJed Brown    Level: beginner
4911c5033834SJed Brown 
4912c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4913c5033834SJed Brown @*/
4914c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4915c5033834SJed Brown {
4916c5033834SJed Brown   PetscFunctionBegin;
4917c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4918c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4919c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4920c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4921c5033834SJed Brown   PetscFunctionReturn(0);
4922c5033834SJed Brown }
4923c5033834SJed Brown 
4924c5033834SJed Brown #undef __FUNCT__
49251c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
49261c3436cfSJed Brown /*@
49271c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
49281c3436cfSJed Brown 
49291c3436cfSJed Brown    Collective on TS
49301c3436cfSJed Brown 
49311c3436cfSJed Brown    Input Arguments:
49321c3436cfSJed Brown +  ts - time stepping context
49331c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
49341c3436cfSJed Brown 
49351c3436cfSJed Brown    Output Arguments:
49361c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
49371c3436cfSJed Brown 
49381c3436cfSJed Brown    Level: developer
49391c3436cfSJed Brown 
49401c3436cfSJed Brown .seealso: TSSetTolerances()
49411c3436cfSJed Brown @*/
49421c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
49431c3436cfSJed Brown {
49441c3436cfSJed Brown   PetscErrorCode    ierr;
49451c3436cfSJed Brown   PetscInt          i,n,N;
49460910c330SBarry Smith   const PetscScalar *u,*y;
49470910c330SBarry Smith   Vec               U;
49481c3436cfSJed Brown   PetscReal         sum,gsum;
49491c3436cfSJed Brown 
49501c3436cfSJed Brown   PetscFunctionBegin;
49511c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49521c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
49531c3436cfSJed Brown   PetscValidPointer(norm,3);
49540910c330SBarry Smith   U = ts->vec_sol;
49550910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
4956ce94432eSBarry Smith   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
49571c3436cfSJed Brown 
49580910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
49590910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
49600910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
49611c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
49621c3436cfSJed Brown   sum  = 0.;
4963ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
4964ceefc113SJed Brown     const PetscScalar *atol,*rtol;
4965ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4966ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4967ceefc113SJed Brown     for (i=0; i<n; i++) {
49680910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49690910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4970ceefc113SJed Brown     }
4971ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4972ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4973ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4974ceefc113SJed Brown     const PetscScalar *atol;
4975ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4976ceefc113SJed Brown     for (i=0; i<n; i++) {
49770910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49780910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4979ceefc113SJed Brown     }
4980ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4981ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4982ceefc113SJed Brown     const PetscScalar *rtol;
4983ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4984ceefc113SJed Brown     for (i=0; i<n; i++) {
49850910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49860910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4987ceefc113SJed Brown     }
4988ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4989ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
49901c3436cfSJed Brown     for (i=0; i<n; i++) {
49910910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49920910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
49931c3436cfSJed Brown     }
4994ceefc113SJed Brown   }
49950910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
49961c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
49971c3436cfSJed Brown 
4998ce94432eSBarry Smith   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
49991c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
5000620fc8aaSSatish Balay   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
50011c3436cfSJed Brown   PetscFunctionReturn(0);
50021c3436cfSJed Brown }
50031c3436cfSJed Brown 
50041c3436cfSJed Brown #undef __FUNCT__
50058d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
50068d59e960SJed Brown /*@
50078d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
50088d59e960SJed Brown 
50098d59e960SJed Brown    Logically Collective on TS
50108d59e960SJed Brown 
50118d59e960SJed Brown    Input Arguments:
50128d59e960SJed Brown +  ts - time stepping context
50138d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
50148d59e960SJed Brown 
50158d59e960SJed Brown    Note:
50168d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
50178d59e960SJed Brown 
50188d59e960SJed Brown    Level: intermediate
50198d59e960SJed Brown 
50208d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
50218d59e960SJed Brown @*/
50228d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
50238d59e960SJed Brown {
50248d59e960SJed Brown   PetscFunctionBegin;
50258d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50268d59e960SJed Brown   ts->cfltime_local = cfltime;
50278d59e960SJed Brown   ts->cfltime       = -1.;
50288d59e960SJed Brown   PetscFunctionReturn(0);
50298d59e960SJed Brown }
50308d59e960SJed Brown 
50318d59e960SJed Brown #undef __FUNCT__
50328d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
50338d59e960SJed Brown /*@
50348d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
50358d59e960SJed Brown 
50368d59e960SJed Brown    Collective on TS
50378d59e960SJed Brown 
50388d59e960SJed Brown    Input Arguments:
50398d59e960SJed Brown .  ts - time stepping context
50408d59e960SJed Brown 
50418d59e960SJed Brown    Output Arguments:
50428d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
50438d59e960SJed Brown 
50448d59e960SJed Brown    Level: advanced
50458d59e960SJed Brown 
50468d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
50478d59e960SJed Brown @*/
50488d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
50498d59e960SJed Brown {
50508d59e960SJed Brown   PetscErrorCode ierr;
50518d59e960SJed Brown 
50528d59e960SJed Brown   PetscFunctionBegin;
50538d59e960SJed Brown   if (ts->cfltime < 0) {
5054ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
50558d59e960SJed Brown   }
50568d59e960SJed Brown   *cfltime = ts->cfltime;
50578d59e960SJed Brown   PetscFunctionReturn(0);
50588d59e960SJed Brown }
50598d59e960SJed Brown 
50608d59e960SJed Brown #undef __FUNCT__
5061d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5062d6ebe24aSShri Abhyankar /*@
5063d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5064d6ebe24aSShri Abhyankar 
5065d6ebe24aSShri Abhyankar    Input Parameters:
5066d6ebe24aSShri Abhyankar .  ts   - the TS context.
5067d6ebe24aSShri Abhyankar .  xl   - lower bound.
5068d6ebe24aSShri Abhyankar .  xu   - upper bound.
5069d6ebe24aSShri Abhyankar 
5070d6ebe24aSShri Abhyankar    Notes:
5071d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5072e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5073d6ebe24aSShri Abhyankar 
50742bd2b0e6SSatish Balay    Level: advanced
50752bd2b0e6SSatish Balay 
5076d6ebe24aSShri Abhyankar @*/
5077d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5078d6ebe24aSShri Abhyankar {
5079d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5080d6ebe24aSShri Abhyankar   SNES           snes;
5081d6ebe24aSShri Abhyankar 
5082d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5083d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5084d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5085d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5086d6ebe24aSShri Abhyankar }
5087d6ebe24aSShri Abhyankar 
5088325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5089c6db04a5SJed Brown #include <mex.h>
5090325fc9f4SBarry Smith 
5091325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5092325fc9f4SBarry Smith 
5093325fc9f4SBarry Smith #undef __FUNCT__
5094325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5095325fc9f4SBarry Smith /*
5096325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5097325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5098325fc9f4SBarry Smith 
5099325fc9f4SBarry Smith    Collective on TS
5100325fc9f4SBarry Smith 
5101325fc9f4SBarry Smith    Input Parameters:
5102325fc9f4SBarry Smith +  snes - the TS context
51030910c330SBarry Smith -  u - input vector
5104325fc9f4SBarry Smith 
5105325fc9f4SBarry Smith    Output Parameter:
5106325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5107325fc9f4SBarry Smith 
5108325fc9f4SBarry Smith    Notes:
5109325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5110325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5111325fc9f4SBarry Smith    themselves.
5112325fc9f4SBarry Smith 
5113325fc9f4SBarry Smith    Level: developer
5114325fc9f4SBarry Smith 
5115325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5116325fc9f4SBarry Smith 
5117325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5118325fc9f4SBarry Smith */
51190910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5120325fc9f4SBarry Smith {
5121325fc9f4SBarry Smith   PetscErrorCode  ierr;
5122325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5123325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5124325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5125325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5126325fc9f4SBarry Smith 
5127325fc9f4SBarry Smith   PetscFunctionBegin;
5128325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
51290910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
51300910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5131325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
51320910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5133325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5134325fc9f4SBarry Smith 
5135325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
51360910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
51370910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
51380910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5139bbd56ea5SKarl Rupp 
5140325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5141325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5142325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5143325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5144325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5145325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5146325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5147325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5148325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5149325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5150325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5151325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5152325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5153325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5154325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5155325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5156325fc9f4SBarry Smith   PetscFunctionReturn(0);
5157325fc9f4SBarry Smith }
5158325fc9f4SBarry Smith 
5159325fc9f4SBarry Smith 
5160325fc9f4SBarry Smith #undef __FUNCT__
5161325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5162325fc9f4SBarry Smith /*
5163325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5164325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5165e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5166325fc9f4SBarry Smith 
5167325fc9f4SBarry Smith    Logically Collective on TS
5168325fc9f4SBarry Smith 
5169325fc9f4SBarry Smith    Input Parameters:
5170325fc9f4SBarry Smith +  ts - the TS context
5171325fc9f4SBarry Smith -  func - function evaluation routine
5172325fc9f4SBarry Smith 
5173325fc9f4SBarry Smith    Calling sequence of func:
51740910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5175325fc9f4SBarry Smith 
5176325fc9f4SBarry Smith    Level: beginner
5177325fc9f4SBarry Smith 
5178325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5179325fc9f4SBarry Smith 
5180325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5181325fc9f4SBarry Smith */
5182cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5183325fc9f4SBarry Smith {
5184325fc9f4SBarry Smith   PetscErrorCode  ierr;
5185325fc9f4SBarry Smith   TSMatlabContext *sctx;
5186325fc9f4SBarry Smith 
5187325fc9f4SBarry Smith   PetscFunctionBegin;
5188325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5189325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5190325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5191325fc9f4SBarry Smith   /*
5192325fc9f4SBarry Smith      This should work, but it doesn't
5193325fc9f4SBarry Smith   sctx->ctx = ctx;
5194325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5195325fc9f4SBarry Smith   */
5196325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5197bbd56ea5SKarl Rupp 
51980298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5199325fc9f4SBarry Smith   PetscFunctionReturn(0);
5200325fc9f4SBarry Smith }
5201325fc9f4SBarry Smith 
5202325fc9f4SBarry Smith #undef __FUNCT__
5203325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5204325fc9f4SBarry Smith /*
5205325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5206325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5207325fc9f4SBarry Smith 
5208325fc9f4SBarry Smith    Collective on TS
5209325fc9f4SBarry Smith 
5210325fc9f4SBarry Smith    Input Parameters:
5211cdcf91faSSean Farley +  ts - the TS context
52120910c330SBarry Smith .  u - input vector
5213325fc9f4SBarry Smith .  A, B - the matrices
5214325fc9f4SBarry Smith -  ctx - user context
5215325fc9f4SBarry Smith 
5216325fc9f4SBarry Smith    Level: developer
5217325fc9f4SBarry Smith 
5218325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5219325fc9f4SBarry Smith 
5220325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5221325fc9f4SBarry Smith @*/
5222f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5223325fc9f4SBarry Smith {
5224325fc9f4SBarry Smith   PetscErrorCode  ierr;
5225325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5226325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5227325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5228325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5229325fc9f4SBarry Smith 
5230325fc9f4SBarry Smith   PetscFunctionBegin;
5231cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52320910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5233325fc9f4SBarry Smith 
52340910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5235325fc9f4SBarry Smith 
5236cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
52370910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
52380910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
52390910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
52400910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5241bbd56ea5SKarl Rupp 
5242325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5243325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5244325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5245325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5246325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5247325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5248325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5249325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5250325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5251325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5252325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5253325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5254325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5255325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5256325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5257325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5258325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5259325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5260325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5261325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5262325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5263325fc9f4SBarry Smith   PetscFunctionReturn(0);
5264325fc9f4SBarry Smith }
5265325fc9f4SBarry Smith 
5266325fc9f4SBarry Smith 
5267325fc9f4SBarry Smith #undef __FUNCT__
5268325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5269325fc9f4SBarry Smith /*
5270325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5271e3c5b3baSBarry 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
5272325fc9f4SBarry Smith 
5273325fc9f4SBarry Smith    Logically Collective on TS
5274325fc9f4SBarry Smith 
5275325fc9f4SBarry Smith    Input Parameters:
5276cdcf91faSSean Farley +  ts - the TS context
5277325fc9f4SBarry Smith .  A,B - Jacobian matrices
5278325fc9f4SBarry Smith .  func - function evaluation routine
5279325fc9f4SBarry Smith -  ctx - user context
5280325fc9f4SBarry Smith 
5281325fc9f4SBarry Smith    Calling sequence of func:
52820910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5283325fc9f4SBarry Smith 
5284325fc9f4SBarry Smith 
5285325fc9f4SBarry Smith    Level: developer
5286325fc9f4SBarry Smith 
5287325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5288325fc9f4SBarry Smith 
5289325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5290325fc9f4SBarry Smith */
5291cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5292325fc9f4SBarry Smith {
5293325fc9f4SBarry Smith   PetscErrorCode  ierr;
5294325fc9f4SBarry Smith   TSMatlabContext *sctx;
5295325fc9f4SBarry Smith 
5296325fc9f4SBarry Smith   PetscFunctionBegin;
5297325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5298325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5299325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5300325fc9f4SBarry Smith   /*
5301325fc9f4SBarry Smith      This should work, but it doesn't
5302325fc9f4SBarry Smith   sctx->ctx = ctx;
5303325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5304325fc9f4SBarry Smith   */
5305325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5306bbd56ea5SKarl Rupp 
5307cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5308325fc9f4SBarry Smith   PetscFunctionReturn(0);
5309325fc9f4SBarry Smith }
5310325fc9f4SBarry Smith 
5311b5b1a830SBarry Smith #undef __FUNCT__
5312b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5313b5b1a830SBarry Smith /*
5314b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5315b5b1a830SBarry Smith 
5316b5b1a830SBarry Smith    Collective on TS
5317b5b1a830SBarry Smith 
5318b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5319b5b1a830SBarry Smith @*/
53200910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5321b5b1a830SBarry Smith {
5322b5b1a830SBarry Smith   PetscErrorCode  ierr;
5323b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5324a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5325b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5326b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5327b5b1a830SBarry Smith 
5328b5b1a830SBarry Smith   PetscFunctionBegin;
5329cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53300910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5331b5b1a830SBarry Smith 
5332cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
53330910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5334bbd56ea5SKarl Rupp 
5335b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5336b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5337b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5338b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5339b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5340b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5341b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5342b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5343b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5344b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5345b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5346b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5347b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5348b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5349b5b1a830SBarry Smith   PetscFunctionReturn(0);
5350b5b1a830SBarry Smith }
5351b5b1a830SBarry Smith 
5352b5b1a830SBarry Smith 
5353b5b1a830SBarry Smith #undef __FUNCT__
5354b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5355b5b1a830SBarry Smith /*
5356b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5357b5b1a830SBarry Smith 
5358b5b1a830SBarry Smith    Level: developer
5359b5b1a830SBarry Smith 
5360b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5361b5b1a830SBarry Smith 
5362b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5363b5b1a830SBarry Smith */
5364cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5365b5b1a830SBarry Smith {
5366b5b1a830SBarry Smith   PetscErrorCode  ierr;
5367b5b1a830SBarry Smith   TSMatlabContext *sctx;
5368b5b1a830SBarry Smith 
5369b5b1a830SBarry Smith   PetscFunctionBegin;
5370b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5371b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5372b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5373b5b1a830SBarry Smith   /*
5374b5b1a830SBarry Smith      This should work, but it doesn't
5375b5b1a830SBarry Smith   sctx->ctx = ctx;
5376b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5377b5b1a830SBarry Smith   */
5378b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5379bbd56ea5SKarl Rupp 
53800298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5381b5b1a830SBarry Smith   PetscFunctionReturn(0);
5382b5b1a830SBarry Smith }
5383325fc9f4SBarry Smith #endif
5384b3603a34SBarry Smith 
53850b039ecaSBarry Smith 
53860b039ecaSBarry Smith 
5387b3603a34SBarry Smith #undef __FUNCT__
53884f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5389b3603a34SBarry Smith /*@C
53904f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5391b3603a34SBarry Smith        in a time based line graph
5392b3603a34SBarry Smith 
5393b3603a34SBarry Smith    Collective on TS
5394b3603a34SBarry Smith 
5395b3603a34SBarry Smith    Input Parameters:
5396b3603a34SBarry Smith +  ts - the TS context
5397b3603a34SBarry Smith .  step - current time-step
5398b3603a34SBarry Smith .  ptime - current time
5399b3603a34SBarry Smith -  lg - a line graph object
5400b3603a34SBarry Smith 
5401b3603a34SBarry Smith    Level: intermediate
5402b3603a34SBarry Smith 
54030b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5404b3603a34SBarry Smith 
5405b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5406b3603a34SBarry Smith 
5407b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5408b3603a34SBarry Smith @*/
54090910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5410b3603a34SBarry Smith {
5411b3603a34SBarry Smith   PetscErrorCode    ierr;
54120b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5413b3603a34SBarry Smith   const PetscScalar *yy;
541458ff32f7SBarry Smith   PetscInt          dim;
5415b3603a34SBarry Smith 
5416b3603a34SBarry Smith   PetscFunctionBegin;
541758ff32f7SBarry Smith   if (!step) {
5418a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5419a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5420a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
54210910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
54220b039ecaSBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
54230b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
542458ff32f7SBarry Smith   }
54250910c330SBarry Smith   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
5426e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5427e3efe391SJed Brown   {
5428e3efe391SJed Brown     PetscReal *yreal;
5429e3efe391SJed Brown     PetscInt  i,n;
54300910c330SBarry Smith     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
5431785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5432e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
54330b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5434e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5435e3efe391SJed Brown   }
5436e3efe391SJed Brown #else
54370b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5438e3efe391SJed Brown #endif
54390910c330SBarry Smith   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
5440b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
54410b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
54423923b477SBarry Smith   }
5443b3603a34SBarry Smith   PetscFunctionReturn(0);
5444b3603a34SBarry Smith }
5445b3603a34SBarry Smith 
5446b3603a34SBarry Smith #undef __FUNCT__
54474f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
5448ef20d060SBarry Smith /*@C
54494f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
5450ef20d060SBarry Smith        in a time based line graph
5451ef20d060SBarry Smith 
5452ef20d060SBarry Smith    Collective on TS
5453ef20d060SBarry Smith 
5454ef20d060SBarry Smith    Input Parameters:
5455ef20d060SBarry Smith +  ts - the TS context
5456ef20d060SBarry Smith .  step - current time-step
5457ef20d060SBarry Smith .  ptime - current time
5458ef20d060SBarry Smith -  lg - a line graph object
5459ef20d060SBarry Smith 
5460ef20d060SBarry Smith    Level: intermediate
5461ef20d060SBarry Smith 
5462abd5a294SJed Brown    Notes:
5463abd5a294SJed Brown    Only for sequential solves.
5464abd5a294SJed Brown 
5465abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
5466abd5a294SJed Brown 
5467abd5a294SJed Brown    Options Database Keys:
54684f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
5469ef20d060SBarry Smith 
5470ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
5471ef20d060SBarry Smith 
5472abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5473ef20d060SBarry Smith @*/
54740910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5475ef20d060SBarry Smith {
5476ef20d060SBarry Smith   PetscErrorCode    ierr;
54770b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5478ef20d060SBarry Smith   const PetscScalar *yy;
5479ef20d060SBarry Smith   Vec               y;
5480a9f9c1f6SBarry Smith   PetscInt          dim;
5481ef20d060SBarry Smith 
5482ef20d060SBarry Smith   PetscFunctionBegin;
5483a9f9c1f6SBarry Smith   if (!step) {
5484a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5485a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
54861ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
54870910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5488a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5489a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5490a9f9c1f6SBarry Smith   }
54910910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5492ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
54930910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5494ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5495e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5496e3efe391SJed Brown   {
5497e3efe391SJed Brown     PetscReal *yreal;
5498e3efe391SJed Brown     PetscInt  i,n;
5499e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5500785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5501e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
55020b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5503e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5504e3efe391SJed Brown   }
5505e3efe391SJed Brown #else
55060b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5507e3efe391SJed Brown #endif
5508ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5509ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
5510b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
55110b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
55123923b477SBarry Smith   }
5513ef20d060SBarry Smith   PetscFunctionReturn(0);
5514ef20d060SBarry Smith }
5515ef20d060SBarry Smith 
5516201da799SBarry Smith #undef __FUNCT__
5517201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
5518201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5519201da799SBarry Smith {
5520201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5521201da799SBarry Smith   PetscReal      x   = ptime,y;
5522201da799SBarry Smith   PetscErrorCode ierr;
5523201da799SBarry Smith   PetscInt       its;
5524201da799SBarry Smith 
5525201da799SBarry Smith   PetscFunctionBegin;
5526201da799SBarry Smith   if (!n) {
5527201da799SBarry Smith     PetscDrawAxis axis;
5528bbd56ea5SKarl Rupp 
5529201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5530201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5531201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5532bbd56ea5SKarl Rupp 
5533201da799SBarry Smith     ctx->snes_its = 0;
5534201da799SBarry Smith   }
5535201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5536201da799SBarry Smith   y    = its - ctx->snes_its;
5537201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
55383fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5539201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5540201da799SBarry Smith   }
5541201da799SBarry Smith   ctx->snes_its = its;
5542201da799SBarry Smith   PetscFunctionReturn(0);
5543201da799SBarry Smith }
5544201da799SBarry Smith 
5545201da799SBarry Smith #undef __FUNCT__
5546201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
5547201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5548201da799SBarry Smith {
5549201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5550201da799SBarry Smith   PetscReal      x   = ptime,y;
5551201da799SBarry Smith   PetscErrorCode ierr;
5552201da799SBarry Smith   PetscInt       its;
5553201da799SBarry Smith 
5554201da799SBarry Smith   PetscFunctionBegin;
5555201da799SBarry Smith   if (!n) {
5556201da799SBarry Smith     PetscDrawAxis axis;
5557bbd56ea5SKarl Rupp 
5558201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5559201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
5560201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5561bbd56ea5SKarl Rupp 
5562201da799SBarry Smith     ctx->ksp_its = 0;
5563201da799SBarry Smith   }
5564201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
5565201da799SBarry Smith   y    = its - ctx->ksp_its;
5566201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
556799fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5568201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5569201da799SBarry Smith   }
5570201da799SBarry Smith   ctx->ksp_its = its;
5571201da799SBarry Smith   PetscFunctionReturn(0);
5572201da799SBarry Smith }
5573f9c1d6abSBarry Smith 
5574f9c1d6abSBarry Smith #undef __FUNCT__
5575f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
5576f9c1d6abSBarry Smith /*@
5577f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
5578f9c1d6abSBarry Smith 
5579f9c1d6abSBarry Smith    Collective on TS and Vec
5580f9c1d6abSBarry Smith 
5581f9c1d6abSBarry Smith    Input Parameters:
5582f9c1d6abSBarry Smith +  ts - the TS context
5583f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
5584f9c1d6abSBarry Smith 
5585f9c1d6abSBarry Smith    Output Parameters:
5586f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
5587f9c1d6abSBarry Smith 
5588f9c1d6abSBarry Smith    Level: developer
5589f9c1d6abSBarry Smith 
5590f9c1d6abSBarry Smith .keywords: TS, compute
5591f9c1d6abSBarry Smith 
5592f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
5593f9c1d6abSBarry Smith @*/
5594f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5595f9c1d6abSBarry Smith {
5596f9c1d6abSBarry Smith   PetscErrorCode ierr;
5597f9c1d6abSBarry Smith 
5598f9c1d6abSBarry Smith   PetscFunctionBegin;
5599f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5600ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5601f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
5602f9c1d6abSBarry Smith   PetscFunctionReturn(0);
5603f9c1d6abSBarry Smith }
560424655328SShri 
560524655328SShri #undef __FUNCT__
560624655328SShri #define __FUNCT__ "TSRollBack"
560724655328SShri /*@
560824655328SShri    TSRollBack - Rolls back one time step
560924655328SShri 
561024655328SShri    Collective on TS
561124655328SShri 
561224655328SShri    Input Parameter:
561324655328SShri .  ts - the TS context obtained from TSCreate()
561424655328SShri 
561524655328SShri    Level: advanced
561624655328SShri 
561724655328SShri .keywords: TS, timestep, rollback
561824655328SShri 
561924655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
562024655328SShri @*/
562124655328SShri PetscErrorCode  TSRollBack(TS ts)
562224655328SShri {
562324655328SShri   PetscErrorCode ierr;
562424655328SShri 
562524655328SShri   PetscFunctionBegin;
562624655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
562724655328SShri 
562824655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
562924655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
563024655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
563124655328SShri   ts->ptime = ts->ptime_prev;
563224655328SShri   PetscFunctionReturn(0);
563324655328SShri }
5634aeb4809dSShri Abhyankar 
5635ff22ae23SHong Zhang #undef __FUNCT__
5636ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
5637ff22ae23SHong Zhang /*@
5638ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
5639ff22ae23SHong Zhang 
5640ff22ae23SHong Zhang    Input Parameter:
5641ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
5642ff22ae23SHong Zhang 
5643ff22ae23SHong Zhang    Level: advanced
5644ff22ae23SHong Zhang 
5645ff22ae23SHong Zhang .keywords: TS, getstages
5646ff22ae23SHong Zhang 
5647ff22ae23SHong Zhang .seealso: TSCreate()
5648ff22ae23SHong Zhang @*/
5649ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
5650ff22ae23SHong Zhang {
5651ff22ae23SHong Zhang   PetscErrorCode ierr;
5652ff22ae23SHong Zhang 
5653ff22ae23SHong Zhang   PetscFunctionBegin;
5654ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5655ff22ae23SHong Zhang   PetscValidPointer(ns,2);
5656ff22ae23SHong Zhang 
5657ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
5658ff22ae23SHong Zhang   else {
5659ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
5660ff22ae23SHong Zhang   }
5661ff22ae23SHong Zhang   PetscFunctionReturn(0);
5662ff22ae23SHong Zhang }
5663ff22ae23SHong Zhang 
5664ff22ae23SHong Zhang 
5665ff22ae23SHong Zhang 
5666