xref: /petsc/src/ts/interface/ts.c (revision 36eaed6031a7ace58dd4c426e7f3639d29c7df42)
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__
377d2daff3dSHong Zhang #define __FUNCT__ "TSSetReverseMode"
378d2daff3dSHong Zhang /*@
379e6ad8bfbSHong Zhang    TSSetReverseMode - Allows one to reset the run mode,
380d2daff3dSHong Zhang    useful for adjoint sensitivity analysis.
381d2daff3dSHong Zhang 
382d2daff3dSHong Zhang    Collective on TS
383d2daff3dSHong Zhang 
384d2daff3dSHong Zhang    Input Parameters:
385d2daff3dSHong Zhang +  ts - the TS context obtained from TSCreate()
386d2daff3dSHong Zhang -  reverse_mode - run in forward (default) or reverse mode
387d2daff3dSHong Zhang 
388d2daff3dSHong Zhang    Level: intermediate
389d2daff3dSHong Zhang 
390d2daff3dSHong Zhang .seealso:
391d2daff3dSHong Zhang 
392d2daff3dSHong Zhang .keywords: TS, set, reverse
393d2daff3dSHong Zhang @*/
394d2daff3dSHong Zhang PetscErrorCode  TSSetReverseMode(TS ts,PetscBool reverse_mode)
395d2daff3dSHong Zhang {
396f8fee759SHong Zhang   PetscErrorCode ierr;
397d2daff3dSHong Zhang   PetscFunctionBegin;
398d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
399d2daff3dSHong Zhang   ts->reverse_mode = reverse_mode;
400f8fee759SHong Zhang   ts->setupcalled  = PETSC_FALSE;
401f8fee759SHong Zhang   ierr = TSSetUp(ts);CHKERRQ(ierr);
402d2daff3dSHong Zhang   PetscFunctionReturn(0);
403d2daff3dSHong Zhang }
404d2daff3dSHong Zhang 
405a7a1495cSBarry Smith #undef __FUNCT__
406a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
407a7a1495cSBarry Smith /*@
408a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
409a7a1495cSBarry Smith       set with TSSetRHSJacobian().
410a7a1495cSBarry Smith 
411a7a1495cSBarry Smith    Collective on TS and Vec
412a7a1495cSBarry Smith 
413a7a1495cSBarry Smith    Input Parameters:
414316643e7SJed Brown +  ts - the TS context
415a7a1495cSBarry Smith .  t - current timestep
4160910c330SBarry Smith -  U - input vector
417a7a1495cSBarry Smith 
418a7a1495cSBarry Smith    Output Parameters:
419a7a1495cSBarry Smith +  A - Jacobian matrix
420a7a1495cSBarry Smith .  B - optional preconditioning matrix
421a7a1495cSBarry Smith -  flag - flag indicating matrix structure
422a7a1495cSBarry Smith 
423a7a1495cSBarry Smith    Notes:
424a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
425a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
426a7a1495cSBarry Smith 
42794b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
428a7a1495cSBarry Smith    flag parameter.
429a7a1495cSBarry Smith 
430a7a1495cSBarry Smith    Level: developer
431a7a1495cSBarry Smith 
432a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
433a7a1495cSBarry Smith 
43494b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
435a7a1495cSBarry Smith @*/
436d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
437a7a1495cSBarry Smith {
438dfbe8321SBarry Smith   PetscErrorCode ierr;
439270bf2e7SJed Brown   PetscObjectState Ustate;
44024989b8cSPeter Brune   DM             dm;
441942e3340SBarry Smith   DMTS           tsdm;
44224989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
44324989b8cSPeter Brune   void           *ctx;
44424989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
445a7a1495cSBarry Smith 
446a7a1495cSBarry Smith   PetscFunctionBegin;
4470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4480910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4490910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
45024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
451942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
45224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4530298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
45459e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
4550910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4560e4ef248SJed Brown     PetscFunctionReturn(0);
457f8ede8e7SJed Brown   }
458d90be118SSean Farley 
459ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
460d90be118SSean Farley 
461e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
46294ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
46394ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
46494ab13aaSBarry Smith     if (A != B) {
46594ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
46694ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
467e1244c69SJed Brown     }
468e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
469e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
470e1244c69SJed Brown   }
471e1244c69SJed Brown 
47224989b8cSPeter Brune   if (rhsjacobianfunc) {
47394ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
474a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
475d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
476a7a1495cSBarry Smith     PetscStackPop;
47794ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
478a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
47994ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
48094ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
481ef66eb69SBarry Smith   } else {
48294ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
48394ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
484ef66eb69SBarry Smith   }
4850e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4860910c330SBarry Smith   ts->rhsjacobian.X          = U;
48759e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
488a7a1495cSBarry Smith   PetscFunctionReturn(0);
489a7a1495cSBarry Smith }
490a7a1495cSBarry Smith 
4914a2ae208SSatish Balay #undef __FUNCT__
4924a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
493316643e7SJed Brown /*@
494d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
495d763cef2SBarry Smith 
496316643e7SJed Brown    Collective on TS and Vec
497316643e7SJed Brown 
498316643e7SJed Brown    Input Parameters:
499316643e7SJed Brown +  ts - the TS context
500316643e7SJed Brown .  t - current time
5010910c330SBarry Smith -  U - state vector
502316643e7SJed Brown 
503316643e7SJed Brown    Output Parameter:
504316643e7SJed Brown .  y - right hand side
505316643e7SJed Brown 
506316643e7SJed Brown    Note:
507316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
508316643e7SJed Brown    is used internally within the nonlinear solvers.
509316643e7SJed Brown 
510316643e7SJed Brown    Level: developer
511316643e7SJed Brown 
512316643e7SJed Brown .keywords: TS, compute
513316643e7SJed Brown 
514316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
515316643e7SJed Brown @*/
5160910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
517d763cef2SBarry Smith {
518dfbe8321SBarry Smith   PetscErrorCode ierr;
51924989b8cSPeter Brune   TSRHSFunction  rhsfunction;
52024989b8cSPeter Brune   TSIFunction    ifunction;
52124989b8cSPeter Brune   void           *ctx;
52224989b8cSPeter Brune   DM             dm;
52324989b8cSPeter Brune 
524d763cef2SBarry Smith   PetscFunctionBegin;
5250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5260910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5270700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
52824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
52924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5300298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
531d763cef2SBarry Smith 
532ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
533d763cef2SBarry Smith 
5340910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
53524989b8cSPeter Brune   if (rhsfunction) {
536d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5370910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
538d763cef2SBarry Smith     PetscStackPop;
539214bc6a2SJed Brown   } else {
540214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
541b2cd27e8SJed Brown   }
54244a41b28SSean Farley 
5430910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
544d763cef2SBarry Smith   PetscFunctionReturn(0);
545d763cef2SBarry Smith }
546d763cef2SBarry Smith 
5474a2ae208SSatish Balay #undef __FUNCT__
548ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
549ef20d060SBarry Smith /*@
550ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
551ef20d060SBarry Smith 
552ef20d060SBarry Smith    Collective on TS and Vec
553ef20d060SBarry Smith 
554ef20d060SBarry Smith    Input Parameters:
555ef20d060SBarry Smith +  ts - the TS context
556ef20d060SBarry Smith -  t - current time
557ef20d060SBarry Smith 
558ef20d060SBarry Smith    Output Parameter:
5590910c330SBarry Smith .  U - the solution
560ef20d060SBarry Smith 
561ef20d060SBarry Smith    Note:
562ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
563ef20d060SBarry Smith    is used internally within the nonlinear solvers.
564ef20d060SBarry Smith 
565ef20d060SBarry Smith    Level: developer
566ef20d060SBarry Smith 
567ef20d060SBarry Smith .keywords: TS, compute
568ef20d060SBarry Smith 
569abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
570ef20d060SBarry Smith @*/
5710910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
572ef20d060SBarry Smith {
573ef20d060SBarry Smith   PetscErrorCode     ierr;
574ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
575ef20d060SBarry Smith   void               *ctx;
576ef20d060SBarry Smith   DM                 dm;
577ef20d060SBarry Smith 
578ef20d060SBarry Smith   PetscFunctionBegin;
579ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5800910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
581ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
582ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
583ef20d060SBarry Smith 
584ef20d060SBarry Smith   if (solutionfunction) {
5859b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5860910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
587ef20d060SBarry Smith     PetscStackPop;
588ef20d060SBarry Smith   }
589ef20d060SBarry Smith   PetscFunctionReturn(0);
590ef20d060SBarry Smith }
5919b7cd975SBarry Smith #undef __FUNCT__
5929b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5939b7cd975SBarry Smith /*@
5949b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5959b7cd975SBarry Smith 
5969b7cd975SBarry Smith    Collective on TS and Vec
5979b7cd975SBarry Smith 
5989b7cd975SBarry Smith    Input Parameters:
5999b7cd975SBarry Smith +  ts - the TS context
6009b7cd975SBarry Smith -  t - current time
6019b7cd975SBarry Smith 
6029b7cd975SBarry Smith    Output Parameter:
6039b7cd975SBarry Smith .  U - the function value
6049b7cd975SBarry Smith 
6059b7cd975SBarry Smith    Note:
6069b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6079b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6089b7cd975SBarry Smith 
6099b7cd975SBarry Smith    Level: developer
6109b7cd975SBarry Smith 
6119b7cd975SBarry Smith .keywords: TS, compute
6129b7cd975SBarry Smith 
6139b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6149b7cd975SBarry Smith @*/
6159b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
6169b7cd975SBarry Smith {
6179b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
6189b7cd975SBarry Smith   void               *ctx;
6199b7cd975SBarry Smith   DM                 dm;
6209b7cd975SBarry Smith 
6219b7cd975SBarry Smith   PetscFunctionBegin;
6229b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6239b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6249b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6259b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6269b7cd975SBarry Smith 
6279b7cd975SBarry Smith   if (forcing) {
6289b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6299b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6309b7cd975SBarry Smith     PetscStackPop;
6319b7cd975SBarry Smith   }
6329b7cd975SBarry Smith   PetscFunctionReturn(0);
6339b7cd975SBarry Smith }
634ef20d060SBarry Smith 
635ef20d060SBarry Smith #undef __FUNCT__
636214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
637214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
638214bc6a2SJed Brown {
6392dd45cf8SJed Brown   Vec            F;
640214bc6a2SJed Brown   PetscErrorCode ierr;
641214bc6a2SJed Brown 
642214bc6a2SJed Brown   PetscFunctionBegin;
6430298fd71SBarry Smith   *Frhs = NULL;
6440298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
645214bc6a2SJed Brown   if (!ts->Frhs) {
6462dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
647214bc6a2SJed Brown   }
648214bc6a2SJed Brown   *Frhs = ts->Frhs;
649214bc6a2SJed Brown   PetscFunctionReturn(0);
650214bc6a2SJed Brown }
651214bc6a2SJed Brown 
652214bc6a2SJed Brown #undef __FUNCT__
653214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
654214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
655214bc6a2SJed Brown {
656214bc6a2SJed Brown   Mat            A,B;
6572dd45cf8SJed Brown   PetscErrorCode ierr;
658214bc6a2SJed Brown 
659214bc6a2SJed Brown   PetscFunctionBegin;
660c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
661c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6620298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
663214bc6a2SJed Brown   if (Arhs) {
664214bc6a2SJed Brown     if (!ts->Arhs) {
665214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
666214bc6a2SJed Brown     }
667214bc6a2SJed Brown     *Arhs = ts->Arhs;
668214bc6a2SJed Brown   }
669214bc6a2SJed Brown   if (Brhs) {
670214bc6a2SJed Brown     if (!ts->Brhs) {
671bdb70873SJed Brown       if (A != B) {
672214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
673bdb70873SJed Brown       } else {
674bdb70873SJed Brown         ts->Brhs = ts->Arhs;
675bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
676bdb70873SJed Brown       }
677214bc6a2SJed Brown     }
678214bc6a2SJed Brown     *Brhs = ts->Brhs;
679214bc6a2SJed Brown   }
680214bc6a2SJed Brown   PetscFunctionReturn(0);
681214bc6a2SJed Brown }
682214bc6a2SJed Brown 
683214bc6a2SJed Brown #undef __FUNCT__
684316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
685316643e7SJed Brown /*@
6860910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
687316643e7SJed Brown 
688316643e7SJed Brown    Collective on TS and Vec
689316643e7SJed Brown 
690316643e7SJed Brown    Input Parameters:
691316643e7SJed Brown +  ts - the TS context
692316643e7SJed Brown .  t - current time
6930910c330SBarry Smith .  U - state vector
6940910c330SBarry Smith .  Udot - time derivative of state vector
695214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
696316643e7SJed Brown 
697316643e7SJed Brown    Output Parameter:
698316643e7SJed Brown .  Y - right hand side
699316643e7SJed Brown 
700316643e7SJed Brown    Note:
701316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
702316643e7SJed Brown    is used internally within the nonlinear solvers.
703316643e7SJed Brown 
704316643e7SJed Brown    If the user did did not write their equations in implicit form, this
705316643e7SJed Brown    function recasts them in implicit form.
706316643e7SJed Brown 
707316643e7SJed Brown    Level: developer
708316643e7SJed Brown 
709316643e7SJed Brown .keywords: TS, compute
710316643e7SJed Brown 
711316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
712316643e7SJed Brown @*/
7130910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
714316643e7SJed Brown {
715316643e7SJed Brown   PetscErrorCode ierr;
71624989b8cSPeter Brune   TSIFunction    ifunction;
71724989b8cSPeter Brune   TSRHSFunction  rhsfunction;
71824989b8cSPeter Brune   void           *ctx;
71924989b8cSPeter Brune   DM             dm;
720316643e7SJed Brown 
721316643e7SJed Brown   PetscFunctionBegin;
7220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7230910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7240910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7250700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
726316643e7SJed Brown 
72724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
72824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7290298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
73024989b8cSPeter Brune 
731ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
732d90be118SSean Farley 
7330910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
73424989b8cSPeter Brune   if (ifunction) {
735316643e7SJed Brown     PetscStackPush("TS user implicit function");
7360910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
737316643e7SJed Brown     PetscStackPop;
738214bc6a2SJed Brown   }
739214bc6a2SJed Brown   if (imex) {
74024989b8cSPeter Brune     if (!ifunction) {
7410910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7422dd45cf8SJed Brown     }
74324989b8cSPeter Brune   } else if (rhsfunction) {
74424989b8cSPeter Brune     if (ifunction) {
745214bc6a2SJed Brown       Vec Frhs;
746214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7470910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
748214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7492dd45cf8SJed Brown     } else {
7500910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7510910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
752316643e7SJed Brown     }
7534a6899ffSJed Brown   }
7540910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
755316643e7SJed Brown   PetscFunctionReturn(0);
756316643e7SJed Brown }
757316643e7SJed Brown 
758316643e7SJed Brown #undef __FUNCT__
759316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
760316643e7SJed Brown /*@
761316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
762316643e7SJed Brown 
763316643e7SJed Brown    Collective on TS and Vec
764316643e7SJed Brown 
765316643e7SJed Brown    Input
766316643e7SJed Brown       Input Parameters:
767316643e7SJed Brown +  ts - the TS context
768316643e7SJed Brown .  t - current timestep
7690910c330SBarry Smith .  U - state vector
7700910c330SBarry Smith .  Udot - time derivative of state vector
771214bc6a2SJed Brown .  shift - shift to apply, see note below
772214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
773316643e7SJed Brown 
774316643e7SJed Brown    Output Parameters:
775316643e7SJed Brown +  A - Jacobian matrix
776316643e7SJed Brown .  B - optional preconditioning matrix
777316643e7SJed Brown -  flag - flag indicating matrix structure
778316643e7SJed Brown 
779316643e7SJed Brown    Notes:
7800910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
781316643e7SJed Brown 
7820910c330SBarry Smith    dF/dU + shift*dF/dUdot
783316643e7SJed Brown 
784316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
785316643e7SJed Brown    is used internally within the nonlinear solvers.
786316643e7SJed Brown 
787316643e7SJed Brown    Level: developer
788316643e7SJed Brown 
789316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
790316643e7SJed Brown 
791316643e7SJed Brown .seealso:  TSSetIJacobian()
79263495f91SJed Brown @*/
793d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
794316643e7SJed Brown {
795316643e7SJed Brown   PetscErrorCode ierr;
79624989b8cSPeter Brune   TSIJacobian    ijacobian;
79724989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
79824989b8cSPeter Brune   DM             dm;
79924989b8cSPeter Brune   void           *ctx;
800316643e7SJed Brown 
801316643e7SJed Brown   PetscFunctionBegin;
8020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8030910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8040910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
805316643e7SJed Brown   PetscValidPointer(A,6);
80694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
807316643e7SJed Brown   PetscValidPointer(B,7);
80894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
80924989b8cSPeter Brune 
81024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
81124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8120298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
81324989b8cSPeter Brune 
814ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
815316643e7SJed Brown 
81694ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
81724989b8cSPeter Brune   if (ijacobian) {
818316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
819d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
820316643e7SJed Brown     PetscStackPop;
821214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
82294ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
82394ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8244a6899ffSJed Brown   }
825214bc6a2SJed Brown   if (imex) {
826b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
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);
832214bc6a2SJed Brown       }
833214bc6a2SJed Brown     }
834214bc6a2SJed Brown   } else {
835e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
836e1244c69SJed Brown     if (rhsjacobian) {
837bd373395SBarry Smith       if (ijacobian) {
838e1244c69SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
839bd373395SBarry Smith       } else {
840bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
841e1244c69SJed Brown       }
842d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
843e1244c69SJed Brown     }
84494ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
845e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
846e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
84794ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
84894ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
84994ab13aaSBarry Smith       if (A != B) {
85094ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
85194ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
852316643e7SJed Brown       }
853e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
854e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
855e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
85694ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
85794ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
85894ab13aaSBarry Smith         if (A != B) {
85994ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
86094ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
861e1244c69SJed Brown         }
862e1244c69SJed Brown       }
86394ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
86494ab13aaSBarry Smith       if (A != B) {
86594ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
866214bc6a2SJed Brown       }
867316643e7SJed Brown     }
868316643e7SJed Brown   }
86994ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
870316643e7SJed Brown   PetscFunctionReturn(0);
871316643e7SJed Brown }
872316643e7SJed Brown 
873316643e7SJed Brown #undef __FUNCT__
8744a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
875d763cef2SBarry Smith /*@C
876d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
877b5abc632SBarry Smith     where U_t = G(t,u).
878d763cef2SBarry Smith 
8793f9fe445SBarry Smith     Logically Collective on TS
880d763cef2SBarry Smith 
881d763cef2SBarry Smith     Input Parameters:
882d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8830298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
884d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
885d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8860298fd71SBarry Smith           function evaluation routine (may be NULL)
887d763cef2SBarry Smith 
888d763cef2SBarry Smith     Calling sequence of func:
88987828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
890d763cef2SBarry Smith 
891d763cef2SBarry Smith +   t - current timestep
892d763cef2SBarry Smith .   u - input vector
893d763cef2SBarry Smith .   F - function vector
894d763cef2SBarry Smith -   ctx - [optional] user-defined function context
895d763cef2SBarry Smith 
896d763cef2SBarry Smith     Level: beginner
897d763cef2SBarry Smith 
898d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
899d763cef2SBarry Smith 
900ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
901d763cef2SBarry Smith @*/
902089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
903d763cef2SBarry Smith {
904089b2837SJed Brown   PetscErrorCode ierr;
905089b2837SJed Brown   SNES           snes;
9060298fd71SBarry Smith   Vec            ralloc = NULL;
90724989b8cSPeter Brune   DM             dm;
908d763cef2SBarry Smith 
909089b2837SJed Brown   PetscFunctionBegin;
9100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
911ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
91224989b8cSPeter Brune 
91324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91424989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
915089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
916e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
917e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
918e856ceecSJed Brown     r    = ralloc;
919e856ceecSJed Brown   }
920089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
921e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
922d763cef2SBarry Smith   PetscFunctionReturn(0);
923d763cef2SBarry Smith }
924d763cef2SBarry Smith 
9254a2ae208SSatish Balay #undef __FUNCT__
926ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
927ef20d060SBarry Smith /*@C
928abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
929ef20d060SBarry Smith 
930ef20d060SBarry Smith     Logically Collective on TS
931ef20d060SBarry Smith 
932ef20d060SBarry Smith     Input Parameters:
933ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
934ef20d060SBarry Smith .   f - routine for evaluating the solution
935ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9360298fd71SBarry Smith           function evaluation routine (may be NULL)
937ef20d060SBarry Smith 
938ef20d060SBarry Smith     Calling sequence of func:
939ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
940ef20d060SBarry Smith 
941ef20d060SBarry Smith +   t - current timestep
942ef20d060SBarry Smith .   u - output vector
943ef20d060SBarry Smith -   ctx - [optional] user-defined function context
944ef20d060SBarry Smith 
945abd5a294SJed Brown     Notes:
946abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
947abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
948abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
949abd5a294SJed Brown 
9504f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
951abd5a294SJed Brown 
952ef20d060SBarry Smith     Level: beginner
953ef20d060SBarry Smith 
954ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
955ef20d060SBarry Smith 
9569b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
957ef20d060SBarry Smith @*/
958ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
959ef20d060SBarry Smith {
960ef20d060SBarry Smith   PetscErrorCode ierr;
961ef20d060SBarry Smith   DM             dm;
962ef20d060SBarry Smith 
963ef20d060SBarry Smith   PetscFunctionBegin;
964ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
965ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
966ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
967ef20d060SBarry Smith   PetscFunctionReturn(0);
968ef20d060SBarry Smith }
969ef20d060SBarry Smith 
970ef20d060SBarry Smith #undef __FUNCT__
9719b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9729b7cd975SBarry Smith /*@C
9739b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9749b7cd975SBarry Smith 
9759b7cd975SBarry Smith     Logically Collective on TS
9769b7cd975SBarry Smith 
9779b7cd975SBarry Smith     Input Parameters:
9789b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9799b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9809b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9810298fd71SBarry Smith           function evaluation routine (may be NULL)
9829b7cd975SBarry Smith 
9839b7cd975SBarry Smith     Calling sequence of func:
9849b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9859b7cd975SBarry Smith 
9869b7cd975SBarry Smith +   t - current timestep
9879b7cd975SBarry Smith .   u - output vector
9889b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9899b7cd975SBarry Smith 
9909b7cd975SBarry Smith     Notes:
9919b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9929b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9939b7cd975SBarry Smith 
9949b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9959b7cd975SBarry Smith 
9969b7cd975SBarry Smith     Level: beginner
9979b7cd975SBarry Smith 
9989b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9999b7cd975SBarry Smith 
10009b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10019b7cd975SBarry Smith @*/
10029b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
10039b7cd975SBarry Smith {
10049b7cd975SBarry Smith   PetscErrorCode ierr;
10059b7cd975SBarry Smith   DM             dm;
10069b7cd975SBarry Smith 
10079b7cd975SBarry Smith   PetscFunctionBegin;
10089b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10099b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
10109b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
10119b7cd975SBarry Smith   PetscFunctionReturn(0);
10129b7cd975SBarry Smith }
10139b7cd975SBarry Smith 
10149b7cd975SBarry Smith #undef __FUNCT__
10154a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1016d763cef2SBarry Smith /*@C
1017d763cef2SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of F,
1018b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1019d763cef2SBarry Smith 
10203f9fe445SBarry Smith    Logically Collective on TS
1021d763cef2SBarry Smith 
1022d763cef2SBarry Smith    Input Parameters:
1023d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1024e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1025e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1026d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1027d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10280298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1029d763cef2SBarry Smith 
1030d763cef2SBarry Smith    Calling sequence of func:
1031ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1032d763cef2SBarry Smith 
1033d763cef2SBarry Smith +  t - current timestep
1034d763cef2SBarry Smith .  u - input vector
1035e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1036e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1037d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1038d763cef2SBarry Smith 
1039d763cef2SBarry Smith 
1040d763cef2SBarry Smith    Level: beginner
1041d763cef2SBarry Smith 
1042d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1043d763cef2SBarry Smith 
1044ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1045d763cef2SBarry Smith 
1046d763cef2SBarry Smith @*/
1047e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1048d763cef2SBarry Smith {
1049277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1050089b2837SJed Brown   SNES           snes;
105124989b8cSPeter Brune   DM             dm;
105224989b8cSPeter Brune   TSIJacobian    ijacobian;
1053277b19d0SLisandro Dalcin 
1054d763cef2SBarry Smith   PetscFunctionBegin;
10550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1056e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1057e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1058e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1059e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1060d763cef2SBarry Smith 
106124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
106224989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1063e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1064e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1065e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1066e1244c69SJed Brown   }
10670298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1068089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10695f659677SPeter Brune   if (!ijacobian) {
1070e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10710e4ef248SJed Brown   }
1072e5d3d808SBarry Smith   if (Amat) {
1073e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10740e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1075bbd56ea5SKarl Rupp 
1076e5d3d808SBarry Smith     ts->Arhs = Amat;
10770e4ef248SJed Brown   }
1078e5d3d808SBarry Smith   if (Pmat) {
1079e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10800e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1081bbd56ea5SKarl Rupp 
1082e5d3d808SBarry Smith     ts->Brhs = Pmat;
10830e4ef248SJed Brown   }
1084d763cef2SBarry Smith   PetscFunctionReturn(0);
1085d763cef2SBarry Smith }
1086d763cef2SBarry Smith 
1087316643e7SJed Brown 
1088316643e7SJed Brown #undef __FUNCT__
1089316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1090316643e7SJed Brown /*@C
1091b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1092316643e7SJed Brown 
10933f9fe445SBarry Smith    Logically Collective on TS
1094316643e7SJed Brown 
1095316643e7SJed Brown    Input Parameters:
1096316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10970298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1098316643e7SJed Brown .  f   - the function evaluation routine
10990298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1100316643e7SJed Brown 
1101316643e7SJed Brown    Calling sequence of f:
1102316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1103316643e7SJed Brown 
1104316643e7SJed Brown +  t   - time at step/stage being solved
1105316643e7SJed Brown .  u   - state vector
1106316643e7SJed Brown .  u_t - time derivative of state vector
1107316643e7SJed Brown .  F   - function vector
1108316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1109316643e7SJed Brown 
1110316643e7SJed Brown    Important:
1111d6cbdb99SBarry Smith    The user MUST call either this routine, TSSetRHSFunction().  This routine must be used when not solving an ODE, for example a DAE.
1112316643e7SJed Brown 
1113316643e7SJed Brown    Level: beginner
1114316643e7SJed Brown 
1115316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1116316643e7SJed Brown 
1117d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1118316643e7SJed Brown @*/
1119089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1120316643e7SJed Brown {
1121089b2837SJed Brown   PetscErrorCode ierr;
1122089b2837SJed Brown   SNES           snes;
11230298fd71SBarry Smith   Vec            resalloc = NULL;
112424989b8cSPeter Brune   DM             dm;
1125316643e7SJed Brown 
1126316643e7SJed Brown   PetscFunctionBegin;
11270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1128ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
112924989b8cSPeter Brune 
113024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
113124989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
113224989b8cSPeter Brune 
1133089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1134e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1135e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1136e856ceecSJed Brown     res  = resalloc;
1137e856ceecSJed Brown   }
1138089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1139e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1140089b2837SJed Brown   PetscFunctionReturn(0);
1141089b2837SJed Brown }
1142089b2837SJed Brown 
1143089b2837SJed Brown #undef __FUNCT__
1144089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1145089b2837SJed Brown /*@C
1146089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1147089b2837SJed Brown 
1148089b2837SJed Brown    Not Collective
1149089b2837SJed Brown 
1150089b2837SJed Brown    Input Parameter:
1151089b2837SJed Brown .  ts - the TS context
1152089b2837SJed Brown 
1153089b2837SJed Brown    Output Parameter:
11540298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11550298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11560298fd71SBarry Smith -  ctx - the function context (or NULL)
1157089b2837SJed Brown 
1158089b2837SJed Brown    Level: advanced
1159089b2837SJed Brown 
1160089b2837SJed Brown .keywords: TS, nonlinear, get, function
1161089b2837SJed Brown 
1162089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1163089b2837SJed Brown @*/
1164089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1165089b2837SJed Brown {
1166089b2837SJed Brown   PetscErrorCode ierr;
1167089b2837SJed Brown   SNES           snes;
116824989b8cSPeter Brune   DM             dm;
1169089b2837SJed Brown 
1170089b2837SJed Brown   PetscFunctionBegin;
1171089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1172089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11730298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
117424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
117524989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1176089b2837SJed Brown   PetscFunctionReturn(0);
1177089b2837SJed Brown }
1178089b2837SJed Brown 
1179089b2837SJed Brown #undef __FUNCT__
1180089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1181089b2837SJed Brown /*@C
1182089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1183089b2837SJed Brown 
1184089b2837SJed Brown    Not Collective
1185089b2837SJed Brown 
1186089b2837SJed Brown    Input Parameter:
1187089b2837SJed Brown .  ts - the TS context
1188089b2837SJed Brown 
1189089b2837SJed Brown    Output Parameter:
11900298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11910298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11920298fd71SBarry Smith -  ctx - the function context (or NULL)
1193089b2837SJed Brown 
1194089b2837SJed Brown    Level: advanced
1195089b2837SJed Brown 
1196089b2837SJed Brown .keywords: TS, nonlinear, get, function
1197089b2837SJed Brown 
1198089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction()
1199089b2837SJed Brown @*/
1200089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1201089b2837SJed Brown {
1202089b2837SJed Brown   PetscErrorCode ierr;
1203089b2837SJed Brown   SNES           snes;
120424989b8cSPeter Brune   DM             dm;
1205089b2837SJed Brown 
1206089b2837SJed Brown   PetscFunctionBegin;
1207089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1208089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12090298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
121024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
121124989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1212316643e7SJed Brown   PetscFunctionReturn(0);
1213316643e7SJed Brown }
1214316643e7SJed Brown 
1215316643e7SJed Brown #undef __FUNCT__
1216316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1217316643e7SJed Brown /*@C
1218a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1219ae8867d6SBarry Smith         provided with TSSetIFunction().
1220316643e7SJed Brown 
12213f9fe445SBarry Smith    Logically Collective on TS
1222316643e7SJed Brown 
1223316643e7SJed Brown    Input Parameters:
1224316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1225e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1226e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1227316643e7SJed Brown .  f   - the Jacobian evaluation routine
12280298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1229316643e7SJed Brown 
1230316643e7SJed Brown    Calling sequence of f:
1231ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1232316643e7SJed Brown 
1233316643e7SJed Brown +  t    - time at step/stage being solved
12341b4a444bSJed Brown .  U    - state vector
12351b4a444bSJed Brown .  U_t  - time derivative of state vector
1236316643e7SJed Brown .  a    - shift
1237e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1238e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1239316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1240316643e7SJed Brown 
1241316643e7SJed Brown    Notes:
1242e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1243316643e7SJed Brown 
1244a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1245b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1246a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1247a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1248a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1249a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1250a4f0a591SBarry Smith 
1251316643e7SJed Brown    Level: beginner
1252316643e7SJed Brown 
1253316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1254316643e7SJed Brown 
1255ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1256316643e7SJed Brown 
1257316643e7SJed Brown @*/
1258e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1259316643e7SJed Brown {
1260316643e7SJed Brown   PetscErrorCode ierr;
1261089b2837SJed Brown   SNES           snes;
126224989b8cSPeter Brune   DM             dm;
1263316643e7SJed Brown 
1264316643e7SJed Brown   PetscFunctionBegin;
12650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1266e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1267e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1268e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1269e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
127024989b8cSPeter Brune 
127124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
127224989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
127324989b8cSPeter Brune 
1274089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1275e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1276316643e7SJed Brown   PetscFunctionReturn(0);
1277316643e7SJed Brown }
1278316643e7SJed Brown 
12794a2ae208SSatish Balay #undef __FUNCT__
1280e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1281e1244c69SJed Brown /*@
1282e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1283e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1284e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1285e1244c69SJed Brown    not been changed by the TS.
1286e1244c69SJed Brown 
1287e1244c69SJed Brown    Logically Collective
1288e1244c69SJed Brown 
1289e1244c69SJed Brown    Input Arguments:
1290e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1291e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1292e1244c69SJed Brown 
1293e1244c69SJed Brown    Level: intermediate
1294e1244c69SJed Brown 
1295e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1296e1244c69SJed Brown @*/
1297e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1298e1244c69SJed Brown {
1299e1244c69SJed Brown   PetscFunctionBegin;
1300e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1301e1244c69SJed Brown   PetscFunctionReturn(0);
1302e1244c69SJed Brown }
1303e1244c69SJed Brown 
1304e1244c69SJed Brown #undef __FUNCT__
130555849f57SBarry Smith #define __FUNCT__ "TSLoad"
130655849f57SBarry Smith /*@C
130755849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
130855849f57SBarry Smith 
130955849f57SBarry Smith   Collective on PetscViewer
131055849f57SBarry Smith 
131155849f57SBarry Smith   Input Parameters:
131255849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
131355849f57SBarry Smith            some related function before a call to TSLoad().
131455849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
131555849f57SBarry Smith 
131655849f57SBarry Smith    Level: intermediate
131755849f57SBarry Smith 
131855849f57SBarry Smith   Notes:
131955849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
132055849f57SBarry Smith 
132155849f57SBarry Smith   Notes for advanced users:
132255849f57SBarry Smith   Most users should not need to know the details of the binary storage
132355849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
132455849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
132555849f57SBarry Smith   format is
132655849f57SBarry Smith .vb
132755849f57SBarry Smith      has not yet been determined
132855849f57SBarry Smith .ve
132955849f57SBarry Smith 
133055849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
133155849f57SBarry Smith @*/
1332f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
133355849f57SBarry Smith {
133455849f57SBarry Smith   PetscErrorCode ierr;
133555849f57SBarry Smith   PetscBool      isbinary;
133655849f57SBarry Smith   PetscInt       classid;
133755849f57SBarry Smith   char           type[256];
13382d53ad75SBarry Smith   DMTS           sdm;
1339ad6bc421SBarry Smith   DM             dm;
134055849f57SBarry Smith 
134155849f57SBarry Smith   PetscFunctionBegin;
1342f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
134355849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
134455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
134555849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
134655849f57SBarry Smith 
134755849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1348ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
134955849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1350f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1351f2c2a1b9SBarry Smith   if (ts->ops->load) {
1352f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1353f2c2a1b9SBarry Smith   }
1354ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1355ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1356ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1357f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1358f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13592d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13602d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
136155849f57SBarry Smith   PetscFunctionReturn(0);
136255849f57SBarry Smith }
136355849f57SBarry Smith 
13649804daf3SBarry Smith #include <petscdraw.h>
1365e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1366e04113cfSBarry Smith #include <petscviewersaws.h>
1367f05ece33SBarry Smith #endif
136855849f57SBarry Smith #undef __FUNCT__
13694a2ae208SSatish Balay #define __FUNCT__ "TSView"
13707e2c5f70SBarry Smith /*@C
1371d763cef2SBarry Smith     TSView - Prints the TS data structure.
1372d763cef2SBarry Smith 
13734c49b128SBarry Smith     Collective on TS
1374d763cef2SBarry Smith 
1375d763cef2SBarry Smith     Input Parameters:
1376d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1377d763cef2SBarry Smith -   viewer - visualization context
1378d763cef2SBarry Smith 
1379d763cef2SBarry Smith     Options Database Key:
1380d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1381d763cef2SBarry Smith 
1382d763cef2SBarry Smith     Notes:
1383d763cef2SBarry Smith     The available visualization contexts include
1384b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1385b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1386d763cef2SBarry Smith          output where only the first processor opens
1387d763cef2SBarry Smith          the file.  All other processors send their
1388d763cef2SBarry Smith          data to the first processor to print.
1389d763cef2SBarry Smith 
1390d763cef2SBarry Smith     The user can open an alternative visualization context with
1391b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1392d763cef2SBarry Smith 
1393d763cef2SBarry Smith     Level: beginner
1394d763cef2SBarry Smith 
1395d763cef2SBarry Smith .keywords: TS, timestep, view
1396d763cef2SBarry Smith 
1397b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1398d763cef2SBarry Smith @*/
13997087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1400d763cef2SBarry Smith {
1401dfbe8321SBarry Smith   PetscErrorCode ierr;
140219fd82e9SBarry Smith   TSType         type;
14032b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
14042d53ad75SBarry Smith   DMTS           sdm;
1405e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1406f05ece33SBarry Smith   PetscBool      isams;
1407f05ece33SBarry Smith #endif
1408d763cef2SBarry Smith 
1409d763cef2SBarry Smith   PetscFunctionBegin;
14100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14113050cee2SBarry Smith   if (!viewer) {
1412ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
14133050cee2SBarry Smith   }
14140700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1415c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1416fd16b177SBarry Smith 
1417251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1418251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
141955849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
14202b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1421e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1422e04113cfSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr);
1423f05ece33SBarry Smith #endif
142432077d6dSBarry Smith   if (iascii) {
1425dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
142677431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14277c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1428d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14295ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1430c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1431d763cef2SBarry Smith     }
14325ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1433193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14342d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14352d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1436d52bd9f3SBarry Smith     if (ts->ops->view) {
1437d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1438d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1439d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1440d52bd9f3SBarry Smith     }
14410f5bd95cSBarry Smith   } else if (isstring) {
1442a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1443b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
144455849f57SBarry Smith   } else if (isbinary) {
144555849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
144655849f57SBarry Smith     MPI_Comm    comm;
144755849f57SBarry Smith     PetscMPIInt rank;
144855849f57SBarry Smith     char        type[256];
144955849f57SBarry Smith 
145055849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
145155849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
145255849f57SBarry Smith     if (!rank) {
145355849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
145455849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
145555849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
145655849f57SBarry Smith     }
145755849f57SBarry Smith     if (ts->ops->view) {
145855849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
145955849f57SBarry Smith     }
1460f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1461f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14622d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14632d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14642b0a91c0SBarry Smith   } else if (isdraw) {
14652b0a91c0SBarry Smith     PetscDraw draw;
14662b0a91c0SBarry Smith     char      str[36];
146789fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14682b0a91c0SBarry Smith 
14692b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14702b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14712b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14722b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
14730298fd71SBarry Smith     ierr   = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
147489fd9fafSBarry Smith     bottom = y - h;
14752b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14762b0a91c0SBarry Smith     if (ts->ops->view) {
14772b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14782b0a91c0SBarry Smith     }
14792b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1480e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1481f05ece33SBarry Smith   } else if (isams) {
1482d45a07a7SBarry Smith     PetscMPIInt rank;
14832657e9d9SBarry Smith     const char  *name;
14842657e9d9SBarry Smith 
14852657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1486d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1487d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1488d45a07a7SBarry Smith       char       dir[1024];
1489d45a07a7SBarry Smith 
1490e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1491a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14922657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14932657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14942657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1495d763cef2SBarry Smith     }
14960acecf5bSBarry Smith     if (ts->ops->view) {
14970acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14980acecf5bSBarry Smith     }
1499f05ece33SBarry Smith #endif
1500f05ece33SBarry Smith   }
1501f05ece33SBarry Smith 
1502b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1503251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1504b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1505d763cef2SBarry Smith   PetscFunctionReturn(0);
1506d763cef2SBarry Smith }
1507d763cef2SBarry Smith 
1508d763cef2SBarry Smith 
15094a2ae208SSatish Balay #undef __FUNCT__
15104a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1511b07ff414SBarry Smith /*@
1512d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1513d763cef2SBarry Smith    the timesteppers.
1514d763cef2SBarry Smith 
15153f9fe445SBarry Smith    Logically Collective on TS
1516d763cef2SBarry Smith 
1517d763cef2SBarry Smith    Input Parameters:
1518d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1519d763cef2SBarry Smith -  usrP - optional user context
1520d763cef2SBarry Smith 
1521d763cef2SBarry Smith    Level: intermediate
1522d763cef2SBarry Smith 
1523d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1524d763cef2SBarry Smith 
1525d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1526d763cef2SBarry Smith @*/
15277087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1528d763cef2SBarry Smith {
1529d763cef2SBarry Smith   PetscFunctionBegin;
15300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1531d763cef2SBarry Smith   ts->user = usrP;
1532d763cef2SBarry Smith   PetscFunctionReturn(0);
1533d763cef2SBarry Smith }
1534d763cef2SBarry Smith 
15354a2ae208SSatish Balay #undef __FUNCT__
15364a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1537b07ff414SBarry Smith /*@
1538d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1539d763cef2SBarry Smith     timestepper.
1540d763cef2SBarry Smith 
1541d763cef2SBarry Smith     Not Collective
1542d763cef2SBarry Smith 
1543d763cef2SBarry Smith     Input Parameter:
1544d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1545d763cef2SBarry Smith 
1546d763cef2SBarry Smith     Output Parameter:
1547d763cef2SBarry Smith .   usrP - user context
1548d763cef2SBarry Smith 
1549d763cef2SBarry Smith     Level: intermediate
1550d763cef2SBarry Smith 
1551d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1552d763cef2SBarry Smith 
1553d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1554d763cef2SBarry Smith @*/
1555e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1556d763cef2SBarry Smith {
1557d763cef2SBarry Smith   PetscFunctionBegin;
15580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1559e71120c6SJed Brown   *(void**)usrP = ts->user;
1560d763cef2SBarry Smith   PetscFunctionReturn(0);
1561d763cef2SBarry Smith }
1562d763cef2SBarry Smith 
15634a2ae208SSatish Balay #undef __FUNCT__
15644a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1565d763cef2SBarry Smith /*@
1566b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1567d763cef2SBarry Smith 
1568d763cef2SBarry Smith    Not Collective
1569d763cef2SBarry Smith 
1570d763cef2SBarry Smith    Input Parameter:
1571d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1572d763cef2SBarry Smith 
1573d763cef2SBarry Smith    Output Parameter:
1574b8123daeSJed Brown .  iter - number of steps completed so far
1575d763cef2SBarry Smith 
1576d763cef2SBarry Smith    Level: intermediate
1577d763cef2SBarry Smith 
1578d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15799be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1580d763cef2SBarry Smith @*/
15817087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1582d763cef2SBarry Smith {
1583d763cef2SBarry Smith   PetscFunctionBegin;
15840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15854482741eSBarry Smith   PetscValidIntPointer(iter,2);
1586d763cef2SBarry Smith   *iter = ts->steps;
1587d763cef2SBarry Smith   PetscFunctionReturn(0);
1588d763cef2SBarry Smith }
1589d763cef2SBarry Smith 
15904a2ae208SSatish Balay #undef __FUNCT__
15914a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1592d763cef2SBarry Smith /*@
1593d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1594d763cef2SBarry Smith    as well as the initial time.
1595d763cef2SBarry Smith 
15963f9fe445SBarry Smith    Logically Collective on TS
1597d763cef2SBarry Smith 
1598d763cef2SBarry Smith    Input Parameters:
1599d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1600d763cef2SBarry Smith .  initial_time - the initial time
1601d763cef2SBarry Smith -  time_step - the size of the timestep
1602d763cef2SBarry Smith 
1603d763cef2SBarry Smith    Level: intermediate
1604d763cef2SBarry Smith 
1605d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1606d763cef2SBarry Smith 
1607d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1608d763cef2SBarry Smith @*/
16097087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1610d763cef2SBarry Smith {
1611e144a568SJed Brown   PetscErrorCode ierr;
1612e144a568SJed Brown 
1613d763cef2SBarry Smith   PetscFunctionBegin;
16140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1615e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1616d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1617d763cef2SBarry Smith   PetscFunctionReturn(0);
1618d763cef2SBarry Smith }
1619d763cef2SBarry Smith 
16204a2ae208SSatish Balay #undef __FUNCT__
16214a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1622d763cef2SBarry Smith /*@
1623d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1624d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1625d763cef2SBarry Smith 
16263f9fe445SBarry Smith    Logically Collective on TS
1627d763cef2SBarry Smith 
1628d763cef2SBarry Smith    Input Parameters:
1629d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1630d763cef2SBarry Smith -  time_step - the size of the timestep
1631d763cef2SBarry Smith 
1632d763cef2SBarry Smith    Level: intermediate
1633d763cef2SBarry Smith 
1634d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1635d763cef2SBarry Smith 
1636d763cef2SBarry Smith .keywords: TS, set, timestep
1637d763cef2SBarry Smith @*/
16387087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1639d763cef2SBarry Smith {
1640d763cef2SBarry Smith   PetscFunctionBegin;
16410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1642c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1643d763cef2SBarry Smith   ts->time_step      = time_step;
164431748224SBarry Smith   ts->time_step_orig = time_step;
1645d763cef2SBarry Smith   PetscFunctionReturn(0);
1646d763cef2SBarry Smith }
1647d763cef2SBarry Smith 
16484a2ae208SSatish Balay #undef __FUNCT__
1649a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1650a43b19c4SJed Brown /*@
165149354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
165249354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
165349354f04SShri Abhyankar      or just return at the final time TS computed.
1654a43b19c4SJed Brown 
1655a43b19c4SJed Brown   Logically Collective on TS
1656a43b19c4SJed Brown 
1657a43b19c4SJed Brown    Input Parameter:
1658a43b19c4SJed Brown +   ts - the time-step context
165949354f04SShri Abhyankar -   eftopt - exact final time option
1660a43b19c4SJed Brown 
1661a43b19c4SJed Brown    Level: beginner
1662a43b19c4SJed Brown 
1663a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1664a43b19c4SJed Brown @*/
166549354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1666a43b19c4SJed Brown {
1667a43b19c4SJed Brown   PetscFunctionBegin;
1668a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
166949354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
167049354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1671a43b19c4SJed Brown   PetscFunctionReturn(0);
1672a43b19c4SJed Brown }
1673a43b19c4SJed Brown 
1674a43b19c4SJed Brown #undef __FUNCT__
16754a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1676d763cef2SBarry Smith /*@
1677d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1678d763cef2SBarry Smith 
1679d763cef2SBarry Smith    Not Collective
1680d763cef2SBarry Smith 
1681d763cef2SBarry Smith    Input Parameter:
1682d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1683d763cef2SBarry Smith 
1684d763cef2SBarry Smith    Output Parameter:
1685d763cef2SBarry Smith .  dt - the current timestep size
1686d763cef2SBarry Smith 
1687d763cef2SBarry Smith    Level: intermediate
1688d763cef2SBarry Smith 
1689d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1690d763cef2SBarry Smith 
1691d763cef2SBarry Smith .keywords: TS, get, timestep
1692d763cef2SBarry Smith @*/
16937087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1694d763cef2SBarry Smith {
1695d763cef2SBarry Smith   PetscFunctionBegin;
16960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1697f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1698d763cef2SBarry Smith   *dt = ts->time_step;
1699d763cef2SBarry Smith   PetscFunctionReturn(0);
1700d763cef2SBarry Smith }
1701d763cef2SBarry Smith 
17024a2ae208SSatish Balay #undef __FUNCT__
17034a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1704d8e5e3e6SSatish Balay /*@
1705d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1706d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1707d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1708d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1709d763cef2SBarry Smith 
1710d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1711d763cef2SBarry Smith 
1712d763cef2SBarry Smith    Input Parameter:
1713d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1714d763cef2SBarry Smith 
1715d763cef2SBarry Smith    Output Parameter:
1716d763cef2SBarry Smith .  v - the vector containing the solution
1717d763cef2SBarry Smith 
1718d763cef2SBarry Smith    Level: intermediate
1719d763cef2SBarry Smith 
1720d763cef2SBarry Smith .seealso: TSGetTimeStep()
1721d763cef2SBarry Smith 
1722d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1723d763cef2SBarry Smith @*/
17247087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1725d763cef2SBarry Smith {
1726d763cef2SBarry Smith   PetscFunctionBegin;
17270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17284482741eSBarry Smith   PetscValidPointer(v,2);
17298737fe31SLisandro Dalcin   *v = ts->vec_sol;
1730d763cef2SBarry Smith   PetscFunctionReturn(0);
1731d763cef2SBarry Smith }
1732d763cef2SBarry Smith 
1733c235aa8dSHong Zhang #undef __FUNCT__
1734c235aa8dSHong Zhang #define __FUNCT__ "TSGetSensitivity"
1735c235aa8dSHong Zhang /*@
1736c235aa8dSHong Zhang    TSGetSensitivity - Returns the sensitivity in the reverse mode.
1737c235aa8dSHong Zhang 
1738c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1739c235aa8dSHong Zhang 
1740c235aa8dSHong Zhang    Input Parameter:
1741c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1742c235aa8dSHong Zhang 
1743c235aa8dSHong Zhang    Output Parameter:
1744c235aa8dSHong Zhang .  v - the vector containing the solution
1745c235aa8dSHong Zhang 
1746c235aa8dSHong Zhang    Level: intermediate
1747c235aa8dSHong Zhang 
1748c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1749c235aa8dSHong Zhang 
1750c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1751c235aa8dSHong Zhang @*/
1752b18ea86cSHong Zhang PetscErrorCode  TSGetSensitivity(TS ts,Vec **v,PetscInt *numberadjs)
1753c235aa8dSHong Zhang {
1754c235aa8dSHong Zhang   PetscFunctionBegin;
1755c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1756c235aa8dSHong Zhang   PetscValidPointer(v,2);
1757b18ea86cSHong Zhang   *v          = ts->vecs_sensi;
1758b18ea86cSHong Zhang   if(numberadjs) *numberadjs = ts->numberadjs;
1759c235aa8dSHong Zhang   PetscFunctionReturn(0);
1760c235aa8dSHong Zhang }
1761c235aa8dSHong Zhang 
1762bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17634a2ae208SSatish Balay #undef __FUNCT__
1764bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1765d8e5e3e6SSatish Balay /*@
1766bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1767d763cef2SBarry Smith 
1768bdad233fSMatthew Knepley   Not collective
1769d763cef2SBarry Smith 
1770bdad233fSMatthew Knepley   Input Parameters:
1771bdad233fSMatthew Knepley + ts   - The TS
1772bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1773d763cef2SBarry Smith .vb
17740910c330SBarry Smith          U_t - A U = 0      (linear)
17750910c330SBarry Smith          U_t - A(t) U = 0   (linear)
17760910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1777d763cef2SBarry Smith .ve
1778d763cef2SBarry Smith 
1779d763cef2SBarry Smith    Level: beginner
1780d763cef2SBarry Smith 
1781bdad233fSMatthew Knepley .keywords: TS, problem type
1782bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1783d763cef2SBarry Smith @*/
17847087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1785a7cc72afSBarry Smith {
17869e2a6581SJed Brown   PetscErrorCode ierr;
17879e2a6581SJed Brown 
1788d763cef2SBarry Smith   PetscFunctionBegin;
17890700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1790bdad233fSMatthew Knepley   ts->problem_type = type;
17919e2a6581SJed Brown   if (type == TS_LINEAR) {
17929e2a6581SJed Brown     SNES snes;
17939e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17949e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17959e2a6581SJed Brown   }
1796d763cef2SBarry Smith   PetscFunctionReturn(0);
1797d763cef2SBarry Smith }
1798d763cef2SBarry Smith 
1799bdad233fSMatthew Knepley #undef __FUNCT__
1800bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1801bdad233fSMatthew Knepley /*@C
1802bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1803bdad233fSMatthew Knepley 
1804bdad233fSMatthew Knepley   Not collective
1805bdad233fSMatthew Knepley 
1806bdad233fSMatthew Knepley   Input Parameter:
1807bdad233fSMatthew Knepley . ts   - The TS
1808bdad233fSMatthew Knepley 
1809bdad233fSMatthew Knepley   Output Parameter:
1810bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1811bdad233fSMatthew Knepley .vb
1812089b2837SJed Brown          M U_t = A U
1813089b2837SJed Brown          M(t) U_t = A(t) U
1814b5abc632SBarry Smith          F(t,U,U_t)
1815bdad233fSMatthew Knepley .ve
1816bdad233fSMatthew Knepley 
1817bdad233fSMatthew Knepley    Level: beginner
1818bdad233fSMatthew Knepley 
1819bdad233fSMatthew Knepley .keywords: TS, problem type
1820bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1821bdad233fSMatthew Knepley @*/
18227087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1823a7cc72afSBarry Smith {
1824bdad233fSMatthew Knepley   PetscFunctionBegin;
18250700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18264482741eSBarry Smith   PetscValidIntPointer(type,2);
1827bdad233fSMatthew Knepley   *type = ts->problem_type;
1828bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1829bdad233fSMatthew Knepley }
1830d763cef2SBarry Smith 
18314a2ae208SSatish Balay #undef __FUNCT__
18324a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1833d763cef2SBarry Smith /*@
1834d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1835d763cef2SBarry Smith    of a timestepper.
1836d763cef2SBarry Smith 
1837d763cef2SBarry Smith    Collective on TS
1838d763cef2SBarry Smith 
1839d763cef2SBarry Smith    Input Parameter:
1840d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1841d763cef2SBarry Smith 
1842d763cef2SBarry Smith    Notes:
1843d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1844d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1845d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1846d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1847d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1848d763cef2SBarry Smith 
1849d763cef2SBarry Smith    Level: advanced
1850d763cef2SBarry Smith 
1851d763cef2SBarry Smith .keywords: TS, timestep, setup
1852d763cef2SBarry Smith 
1853d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1854d763cef2SBarry Smith @*/
18557087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1856d763cef2SBarry Smith {
1857dfbe8321SBarry Smith   PetscErrorCode ierr;
18586c6b9e74SPeter Brune   DM             dm;
18596c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1860d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18616c6b9e74SPeter Brune   TSIJacobian    ijac;
18626c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1863d763cef2SBarry Smith 
1864d763cef2SBarry Smith   PetscFunctionBegin;
18650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1866277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1867277b19d0SLisandro Dalcin 
18687adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18699596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1870d763cef2SBarry Smith   }
1871277b19d0SLisandro Dalcin 
1872277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1873277b19d0SLisandro Dalcin 
1874b18ea86cSHong Zhang   if (ts->reverse_mode && !ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSensitivity() first");
1875c235aa8dSHong Zhang 
1876552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
18771c3436cfSJed Brown 
1878e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1879e1244c69SJed Brown     Mat Amat,Pmat;
1880e1244c69SJed Brown     SNES snes;
1881e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1882e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1883e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1884e1244c69SJed Brown      * have displaced the RHS matrix */
1885e1244c69SJed Brown     if (Amat == ts->Arhs) {
1886e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1887e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1888e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1889e1244c69SJed Brown     }
1890e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1891e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1892e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1893e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1894e1244c69SJed Brown     }
1895e1244c69SJed Brown   }
1896277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1897000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1898277b19d0SLisandro Dalcin   }
1899277b19d0SLisandro Dalcin 
19006c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
19016c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
19026c6b9e74SPeter Brune    */
19036c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
19040298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
19056c6b9e74SPeter Brune   if (!func) {
19066c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
19076c6b9e74SPeter Brune   }
19086c6b9e74SPeter 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.
19096c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
19106c6b9e74SPeter Brune    */
19110298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
19120298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
19130298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
19146c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
19156c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
19166c6b9e74SPeter Brune   }
1917277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1918277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1919277b19d0SLisandro Dalcin }
1920277b19d0SLisandro Dalcin 
1921277b19d0SLisandro Dalcin #undef __FUNCT__
1922277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1923277b19d0SLisandro Dalcin /*@
1924277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1925277b19d0SLisandro Dalcin 
1926277b19d0SLisandro Dalcin    Collective on TS
1927277b19d0SLisandro Dalcin 
1928277b19d0SLisandro Dalcin    Input Parameter:
1929277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1930277b19d0SLisandro Dalcin 
1931277b19d0SLisandro Dalcin    Level: beginner
1932277b19d0SLisandro Dalcin 
1933277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1934277b19d0SLisandro Dalcin 
1935277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1936277b19d0SLisandro Dalcin @*/
1937277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1938277b19d0SLisandro Dalcin {
1939277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1940277b19d0SLisandro Dalcin 
1941277b19d0SLisandro Dalcin   PetscFunctionBegin;
1942277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1943b18ea86cSHong Zhang 
1944277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1945277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1946277b19d0SLisandro Dalcin   }
1947277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1948bbd56ea5SKarl Rupp 
19494e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
19504e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1951214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
19526bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1953e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1954e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
195538637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1956b18ea86cSHong Zhang   if (ts->reverse_mode) {
1957f8fee759SHong Zhang     ts->vecs_sensi = 0;
1958ad8e2604SHong Zhang     if (ts->vecs_sensip) {
1959f8fee759SHong Zhang       ts->vecs_sensip = 0;
1960ad8e2604SHong Zhang       ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
1961ad8e2604SHong Zhang     }
196205755b9cSHong Zhang     if (ts->vec_costquad) {
196305755b9cSHong Zhang       ierr = VecDestroy(&ts->vec_costquad);CHKERRQ(ierr);
1964*36eaed60SHong Zhang       ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
1965c384f6ddSHong Zhang     }
1966b18ea86cSHong Zhang   }
1967277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1968d763cef2SBarry Smith   PetscFunctionReturn(0);
1969d763cef2SBarry Smith }
1970d763cef2SBarry Smith 
19714a2ae208SSatish Balay #undef __FUNCT__
19724a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1973d8e5e3e6SSatish Balay /*@
1974d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1975d763cef2SBarry Smith    with TSCreate().
1976d763cef2SBarry Smith 
1977d763cef2SBarry Smith    Collective on TS
1978d763cef2SBarry Smith 
1979d763cef2SBarry Smith    Input Parameter:
1980d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1981d763cef2SBarry Smith 
1982d763cef2SBarry Smith    Level: beginner
1983d763cef2SBarry Smith 
1984d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1985d763cef2SBarry Smith 
1986d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1987d763cef2SBarry Smith @*/
19886bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1989d763cef2SBarry Smith {
19906849ba73SBarry Smith   PetscErrorCode ierr;
1991d763cef2SBarry Smith 
1992d763cef2SBarry Smith   PetscFunctionBegin;
19936bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
19946bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
19956bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1996d763cef2SBarry Smith 
19976bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1998277b19d0SLisandro Dalcin 
1999e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2000e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20016bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20026d4c513bSLisandro Dalcin 
200384df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2004aeb4809dSShri Abhyankar   if ((*ts)->event) {
2005aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2006aeb4809dSShri Abhyankar   }
20076bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20086bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20096bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20106d4c513bSLisandro Dalcin 
2011a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2012d763cef2SBarry Smith   PetscFunctionReturn(0);
2013d763cef2SBarry Smith }
2014d763cef2SBarry Smith 
20154a2ae208SSatish Balay #undef __FUNCT__
20164a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2017d8e5e3e6SSatish Balay /*@
2018d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2019d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2020d763cef2SBarry Smith 
2021d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2022d763cef2SBarry Smith 
2023d763cef2SBarry Smith    Input Parameter:
2024d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2025d763cef2SBarry Smith 
2026d763cef2SBarry Smith    Output Parameter:
2027d763cef2SBarry Smith .  snes - the nonlinear solver context
2028d763cef2SBarry Smith 
2029d763cef2SBarry Smith    Notes:
2030d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2031d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
203294b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2033d763cef2SBarry Smith 
2034d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20350298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2036d763cef2SBarry Smith 
2037d763cef2SBarry Smith    Level: beginner
2038d763cef2SBarry Smith 
2039d763cef2SBarry Smith .keywords: timestep, get, SNES
2040d763cef2SBarry Smith @*/
20417087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2042d763cef2SBarry Smith {
2043d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2044d372ba47SLisandro Dalcin 
2045d763cef2SBarry Smith   PetscFunctionBegin;
20460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20474482741eSBarry Smith   PetscValidPointer(snes,2);
2048d372ba47SLisandro Dalcin   if (!ts->snes) {
2049ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20500298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20513bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2052d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2053496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20549e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20559e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20569e2a6581SJed Brown     }
2057d372ba47SLisandro Dalcin   }
2058d763cef2SBarry Smith   *snes = ts->snes;
2059d763cef2SBarry Smith   PetscFunctionReturn(0);
2060d763cef2SBarry Smith }
2061d763cef2SBarry Smith 
20624a2ae208SSatish Balay #undef __FUNCT__
2063deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2064deb2cd25SJed Brown /*@
2065deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2066deb2cd25SJed Brown 
2067deb2cd25SJed Brown    Collective
2068deb2cd25SJed Brown 
2069deb2cd25SJed Brown    Input Parameter:
2070deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2071deb2cd25SJed Brown -  snes - the nonlinear solver context
2072deb2cd25SJed Brown 
2073deb2cd25SJed Brown    Notes:
2074deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2075deb2cd25SJed Brown 
2076deb2cd25SJed Brown    Level: developer
2077deb2cd25SJed Brown 
2078deb2cd25SJed Brown .keywords: timestep, set, SNES
2079deb2cd25SJed Brown @*/
2080deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2081deb2cd25SJed Brown {
2082deb2cd25SJed Brown   PetscErrorCode ierr;
2083d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2084deb2cd25SJed Brown 
2085deb2cd25SJed Brown   PetscFunctionBegin;
2086deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2087deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2088deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2089deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2090bbd56ea5SKarl Rupp 
2091deb2cd25SJed Brown   ts->snes = snes;
2092bbd56ea5SKarl Rupp 
20930298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20940298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2095740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
20960298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2097740132f1SEmil Constantinescu   }
2098deb2cd25SJed Brown   PetscFunctionReturn(0);
2099deb2cd25SJed Brown }
2100deb2cd25SJed Brown 
2101deb2cd25SJed Brown #undef __FUNCT__
210294b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2103d8e5e3e6SSatish Balay /*@
210494b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2105d763cef2SBarry Smith    a TS (timestepper) context.
2106d763cef2SBarry Smith 
210794b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2108d763cef2SBarry Smith 
2109d763cef2SBarry Smith    Input Parameter:
2110d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2111d763cef2SBarry Smith 
2112d763cef2SBarry Smith    Output Parameter:
211394b7f48cSBarry Smith .  ksp - the nonlinear solver context
2114d763cef2SBarry Smith 
2115d763cef2SBarry Smith    Notes:
211694b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2117d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2118d763cef2SBarry Smith    KSP and PC contexts as well.
2119d763cef2SBarry Smith 
212094b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21210298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2122d763cef2SBarry Smith 
2123d763cef2SBarry Smith    Level: beginner
2124d763cef2SBarry Smith 
212594b7f48cSBarry Smith .keywords: timestep, get, KSP
2126d763cef2SBarry Smith @*/
21277087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2128d763cef2SBarry Smith {
2129d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2130089b2837SJed Brown   SNES           snes;
2131d372ba47SLisandro Dalcin 
2132d763cef2SBarry Smith   PetscFunctionBegin;
21330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21344482741eSBarry Smith   PetscValidPointer(ksp,2);
213517186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2136e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2137089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2138089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2139d763cef2SBarry Smith   PetscFunctionReturn(0);
2140d763cef2SBarry Smith }
2141d763cef2SBarry Smith 
2142d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2143d763cef2SBarry Smith 
21444a2ae208SSatish Balay #undef __FUNCT__
2145adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2146adb62b0dSMatthew Knepley /*@
2147adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2148adb62b0dSMatthew Knepley    maximum time for iteration.
2149adb62b0dSMatthew Knepley 
21503f9fe445SBarry Smith    Not Collective
2151adb62b0dSMatthew Knepley 
2152adb62b0dSMatthew Knepley    Input Parameters:
2153adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21540298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21550298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2156adb62b0dSMatthew Knepley 
2157adb62b0dSMatthew Knepley    Level: intermediate
2158adb62b0dSMatthew Knepley 
2159adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2160adb62b0dSMatthew Knepley @*/
21617087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2162adb62b0dSMatthew Knepley {
2163adb62b0dSMatthew Knepley   PetscFunctionBegin;
21640700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2165abc0a331SBarry Smith   if (maxsteps) {
21664482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2167adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2168adb62b0dSMatthew Knepley   }
2169abc0a331SBarry Smith   if (maxtime) {
21704482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2171adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2172adb62b0dSMatthew Knepley   }
2173adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2174adb62b0dSMatthew Knepley }
2175adb62b0dSMatthew Knepley 
2176adb62b0dSMatthew Knepley #undef __FUNCT__
21774a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2178d763cef2SBarry Smith /*@
2179d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2180d763cef2SBarry Smith    maximum time for iteration.
2181d763cef2SBarry Smith 
21823f9fe445SBarry Smith    Logically Collective on TS
2183d763cef2SBarry Smith 
2184d763cef2SBarry Smith    Input Parameters:
2185d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2186d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2187d763cef2SBarry Smith -  maxtime - final time to iterate to
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Options Database Keys:
2190d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
21913bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2192d763cef2SBarry Smith 
2193d763cef2SBarry Smith    Notes:
2194d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2195d763cef2SBarry Smith 
2196d763cef2SBarry Smith    Level: intermediate
2197d763cef2SBarry Smith 
2198d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2199a43b19c4SJed Brown 
2200a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2201d763cef2SBarry Smith @*/
22027087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2203d763cef2SBarry Smith {
2204d763cef2SBarry Smith   PetscFunctionBegin;
22050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2206c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2207c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
220839b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
220939b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2210d763cef2SBarry Smith   PetscFunctionReturn(0);
2211d763cef2SBarry Smith }
2212d763cef2SBarry Smith 
22134a2ae208SSatish Balay #undef __FUNCT__
22144a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2215d763cef2SBarry Smith /*@
2216d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2217d763cef2SBarry Smith    for use by the TS routines.
2218d763cef2SBarry Smith 
22193f9fe445SBarry Smith    Logically Collective on TS and Vec
2220d763cef2SBarry Smith 
2221d763cef2SBarry Smith    Input Parameters:
2222d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22230910c330SBarry Smith -  u - the solution vector
2224d763cef2SBarry Smith 
2225d763cef2SBarry Smith    Level: beginner
2226d763cef2SBarry Smith 
2227d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2228d763cef2SBarry Smith @*/
22290910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2230d763cef2SBarry Smith {
22318737fe31SLisandro Dalcin   PetscErrorCode ierr;
2232496e6a7aSJed Brown   DM             dm;
22338737fe31SLisandro Dalcin 
2234d763cef2SBarry Smith   PetscFunctionBegin;
22350700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22360910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22370910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22386bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2239bbd56ea5SKarl Rupp 
22400910c330SBarry Smith   ts->vec_sol = u;
2241bbd56ea5SKarl Rupp 
2242496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22430910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2244d763cef2SBarry Smith   PetscFunctionReturn(0);
2245d763cef2SBarry Smith }
2246d763cef2SBarry Smith 
2247e74ef692SMatthew Knepley #undef __FUNCT__
2248c235aa8dSHong Zhang #define __FUNCT__ "TSSetSensitivity"
2249c235aa8dSHong Zhang /*@
2250ad8e2604SHong Zhang    TSSetSensitivity - Sets the initial value of sensitivity (w.r.t. initial conditions)
2251c235aa8dSHong Zhang    for use by the TS routines.
2252c235aa8dSHong Zhang 
2253c235aa8dSHong Zhang    Logically Collective on TS and Vec
2254c235aa8dSHong Zhang 
2255c235aa8dSHong Zhang    Input Parameters:
2256c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2257c235aa8dSHong Zhang -  u - the solution vector
2258c235aa8dSHong Zhang 
2259c235aa8dSHong Zhang    Level: beginner
2260c235aa8dSHong Zhang 
2261c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2262c235aa8dSHong Zhang @*/
2263b18ea86cSHong Zhang PetscErrorCode  TSSetSensitivity(TS ts,Vec *u,PetscInt numberadjs)
2264c235aa8dSHong Zhang {
2265c235aa8dSHong Zhang   PetscFunctionBegin;
2266c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2267b18ea86cSHong Zhang   PetscValidPointer(u,2);
2268b18ea86cSHong Zhang   ts->vecs_sensi = u;
2269ad8e2604SHong Zhang   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 TSSetSensitivityP()");
2270b18ea86cSHong Zhang   ts->numberadjs = numberadjs;
2271c235aa8dSHong Zhang 
2272ad8e2604SHong Zhang   PetscFunctionReturn(0);
2273ad8e2604SHong Zhang }
2274ad8e2604SHong Zhang 
2275ad8e2604SHong Zhang #undef __FUNCT__
2276ad8e2604SHong Zhang #define __FUNCT__ "TSSetSensitivityP"
2277ad8e2604SHong Zhang /*@
2278ad8e2604SHong Zhang    TSSetSensitivityP - Sets the initial value of sensitivity (w.r.t. parameters)
2279ad8e2604SHong Zhang    for use by the TS routines.
2280ad8e2604SHong Zhang 
2281ad8e2604SHong Zhang    Logically Collective on TS and Vec
2282ad8e2604SHong Zhang 
2283ad8e2604SHong Zhang    Input Parameters:
2284ad8e2604SHong Zhang +  ts - the TS context obtained from TSCreate()
2285ad8e2604SHong Zhang -  u - the solution vector
2286ad8e2604SHong Zhang 
2287ad8e2604SHong Zhang    Level: beginner
2288ad8e2604SHong Zhang 
2289ad8e2604SHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2290ad8e2604SHong Zhang @*/
2291ad8e2604SHong Zhang PetscErrorCode  TSSetSensitivityP(TS ts,Vec *u,PetscInt numberadjs)
2292ad8e2604SHong Zhang {
2293ad8e2604SHong Zhang   PetscFunctionBegin;
2294ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2295ad8e2604SHong Zhang   PetscValidPointer(u,2);
2296ad8e2604SHong Zhang   ts->vecs_sensip = u;
2297ad8e2604SHong Zhang   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 TSSetSensitivity()");
2298ad8e2604SHong Zhang   ts->numberadjs = numberadjs;
2299ad8e2604SHong Zhang 
2300ad8e2604SHong Zhang   PetscFunctionReturn(0);
2301ad8e2604SHong Zhang }
2302ad8e2604SHong Zhang 
2303ad8e2604SHong Zhang #undef __FUNCT__
2304ad8e2604SHong Zhang #define __FUNCT__ "TSSetRHSJacobianP"
2305ad8e2604SHong Zhang /*@C
2306ad8e2604SHong Zhang   TSSetRHSJacobianP - Sets the function that computes the Jacobian w.r.t. parameters.
2307ad8e2604SHong Zhang 
2308ad8e2604SHong Zhang   Logically Collective on TS
2309ad8e2604SHong Zhang 
2310ad8e2604SHong Zhang   Input Parameters:
2311ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2312ad8e2604SHong Zhang - func - The function
2313ad8e2604SHong Zhang 
2314ad8e2604SHong Zhang   Calling sequence of func:
231505755b9cSHong Zhang $ func (TS ts,PetscReal t,Vec u,Mat A,void *ctx);
231605755b9cSHong Zhang +   t - current timestep
231705755b9cSHong Zhang .   u - input vector
231805755b9cSHong Zhang .   A - output matrix
231905755b9cSHong Zhang -   ctx - [optional] user-defined function context
2320ad8e2604SHong Zhang 
2321ad8e2604SHong Zhang   Level: intermediate
2322ad8e2604SHong Zhang 
2323ad8e2604SHong Zhang .keywords: TS, sensitivity
2324ad8e2604SHong Zhang .seealso:
2325ad8e2604SHong Zhang @*/
2326ad8e2604SHong Zhang PetscErrorCode  TSSetRHSJacobianP(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2327ad8e2604SHong Zhang {
2328ad8e2604SHong Zhang   PetscErrorCode ierr;
2329ad8e2604SHong Zhang 
2330ad8e2604SHong Zhang   PetscFunctionBegin;
2331ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2332ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2333ad8e2604SHong Zhang 
2334ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2335ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2336ad8e2604SHong Zhang   if(Amat) {
2337ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2338ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2339ad8e2604SHong Zhang 
2340ad8e2604SHong Zhang     ts->Jacp = Amat;
2341ad8e2604SHong Zhang   }
2342ad8e2604SHong Zhang   PetscFunctionReturn(0);
2343ad8e2604SHong Zhang }
2344ad8e2604SHong Zhang 
2345ad8e2604SHong Zhang #undef __FUNCT__
2346ad8e2604SHong Zhang #define __FUNCT__ "TSRHSJacobianP"
2347ad8e2604SHong Zhang /*@
2348ad8e2604SHong Zhang   TSRHSJacobianP - Runs the user-defined JacobianP function.
2349ad8e2604SHong Zhang 
2350ad8e2604SHong Zhang   Collective on TS
2351ad8e2604SHong Zhang 
2352ad8e2604SHong Zhang   Input Parameters:
2353ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2354ad8e2604SHong Zhang 
2355ad8e2604SHong Zhang   Notes:
2356ad8e2604SHong Zhang   TSJacobianP() is typically used for sensitivity implementation,
2357ad8e2604SHong Zhang   so most users would not generally call this routine themselves.
2358ad8e2604SHong Zhang 
2359ad8e2604SHong Zhang   Level: developer
2360ad8e2604SHong Zhang 
2361ad8e2604SHong Zhang .keywords: TS, sensitivity
2362ad8e2604SHong Zhang .seealso: TSSetRHSJacobianP()
2363ad8e2604SHong Zhang @*/
2364ad8e2604SHong Zhang PetscErrorCode  TSRHSJacobianP(TS ts,PetscReal t,Vec X,Mat Amat)
2365ad8e2604SHong Zhang {
2366ad8e2604SHong Zhang   PetscErrorCode ierr;
2367ad8e2604SHong Zhang 
2368ad8e2604SHong Zhang   PetscFunctionBegin;
2369ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2370ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2371ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2372ad8e2604SHong Zhang 
2373ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2374ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2375ad8e2604SHong Zhang   PetscStackPop;
2376ad8e2604SHong Zhang 
2377c235aa8dSHong Zhang   PetscFunctionReturn(0);
2378c235aa8dSHong Zhang }
2379c235aa8dSHong Zhang 
2380c235aa8dSHong Zhang #undef __FUNCT__
2381e4680132SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
23826fd0887fSHong Zhang /*@C
2383e4680132SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the quadrature (or integral) term in a cost function,
23846fd0887fSHong Zhang     where Q_t = r(t,u).
23856fd0887fSHong Zhang 
23866fd0887fSHong Zhang     Logically Collective on TS
23876fd0887fSHong Zhang 
23886fd0887fSHong Zhang     Input Parameters:
23896fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2390*36eaed60SHong Zhang .   q -  vector to put the computed quadrature term in the cost function (or NULL to have it created)
23916fd0887fSHong Zhang .   fq - routine for evaluating the right-hand-side function
23926fd0887fSHong Zhang -   ctx - [optional] user-defined context for private data for the
23936fd0887fSHong Zhang           function evaluation routine (may be NULL)
23946fd0887fSHong Zhang 
23956fd0887fSHong Zhang     Calling sequence of func:
2396*36eaed60SHong Zhang $     func (TS ts,PetscReal t,Vec u,PetscReal *f,void *ctx);
23976fd0887fSHong Zhang 
23986fd0887fSHong Zhang +   t - current timestep
23996fd0887fSHong Zhang .   u - input vector
2400*36eaed60SHong Zhang .   f - function vector
24016fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24026fd0887fSHong Zhang 
24036fd0887fSHong Zhang     Level: beginner
24046fd0887fSHong Zhang 
24056fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24066fd0887fSHong Zhang 
24076fd0887fSHong Zhang .seealso: TSSetRHSJacobianP(),TSSetSensitivity(),TSSetSensitivityP()
24086fd0887fSHong Zhang @*/
2409*36eaed60SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numberadjs,Vec q,PetscErrorCode (*fq)(TS,PetscReal,Vec,Vec,void*),void *ctx)
24106fd0887fSHong Zhang {
24116fd0887fSHong Zhang   PetscErrorCode ierr;
2412c384f6ddSHong Zhang   Vec      ralloc = NULL;
2413*36eaed60SHong Zhang   PetscInt size;
24146fd0887fSHong Zhang 
24156fd0887fSHong Zhang   PetscFunctionBegin;
24166fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2417*36eaed60SHong Zhang   if (q) {
2418*36eaed60SHong Zhang     PetscValidHeaderSpecific(q,VEC_CLASSID,2);
2419*36eaed60SHong Zhang   } else {
2420*36eaed60SHong Zhang     SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"TSSetCostIntegrand() requires a vector of size numberajds to hold the value of integrals as 3rd input parameter");
24216fd0887fSHong Zhang   }
2422*36eaed60SHong Zhang   if (!ts->numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSSetSensitivity() or TSSetSensitivityP() first so that the number of cost functions can be determined.");
2423*36eaed60SHong Zhang   if (ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetSensitivity() or TSSetSensitivityP()");
2424*36eaed60SHong Zhang   ierr = VecGetSize(q,&size);CHKERRQ(ierr);
2425*36eaed60SHong Zhang   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 TSSetCostIntegrand()).");
24266fd0887fSHong Zhang 
2427*36eaed60SHong Zhang   ierr = PetscObjectReference((PetscObject)q);CHKERRQ(ierr);
2428*36eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costquad);CHKERRQ(ierr);
2429*36eaed60SHong Zhang   ts->vec_costquad = q;
2430*36eaed60SHong Zhang 
2431*36eaed60SHong Zhang   ierr                  = VecDuplicate(ts->vec_costquad,&ralloc);CHKERRQ(ierr);
2432*36eaed60SHong Zhang   ts->vec_costintegrand = ralloc;
2433*36eaed60SHong Zhang   ierr                  = VecDestroy(&ralloc);CHKERRQ(ierr);
2434e4680132SHong Zhang   ts->costintegrand     = fq;
243505755b9cSHong Zhang   ts->costintegrandctx  = ctx;
24366fd0887fSHong Zhang 
24376fd0887fSHong Zhang   PetscFunctionReturn(0);
24386fd0887fSHong Zhang }
24396fd0887fSHong Zhang 
24406fd0887fSHong Zhang #undef __FUNCT__
2441*36eaed60SHong Zhang #define __FUNCT__ "TSGetCostQuad"
2442*36eaed60SHong Zhang /*@
2443*36eaed60SHong Zhang    TSGetCostQuad - Returns the values of the quadrature (or integral) terms in a cost function.
2444*36eaed60SHong Zhang    It is valid to call the routine after a backward run.
2445*36eaed60SHong Zhang 
2446*36eaed60SHong Zhang    Not Collective
2447*36eaed60SHong Zhang 
2448*36eaed60SHong Zhang    Input Parameter:
2449*36eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
2450*36eaed60SHong Zhang 
2451*36eaed60SHong Zhang    Output Parameter:
2452*36eaed60SHong Zhang .  v - the vector containing the solution
2453*36eaed60SHong Zhang 
2454*36eaed60SHong Zhang    Level: intermediate
2455*36eaed60SHong Zhang 
2456*36eaed60SHong Zhang .seealso: TSSetCostIntegrand()
2457*36eaed60SHong Zhang 
2458*36eaed60SHong Zhang .keywords: TS, sensitivity analysis
2459*36eaed60SHong Zhang @*/
2460*36eaed60SHong Zhang PetscErrorCode  TSGetCostQuad(TS ts,Vec *v)
2461*36eaed60SHong Zhang {
2462*36eaed60SHong Zhang   PetscFunctionBegin;
2463*36eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2464*36eaed60SHong Zhang   PetscValidPointer(v,2);
2465*36eaed60SHong Zhang   *v = ts->vec_costquad;
2466*36eaed60SHong Zhang   PetscFunctionReturn(0);
2467*36eaed60SHong Zhang }
2468*36eaed60SHong Zhang 
2469*36eaed60SHong Zhang #undef __FUNCT__
2470e4680132SHong Zhang #define __FUNCT__ "TSComputeCostIntegrand"
24716fd0887fSHong Zhang /*@
2472e4680132SHong Zhang    TSComputeCostIntegrand - Evaluates the quadrature function in the cost functions.
24736fd0887fSHong Zhang 
24746fd0887fSHong Zhang    Input Parameters:
24756fd0887fSHong Zhang +  ts - the TS context
24766fd0887fSHong Zhang .  t - current time
247705755b9cSHong Zhang -  U - state vector
24786fd0887fSHong Zhang 
24796fd0887fSHong Zhang    Output Parameter:
24806fd0887fSHong Zhang .  q - vector of size numberadjs to hold the outputs
24816fd0887fSHong Zhang 
24826fd0887fSHong Zhang    Note:
24836fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
24846fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
24856fd0887fSHong Zhang 
24866fd0887fSHong Zhang    Level: developer
24876fd0887fSHong Zhang 
24886fd0887fSHong Zhang .keywords: TS, compute
24896fd0887fSHong Zhang 
2490e4680132SHong Zhang .seealso: TSSetCostIntegrand()
24916fd0887fSHong Zhang @*/
249205755b9cSHong Zhang PetscErrorCode TSComputeCostIntegrand(TS ts,PetscReal t,Vec U,Vec q)
24936fd0887fSHong Zhang {
24946fd0887fSHong Zhang   PetscErrorCode ierr;
24956fd0887fSHong Zhang 
24966fd0887fSHong Zhang   PetscFunctionBegin;
24976fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24986fd0887fSHong Zhang   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
24996fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
25006fd0887fSHong Zhang 
25016fd0887fSHong Zhang   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,q,0);CHKERRQ(ierr);
2502e4680132SHong Zhang   if (ts->costintegrand) {
2503e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
250405755b9cSHong Zhang     ierr = (*ts->costintegrand)(ts,t,U,q,ts->costintegrandctx);CHKERRQ(ierr);
25056fd0887fSHong Zhang     PetscStackPop;
25066fd0887fSHong Zhang   } else {
25076fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25086fd0887fSHong Zhang   }
25096fd0887fSHong Zhang 
25106fd0887fSHong Zhang   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,q,0);CHKERRQ(ierr);
25116fd0887fSHong Zhang   PetscFunctionReturn(0);
25126fd0887fSHong Zhang }
25136fd0887fSHong Zhang 
25146fd0887fSHong Zhang #undef __FUNCT__
251505755b9cSHong Zhang #define __FUNCT__ "TSSetDRDYFunction"
251605755b9cSHong Zhang /*@C
251705755b9cSHong Zhang   TSSetDRDYFunction - Sets the function that computes the gradient of the CostIntegrand function r w.r.t. states y.
251805755b9cSHong Zhang 
251905755b9cSHong Zhang   Logically Collective on TS
252005755b9cSHong Zhang 
252105755b9cSHong Zhang   Input Parameters:
252205755b9cSHong Zhang + ts   - The TS context obtained from TSCreate()
252305755b9cSHong Zhang - func - The function
252405755b9cSHong Zhang 
252505755b9cSHong Zhang   Calling sequence of func:
252605755b9cSHong Zhang . func (TS ts);
252705755b9cSHong Zhang 
252805755b9cSHong Zhang   Level: intermediate
252905755b9cSHong Zhang 
253005755b9cSHong Zhang .keywords: TS, sensitivity
253105755b9cSHong Zhang .seealso:
253205755b9cSHong Zhang @*/
253305755b9cSHong Zhang PetscErrorCode  TSSetDRDYFunction(TS ts,Vec *drdy,PetscErrorCode (*func)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
253405755b9cSHong Zhang {
253505755b9cSHong Zhang   PetscFunctionBegin;
253605755b9cSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
253705755b9cSHong Zhang 
253805755b9cSHong Zhang   ts->drdyfunction    = func;
253905755b9cSHong Zhang   ts->drdyfunctionctx = ctx;
254005755b9cSHong Zhang   ts->vecs_drdy       = drdy;
254105755b9cSHong Zhang 
254205755b9cSHong Zhang   PetscFunctionReturn(0);
254305755b9cSHong Zhang }
254405755b9cSHong Zhang 
254505755b9cSHong Zhang #undef __FUNCT__
254605755b9cSHong Zhang #define __FUNCT__ "TSComputeDRDYFunction"
254705755b9cSHong Zhang /*@
254805755b9cSHong Zhang   TSComputeDRDYFunction - Runs the user-defined DRDY function.
254905755b9cSHong Zhang 
255005755b9cSHong Zhang   Collective on TS
255105755b9cSHong Zhang 
255205755b9cSHong Zhang   Input Parameters:
255305755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
255405755b9cSHong Zhang 
255505755b9cSHong Zhang   Notes:
255605755b9cSHong Zhang   TSComputeDRDYFunction() is typically used for sensitivity implementation,
255705755b9cSHong Zhang   so most users would not generally call this routine themselves.
255805755b9cSHong Zhang 
255905755b9cSHong Zhang   Level: developer
256005755b9cSHong Zhang 
256105755b9cSHong Zhang .keywords: TS, sensitivity
256205755b9cSHong Zhang .seealso: TSComputeDRDYFunction()
256305755b9cSHong Zhang @*/
256405755b9cSHong Zhang PetscErrorCode  TSComputeDRDYFunction(TS ts,PetscReal t,Vec X,Vec *drdy)
256505755b9cSHong Zhang {
256605755b9cSHong Zhang   PetscErrorCode ierr;
256705755b9cSHong Zhang 
256805755b9cSHong Zhang   PetscFunctionBegin;
256905755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
257005755b9cSHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
257105755b9cSHong Zhang 
257205755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
257305755b9cSHong Zhang   ierr = (*ts->drdyfunction)(ts,t,X,drdy,ts->drdyfunctionctx); CHKERRQ(ierr);
257405755b9cSHong Zhang   PetscStackPop;
257505755b9cSHong Zhang 
257605755b9cSHong Zhang   PetscFunctionReturn(0);
257705755b9cSHong Zhang }
257805755b9cSHong Zhang 
257905755b9cSHong Zhang #undef __FUNCT__
258005755b9cSHong Zhang #define __FUNCT__ "TSSetDRDPFunction"
258105755b9cSHong Zhang /*@C
258205755b9cSHong Zhang   TSSetDRDPFunction - Sets the function that computes the gradient of the CostIntegrand function w.r.t. parameters.
258305755b9cSHong Zhang 
258405755b9cSHong Zhang   Logically Collective on TS
258505755b9cSHong Zhang 
258605755b9cSHong Zhang   Input Parameters:
258705755b9cSHong Zhang + ts   - The TS context obtained from TSCreate()
258805755b9cSHong Zhang - func - The function
258905755b9cSHong Zhang 
259005755b9cSHong Zhang   Calling sequence of func:
259105755b9cSHong Zhang . func (TS ts);
259205755b9cSHong Zhang 
259305755b9cSHong Zhang   Level: intermediate
259405755b9cSHong Zhang 
259505755b9cSHong Zhang .keywords: TS, sensitivity
259605755b9cSHong Zhang .seealso:
259705755b9cSHong Zhang @*/
259805755b9cSHong Zhang PetscErrorCode  TSSetDRDPFunction(TS ts,Vec *drdp,PetscErrorCode (*func)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
259905755b9cSHong Zhang {
260005755b9cSHong Zhang   PetscFunctionBegin;
260105755b9cSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
260205755b9cSHong Zhang 
260305755b9cSHong Zhang   ts->drdpfunction    = func;
260405755b9cSHong Zhang   ts->drdpfunctionctx = ctx;
260505755b9cSHong Zhang   ts->vecs_drdp       = drdp;
260605755b9cSHong Zhang 
260705755b9cSHong Zhang   PetscFunctionReturn(0);
260805755b9cSHong Zhang }
260905755b9cSHong Zhang 
261005755b9cSHong Zhang #undef __FUNCT__
261105755b9cSHong Zhang #define __FUNCT__ "TSComputeDRDPFunction"
261205755b9cSHong Zhang /*@
261305755b9cSHong Zhang   TSComputeDRDPFunction - Runs the user-defined DRDP function.
261405755b9cSHong Zhang 
261505755b9cSHong Zhang   Collective on TS
261605755b9cSHong Zhang 
261705755b9cSHong Zhang   Input Parameters:
261805755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
261905755b9cSHong Zhang 
262005755b9cSHong Zhang   Notes:
262105755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
262205755b9cSHong Zhang   so most users would not generally call this routine themselves.
262305755b9cSHong Zhang 
262405755b9cSHong Zhang   Level: developer
262505755b9cSHong Zhang 
262605755b9cSHong Zhang .keywords: TS, sensitivity
262705755b9cSHong Zhang .seealso: TSSetDRDPFunction()
262805755b9cSHong Zhang @*/
262905755b9cSHong Zhang PetscErrorCode  TSComputeDRDPFunction(TS ts,PetscReal t,Vec X,Vec *drdp)
263005755b9cSHong Zhang {
263105755b9cSHong Zhang   PetscErrorCode ierr;
263205755b9cSHong Zhang 
263305755b9cSHong Zhang   PetscFunctionBegin;
263405755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
263505755b9cSHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
263605755b9cSHong Zhang 
263705755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
263805755b9cSHong Zhang   ierr = (*ts->drdpfunction)(ts,t,X,drdp,ts->drdpfunctionctx); CHKERRQ(ierr);
263905755b9cSHong Zhang   PetscStackPop;
264005755b9cSHong Zhang 
264105755b9cSHong Zhang   PetscFunctionReturn(0);
264205755b9cSHong Zhang }
264305755b9cSHong Zhang 
264405755b9cSHong Zhang #undef __FUNCT__
2645e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2646ac226902SBarry Smith /*@C
2647000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26483f2090d5SJed Brown   called once at the beginning of each time step.
2649000e7ae3SMatthew Knepley 
26503f9fe445SBarry Smith   Logically Collective on TS
2651000e7ae3SMatthew Knepley 
2652000e7ae3SMatthew Knepley   Input Parameters:
2653000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2654000e7ae3SMatthew Knepley - func - The function
2655000e7ae3SMatthew Knepley 
2656000e7ae3SMatthew Knepley   Calling sequence of func:
2657000e7ae3SMatthew Knepley . func (TS ts);
2658000e7ae3SMatthew Knepley 
2659000e7ae3SMatthew Knepley   Level: intermediate
2660000e7ae3SMatthew Knepley 
2661b8123daeSJed Brown   Note:
2662b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2663b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2664b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2665b8123daeSJed Brown 
2666000e7ae3SMatthew Knepley .keywords: TS, timestep
26679be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2668000e7ae3SMatthew Knepley @*/
26697087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2670000e7ae3SMatthew Knepley {
2671000e7ae3SMatthew Knepley   PetscFunctionBegin;
26720700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2673ae60f76fSBarry Smith   ts->prestep = func;
2674000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2675000e7ae3SMatthew Knepley }
2676000e7ae3SMatthew Knepley 
2677e74ef692SMatthew Knepley #undef __FUNCT__
26783f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
267909ee8438SJed Brown /*@
26803f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26813f2090d5SJed Brown 
26823f2090d5SJed Brown   Collective on TS
26833f2090d5SJed Brown 
26843f2090d5SJed Brown   Input Parameters:
26853f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26863f2090d5SJed Brown 
26873f2090d5SJed Brown   Notes:
26883f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
26893f2090d5SJed Brown   so most users would not generally call this routine themselves.
26903f2090d5SJed Brown 
26913f2090d5SJed Brown   Level: developer
26923f2090d5SJed Brown 
26933f2090d5SJed Brown .keywords: TS, timestep
26949be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
26953f2090d5SJed Brown @*/
26967087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
26973f2090d5SJed Brown {
26983f2090d5SJed Brown   PetscErrorCode ierr;
26993f2090d5SJed Brown 
27003f2090d5SJed Brown   PetscFunctionBegin;
27010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2702ae60f76fSBarry Smith   if (ts->prestep) {
2703ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2704312ce896SJed Brown   }
27053f2090d5SJed Brown   PetscFunctionReturn(0);
27063f2090d5SJed Brown }
27073f2090d5SJed Brown 
27083f2090d5SJed Brown #undef __FUNCT__
2709b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2710b8123daeSJed Brown /*@C
2711b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2712b8123daeSJed Brown   called once at the beginning of each stage.
2713b8123daeSJed Brown 
2714b8123daeSJed Brown   Logically Collective on TS
2715b8123daeSJed Brown 
2716b8123daeSJed Brown   Input Parameters:
2717b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2718b8123daeSJed Brown - func - The function
2719b8123daeSJed Brown 
2720b8123daeSJed Brown   Calling sequence of func:
2721b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2722b8123daeSJed Brown 
2723b8123daeSJed Brown   Level: intermediate
2724b8123daeSJed Brown 
2725b8123daeSJed Brown   Note:
2726b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2727b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2728b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2729b8123daeSJed Brown 
2730b8123daeSJed Brown .keywords: TS, timestep
27319be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2732b8123daeSJed Brown @*/
2733b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2734b8123daeSJed Brown {
2735b8123daeSJed Brown   PetscFunctionBegin;
2736b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2737ae60f76fSBarry Smith   ts->prestage = func;
2738b8123daeSJed Brown   PetscFunctionReturn(0);
2739b8123daeSJed Brown }
2740b8123daeSJed Brown 
2741b8123daeSJed Brown #undef __FUNCT__
27429be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27439be3e283SDebojyoti Ghosh /*@C
27449be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27459be3e283SDebojyoti Ghosh   called once at the end of each stage.
27469be3e283SDebojyoti Ghosh 
27479be3e283SDebojyoti Ghosh   Logically Collective on TS
27489be3e283SDebojyoti Ghosh 
27499be3e283SDebojyoti Ghosh   Input Parameters:
27509be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27519be3e283SDebojyoti Ghosh - func - The function
27529be3e283SDebojyoti Ghosh 
27539be3e283SDebojyoti Ghosh   Calling sequence of func:
27549be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27559be3e283SDebojyoti Ghosh 
27569be3e283SDebojyoti Ghosh   Level: intermediate
27579be3e283SDebojyoti Ghosh 
27589be3e283SDebojyoti Ghosh   Note:
27599be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27609be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27619be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27629be3e283SDebojyoti Ghosh 
27639be3e283SDebojyoti Ghosh .keywords: TS, timestep
27649be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27659be3e283SDebojyoti Ghosh @*/
27669be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27679be3e283SDebojyoti Ghosh {
27689be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27699be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27709be3e283SDebojyoti Ghosh   ts->poststage = func;
27719be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27729be3e283SDebojyoti Ghosh }
27739be3e283SDebojyoti Ghosh 
27749be3e283SDebojyoti Ghosh #undef __FUNCT__
2775b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2776b8123daeSJed Brown /*@
2777b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2778b8123daeSJed Brown 
2779b8123daeSJed Brown   Collective on TS
2780b8123daeSJed Brown 
2781b8123daeSJed Brown   Input Parameters:
2782b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27839be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2784b8123daeSJed Brown 
2785b8123daeSJed Brown   Notes:
2786b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2787b8123daeSJed Brown   most users would not generally call this routine themselves.
2788b8123daeSJed Brown 
2789b8123daeSJed Brown   Level: developer
2790b8123daeSJed Brown 
2791b8123daeSJed Brown .keywords: TS, timestep
27929be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2793b8123daeSJed Brown @*/
2794b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2795b8123daeSJed Brown {
2796b8123daeSJed Brown   PetscErrorCode ierr;
2797b8123daeSJed Brown 
2798b8123daeSJed Brown   PetscFunctionBegin;
2799b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2800ae60f76fSBarry Smith   if (ts->prestage) {
2801ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2802b8123daeSJed Brown   }
2803b8123daeSJed Brown   PetscFunctionReturn(0);
2804b8123daeSJed Brown }
2805b8123daeSJed Brown 
2806b8123daeSJed Brown #undef __FUNCT__
28079be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
28089be3e283SDebojyoti Ghosh /*@
28099be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
28109be3e283SDebojyoti Ghosh 
28119be3e283SDebojyoti Ghosh   Collective on TS
28129be3e283SDebojyoti Ghosh 
28139be3e283SDebojyoti Ghosh   Input Parameters:
28149be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
28159be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
28169be3e283SDebojyoti Ghosh   stageindex  - Stage number
28179be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
28189be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
28199be3e283SDebojyoti Ghosh 
28209be3e283SDebojyoti Ghosh   Notes:
28219be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
28229be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
28239be3e283SDebojyoti Ghosh 
28249be3e283SDebojyoti Ghosh   Level: developer
28259be3e283SDebojyoti Ghosh 
28269be3e283SDebojyoti Ghosh .keywords: TS, timestep
28279be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
28289be3e283SDebojyoti Ghosh @*/
28299be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
28309be3e283SDebojyoti Ghosh {
28319be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
28329be3e283SDebojyoti Ghosh 
28339be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28349be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28354beae5d8SLisandro Dalcin   if (ts->poststage) {
28369be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
28379be3e283SDebojyoti Ghosh   }
28389be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28399be3e283SDebojyoti Ghosh }
28409be3e283SDebojyoti Ghosh 
28419be3e283SDebojyoti Ghosh #undef __FUNCT__
2842e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2843ac226902SBarry Smith /*@C
2844000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28453f2090d5SJed Brown   called once at the end of each time step.
2846000e7ae3SMatthew Knepley 
28473f9fe445SBarry Smith   Logically Collective on TS
2848000e7ae3SMatthew Knepley 
2849000e7ae3SMatthew Knepley   Input Parameters:
2850000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2851000e7ae3SMatthew Knepley - func - The function
2852000e7ae3SMatthew Knepley 
2853000e7ae3SMatthew Knepley   Calling sequence of func:
2854b8123daeSJed Brown $ func (TS ts);
2855000e7ae3SMatthew Knepley 
2856000e7ae3SMatthew Knepley   Level: intermediate
2857000e7ae3SMatthew Knepley 
2858000e7ae3SMatthew Knepley .keywords: TS, timestep
2859b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2860000e7ae3SMatthew Knepley @*/
28617087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2862000e7ae3SMatthew Knepley {
2863000e7ae3SMatthew Knepley   PetscFunctionBegin;
28640700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2865ae60f76fSBarry Smith   ts->poststep = func;
2866000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2867000e7ae3SMatthew Knepley }
2868000e7ae3SMatthew Knepley 
2869e74ef692SMatthew Knepley #undef __FUNCT__
28703f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
287109ee8438SJed Brown /*@
28723f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28733f2090d5SJed Brown 
28743f2090d5SJed Brown   Collective on TS
28753f2090d5SJed Brown 
28763f2090d5SJed Brown   Input Parameters:
28773f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28783f2090d5SJed Brown 
28793f2090d5SJed Brown   Notes:
28803f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28813f2090d5SJed Brown   so most users would not generally call this routine themselves.
28823f2090d5SJed Brown 
28833f2090d5SJed Brown   Level: developer
28843f2090d5SJed Brown 
28853f2090d5SJed Brown .keywords: TS, timestep
28863f2090d5SJed Brown @*/
28877087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28883f2090d5SJed Brown {
28893f2090d5SJed Brown   PetscErrorCode ierr;
28903f2090d5SJed Brown 
28913f2090d5SJed Brown   PetscFunctionBegin;
28920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2893ae60f76fSBarry Smith   if (ts->poststep) {
2894ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
289572ac3e02SJed Brown   }
28963f2090d5SJed Brown   PetscFunctionReturn(0);
28973f2090d5SJed Brown }
28983f2090d5SJed Brown 
2899d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2900d763cef2SBarry Smith 
29014a2ae208SSatish Balay #undef __FUNCT__
2902a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2903d763cef2SBarry Smith /*@C
2904a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2905d763cef2SBarry Smith    timestep to display the iteration's  progress.
2906d763cef2SBarry Smith 
29073f9fe445SBarry Smith    Logically Collective on TS
2908d763cef2SBarry Smith 
2909d763cef2SBarry Smith    Input Parameters:
2910d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2911e213d8f1SJed Brown .  monitor - monitoring routine
2912329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
29130298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2914b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
29150298fd71SBarry Smith           (may be NULL)
2916d763cef2SBarry Smith 
2917e213d8f1SJed Brown    Calling sequence of monitor:
29180910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2919d763cef2SBarry Smith 
2920d763cef2SBarry Smith +    ts - the TS context
292188c05cc5SBarry 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
292288c05cc5SBarry Smith                                been interpolated to)
29231f06c33eSBarry Smith .    time - current time
29240910c330SBarry Smith .    u - current iterate
2925d763cef2SBarry Smith -    mctx - [optional] monitoring context
2926d763cef2SBarry Smith 
2927d763cef2SBarry Smith    Notes:
2928d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2929d763cef2SBarry Smith    already has been loaded.
2930d763cef2SBarry Smith 
2931025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2932025f1a04SBarry Smith 
2933d763cef2SBarry Smith    Level: intermediate
2934d763cef2SBarry Smith 
2935d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2936d763cef2SBarry Smith 
2937a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2938d763cef2SBarry Smith @*/
2939c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2940d763cef2SBarry Smith {
2941d763cef2SBarry Smith   PetscFunctionBegin;
29420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
294317186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2944d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29458704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2946d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2947d763cef2SBarry Smith   PetscFunctionReturn(0);
2948d763cef2SBarry Smith }
2949d763cef2SBarry Smith 
29504a2ae208SSatish Balay #undef __FUNCT__
2951a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2952d763cef2SBarry Smith /*@C
2953a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2954d763cef2SBarry Smith 
29553f9fe445SBarry Smith    Logically Collective on TS
2956d763cef2SBarry Smith 
2957d763cef2SBarry Smith    Input Parameters:
2958d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2959d763cef2SBarry Smith 
2960d763cef2SBarry Smith    Notes:
2961d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2962d763cef2SBarry Smith 
2963d763cef2SBarry Smith    Level: intermediate
2964d763cef2SBarry Smith 
2965d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2966d763cef2SBarry Smith 
2967a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2968d763cef2SBarry Smith @*/
29697087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2970d763cef2SBarry Smith {
2971d952e501SBarry Smith   PetscErrorCode ierr;
2972d952e501SBarry Smith   PetscInt       i;
2973d952e501SBarry Smith 
2974d763cef2SBarry Smith   PetscFunctionBegin;
29750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2976d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29778704b422SBarry Smith     if (ts->monitordestroy[i]) {
29788704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2979d952e501SBarry Smith     }
2980d952e501SBarry Smith   }
2981d763cef2SBarry Smith   ts->numbermonitors = 0;
2982d763cef2SBarry Smith   PetscFunctionReturn(0);
2983d763cef2SBarry Smith }
2984d763cef2SBarry Smith 
29854a2ae208SSatish Balay #undef __FUNCT__
2986a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2987d8e5e3e6SSatish Balay /*@
2988a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
29895516499fSSatish Balay 
29905516499fSSatish Balay    Level: intermediate
299141251cbbSSatish Balay 
29925516499fSSatish Balay .keywords: TS, set, monitor
29935516499fSSatish Balay 
299441251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
299541251cbbSSatish Balay @*/
2996649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2997d763cef2SBarry Smith {
2998dfbe8321SBarry Smith   PetscErrorCode ierr;
2999ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
3000d132466eSBarry Smith 
3001d763cef2SBarry Smith   PetscFunctionBegin;
3002649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3003971832b6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr);
3004649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3005d763cef2SBarry Smith   PetscFunctionReturn(0);
3006d763cef2SBarry Smith }
3007d763cef2SBarry Smith 
30084a2ae208SSatish Balay #undef __FUNCT__
3009cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
3010cd652676SJed Brown /*@
3011cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
3012cd652676SJed Brown 
3013cd652676SJed Brown    Logically Collective on TS
3014cd652676SJed Brown 
3015cd652676SJed Brown    Input Argument:
3016cd652676SJed Brown .  ts - time stepping context
3017cd652676SJed Brown 
3018cd652676SJed Brown    Output Argument:
3019cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
3020cd652676SJed Brown 
3021cd652676SJed Brown    Level: intermediate
3022cd652676SJed Brown 
3023cd652676SJed Brown .keywords: TS, set
3024cd652676SJed Brown 
3025cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3026cd652676SJed Brown @*/
3027cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3028cd652676SJed Brown {
3029cd652676SJed Brown   PetscFunctionBegin;
3030cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3031cd652676SJed Brown   ts->retain_stages = flg;
3032cd652676SJed Brown   PetscFunctionReturn(0);
3033cd652676SJed Brown }
3034cd652676SJed Brown 
3035cd652676SJed Brown #undef __FUNCT__
3036cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3037cd652676SJed Brown /*@
3038cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3039cd652676SJed Brown 
3040cd652676SJed Brown    Collective on TS
3041cd652676SJed Brown 
3042cd652676SJed Brown    Input Argument:
3043cd652676SJed Brown +  ts - time stepping context
3044cd652676SJed Brown -  t - time to interpolate to
3045cd652676SJed Brown 
3046cd652676SJed Brown    Output Argument:
30470910c330SBarry Smith .  U - state at given time
3048cd652676SJed Brown 
3049cd652676SJed Brown    Notes:
3050cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3051cd652676SJed Brown 
3052cd652676SJed Brown    Level: intermediate
3053cd652676SJed Brown 
3054cd652676SJed Brown    Developer Notes:
3055cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3056cd652676SJed Brown 
3057cd652676SJed Brown .keywords: TS, set
3058cd652676SJed Brown 
3059cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3060cd652676SJed Brown @*/
30610910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3062cd652676SJed Brown {
3063cd652676SJed Brown   PetscErrorCode ierr;
3064cd652676SJed Brown 
3065cd652676SJed Brown   PetscFunctionBegin;
3066cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3067b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
30686712e2f1SBarry 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);
3069ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
30700910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3071cd652676SJed Brown   PetscFunctionReturn(0);
3072cd652676SJed Brown }
3073cd652676SJed Brown 
3074cd652676SJed Brown #undef __FUNCT__
30754a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3076d763cef2SBarry Smith /*@
30776d9e5789SSean Farley    TSStep - Steps one time step
3078d763cef2SBarry Smith 
3079d763cef2SBarry Smith    Collective on TS
3080d763cef2SBarry Smith 
3081d763cef2SBarry Smith    Input Parameter:
3082d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3083d763cef2SBarry Smith 
30846d9e5789SSean Farley    Level: intermediate
3085d763cef2SBarry Smith 
3086b8123daeSJed Brown    Notes:
3087b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3088b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3089b8123daeSJed Brown 
309025cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
309125cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
309225cb2221SBarry Smith 
3093d763cef2SBarry Smith .keywords: TS, timestep, solve
3094d763cef2SBarry Smith 
30959be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3096d763cef2SBarry Smith @*/
3097193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3098d763cef2SBarry Smith {
30992fb8446cSMatthew G. Knepley   DM               dm;
3100dfbe8321SBarry Smith   PetscErrorCode   ierr;
3101fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3102d763cef2SBarry Smith 
3103d763cef2SBarry Smith   PetscFunctionBegin;
31040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3105fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3106fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3107fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3108fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3109fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3110fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3111fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
3112fffbeea8SBarry Smith 
31132fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3114d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3115d405a339SMatthew Knepley 
3116362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
311724655328SShri   ts->ptime_prev = ts->ptime;
3118cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
31194e9ba7eeSMatthew G. Knepley   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3120bbd56ea5SKarl Rupp 
3121e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3122d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3123d2daff3dSHong Zhang   if(ts->reverse_mode) {
3124d2daff3dSHong Zhang     if(!ts->ops->stepadj) {
3125d2daff3dSHong Zhang       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);
3126d2daff3dSHong Zhang     }else {
3127d2daff3dSHong Zhang       ierr = (*ts->ops->stepadj)(ts);CHKERRQ(ierr);
3128d2daff3dSHong Zhang     }
3129d2daff3dSHong Zhang   }else {
3130193ac0bcSJed Brown     ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3131d2daff3dSHong Zhang   }
3132d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3133bbd56ea5SKarl Rupp 
313424655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3135cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3136362cd11cSLisandro Dalcin 
3137362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3138cef5090cSJed Brown     if (ts->errorifstepfailed) {
3139cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3140ce94432eSBarry 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]);
31412a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
31422a3a10ceSLisandro 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]);
3143ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3144cef5090cSJed Brown     }
3145362cd11cSLisandro Dalcin   } else if (!ts->reason) {
3146db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3147db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3148362cd11cSLisandro Dalcin   }
3149d763cef2SBarry Smith   PetscFunctionReturn(0);
3150d763cef2SBarry Smith }
3151d763cef2SBarry Smith 
31524a2ae208SSatish Balay #undef __FUNCT__
315305175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
315405175c85SJed Brown /*@
315505175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
315605175c85SJed Brown 
31571c3436cfSJed Brown    Collective on TS
315805175c85SJed Brown 
315905175c85SJed Brown    Input Arguments:
31601c3436cfSJed Brown +  ts - time stepping context
31611c3436cfSJed Brown .  order - desired order of accuracy
31620298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
316305175c85SJed Brown 
316405175c85SJed Brown    Output Arguments:
31650910c330SBarry Smith .  U - state at the end of the current step
316605175c85SJed Brown 
316705175c85SJed Brown    Level: advanced
316805175c85SJed Brown 
3169108c343cSJed Brown    Notes:
3170108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3171108c343cSJed 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.
3172108c343cSJed Brown 
31731c3436cfSJed Brown .seealso: TSStep(), TSAdapt
317405175c85SJed Brown @*/
31750910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
317605175c85SJed Brown {
317705175c85SJed Brown   PetscErrorCode ierr;
317805175c85SJed Brown 
317905175c85SJed Brown   PetscFunctionBegin;
318005175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
318105175c85SJed Brown   PetscValidType(ts,1);
31820910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3183ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
31840910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
318505175c85SJed Brown   PetscFunctionReturn(0);
318605175c85SJed Brown }
318705175c85SJed Brown 
318805175c85SJed Brown #undef __FUNCT__
31896a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
31906a4d4014SLisandro Dalcin /*@
31916a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
31926a4d4014SLisandro Dalcin 
31936a4d4014SLisandro Dalcin    Collective on TS
31946a4d4014SLisandro Dalcin 
31956a4d4014SLisandro Dalcin    Input Parameter:
31966a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3197cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
31985a3a76d0SJed Brown 
31996a4d4014SLisandro Dalcin    Level: beginner
32006a4d4014SLisandro Dalcin 
32015a3a76d0SJed Brown    Notes:
32025a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
32035a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
32045a3a76d0SJed Brown    stepped over the final time.
32055a3a76d0SJed Brown 
32066a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
32076a4d4014SLisandro Dalcin 
32086a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
32096a4d4014SLisandro Dalcin @*/
3210cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
32116a4d4014SLisandro Dalcin {
3212b06615a5SLisandro Dalcin   Vec               solution;
32136a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
3214f22f69f0SBarry Smith 
32156a4d4014SLisandro Dalcin   PetscFunctionBegin;
32160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3217f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
3218d2daff3dSHong Zhang   if (!ts->reverse_mode && 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 */
3219b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
32200910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3221b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3222b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3223b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
32245a3a76d0SJed Brown     }
32250910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3226bbd56ea5SKarl Rupp   } else if (u) {
32270910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
32285a3a76d0SJed Brown   }
3229d2daff3dSHong Zhang   ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/
32306a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
3231193ac0bcSJed Brown   ts->steps             = 0;
32325ef26d82SJed Brown   ts->ksp_its           = 0;
32335ef26d82SJed Brown   ts->snes_its          = 0;
3234c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3235c610991cSLisandro Dalcin   ts->reject            = 0;
3236193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3237193ac0bcSJed Brown 
3238ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3239f05ece33SBarry Smith 
3240193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3241193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
32420910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3243cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3244193ac0bcSJed Brown   } else {
32456a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
3246db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3247d2daff3dSHong Zhang     else if (!ts->reverse_mode && ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3248e1a7a14fSJed Brown     while (!ts->reason) {
3249d2daff3dSHong Zhang       if(!ts->reverse_mode) {
3250b06615a5SLisandro Dalcin         ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3251d2daff3dSHong Zhang       }else {
3252d2daff3dSHong Zhang         ierr = TSMonitor(ts,ts->max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3253d2daff3dSHong Zhang       }
3254193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3255aeb4809dSShri Abhyankar       if (ts->event) {
3256aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
32571eda64f1SShri Abhyankar 	if (ts->event->status != TSEVENT_PROCESSING) {
32581eda64f1SShri Abhyankar 	  ierr = TSPostStep(ts);CHKERRQ(ierr);
32591eda64f1SShri Abhyankar 	}
32601eda64f1SShri Abhyankar       } else {
32611eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3262aeb4809dSShri Abhyankar       }
3263193ac0bcSJed Brown     }
3264d2daff3dSHong Zhang     if (!ts->reverse_mode && ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
32650910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3266cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3267b06615a5SLisandro Dalcin       solution = u;
32680574a7fbSJed Brown     } else {
3269ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3270cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3271b06615a5SLisandro Dalcin       solution = ts->vec_sol;
32720574a7fbSJed Brown     }
3273d2daff3dSHong Zhang     if(!ts->reverse_mode) {
3274b06615a5SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3275d2daff3dSHong Zhang     }
32764e9ba7eeSMatthew G. Knepley     ierr = VecViewFromOptions(u, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3277193ac0bcSJed Brown   }
3278d2daff3dSHong Zhang 
3279ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
328056f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
32816a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
32826a4d4014SLisandro Dalcin }
32836a4d4014SLisandro Dalcin 
32846a4d4014SLisandro Dalcin #undef __FUNCT__
32854a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
3286228d79bcSJed Brown /*@
3287228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3288228d79bcSJed Brown 
3289228d79bcSJed Brown    Collective on TS
3290228d79bcSJed Brown 
3291228d79bcSJed Brown    Input Parameters:
3292228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3293228d79bcSJed Brown .  step - step number that has just completed
3294228d79bcSJed Brown .  ptime - model time of the state
32950910c330SBarry Smith -  u - state at the current model time
3296228d79bcSJed Brown 
3297228d79bcSJed Brown    Notes:
3298228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
3299228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
3300228d79bcSJed Brown 
3301228d79bcSJed Brown    Level: advanced
3302228d79bcSJed Brown 
3303228d79bcSJed Brown .keywords: TS, timestep
3304228d79bcSJed Brown @*/
33050910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3306d763cef2SBarry Smith {
33076849ba73SBarry Smith   PetscErrorCode ierr;
3308a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3309d763cef2SBarry Smith 
3310d763cef2SBarry Smith   PetscFunctionBegin;
3311b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3312b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
33135edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3314d763cef2SBarry Smith   for (i=0; i<n; i++) {
33150910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3316d763cef2SBarry Smith   }
33175edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3318d763cef2SBarry Smith   PetscFunctionReturn(0);
3319d763cef2SBarry Smith }
3320d763cef2SBarry Smith 
3321d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
33224a2ae208SSatish Balay #undef __FUNCT__
3323a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3324d763cef2SBarry Smith /*@C
3325a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
3326a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3327d763cef2SBarry Smith 
3328d763cef2SBarry Smith    Collective on TS
3329d763cef2SBarry Smith 
3330d763cef2SBarry Smith    Input Parameters:
3331d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3332d763cef2SBarry Smith .  label - the title to put in the title bar
33337c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3334a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3335a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3336d763cef2SBarry Smith 
3337d763cef2SBarry Smith    Output Parameter:
33380b039ecaSBarry Smith .  ctx - the context
3339d763cef2SBarry Smith 
3340d763cef2SBarry Smith    Options Database Key:
33414f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
33424f09c107SBarry Smith .  -ts_monitor_lg_solution -
334399fdda47SBarry Smith .  -ts_monitor_lg_error -
334499fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
334599fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
334699fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
3347d763cef2SBarry Smith 
3348d763cef2SBarry Smith    Notes:
3349a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3350d763cef2SBarry Smith 
3351d763cef2SBarry Smith    Level: intermediate
3352d763cef2SBarry Smith 
33537c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
3354d763cef2SBarry Smith 
33554f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
33567c922b88SBarry Smith 
3357d763cef2SBarry Smith @*/
3358a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3359d763cef2SBarry Smith {
3360b0a32e0cSBarry Smith   PetscDraw      win;
3361dfbe8321SBarry Smith   PetscErrorCode ierr;
3362d763cef2SBarry Smith 
3363d763cef2SBarry Smith   PetscFunctionBegin;
3364b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3365a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
33663fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
33670b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
33683bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3369287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3370287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3371a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3372d763cef2SBarry Smith   PetscFunctionReturn(0);
3373d763cef2SBarry Smith }
3374d763cef2SBarry Smith 
33754a2ae208SSatish Balay #undef __FUNCT__
33764f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3377b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3378d763cef2SBarry Smith {
33790b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3380c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3381dfbe8321SBarry Smith   PetscErrorCode ierr;
3382d763cef2SBarry Smith 
3383d763cef2SBarry Smith   PetscFunctionBegin;
3384b06615a5SLisandro Dalcin   if (!step) {
3385a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3386a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3387a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3388a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3389287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3390a9f9c1f6SBarry Smith   }
3391c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
33920b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3393b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
33940b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
33953923b477SBarry Smith   }
3396d763cef2SBarry Smith   PetscFunctionReturn(0);
3397d763cef2SBarry Smith }
3398d763cef2SBarry Smith 
33994a2ae208SSatish Balay #undef __FUNCT__
3400a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3401d763cef2SBarry Smith /*@C
3402a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3403a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3404d763cef2SBarry Smith 
34050b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3406d763cef2SBarry Smith 
3407d763cef2SBarry Smith    Input Parameter:
34080b039ecaSBarry Smith .  ctx - the monitor context
3409d763cef2SBarry Smith 
3410d763cef2SBarry Smith    Level: intermediate
3411d763cef2SBarry Smith 
3412d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3413d763cef2SBarry Smith 
34144f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3415d763cef2SBarry Smith @*/
3416a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3417d763cef2SBarry Smith {
3418b0a32e0cSBarry Smith   PetscDraw      draw;
3419dfbe8321SBarry Smith   PetscErrorCode ierr;
3420d763cef2SBarry Smith 
3421d763cef2SBarry Smith   PetscFunctionBegin;
34220b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
34236bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
34240b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
34250b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3426d763cef2SBarry Smith   PetscFunctionReturn(0);
3427d763cef2SBarry Smith }
3428d763cef2SBarry Smith 
34294a2ae208SSatish Balay #undef __FUNCT__
34304a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3431d763cef2SBarry Smith /*@
3432b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3433d763cef2SBarry Smith 
3434d763cef2SBarry Smith    Not Collective
3435d763cef2SBarry Smith 
3436d763cef2SBarry Smith    Input Parameter:
3437d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3438d763cef2SBarry Smith 
3439d763cef2SBarry Smith    Output Parameter:
3440d763cef2SBarry Smith .  t  - the current time
3441d763cef2SBarry Smith 
3442d763cef2SBarry Smith    Level: beginner
3443d763cef2SBarry Smith 
3444b8123daeSJed Brown    Note:
3445b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
34469be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3447b8123daeSJed Brown 
3448d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3449d763cef2SBarry Smith 
3450d763cef2SBarry Smith .keywords: TS, get, time
3451d763cef2SBarry Smith @*/
34527087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3453d763cef2SBarry Smith {
3454d763cef2SBarry Smith   PetscFunctionBegin;
34550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3456f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3457d763cef2SBarry Smith   *t = ts->ptime;
3458d763cef2SBarry Smith   PetscFunctionReturn(0);
3459d763cef2SBarry Smith }
3460d763cef2SBarry Smith 
34614a2ae208SSatish Balay #undef __FUNCT__
3462e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3463e5e524a1SHong Zhang /*@
3464e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3465e5e524a1SHong Zhang 
3466e5e524a1SHong Zhang    Not Collective
3467e5e524a1SHong Zhang 
3468e5e524a1SHong Zhang    Input Parameter:
3469e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3470e5e524a1SHong Zhang 
3471e5e524a1SHong Zhang    Output Parameter:
3472e5e524a1SHong Zhang .  t  - the previous time
3473e5e524a1SHong Zhang 
3474e5e524a1SHong Zhang    Level: beginner
3475e5e524a1SHong Zhang 
3476e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3477e5e524a1SHong Zhang 
3478e5e524a1SHong Zhang .keywords: TS, get, time
3479e5e524a1SHong Zhang @*/
3480e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3481e5e524a1SHong Zhang {
3482e5e524a1SHong Zhang   PetscFunctionBegin;
3483e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3484e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3485e5e524a1SHong Zhang   *t = ts->ptime_prev;
3486e5e524a1SHong Zhang   PetscFunctionReturn(0);
3487e5e524a1SHong Zhang }
3488e5e524a1SHong Zhang 
3489e5e524a1SHong Zhang #undef __FUNCT__
34906a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
34916a4d4014SLisandro Dalcin /*@
34926a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
34936a4d4014SLisandro Dalcin 
34943f9fe445SBarry Smith    Logically Collective on TS
34956a4d4014SLisandro Dalcin 
34966a4d4014SLisandro Dalcin    Input Parameters:
34976a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
34986a4d4014SLisandro Dalcin -  time - the time
34996a4d4014SLisandro Dalcin 
35006a4d4014SLisandro Dalcin    Level: intermediate
35016a4d4014SLisandro Dalcin 
35026a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
35036a4d4014SLisandro Dalcin 
35046a4d4014SLisandro Dalcin .keywords: TS, set, time
35056a4d4014SLisandro Dalcin @*/
35067087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
35076a4d4014SLisandro Dalcin {
35086a4d4014SLisandro Dalcin   PetscFunctionBegin;
35090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3510c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
35116a4d4014SLisandro Dalcin   ts->ptime = t;
35126a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
35136a4d4014SLisandro Dalcin }
35146a4d4014SLisandro Dalcin 
35156a4d4014SLisandro Dalcin #undef __FUNCT__
35164a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3517d763cef2SBarry Smith /*@C
3518d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3519d763cef2SBarry Smith    TS options in the database.
3520d763cef2SBarry Smith 
35213f9fe445SBarry Smith    Logically Collective on TS
3522d763cef2SBarry Smith 
3523d763cef2SBarry Smith    Input Parameter:
3524d763cef2SBarry Smith +  ts     - The TS context
3525d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3526d763cef2SBarry Smith 
3527d763cef2SBarry Smith    Notes:
3528d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3529d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3530d763cef2SBarry Smith    hyphen.
3531d763cef2SBarry Smith 
3532d763cef2SBarry Smith    Level: advanced
3533d763cef2SBarry Smith 
3534d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3535d763cef2SBarry Smith 
3536d763cef2SBarry Smith .seealso: TSSetFromOptions()
3537d763cef2SBarry Smith 
3538d763cef2SBarry Smith @*/
35397087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3540d763cef2SBarry Smith {
3541dfbe8321SBarry Smith   PetscErrorCode ierr;
3542089b2837SJed Brown   SNES           snes;
3543d763cef2SBarry Smith 
3544d763cef2SBarry Smith   PetscFunctionBegin;
35450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3546d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3547089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3548089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3549d763cef2SBarry Smith   PetscFunctionReturn(0);
3550d763cef2SBarry Smith }
3551d763cef2SBarry Smith 
3552d763cef2SBarry Smith 
35534a2ae208SSatish Balay #undef __FUNCT__
35544a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3555d763cef2SBarry Smith /*@C
3556d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3557d763cef2SBarry Smith    TS options in the database.
3558d763cef2SBarry Smith 
35593f9fe445SBarry Smith    Logically Collective on TS
3560d763cef2SBarry Smith 
3561d763cef2SBarry Smith    Input Parameter:
3562d763cef2SBarry Smith +  ts     - The TS context
3563d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3564d763cef2SBarry Smith 
3565d763cef2SBarry Smith    Notes:
3566d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3567d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3568d763cef2SBarry Smith    hyphen.
3569d763cef2SBarry Smith 
3570d763cef2SBarry Smith    Level: advanced
3571d763cef2SBarry Smith 
3572d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3573d763cef2SBarry Smith 
3574d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3575d763cef2SBarry Smith 
3576d763cef2SBarry Smith @*/
35777087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3578d763cef2SBarry Smith {
3579dfbe8321SBarry Smith   PetscErrorCode ierr;
3580089b2837SJed Brown   SNES           snes;
3581d763cef2SBarry Smith 
3582d763cef2SBarry Smith   PetscFunctionBegin;
35830700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3584d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3585089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3586089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3587d763cef2SBarry Smith   PetscFunctionReturn(0);
3588d763cef2SBarry Smith }
3589d763cef2SBarry Smith 
35904a2ae208SSatish Balay #undef __FUNCT__
35914a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3592d763cef2SBarry Smith /*@C
3593d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3594d763cef2SBarry Smith    TS options in the database.
3595d763cef2SBarry Smith 
3596d763cef2SBarry Smith    Not Collective
3597d763cef2SBarry Smith 
3598d763cef2SBarry Smith    Input Parameter:
3599d763cef2SBarry Smith .  ts - The TS context
3600d763cef2SBarry Smith 
3601d763cef2SBarry Smith    Output Parameter:
3602d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3603d763cef2SBarry Smith 
3604d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3605d763cef2SBarry Smith    sufficient length to hold the prefix.
3606d763cef2SBarry Smith 
3607d763cef2SBarry Smith    Level: intermediate
3608d763cef2SBarry Smith 
3609d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3610d763cef2SBarry Smith 
3611d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3612d763cef2SBarry Smith @*/
36137087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3614d763cef2SBarry Smith {
3615dfbe8321SBarry Smith   PetscErrorCode ierr;
3616d763cef2SBarry Smith 
3617d763cef2SBarry Smith   PetscFunctionBegin;
36180700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
36194482741eSBarry Smith   PetscValidPointer(prefix,2);
3620d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3621d763cef2SBarry Smith   PetscFunctionReturn(0);
3622d763cef2SBarry Smith }
3623d763cef2SBarry Smith 
36244a2ae208SSatish Balay #undef __FUNCT__
36254a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3626d763cef2SBarry Smith /*@C
3627d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3628d763cef2SBarry Smith 
3629d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3630d763cef2SBarry Smith 
3631d763cef2SBarry Smith    Input Parameter:
3632d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3633d763cef2SBarry Smith 
3634d763cef2SBarry Smith    Output Parameters:
3635e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3636e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3637e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3638e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3639d763cef2SBarry Smith 
36400298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3641d763cef2SBarry Smith 
3642d763cef2SBarry Smith    Level: intermediate
3643d763cef2SBarry Smith 
364426d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3645d763cef2SBarry Smith 
3646d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3647d763cef2SBarry Smith @*/
3648e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3649d763cef2SBarry Smith {
3650089b2837SJed Brown   PetscErrorCode ierr;
3651089b2837SJed Brown   SNES           snes;
365224989b8cSPeter Brune   DM             dm;
3653089b2837SJed Brown 
3654d763cef2SBarry Smith   PetscFunctionBegin;
3655089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3656e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
365724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
365824989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3659d763cef2SBarry Smith   PetscFunctionReturn(0);
3660d763cef2SBarry Smith }
3661d763cef2SBarry Smith 
36621713a123SBarry Smith #undef __FUNCT__
36632eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
36642eca1d9cSJed Brown /*@C
36652eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
36662eca1d9cSJed Brown 
36672eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
36682eca1d9cSJed Brown 
36692eca1d9cSJed Brown    Input Parameter:
36702eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
36712eca1d9cSJed Brown 
36722eca1d9cSJed Brown    Output Parameters:
3673e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3674e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
36752eca1d9cSJed Brown .  f   - The function to compute the matrices
36762eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
36772eca1d9cSJed Brown 
36780298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
36792eca1d9cSJed Brown 
36802eca1d9cSJed Brown    Level: advanced
36812eca1d9cSJed Brown 
36822eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
36832eca1d9cSJed Brown 
36842eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
36852eca1d9cSJed Brown @*/
3686e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
36872eca1d9cSJed Brown {
3688089b2837SJed Brown   PetscErrorCode ierr;
3689089b2837SJed Brown   SNES           snes;
369024989b8cSPeter Brune   DM             dm;
36910910c330SBarry Smith 
36922eca1d9cSJed Brown   PetscFunctionBegin;
3693089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3694f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3695e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
369624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
369724989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
36982eca1d9cSJed Brown   PetscFunctionReturn(0);
36992eca1d9cSJed Brown }
37002eca1d9cSJed Brown 
37016083293cSBarry Smith 
37022eca1d9cSJed Brown #undef __FUNCT__
370383a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
37041713a123SBarry Smith /*@C
370583a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
37061713a123SBarry Smith    VecView() for the solution at each timestep
37071713a123SBarry Smith 
37081713a123SBarry Smith    Collective on TS
37091713a123SBarry Smith 
37101713a123SBarry Smith    Input Parameters:
37111713a123SBarry Smith +  ts - the TS context
37121713a123SBarry Smith .  step - current time-step
3713142b95e3SSatish Balay .  ptime - current time
37140298fd71SBarry Smith -  dummy - either a viewer or NULL
37151713a123SBarry Smith 
371699fdda47SBarry Smith    Options Database:
371799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
371899fdda47SBarry Smith 
371999fdda47SBarry 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
372099fdda47SBarry Smith        will look bad
372199fdda47SBarry Smith 
37221713a123SBarry Smith    Level: intermediate
37231713a123SBarry Smith 
37241713a123SBarry Smith .keywords: TS,  vector, monitor, view
37251713a123SBarry Smith 
3726a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
37271713a123SBarry Smith @*/
37280910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
37291713a123SBarry Smith {
3730dfbe8321SBarry Smith   PetscErrorCode   ierr;
373183a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3732473a3ab2SBarry Smith   PetscDraw        draw;
37331713a123SBarry Smith 
37341713a123SBarry Smith   PetscFunctionBegin;
37356083293cSBarry Smith   if (!step && ictx->showinitial) {
37366083293cSBarry Smith     if (!ictx->initialsolution) {
37370910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
37381713a123SBarry Smith     }
37390910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
37406083293cSBarry Smith   }
3741b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
37420dcf80beSBarry Smith 
37436083293cSBarry Smith   if (ictx->showinitial) {
37446083293cSBarry Smith     PetscReal pause;
37456083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
37466083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
37476083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
37486083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
37496083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
37506083293cSBarry Smith   }
37510910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3752473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3753473a3ab2SBarry Smith     PetscReal xl,yl,xr,yr,tw,w,h;
3754473a3ab2SBarry Smith     char      time[32];
3755473a3ab2SBarry Smith     size_t    len;
3756473a3ab2SBarry Smith 
3757473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3758473a3ab2SBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
3759473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3760473a3ab2SBarry Smith     ierr =  PetscStrlen(time,&len);CHKERRQ(ierr);
37610298fd71SBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3762473a3ab2SBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
3763473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3764473a3ab2SBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3765473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3766473a3ab2SBarry Smith   }
3767473a3ab2SBarry Smith 
37686083293cSBarry Smith   if (ictx->showinitial) {
37696083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
37706083293cSBarry Smith   }
37711713a123SBarry Smith   PetscFunctionReturn(0);
37721713a123SBarry Smith }
37731713a123SBarry Smith 
37742d5ee99bSBarry Smith #undef __FUNCT__
37752d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
37762d5ee99bSBarry Smith /*@C
37772d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
37782d5ee99bSBarry Smith 
37792d5ee99bSBarry Smith    Collective on TS
37802d5ee99bSBarry Smith 
37812d5ee99bSBarry Smith    Input Parameters:
37822d5ee99bSBarry Smith +  ts - the TS context
37832d5ee99bSBarry Smith .  step - current time-step
37842d5ee99bSBarry Smith .  ptime - current time
37852d5ee99bSBarry Smith -  dummy - either a viewer or NULL
37862d5ee99bSBarry Smith 
37872d5ee99bSBarry Smith    Level: intermediate
37882d5ee99bSBarry Smith 
37892d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
37902d5ee99bSBarry Smith 
37912d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
37922d5ee99bSBarry Smith @*/
37932d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
37942d5ee99bSBarry Smith {
37952d5ee99bSBarry Smith   PetscErrorCode    ierr;
37962d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
37972d5ee99bSBarry Smith   PetscDraw         draw;
37982d5ee99bSBarry Smith   MPI_Comm          comm;
37992d5ee99bSBarry Smith   PetscInt          n;
38002d5ee99bSBarry Smith   PetscMPIInt       size;
38012d5ee99bSBarry Smith   PetscReal         xl,yl,xr,yr,tw,w,h;
38022d5ee99bSBarry Smith   char              time[32];
38032d5ee99bSBarry Smith   size_t            len;
38042d5ee99bSBarry Smith   const PetscScalar *U;
38052d5ee99bSBarry Smith 
38062d5ee99bSBarry Smith   PetscFunctionBegin;
38072d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
38082d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
38092d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
38102d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
38112d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
38122d5ee99bSBarry Smith 
38132d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
38142d5ee99bSBarry Smith 
38152d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
38164b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3817ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3818a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3819a4494fc1SBarry Smith       PetscFunctionReturn(0);
3820a4494fc1SBarry Smith   }
38212d5ee99bSBarry Smith   if (!step) ictx->color++;
38222d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
38232d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
38242d5ee99bSBarry Smith 
38252d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
38264b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
38272d5ee99bSBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
38282d5ee99bSBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
38292d5ee99bSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
38302d5ee99bSBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
38312d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
38322d5ee99bSBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
38332d5ee99bSBarry Smith   }
38342d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
38352d5ee99bSBarry Smith   PetscFunctionReturn(0);
38362d5ee99bSBarry Smith }
38372d5ee99bSBarry Smith 
38381713a123SBarry Smith 
38396c699258SBarry Smith #undef __FUNCT__
384083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
38416083293cSBarry Smith /*@C
384283a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
38436083293cSBarry Smith 
38446083293cSBarry Smith    Collective on TS
38456083293cSBarry Smith 
38466083293cSBarry Smith    Input Parameters:
38476083293cSBarry Smith .    ctx - the monitor context
38486083293cSBarry Smith 
38496083293cSBarry Smith    Level: intermediate
38506083293cSBarry Smith 
38516083293cSBarry Smith .keywords: TS,  vector, monitor, view
38526083293cSBarry Smith 
385383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
38546083293cSBarry Smith @*/
385583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
38566083293cSBarry Smith {
38576083293cSBarry Smith   PetscErrorCode ierr;
38586083293cSBarry Smith 
38596083293cSBarry Smith   PetscFunctionBegin;
38604b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
386183a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
386283a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
386383a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
38646083293cSBarry Smith   PetscFunctionReturn(0);
38656083293cSBarry Smith }
38666083293cSBarry Smith 
38676083293cSBarry Smith #undef __FUNCT__
386883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
38696083293cSBarry Smith /*@C
387083a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
38716083293cSBarry Smith 
38726083293cSBarry Smith    Collective on TS
38736083293cSBarry Smith 
38746083293cSBarry Smith    Input Parameter:
38756083293cSBarry Smith .    ts - time-step context
38766083293cSBarry Smith 
38776083293cSBarry Smith    Output Patameter:
38786083293cSBarry Smith .    ctx - the monitor context
38796083293cSBarry Smith 
388099fdda47SBarry Smith    Options Database:
388199fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
388299fdda47SBarry Smith 
38836083293cSBarry Smith    Level: intermediate
38846083293cSBarry Smith 
38856083293cSBarry Smith .keywords: TS,  vector, monitor, view
38866083293cSBarry Smith 
388783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
38886083293cSBarry Smith @*/
388983a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
38906083293cSBarry Smith {
38916083293cSBarry Smith   PetscErrorCode   ierr;
38926083293cSBarry Smith 
38936083293cSBarry Smith   PetscFunctionBegin;
3894b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
389583a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3896e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3897bbd56ea5SKarl Rupp 
389883a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3899473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
39000298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3901473a3ab2SBarry Smith 
3902473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
39030298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
39042d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
39056083293cSBarry Smith   PetscFunctionReturn(0);
39066083293cSBarry Smith }
39076083293cSBarry Smith 
39086083293cSBarry Smith #undef __FUNCT__
390983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
39103a471f94SBarry Smith /*@C
391183a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
39123a471f94SBarry Smith    VecView() for the error at each timestep
39133a471f94SBarry Smith 
39143a471f94SBarry Smith    Collective on TS
39153a471f94SBarry Smith 
39163a471f94SBarry Smith    Input Parameters:
39173a471f94SBarry Smith +  ts - the TS context
39183a471f94SBarry Smith .  step - current time-step
39193a471f94SBarry Smith .  ptime - current time
39200298fd71SBarry Smith -  dummy - either a viewer or NULL
39213a471f94SBarry Smith 
39223a471f94SBarry Smith    Level: intermediate
39233a471f94SBarry Smith 
39243a471f94SBarry Smith .keywords: TS,  vector, monitor, view
39253a471f94SBarry Smith 
39263a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
39273a471f94SBarry Smith @*/
39280910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
39293a471f94SBarry Smith {
39303a471f94SBarry Smith   PetscErrorCode   ierr;
393183a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
393283a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
39333a471f94SBarry Smith   Vec              work;
39343a471f94SBarry Smith 
39353a471f94SBarry Smith   PetscFunctionBegin;
3936b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
39370910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
39383a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
39390910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
39403a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
39413a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
39423a471f94SBarry Smith   PetscFunctionReturn(0);
39433a471f94SBarry Smith }
39443a471f94SBarry Smith 
39452a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
39463a471f94SBarry Smith #undef __FUNCT__
39476c699258SBarry Smith #define __FUNCT__ "TSSetDM"
39486c699258SBarry Smith /*@
39496c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
39506c699258SBarry Smith 
39513f9fe445SBarry Smith    Logically Collective on TS and DM
39526c699258SBarry Smith 
39536c699258SBarry Smith    Input Parameters:
39546c699258SBarry Smith +  ts - the preconditioner context
39556c699258SBarry Smith -  dm - the dm
39566c699258SBarry Smith 
39576c699258SBarry Smith    Level: intermediate
39586c699258SBarry Smith 
39596c699258SBarry Smith 
39606c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
39616c699258SBarry Smith @*/
39627087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
39636c699258SBarry Smith {
39646c699258SBarry Smith   PetscErrorCode ierr;
3965089b2837SJed Brown   SNES           snes;
3966942e3340SBarry Smith   DMTS           tsdm;
39676c699258SBarry Smith 
39686c699258SBarry Smith   PetscFunctionBegin;
39690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
397070663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
3971942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
39722a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
3973942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
3974942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
397524989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
397624989b8cSPeter Brune         tsdm->originaldm = dm;
397724989b8cSPeter Brune       }
397824989b8cSPeter Brune     }
39796bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
398024989b8cSPeter Brune   }
39816c699258SBarry Smith   ts->dm = dm;
3982bbd56ea5SKarl Rupp 
3983089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3984089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
39856c699258SBarry Smith   PetscFunctionReturn(0);
39866c699258SBarry Smith }
39876c699258SBarry Smith 
39886c699258SBarry Smith #undef __FUNCT__
39896c699258SBarry Smith #define __FUNCT__ "TSGetDM"
39906c699258SBarry Smith /*@
39916c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
39926c699258SBarry Smith 
39933f9fe445SBarry Smith    Not Collective
39946c699258SBarry Smith 
39956c699258SBarry Smith    Input Parameter:
39966c699258SBarry Smith . ts - the preconditioner context
39976c699258SBarry Smith 
39986c699258SBarry Smith    Output Parameter:
39996c699258SBarry Smith .  dm - the dm
40006c699258SBarry Smith 
40016c699258SBarry Smith    Level: intermediate
40026c699258SBarry Smith 
40036c699258SBarry Smith 
40046c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
40056c699258SBarry Smith @*/
40067087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
40076c699258SBarry Smith {
4008496e6a7aSJed Brown   PetscErrorCode ierr;
4009496e6a7aSJed Brown 
40106c699258SBarry Smith   PetscFunctionBegin;
40110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4012496e6a7aSJed Brown   if (!ts->dm) {
4013ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4014496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4015496e6a7aSJed Brown   }
40166c699258SBarry Smith   *dm = ts->dm;
40176c699258SBarry Smith   PetscFunctionReturn(0);
40186c699258SBarry Smith }
40191713a123SBarry Smith 
40200f5c6efeSJed Brown #undef __FUNCT__
40210f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
40220f5c6efeSJed Brown /*@
40230f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
40240f5c6efeSJed Brown 
40253f9fe445SBarry Smith    Logically Collective on SNES
40260f5c6efeSJed Brown 
40270f5c6efeSJed Brown    Input Parameter:
4028d42a1c89SJed Brown + snes - nonlinear solver
40290910c330SBarry Smith . U - the current state at which to evaluate the residual
4030d42a1c89SJed Brown - ctx - user context, must be a TS
40310f5c6efeSJed Brown 
40320f5c6efeSJed Brown    Output Parameter:
40330f5c6efeSJed Brown . F - the nonlinear residual
40340f5c6efeSJed Brown 
40350f5c6efeSJed Brown    Notes:
40360f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
40370f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
40380f5c6efeSJed Brown 
40390f5c6efeSJed Brown    Level: advanced
40400f5c6efeSJed Brown 
40410f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
40420f5c6efeSJed Brown @*/
40430910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
40440f5c6efeSJed Brown {
40450f5c6efeSJed Brown   TS             ts = (TS)ctx;
40460f5c6efeSJed Brown   PetscErrorCode ierr;
40470f5c6efeSJed Brown 
40480f5c6efeSJed Brown   PetscFunctionBegin;
40490f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
40500910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
40510f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
40520f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
40530910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
40540f5c6efeSJed Brown   PetscFunctionReturn(0);
40550f5c6efeSJed Brown }
40560f5c6efeSJed Brown 
40570f5c6efeSJed Brown #undef __FUNCT__
40580f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
40590f5c6efeSJed Brown /*@
40600f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
40610f5c6efeSJed Brown 
40620f5c6efeSJed Brown    Collective on SNES
40630f5c6efeSJed Brown 
40640f5c6efeSJed Brown    Input Parameter:
40650f5c6efeSJed Brown + snes - nonlinear solver
40660910c330SBarry Smith . U - the current state at which to evaluate the residual
40670f5c6efeSJed Brown - ctx - user context, must be a TS
40680f5c6efeSJed Brown 
40690f5c6efeSJed Brown    Output Parameter:
40700f5c6efeSJed Brown + A - the Jacobian
40710f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
40720f5c6efeSJed Brown - flag - indicates any structure change in the matrix
40730f5c6efeSJed Brown 
40740f5c6efeSJed Brown    Notes:
40750f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
40760f5c6efeSJed Brown 
40770f5c6efeSJed Brown    Level: developer
40780f5c6efeSJed Brown 
40790f5c6efeSJed Brown .seealso: SNESSetJacobian()
40800f5c6efeSJed Brown @*/
4081d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
40820f5c6efeSJed Brown {
40830f5c6efeSJed Brown   TS             ts = (TS)ctx;
40840f5c6efeSJed Brown   PetscErrorCode ierr;
40850f5c6efeSJed Brown 
40860f5c6efeSJed Brown   PetscFunctionBegin;
40870f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
40880910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
40890f5c6efeSJed Brown   PetscValidPointer(A,3);
409094ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
40910f5c6efeSJed Brown   PetscValidPointer(B,4);
409294ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
40930f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4094d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
40950f5c6efeSJed Brown   PetscFunctionReturn(0);
40960f5c6efeSJed Brown }
4097325fc9f4SBarry Smith 
40980e4ef248SJed Brown #undef __FUNCT__
40990e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
41000e4ef248SJed Brown /*@C
41010e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
41020e4ef248SJed Brown 
41030e4ef248SJed Brown    Collective on TS
41040e4ef248SJed Brown 
41050e4ef248SJed Brown    Input Arguments:
41060e4ef248SJed Brown +  ts - time stepping context
41070e4ef248SJed Brown .  t - time at which to evaluate
41080910c330SBarry Smith .  U - state at which to evaluate
41090e4ef248SJed Brown -  ctx - context
41100e4ef248SJed Brown 
41110e4ef248SJed Brown    Output Arguments:
41120e4ef248SJed Brown .  F - right hand side
41130e4ef248SJed Brown 
41140e4ef248SJed Brown    Level: intermediate
41150e4ef248SJed Brown 
41160e4ef248SJed Brown    Notes:
41170e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
41180e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
41190e4ef248SJed Brown 
41200e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
41210e4ef248SJed Brown @*/
41220910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
41230e4ef248SJed Brown {
41240e4ef248SJed Brown   PetscErrorCode ierr;
41250e4ef248SJed Brown   Mat            Arhs,Brhs;
41260e4ef248SJed Brown 
41270e4ef248SJed Brown   PetscFunctionBegin;
41280e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4129d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
41300910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
41310e4ef248SJed Brown   PetscFunctionReturn(0);
41320e4ef248SJed Brown }
41330e4ef248SJed Brown 
41340e4ef248SJed Brown #undef __FUNCT__
41350e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
41360e4ef248SJed Brown /*@C
41370e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
41380e4ef248SJed Brown 
41390e4ef248SJed Brown    Collective on TS
41400e4ef248SJed Brown 
41410e4ef248SJed Brown    Input Arguments:
41420e4ef248SJed Brown +  ts - time stepping context
41430e4ef248SJed Brown .  t - time at which to evaluate
41440910c330SBarry Smith .  U - state at which to evaluate
41450e4ef248SJed Brown -  ctx - context
41460e4ef248SJed Brown 
41470e4ef248SJed Brown    Output Arguments:
41480e4ef248SJed Brown +  A - pointer to operator
41490e4ef248SJed Brown .  B - pointer to preconditioning matrix
41500e4ef248SJed Brown -  flg - matrix structure flag
41510e4ef248SJed Brown 
41520e4ef248SJed Brown    Level: intermediate
41530e4ef248SJed Brown 
41540e4ef248SJed Brown    Notes:
41550e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
41560e4ef248SJed Brown 
41570e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
41580e4ef248SJed Brown @*/
4159d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
41600e4ef248SJed Brown {
41610e4ef248SJed Brown   PetscFunctionBegin;
41620e4ef248SJed Brown   PetscFunctionReturn(0);
41630e4ef248SJed Brown }
41640e4ef248SJed Brown 
41650026cea9SSean Farley #undef __FUNCT__
41660026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
41670026cea9SSean Farley /*@C
41680026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
41690026cea9SSean Farley 
41700026cea9SSean Farley    Collective on TS
41710026cea9SSean Farley 
41720026cea9SSean Farley    Input Arguments:
41730026cea9SSean Farley +  ts - time stepping context
41740026cea9SSean Farley .  t - time at which to evaluate
41750910c330SBarry Smith .  U - state at which to evaluate
41760910c330SBarry Smith .  Udot - time derivative of state vector
41770026cea9SSean Farley -  ctx - context
41780026cea9SSean Farley 
41790026cea9SSean Farley    Output Arguments:
41800026cea9SSean Farley .  F - left hand side
41810026cea9SSean Farley 
41820026cea9SSean Farley    Level: intermediate
41830026cea9SSean Farley 
41840026cea9SSean Farley    Notes:
41850910c330SBarry 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
41860026cea9SSean Farley    user is required to write their own TSComputeIFunction.
41870026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
41880026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
41890026cea9SSean Farley 
41900026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
41910026cea9SSean Farley @*/
41920910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
41930026cea9SSean Farley {
41940026cea9SSean Farley   PetscErrorCode ierr;
41950026cea9SSean Farley   Mat            A,B;
41960026cea9SSean Farley 
41970026cea9SSean Farley   PetscFunctionBegin;
41980298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4199d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
42000910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
42010026cea9SSean Farley   PetscFunctionReturn(0);
42020026cea9SSean Farley }
42030026cea9SSean Farley 
42040026cea9SSean Farley #undef __FUNCT__
42050026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
42060026cea9SSean Farley /*@C
4207b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
42080026cea9SSean Farley 
42090026cea9SSean Farley    Collective on TS
42100026cea9SSean Farley 
42110026cea9SSean Farley    Input Arguments:
42120026cea9SSean Farley +  ts - time stepping context
42130026cea9SSean Farley .  t - time at which to evaluate
42140910c330SBarry Smith .  U - state at which to evaluate
42150910c330SBarry Smith .  Udot - time derivative of state vector
42160026cea9SSean Farley .  shift - shift to apply
42170026cea9SSean Farley -  ctx - context
42180026cea9SSean Farley 
42190026cea9SSean Farley    Output Arguments:
42200026cea9SSean Farley +  A - pointer to operator
42210026cea9SSean Farley .  B - pointer to preconditioning matrix
42220026cea9SSean Farley -  flg - matrix structure flag
42230026cea9SSean Farley 
4224b41af12eSJed Brown    Level: advanced
42250026cea9SSean Farley 
42260026cea9SSean Farley    Notes:
42270026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
42280026cea9SSean Farley 
4229b41af12eSJed Brown    It is only appropriate for problems of the form
4230b41af12eSJed Brown 
4231b41af12eSJed Brown $     M Udot = F(U,t)
4232b41af12eSJed Brown 
4233b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4234b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4235b41af12eSJed Brown   an implicit operator of the form
4236b41af12eSJed Brown 
4237b41af12eSJed Brown $    shift*M + J
4238b41af12eSJed Brown 
4239b41af12eSJed 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
4240b41af12eSJed Brown   a copy of M or reassemble it when requested.
4241b41af12eSJed Brown 
42420026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
42430026cea9SSean Farley @*/
4244d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
42450026cea9SSean Farley {
4246b41af12eSJed Brown   PetscErrorCode ierr;
4247b41af12eSJed Brown 
42480026cea9SSean Farley   PetscFunctionBegin;
424994ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4250b41af12eSJed Brown   ts->ijacobian.shift = shift;
42510026cea9SSean Farley   PetscFunctionReturn(0);
42520026cea9SSean Farley }
4253b41af12eSJed Brown 
4254e817cc15SEmil Constantinescu #undef __FUNCT__
4255e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4256e817cc15SEmil Constantinescu /*@
4257e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4258e817cc15SEmil Constantinescu 
4259e817cc15SEmil Constantinescu    Not Collective
4260e817cc15SEmil Constantinescu 
4261e817cc15SEmil Constantinescu    Input Parameter:
4262e817cc15SEmil Constantinescu .  ts - the TS context
4263e817cc15SEmil Constantinescu 
4264e817cc15SEmil Constantinescu    Output Parameter:
42654e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4266e817cc15SEmil Constantinescu 
4267e817cc15SEmil Constantinescu    Level: beginner
4268e817cc15SEmil Constantinescu 
4269e817cc15SEmil Constantinescu .keywords: TS, equation type
4270e817cc15SEmil Constantinescu 
4271e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4272e817cc15SEmil Constantinescu @*/
4273e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4274e817cc15SEmil Constantinescu {
4275e817cc15SEmil Constantinescu   PetscFunctionBegin;
4276e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4277e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4278e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4279e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4280e817cc15SEmil Constantinescu }
4281e817cc15SEmil Constantinescu 
4282e817cc15SEmil Constantinescu #undef __FUNCT__
4283e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4284e817cc15SEmil Constantinescu /*@
4285e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4286e817cc15SEmil Constantinescu 
4287e817cc15SEmil Constantinescu    Not Collective
4288e817cc15SEmil Constantinescu 
4289e817cc15SEmil Constantinescu    Input Parameter:
4290e817cc15SEmil Constantinescu +  ts - the TS context
42914e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4292e817cc15SEmil Constantinescu 
4293e817cc15SEmil Constantinescu    Level: advanced
4294e817cc15SEmil Constantinescu 
4295e817cc15SEmil Constantinescu .keywords: TS, equation type
4296e817cc15SEmil Constantinescu 
4297e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4298e817cc15SEmil Constantinescu @*/
4299e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4300e817cc15SEmil Constantinescu {
4301e817cc15SEmil Constantinescu   PetscFunctionBegin;
4302e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4303e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4304e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4305e817cc15SEmil Constantinescu }
43060026cea9SSean Farley 
43074af1b03aSJed Brown #undef __FUNCT__
43084af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
43094af1b03aSJed Brown /*@
43104af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
43114af1b03aSJed Brown 
43124af1b03aSJed Brown    Not Collective
43134af1b03aSJed Brown 
43144af1b03aSJed Brown    Input Parameter:
43154af1b03aSJed Brown .  ts - the TS context
43164af1b03aSJed Brown 
43174af1b03aSJed Brown    Output Parameter:
43184af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
43194af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
43204af1b03aSJed Brown 
4321487e0bb9SJed Brown    Level: beginner
43224af1b03aSJed Brown 
4323cd652676SJed Brown    Notes:
4324cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
43254af1b03aSJed Brown 
43264af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
43274af1b03aSJed Brown 
43284af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
43294af1b03aSJed Brown @*/
43304af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
43314af1b03aSJed Brown {
43324af1b03aSJed Brown   PetscFunctionBegin;
43334af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
43344af1b03aSJed Brown   PetscValidPointer(reason,2);
43354af1b03aSJed Brown   *reason = ts->reason;
43364af1b03aSJed Brown   PetscFunctionReturn(0);
43374af1b03aSJed Brown }
43384af1b03aSJed Brown 
4339fb1732b5SBarry Smith #undef __FUNCT__
4340d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4341d6ad946cSShri Abhyankar /*@
4342d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4343d6ad946cSShri Abhyankar 
4344d6ad946cSShri Abhyankar    Not Collective
4345d6ad946cSShri Abhyankar 
4346d6ad946cSShri Abhyankar    Input Parameter:
4347d6ad946cSShri Abhyankar +  ts - the TS context
4348d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4349d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4350d6ad946cSShri Abhyankar 
4351f5abba47SShri Abhyankar    Level: advanced
4352d6ad946cSShri Abhyankar 
4353d6ad946cSShri Abhyankar    Notes:
4354d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4355d6ad946cSShri Abhyankar 
4356d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4357d6ad946cSShri Abhyankar 
4358d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4359d6ad946cSShri Abhyankar @*/
4360d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4361d6ad946cSShri Abhyankar {
4362d6ad946cSShri Abhyankar   PetscFunctionBegin;
4363d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4364d6ad946cSShri Abhyankar   ts->reason = reason;
4365d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4366d6ad946cSShri Abhyankar }
4367d6ad946cSShri Abhyankar 
4368d6ad946cSShri Abhyankar #undef __FUNCT__
4369cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4370cc708dedSBarry Smith /*@
4371cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4372cc708dedSBarry Smith 
4373cc708dedSBarry Smith    Not Collective
4374cc708dedSBarry Smith 
4375cc708dedSBarry Smith    Input Parameter:
4376cc708dedSBarry Smith .  ts - the TS context
4377cc708dedSBarry Smith 
4378cc708dedSBarry Smith    Output Parameter:
4379cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4380cc708dedSBarry Smith 
4381487e0bb9SJed Brown    Level: beginner
4382cc708dedSBarry Smith 
4383cc708dedSBarry Smith    Notes:
4384cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4385cc708dedSBarry Smith 
4386cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4387cc708dedSBarry Smith 
4388cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4389cc708dedSBarry Smith @*/
4390cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4391cc708dedSBarry Smith {
4392cc708dedSBarry Smith   PetscFunctionBegin;
4393cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4394cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4395cc708dedSBarry Smith   *ftime = ts->solvetime;
4396cc708dedSBarry Smith   PetscFunctionReturn(0);
4397cc708dedSBarry Smith }
4398cc708dedSBarry Smith 
4399cc708dedSBarry Smith #undef __FUNCT__
44005ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
44019f67acb7SJed Brown /*@
44025ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
44039f67acb7SJed Brown    used by the time integrator.
44049f67acb7SJed Brown 
44059f67acb7SJed Brown    Not Collective
44069f67acb7SJed Brown 
44079f67acb7SJed Brown    Input Parameter:
44089f67acb7SJed Brown .  ts - TS context
44099f67acb7SJed Brown 
44109f67acb7SJed Brown    Output Parameter:
44119f67acb7SJed Brown .  nits - number of nonlinear iterations
44129f67acb7SJed Brown 
44139f67acb7SJed Brown    Notes:
44149f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
44159f67acb7SJed Brown 
44169f67acb7SJed Brown    Level: intermediate
44179f67acb7SJed Brown 
44189f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
44199f67acb7SJed Brown 
44205ef26d82SJed Brown .seealso:  TSGetKSPIterations()
44219f67acb7SJed Brown @*/
44225ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
44239f67acb7SJed Brown {
44249f67acb7SJed Brown   PetscFunctionBegin;
44259f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44269f67acb7SJed Brown   PetscValidIntPointer(nits,2);
44275ef26d82SJed Brown   *nits = ts->snes_its;
44289f67acb7SJed Brown   PetscFunctionReturn(0);
44299f67acb7SJed Brown }
44309f67acb7SJed Brown 
44319f67acb7SJed Brown #undef __FUNCT__
44325ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
44339f67acb7SJed Brown /*@
44345ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
44359f67acb7SJed Brown    used by the time integrator.
44369f67acb7SJed Brown 
44379f67acb7SJed Brown    Not Collective
44389f67acb7SJed Brown 
44399f67acb7SJed Brown    Input Parameter:
44409f67acb7SJed Brown .  ts - TS context
44419f67acb7SJed Brown 
44429f67acb7SJed Brown    Output Parameter:
44439f67acb7SJed Brown .  lits - number of linear iterations
44449f67acb7SJed Brown 
44459f67acb7SJed Brown    Notes:
44469f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
44479f67acb7SJed Brown 
44489f67acb7SJed Brown    Level: intermediate
44499f67acb7SJed Brown 
44509f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
44519f67acb7SJed Brown 
44525ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
44539f67acb7SJed Brown @*/
44545ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
44559f67acb7SJed Brown {
44569f67acb7SJed Brown   PetscFunctionBegin;
44579f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44589f67acb7SJed Brown   PetscValidIntPointer(lits,2);
44595ef26d82SJed Brown   *lits = ts->ksp_its;
44609f67acb7SJed Brown   PetscFunctionReturn(0);
44619f67acb7SJed Brown }
44629f67acb7SJed Brown 
44639f67acb7SJed Brown #undef __FUNCT__
4464cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4465cef5090cSJed Brown /*@
4466cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4467cef5090cSJed Brown 
4468cef5090cSJed Brown    Not Collective
4469cef5090cSJed Brown 
4470cef5090cSJed Brown    Input Parameter:
4471cef5090cSJed Brown .  ts - TS context
4472cef5090cSJed Brown 
4473cef5090cSJed Brown    Output Parameter:
4474cef5090cSJed Brown .  rejects - number of steps rejected
4475cef5090cSJed Brown 
4476cef5090cSJed Brown    Notes:
4477cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4478cef5090cSJed Brown 
4479cef5090cSJed Brown    Level: intermediate
4480cef5090cSJed Brown 
4481cef5090cSJed Brown .keywords: TS, get, number
4482cef5090cSJed Brown 
44835ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4484cef5090cSJed Brown @*/
4485cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4486cef5090cSJed Brown {
4487cef5090cSJed Brown   PetscFunctionBegin;
4488cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4489cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4490cef5090cSJed Brown   *rejects = ts->reject;
4491cef5090cSJed Brown   PetscFunctionReturn(0);
4492cef5090cSJed Brown }
4493cef5090cSJed Brown 
4494cef5090cSJed Brown #undef __FUNCT__
4495cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4496cef5090cSJed Brown /*@
4497cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4498cef5090cSJed Brown 
4499cef5090cSJed Brown    Not Collective
4500cef5090cSJed Brown 
4501cef5090cSJed Brown    Input Parameter:
4502cef5090cSJed Brown .  ts - TS context
4503cef5090cSJed Brown 
4504cef5090cSJed Brown    Output Parameter:
4505cef5090cSJed Brown .  fails - number of failed nonlinear solves
4506cef5090cSJed Brown 
4507cef5090cSJed Brown    Notes:
4508cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4509cef5090cSJed Brown 
4510cef5090cSJed Brown    Level: intermediate
4511cef5090cSJed Brown 
4512cef5090cSJed Brown .keywords: TS, get, number
4513cef5090cSJed Brown 
45145ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4515cef5090cSJed Brown @*/
4516cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4517cef5090cSJed Brown {
4518cef5090cSJed Brown   PetscFunctionBegin;
4519cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4520cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4521cef5090cSJed Brown   *fails = ts->num_snes_failures;
4522cef5090cSJed Brown   PetscFunctionReturn(0);
4523cef5090cSJed Brown }
4524cef5090cSJed Brown 
4525cef5090cSJed Brown #undef __FUNCT__
4526cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4527cef5090cSJed Brown /*@
4528cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4529cef5090cSJed Brown 
4530cef5090cSJed Brown    Not Collective
4531cef5090cSJed Brown 
4532cef5090cSJed Brown    Input Parameter:
4533cef5090cSJed Brown +  ts - TS context
4534cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4535cef5090cSJed Brown 
4536cef5090cSJed Brown    Notes:
4537cef5090cSJed Brown    The counter is reset to zero for each step
4538cef5090cSJed Brown 
4539cef5090cSJed Brown    Options Database Key:
4540cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4541cef5090cSJed Brown 
4542cef5090cSJed Brown    Level: intermediate
4543cef5090cSJed Brown 
4544cef5090cSJed Brown .keywords: TS, set, maximum, number
4545cef5090cSJed Brown 
45465ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4547cef5090cSJed Brown @*/
4548cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4549cef5090cSJed Brown {
4550cef5090cSJed Brown   PetscFunctionBegin;
4551cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4552cef5090cSJed Brown   ts->max_reject = rejects;
4553cef5090cSJed Brown   PetscFunctionReturn(0);
4554cef5090cSJed Brown }
4555cef5090cSJed Brown 
4556cef5090cSJed Brown #undef __FUNCT__
4557cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4558cef5090cSJed Brown /*@
4559cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4560cef5090cSJed Brown 
4561cef5090cSJed Brown    Not Collective
4562cef5090cSJed Brown 
4563cef5090cSJed Brown    Input Parameter:
4564cef5090cSJed Brown +  ts - TS context
4565cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4566cef5090cSJed Brown 
4567cef5090cSJed Brown    Notes:
4568cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4569cef5090cSJed Brown 
4570cef5090cSJed Brown    Options Database Key:
4571cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4572cef5090cSJed Brown 
4573cef5090cSJed Brown    Level: intermediate
4574cef5090cSJed Brown 
4575cef5090cSJed Brown .keywords: TS, set, maximum, number
4576cef5090cSJed Brown 
45775ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4578cef5090cSJed Brown @*/
4579cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4580cef5090cSJed Brown {
4581cef5090cSJed Brown   PetscFunctionBegin;
4582cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4583cef5090cSJed Brown   ts->max_snes_failures = fails;
4584cef5090cSJed Brown   PetscFunctionReturn(0);
4585cef5090cSJed Brown }
4586cef5090cSJed Brown 
4587cef5090cSJed Brown #undef __FUNCT__
45884e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4589cef5090cSJed Brown /*@
4590cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4591cef5090cSJed Brown 
4592cef5090cSJed Brown    Not Collective
4593cef5090cSJed Brown 
4594cef5090cSJed Brown    Input Parameter:
4595cef5090cSJed Brown +  ts - TS context
4596cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4597cef5090cSJed Brown 
4598cef5090cSJed Brown    Options Database Key:
4599cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4600cef5090cSJed Brown 
4601cef5090cSJed Brown    Level: intermediate
4602cef5090cSJed Brown 
4603cef5090cSJed Brown .keywords: TS, set, error
4604cef5090cSJed Brown 
46055ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4606cef5090cSJed Brown @*/
4607cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4608cef5090cSJed Brown {
4609cef5090cSJed Brown   PetscFunctionBegin;
4610cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4611cef5090cSJed Brown   ts->errorifstepfailed = err;
4612cef5090cSJed Brown   PetscFunctionReturn(0);
4613cef5090cSJed Brown }
4614cef5090cSJed Brown 
4615cef5090cSJed Brown #undef __FUNCT__
4616fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4617fb1732b5SBarry Smith /*@C
4618fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4619fb1732b5SBarry Smith 
4620fb1732b5SBarry Smith    Collective on TS
4621fb1732b5SBarry Smith 
4622fb1732b5SBarry Smith    Input Parameters:
4623fb1732b5SBarry Smith +  ts - the TS context
4624fb1732b5SBarry Smith .  step - current time-step
4625fb1732b5SBarry Smith .  ptime - current time
46260910c330SBarry Smith .  u - current state
4627fb1732b5SBarry Smith -  viewer - binary viewer
4628fb1732b5SBarry Smith 
4629fb1732b5SBarry Smith    Level: intermediate
4630fb1732b5SBarry Smith 
4631fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4632fb1732b5SBarry Smith 
4633fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4634fb1732b5SBarry Smith @*/
46350910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4636fb1732b5SBarry Smith {
4637fb1732b5SBarry Smith   PetscErrorCode ierr;
4638ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4639fb1732b5SBarry Smith 
4640fb1732b5SBarry Smith   PetscFunctionBegin;
46410910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4642ed81e22dSJed Brown   PetscFunctionReturn(0);
4643ed81e22dSJed Brown }
4644ed81e22dSJed Brown 
4645ed81e22dSJed Brown #undef __FUNCT__
4646ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4647ed81e22dSJed Brown /*@C
4648ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4649ed81e22dSJed Brown 
4650ed81e22dSJed Brown    Collective on TS
4651ed81e22dSJed Brown 
4652ed81e22dSJed Brown    Input Parameters:
4653ed81e22dSJed Brown +  ts - the TS context
4654ed81e22dSJed Brown .  step - current time-step
4655ed81e22dSJed Brown .  ptime - current time
46560910c330SBarry Smith .  u - current state
4657ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4658ed81e22dSJed Brown 
4659ed81e22dSJed Brown    Level: intermediate
4660ed81e22dSJed Brown 
4661ed81e22dSJed Brown    Notes:
4662ed81e22dSJed 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.
4663ed81e22dSJed Brown    These are named according to the file name template.
4664ed81e22dSJed Brown 
4665ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4666ed81e22dSJed Brown 
4667ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4668ed81e22dSJed Brown 
4669ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4670ed81e22dSJed Brown @*/
46710910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4672ed81e22dSJed Brown {
4673ed81e22dSJed Brown   PetscErrorCode ierr;
4674ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4675ed81e22dSJed Brown   PetscViewer    viewer;
4676ed81e22dSJed Brown 
4677ed81e22dSJed Brown   PetscFunctionBegin;
46788caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4679ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
46800910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4681ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4682ed81e22dSJed Brown   PetscFunctionReturn(0);
4683ed81e22dSJed Brown }
4684ed81e22dSJed Brown 
4685ed81e22dSJed Brown #undef __FUNCT__
4686ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4687ed81e22dSJed Brown /*@C
4688ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4689ed81e22dSJed Brown 
4690ed81e22dSJed Brown    Collective on TS
4691ed81e22dSJed Brown 
4692ed81e22dSJed Brown    Input Parameters:
4693ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4694ed81e22dSJed Brown 
4695ed81e22dSJed Brown    Level: intermediate
4696ed81e22dSJed Brown 
4697ed81e22dSJed Brown    Note:
4698ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4699ed81e22dSJed Brown 
4700ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4701ed81e22dSJed Brown 
4702ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4703ed81e22dSJed Brown @*/
4704ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4705ed81e22dSJed Brown {
4706ed81e22dSJed Brown   PetscErrorCode ierr;
4707ed81e22dSJed Brown 
4708ed81e22dSJed Brown   PetscFunctionBegin;
4709ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4710fb1732b5SBarry Smith   PetscFunctionReturn(0);
4711fb1732b5SBarry Smith }
4712fb1732b5SBarry Smith 
471384df9cb4SJed Brown #undef __FUNCT__
4714552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
471584df9cb4SJed Brown /*@
4716552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
471784df9cb4SJed Brown 
4718ed81e22dSJed Brown    Collective on TS if controller has not been created yet
471984df9cb4SJed Brown 
472084df9cb4SJed Brown    Input Arguments:
4721ed81e22dSJed Brown .  ts - time stepping context
472284df9cb4SJed Brown 
472384df9cb4SJed Brown    Output Arguments:
4724ed81e22dSJed Brown .  adapt - adaptive controller
472584df9cb4SJed Brown 
472684df9cb4SJed Brown    Level: intermediate
472784df9cb4SJed Brown 
4728ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
472984df9cb4SJed Brown @*/
4730552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
473184df9cb4SJed Brown {
473284df9cb4SJed Brown   PetscErrorCode ierr;
473384df9cb4SJed Brown 
473484df9cb4SJed Brown   PetscFunctionBegin;
473584df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
473684df9cb4SJed Brown   PetscValidPointer(adapt,2);
473784df9cb4SJed Brown   if (!ts->adapt) {
4738ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
47393bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
47401c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
474184df9cb4SJed Brown   }
474284df9cb4SJed Brown   *adapt = ts->adapt;
474384df9cb4SJed Brown   PetscFunctionReturn(0);
474484df9cb4SJed Brown }
4745d6ebe24aSShri Abhyankar 
4746d6ebe24aSShri Abhyankar #undef __FUNCT__
47471c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
47481c3436cfSJed Brown /*@
47491c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
47501c3436cfSJed Brown 
47511c3436cfSJed Brown    Logically Collective
47521c3436cfSJed Brown 
47531c3436cfSJed Brown    Input Arguments:
47541c3436cfSJed Brown +  ts - time integration context
47551c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
47560298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
47571c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
47580298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
47591c3436cfSJed Brown 
4760a3cdaa26SBarry Smith    Options Database keys:
4761a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4762a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4763a3cdaa26SBarry Smith 
47641c3436cfSJed Brown    Level: beginner
47651c3436cfSJed Brown 
4766c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
47671c3436cfSJed Brown @*/
47681c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
47691c3436cfSJed Brown {
47701c3436cfSJed Brown   PetscErrorCode ierr;
47711c3436cfSJed Brown 
47721c3436cfSJed Brown   PetscFunctionBegin;
4773c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
47741c3436cfSJed Brown   if (vatol) {
47751c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
47761c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4777bbd56ea5SKarl Rupp 
47781c3436cfSJed Brown     ts->vatol = vatol;
47791c3436cfSJed Brown   }
4780c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
47811c3436cfSJed Brown   if (vrtol) {
47821c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
47831c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4784bbd56ea5SKarl Rupp 
47851c3436cfSJed Brown     ts->vrtol = vrtol;
47861c3436cfSJed Brown   }
47871c3436cfSJed Brown   PetscFunctionReturn(0);
47881c3436cfSJed Brown }
47891c3436cfSJed Brown 
47901c3436cfSJed Brown #undef __FUNCT__
4791c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4792c5033834SJed Brown /*@
4793c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4794c5033834SJed Brown 
4795c5033834SJed Brown    Logically Collective
4796c5033834SJed Brown 
4797c5033834SJed Brown    Input Arguments:
4798c5033834SJed Brown .  ts - time integration context
4799c5033834SJed Brown 
4800c5033834SJed Brown    Output Arguments:
48010298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
48020298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
48030298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
48040298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4805c5033834SJed Brown 
4806c5033834SJed Brown    Level: beginner
4807c5033834SJed Brown 
4808c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4809c5033834SJed Brown @*/
4810c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4811c5033834SJed Brown {
4812c5033834SJed Brown   PetscFunctionBegin;
4813c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4814c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4815c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4816c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4817c5033834SJed Brown   PetscFunctionReturn(0);
4818c5033834SJed Brown }
4819c5033834SJed Brown 
4820c5033834SJed Brown #undef __FUNCT__
48211c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
48221c3436cfSJed Brown /*@
48231c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
48241c3436cfSJed Brown 
48251c3436cfSJed Brown    Collective on TS
48261c3436cfSJed Brown 
48271c3436cfSJed Brown    Input Arguments:
48281c3436cfSJed Brown +  ts - time stepping context
48291c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
48301c3436cfSJed Brown 
48311c3436cfSJed Brown    Output Arguments:
48321c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
48331c3436cfSJed Brown 
48341c3436cfSJed Brown    Level: developer
48351c3436cfSJed Brown 
48361c3436cfSJed Brown .seealso: TSSetTolerances()
48371c3436cfSJed Brown @*/
48381c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
48391c3436cfSJed Brown {
48401c3436cfSJed Brown   PetscErrorCode    ierr;
48411c3436cfSJed Brown   PetscInt          i,n,N;
48420910c330SBarry Smith   const PetscScalar *u,*y;
48430910c330SBarry Smith   Vec               U;
48441c3436cfSJed Brown   PetscReal         sum,gsum;
48451c3436cfSJed Brown 
48461c3436cfSJed Brown   PetscFunctionBegin;
48471c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48481c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
48491c3436cfSJed Brown   PetscValidPointer(norm,3);
48500910c330SBarry Smith   U = ts->vec_sol;
48510910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
4852ce94432eSBarry Smith   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
48531c3436cfSJed Brown 
48540910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
48550910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
48560910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
48571c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
48581c3436cfSJed Brown   sum  = 0.;
4859ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
4860ceefc113SJed Brown     const PetscScalar *atol,*rtol;
4861ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4862ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4863ceefc113SJed Brown     for (i=0; i<n; i++) {
48640910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
48650910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4866ceefc113SJed Brown     }
4867ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4868ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4869ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4870ceefc113SJed Brown     const PetscScalar *atol;
4871ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4872ceefc113SJed Brown     for (i=0; i<n; i++) {
48730910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
48740910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4875ceefc113SJed Brown     }
4876ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4877ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4878ceefc113SJed Brown     const PetscScalar *rtol;
4879ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4880ceefc113SJed Brown     for (i=0; i<n; i++) {
48810910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
48820910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4883ceefc113SJed Brown     }
4884ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4885ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
48861c3436cfSJed Brown     for (i=0; i<n; i++) {
48870910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
48880910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
48891c3436cfSJed Brown     }
4890ceefc113SJed Brown   }
48910910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
48921c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
48931c3436cfSJed Brown 
4894ce94432eSBarry Smith   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
48951c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
4896620fc8aaSSatish Balay   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
48971c3436cfSJed Brown   PetscFunctionReturn(0);
48981c3436cfSJed Brown }
48991c3436cfSJed Brown 
49001c3436cfSJed Brown #undef __FUNCT__
49018d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
49028d59e960SJed Brown /*@
49038d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
49048d59e960SJed Brown 
49058d59e960SJed Brown    Logically Collective on TS
49068d59e960SJed Brown 
49078d59e960SJed Brown    Input Arguments:
49088d59e960SJed Brown +  ts - time stepping context
49098d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
49108d59e960SJed Brown 
49118d59e960SJed Brown    Note:
49128d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
49138d59e960SJed Brown 
49148d59e960SJed Brown    Level: intermediate
49158d59e960SJed Brown 
49168d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
49178d59e960SJed Brown @*/
49188d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
49198d59e960SJed Brown {
49208d59e960SJed Brown   PetscFunctionBegin;
49218d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49228d59e960SJed Brown   ts->cfltime_local = cfltime;
49238d59e960SJed Brown   ts->cfltime       = -1.;
49248d59e960SJed Brown   PetscFunctionReturn(0);
49258d59e960SJed Brown }
49268d59e960SJed Brown 
49278d59e960SJed Brown #undef __FUNCT__
49288d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
49298d59e960SJed Brown /*@
49308d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
49318d59e960SJed Brown 
49328d59e960SJed Brown    Collective on TS
49338d59e960SJed Brown 
49348d59e960SJed Brown    Input Arguments:
49358d59e960SJed Brown .  ts - time stepping context
49368d59e960SJed Brown 
49378d59e960SJed Brown    Output Arguments:
49388d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
49398d59e960SJed Brown 
49408d59e960SJed Brown    Level: advanced
49418d59e960SJed Brown 
49428d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
49438d59e960SJed Brown @*/
49448d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
49458d59e960SJed Brown {
49468d59e960SJed Brown   PetscErrorCode ierr;
49478d59e960SJed Brown 
49488d59e960SJed Brown   PetscFunctionBegin;
49498d59e960SJed Brown   if (ts->cfltime < 0) {
4950ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
49518d59e960SJed Brown   }
49528d59e960SJed Brown   *cfltime = ts->cfltime;
49538d59e960SJed Brown   PetscFunctionReturn(0);
49548d59e960SJed Brown }
49558d59e960SJed Brown 
49568d59e960SJed Brown #undef __FUNCT__
4957d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
4958d6ebe24aSShri Abhyankar /*@
4959d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
4960d6ebe24aSShri Abhyankar 
4961d6ebe24aSShri Abhyankar    Input Parameters:
4962d6ebe24aSShri Abhyankar .  ts   - the TS context.
4963d6ebe24aSShri Abhyankar .  xl   - lower bound.
4964d6ebe24aSShri Abhyankar .  xu   - upper bound.
4965d6ebe24aSShri Abhyankar 
4966d6ebe24aSShri Abhyankar    Notes:
4967d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
4968e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
4969d6ebe24aSShri Abhyankar 
49702bd2b0e6SSatish Balay    Level: advanced
49712bd2b0e6SSatish Balay 
4972d6ebe24aSShri Abhyankar @*/
4973d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
4974d6ebe24aSShri Abhyankar {
4975d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
4976d6ebe24aSShri Abhyankar   SNES           snes;
4977d6ebe24aSShri Abhyankar 
4978d6ebe24aSShri Abhyankar   PetscFunctionBegin;
4979d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4980d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
4981d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
4982d6ebe24aSShri Abhyankar }
4983d6ebe24aSShri Abhyankar 
4984325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4985c6db04a5SJed Brown #include <mex.h>
4986325fc9f4SBarry Smith 
4987325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
4988325fc9f4SBarry Smith 
4989325fc9f4SBarry Smith #undef __FUNCT__
4990325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
4991325fc9f4SBarry Smith /*
4992325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
4993325fc9f4SBarry Smith                          TSSetFunctionMatlab().
4994325fc9f4SBarry Smith 
4995325fc9f4SBarry Smith    Collective on TS
4996325fc9f4SBarry Smith 
4997325fc9f4SBarry Smith    Input Parameters:
4998325fc9f4SBarry Smith +  snes - the TS context
49990910c330SBarry Smith -  u - input vector
5000325fc9f4SBarry Smith 
5001325fc9f4SBarry Smith    Output Parameter:
5002325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5003325fc9f4SBarry Smith 
5004325fc9f4SBarry Smith    Notes:
5005325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5006325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5007325fc9f4SBarry Smith    themselves.
5008325fc9f4SBarry Smith 
5009325fc9f4SBarry Smith    Level: developer
5010325fc9f4SBarry Smith 
5011325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5012325fc9f4SBarry Smith 
5013325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5014325fc9f4SBarry Smith */
50150910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5016325fc9f4SBarry Smith {
5017325fc9f4SBarry Smith   PetscErrorCode  ierr;
5018325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5019325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5020325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5021325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5022325fc9f4SBarry Smith 
5023325fc9f4SBarry Smith   PetscFunctionBegin;
5024325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
50250910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
50260910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5027325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
50280910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5029325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5030325fc9f4SBarry Smith 
5031325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
50320910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
50330910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
50340910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5035bbd56ea5SKarl Rupp 
5036325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5037325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5038325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5039325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5040325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5041325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5042325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5043325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5044325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5045325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5046325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5047325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5048325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5049325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5050325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5051325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5052325fc9f4SBarry Smith   PetscFunctionReturn(0);
5053325fc9f4SBarry Smith }
5054325fc9f4SBarry Smith 
5055325fc9f4SBarry Smith 
5056325fc9f4SBarry Smith #undef __FUNCT__
5057325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5058325fc9f4SBarry Smith /*
5059325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5060325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5061e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5062325fc9f4SBarry Smith 
5063325fc9f4SBarry Smith    Logically Collective on TS
5064325fc9f4SBarry Smith 
5065325fc9f4SBarry Smith    Input Parameters:
5066325fc9f4SBarry Smith +  ts - the TS context
5067325fc9f4SBarry Smith -  func - function evaluation routine
5068325fc9f4SBarry Smith 
5069325fc9f4SBarry Smith    Calling sequence of func:
50700910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5071325fc9f4SBarry Smith 
5072325fc9f4SBarry Smith    Level: beginner
5073325fc9f4SBarry Smith 
5074325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5075325fc9f4SBarry Smith 
5076325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5077325fc9f4SBarry Smith */
5078cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5079325fc9f4SBarry Smith {
5080325fc9f4SBarry Smith   PetscErrorCode  ierr;
5081325fc9f4SBarry Smith   TSMatlabContext *sctx;
5082325fc9f4SBarry Smith 
5083325fc9f4SBarry Smith   PetscFunctionBegin;
5084325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5085325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5086325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5087325fc9f4SBarry Smith   /*
5088325fc9f4SBarry Smith      This should work, but it doesn't
5089325fc9f4SBarry Smith   sctx->ctx = ctx;
5090325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5091325fc9f4SBarry Smith   */
5092325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5093bbd56ea5SKarl Rupp 
50940298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5095325fc9f4SBarry Smith   PetscFunctionReturn(0);
5096325fc9f4SBarry Smith }
5097325fc9f4SBarry Smith 
5098325fc9f4SBarry Smith #undef __FUNCT__
5099325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5100325fc9f4SBarry Smith /*
5101325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5102325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5103325fc9f4SBarry Smith 
5104325fc9f4SBarry Smith    Collective on TS
5105325fc9f4SBarry Smith 
5106325fc9f4SBarry Smith    Input Parameters:
5107cdcf91faSSean Farley +  ts - the TS context
51080910c330SBarry Smith .  u - input vector
5109325fc9f4SBarry Smith .  A, B - the matrices
5110325fc9f4SBarry Smith -  ctx - user context
5111325fc9f4SBarry Smith 
5112325fc9f4SBarry Smith    Level: developer
5113325fc9f4SBarry Smith 
5114325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5115325fc9f4SBarry Smith 
5116325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5117325fc9f4SBarry Smith @*/
5118f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5119325fc9f4SBarry Smith {
5120325fc9f4SBarry Smith   PetscErrorCode  ierr;
5121325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5122325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5123325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5124325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5125325fc9f4SBarry Smith 
5126325fc9f4SBarry Smith   PetscFunctionBegin;
5127cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
51280910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5129325fc9f4SBarry Smith 
51300910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5131325fc9f4SBarry Smith 
5132cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
51330910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
51340910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
51350910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
51360910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5137bbd56ea5SKarl Rupp 
5138325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5139325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5140325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5141325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5142325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5143325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5144325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5145325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5146325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5147325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");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(prhs[6]);
5156325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5157325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5158325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5159325fc9f4SBarry Smith   PetscFunctionReturn(0);
5160325fc9f4SBarry Smith }
5161325fc9f4SBarry Smith 
5162325fc9f4SBarry Smith 
5163325fc9f4SBarry Smith #undef __FUNCT__
5164325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5165325fc9f4SBarry Smith /*
5166325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5167e3c5b3baSBarry 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
5168325fc9f4SBarry Smith 
5169325fc9f4SBarry Smith    Logically Collective on TS
5170325fc9f4SBarry Smith 
5171325fc9f4SBarry Smith    Input Parameters:
5172cdcf91faSSean Farley +  ts - the TS context
5173325fc9f4SBarry Smith .  A,B - Jacobian matrices
5174325fc9f4SBarry Smith .  func - function evaluation routine
5175325fc9f4SBarry Smith -  ctx - user context
5176325fc9f4SBarry Smith 
5177325fc9f4SBarry Smith    Calling sequence of func:
51780910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5179325fc9f4SBarry Smith 
5180325fc9f4SBarry Smith 
5181325fc9f4SBarry Smith    Level: developer
5182325fc9f4SBarry Smith 
5183325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5184325fc9f4SBarry Smith 
5185325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5186325fc9f4SBarry Smith */
5187cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5188325fc9f4SBarry Smith {
5189325fc9f4SBarry Smith   PetscErrorCode  ierr;
5190325fc9f4SBarry Smith   TSMatlabContext *sctx;
5191325fc9f4SBarry Smith 
5192325fc9f4SBarry Smith   PetscFunctionBegin;
5193325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5194325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5195325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5196325fc9f4SBarry Smith   /*
5197325fc9f4SBarry Smith      This should work, but it doesn't
5198325fc9f4SBarry Smith   sctx->ctx = ctx;
5199325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5200325fc9f4SBarry Smith   */
5201325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5202bbd56ea5SKarl Rupp 
5203cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5204325fc9f4SBarry Smith   PetscFunctionReturn(0);
5205325fc9f4SBarry Smith }
5206325fc9f4SBarry Smith 
5207b5b1a830SBarry Smith #undef __FUNCT__
5208b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5209b5b1a830SBarry Smith /*
5210b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5211b5b1a830SBarry Smith 
5212b5b1a830SBarry Smith    Collective on TS
5213b5b1a830SBarry Smith 
5214b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5215b5b1a830SBarry Smith @*/
52160910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5217b5b1a830SBarry Smith {
5218b5b1a830SBarry Smith   PetscErrorCode  ierr;
5219b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5220a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5221b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5222b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5223b5b1a830SBarry Smith 
5224b5b1a830SBarry Smith   PetscFunctionBegin;
5225cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52260910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5227b5b1a830SBarry Smith 
5228cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
52290910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5230bbd56ea5SKarl Rupp 
5231b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5232b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5233b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5234b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5235b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5236b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5237b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5238b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5239b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5240b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5241b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5242b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5243b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5244b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5245b5b1a830SBarry Smith   PetscFunctionReturn(0);
5246b5b1a830SBarry Smith }
5247b5b1a830SBarry Smith 
5248b5b1a830SBarry Smith 
5249b5b1a830SBarry Smith #undef __FUNCT__
5250b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5251b5b1a830SBarry Smith /*
5252b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5253b5b1a830SBarry Smith 
5254b5b1a830SBarry Smith    Level: developer
5255b5b1a830SBarry Smith 
5256b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5257b5b1a830SBarry Smith 
5258b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5259b5b1a830SBarry Smith */
5260cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5261b5b1a830SBarry Smith {
5262b5b1a830SBarry Smith   PetscErrorCode  ierr;
5263b5b1a830SBarry Smith   TSMatlabContext *sctx;
5264b5b1a830SBarry Smith 
5265b5b1a830SBarry Smith   PetscFunctionBegin;
5266b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5267b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5268b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5269b5b1a830SBarry Smith   /*
5270b5b1a830SBarry Smith      This should work, but it doesn't
5271b5b1a830SBarry Smith   sctx->ctx = ctx;
5272b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5273b5b1a830SBarry Smith   */
5274b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5275bbd56ea5SKarl Rupp 
52760298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5277b5b1a830SBarry Smith   PetscFunctionReturn(0);
5278b5b1a830SBarry Smith }
5279325fc9f4SBarry Smith #endif
5280b3603a34SBarry Smith 
52810b039ecaSBarry Smith 
52820b039ecaSBarry Smith 
5283b3603a34SBarry Smith #undef __FUNCT__
52844f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5285b3603a34SBarry Smith /*@C
52864f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5287b3603a34SBarry Smith        in a time based line graph
5288b3603a34SBarry Smith 
5289b3603a34SBarry Smith    Collective on TS
5290b3603a34SBarry Smith 
5291b3603a34SBarry Smith    Input Parameters:
5292b3603a34SBarry Smith +  ts - the TS context
5293b3603a34SBarry Smith .  step - current time-step
5294b3603a34SBarry Smith .  ptime - current time
5295b3603a34SBarry Smith -  lg - a line graph object
5296b3603a34SBarry Smith 
5297b3603a34SBarry Smith    Level: intermediate
5298b3603a34SBarry Smith 
52990b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5300b3603a34SBarry Smith 
5301b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5302b3603a34SBarry Smith 
5303b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5304b3603a34SBarry Smith @*/
53050910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5306b3603a34SBarry Smith {
5307b3603a34SBarry Smith   PetscErrorCode    ierr;
53080b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5309b3603a34SBarry Smith   const PetscScalar *yy;
531058ff32f7SBarry Smith   PetscInt          dim;
5311b3603a34SBarry Smith 
5312b3603a34SBarry Smith   PetscFunctionBegin;
531358ff32f7SBarry Smith   if (!step) {
5314a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5315a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5316a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
53170910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
53180b039ecaSBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
53190b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
532058ff32f7SBarry Smith   }
53210910c330SBarry Smith   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
5322e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5323e3efe391SJed Brown   {
5324e3efe391SJed Brown     PetscReal *yreal;
5325e3efe391SJed Brown     PetscInt  i,n;
53260910c330SBarry Smith     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
5327785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5328e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
53290b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5330e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5331e3efe391SJed Brown   }
5332e3efe391SJed Brown #else
53330b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5334e3efe391SJed Brown #endif
53350910c330SBarry Smith   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
5336b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
53370b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
53383923b477SBarry Smith   }
5339b3603a34SBarry Smith   PetscFunctionReturn(0);
5340b3603a34SBarry Smith }
5341b3603a34SBarry Smith 
5342b3603a34SBarry Smith #undef __FUNCT__
53434f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
5344ef20d060SBarry Smith /*@C
53454f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
5346ef20d060SBarry Smith        in a time based line graph
5347ef20d060SBarry Smith 
5348ef20d060SBarry Smith    Collective on TS
5349ef20d060SBarry Smith 
5350ef20d060SBarry Smith    Input Parameters:
5351ef20d060SBarry Smith +  ts - the TS context
5352ef20d060SBarry Smith .  step - current time-step
5353ef20d060SBarry Smith .  ptime - current time
5354ef20d060SBarry Smith -  lg - a line graph object
5355ef20d060SBarry Smith 
5356ef20d060SBarry Smith    Level: intermediate
5357ef20d060SBarry Smith 
5358abd5a294SJed Brown    Notes:
5359abd5a294SJed Brown    Only for sequential solves.
5360abd5a294SJed Brown 
5361abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
5362abd5a294SJed Brown 
5363abd5a294SJed Brown    Options Database Keys:
53644f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
5365ef20d060SBarry Smith 
5366ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
5367ef20d060SBarry Smith 
5368abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5369ef20d060SBarry Smith @*/
53700910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5371ef20d060SBarry Smith {
5372ef20d060SBarry Smith   PetscErrorCode    ierr;
53730b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5374ef20d060SBarry Smith   const PetscScalar *yy;
5375ef20d060SBarry Smith   Vec               y;
5376a9f9c1f6SBarry Smith   PetscInt          dim;
5377ef20d060SBarry Smith 
5378ef20d060SBarry Smith   PetscFunctionBegin;
5379a9f9c1f6SBarry Smith   if (!step) {
5380a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5381a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
53821ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
53830910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5384a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5385a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5386a9f9c1f6SBarry Smith   }
53870910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5388ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
53890910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5390ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5391e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5392e3efe391SJed Brown   {
5393e3efe391SJed Brown     PetscReal *yreal;
5394e3efe391SJed Brown     PetscInt  i,n;
5395e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5396785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5397e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
53980b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5399e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5400e3efe391SJed Brown   }
5401e3efe391SJed Brown #else
54020b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5403e3efe391SJed Brown #endif
5404ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5405ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
5406b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
54070b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
54083923b477SBarry Smith   }
5409ef20d060SBarry Smith   PetscFunctionReturn(0);
5410ef20d060SBarry Smith }
5411ef20d060SBarry Smith 
5412201da799SBarry Smith #undef __FUNCT__
5413201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
5414201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5415201da799SBarry Smith {
5416201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5417201da799SBarry Smith   PetscReal      x   = ptime,y;
5418201da799SBarry Smith   PetscErrorCode ierr;
5419201da799SBarry Smith   PetscInt       its;
5420201da799SBarry Smith 
5421201da799SBarry Smith   PetscFunctionBegin;
5422201da799SBarry Smith   if (!n) {
5423201da799SBarry Smith     PetscDrawAxis axis;
5424bbd56ea5SKarl Rupp 
5425201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5426201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5427201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5428bbd56ea5SKarl Rupp 
5429201da799SBarry Smith     ctx->snes_its = 0;
5430201da799SBarry Smith   }
5431201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5432201da799SBarry Smith   y    = its - ctx->snes_its;
5433201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
54343fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5435201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5436201da799SBarry Smith   }
5437201da799SBarry Smith   ctx->snes_its = its;
5438201da799SBarry Smith   PetscFunctionReturn(0);
5439201da799SBarry Smith }
5440201da799SBarry Smith 
5441201da799SBarry Smith #undef __FUNCT__
5442201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
5443201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5444201da799SBarry Smith {
5445201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5446201da799SBarry Smith   PetscReal      x   = ptime,y;
5447201da799SBarry Smith   PetscErrorCode ierr;
5448201da799SBarry Smith   PetscInt       its;
5449201da799SBarry Smith 
5450201da799SBarry Smith   PetscFunctionBegin;
5451201da799SBarry Smith   if (!n) {
5452201da799SBarry Smith     PetscDrawAxis axis;
5453bbd56ea5SKarl Rupp 
5454201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5455201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
5456201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5457bbd56ea5SKarl Rupp 
5458201da799SBarry Smith     ctx->ksp_its = 0;
5459201da799SBarry Smith   }
5460201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
5461201da799SBarry Smith   y    = its - ctx->ksp_its;
5462201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
546399fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5464201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5465201da799SBarry Smith   }
5466201da799SBarry Smith   ctx->ksp_its = its;
5467201da799SBarry Smith   PetscFunctionReturn(0);
5468201da799SBarry Smith }
5469f9c1d6abSBarry Smith 
5470f9c1d6abSBarry Smith #undef __FUNCT__
5471f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
5472f9c1d6abSBarry Smith /*@
5473f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
5474f9c1d6abSBarry Smith 
5475f9c1d6abSBarry Smith    Collective on TS and Vec
5476f9c1d6abSBarry Smith 
5477f9c1d6abSBarry Smith    Input Parameters:
5478f9c1d6abSBarry Smith +  ts - the TS context
5479f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
5480f9c1d6abSBarry Smith 
5481f9c1d6abSBarry Smith    Output Parameters:
5482f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
5483f9c1d6abSBarry Smith 
5484f9c1d6abSBarry Smith    Level: developer
5485f9c1d6abSBarry Smith 
5486f9c1d6abSBarry Smith .keywords: TS, compute
5487f9c1d6abSBarry Smith 
5488f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
5489f9c1d6abSBarry Smith @*/
5490f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5491f9c1d6abSBarry Smith {
5492f9c1d6abSBarry Smith   PetscErrorCode ierr;
5493f9c1d6abSBarry Smith 
5494f9c1d6abSBarry Smith   PetscFunctionBegin;
5495f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5496ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5497f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
5498f9c1d6abSBarry Smith   PetscFunctionReturn(0);
5499f9c1d6abSBarry Smith }
550024655328SShri 
550124655328SShri #undef __FUNCT__
550224655328SShri #define __FUNCT__ "TSRollBack"
550324655328SShri /*@
550424655328SShri    TSRollBack - Rolls back one time step
550524655328SShri 
550624655328SShri    Collective on TS
550724655328SShri 
550824655328SShri    Input Parameter:
550924655328SShri .  ts - the TS context obtained from TSCreate()
551024655328SShri 
551124655328SShri    Level: advanced
551224655328SShri 
551324655328SShri .keywords: TS, timestep, rollback
551424655328SShri 
551524655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
551624655328SShri @*/
551724655328SShri PetscErrorCode  TSRollBack(TS ts)
551824655328SShri {
551924655328SShri   PetscErrorCode ierr;
552024655328SShri 
552124655328SShri   PetscFunctionBegin;
552224655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
552324655328SShri 
552424655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
552524655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
552624655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
552724655328SShri   ts->ptime = ts->ptime_prev;
552824655328SShri   PetscFunctionReturn(0);
552924655328SShri }
5530aeb4809dSShri Abhyankar 
5531ff22ae23SHong Zhang #undef __FUNCT__
5532ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
5533ff22ae23SHong Zhang /*@
5534ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
5535ff22ae23SHong Zhang 
5536ff22ae23SHong Zhang    Input Parameter:
5537ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
5538ff22ae23SHong Zhang 
5539ff22ae23SHong Zhang    Level: advanced
5540ff22ae23SHong Zhang 
5541ff22ae23SHong Zhang .keywords: TS, getstages
5542ff22ae23SHong Zhang 
5543ff22ae23SHong Zhang .seealso: TSCreate()
5544ff22ae23SHong Zhang @*/
5545ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
5546ff22ae23SHong Zhang {
5547ff22ae23SHong Zhang   PetscErrorCode ierr;
5548ff22ae23SHong Zhang 
5549ff22ae23SHong Zhang   PetscFunctionBegin;
5550ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5551ff22ae23SHong Zhang   PetscValidPointer(ns,2);
5552ff22ae23SHong Zhang 
5553ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
5554ff22ae23SHong Zhang   else {
5555ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
5556ff22ae23SHong Zhang   }
5557ff22ae23SHong Zhang   PetscFunctionReturn(0);
5558ff22ae23SHong Zhang }
5559ff22ae23SHong Zhang 
5560ff22ae23SHong Zhang 
5561ff22ae23SHong Zhang 
5562