xref: /petsc/src/ts/interface/ts.c (revision b18ea86c599c11b5ec41115a5d8c885443e32aa1)
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 /*@
379d2daff3dSHong Zhang    TSSetRunMode - 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 {
396d2daff3dSHong Zhang   PetscFunctionBegin;
397d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
398d2daff3dSHong Zhang   ts->reverse_mode = reverse_mode;
399d2daff3dSHong Zhang   PetscFunctionReturn(0);
400d2daff3dSHong Zhang }
401d2daff3dSHong Zhang 
402a7a1495cSBarry Smith #undef __FUNCT__
403a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
404a7a1495cSBarry Smith /*@
405a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
406a7a1495cSBarry Smith       set with TSSetRHSJacobian().
407a7a1495cSBarry Smith 
408a7a1495cSBarry Smith    Collective on TS and Vec
409a7a1495cSBarry Smith 
410a7a1495cSBarry Smith    Input Parameters:
411316643e7SJed Brown +  ts - the TS context
412a7a1495cSBarry Smith .  t - current timestep
4130910c330SBarry Smith -  U - input vector
414a7a1495cSBarry Smith 
415a7a1495cSBarry Smith    Output Parameters:
416a7a1495cSBarry Smith +  A - Jacobian matrix
417a7a1495cSBarry Smith .  B - optional preconditioning matrix
418a7a1495cSBarry Smith -  flag - flag indicating matrix structure
419a7a1495cSBarry Smith 
420a7a1495cSBarry Smith    Notes:
421a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
422a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
423a7a1495cSBarry Smith 
42494b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
425a7a1495cSBarry Smith    flag parameter.
426a7a1495cSBarry Smith 
427a7a1495cSBarry Smith    Level: developer
428a7a1495cSBarry Smith 
429a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
430a7a1495cSBarry Smith 
43194b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
432a7a1495cSBarry Smith @*/
433d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
434a7a1495cSBarry Smith {
435dfbe8321SBarry Smith   PetscErrorCode ierr;
436270bf2e7SJed Brown   PetscObjectState Ustate;
43724989b8cSPeter Brune   DM             dm;
438942e3340SBarry Smith   DMTS           tsdm;
43924989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
44024989b8cSPeter Brune   void           *ctx;
44124989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
442a7a1495cSBarry Smith 
443a7a1495cSBarry Smith   PetscFunctionBegin;
4440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4450910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4460910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
44724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
448942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
44924989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4500298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
45159e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
4520910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4530e4ef248SJed Brown     PetscFunctionReturn(0);
454f8ede8e7SJed Brown   }
455d90be118SSean Farley 
456ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
457d90be118SSean Farley 
458e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
45994ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
46094ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
46194ab13aaSBarry Smith     if (A != B) {
46294ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
46394ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
464e1244c69SJed Brown     }
465e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
466e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
467e1244c69SJed Brown   }
468e1244c69SJed Brown 
46924989b8cSPeter Brune   if (rhsjacobianfunc) {
47094ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
471a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
472d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
473a7a1495cSBarry Smith     PetscStackPop;
47494ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
475a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
47694ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
47794ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
478ef66eb69SBarry Smith   } else {
47994ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
48094ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
481ef66eb69SBarry Smith   }
4820e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4830910c330SBarry Smith   ts->rhsjacobian.X          = U;
48459e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
485a7a1495cSBarry Smith   PetscFunctionReturn(0);
486a7a1495cSBarry Smith }
487a7a1495cSBarry Smith 
4884a2ae208SSatish Balay #undef __FUNCT__
4894a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
490316643e7SJed Brown /*@
491d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
492d763cef2SBarry Smith 
493316643e7SJed Brown    Collective on TS and Vec
494316643e7SJed Brown 
495316643e7SJed Brown    Input Parameters:
496316643e7SJed Brown +  ts - the TS context
497316643e7SJed Brown .  t - current time
4980910c330SBarry Smith -  U - state vector
499316643e7SJed Brown 
500316643e7SJed Brown    Output Parameter:
501316643e7SJed Brown .  y - right hand side
502316643e7SJed Brown 
503316643e7SJed Brown    Note:
504316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
505316643e7SJed Brown    is used internally within the nonlinear solvers.
506316643e7SJed Brown 
507316643e7SJed Brown    Level: developer
508316643e7SJed Brown 
509316643e7SJed Brown .keywords: TS, compute
510316643e7SJed Brown 
511316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
512316643e7SJed Brown @*/
5130910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
514d763cef2SBarry Smith {
515dfbe8321SBarry Smith   PetscErrorCode ierr;
51624989b8cSPeter Brune   TSRHSFunction  rhsfunction;
51724989b8cSPeter Brune   TSIFunction    ifunction;
51824989b8cSPeter Brune   void           *ctx;
51924989b8cSPeter Brune   DM             dm;
52024989b8cSPeter Brune 
521d763cef2SBarry Smith   PetscFunctionBegin;
5220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5230910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5240700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
52524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
52624989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5270298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
528d763cef2SBarry Smith 
529ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
530d763cef2SBarry Smith 
5310910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
53224989b8cSPeter Brune   if (rhsfunction) {
533d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5340910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
535d763cef2SBarry Smith     PetscStackPop;
536214bc6a2SJed Brown   } else {
537214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
538b2cd27e8SJed Brown   }
53944a41b28SSean Farley 
5400910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
541d763cef2SBarry Smith   PetscFunctionReturn(0);
542d763cef2SBarry Smith }
543d763cef2SBarry Smith 
5444a2ae208SSatish Balay #undef __FUNCT__
545ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
546ef20d060SBarry Smith /*@
547ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
548ef20d060SBarry Smith 
549ef20d060SBarry Smith    Collective on TS and Vec
550ef20d060SBarry Smith 
551ef20d060SBarry Smith    Input Parameters:
552ef20d060SBarry Smith +  ts - the TS context
553ef20d060SBarry Smith -  t - current time
554ef20d060SBarry Smith 
555ef20d060SBarry Smith    Output Parameter:
5560910c330SBarry Smith .  U - the solution
557ef20d060SBarry Smith 
558ef20d060SBarry Smith    Note:
559ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
560ef20d060SBarry Smith    is used internally within the nonlinear solvers.
561ef20d060SBarry Smith 
562ef20d060SBarry Smith    Level: developer
563ef20d060SBarry Smith 
564ef20d060SBarry Smith .keywords: TS, compute
565ef20d060SBarry Smith 
566abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
567ef20d060SBarry Smith @*/
5680910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
569ef20d060SBarry Smith {
570ef20d060SBarry Smith   PetscErrorCode     ierr;
571ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
572ef20d060SBarry Smith   void               *ctx;
573ef20d060SBarry Smith   DM                 dm;
574ef20d060SBarry Smith 
575ef20d060SBarry Smith   PetscFunctionBegin;
576ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5770910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
578ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
579ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
580ef20d060SBarry Smith 
581ef20d060SBarry Smith   if (solutionfunction) {
5829b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5830910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
584ef20d060SBarry Smith     PetscStackPop;
585ef20d060SBarry Smith   }
586ef20d060SBarry Smith   PetscFunctionReturn(0);
587ef20d060SBarry Smith }
5889b7cd975SBarry Smith #undef __FUNCT__
5899b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5909b7cd975SBarry Smith /*@
5919b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5929b7cd975SBarry Smith 
5939b7cd975SBarry Smith    Collective on TS and Vec
5949b7cd975SBarry Smith 
5959b7cd975SBarry Smith    Input Parameters:
5969b7cd975SBarry Smith +  ts - the TS context
5979b7cd975SBarry Smith -  t - current time
5989b7cd975SBarry Smith 
5999b7cd975SBarry Smith    Output Parameter:
6009b7cd975SBarry Smith .  U - the function value
6019b7cd975SBarry Smith 
6029b7cd975SBarry Smith    Note:
6039b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6049b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6059b7cd975SBarry Smith 
6069b7cd975SBarry Smith    Level: developer
6079b7cd975SBarry Smith 
6089b7cd975SBarry Smith .keywords: TS, compute
6099b7cd975SBarry Smith 
6109b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6119b7cd975SBarry Smith @*/
6129b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
6139b7cd975SBarry Smith {
6149b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
6159b7cd975SBarry Smith   void               *ctx;
6169b7cd975SBarry Smith   DM                 dm;
6179b7cd975SBarry Smith 
6189b7cd975SBarry Smith   PetscFunctionBegin;
6199b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6209b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6219b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6229b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6239b7cd975SBarry Smith 
6249b7cd975SBarry Smith   if (forcing) {
6259b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6269b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6279b7cd975SBarry Smith     PetscStackPop;
6289b7cd975SBarry Smith   }
6299b7cd975SBarry Smith   PetscFunctionReturn(0);
6309b7cd975SBarry Smith }
631ef20d060SBarry Smith 
632ef20d060SBarry Smith #undef __FUNCT__
633214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
634214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
635214bc6a2SJed Brown {
6362dd45cf8SJed Brown   Vec            F;
637214bc6a2SJed Brown   PetscErrorCode ierr;
638214bc6a2SJed Brown 
639214bc6a2SJed Brown   PetscFunctionBegin;
6400298fd71SBarry Smith   *Frhs = NULL;
6410298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
642214bc6a2SJed Brown   if (!ts->Frhs) {
6432dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
644214bc6a2SJed Brown   }
645214bc6a2SJed Brown   *Frhs = ts->Frhs;
646214bc6a2SJed Brown   PetscFunctionReturn(0);
647214bc6a2SJed Brown }
648214bc6a2SJed Brown 
649214bc6a2SJed Brown #undef __FUNCT__
650214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
651214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
652214bc6a2SJed Brown {
653214bc6a2SJed Brown   Mat            A,B;
6542dd45cf8SJed Brown   PetscErrorCode ierr;
655214bc6a2SJed Brown 
656214bc6a2SJed Brown   PetscFunctionBegin;
657c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
658c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6590298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
660214bc6a2SJed Brown   if (Arhs) {
661214bc6a2SJed Brown     if (!ts->Arhs) {
662214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
663214bc6a2SJed Brown     }
664214bc6a2SJed Brown     *Arhs = ts->Arhs;
665214bc6a2SJed Brown   }
666214bc6a2SJed Brown   if (Brhs) {
667214bc6a2SJed Brown     if (!ts->Brhs) {
668bdb70873SJed Brown       if (A != B) {
669214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
670bdb70873SJed Brown       } else {
671bdb70873SJed Brown         ts->Brhs = ts->Arhs;
672bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
673bdb70873SJed Brown       }
674214bc6a2SJed Brown     }
675214bc6a2SJed Brown     *Brhs = ts->Brhs;
676214bc6a2SJed Brown   }
677214bc6a2SJed Brown   PetscFunctionReturn(0);
678214bc6a2SJed Brown }
679214bc6a2SJed Brown 
680214bc6a2SJed Brown #undef __FUNCT__
681316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
682316643e7SJed Brown /*@
6830910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
684316643e7SJed Brown 
685316643e7SJed Brown    Collective on TS and Vec
686316643e7SJed Brown 
687316643e7SJed Brown    Input Parameters:
688316643e7SJed Brown +  ts - the TS context
689316643e7SJed Brown .  t - current time
6900910c330SBarry Smith .  U - state vector
6910910c330SBarry Smith .  Udot - time derivative of state vector
692214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
693316643e7SJed Brown 
694316643e7SJed Brown    Output Parameter:
695316643e7SJed Brown .  Y - right hand side
696316643e7SJed Brown 
697316643e7SJed Brown    Note:
698316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
699316643e7SJed Brown    is used internally within the nonlinear solvers.
700316643e7SJed Brown 
701316643e7SJed Brown    If the user did did not write their equations in implicit form, this
702316643e7SJed Brown    function recasts them in implicit form.
703316643e7SJed Brown 
704316643e7SJed Brown    Level: developer
705316643e7SJed Brown 
706316643e7SJed Brown .keywords: TS, compute
707316643e7SJed Brown 
708316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
709316643e7SJed Brown @*/
7100910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
711316643e7SJed Brown {
712316643e7SJed Brown   PetscErrorCode ierr;
71324989b8cSPeter Brune   TSIFunction    ifunction;
71424989b8cSPeter Brune   TSRHSFunction  rhsfunction;
71524989b8cSPeter Brune   void           *ctx;
71624989b8cSPeter Brune   DM             dm;
717316643e7SJed Brown 
718316643e7SJed Brown   PetscFunctionBegin;
7190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7200910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7210910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7220700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
723316643e7SJed Brown 
72424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
72524989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7260298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
72724989b8cSPeter Brune 
728ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
729d90be118SSean Farley 
7300910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
73124989b8cSPeter Brune   if (ifunction) {
732316643e7SJed Brown     PetscStackPush("TS user implicit function");
7330910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
734316643e7SJed Brown     PetscStackPop;
735214bc6a2SJed Brown   }
736214bc6a2SJed Brown   if (imex) {
73724989b8cSPeter Brune     if (!ifunction) {
7380910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7392dd45cf8SJed Brown     }
74024989b8cSPeter Brune   } else if (rhsfunction) {
74124989b8cSPeter Brune     if (ifunction) {
742214bc6a2SJed Brown       Vec Frhs;
743214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7440910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
745214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7462dd45cf8SJed Brown     } else {
7470910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7480910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
749316643e7SJed Brown     }
7504a6899ffSJed Brown   }
7510910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
752316643e7SJed Brown   PetscFunctionReturn(0);
753316643e7SJed Brown }
754316643e7SJed Brown 
755316643e7SJed Brown #undef __FUNCT__
756316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
757316643e7SJed Brown /*@
758316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
759316643e7SJed Brown 
760316643e7SJed Brown    Collective on TS and Vec
761316643e7SJed Brown 
762316643e7SJed Brown    Input
763316643e7SJed Brown       Input Parameters:
764316643e7SJed Brown +  ts - the TS context
765316643e7SJed Brown .  t - current timestep
7660910c330SBarry Smith .  U - state vector
7670910c330SBarry Smith .  Udot - time derivative of state vector
768214bc6a2SJed Brown .  shift - shift to apply, see note below
769214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
770316643e7SJed Brown 
771316643e7SJed Brown    Output Parameters:
772316643e7SJed Brown +  A - Jacobian matrix
773316643e7SJed Brown .  B - optional preconditioning matrix
774316643e7SJed Brown -  flag - flag indicating matrix structure
775316643e7SJed Brown 
776316643e7SJed Brown    Notes:
7770910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
778316643e7SJed Brown 
7790910c330SBarry Smith    dF/dU + shift*dF/dUdot
780316643e7SJed Brown 
781316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
782316643e7SJed Brown    is used internally within the nonlinear solvers.
783316643e7SJed Brown 
784316643e7SJed Brown    Level: developer
785316643e7SJed Brown 
786316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
787316643e7SJed Brown 
788316643e7SJed Brown .seealso:  TSSetIJacobian()
78963495f91SJed Brown @*/
790d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
791316643e7SJed Brown {
792316643e7SJed Brown   PetscErrorCode ierr;
79324989b8cSPeter Brune   TSIJacobian    ijacobian;
79424989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
79524989b8cSPeter Brune   DM             dm;
79624989b8cSPeter Brune   void           *ctx;
797316643e7SJed Brown 
798316643e7SJed Brown   PetscFunctionBegin;
7990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8000910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8010910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
802316643e7SJed Brown   PetscValidPointer(A,6);
80394ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
804316643e7SJed Brown   PetscValidPointer(B,7);
80594ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
80624989b8cSPeter Brune 
80724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
80824989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8090298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
81024989b8cSPeter Brune 
811ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
812316643e7SJed Brown 
81394ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
81424989b8cSPeter Brune   if (ijacobian) {
815316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
816d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
817316643e7SJed Brown     PetscStackPop;
818214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
81994ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
82094ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8214a6899ffSJed Brown   }
822214bc6a2SJed Brown   if (imex) {
823b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
82494ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
82594ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
82694ab13aaSBarry Smith       if (A != B) {
82794ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
82894ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
829214bc6a2SJed Brown       }
830214bc6a2SJed Brown     }
831214bc6a2SJed Brown   } else {
832e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
833e1244c69SJed Brown     if (rhsjacobian) {
834bd373395SBarry Smith       if (ijacobian) {
835e1244c69SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
836bd373395SBarry Smith       } else {
837bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
838e1244c69SJed Brown       }
839d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
840e1244c69SJed Brown     }
84194ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
842e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
843e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
84494ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
84594ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
84694ab13aaSBarry Smith       if (A != B) {
84794ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
84894ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
849316643e7SJed Brown       }
850e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
851e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
852e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
85394ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
85494ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
85594ab13aaSBarry Smith         if (A != B) {
85694ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
85794ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
858e1244c69SJed Brown         }
859e1244c69SJed Brown       }
86094ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
86194ab13aaSBarry Smith       if (A != B) {
86294ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
863214bc6a2SJed Brown       }
864316643e7SJed Brown     }
865316643e7SJed Brown   }
86694ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
867316643e7SJed Brown   PetscFunctionReturn(0);
868316643e7SJed Brown }
869316643e7SJed Brown 
870316643e7SJed Brown #undef __FUNCT__
8714a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
872d763cef2SBarry Smith /*@C
873d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
874b5abc632SBarry Smith     where U_t = G(t,u).
875d763cef2SBarry Smith 
8763f9fe445SBarry Smith     Logically Collective on TS
877d763cef2SBarry Smith 
878d763cef2SBarry Smith     Input Parameters:
879d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8800298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
881d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
882d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8830298fd71SBarry Smith           function evaluation routine (may be NULL)
884d763cef2SBarry Smith 
885d763cef2SBarry Smith     Calling sequence of func:
88687828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
887d763cef2SBarry Smith 
888d763cef2SBarry Smith +   t - current timestep
889d763cef2SBarry Smith .   u - input vector
890d763cef2SBarry Smith .   F - function vector
891d763cef2SBarry Smith -   ctx - [optional] user-defined function context
892d763cef2SBarry Smith 
893d763cef2SBarry Smith     Level: beginner
894d763cef2SBarry Smith 
895d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
896d763cef2SBarry Smith 
897ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
898d763cef2SBarry Smith @*/
899089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
900d763cef2SBarry Smith {
901089b2837SJed Brown   PetscErrorCode ierr;
902089b2837SJed Brown   SNES           snes;
9030298fd71SBarry Smith   Vec            ralloc = NULL;
90424989b8cSPeter Brune   DM             dm;
905d763cef2SBarry Smith 
906089b2837SJed Brown   PetscFunctionBegin;
9070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
908ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
90924989b8cSPeter Brune 
91024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91124989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
912089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
913e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
914e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
915e856ceecSJed Brown     r    = ralloc;
916e856ceecSJed Brown   }
917089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
918e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
919d763cef2SBarry Smith   PetscFunctionReturn(0);
920d763cef2SBarry Smith }
921d763cef2SBarry Smith 
9224a2ae208SSatish Balay #undef __FUNCT__
923ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
924ef20d060SBarry Smith /*@C
925abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
926ef20d060SBarry Smith 
927ef20d060SBarry Smith     Logically Collective on TS
928ef20d060SBarry Smith 
929ef20d060SBarry Smith     Input Parameters:
930ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
931ef20d060SBarry Smith .   f - routine for evaluating the solution
932ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9330298fd71SBarry Smith           function evaluation routine (may be NULL)
934ef20d060SBarry Smith 
935ef20d060SBarry Smith     Calling sequence of func:
936ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
937ef20d060SBarry Smith 
938ef20d060SBarry Smith +   t - current timestep
939ef20d060SBarry Smith .   u - output vector
940ef20d060SBarry Smith -   ctx - [optional] user-defined function context
941ef20d060SBarry Smith 
942abd5a294SJed Brown     Notes:
943abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
944abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
945abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
946abd5a294SJed Brown 
9474f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
948abd5a294SJed Brown 
949ef20d060SBarry Smith     Level: beginner
950ef20d060SBarry Smith 
951ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
952ef20d060SBarry Smith 
9539b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
954ef20d060SBarry Smith @*/
955ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
956ef20d060SBarry Smith {
957ef20d060SBarry Smith   PetscErrorCode ierr;
958ef20d060SBarry Smith   DM             dm;
959ef20d060SBarry Smith 
960ef20d060SBarry Smith   PetscFunctionBegin;
961ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
962ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
963ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
964ef20d060SBarry Smith   PetscFunctionReturn(0);
965ef20d060SBarry Smith }
966ef20d060SBarry Smith 
967ef20d060SBarry Smith #undef __FUNCT__
9689b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9699b7cd975SBarry Smith /*@C
9709b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9719b7cd975SBarry Smith 
9729b7cd975SBarry Smith     Logically Collective on TS
9739b7cd975SBarry Smith 
9749b7cd975SBarry Smith     Input Parameters:
9759b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9769b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9779b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9780298fd71SBarry Smith           function evaluation routine (may be NULL)
9799b7cd975SBarry Smith 
9809b7cd975SBarry Smith     Calling sequence of func:
9819b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9829b7cd975SBarry Smith 
9839b7cd975SBarry Smith +   t - current timestep
9849b7cd975SBarry Smith .   u - output vector
9859b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9869b7cd975SBarry Smith 
9879b7cd975SBarry Smith     Notes:
9889b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9899b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9909b7cd975SBarry Smith 
9919b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9929b7cd975SBarry Smith 
9939b7cd975SBarry Smith     Level: beginner
9949b7cd975SBarry Smith 
9959b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9969b7cd975SBarry Smith 
9979b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
9989b7cd975SBarry Smith @*/
9999b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
10009b7cd975SBarry Smith {
10019b7cd975SBarry Smith   PetscErrorCode ierr;
10029b7cd975SBarry Smith   DM             dm;
10039b7cd975SBarry Smith 
10049b7cd975SBarry Smith   PetscFunctionBegin;
10059b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10069b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
10079b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
10089b7cd975SBarry Smith   PetscFunctionReturn(0);
10099b7cd975SBarry Smith }
10109b7cd975SBarry Smith 
10119b7cd975SBarry Smith #undef __FUNCT__
10124a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1013d763cef2SBarry Smith /*@C
1014d763cef2SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of F,
1015b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1016d763cef2SBarry Smith 
10173f9fe445SBarry Smith    Logically Collective on TS
1018d763cef2SBarry Smith 
1019d763cef2SBarry Smith    Input Parameters:
1020d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1021e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1022e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1023d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1024d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10250298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1026d763cef2SBarry Smith 
1027d763cef2SBarry Smith    Calling sequence of func:
1028ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1029d763cef2SBarry Smith 
1030d763cef2SBarry Smith +  t - current timestep
1031d763cef2SBarry Smith .  u - input vector
1032e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1033e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1034d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1035d763cef2SBarry Smith 
1036d763cef2SBarry Smith 
1037d763cef2SBarry Smith    Level: beginner
1038d763cef2SBarry Smith 
1039d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1040d763cef2SBarry Smith 
1041ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1042d763cef2SBarry Smith 
1043d763cef2SBarry Smith @*/
1044e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1045d763cef2SBarry Smith {
1046277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1047089b2837SJed Brown   SNES           snes;
104824989b8cSPeter Brune   DM             dm;
104924989b8cSPeter Brune   TSIJacobian    ijacobian;
1050277b19d0SLisandro Dalcin 
1051d763cef2SBarry Smith   PetscFunctionBegin;
10520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1053e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1054e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1055e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1056e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1057d763cef2SBarry Smith 
105824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
105924989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1060e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1061e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1062e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1063e1244c69SJed Brown   }
10640298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1065089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10665f659677SPeter Brune   if (!ijacobian) {
1067e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10680e4ef248SJed Brown   }
1069e5d3d808SBarry Smith   if (Amat) {
1070e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10710e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1072bbd56ea5SKarl Rupp 
1073e5d3d808SBarry Smith     ts->Arhs = Amat;
10740e4ef248SJed Brown   }
1075e5d3d808SBarry Smith   if (Pmat) {
1076e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10770e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1078bbd56ea5SKarl Rupp 
1079e5d3d808SBarry Smith     ts->Brhs = Pmat;
10800e4ef248SJed Brown   }
1081d763cef2SBarry Smith   PetscFunctionReturn(0);
1082d763cef2SBarry Smith }
1083d763cef2SBarry Smith 
1084316643e7SJed Brown 
1085316643e7SJed Brown #undef __FUNCT__
1086316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1087316643e7SJed Brown /*@C
1088b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1089316643e7SJed Brown 
10903f9fe445SBarry Smith    Logically Collective on TS
1091316643e7SJed Brown 
1092316643e7SJed Brown    Input Parameters:
1093316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10940298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1095316643e7SJed Brown .  f   - the function evaluation routine
10960298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1097316643e7SJed Brown 
1098316643e7SJed Brown    Calling sequence of f:
1099316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1100316643e7SJed Brown 
1101316643e7SJed Brown +  t   - time at step/stage being solved
1102316643e7SJed Brown .  u   - state vector
1103316643e7SJed Brown .  u_t - time derivative of state vector
1104316643e7SJed Brown .  F   - function vector
1105316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1106316643e7SJed Brown 
1107316643e7SJed Brown    Important:
1108d6cbdb99SBarry Smith    The user MUST call either this routine, TSSetRHSFunction().  This routine must be used when not solving an ODE, for example a DAE.
1109316643e7SJed Brown 
1110316643e7SJed Brown    Level: beginner
1111316643e7SJed Brown 
1112316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1113316643e7SJed Brown 
1114d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1115316643e7SJed Brown @*/
1116089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1117316643e7SJed Brown {
1118089b2837SJed Brown   PetscErrorCode ierr;
1119089b2837SJed Brown   SNES           snes;
11200298fd71SBarry Smith   Vec            resalloc = NULL;
112124989b8cSPeter Brune   DM             dm;
1122316643e7SJed Brown 
1123316643e7SJed Brown   PetscFunctionBegin;
11240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1125ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
112624989b8cSPeter Brune 
112724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
112824989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
112924989b8cSPeter Brune 
1130089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1131e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1132e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1133e856ceecSJed Brown     res  = resalloc;
1134e856ceecSJed Brown   }
1135089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1136e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1137089b2837SJed Brown   PetscFunctionReturn(0);
1138089b2837SJed Brown }
1139089b2837SJed Brown 
1140089b2837SJed Brown #undef __FUNCT__
1141089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1142089b2837SJed Brown /*@C
1143089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1144089b2837SJed Brown 
1145089b2837SJed Brown    Not Collective
1146089b2837SJed Brown 
1147089b2837SJed Brown    Input Parameter:
1148089b2837SJed Brown .  ts - the TS context
1149089b2837SJed Brown 
1150089b2837SJed Brown    Output Parameter:
11510298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11520298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11530298fd71SBarry Smith -  ctx - the function context (or NULL)
1154089b2837SJed Brown 
1155089b2837SJed Brown    Level: advanced
1156089b2837SJed Brown 
1157089b2837SJed Brown .keywords: TS, nonlinear, get, function
1158089b2837SJed Brown 
1159089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1160089b2837SJed Brown @*/
1161089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1162089b2837SJed Brown {
1163089b2837SJed Brown   PetscErrorCode ierr;
1164089b2837SJed Brown   SNES           snes;
116524989b8cSPeter Brune   DM             dm;
1166089b2837SJed Brown 
1167089b2837SJed Brown   PetscFunctionBegin;
1168089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1169089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11700298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
117124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
117224989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1173089b2837SJed Brown   PetscFunctionReturn(0);
1174089b2837SJed Brown }
1175089b2837SJed Brown 
1176089b2837SJed Brown #undef __FUNCT__
1177089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1178089b2837SJed Brown /*@C
1179089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1180089b2837SJed Brown 
1181089b2837SJed Brown    Not Collective
1182089b2837SJed Brown 
1183089b2837SJed Brown    Input Parameter:
1184089b2837SJed Brown .  ts - the TS context
1185089b2837SJed Brown 
1186089b2837SJed Brown    Output Parameter:
11870298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11880298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11890298fd71SBarry Smith -  ctx - the function context (or NULL)
1190089b2837SJed Brown 
1191089b2837SJed Brown    Level: advanced
1192089b2837SJed Brown 
1193089b2837SJed Brown .keywords: TS, nonlinear, get, function
1194089b2837SJed Brown 
1195089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction()
1196089b2837SJed Brown @*/
1197089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1198089b2837SJed Brown {
1199089b2837SJed Brown   PetscErrorCode ierr;
1200089b2837SJed Brown   SNES           snes;
120124989b8cSPeter Brune   DM             dm;
1202089b2837SJed Brown 
1203089b2837SJed Brown   PetscFunctionBegin;
1204089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1205089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12060298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
120724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
120824989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1209316643e7SJed Brown   PetscFunctionReturn(0);
1210316643e7SJed Brown }
1211316643e7SJed Brown 
1212316643e7SJed Brown #undef __FUNCT__
1213316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1214316643e7SJed Brown /*@C
1215a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1216ae8867d6SBarry Smith         provided with TSSetIFunction().
1217316643e7SJed Brown 
12183f9fe445SBarry Smith    Logically Collective on TS
1219316643e7SJed Brown 
1220316643e7SJed Brown    Input Parameters:
1221316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1222e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1223e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1224316643e7SJed Brown .  f   - the Jacobian evaluation routine
12250298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1226316643e7SJed Brown 
1227316643e7SJed Brown    Calling sequence of f:
1228ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1229316643e7SJed Brown 
1230316643e7SJed Brown +  t    - time at step/stage being solved
12311b4a444bSJed Brown .  U    - state vector
12321b4a444bSJed Brown .  U_t  - time derivative of state vector
1233316643e7SJed Brown .  a    - shift
1234e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1235e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1236316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1237316643e7SJed Brown 
1238316643e7SJed Brown    Notes:
1239e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1240316643e7SJed Brown 
1241a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1242b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1243a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1244a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1245a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1246a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1247a4f0a591SBarry Smith 
1248316643e7SJed Brown    Level: beginner
1249316643e7SJed Brown 
1250316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1251316643e7SJed Brown 
1252ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1253316643e7SJed Brown 
1254316643e7SJed Brown @*/
1255e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1256316643e7SJed Brown {
1257316643e7SJed Brown   PetscErrorCode ierr;
1258089b2837SJed Brown   SNES           snes;
125924989b8cSPeter Brune   DM             dm;
1260316643e7SJed Brown 
1261316643e7SJed Brown   PetscFunctionBegin;
12620700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1263e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1264e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1265e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1266e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
126724989b8cSPeter Brune 
126824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
126924989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
127024989b8cSPeter Brune 
1271089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1272e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1273316643e7SJed Brown   PetscFunctionReturn(0);
1274316643e7SJed Brown }
1275316643e7SJed Brown 
12764a2ae208SSatish Balay #undef __FUNCT__
1277e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1278e1244c69SJed Brown /*@
1279e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1280e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1281e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1282e1244c69SJed Brown    not been changed by the TS.
1283e1244c69SJed Brown 
1284e1244c69SJed Brown    Logically Collective
1285e1244c69SJed Brown 
1286e1244c69SJed Brown    Input Arguments:
1287e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1288e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1289e1244c69SJed Brown 
1290e1244c69SJed Brown    Level: intermediate
1291e1244c69SJed Brown 
1292e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1293e1244c69SJed Brown @*/
1294e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1295e1244c69SJed Brown {
1296e1244c69SJed Brown   PetscFunctionBegin;
1297e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1298e1244c69SJed Brown   PetscFunctionReturn(0);
1299e1244c69SJed Brown }
1300e1244c69SJed Brown 
1301e1244c69SJed Brown #undef __FUNCT__
130255849f57SBarry Smith #define __FUNCT__ "TSLoad"
130355849f57SBarry Smith /*@C
130455849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
130555849f57SBarry Smith 
130655849f57SBarry Smith   Collective on PetscViewer
130755849f57SBarry Smith 
130855849f57SBarry Smith   Input Parameters:
130955849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
131055849f57SBarry Smith            some related function before a call to TSLoad().
131155849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
131255849f57SBarry Smith 
131355849f57SBarry Smith    Level: intermediate
131455849f57SBarry Smith 
131555849f57SBarry Smith   Notes:
131655849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
131755849f57SBarry Smith 
131855849f57SBarry Smith   Notes for advanced users:
131955849f57SBarry Smith   Most users should not need to know the details of the binary storage
132055849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
132155849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
132255849f57SBarry Smith   format is
132355849f57SBarry Smith .vb
132455849f57SBarry Smith      has not yet been determined
132555849f57SBarry Smith .ve
132655849f57SBarry Smith 
132755849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
132855849f57SBarry Smith @*/
1329f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
133055849f57SBarry Smith {
133155849f57SBarry Smith   PetscErrorCode ierr;
133255849f57SBarry Smith   PetscBool      isbinary;
133355849f57SBarry Smith   PetscInt       classid;
133455849f57SBarry Smith   char           type[256];
13352d53ad75SBarry Smith   DMTS           sdm;
1336ad6bc421SBarry Smith   DM             dm;
133755849f57SBarry Smith 
133855849f57SBarry Smith   PetscFunctionBegin;
1339f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
134055849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
134155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
134255849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
134355849f57SBarry Smith 
134455849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1345ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
134655849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1347f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1348f2c2a1b9SBarry Smith   if (ts->ops->load) {
1349f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1350f2c2a1b9SBarry Smith   }
1351ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1352ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1353ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1354f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1355f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13562d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13572d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
135855849f57SBarry Smith   PetscFunctionReturn(0);
135955849f57SBarry Smith }
136055849f57SBarry Smith 
13619804daf3SBarry Smith #include <petscdraw.h>
1362e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1363e04113cfSBarry Smith #include <petscviewersaws.h>
1364f05ece33SBarry Smith #endif
136555849f57SBarry Smith #undef __FUNCT__
13664a2ae208SSatish Balay #define __FUNCT__ "TSView"
13677e2c5f70SBarry Smith /*@C
1368d763cef2SBarry Smith     TSView - Prints the TS data structure.
1369d763cef2SBarry Smith 
13704c49b128SBarry Smith     Collective on TS
1371d763cef2SBarry Smith 
1372d763cef2SBarry Smith     Input Parameters:
1373d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1374d763cef2SBarry Smith -   viewer - visualization context
1375d763cef2SBarry Smith 
1376d763cef2SBarry Smith     Options Database Key:
1377d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1378d763cef2SBarry Smith 
1379d763cef2SBarry Smith     Notes:
1380d763cef2SBarry Smith     The available visualization contexts include
1381b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1382b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1383d763cef2SBarry Smith          output where only the first processor opens
1384d763cef2SBarry Smith          the file.  All other processors send their
1385d763cef2SBarry Smith          data to the first processor to print.
1386d763cef2SBarry Smith 
1387d763cef2SBarry Smith     The user can open an alternative visualization context with
1388b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1389d763cef2SBarry Smith 
1390d763cef2SBarry Smith     Level: beginner
1391d763cef2SBarry Smith 
1392d763cef2SBarry Smith .keywords: TS, timestep, view
1393d763cef2SBarry Smith 
1394b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1395d763cef2SBarry Smith @*/
13967087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1397d763cef2SBarry Smith {
1398dfbe8321SBarry Smith   PetscErrorCode ierr;
139919fd82e9SBarry Smith   TSType         type;
14002b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
14012d53ad75SBarry Smith   DMTS           sdm;
1402e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1403f05ece33SBarry Smith   PetscBool      isams;
1404f05ece33SBarry Smith #endif
1405d763cef2SBarry Smith 
1406d763cef2SBarry Smith   PetscFunctionBegin;
14070700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14083050cee2SBarry Smith   if (!viewer) {
1409ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
14103050cee2SBarry Smith   }
14110700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1412c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1413fd16b177SBarry Smith 
1414251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1415251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
141655849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
14172b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1418e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1419e04113cfSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr);
1420f05ece33SBarry Smith #endif
142132077d6dSBarry Smith   if (iascii) {
1422dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
142377431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14247c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1425d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14265ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1427c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1428d763cef2SBarry Smith     }
14295ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1430193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14312d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14322d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1433d52bd9f3SBarry Smith     if (ts->ops->view) {
1434d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1435d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1436d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1437d52bd9f3SBarry Smith     }
14380f5bd95cSBarry Smith   } else if (isstring) {
1439a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1440b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
144155849f57SBarry Smith   } else if (isbinary) {
144255849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
144355849f57SBarry Smith     MPI_Comm    comm;
144455849f57SBarry Smith     PetscMPIInt rank;
144555849f57SBarry Smith     char        type[256];
144655849f57SBarry Smith 
144755849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
144855849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
144955849f57SBarry Smith     if (!rank) {
145055849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
145155849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
145255849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
145355849f57SBarry Smith     }
145455849f57SBarry Smith     if (ts->ops->view) {
145555849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
145655849f57SBarry Smith     }
1457f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1458f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14592d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14602d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14612b0a91c0SBarry Smith   } else if (isdraw) {
14622b0a91c0SBarry Smith     PetscDraw draw;
14632b0a91c0SBarry Smith     char      str[36];
146489fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14652b0a91c0SBarry Smith 
14662b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14672b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14682b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14692b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
14700298fd71SBarry Smith     ierr   = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
147189fd9fafSBarry Smith     bottom = y - h;
14722b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14732b0a91c0SBarry Smith     if (ts->ops->view) {
14742b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14752b0a91c0SBarry Smith     }
14762b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1477e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1478f05ece33SBarry Smith   } else if (isams) {
1479d45a07a7SBarry Smith     PetscMPIInt rank;
14802657e9d9SBarry Smith     const char  *name;
14812657e9d9SBarry Smith 
14822657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1483d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1484d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1485d45a07a7SBarry Smith       char       dir[1024];
1486d45a07a7SBarry Smith 
1487e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1488a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14892657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14902657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14912657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1492d763cef2SBarry Smith     }
14930acecf5bSBarry Smith     if (ts->ops->view) {
14940acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14950acecf5bSBarry Smith     }
1496f05ece33SBarry Smith #endif
1497f05ece33SBarry Smith   }
1498f05ece33SBarry Smith 
1499b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1500251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1501b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1502d763cef2SBarry Smith   PetscFunctionReturn(0);
1503d763cef2SBarry Smith }
1504d763cef2SBarry Smith 
1505d763cef2SBarry Smith 
15064a2ae208SSatish Balay #undef __FUNCT__
15074a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1508b07ff414SBarry Smith /*@
1509d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1510d763cef2SBarry Smith    the timesteppers.
1511d763cef2SBarry Smith 
15123f9fe445SBarry Smith    Logically Collective on TS
1513d763cef2SBarry Smith 
1514d763cef2SBarry Smith    Input Parameters:
1515d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1516d763cef2SBarry Smith -  usrP - optional user context
1517d763cef2SBarry Smith 
1518d763cef2SBarry Smith    Level: intermediate
1519d763cef2SBarry Smith 
1520d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1521d763cef2SBarry Smith 
1522d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1523d763cef2SBarry Smith @*/
15247087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1525d763cef2SBarry Smith {
1526d763cef2SBarry Smith   PetscFunctionBegin;
15270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1528d763cef2SBarry Smith   ts->user = usrP;
1529d763cef2SBarry Smith   PetscFunctionReturn(0);
1530d763cef2SBarry Smith }
1531d763cef2SBarry Smith 
15324a2ae208SSatish Balay #undef __FUNCT__
15334a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1534b07ff414SBarry Smith /*@
1535d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1536d763cef2SBarry Smith     timestepper.
1537d763cef2SBarry Smith 
1538d763cef2SBarry Smith     Not Collective
1539d763cef2SBarry Smith 
1540d763cef2SBarry Smith     Input Parameter:
1541d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1542d763cef2SBarry Smith 
1543d763cef2SBarry Smith     Output Parameter:
1544d763cef2SBarry Smith .   usrP - user context
1545d763cef2SBarry Smith 
1546d763cef2SBarry Smith     Level: intermediate
1547d763cef2SBarry Smith 
1548d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1549d763cef2SBarry Smith 
1550d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1551d763cef2SBarry Smith @*/
1552e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1553d763cef2SBarry Smith {
1554d763cef2SBarry Smith   PetscFunctionBegin;
15550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1556e71120c6SJed Brown   *(void**)usrP = ts->user;
1557d763cef2SBarry Smith   PetscFunctionReturn(0);
1558d763cef2SBarry Smith }
1559d763cef2SBarry Smith 
15604a2ae208SSatish Balay #undef __FUNCT__
15614a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1562d763cef2SBarry Smith /*@
1563b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1564d763cef2SBarry Smith 
1565d763cef2SBarry Smith    Not Collective
1566d763cef2SBarry Smith 
1567d763cef2SBarry Smith    Input Parameter:
1568d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1569d763cef2SBarry Smith 
1570d763cef2SBarry Smith    Output Parameter:
1571b8123daeSJed Brown .  iter - number of steps completed so far
1572d763cef2SBarry Smith 
1573d763cef2SBarry Smith    Level: intermediate
1574d763cef2SBarry Smith 
1575d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15769be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1577d763cef2SBarry Smith @*/
15787087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1579d763cef2SBarry Smith {
1580d763cef2SBarry Smith   PetscFunctionBegin;
15810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15824482741eSBarry Smith   PetscValidIntPointer(iter,2);
1583d763cef2SBarry Smith   *iter = ts->steps;
1584d763cef2SBarry Smith   PetscFunctionReturn(0);
1585d763cef2SBarry Smith }
1586d763cef2SBarry Smith 
15874a2ae208SSatish Balay #undef __FUNCT__
15884a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1589d763cef2SBarry Smith /*@
1590d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1591d763cef2SBarry Smith    as well as the initial time.
1592d763cef2SBarry Smith 
15933f9fe445SBarry Smith    Logically Collective on TS
1594d763cef2SBarry Smith 
1595d763cef2SBarry Smith    Input Parameters:
1596d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1597d763cef2SBarry Smith .  initial_time - the initial time
1598d763cef2SBarry Smith -  time_step - the size of the timestep
1599d763cef2SBarry Smith 
1600d763cef2SBarry Smith    Level: intermediate
1601d763cef2SBarry Smith 
1602d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1603d763cef2SBarry Smith 
1604d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1605d763cef2SBarry Smith @*/
16067087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1607d763cef2SBarry Smith {
1608e144a568SJed Brown   PetscErrorCode ierr;
1609e144a568SJed Brown 
1610d763cef2SBarry Smith   PetscFunctionBegin;
16110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1612e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1613d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1614d763cef2SBarry Smith   PetscFunctionReturn(0);
1615d763cef2SBarry Smith }
1616d763cef2SBarry Smith 
16174a2ae208SSatish Balay #undef __FUNCT__
16184a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1619d763cef2SBarry Smith /*@
1620d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1621d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1622d763cef2SBarry Smith 
16233f9fe445SBarry Smith    Logically Collective on TS
1624d763cef2SBarry Smith 
1625d763cef2SBarry Smith    Input Parameters:
1626d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1627d763cef2SBarry Smith -  time_step - the size of the timestep
1628d763cef2SBarry Smith 
1629d763cef2SBarry Smith    Level: intermediate
1630d763cef2SBarry Smith 
1631d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1632d763cef2SBarry Smith 
1633d763cef2SBarry Smith .keywords: TS, set, timestep
1634d763cef2SBarry Smith @*/
16357087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1636d763cef2SBarry Smith {
1637d763cef2SBarry Smith   PetscFunctionBegin;
16380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1639c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1640d763cef2SBarry Smith   ts->time_step      = time_step;
164131748224SBarry Smith   ts->time_step_orig = time_step;
1642d763cef2SBarry Smith   PetscFunctionReturn(0);
1643d763cef2SBarry Smith }
1644d763cef2SBarry Smith 
16454a2ae208SSatish Balay #undef __FUNCT__
1646a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1647a43b19c4SJed Brown /*@
164849354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
164949354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
165049354f04SShri Abhyankar      or just return at the final time TS computed.
1651a43b19c4SJed Brown 
1652a43b19c4SJed Brown   Logically Collective on TS
1653a43b19c4SJed Brown 
1654a43b19c4SJed Brown    Input Parameter:
1655a43b19c4SJed Brown +   ts - the time-step context
165649354f04SShri Abhyankar -   eftopt - exact final time option
1657a43b19c4SJed Brown 
1658a43b19c4SJed Brown    Level: beginner
1659a43b19c4SJed Brown 
1660a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1661a43b19c4SJed Brown @*/
166249354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1663a43b19c4SJed Brown {
1664a43b19c4SJed Brown   PetscFunctionBegin;
1665a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
166649354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
166749354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1668a43b19c4SJed Brown   PetscFunctionReturn(0);
1669a43b19c4SJed Brown }
1670a43b19c4SJed Brown 
1671a43b19c4SJed Brown #undef __FUNCT__
16724a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1673d763cef2SBarry Smith /*@
1674d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1675d763cef2SBarry Smith 
1676d763cef2SBarry Smith    Not Collective
1677d763cef2SBarry Smith 
1678d763cef2SBarry Smith    Input Parameter:
1679d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1680d763cef2SBarry Smith 
1681d763cef2SBarry Smith    Output Parameter:
1682d763cef2SBarry Smith .  dt - the current timestep size
1683d763cef2SBarry Smith 
1684d763cef2SBarry Smith    Level: intermediate
1685d763cef2SBarry Smith 
1686d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1687d763cef2SBarry Smith 
1688d763cef2SBarry Smith .keywords: TS, get, timestep
1689d763cef2SBarry Smith @*/
16907087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1691d763cef2SBarry Smith {
1692d763cef2SBarry Smith   PetscFunctionBegin;
16930700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1694f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1695d763cef2SBarry Smith   *dt = ts->time_step;
1696d763cef2SBarry Smith   PetscFunctionReturn(0);
1697d763cef2SBarry Smith }
1698d763cef2SBarry Smith 
16994a2ae208SSatish Balay #undef __FUNCT__
17004a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1701d8e5e3e6SSatish Balay /*@
1702d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1703d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1704d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1705d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1706d763cef2SBarry Smith 
1707d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1708d763cef2SBarry Smith 
1709d763cef2SBarry Smith    Input Parameter:
1710d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1711d763cef2SBarry Smith 
1712d763cef2SBarry Smith    Output Parameter:
1713d763cef2SBarry Smith .  v - the vector containing the solution
1714d763cef2SBarry Smith 
1715d763cef2SBarry Smith    Level: intermediate
1716d763cef2SBarry Smith 
1717d763cef2SBarry Smith .seealso: TSGetTimeStep()
1718d763cef2SBarry Smith 
1719d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1720d763cef2SBarry Smith @*/
17217087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1722d763cef2SBarry Smith {
1723d763cef2SBarry Smith   PetscFunctionBegin;
17240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17254482741eSBarry Smith   PetscValidPointer(v,2);
17268737fe31SLisandro Dalcin   *v = ts->vec_sol;
1727d763cef2SBarry Smith   PetscFunctionReturn(0);
1728d763cef2SBarry Smith }
1729d763cef2SBarry Smith 
1730c235aa8dSHong Zhang #undef __FUNCT__
1731c235aa8dSHong Zhang #define __FUNCT__ "TSGetSensitivity"
1732c235aa8dSHong Zhang /*@
1733c235aa8dSHong Zhang    TSGetSensitivity - Returns the sensitivity in the reverse mode.
1734c235aa8dSHong Zhang 
1735c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1736c235aa8dSHong Zhang 
1737c235aa8dSHong Zhang    Input Parameter:
1738c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1739c235aa8dSHong Zhang 
1740c235aa8dSHong Zhang    Output Parameter:
1741c235aa8dSHong Zhang .  v - the vector containing the solution
1742c235aa8dSHong Zhang 
1743c235aa8dSHong Zhang    Level: intermediate
1744c235aa8dSHong Zhang 
1745c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1746c235aa8dSHong Zhang 
1747c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1748c235aa8dSHong Zhang @*/
1749*b18ea86cSHong Zhang PetscErrorCode  TSGetSensitivity(TS ts,Vec **v,PetscInt *numberadjs)
1750c235aa8dSHong Zhang {
1751c235aa8dSHong Zhang   PetscFunctionBegin;
1752c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1753c235aa8dSHong Zhang   PetscValidPointer(v,2);
1754*b18ea86cSHong Zhang   *v          = ts->vecs_sensi;
1755*b18ea86cSHong Zhang   if(numberadjs) *numberadjs = ts->numberadjs;
1756c235aa8dSHong Zhang   PetscFunctionReturn(0);
1757c235aa8dSHong Zhang }
1758c235aa8dSHong Zhang 
1759bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17604a2ae208SSatish Balay #undef __FUNCT__
1761bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1762d8e5e3e6SSatish Balay /*@
1763bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1764d763cef2SBarry Smith 
1765bdad233fSMatthew Knepley   Not collective
1766d763cef2SBarry Smith 
1767bdad233fSMatthew Knepley   Input Parameters:
1768bdad233fSMatthew Knepley + ts   - The TS
1769bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1770d763cef2SBarry Smith .vb
17710910c330SBarry Smith          U_t - A U = 0      (linear)
17720910c330SBarry Smith          U_t - A(t) U = 0   (linear)
17730910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1774d763cef2SBarry Smith .ve
1775d763cef2SBarry Smith 
1776d763cef2SBarry Smith    Level: beginner
1777d763cef2SBarry Smith 
1778bdad233fSMatthew Knepley .keywords: TS, problem type
1779bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1780d763cef2SBarry Smith @*/
17817087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1782a7cc72afSBarry Smith {
17839e2a6581SJed Brown   PetscErrorCode ierr;
17849e2a6581SJed Brown 
1785d763cef2SBarry Smith   PetscFunctionBegin;
17860700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1787bdad233fSMatthew Knepley   ts->problem_type = type;
17889e2a6581SJed Brown   if (type == TS_LINEAR) {
17899e2a6581SJed Brown     SNES snes;
17909e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17919e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17929e2a6581SJed Brown   }
1793d763cef2SBarry Smith   PetscFunctionReturn(0);
1794d763cef2SBarry Smith }
1795d763cef2SBarry Smith 
1796bdad233fSMatthew Knepley #undef __FUNCT__
1797bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1798bdad233fSMatthew Knepley /*@C
1799bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1800bdad233fSMatthew Knepley 
1801bdad233fSMatthew Knepley   Not collective
1802bdad233fSMatthew Knepley 
1803bdad233fSMatthew Knepley   Input Parameter:
1804bdad233fSMatthew Knepley . ts   - The TS
1805bdad233fSMatthew Knepley 
1806bdad233fSMatthew Knepley   Output Parameter:
1807bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1808bdad233fSMatthew Knepley .vb
1809089b2837SJed Brown          M U_t = A U
1810089b2837SJed Brown          M(t) U_t = A(t) U
1811b5abc632SBarry Smith          F(t,U,U_t)
1812bdad233fSMatthew Knepley .ve
1813bdad233fSMatthew Knepley 
1814bdad233fSMatthew Knepley    Level: beginner
1815bdad233fSMatthew Knepley 
1816bdad233fSMatthew Knepley .keywords: TS, problem type
1817bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1818bdad233fSMatthew Knepley @*/
18197087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1820a7cc72afSBarry Smith {
1821bdad233fSMatthew Knepley   PetscFunctionBegin;
18220700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18234482741eSBarry Smith   PetscValidIntPointer(type,2);
1824bdad233fSMatthew Knepley   *type = ts->problem_type;
1825bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1826bdad233fSMatthew Knepley }
1827d763cef2SBarry Smith 
18284a2ae208SSatish Balay #undef __FUNCT__
18294a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1830d763cef2SBarry Smith /*@
1831d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1832d763cef2SBarry Smith    of a timestepper.
1833d763cef2SBarry Smith 
1834d763cef2SBarry Smith    Collective on TS
1835d763cef2SBarry Smith 
1836d763cef2SBarry Smith    Input Parameter:
1837d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1838d763cef2SBarry Smith 
1839d763cef2SBarry Smith    Notes:
1840d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1841d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1842d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1843d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1844d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1845d763cef2SBarry Smith 
1846d763cef2SBarry Smith    Level: advanced
1847d763cef2SBarry Smith 
1848d763cef2SBarry Smith .keywords: TS, timestep, setup
1849d763cef2SBarry Smith 
1850d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1851d763cef2SBarry Smith @*/
18527087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1853d763cef2SBarry Smith {
1854dfbe8321SBarry Smith   PetscErrorCode ierr;
18556c6b9e74SPeter Brune   DM             dm;
18566c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1857d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18586c6b9e74SPeter Brune   TSIJacobian    ijac;
18596c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1860d763cef2SBarry Smith 
1861d763cef2SBarry Smith   PetscFunctionBegin;
18620700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1863277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1864277b19d0SLisandro Dalcin 
18657adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18669596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1867d763cef2SBarry Smith   }
1868277b19d0SLisandro Dalcin 
1869277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1870277b19d0SLisandro Dalcin 
1871*b18ea86cSHong Zhang   if (ts->reverse_mode && !ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSensitivity() first");
1872c235aa8dSHong Zhang 
1873552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
18741c3436cfSJed Brown 
1875e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1876e1244c69SJed Brown     Mat Amat,Pmat;
1877e1244c69SJed Brown     SNES snes;
1878e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1879e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1880e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1881e1244c69SJed Brown      * have displaced the RHS matrix */
1882e1244c69SJed Brown     if (Amat == ts->Arhs) {
1883e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1884e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1885e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1886e1244c69SJed Brown     }
1887e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1888e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1889e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1890e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1891e1244c69SJed Brown     }
1892e1244c69SJed Brown   }
1893e1244c69SJed Brown 
1894277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1895000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1896277b19d0SLisandro Dalcin   }
1897277b19d0SLisandro Dalcin 
18986c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
18996c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
19006c6b9e74SPeter Brune    */
19016c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
19020298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
19036c6b9e74SPeter Brune   if (!func) {
19046c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
19056c6b9e74SPeter Brune   }
19066c6b9e74SPeter 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.
19076c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
19086c6b9e74SPeter Brune    */
19090298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
19100298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
19110298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
19126c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
19136c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
19146c6b9e74SPeter Brune   }
1915277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1916277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1917277b19d0SLisandro Dalcin }
1918277b19d0SLisandro Dalcin 
1919277b19d0SLisandro Dalcin #undef __FUNCT__
1920277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1921277b19d0SLisandro Dalcin /*@
1922277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1923277b19d0SLisandro Dalcin 
1924277b19d0SLisandro Dalcin    Collective on TS
1925277b19d0SLisandro Dalcin 
1926277b19d0SLisandro Dalcin    Input Parameter:
1927277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1928277b19d0SLisandro Dalcin 
1929277b19d0SLisandro Dalcin    Level: beginner
1930277b19d0SLisandro Dalcin 
1931277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1932277b19d0SLisandro Dalcin 
1933277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1934277b19d0SLisandro Dalcin @*/
1935277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1936277b19d0SLisandro Dalcin {
1937*b18ea86cSHong Zhang   PetscInt       i;
1938277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1939277b19d0SLisandro Dalcin 
1940277b19d0SLisandro Dalcin   PetscFunctionBegin;
1941277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1942*b18ea86cSHong Zhang 
1943277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1944277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1945277b19d0SLisandro Dalcin   }
1946277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1947bbd56ea5SKarl Rupp 
19484e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
19494e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1950214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
19516bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1952e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1953e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
195438637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1955*b18ea86cSHong Zhang   if (ts->reverse_mode) {
1956*b18ea86cSHong Zhang     for (i=0; i<ts->numberadjs; i++) {
1957*b18ea86cSHong Zhang       ierr = VecDestroy(&ts->vecs_sensi[i]);CHKERRQ(ierr);
1958*b18ea86cSHong Zhang     }
1959*b18ea86cSHong Zhang   }
1960277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1961d763cef2SBarry Smith   PetscFunctionReturn(0);
1962d763cef2SBarry Smith }
1963d763cef2SBarry Smith 
19644a2ae208SSatish Balay #undef __FUNCT__
19654a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1966d8e5e3e6SSatish Balay /*@
1967d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1968d763cef2SBarry Smith    with TSCreate().
1969d763cef2SBarry Smith 
1970d763cef2SBarry Smith    Collective on TS
1971d763cef2SBarry Smith 
1972d763cef2SBarry Smith    Input Parameter:
1973d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1974d763cef2SBarry Smith 
1975d763cef2SBarry Smith    Level: beginner
1976d763cef2SBarry Smith 
1977d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1978d763cef2SBarry Smith 
1979d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1980d763cef2SBarry Smith @*/
19816bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1982d763cef2SBarry Smith {
19836849ba73SBarry Smith   PetscErrorCode ierr;
1984d763cef2SBarry Smith 
1985d763cef2SBarry Smith   PetscFunctionBegin;
19866bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
19876bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
19886bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1989d763cef2SBarry Smith 
19906bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1991277b19d0SLisandro Dalcin 
1992e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
1993e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
19946bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
19956d4c513bSLisandro Dalcin 
199684df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
1997aeb4809dSShri Abhyankar   if ((*ts)->event) {
1998aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
1999aeb4809dSShri Abhyankar   }
20006bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20016bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20026bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20036d4c513bSLisandro Dalcin 
2004a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2005d763cef2SBarry Smith   PetscFunctionReturn(0);
2006d763cef2SBarry Smith }
2007d763cef2SBarry Smith 
20084a2ae208SSatish Balay #undef __FUNCT__
20094a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2010d8e5e3e6SSatish Balay /*@
2011d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2012d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2013d763cef2SBarry Smith 
2014d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2015d763cef2SBarry Smith 
2016d763cef2SBarry Smith    Input Parameter:
2017d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2018d763cef2SBarry Smith 
2019d763cef2SBarry Smith    Output Parameter:
2020d763cef2SBarry Smith .  snes - the nonlinear solver context
2021d763cef2SBarry Smith 
2022d763cef2SBarry Smith    Notes:
2023d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2024d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
202594b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2026d763cef2SBarry Smith 
2027d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20280298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2029d763cef2SBarry Smith 
2030d763cef2SBarry Smith    Level: beginner
2031d763cef2SBarry Smith 
2032d763cef2SBarry Smith .keywords: timestep, get, SNES
2033d763cef2SBarry Smith @*/
20347087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2035d763cef2SBarry Smith {
2036d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2037d372ba47SLisandro Dalcin 
2038d763cef2SBarry Smith   PetscFunctionBegin;
20390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20404482741eSBarry Smith   PetscValidPointer(snes,2);
2041d372ba47SLisandro Dalcin   if (!ts->snes) {
2042ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20430298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20443bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2045d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2046496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20479e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20489e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20499e2a6581SJed Brown     }
2050d372ba47SLisandro Dalcin   }
2051d763cef2SBarry Smith   *snes = ts->snes;
2052d763cef2SBarry Smith   PetscFunctionReturn(0);
2053d763cef2SBarry Smith }
2054d763cef2SBarry Smith 
20554a2ae208SSatish Balay #undef __FUNCT__
2056deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2057deb2cd25SJed Brown /*@
2058deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2059deb2cd25SJed Brown 
2060deb2cd25SJed Brown    Collective
2061deb2cd25SJed Brown 
2062deb2cd25SJed Brown    Input Parameter:
2063deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2064deb2cd25SJed Brown -  snes - the nonlinear solver context
2065deb2cd25SJed Brown 
2066deb2cd25SJed Brown    Notes:
2067deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2068deb2cd25SJed Brown 
2069deb2cd25SJed Brown    Level: developer
2070deb2cd25SJed Brown 
2071deb2cd25SJed Brown .keywords: timestep, set, SNES
2072deb2cd25SJed Brown @*/
2073deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2074deb2cd25SJed Brown {
2075deb2cd25SJed Brown   PetscErrorCode ierr;
2076d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2077deb2cd25SJed Brown 
2078deb2cd25SJed Brown   PetscFunctionBegin;
2079deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2080deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2081deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2082deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2083bbd56ea5SKarl Rupp 
2084deb2cd25SJed Brown   ts->snes = snes;
2085bbd56ea5SKarl Rupp 
20860298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20870298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2088740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
20890298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2090740132f1SEmil Constantinescu   }
2091deb2cd25SJed Brown   PetscFunctionReturn(0);
2092deb2cd25SJed Brown }
2093deb2cd25SJed Brown 
2094deb2cd25SJed Brown #undef __FUNCT__
209594b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2096d8e5e3e6SSatish Balay /*@
209794b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2098d763cef2SBarry Smith    a TS (timestepper) context.
2099d763cef2SBarry Smith 
210094b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2101d763cef2SBarry Smith 
2102d763cef2SBarry Smith    Input Parameter:
2103d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2104d763cef2SBarry Smith 
2105d763cef2SBarry Smith    Output Parameter:
210694b7f48cSBarry Smith .  ksp - the nonlinear solver context
2107d763cef2SBarry Smith 
2108d763cef2SBarry Smith    Notes:
210994b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2110d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2111d763cef2SBarry Smith    KSP and PC contexts as well.
2112d763cef2SBarry Smith 
211394b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21140298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2115d763cef2SBarry Smith 
2116d763cef2SBarry Smith    Level: beginner
2117d763cef2SBarry Smith 
211894b7f48cSBarry Smith .keywords: timestep, get, KSP
2119d763cef2SBarry Smith @*/
21207087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2121d763cef2SBarry Smith {
2122d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2123089b2837SJed Brown   SNES           snes;
2124d372ba47SLisandro Dalcin 
2125d763cef2SBarry Smith   PetscFunctionBegin;
21260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21274482741eSBarry Smith   PetscValidPointer(ksp,2);
212817186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2129e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2130089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2131089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2132d763cef2SBarry Smith   PetscFunctionReturn(0);
2133d763cef2SBarry Smith }
2134d763cef2SBarry Smith 
2135d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2136d763cef2SBarry Smith 
21374a2ae208SSatish Balay #undef __FUNCT__
2138adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2139adb62b0dSMatthew Knepley /*@
2140adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2141adb62b0dSMatthew Knepley    maximum time for iteration.
2142adb62b0dSMatthew Knepley 
21433f9fe445SBarry Smith    Not Collective
2144adb62b0dSMatthew Knepley 
2145adb62b0dSMatthew Knepley    Input Parameters:
2146adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21470298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21480298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2149adb62b0dSMatthew Knepley 
2150adb62b0dSMatthew Knepley    Level: intermediate
2151adb62b0dSMatthew Knepley 
2152adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2153adb62b0dSMatthew Knepley @*/
21547087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2155adb62b0dSMatthew Knepley {
2156adb62b0dSMatthew Knepley   PetscFunctionBegin;
21570700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2158abc0a331SBarry Smith   if (maxsteps) {
21594482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2160adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2161adb62b0dSMatthew Knepley   }
2162abc0a331SBarry Smith   if (maxtime) {
21634482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2164adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2165adb62b0dSMatthew Knepley   }
2166adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2167adb62b0dSMatthew Knepley }
2168adb62b0dSMatthew Knepley 
2169adb62b0dSMatthew Knepley #undef __FUNCT__
21704a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2171d763cef2SBarry Smith /*@
2172d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2173d763cef2SBarry Smith    maximum time for iteration.
2174d763cef2SBarry Smith 
21753f9fe445SBarry Smith    Logically Collective on TS
2176d763cef2SBarry Smith 
2177d763cef2SBarry Smith    Input Parameters:
2178d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2179d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2180d763cef2SBarry Smith -  maxtime - final time to iterate to
2181d763cef2SBarry Smith 
2182d763cef2SBarry Smith    Options Database Keys:
2183d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
21843bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2185d763cef2SBarry Smith 
2186d763cef2SBarry Smith    Notes:
2187d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Level: intermediate
2190d763cef2SBarry Smith 
2191d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2192a43b19c4SJed Brown 
2193a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2194d763cef2SBarry Smith @*/
21957087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2196d763cef2SBarry Smith {
2197d763cef2SBarry Smith   PetscFunctionBegin;
21980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2199c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2200c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
220139b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
220239b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2203d763cef2SBarry Smith   PetscFunctionReturn(0);
2204d763cef2SBarry Smith }
2205d763cef2SBarry Smith 
22064a2ae208SSatish Balay #undef __FUNCT__
22074a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2208d763cef2SBarry Smith /*@
2209d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2210d763cef2SBarry Smith    for use by the TS routines.
2211d763cef2SBarry Smith 
22123f9fe445SBarry Smith    Logically Collective on TS and Vec
2213d763cef2SBarry Smith 
2214d763cef2SBarry Smith    Input Parameters:
2215d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22160910c330SBarry Smith -  u - the solution vector
2217d763cef2SBarry Smith 
2218d763cef2SBarry Smith    Level: beginner
2219d763cef2SBarry Smith 
2220d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2221d763cef2SBarry Smith @*/
22220910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2223d763cef2SBarry Smith {
22248737fe31SLisandro Dalcin   PetscErrorCode ierr;
2225496e6a7aSJed Brown   DM             dm;
22268737fe31SLisandro Dalcin 
2227d763cef2SBarry Smith   PetscFunctionBegin;
22280700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22290910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22300910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22316bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2232bbd56ea5SKarl Rupp 
22330910c330SBarry Smith   ts->vec_sol = u;
2234bbd56ea5SKarl Rupp 
2235496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22360910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2237d763cef2SBarry Smith   PetscFunctionReturn(0);
2238d763cef2SBarry Smith }
2239d763cef2SBarry Smith 
2240e74ef692SMatthew Knepley #undef __FUNCT__
2241c235aa8dSHong Zhang #define __FUNCT__ "TSSetSensitivity"
2242c235aa8dSHong Zhang /*@
2243c235aa8dSHong Zhang    TSSetSensitivity - Sets the initial solution vector
2244c235aa8dSHong Zhang    for use by the TS routines.
2245c235aa8dSHong Zhang 
2246c235aa8dSHong Zhang    Logically Collective on TS and Vec
2247c235aa8dSHong Zhang 
2248c235aa8dSHong Zhang    Input Parameters:
2249c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2250c235aa8dSHong Zhang -  u - the solution vector
2251c235aa8dSHong Zhang 
2252c235aa8dSHong Zhang    Level: beginner
2253c235aa8dSHong Zhang 
2254c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2255c235aa8dSHong Zhang @*/
2256*b18ea86cSHong Zhang PetscErrorCode  TSSetSensitivity(TS ts,Vec *u,PetscInt numberadjs)
2257c235aa8dSHong Zhang {
2258c235aa8dSHong Zhang   PetscErrorCode ierr;
2259c235aa8dSHong Zhang   DM             dm;
2260*b18ea86cSHong Zhang   PetscInt       i;
2261c235aa8dSHong Zhang 
2262c235aa8dSHong Zhang   PetscFunctionBegin;
2263c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2264*b18ea86cSHong Zhang   PetscValidPointer(u,2);
2265*b18ea86cSHong Zhang   for (i=0; i<numberadjs; i++) {
2266*b18ea86cSHong Zhang     ierr = PetscObjectReference((PetscObject)u[i]);CHKERRQ(ierr);
2267*b18ea86cSHong Zhang   }
2268*b18ea86cSHong Zhang   if(ts->vecs_sensi) {
2269*b18ea86cSHong Zhang     ierr = VecDestroyVecs(ts->numberadjs,&ts->vecs_sensi);CHKERRQ(ierr);
2270*b18ea86cSHong Zhang   }
2271*b18ea86cSHong Zhang   ts->vecs_sensi = u;
2272*b18ea86cSHong Zhang   ts->numberadjs = numberadjs;
2273c235aa8dSHong Zhang 
2274c235aa8dSHong Zhang   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
2275*b18ea86cSHong Zhang   if(u) {
2276*b18ea86cSHong Zhang     ierr = DMShellSetGlobalVector(dm,u[0]);CHKERRQ(ierr);
2277*b18ea86cSHong Zhang   }
2278c235aa8dSHong Zhang   PetscFunctionReturn(0);
2279c235aa8dSHong Zhang }
2280c235aa8dSHong Zhang 
2281c235aa8dSHong Zhang #undef __FUNCT__
2282e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2283ac226902SBarry Smith /*@C
2284000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
22853f2090d5SJed Brown   called once at the beginning of each time step.
2286000e7ae3SMatthew Knepley 
22873f9fe445SBarry Smith   Logically Collective on TS
2288000e7ae3SMatthew Knepley 
2289000e7ae3SMatthew Knepley   Input Parameters:
2290000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2291000e7ae3SMatthew Knepley - func - The function
2292000e7ae3SMatthew Knepley 
2293000e7ae3SMatthew Knepley   Calling sequence of func:
2294000e7ae3SMatthew Knepley . func (TS ts);
2295000e7ae3SMatthew Knepley 
2296000e7ae3SMatthew Knepley   Level: intermediate
2297000e7ae3SMatthew Knepley 
2298b8123daeSJed Brown   Note:
2299b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2300b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2301b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2302b8123daeSJed Brown 
2303000e7ae3SMatthew Knepley .keywords: TS, timestep
23049be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2305000e7ae3SMatthew Knepley @*/
23067087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2307000e7ae3SMatthew Knepley {
2308000e7ae3SMatthew Knepley   PetscFunctionBegin;
23090700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2310ae60f76fSBarry Smith   ts->prestep = func;
2311000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2312000e7ae3SMatthew Knepley }
2313000e7ae3SMatthew Knepley 
2314e74ef692SMatthew Knepley #undef __FUNCT__
23153f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
231609ee8438SJed Brown /*@
23173f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
23183f2090d5SJed Brown 
23193f2090d5SJed Brown   Collective on TS
23203f2090d5SJed Brown 
23213f2090d5SJed Brown   Input Parameters:
23223f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
23233f2090d5SJed Brown 
23243f2090d5SJed Brown   Notes:
23253f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
23263f2090d5SJed Brown   so most users would not generally call this routine themselves.
23273f2090d5SJed Brown 
23283f2090d5SJed Brown   Level: developer
23293f2090d5SJed Brown 
23303f2090d5SJed Brown .keywords: TS, timestep
23319be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
23323f2090d5SJed Brown @*/
23337087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
23343f2090d5SJed Brown {
23353f2090d5SJed Brown   PetscErrorCode ierr;
23363f2090d5SJed Brown 
23373f2090d5SJed Brown   PetscFunctionBegin;
23380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2339ae60f76fSBarry Smith   if (ts->prestep) {
2340ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2341312ce896SJed Brown   }
23423f2090d5SJed Brown   PetscFunctionReturn(0);
23433f2090d5SJed Brown }
23443f2090d5SJed Brown 
23453f2090d5SJed Brown #undef __FUNCT__
2346b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2347b8123daeSJed Brown /*@C
2348b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2349b8123daeSJed Brown   called once at the beginning of each stage.
2350b8123daeSJed Brown 
2351b8123daeSJed Brown   Logically Collective on TS
2352b8123daeSJed Brown 
2353b8123daeSJed Brown   Input Parameters:
2354b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2355b8123daeSJed Brown - func - The function
2356b8123daeSJed Brown 
2357b8123daeSJed Brown   Calling sequence of func:
2358b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2359b8123daeSJed Brown 
2360b8123daeSJed Brown   Level: intermediate
2361b8123daeSJed Brown 
2362b8123daeSJed Brown   Note:
2363b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2364b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2365b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2366b8123daeSJed Brown 
2367b8123daeSJed Brown .keywords: TS, timestep
23689be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2369b8123daeSJed Brown @*/
2370b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2371b8123daeSJed Brown {
2372b8123daeSJed Brown   PetscFunctionBegin;
2373b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2374ae60f76fSBarry Smith   ts->prestage = func;
2375b8123daeSJed Brown   PetscFunctionReturn(0);
2376b8123daeSJed Brown }
2377b8123daeSJed Brown 
2378b8123daeSJed Brown #undef __FUNCT__
23799be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
23809be3e283SDebojyoti Ghosh /*@C
23819be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
23829be3e283SDebojyoti Ghosh   called once at the end of each stage.
23839be3e283SDebojyoti Ghosh 
23849be3e283SDebojyoti Ghosh   Logically Collective on TS
23859be3e283SDebojyoti Ghosh 
23869be3e283SDebojyoti Ghosh   Input Parameters:
23879be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
23889be3e283SDebojyoti Ghosh - func - The function
23899be3e283SDebojyoti Ghosh 
23909be3e283SDebojyoti Ghosh   Calling sequence of func:
23919be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
23929be3e283SDebojyoti Ghosh 
23939be3e283SDebojyoti Ghosh   Level: intermediate
23949be3e283SDebojyoti Ghosh 
23959be3e283SDebojyoti Ghosh   Note:
23969be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
23979be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
23989be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
23999be3e283SDebojyoti Ghosh 
24009be3e283SDebojyoti Ghosh .keywords: TS, timestep
24019be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
24029be3e283SDebojyoti Ghosh @*/
24039be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
24049be3e283SDebojyoti Ghosh {
24059be3e283SDebojyoti Ghosh   PetscFunctionBegin;
24069be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
24079be3e283SDebojyoti Ghosh   ts->poststage = func;
24089be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
24099be3e283SDebojyoti Ghosh }
24109be3e283SDebojyoti Ghosh 
24119be3e283SDebojyoti Ghosh #undef __FUNCT__
2412b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2413b8123daeSJed Brown /*@
2414b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2415b8123daeSJed Brown 
2416b8123daeSJed Brown   Collective on TS
2417b8123daeSJed Brown 
2418b8123daeSJed Brown   Input Parameters:
2419b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
24209be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2421b8123daeSJed Brown 
2422b8123daeSJed Brown   Notes:
2423b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2424b8123daeSJed Brown   most users would not generally call this routine themselves.
2425b8123daeSJed Brown 
2426b8123daeSJed Brown   Level: developer
2427b8123daeSJed Brown 
2428b8123daeSJed Brown .keywords: TS, timestep
24299be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2430b8123daeSJed Brown @*/
2431b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2432b8123daeSJed Brown {
2433b8123daeSJed Brown   PetscErrorCode ierr;
2434b8123daeSJed Brown 
2435b8123daeSJed Brown   PetscFunctionBegin;
2436b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2437ae60f76fSBarry Smith   if (ts->prestage) {
2438ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2439b8123daeSJed Brown   }
2440b8123daeSJed Brown   PetscFunctionReturn(0);
2441b8123daeSJed Brown }
2442b8123daeSJed Brown 
2443b8123daeSJed Brown #undef __FUNCT__
24449be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
24459be3e283SDebojyoti Ghosh /*@
24469be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
24479be3e283SDebojyoti Ghosh 
24489be3e283SDebojyoti Ghosh   Collective on TS
24499be3e283SDebojyoti Ghosh 
24509be3e283SDebojyoti Ghosh   Input Parameters:
24519be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
24529be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
24539be3e283SDebojyoti Ghosh   stageindex  - Stage number
24549be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
24559be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
24569be3e283SDebojyoti Ghosh 
24579be3e283SDebojyoti Ghosh   Notes:
24589be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
24599be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
24609be3e283SDebojyoti Ghosh 
24619be3e283SDebojyoti Ghosh   Level: developer
24629be3e283SDebojyoti Ghosh 
24639be3e283SDebojyoti Ghosh .keywords: TS, timestep
24649be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
24659be3e283SDebojyoti Ghosh @*/
24669be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
24679be3e283SDebojyoti Ghosh {
24689be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
24699be3e283SDebojyoti Ghosh 
24709be3e283SDebojyoti Ghosh   PetscFunctionBegin;
24719be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
24724beae5d8SLisandro Dalcin   if (ts->poststage) {
24739be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
24749be3e283SDebojyoti Ghosh   }
24759be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
24769be3e283SDebojyoti Ghosh }
24779be3e283SDebojyoti Ghosh 
24789be3e283SDebojyoti Ghosh #undef __FUNCT__
2479e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2480ac226902SBarry Smith /*@C
2481000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
24823f2090d5SJed Brown   called once at the end of each time step.
2483000e7ae3SMatthew Knepley 
24843f9fe445SBarry Smith   Logically Collective on TS
2485000e7ae3SMatthew Knepley 
2486000e7ae3SMatthew Knepley   Input Parameters:
2487000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2488000e7ae3SMatthew Knepley - func - The function
2489000e7ae3SMatthew Knepley 
2490000e7ae3SMatthew Knepley   Calling sequence of func:
2491b8123daeSJed Brown $ func (TS ts);
2492000e7ae3SMatthew Knepley 
2493000e7ae3SMatthew Knepley   Level: intermediate
2494000e7ae3SMatthew Knepley 
2495000e7ae3SMatthew Knepley .keywords: TS, timestep
2496b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2497000e7ae3SMatthew Knepley @*/
24987087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2499000e7ae3SMatthew Knepley {
2500000e7ae3SMatthew Knepley   PetscFunctionBegin;
25010700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2502ae60f76fSBarry Smith   ts->poststep = func;
2503000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2504000e7ae3SMatthew Knepley }
2505000e7ae3SMatthew Knepley 
2506e74ef692SMatthew Knepley #undef __FUNCT__
25073f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
250809ee8438SJed Brown /*@
25093f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
25103f2090d5SJed Brown 
25113f2090d5SJed Brown   Collective on TS
25123f2090d5SJed Brown 
25133f2090d5SJed Brown   Input Parameters:
25143f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
25153f2090d5SJed Brown 
25163f2090d5SJed Brown   Notes:
25173f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
25183f2090d5SJed Brown   so most users would not generally call this routine themselves.
25193f2090d5SJed Brown 
25203f2090d5SJed Brown   Level: developer
25213f2090d5SJed Brown 
25223f2090d5SJed Brown .keywords: TS, timestep
25233f2090d5SJed Brown @*/
25247087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
25253f2090d5SJed Brown {
25263f2090d5SJed Brown   PetscErrorCode ierr;
25273f2090d5SJed Brown 
25283f2090d5SJed Brown   PetscFunctionBegin;
25290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2530ae60f76fSBarry Smith   if (ts->poststep) {
2531ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
253272ac3e02SJed Brown   }
25333f2090d5SJed Brown   PetscFunctionReturn(0);
25343f2090d5SJed Brown }
25353f2090d5SJed Brown 
2536d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2537d763cef2SBarry Smith 
25384a2ae208SSatish Balay #undef __FUNCT__
2539a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2540d763cef2SBarry Smith /*@C
2541a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2542d763cef2SBarry Smith    timestep to display the iteration's  progress.
2543d763cef2SBarry Smith 
25443f9fe445SBarry Smith    Logically Collective on TS
2545d763cef2SBarry Smith 
2546d763cef2SBarry Smith    Input Parameters:
2547d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2548e213d8f1SJed Brown .  monitor - monitoring routine
2549329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
25500298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2551b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
25520298fd71SBarry Smith           (may be NULL)
2553d763cef2SBarry Smith 
2554e213d8f1SJed Brown    Calling sequence of monitor:
25550910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2556d763cef2SBarry Smith 
2557d763cef2SBarry Smith +    ts - the TS context
255888c05cc5SBarry 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
255988c05cc5SBarry Smith                                been interpolated to)
25601f06c33eSBarry Smith .    time - current time
25610910c330SBarry Smith .    u - current iterate
2562d763cef2SBarry Smith -    mctx - [optional] monitoring context
2563d763cef2SBarry Smith 
2564d763cef2SBarry Smith    Notes:
2565d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2566d763cef2SBarry Smith    already has been loaded.
2567d763cef2SBarry Smith 
2568025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2569025f1a04SBarry Smith 
2570d763cef2SBarry Smith    Level: intermediate
2571d763cef2SBarry Smith 
2572d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2573d763cef2SBarry Smith 
2574a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2575d763cef2SBarry Smith @*/
2576c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2577d763cef2SBarry Smith {
2578d763cef2SBarry Smith   PetscFunctionBegin;
25790700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
258017186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2581d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
25828704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2583d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2584d763cef2SBarry Smith   PetscFunctionReturn(0);
2585d763cef2SBarry Smith }
2586d763cef2SBarry Smith 
25874a2ae208SSatish Balay #undef __FUNCT__
2588a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2589d763cef2SBarry Smith /*@C
2590a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2591d763cef2SBarry Smith 
25923f9fe445SBarry Smith    Logically Collective on TS
2593d763cef2SBarry Smith 
2594d763cef2SBarry Smith    Input Parameters:
2595d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2596d763cef2SBarry Smith 
2597d763cef2SBarry Smith    Notes:
2598d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2599d763cef2SBarry Smith 
2600d763cef2SBarry Smith    Level: intermediate
2601d763cef2SBarry Smith 
2602d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2603d763cef2SBarry Smith 
2604a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2605d763cef2SBarry Smith @*/
26067087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2607d763cef2SBarry Smith {
2608d952e501SBarry Smith   PetscErrorCode ierr;
2609d952e501SBarry Smith   PetscInt       i;
2610d952e501SBarry Smith 
2611d763cef2SBarry Smith   PetscFunctionBegin;
26120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2613d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
26148704b422SBarry Smith     if (ts->monitordestroy[i]) {
26158704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2616d952e501SBarry Smith     }
2617d952e501SBarry Smith   }
2618d763cef2SBarry Smith   ts->numbermonitors = 0;
2619d763cef2SBarry Smith   PetscFunctionReturn(0);
2620d763cef2SBarry Smith }
2621d763cef2SBarry Smith 
26224a2ae208SSatish Balay #undef __FUNCT__
2623a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2624d8e5e3e6SSatish Balay /*@
2625a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
26265516499fSSatish Balay 
26275516499fSSatish Balay    Level: intermediate
262841251cbbSSatish Balay 
26295516499fSSatish Balay .keywords: TS, set, monitor
26305516499fSSatish Balay 
263141251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
263241251cbbSSatish Balay @*/
2633649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2634d763cef2SBarry Smith {
2635dfbe8321SBarry Smith   PetscErrorCode ierr;
2636ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2637d132466eSBarry Smith 
2638d763cef2SBarry Smith   PetscFunctionBegin;
2639649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2640971832b6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr);
2641649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2642d763cef2SBarry Smith   PetscFunctionReturn(0);
2643d763cef2SBarry Smith }
2644d763cef2SBarry Smith 
26454a2ae208SSatish Balay #undef __FUNCT__
2646cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2647cd652676SJed Brown /*@
2648cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2649cd652676SJed Brown 
2650cd652676SJed Brown    Logically Collective on TS
2651cd652676SJed Brown 
2652cd652676SJed Brown    Input Argument:
2653cd652676SJed Brown .  ts - time stepping context
2654cd652676SJed Brown 
2655cd652676SJed Brown    Output Argument:
2656cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2657cd652676SJed Brown 
2658cd652676SJed Brown    Level: intermediate
2659cd652676SJed Brown 
2660cd652676SJed Brown .keywords: TS, set
2661cd652676SJed Brown 
2662cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
2663cd652676SJed Brown @*/
2664cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2665cd652676SJed Brown {
2666cd652676SJed Brown   PetscFunctionBegin;
2667cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2668cd652676SJed Brown   ts->retain_stages = flg;
2669cd652676SJed Brown   PetscFunctionReturn(0);
2670cd652676SJed Brown }
2671cd652676SJed Brown 
2672cd652676SJed Brown #undef __FUNCT__
2673cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
2674cd652676SJed Brown /*@
2675cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2676cd652676SJed Brown 
2677cd652676SJed Brown    Collective on TS
2678cd652676SJed Brown 
2679cd652676SJed Brown    Input Argument:
2680cd652676SJed Brown +  ts - time stepping context
2681cd652676SJed Brown -  t - time to interpolate to
2682cd652676SJed Brown 
2683cd652676SJed Brown    Output Argument:
26840910c330SBarry Smith .  U - state at given time
2685cd652676SJed Brown 
2686cd652676SJed Brown    Notes:
2687cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
2688cd652676SJed Brown 
2689cd652676SJed Brown    Level: intermediate
2690cd652676SJed Brown 
2691cd652676SJed Brown    Developer Notes:
2692cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
2693cd652676SJed Brown 
2694cd652676SJed Brown .keywords: TS, set
2695cd652676SJed Brown 
2696cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
2697cd652676SJed Brown @*/
26980910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
2699cd652676SJed Brown {
2700cd652676SJed Brown   PetscErrorCode ierr;
2701cd652676SJed Brown 
2702cd652676SJed Brown   PetscFunctionBegin;
2703cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2704b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
27056712e2f1SBarry 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);
2706ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
27070910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
2708cd652676SJed Brown   PetscFunctionReturn(0);
2709cd652676SJed Brown }
2710cd652676SJed Brown 
2711cd652676SJed Brown #undef __FUNCT__
27124a2ae208SSatish Balay #define __FUNCT__ "TSStep"
2713d763cef2SBarry Smith /*@
27146d9e5789SSean Farley    TSStep - Steps one time step
2715d763cef2SBarry Smith 
2716d763cef2SBarry Smith    Collective on TS
2717d763cef2SBarry Smith 
2718d763cef2SBarry Smith    Input Parameter:
2719d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2720d763cef2SBarry Smith 
27216d9e5789SSean Farley    Level: intermediate
2722d763cef2SBarry Smith 
2723b8123daeSJed Brown    Notes:
2724b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
2725b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
2726b8123daeSJed Brown 
272725cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
272825cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
272925cb2221SBarry Smith 
2730d763cef2SBarry Smith .keywords: TS, timestep, solve
2731d763cef2SBarry Smith 
27329be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
2733d763cef2SBarry Smith @*/
2734193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
2735d763cef2SBarry Smith {
27362fb8446cSMatthew G. Knepley   DM               dm;
2737dfbe8321SBarry Smith   PetscErrorCode   ierr;
2738fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
2739d763cef2SBarry Smith 
2740d763cef2SBarry Smith   PetscFunctionBegin;
27410700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2742fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
2743fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
2744fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
2745fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
2746fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
2747fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
2748fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
2749fffbeea8SBarry Smith 
27502fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
2751d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
2752d405a339SMatthew Knepley 
2753362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
275424655328SShri   ts->ptime_prev = ts->ptime;
2755cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
27564e9ba7eeSMatthew G. Knepley   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
2757bbd56ea5SKarl Rupp 
2758e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
2759d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2760d2daff3dSHong Zhang   if(ts->reverse_mode) {
2761d2daff3dSHong Zhang     if(!ts->ops->stepadj) {
2762d2daff3dSHong 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);
2763d2daff3dSHong Zhang     }else {
2764d2daff3dSHong Zhang       ierr = (*ts->ops->stepadj)(ts);CHKERRQ(ierr);
2765d2daff3dSHong Zhang     }
2766d2daff3dSHong Zhang   }else {
2767193ac0bcSJed Brown     ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
2768d2daff3dSHong Zhang   }
2769d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2770bbd56ea5SKarl Rupp 
277124655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
2772cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
2773362cd11cSLisandro Dalcin 
2774362cd11cSLisandro Dalcin   if (ts->reason < 0) {
2775cef5090cSJed Brown     if (ts->errorifstepfailed) {
2776cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
2777ce94432eSBarry 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]);
27782a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
27792a3a10ceSLisandro 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]);
2780ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
2781cef5090cSJed Brown     }
2782362cd11cSLisandro Dalcin   } else if (!ts->reason) {
2783db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
2784db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
2785362cd11cSLisandro Dalcin   }
2786d763cef2SBarry Smith   PetscFunctionReturn(0);
2787d763cef2SBarry Smith }
2788d763cef2SBarry Smith 
27894a2ae208SSatish Balay #undef __FUNCT__
279005175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
279105175c85SJed Brown /*@
279205175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
279305175c85SJed Brown 
27941c3436cfSJed Brown    Collective on TS
279505175c85SJed Brown 
279605175c85SJed Brown    Input Arguments:
27971c3436cfSJed Brown +  ts - time stepping context
27981c3436cfSJed Brown .  order - desired order of accuracy
27990298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
280005175c85SJed Brown 
280105175c85SJed Brown    Output Arguments:
28020910c330SBarry Smith .  U - state at the end of the current step
280305175c85SJed Brown 
280405175c85SJed Brown    Level: advanced
280505175c85SJed Brown 
2806108c343cSJed Brown    Notes:
2807108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
2808108c343cSJed 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.
2809108c343cSJed Brown 
28101c3436cfSJed Brown .seealso: TSStep(), TSAdapt
281105175c85SJed Brown @*/
28120910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
281305175c85SJed Brown {
281405175c85SJed Brown   PetscErrorCode ierr;
281505175c85SJed Brown 
281605175c85SJed Brown   PetscFunctionBegin;
281705175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
281805175c85SJed Brown   PetscValidType(ts,1);
28190910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
2820ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
28210910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
282205175c85SJed Brown   PetscFunctionReturn(0);
282305175c85SJed Brown }
282405175c85SJed Brown 
282505175c85SJed Brown #undef __FUNCT__
28266a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
28276a4d4014SLisandro Dalcin /*@
28286a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
28296a4d4014SLisandro Dalcin 
28306a4d4014SLisandro Dalcin    Collective on TS
28316a4d4014SLisandro Dalcin 
28326a4d4014SLisandro Dalcin    Input Parameter:
28336a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2834cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
28355a3a76d0SJed Brown 
28366a4d4014SLisandro Dalcin    Level: beginner
28376a4d4014SLisandro Dalcin 
28385a3a76d0SJed Brown    Notes:
28395a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
28405a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
28415a3a76d0SJed Brown    stepped over the final time.
28425a3a76d0SJed Brown 
28436a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
28446a4d4014SLisandro Dalcin 
28456a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
28466a4d4014SLisandro Dalcin @*/
2847cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
28486a4d4014SLisandro Dalcin {
2849b06615a5SLisandro Dalcin   Vec               solution;
28506a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
2851f22f69f0SBarry Smith 
28526a4d4014SLisandro Dalcin   PetscFunctionBegin;
28530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2854f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
2855d2daff3dSHong 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 */
2856b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
28570910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
2858b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
2859b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
2860b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
28615a3a76d0SJed Brown     }
28620910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
2863bbd56ea5SKarl Rupp   } else if (u) {
28640910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
28655a3a76d0SJed Brown   }
2866d2daff3dSHong Zhang   ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/
28676a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
2868193ac0bcSJed Brown   ts->steps             = 0;
28695ef26d82SJed Brown   ts->ksp_its           = 0;
28705ef26d82SJed Brown   ts->snes_its          = 0;
2871c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
2872c610991cSLisandro Dalcin   ts->reject            = 0;
2873193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
2874193ac0bcSJed Brown 
2875ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
2876f05ece33SBarry Smith 
2877193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
2878193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
28790910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
2880cc708dedSBarry Smith     ts->solvetime = ts->ptime;
2881193ac0bcSJed Brown   } else {
28826a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
2883db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
2884d2daff3dSHong Zhang     else if (!ts->reverse_mode && ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
2885e1a7a14fSJed Brown     while (!ts->reason) {
2886d2daff3dSHong Zhang       if(!ts->reverse_mode) {
2887b06615a5SLisandro Dalcin         ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2888d2daff3dSHong Zhang       }else {
2889d2daff3dSHong Zhang         ierr = TSMonitor(ts,ts->max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2890d2daff3dSHong Zhang       }
2891193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
2892aeb4809dSShri Abhyankar       if (ts->event) {
2893aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
28941eda64f1SShri Abhyankar 	if (ts->event->status != TSEVENT_PROCESSING) {
28951eda64f1SShri Abhyankar 	  ierr = TSPostStep(ts);CHKERRQ(ierr);
28961eda64f1SShri Abhyankar 	}
28971eda64f1SShri Abhyankar       } else {
28981eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
2899aeb4809dSShri Abhyankar       }
2900193ac0bcSJed Brown     }
2901d2daff3dSHong Zhang     if (!ts->reverse_mode && ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
29020910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
2903cc708dedSBarry Smith       ts->solvetime = ts->max_time;
2904b06615a5SLisandro Dalcin       solution = u;
29050574a7fbSJed Brown     } else {
2906ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
2907cc708dedSBarry Smith       ts->solvetime = ts->ptime;
2908b06615a5SLisandro Dalcin       solution = ts->vec_sol;
29090574a7fbSJed Brown     }
2910d2daff3dSHong Zhang     if(!ts->reverse_mode) {
2911b06615a5SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
2912d2daff3dSHong Zhang     }
29134e9ba7eeSMatthew G. Knepley     ierr = VecViewFromOptions(u, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
2914193ac0bcSJed Brown   }
2915d2daff3dSHong Zhang 
2916ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
291756f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
29186a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
29196a4d4014SLisandro Dalcin }
29206a4d4014SLisandro Dalcin 
29216a4d4014SLisandro Dalcin #undef __FUNCT__
29224a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
2923228d79bcSJed Brown /*@
2924228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
2925228d79bcSJed Brown 
2926228d79bcSJed Brown    Collective on TS
2927228d79bcSJed Brown 
2928228d79bcSJed Brown    Input Parameters:
2929228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
2930228d79bcSJed Brown .  step - step number that has just completed
2931228d79bcSJed Brown .  ptime - model time of the state
29320910c330SBarry Smith -  u - state at the current model time
2933228d79bcSJed Brown 
2934228d79bcSJed Brown    Notes:
2935228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
2936228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
2937228d79bcSJed Brown 
2938228d79bcSJed Brown    Level: advanced
2939228d79bcSJed Brown 
2940228d79bcSJed Brown .keywords: TS, timestep
2941228d79bcSJed Brown @*/
29420910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
2943d763cef2SBarry Smith {
29446849ba73SBarry Smith   PetscErrorCode ierr;
2945a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
2946d763cef2SBarry Smith 
2947d763cef2SBarry Smith   PetscFunctionBegin;
2948b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2949b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
29505edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
2951d763cef2SBarry Smith   for (i=0; i<n; i++) {
29520910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
2953d763cef2SBarry Smith   }
29545edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
2955d763cef2SBarry Smith   PetscFunctionReturn(0);
2956d763cef2SBarry Smith }
2957d763cef2SBarry Smith 
2958d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
29594a2ae208SSatish Balay #undef __FUNCT__
2960a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
2961d763cef2SBarry Smith /*@C
2962a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
2963a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
2964d763cef2SBarry Smith 
2965d763cef2SBarry Smith    Collective on TS
2966d763cef2SBarry Smith 
2967d763cef2SBarry Smith    Input Parameters:
2968d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
2969d763cef2SBarry Smith .  label - the title to put in the title bar
29707c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
2971a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
2972a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
2973d763cef2SBarry Smith 
2974d763cef2SBarry Smith    Output Parameter:
29750b039ecaSBarry Smith .  ctx - the context
2976d763cef2SBarry Smith 
2977d763cef2SBarry Smith    Options Database Key:
29784f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
29794f09c107SBarry Smith .  -ts_monitor_lg_solution -
298099fdda47SBarry Smith .  -ts_monitor_lg_error -
298199fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
298299fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
298399fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
2984d763cef2SBarry Smith 
2985d763cef2SBarry Smith    Notes:
2986a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
2987d763cef2SBarry Smith 
2988d763cef2SBarry Smith    Level: intermediate
2989d763cef2SBarry Smith 
29907c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
2991d763cef2SBarry Smith 
29924f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
29937c922b88SBarry Smith 
2994d763cef2SBarry Smith @*/
2995a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
2996d763cef2SBarry Smith {
2997b0a32e0cSBarry Smith   PetscDraw      win;
2998dfbe8321SBarry Smith   PetscErrorCode ierr;
2999d763cef2SBarry Smith 
3000d763cef2SBarry Smith   PetscFunctionBegin;
3001b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3002a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
30033fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
30040b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
30053bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3006287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3007287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3008a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3009d763cef2SBarry Smith   PetscFunctionReturn(0);
3010d763cef2SBarry Smith }
3011d763cef2SBarry Smith 
30124a2ae208SSatish Balay #undef __FUNCT__
30134f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3014b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3015d763cef2SBarry Smith {
30160b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3017c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3018dfbe8321SBarry Smith   PetscErrorCode ierr;
3019d763cef2SBarry Smith 
3020d763cef2SBarry Smith   PetscFunctionBegin;
3021b06615a5SLisandro Dalcin   if (!step) {
3022a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3023a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3024a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3025a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3026287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3027a9f9c1f6SBarry Smith   }
3028c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
30290b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3030b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
30310b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
30323923b477SBarry Smith   }
3033d763cef2SBarry Smith   PetscFunctionReturn(0);
3034d763cef2SBarry Smith }
3035d763cef2SBarry Smith 
30364a2ae208SSatish Balay #undef __FUNCT__
3037a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3038d763cef2SBarry Smith /*@C
3039a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3040a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3041d763cef2SBarry Smith 
30420b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3043d763cef2SBarry Smith 
3044d763cef2SBarry Smith    Input Parameter:
30450b039ecaSBarry Smith .  ctx - the monitor context
3046d763cef2SBarry Smith 
3047d763cef2SBarry Smith    Level: intermediate
3048d763cef2SBarry Smith 
3049d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3050d763cef2SBarry Smith 
30514f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3052d763cef2SBarry Smith @*/
3053a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3054d763cef2SBarry Smith {
3055b0a32e0cSBarry Smith   PetscDraw      draw;
3056dfbe8321SBarry Smith   PetscErrorCode ierr;
3057d763cef2SBarry Smith 
3058d763cef2SBarry Smith   PetscFunctionBegin;
30590b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
30606bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
30610b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
30620b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3063d763cef2SBarry Smith   PetscFunctionReturn(0);
3064d763cef2SBarry Smith }
3065d763cef2SBarry Smith 
30664a2ae208SSatish Balay #undef __FUNCT__
30674a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3068d763cef2SBarry Smith /*@
3069b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3070d763cef2SBarry Smith 
3071d763cef2SBarry Smith    Not Collective
3072d763cef2SBarry Smith 
3073d763cef2SBarry Smith    Input Parameter:
3074d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3075d763cef2SBarry Smith 
3076d763cef2SBarry Smith    Output Parameter:
3077d763cef2SBarry Smith .  t  - the current time
3078d763cef2SBarry Smith 
3079d763cef2SBarry Smith    Level: beginner
3080d763cef2SBarry Smith 
3081b8123daeSJed Brown    Note:
3082b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
30839be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3084b8123daeSJed Brown 
3085d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3086d763cef2SBarry Smith 
3087d763cef2SBarry Smith .keywords: TS, get, time
3088d763cef2SBarry Smith @*/
30897087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3090d763cef2SBarry Smith {
3091d763cef2SBarry Smith   PetscFunctionBegin;
30920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3093f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3094d763cef2SBarry Smith   *t = ts->ptime;
3095d763cef2SBarry Smith   PetscFunctionReturn(0);
3096d763cef2SBarry Smith }
3097d763cef2SBarry Smith 
30984a2ae208SSatish Balay #undef __FUNCT__
3099e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3100e5e524a1SHong Zhang /*@
3101e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3102e5e524a1SHong Zhang 
3103e5e524a1SHong Zhang    Not Collective
3104e5e524a1SHong Zhang 
3105e5e524a1SHong Zhang    Input Parameter:
3106e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3107e5e524a1SHong Zhang 
3108e5e524a1SHong Zhang    Output Parameter:
3109e5e524a1SHong Zhang .  t  - the previous time
3110e5e524a1SHong Zhang 
3111e5e524a1SHong Zhang    Level: beginner
3112e5e524a1SHong Zhang 
3113e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3114e5e524a1SHong Zhang 
3115e5e524a1SHong Zhang .keywords: TS, get, time
3116e5e524a1SHong Zhang @*/
3117e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3118e5e524a1SHong Zhang {
3119e5e524a1SHong Zhang   PetscFunctionBegin;
3120e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3121e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3122e5e524a1SHong Zhang   *t = ts->ptime_prev;
3123e5e524a1SHong Zhang   PetscFunctionReturn(0);
3124e5e524a1SHong Zhang }
3125e5e524a1SHong Zhang 
3126e5e524a1SHong Zhang #undef __FUNCT__
31276a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
31286a4d4014SLisandro Dalcin /*@
31296a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
31306a4d4014SLisandro Dalcin 
31313f9fe445SBarry Smith    Logically Collective on TS
31326a4d4014SLisandro Dalcin 
31336a4d4014SLisandro Dalcin    Input Parameters:
31346a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
31356a4d4014SLisandro Dalcin -  time - the time
31366a4d4014SLisandro Dalcin 
31376a4d4014SLisandro Dalcin    Level: intermediate
31386a4d4014SLisandro Dalcin 
31396a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
31406a4d4014SLisandro Dalcin 
31416a4d4014SLisandro Dalcin .keywords: TS, set, time
31426a4d4014SLisandro Dalcin @*/
31437087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
31446a4d4014SLisandro Dalcin {
31456a4d4014SLisandro Dalcin   PetscFunctionBegin;
31460700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3147c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
31486a4d4014SLisandro Dalcin   ts->ptime = t;
31496a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
31506a4d4014SLisandro Dalcin }
31516a4d4014SLisandro Dalcin 
31526a4d4014SLisandro Dalcin #undef __FUNCT__
31534a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3154d763cef2SBarry Smith /*@C
3155d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3156d763cef2SBarry Smith    TS options in the database.
3157d763cef2SBarry Smith 
31583f9fe445SBarry Smith    Logically Collective on TS
3159d763cef2SBarry Smith 
3160d763cef2SBarry Smith    Input Parameter:
3161d763cef2SBarry Smith +  ts     - The TS context
3162d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3163d763cef2SBarry Smith 
3164d763cef2SBarry Smith    Notes:
3165d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3166d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3167d763cef2SBarry Smith    hyphen.
3168d763cef2SBarry Smith 
3169d763cef2SBarry Smith    Level: advanced
3170d763cef2SBarry Smith 
3171d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3172d763cef2SBarry Smith 
3173d763cef2SBarry Smith .seealso: TSSetFromOptions()
3174d763cef2SBarry Smith 
3175d763cef2SBarry Smith @*/
31767087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3177d763cef2SBarry Smith {
3178dfbe8321SBarry Smith   PetscErrorCode ierr;
3179089b2837SJed Brown   SNES           snes;
3180d763cef2SBarry Smith 
3181d763cef2SBarry Smith   PetscFunctionBegin;
31820700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3183d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3184089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3185089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3186d763cef2SBarry Smith   PetscFunctionReturn(0);
3187d763cef2SBarry Smith }
3188d763cef2SBarry Smith 
3189d763cef2SBarry Smith 
31904a2ae208SSatish Balay #undef __FUNCT__
31914a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3192d763cef2SBarry Smith /*@C
3193d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3194d763cef2SBarry Smith    TS options in the database.
3195d763cef2SBarry Smith 
31963f9fe445SBarry Smith    Logically Collective on TS
3197d763cef2SBarry Smith 
3198d763cef2SBarry Smith    Input Parameter:
3199d763cef2SBarry Smith +  ts     - The TS context
3200d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3201d763cef2SBarry Smith 
3202d763cef2SBarry Smith    Notes:
3203d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3204d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3205d763cef2SBarry Smith    hyphen.
3206d763cef2SBarry Smith 
3207d763cef2SBarry Smith    Level: advanced
3208d763cef2SBarry Smith 
3209d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3210d763cef2SBarry Smith 
3211d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3212d763cef2SBarry Smith 
3213d763cef2SBarry Smith @*/
32147087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3215d763cef2SBarry Smith {
3216dfbe8321SBarry Smith   PetscErrorCode ierr;
3217089b2837SJed Brown   SNES           snes;
3218d763cef2SBarry Smith 
3219d763cef2SBarry Smith   PetscFunctionBegin;
32200700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3221d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3222089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3223089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3224d763cef2SBarry Smith   PetscFunctionReturn(0);
3225d763cef2SBarry Smith }
3226d763cef2SBarry Smith 
32274a2ae208SSatish Balay #undef __FUNCT__
32284a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3229d763cef2SBarry Smith /*@C
3230d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3231d763cef2SBarry Smith    TS options in the database.
3232d763cef2SBarry Smith 
3233d763cef2SBarry Smith    Not Collective
3234d763cef2SBarry Smith 
3235d763cef2SBarry Smith    Input Parameter:
3236d763cef2SBarry Smith .  ts - The TS context
3237d763cef2SBarry Smith 
3238d763cef2SBarry Smith    Output Parameter:
3239d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3240d763cef2SBarry Smith 
3241d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3242d763cef2SBarry Smith    sufficient length to hold the prefix.
3243d763cef2SBarry Smith 
3244d763cef2SBarry Smith    Level: intermediate
3245d763cef2SBarry Smith 
3246d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3247d763cef2SBarry Smith 
3248d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3249d763cef2SBarry Smith @*/
32507087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3251d763cef2SBarry Smith {
3252dfbe8321SBarry Smith   PetscErrorCode ierr;
3253d763cef2SBarry Smith 
3254d763cef2SBarry Smith   PetscFunctionBegin;
32550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
32564482741eSBarry Smith   PetscValidPointer(prefix,2);
3257d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3258d763cef2SBarry Smith   PetscFunctionReturn(0);
3259d763cef2SBarry Smith }
3260d763cef2SBarry Smith 
32614a2ae208SSatish Balay #undef __FUNCT__
32624a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3263d763cef2SBarry Smith /*@C
3264d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3265d763cef2SBarry Smith 
3266d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3267d763cef2SBarry Smith 
3268d763cef2SBarry Smith    Input Parameter:
3269d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3270d763cef2SBarry Smith 
3271d763cef2SBarry Smith    Output Parameters:
3272e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3273e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3274e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3275e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3276d763cef2SBarry Smith 
32770298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3278d763cef2SBarry Smith 
3279d763cef2SBarry Smith    Level: intermediate
3280d763cef2SBarry Smith 
328126d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3282d763cef2SBarry Smith 
3283d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3284d763cef2SBarry Smith @*/
3285e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3286d763cef2SBarry Smith {
3287089b2837SJed Brown   PetscErrorCode ierr;
3288089b2837SJed Brown   SNES           snes;
328924989b8cSPeter Brune   DM             dm;
3290089b2837SJed Brown 
3291d763cef2SBarry Smith   PetscFunctionBegin;
3292089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3293e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
329424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
329524989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3296d763cef2SBarry Smith   PetscFunctionReturn(0);
3297d763cef2SBarry Smith }
3298d763cef2SBarry Smith 
32991713a123SBarry Smith #undef __FUNCT__
33002eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
33012eca1d9cSJed Brown /*@C
33022eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
33032eca1d9cSJed Brown 
33042eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
33052eca1d9cSJed Brown 
33062eca1d9cSJed Brown    Input Parameter:
33072eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
33082eca1d9cSJed Brown 
33092eca1d9cSJed Brown    Output Parameters:
3310e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3311e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
33122eca1d9cSJed Brown .  f   - The function to compute the matrices
33132eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
33142eca1d9cSJed Brown 
33150298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
33162eca1d9cSJed Brown 
33172eca1d9cSJed Brown    Level: advanced
33182eca1d9cSJed Brown 
33192eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
33202eca1d9cSJed Brown 
33212eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
33222eca1d9cSJed Brown @*/
3323e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
33242eca1d9cSJed Brown {
3325089b2837SJed Brown   PetscErrorCode ierr;
3326089b2837SJed Brown   SNES           snes;
332724989b8cSPeter Brune   DM             dm;
33280910c330SBarry Smith 
33292eca1d9cSJed Brown   PetscFunctionBegin;
3330089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3331f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3332e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
333324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
333424989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
33352eca1d9cSJed Brown   PetscFunctionReturn(0);
33362eca1d9cSJed Brown }
33372eca1d9cSJed Brown 
33386083293cSBarry Smith 
33392eca1d9cSJed Brown #undef __FUNCT__
334083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
33411713a123SBarry Smith /*@C
334283a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
33431713a123SBarry Smith    VecView() for the solution at each timestep
33441713a123SBarry Smith 
33451713a123SBarry Smith    Collective on TS
33461713a123SBarry Smith 
33471713a123SBarry Smith    Input Parameters:
33481713a123SBarry Smith +  ts - the TS context
33491713a123SBarry Smith .  step - current time-step
3350142b95e3SSatish Balay .  ptime - current time
33510298fd71SBarry Smith -  dummy - either a viewer or NULL
33521713a123SBarry Smith 
335399fdda47SBarry Smith    Options Database:
335499fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
335599fdda47SBarry Smith 
335699fdda47SBarry 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
335799fdda47SBarry Smith        will look bad
335899fdda47SBarry Smith 
33591713a123SBarry Smith    Level: intermediate
33601713a123SBarry Smith 
33611713a123SBarry Smith .keywords: TS,  vector, monitor, view
33621713a123SBarry Smith 
3363a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
33641713a123SBarry Smith @*/
33650910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
33661713a123SBarry Smith {
3367dfbe8321SBarry Smith   PetscErrorCode   ierr;
336883a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3369473a3ab2SBarry Smith   PetscDraw        draw;
33701713a123SBarry Smith 
33711713a123SBarry Smith   PetscFunctionBegin;
33726083293cSBarry Smith   if (!step && ictx->showinitial) {
33736083293cSBarry Smith     if (!ictx->initialsolution) {
33740910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
33751713a123SBarry Smith     }
33760910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
33776083293cSBarry Smith   }
3378b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
33790dcf80beSBarry Smith 
33806083293cSBarry Smith   if (ictx->showinitial) {
33816083293cSBarry Smith     PetscReal pause;
33826083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
33836083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
33846083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
33856083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
33866083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
33876083293cSBarry Smith   }
33880910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3389473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3390473a3ab2SBarry Smith     PetscReal xl,yl,xr,yr,tw,w,h;
3391473a3ab2SBarry Smith     char      time[32];
3392473a3ab2SBarry Smith     size_t    len;
3393473a3ab2SBarry Smith 
3394473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3395473a3ab2SBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
3396473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3397473a3ab2SBarry Smith     ierr =  PetscStrlen(time,&len);CHKERRQ(ierr);
33980298fd71SBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3399473a3ab2SBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
3400473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3401473a3ab2SBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3402473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3403473a3ab2SBarry Smith   }
3404473a3ab2SBarry Smith 
34056083293cSBarry Smith   if (ictx->showinitial) {
34066083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
34076083293cSBarry Smith   }
34081713a123SBarry Smith   PetscFunctionReturn(0);
34091713a123SBarry Smith }
34101713a123SBarry Smith 
34112d5ee99bSBarry Smith #undef __FUNCT__
34122d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
34132d5ee99bSBarry Smith /*@C
34142d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
34152d5ee99bSBarry Smith 
34162d5ee99bSBarry Smith    Collective on TS
34172d5ee99bSBarry Smith 
34182d5ee99bSBarry Smith    Input Parameters:
34192d5ee99bSBarry Smith +  ts - the TS context
34202d5ee99bSBarry Smith .  step - current time-step
34212d5ee99bSBarry Smith .  ptime - current time
34222d5ee99bSBarry Smith -  dummy - either a viewer or NULL
34232d5ee99bSBarry Smith 
34242d5ee99bSBarry Smith    Level: intermediate
34252d5ee99bSBarry Smith 
34262d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
34272d5ee99bSBarry Smith 
34282d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
34292d5ee99bSBarry Smith @*/
34302d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
34312d5ee99bSBarry Smith {
34322d5ee99bSBarry Smith   PetscErrorCode    ierr;
34332d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
34342d5ee99bSBarry Smith   PetscDraw         draw;
34352d5ee99bSBarry Smith   MPI_Comm          comm;
34362d5ee99bSBarry Smith   PetscInt          n;
34372d5ee99bSBarry Smith   PetscMPIInt       size;
34382d5ee99bSBarry Smith   PetscReal         xl,yl,xr,yr,tw,w,h;
34392d5ee99bSBarry Smith   char              time[32];
34402d5ee99bSBarry Smith   size_t            len;
34412d5ee99bSBarry Smith   const PetscScalar *U;
34422d5ee99bSBarry Smith 
34432d5ee99bSBarry Smith   PetscFunctionBegin;
34442d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
34452d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
34462d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
34472d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
34482d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
34492d5ee99bSBarry Smith 
34502d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
34512d5ee99bSBarry Smith 
34522d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
34534b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3454ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3455a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3456a4494fc1SBarry Smith       PetscFunctionReturn(0);
3457a4494fc1SBarry Smith   }
34582d5ee99bSBarry Smith   if (!step) ictx->color++;
34592d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
34602d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
34612d5ee99bSBarry Smith 
34622d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
34634b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
34642d5ee99bSBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
34652d5ee99bSBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
34662d5ee99bSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
34672d5ee99bSBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
34682d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
34692d5ee99bSBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
34702d5ee99bSBarry Smith   }
34712d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
34722d5ee99bSBarry Smith   PetscFunctionReturn(0);
34732d5ee99bSBarry Smith }
34742d5ee99bSBarry Smith 
34751713a123SBarry Smith 
34766c699258SBarry Smith #undef __FUNCT__
347783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
34786083293cSBarry Smith /*@C
347983a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
34806083293cSBarry Smith 
34816083293cSBarry Smith    Collective on TS
34826083293cSBarry Smith 
34836083293cSBarry Smith    Input Parameters:
34846083293cSBarry Smith .    ctx - the monitor context
34856083293cSBarry Smith 
34866083293cSBarry Smith    Level: intermediate
34876083293cSBarry Smith 
34886083293cSBarry Smith .keywords: TS,  vector, monitor, view
34896083293cSBarry Smith 
349083a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
34916083293cSBarry Smith @*/
349283a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
34936083293cSBarry Smith {
34946083293cSBarry Smith   PetscErrorCode ierr;
34956083293cSBarry Smith 
34966083293cSBarry Smith   PetscFunctionBegin;
34974b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
349883a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
349983a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
350083a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
35016083293cSBarry Smith   PetscFunctionReturn(0);
35026083293cSBarry Smith }
35036083293cSBarry Smith 
35046083293cSBarry Smith #undef __FUNCT__
350583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
35066083293cSBarry Smith /*@C
350783a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
35086083293cSBarry Smith 
35096083293cSBarry Smith    Collective on TS
35106083293cSBarry Smith 
35116083293cSBarry Smith    Input Parameter:
35126083293cSBarry Smith .    ts - time-step context
35136083293cSBarry Smith 
35146083293cSBarry Smith    Output Patameter:
35156083293cSBarry Smith .    ctx - the monitor context
35166083293cSBarry Smith 
351799fdda47SBarry Smith    Options Database:
351899fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
351999fdda47SBarry Smith 
35206083293cSBarry Smith    Level: intermediate
35216083293cSBarry Smith 
35226083293cSBarry Smith .keywords: TS,  vector, monitor, view
35236083293cSBarry Smith 
352483a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
35256083293cSBarry Smith @*/
352683a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
35276083293cSBarry Smith {
35286083293cSBarry Smith   PetscErrorCode   ierr;
35296083293cSBarry Smith 
35306083293cSBarry Smith   PetscFunctionBegin;
3531b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
353283a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3533e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3534bbd56ea5SKarl Rupp 
353583a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3536473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
35370298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3538473a3ab2SBarry Smith 
3539473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
35400298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
35412d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
35426083293cSBarry Smith   PetscFunctionReturn(0);
35436083293cSBarry Smith }
35446083293cSBarry Smith 
35456083293cSBarry Smith #undef __FUNCT__
354683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
35473a471f94SBarry Smith /*@C
354883a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
35493a471f94SBarry Smith    VecView() for the error at each timestep
35503a471f94SBarry Smith 
35513a471f94SBarry Smith    Collective on TS
35523a471f94SBarry Smith 
35533a471f94SBarry Smith    Input Parameters:
35543a471f94SBarry Smith +  ts - the TS context
35553a471f94SBarry Smith .  step - current time-step
35563a471f94SBarry Smith .  ptime - current time
35570298fd71SBarry Smith -  dummy - either a viewer or NULL
35583a471f94SBarry Smith 
35593a471f94SBarry Smith    Level: intermediate
35603a471f94SBarry Smith 
35613a471f94SBarry Smith .keywords: TS,  vector, monitor, view
35623a471f94SBarry Smith 
35633a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
35643a471f94SBarry Smith @*/
35650910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
35663a471f94SBarry Smith {
35673a471f94SBarry Smith   PetscErrorCode   ierr;
356883a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
356983a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
35703a471f94SBarry Smith   Vec              work;
35713a471f94SBarry Smith 
35723a471f94SBarry Smith   PetscFunctionBegin;
3573b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
35740910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
35753a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
35760910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
35773a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
35783a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
35793a471f94SBarry Smith   PetscFunctionReturn(0);
35803a471f94SBarry Smith }
35813a471f94SBarry Smith 
35822a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
35833a471f94SBarry Smith #undef __FUNCT__
35846c699258SBarry Smith #define __FUNCT__ "TSSetDM"
35856c699258SBarry Smith /*@
35866c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
35876c699258SBarry Smith 
35883f9fe445SBarry Smith    Logically Collective on TS and DM
35896c699258SBarry Smith 
35906c699258SBarry Smith    Input Parameters:
35916c699258SBarry Smith +  ts - the preconditioner context
35926c699258SBarry Smith -  dm - the dm
35936c699258SBarry Smith 
35946c699258SBarry Smith    Level: intermediate
35956c699258SBarry Smith 
35966c699258SBarry Smith 
35976c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
35986c699258SBarry Smith @*/
35997087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
36006c699258SBarry Smith {
36016c699258SBarry Smith   PetscErrorCode ierr;
3602089b2837SJed Brown   SNES           snes;
3603942e3340SBarry Smith   DMTS           tsdm;
36046c699258SBarry Smith 
36056c699258SBarry Smith   PetscFunctionBegin;
36060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
360770663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
3608942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
36092a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
3610942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
3611942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
361224989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
361324989b8cSPeter Brune         tsdm->originaldm = dm;
361424989b8cSPeter Brune       }
361524989b8cSPeter Brune     }
36166bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
361724989b8cSPeter Brune   }
36186c699258SBarry Smith   ts->dm = dm;
3619bbd56ea5SKarl Rupp 
3620089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3621089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
36226c699258SBarry Smith   PetscFunctionReturn(0);
36236c699258SBarry Smith }
36246c699258SBarry Smith 
36256c699258SBarry Smith #undef __FUNCT__
36266c699258SBarry Smith #define __FUNCT__ "TSGetDM"
36276c699258SBarry Smith /*@
36286c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
36296c699258SBarry Smith 
36303f9fe445SBarry Smith    Not Collective
36316c699258SBarry Smith 
36326c699258SBarry Smith    Input Parameter:
36336c699258SBarry Smith . ts - the preconditioner context
36346c699258SBarry Smith 
36356c699258SBarry Smith    Output Parameter:
36366c699258SBarry Smith .  dm - the dm
36376c699258SBarry Smith 
36386c699258SBarry Smith    Level: intermediate
36396c699258SBarry Smith 
36406c699258SBarry Smith 
36416c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
36426c699258SBarry Smith @*/
36437087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
36446c699258SBarry Smith {
3645496e6a7aSJed Brown   PetscErrorCode ierr;
3646496e6a7aSJed Brown 
36476c699258SBarry Smith   PetscFunctionBegin;
36480700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3649496e6a7aSJed Brown   if (!ts->dm) {
3650ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
3651496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
3652496e6a7aSJed Brown   }
36536c699258SBarry Smith   *dm = ts->dm;
36546c699258SBarry Smith   PetscFunctionReturn(0);
36556c699258SBarry Smith }
36561713a123SBarry Smith 
36570f5c6efeSJed Brown #undef __FUNCT__
36580f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
36590f5c6efeSJed Brown /*@
36600f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
36610f5c6efeSJed Brown 
36623f9fe445SBarry Smith    Logically Collective on SNES
36630f5c6efeSJed Brown 
36640f5c6efeSJed Brown    Input Parameter:
3665d42a1c89SJed Brown + snes - nonlinear solver
36660910c330SBarry Smith . U - the current state at which to evaluate the residual
3667d42a1c89SJed Brown - ctx - user context, must be a TS
36680f5c6efeSJed Brown 
36690f5c6efeSJed Brown    Output Parameter:
36700f5c6efeSJed Brown . F - the nonlinear residual
36710f5c6efeSJed Brown 
36720f5c6efeSJed Brown    Notes:
36730f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
36740f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
36750f5c6efeSJed Brown 
36760f5c6efeSJed Brown    Level: advanced
36770f5c6efeSJed Brown 
36780f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
36790f5c6efeSJed Brown @*/
36800910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
36810f5c6efeSJed Brown {
36820f5c6efeSJed Brown   TS             ts = (TS)ctx;
36830f5c6efeSJed Brown   PetscErrorCode ierr;
36840f5c6efeSJed Brown 
36850f5c6efeSJed Brown   PetscFunctionBegin;
36860f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
36870910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
36880f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
36890f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
36900910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
36910f5c6efeSJed Brown   PetscFunctionReturn(0);
36920f5c6efeSJed Brown }
36930f5c6efeSJed Brown 
36940f5c6efeSJed Brown #undef __FUNCT__
36950f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
36960f5c6efeSJed Brown /*@
36970f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
36980f5c6efeSJed Brown 
36990f5c6efeSJed Brown    Collective on SNES
37000f5c6efeSJed Brown 
37010f5c6efeSJed Brown    Input Parameter:
37020f5c6efeSJed Brown + snes - nonlinear solver
37030910c330SBarry Smith . U - the current state at which to evaluate the residual
37040f5c6efeSJed Brown - ctx - user context, must be a TS
37050f5c6efeSJed Brown 
37060f5c6efeSJed Brown    Output Parameter:
37070f5c6efeSJed Brown + A - the Jacobian
37080f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
37090f5c6efeSJed Brown - flag - indicates any structure change in the matrix
37100f5c6efeSJed Brown 
37110f5c6efeSJed Brown    Notes:
37120f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
37130f5c6efeSJed Brown 
37140f5c6efeSJed Brown    Level: developer
37150f5c6efeSJed Brown 
37160f5c6efeSJed Brown .seealso: SNESSetJacobian()
37170f5c6efeSJed Brown @*/
3718d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
37190f5c6efeSJed Brown {
37200f5c6efeSJed Brown   TS             ts = (TS)ctx;
37210f5c6efeSJed Brown   PetscErrorCode ierr;
37220f5c6efeSJed Brown 
37230f5c6efeSJed Brown   PetscFunctionBegin;
37240f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
37250910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
37260f5c6efeSJed Brown   PetscValidPointer(A,3);
372794ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
37280f5c6efeSJed Brown   PetscValidPointer(B,4);
372994ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
37300f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
3731d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
37320f5c6efeSJed Brown   PetscFunctionReturn(0);
37330f5c6efeSJed Brown }
3734325fc9f4SBarry Smith 
37350e4ef248SJed Brown #undef __FUNCT__
37360e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
37370e4ef248SJed Brown /*@C
37380e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
37390e4ef248SJed Brown 
37400e4ef248SJed Brown    Collective on TS
37410e4ef248SJed Brown 
37420e4ef248SJed Brown    Input Arguments:
37430e4ef248SJed Brown +  ts - time stepping context
37440e4ef248SJed Brown .  t - time at which to evaluate
37450910c330SBarry Smith .  U - state at which to evaluate
37460e4ef248SJed Brown -  ctx - context
37470e4ef248SJed Brown 
37480e4ef248SJed Brown    Output Arguments:
37490e4ef248SJed Brown .  F - right hand side
37500e4ef248SJed Brown 
37510e4ef248SJed Brown    Level: intermediate
37520e4ef248SJed Brown 
37530e4ef248SJed Brown    Notes:
37540e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
37550e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
37560e4ef248SJed Brown 
37570e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
37580e4ef248SJed Brown @*/
37590910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
37600e4ef248SJed Brown {
37610e4ef248SJed Brown   PetscErrorCode ierr;
37620e4ef248SJed Brown   Mat            Arhs,Brhs;
37630e4ef248SJed Brown 
37640e4ef248SJed Brown   PetscFunctionBegin;
37650e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
3766d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
37670910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
37680e4ef248SJed Brown   PetscFunctionReturn(0);
37690e4ef248SJed Brown }
37700e4ef248SJed Brown 
37710e4ef248SJed Brown #undef __FUNCT__
37720e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
37730e4ef248SJed Brown /*@C
37740e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
37750e4ef248SJed Brown 
37760e4ef248SJed Brown    Collective on TS
37770e4ef248SJed Brown 
37780e4ef248SJed Brown    Input Arguments:
37790e4ef248SJed Brown +  ts - time stepping context
37800e4ef248SJed Brown .  t - time at which to evaluate
37810910c330SBarry Smith .  U - state at which to evaluate
37820e4ef248SJed Brown -  ctx - context
37830e4ef248SJed Brown 
37840e4ef248SJed Brown    Output Arguments:
37850e4ef248SJed Brown +  A - pointer to operator
37860e4ef248SJed Brown .  B - pointer to preconditioning matrix
37870e4ef248SJed Brown -  flg - matrix structure flag
37880e4ef248SJed Brown 
37890e4ef248SJed Brown    Level: intermediate
37900e4ef248SJed Brown 
37910e4ef248SJed Brown    Notes:
37920e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
37930e4ef248SJed Brown 
37940e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
37950e4ef248SJed Brown @*/
3796d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
37970e4ef248SJed Brown {
37980e4ef248SJed Brown   PetscFunctionBegin;
37990e4ef248SJed Brown   PetscFunctionReturn(0);
38000e4ef248SJed Brown }
38010e4ef248SJed Brown 
38020026cea9SSean Farley #undef __FUNCT__
38030026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
38040026cea9SSean Farley /*@C
38050026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
38060026cea9SSean Farley 
38070026cea9SSean Farley    Collective on TS
38080026cea9SSean Farley 
38090026cea9SSean Farley    Input Arguments:
38100026cea9SSean Farley +  ts - time stepping context
38110026cea9SSean Farley .  t - time at which to evaluate
38120910c330SBarry Smith .  U - state at which to evaluate
38130910c330SBarry Smith .  Udot - time derivative of state vector
38140026cea9SSean Farley -  ctx - context
38150026cea9SSean Farley 
38160026cea9SSean Farley    Output Arguments:
38170026cea9SSean Farley .  F - left hand side
38180026cea9SSean Farley 
38190026cea9SSean Farley    Level: intermediate
38200026cea9SSean Farley 
38210026cea9SSean Farley    Notes:
38220910c330SBarry 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
38230026cea9SSean Farley    user is required to write their own TSComputeIFunction.
38240026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
38250026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
38260026cea9SSean Farley 
38270026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
38280026cea9SSean Farley @*/
38290910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
38300026cea9SSean Farley {
38310026cea9SSean Farley   PetscErrorCode ierr;
38320026cea9SSean Farley   Mat            A,B;
38330026cea9SSean Farley 
38340026cea9SSean Farley   PetscFunctionBegin;
38350298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
3836d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
38370910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
38380026cea9SSean Farley   PetscFunctionReturn(0);
38390026cea9SSean Farley }
38400026cea9SSean Farley 
38410026cea9SSean Farley #undef __FUNCT__
38420026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
38430026cea9SSean Farley /*@C
3844b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
38450026cea9SSean Farley 
38460026cea9SSean Farley    Collective on TS
38470026cea9SSean Farley 
38480026cea9SSean Farley    Input Arguments:
38490026cea9SSean Farley +  ts - time stepping context
38500026cea9SSean Farley .  t - time at which to evaluate
38510910c330SBarry Smith .  U - state at which to evaluate
38520910c330SBarry Smith .  Udot - time derivative of state vector
38530026cea9SSean Farley .  shift - shift to apply
38540026cea9SSean Farley -  ctx - context
38550026cea9SSean Farley 
38560026cea9SSean Farley    Output Arguments:
38570026cea9SSean Farley +  A - pointer to operator
38580026cea9SSean Farley .  B - pointer to preconditioning matrix
38590026cea9SSean Farley -  flg - matrix structure flag
38600026cea9SSean Farley 
3861b41af12eSJed Brown    Level: advanced
38620026cea9SSean Farley 
38630026cea9SSean Farley    Notes:
38640026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
38650026cea9SSean Farley 
3866b41af12eSJed Brown    It is only appropriate for problems of the form
3867b41af12eSJed Brown 
3868b41af12eSJed Brown $     M Udot = F(U,t)
3869b41af12eSJed Brown 
3870b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
3871b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
3872b41af12eSJed Brown   an implicit operator of the form
3873b41af12eSJed Brown 
3874b41af12eSJed Brown $    shift*M + J
3875b41af12eSJed Brown 
3876b41af12eSJed 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
3877b41af12eSJed Brown   a copy of M or reassemble it when requested.
3878b41af12eSJed Brown 
38790026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
38800026cea9SSean Farley @*/
3881d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
38820026cea9SSean Farley {
3883b41af12eSJed Brown   PetscErrorCode ierr;
3884b41af12eSJed Brown 
38850026cea9SSean Farley   PetscFunctionBegin;
388694ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
3887b41af12eSJed Brown   ts->ijacobian.shift = shift;
38880026cea9SSean Farley   PetscFunctionReturn(0);
38890026cea9SSean Farley }
3890b41af12eSJed Brown 
3891e817cc15SEmil Constantinescu #undef __FUNCT__
3892e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
3893e817cc15SEmil Constantinescu /*@
3894e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
3895e817cc15SEmil Constantinescu 
3896e817cc15SEmil Constantinescu    Not Collective
3897e817cc15SEmil Constantinescu 
3898e817cc15SEmil Constantinescu    Input Parameter:
3899e817cc15SEmil Constantinescu .  ts - the TS context
3900e817cc15SEmil Constantinescu 
3901e817cc15SEmil Constantinescu    Output Parameter:
39024e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
3903e817cc15SEmil Constantinescu 
3904e817cc15SEmil Constantinescu    Level: beginner
3905e817cc15SEmil Constantinescu 
3906e817cc15SEmil Constantinescu .keywords: TS, equation type
3907e817cc15SEmil Constantinescu 
3908e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
3909e817cc15SEmil Constantinescu @*/
3910e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
3911e817cc15SEmil Constantinescu {
3912e817cc15SEmil Constantinescu   PetscFunctionBegin;
3913e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3914e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
3915e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
3916e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
3917e817cc15SEmil Constantinescu }
3918e817cc15SEmil Constantinescu 
3919e817cc15SEmil Constantinescu #undef __FUNCT__
3920e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
3921e817cc15SEmil Constantinescu /*@
3922e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
3923e817cc15SEmil Constantinescu 
3924e817cc15SEmil Constantinescu    Not Collective
3925e817cc15SEmil Constantinescu 
3926e817cc15SEmil Constantinescu    Input Parameter:
3927e817cc15SEmil Constantinescu +  ts - the TS context
39284e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
3929e817cc15SEmil Constantinescu 
3930e817cc15SEmil Constantinescu    Level: advanced
3931e817cc15SEmil Constantinescu 
3932e817cc15SEmil Constantinescu .keywords: TS, equation type
3933e817cc15SEmil Constantinescu 
3934e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
3935e817cc15SEmil Constantinescu @*/
3936e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
3937e817cc15SEmil Constantinescu {
3938e817cc15SEmil Constantinescu   PetscFunctionBegin;
3939e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3940e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
3941e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
3942e817cc15SEmil Constantinescu }
39430026cea9SSean Farley 
39444af1b03aSJed Brown #undef __FUNCT__
39454af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
39464af1b03aSJed Brown /*@
39474af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
39484af1b03aSJed Brown 
39494af1b03aSJed Brown    Not Collective
39504af1b03aSJed Brown 
39514af1b03aSJed Brown    Input Parameter:
39524af1b03aSJed Brown .  ts - the TS context
39534af1b03aSJed Brown 
39544af1b03aSJed Brown    Output Parameter:
39554af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
39564af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
39574af1b03aSJed Brown 
3958487e0bb9SJed Brown    Level: beginner
39594af1b03aSJed Brown 
3960cd652676SJed Brown    Notes:
3961cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
39624af1b03aSJed Brown 
39634af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
39644af1b03aSJed Brown 
39654af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
39664af1b03aSJed Brown @*/
39674af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
39684af1b03aSJed Brown {
39694af1b03aSJed Brown   PetscFunctionBegin;
39704af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39714af1b03aSJed Brown   PetscValidPointer(reason,2);
39724af1b03aSJed Brown   *reason = ts->reason;
39734af1b03aSJed Brown   PetscFunctionReturn(0);
39744af1b03aSJed Brown }
39754af1b03aSJed Brown 
3976fb1732b5SBarry Smith #undef __FUNCT__
3977d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
3978d6ad946cSShri Abhyankar /*@
3979d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
3980d6ad946cSShri Abhyankar 
3981d6ad946cSShri Abhyankar    Not Collective
3982d6ad946cSShri Abhyankar 
3983d6ad946cSShri Abhyankar    Input Parameter:
3984d6ad946cSShri Abhyankar +  ts - the TS context
3985d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
3986d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
3987d6ad946cSShri Abhyankar 
3988f5abba47SShri Abhyankar    Level: advanced
3989d6ad946cSShri Abhyankar 
3990d6ad946cSShri Abhyankar    Notes:
3991d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
3992d6ad946cSShri Abhyankar 
3993d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
3994d6ad946cSShri Abhyankar 
3995d6ad946cSShri Abhyankar .seealso: TSConvergedReason
3996d6ad946cSShri Abhyankar @*/
3997d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
3998d6ad946cSShri Abhyankar {
3999d6ad946cSShri Abhyankar   PetscFunctionBegin;
4000d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4001d6ad946cSShri Abhyankar   ts->reason = reason;
4002d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4003d6ad946cSShri Abhyankar }
4004d6ad946cSShri Abhyankar 
4005d6ad946cSShri Abhyankar #undef __FUNCT__
4006cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4007cc708dedSBarry Smith /*@
4008cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4009cc708dedSBarry Smith 
4010cc708dedSBarry Smith    Not Collective
4011cc708dedSBarry Smith 
4012cc708dedSBarry Smith    Input Parameter:
4013cc708dedSBarry Smith .  ts - the TS context
4014cc708dedSBarry Smith 
4015cc708dedSBarry Smith    Output Parameter:
4016cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4017cc708dedSBarry Smith 
4018487e0bb9SJed Brown    Level: beginner
4019cc708dedSBarry Smith 
4020cc708dedSBarry Smith    Notes:
4021cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4022cc708dedSBarry Smith 
4023cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4024cc708dedSBarry Smith 
4025cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4026cc708dedSBarry Smith @*/
4027cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4028cc708dedSBarry Smith {
4029cc708dedSBarry Smith   PetscFunctionBegin;
4030cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4031cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4032cc708dedSBarry Smith   *ftime = ts->solvetime;
4033cc708dedSBarry Smith   PetscFunctionReturn(0);
4034cc708dedSBarry Smith }
4035cc708dedSBarry Smith 
4036cc708dedSBarry Smith #undef __FUNCT__
40375ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
40389f67acb7SJed Brown /*@
40395ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
40409f67acb7SJed Brown    used by the time integrator.
40419f67acb7SJed Brown 
40429f67acb7SJed Brown    Not Collective
40439f67acb7SJed Brown 
40449f67acb7SJed Brown    Input Parameter:
40459f67acb7SJed Brown .  ts - TS context
40469f67acb7SJed Brown 
40479f67acb7SJed Brown    Output Parameter:
40489f67acb7SJed Brown .  nits - number of nonlinear iterations
40499f67acb7SJed Brown 
40509f67acb7SJed Brown    Notes:
40519f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
40529f67acb7SJed Brown 
40539f67acb7SJed Brown    Level: intermediate
40549f67acb7SJed Brown 
40559f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
40569f67acb7SJed Brown 
40575ef26d82SJed Brown .seealso:  TSGetKSPIterations()
40589f67acb7SJed Brown @*/
40595ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
40609f67acb7SJed Brown {
40619f67acb7SJed Brown   PetscFunctionBegin;
40629f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40639f67acb7SJed Brown   PetscValidIntPointer(nits,2);
40645ef26d82SJed Brown   *nits = ts->snes_its;
40659f67acb7SJed Brown   PetscFunctionReturn(0);
40669f67acb7SJed Brown }
40679f67acb7SJed Brown 
40689f67acb7SJed Brown #undef __FUNCT__
40695ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
40709f67acb7SJed Brown /*@
40715ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
40729f67acb7SJed Brown    used by the time integrator.
40739f67acb7SJed Brown 
40749f67acb7SJed Brown    Not Collective
40759f67acb7SJed Brown 
40769f67acb7SJed Brown    Input Parameter:
40779f67acb7SJed Brown .  ts - TS context
40789f67acb7SJed Brown 
40799f67acb7SJed Brown    Output Parameter:
40809f67acb7SJed Brown .  lits - number of linear iterations
40819f67acb7SJed Brown 
40829f67acb7SJed Brown    Notes:
40839f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
40849f67acb7SJed Brown 
40859f67acb7SJed Brown    Level: intermediate
40869f67acb7SJed Brown 
40879f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
40889f67acb7SJed Brown 
40895ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
40909f67acb7SJed Brown @*/
40915ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
40929f67acb7SJed Brown {
40939f67acb7SJed Brown   PetscFunctionBegin;
40949f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40959f67acb7SJed Brown   PetscValidIntPointer(lits,2);
40965ef26d82SJed Brown   *lits = ts->ksp_its;
40979f67acb7SJed Brown   PetscFunctionReturn(0);
40989f67acb7SJed Brown }
40999f67acb7SJed Brown 
41009f67acb7SJed Brown #undef __FUNCT__
4101cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4102cef5090cSJed Brown /*@
4103cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4104cef5090cSJed Brown 
4105cef5090cSJed Brown    Not Collective
4106cef5090cSJed Brown 
4107cef5090cSJed Brown    Input Parameter:
4108cef5090cSJed Brown .  ts - TS context
4109cef5090cSJed Brown 
4110cef5090cSJed Brown    Output Parameter:
4111cef5090cSJed Brown .  rejects - number of steps rejected
4112cef5090cSJed Brown 
4113cef5090cSJed Brown    Notes:
4114cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4115cef5090cSJed Brown 
4116cef5090cSJed Brown    Level: intermediate
4117cef5090cSJed Brown 
4118cef5090cSJed Brown .keywords: TS, get, number
4119cef5090cSJed Brown 
41205ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4121cef5090cSJed Brown @*/
4122cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4123cef5090cSJed Brown {
4124cef5090cSJed Brown   PetscFunctionBegin;
4125cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4126cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4127cef5090cSJed Brown   *rejects = ts->reject;
4128cef5090cSJed Brown   PetscFunctionReturn(0);
4129cef5090cSJed Brown }
4130cef5090cSJed Brown 
4131cef5090cSJed Brown #undef __FUNCT__
4132cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4133cef5090cSJed Brown /*@
4134cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4135cef5090cSJed Brown 
4136cef5090cSJed Brown    Not Collective
4137cef5090cSJed Brown 
4138cef5090cSJed Brown    Input Parameter:
4139cef5090cSJed Brown .  ts - TS context
4140cef5090cSJed Brown 
4141cef5090cSJed Brown    Output Parameter:
4142cef5090cSJed Brown .  fails - number of failed nonlinear solves
4143cef5090cSJed Brown 
4144cef5090cSJed Brown    Notes:
4145cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4146cef5090cSJed Brown 
4147cef5090cSJed Brown    Level: intermediate
4148cef5090cSJed Brown 
4149cef5090cSJed Brown .keywords: TS, get, number
4150cef5090cSJed Brown 
41515ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4152cef5090cSJed Brown @*/
4153cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4154cef5090cSJed Brown {
4155cef5090cSJed Brown   PetscFunctionBegin;
4156cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4157cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4158cef5090cSJed Brown   *fails = ts->num_snes_failures;
4159cef5090cSJed Brown   PetscFunctionReturn(0);
4160cef5090cSJed Brown }
4161cef5090cSJed Brown 
4162cef5090cSJed Brown #undef __FUNCT__
4163cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4164cef5090cSJed Brown /*@
4165cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4166cef5090cSJed Brown 
4167cef5090cSJed Brown    Not Collective
4168cef5090cSJed Brown 
4169cef5090cSJed Brown    Input Parameter:
4170cef5090cSJed Brown +  ts - TS context
4171cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4172cef5090cSJed Brown 
4173cef5090cSJed Brown    Notes:
4174cef5090cSJed Brown    The counter is reset to zero for each step
4175cef5090cSJed Brown 
4176cef5090cSJed Brown    Options Database Key:
4177cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4178cef5090cSJed Brown 
4179cef5090cSJed Brown    Level: intermediate
4180cef5090cSJed Brown 
4181cef5090cSJed Brown .keywords: TS, set, maximum, number
4182cef5090cSJed Brown 
41835ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4184cef5090cSJed Brown @*/
4185cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4186cef5090cSJed Brown {
4187cef5090cSJed Brown   PetscFunctionBegin;
4188cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4189cef5090cSJed Brown   ts->max_reject = rejects;
4190cef5090cSJed Brown   PetscFunctionReturn(0);
4191cef5090cSJed Brown }
4192cef5090cSJed Brown 
4193cef5090cSJed Brown #undef __FUNCT__
4194cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4195cef5090cSJed Brown /*@
4196cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4197cef5090cSJed Brown 
4198cef5090cSJed Brown    Not Collective
4199cef5090cSJed Brown 
4200cef5090cSJed Brown    Input Parameter:
4201cef5090cSJed Brown +  ts - TS context
4202cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4203cef5090cSJed Brown 
4204cef5090cSJed Brown    Notes:
4205cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4206cef5090cSJed Brown 
4207cef5090cSJed Brown    Options Database Key:
4208cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4209cef5090cSJed Brown 
4210cef5090cSJed Brown    Level: intermediate
4211cef5090cSJed Brown 
4212cef5090cSJed Brown .keywords: TS, set, maximum, number
4213cef5090cSJed Brown 
42145ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4215cef5090cSJed Brown @*/
4216cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4217cef5090cSJed Brown {
4218cef5090cSJed Brown   PetscFunctionBegin;
4219cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4220cef5090cSJed Brown   ts->max_snes_failures = fails;
4221cef5090cSJed Brown   PetscFunctionReturn(0);
4222cef5090cSJed Brown }
4223cef5090cSJed Brown 
4224cef5090cSJed Brown #undef __FUNCT__
42254e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4226cef5090cSJed Brown /*@
4227cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4228cef5090cSJed Brown 
4229cef5090cSJed Brown    Not Collective
4230cef5090cSJed Brown 
4231cef5090cSJed Brown    Input Parameter:
4232cef5090cSJed Brown +  ts - TS context
4233cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4234cef5090cSJed Brown 
4235cef5090cSJed Brown    Options Database Key:
4236cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4237cef5090cSJed Brown 
4238cef5090cSJed Brown    Level: intermediate
4239cef5090cSJed Brown 
4240cef5090cSJed Brown .keywords: TS, set, error
4241cef5090cSJed Brown 
42425ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4243cef5090cSJed Brown @*/
4244cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4245cef5090cSJed Brown {
4246cef5090cSJed Brown   PetscFunctionBegin;
4247cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4248cef5090cSJed Brown   ts->errorifstepfailed = err;
4249cef5090cSJed Brown   PetscFunctionReturn(0);
4250cef5090cSJed Brown }
4251cef5090cSJed Brown 
4252cef5090cSJed Brown #undef __FUNCT__
4253fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4254fb1732b5SBarry Smith /*@C
4255fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4256fb1732b5SBarry Smith 
4257fb1732b5SBarry Smith    Collective on TS
4258fb1732b5SBarry Smith 
4259fb1732b5SBarry Smith    Input Parameters:
4260fb1732b5SBarry Smith +  ts - the TS context
4261fb1732b5SBarry Smith .  step - current time-step
4262fb1732b5SBarry Smith .  ptime - current time
42630910c330SBarry Smith .  u - current state
4264fb1732b5SBarry Smith -  viewer - binary viewer
4265fb1732b5SBarry Smith 
4266fb1732b5SBarry Smith    Level: intermediate
4267fb1732b5SBarry Smith 
4268fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4269fb1732b5SBarry Smith 
4270fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4271fb1732b5SBarry Smith @*/
42720910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4273fb1732b5SBarry Smith {
4274fb1732b5SBarry Smith   PetscErrorCode ierr;
4275ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4276fb1732b5SBarry Smith 
4277fb1732b5SBarry Smith   PetscFunctionBegin;
42780910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4279ed81e22dSJed Brown   PetscFunctionReturn(0);
4280ed81e22dSJed Brown }
4281ed81e22dSJed Brown 
4282ed81e22dSJed Brown #undef __FUNCT__
4283ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4284ed81e22dSJed Brown /*@C
4285ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4286ed81e22dSJed Brown 
4287ed81e22dSJed Brown    Collective on TS
4288ed81e22dSJed Brown 
4289ed81e22dSJed Brown    Input Parameters:
4290ed81e22dSJed Brown +  ts - the TS context
4291ed81e22dSJed Brown .  step - current time-step
4292ed81e22dSJed Brown .  ptime - current time
42930910c330SBarry Smith .  u - current state
4294ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4295ed81e22dSJed Brown 
4296ed81e22dSJed Brown    Level: intermediate
4297ed81e22dSJed Brown 
4298ed81e22dSJed Brown    Notes:
4299ed81e22dSJed 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.
4300ed81e22dSJed Brown    These are named according to the file name template.
4301ed81e22dSJed Brown 
4302ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4303ed81e22dSJed Brown 
4304ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4305ed81e22dSJed Brown 
4306ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4307ed81e22dSJed Brown @*/
43080910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4309ed81e22dSJed Brown {
4310ed81e22dSJed Brown   PetscErrorCode ierr;
4311ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4312ed81e22dSJed Brown   PetscViewer    viewer;
4313ed81e22dSJed Brown 
4314ed81e22dSJed Brown   PetscFunctionBegin;
43158caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4316ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
43170910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4318ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4319ed81e22dSJed Brown   PetscFunctionReturn(0);
4320ed81e22dSJed Brown }
4321ed81e22dSJed Brown 
4322ed81e22dSJed Brown #undef __FUNCT__
4323ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4324ed81e22dSJed Brown /*@C
4325ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4326ed81e22dSJed Brown 
4327ed81e22dSJed Brown    Collective on TS
4328ed81e22dSJed Brown 
4329ed81e22dSJed Brown    Input Parameters:
4330ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4331ed81e22dSJed Brown 
4332ed81e22dSJed Brown    Level: intermediate
4333ed81e22dSJed Brown 
4334ed81e22dSJed Brown    Note:
4335ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4336ed81e22dSJed Brown 
4337ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4338ed81e22dSJed Brown 
4339ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4340ed81e22dSJed Brown @*/
4341ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4342ed81e22dSJed Brown {
4343ed81e22dSJed Brown   PetscErrorCode ierr;
4344ed81e22dSJed Brown 
4345ed81e22dSJed Brown   PetscFunctionBegin;
4346ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4347fb1732b5SBarry Smith   PetscFunctionReturn(0);
4348fb1732b5SBarry Smith }
4349fb1732b5SBarry Smith 
435084df9cb4SJed Brown #undef __FUNCT__
4351552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
435284df9cb4SJed Brown /*@
4353552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
435484df9cb4SJed Brown 
4355ed81e22dSJed Brown    Collective on TS if controller has not been created yet
435684df9cb4SJed Brown 
435784df9cb4SJed Brown    Input Arguments:
4358ed81e22dSJed Brown .  ts - time stepping context
435984df9cb4SJed Brown 
436084df9cb4SJed Brown    Output Arguments:
4361ed81e22dSJed Brown .  adapt - adaptive controller
436284df9cb4SJed Brown 
436384df9cb4SJed Brown    Level: intermediate
436484df9cb4SJed Brown 
4365ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
436684df9cb4SJed Brown @*/
4367552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
436884df9cb4SJed Brown {
436984df9cb4SJed Brown   PetscErrorCode ierr;
437084df9cb4SJed Brown 
437184df9cb4SJed Brown   PetscFunctionBegin;
437284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
437384df9cb4SJed Brown   PetscValidPointer(adapt,2);
437484df9cb4SJed Brown   if (!ts->adapt) {
4375ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
43763bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
43771c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
437884df9cb4SJed Brown   }
437984df9cb4SJed Brown   *adapt = ts->adapt;
438084df9cb4SJed Brown   PetscFunctionReturn(0);
438184df9cb4SJed Brown }
4382d6ebe24aSShri Abhyankar 
4383d6ebe24aSShri Abhyankar #undef __FUNCT__
43841c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
43851c3436cfSJed Brown /*@
43861c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
43871c3436cfSJed Brown 
43881c3436cfSJed Brown    Logically Collective
43891c3436cfSJed Brown 
43901c3436cfSJed Brown    Input Arguments:
43911c3436cfSJed Brown +  ts - time integration context
43921c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
43930298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
43941c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
43950298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
43961c3436cfSJed Brown 
4397a3cdaa26SBarry Smith    Options Database keys:
4398a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4399a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4400a3cdaa26SBarry Smith 
44011c3436cfSJed Brown    Level: beginner
44021c3436cfSJed Brown 
4403c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
44041c3436cfSJed Brown @*/
44051c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
44061c3436cfSJed Brown {
44071c3436cfSJed Brown   PetscErrorCode ierr;
44081c3436cfSJed Brown 
44091c3436cfSJed Brown   PetscFunctionBegin;
4410c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
44111c3436cfSJed Brown   if (vatol) {
44121c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
44131c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4414bbd56ea5SKarl Rupp 
44151c3436cfSJed Brown     ts->vatol = vatol;
44161c3436cfSJed Brown   }
4417c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
44181c3436cfSJed Brown   if (vrtol) {
44191c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
44201c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4421bbd56ea5SKarl Rupp 
44221c3436cfSJed Brown     ts->vrtol = vrtol;
44231c3436cfSJed Brown   }
44241c3436cfSJed Brown   PetscFunctionReturn(0);
44251c3436cfSJed Brown }
44261c3436cfSJed Brown 
44271c3436cfSJed Brown #undef __FUNCT__
4428c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4429c5033834SJed Brown /*@
4430c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4431c5033834SJed Brown 
4432c5033834SJed Brown    Logically Collective
4433c5033834SJed Brown 
4434c5033834SJed Brown    Input Arguments:
4435c5033834SJed Brown .  ts - time integration context
4436c5033834SJed Brown 
4437c5033834SJed Brown    Output Arguments:
44380298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
44390298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
44400298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
44410298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4442c5033834SJed Brown 
4443c5033834SJed Brown    Level: beginner
4444c5033834SJed Brown 
4445c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4446c5033834SJed Brown @*/
4447c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4448c5033834SJed Brown {
4449c5033834SJed Brown   PetscFunctionBegin;
4450c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4451c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4452c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4453c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4454c5033834SJed Brown   PetscFunctionReturn(0);
4455c5033834SJed Brown }
4456c5033834SJed Brown 
4457c5033834SJed Brown #undef __FUNCT__
44581c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
44591c3436cfSJed Brown /*@
44601c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
44611c3436cfSJed Brown 
44621c3436cfSJed Brown    Collective on TS
44631c3436cfSJed Brown 
44641c3436cfSJed Brown    Input Arguments:
44651c3436cfSJed Brown +  ts - time stepping context
44661c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
44671c3436cfSJed Brown 
44681c3436cfSJed Brown    Output Arguments:
44691c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
44701c3436cfSJed Brown 
44711c3436cfSJed Brown    Level: developer
44721c3436cfSJed Brown 
44731c3436cfSJed Brown .seealso: TSSetTolerances()
44741c3436cfSJed Brown @*/
44751c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
44761c3436cfSJed Brown {
44771c3436cfSJed Brown   PetscErrorCode    ierr;
44781c3436cfSJed Brown   PetscInt          i,n,N;
44790910c330SBarry Smith   const PetscScalar *u,*y;
44800910c330SBarry Smith   Vec               U;
44811c3436cfSJed Brown   PetscReal         sum,gsum;
44821c3436cfSJed Brown 
44831c3436cfSJed Brown   PetscFunctionBegin;
44841c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44851c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
44861c3436cfSJed Brown   PetscValidPointer(norm,3);
44870910c330SBarry Smith   U = ts->vec_sol;
44880910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
4489ce94432eSBarry Smith   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
44901c3436cfSJed Brown 
44910910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
44920910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
44930910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
44941c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
44951c3436cfSJed Brown   sum  = 0.;
4496ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
4497ceefc113SJed Brown     const PetscScalar *atol,*rtol;
4498ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4499ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4500ceefc113SJed Brown     for (i=0; i<n; i++) {
45010910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
45020910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4503ceefc113SJed Brown     }
4504ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4505ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4506ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4507ceefc113SJed Brown     const PetscScalar *atol;
4508ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4509ceefc113SJed Brown     for (i=0; i<n; i++) {
45100910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
45110910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4512ceefc113SJed Brown     }
4513ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4514ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4515ceefc113SJed Brown     const PetscScalar *rtol;
4516ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4517ceefc113SJed Brown     for (i=0; i<n; i++) {
45180910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
45190910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4520ceefc113SJed Brown     }
4521ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4522ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
45231c3436cfSJed Brown     for (i=0; i<n; i++) {
45240910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
45250910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
45261c3436cfSJed Brown     }
4527ceefc113SJed Brown   }
45280910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
45291c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
45301c3436cfSJed Brown 
4531ce94432eSBarry Smith   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
45321c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
4533620fc8aaSSatish Balay   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
45341c3436cfSJed Brown   PetscFunctionReturn(0);
45351c3436cfSJed Brown }
45361c3436cfSJed Brown 
45371c3436cfSJed Brown #undef __FUNCT__
45388d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
45398d59e960SJed Brown /*@
45408d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
45418d59e960SJed Brown 
45428d59e960SJed Brown    Logically Collective on TS
45438d59e960SJed Brown 
45448d59e960SJed Brown    Input Arguments:
45458d59e960SJed Brown +  ts - time stepping context
45468d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
45478d59e960SJed Brown 
45488d59e960SJed Brown    Note:
45498d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
45508d59e960SJed Brown 
45518d59e960SJed Brown    Level: intermediate
45528d59e960SJed Brown 
45538d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
45548d59e960SJed Brown @*/
45558d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
45568d59e960SJed Brown {
45578d59e960SJed Brown   PetscFunctionBegin;
45588d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45598d59e960SJed Brown   ts->cfltime_local = cfltime;
45608d59e960SJed Brown   ts->cfltime       = -1.;
45618d59e960SJed Brown   PetscFunctionReturn(0);
45628d59e960SJed Brown }
45638d59e960SJed Brown 
45648d59e960SJed Brown #undef __FUNCT__
45658d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
45668d59e960SJed Brown /*@
45678d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
45688d59e960SJed Brown 
45698d59e960SJed Brown    Collective on TS
45708d59e960SJed Brown 
45718d59e960SJed Brown    Input Arguments:
45728d59e960SJed Brown .  ts - time stepping context
45738d59e960SJed Brown 
45748d59e960SJed Brown    Output Arguments:
45758d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
45768d59e960SJed Brown 
45778d59e960SJed Brown    Level: advanced
45788d59e960SJed Brown 
45798d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
45808d59e960SJed Brown @*/
45818d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
45828d59e960SJed Brown {
45838d59e960SJed Brown   PetscErrorCode ierr;
45848d59e960SJed Brown 
45858d59e960SJed Brown   PetscFunctionBegin;
45868d59e960SJed Brown   if (ts->cfltime < 0) {
4587ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
45888d59e960SJed Brown   }
45898d59e960SJed Brown   *cfltime = ts->cfltime;
45908d59e960SJed Brown   PetscFunctionReturn(0);
45918d59e960SJed Brown }
45928d59e960SJed Brown 
45938d59e960SJed Brown #undef __FUNCT__
4594d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
4595d6ebe24aSShri Abhyankar /*@
4596d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
4597d6ebe24aSShri Abhyankar 
4598d6ebe24aSShri Abhyankar    Input Parameters:
4599d6ebe24aSShri Abhyankar .  ts   - the TS context.
4600d6ebe24aSShri Abhyankar .  xl   - lower bound.
4601d6ebe24aSShri Abhyankar .  xu   - upper bound.
4602d6ebe24aSShri Abhyankar 
4603d6ebe24aSShri Abhyankar    Notes:
4604d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
4605e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
4606d6ebe24aSShri Abhyankar 
46072bd2b0e6SSatish Balay    Level: advanced
46082bd2b0e6SSatish Balay 
4609d6ebe24aSShri Abhyankar @*/
4610d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
4611d6ebe24aSShri Abhyankar {
4612d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
4613d6ebe24aSShri Abhyankar   SNES           snes;
4614d6ebe24aSShri Abhyankar 
4615d6ebe24aSShri Abhyankar   PetscFunctionBegin;
4616d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4617d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
4618d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
4619d6ebe24aSShri Abhyankar }
4620d6ebe24aSShri Abhyankar 
4621325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4622c6db04a5SJed Brown #include <mex.h>
4623325fc9f4SBarry Smith 
4624325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
4625325fc9f4SBarry Smith 
4626325fc9f4SBarry Smith #undef __FUNCT__
4627325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
4628325fc9f4SBarry Smith /*
4629325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
4630325fc9f4SBarry Smith                          TSSetFunctionMatlab().
4631325fc9f4SBarry Smith 
4632325fc9f4SBarry Smith    Collective on TS
4633325fc9f4SBarry Smith 
4634325fc9f4SBarry Smith    Input Parameters:
4635325fc9f4SBarry Smith +  snes - the TS context
46360910c330SBarry Smith -  u - input vector
4637325fc9f4SBarry Smith 
4638325fc9f4SBarry Smith    Output Parameter:
4639325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
4640325fc9f4SBarry Smith 
4641325fc9f4SBarry Smith    Notes:
4642325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
4643325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
4644325fc9f4SBarry Smith    themselves.
4645325fc9f4SBarry Smith 
4646325fc9f4SBarry Smith    Level: developer
4647325fc9f4SBarry Smith 
4648325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4649325fc9f4SBarry Smith 
4650325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4651325fc9f4SBarry Smith */
46520910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
4653325fc9f4SBarry Smith {
4654325fc9f4SBarry Smith   PetscErrorCode  ierr;
4655325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4656325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
4657325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
4658325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
4659325fc9f4SBarry Smith 
4660325fc9f4SBarry Smith   PetscFunctionBegin;
4661325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
46620910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
46630910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
4664325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
46650910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
4666325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
4667325fc9f4SBarry Smith 
4668325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
46690910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
46700910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
46710910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
4672bbd56ea5SKarl Rupp 
4673325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4674325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
4675325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4676325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4677325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
4678325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
4679325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
4680325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
4681325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4682325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4683325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4684325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4685325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4686325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4687325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4688325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4689325fc9f4SBarry Smith   PetscFunctionReturn(0);
4690325fc9f4SBarry Smith }
4691325fc9f4SBarry Smith 
4692325fc9f4SBarry Smith 
4693325fc9f4SBarry Smith #undef __FUNCT__
4694325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
4695325fc9f4SBarry Smith /*
4696325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
4697325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
4698e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
4699325fc9f4SBarry Smith 
4700325fc9f4SBarry Smith    Logically Collective on TS
4701325fc9f4SBarry Smith 
4702325fc9f4SBarry Smith    Input Parameters:
4703325fc9f4SBarry Smith +  ts - the TS context
4704325fc9f4SBarry Smith -  func - function evaluation routine
4705325fc9f4SBarry Smith 
4706325fc9f4SBarry Smith    Calling sequence of func:
47070910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
4708325fc9f4SBarry Smith 
4709325fc9f4SBarry Smith    Level: beginner
4710325fc9f4SBarry Smith 
4711325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4712325fc9f4SBarry Smith 
4713325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4714325fc9f4SBarry Smith */
4715cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
4716325fc9f4SBarry Smith {
4717325fc9f4SBarry Smith   PetscErrorCode  ierr;
4718325fc9f4SBarry Smith   TSMatlabContext *sctx;
4719325fc9f4SBarry Smith 
4720325fc9f4SBarry Smith   PetscFunctionBegin;
4721325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4722325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4723325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4724325fc9f4SBarry Smith   /*
4725325fc9f4SBarry Smith      This should work, but it doesn't
4726325fc9f4SBarry Smith   sctx->ctx = ctx;
4727325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4728325fc9f4SBarry Smith   */
4729325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4730bbd56ea5SKarl Rupp 
47310298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
4732325fc9f4SBarry Smith   PetscFunctionReturn(0);
4733325fc9f4SBarry Smith }
4734325fc9f4SBarry Smith 
4735325fc9f4SBarry Smith #undef __FUNCT__
4736325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
4737325fc9f4SBarry Smith /*
4738325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
4739325fc9f4SBarry Smith                          TSSetJacobianMatlab().
4740325fc9f4SBarry Smith 
4741325fc9f4SBarry Smith    Collective on TS
4742325fc9f4SBarry Smith 
4743325fc9f4SBarry Smith    Input Parameters:
4744cdcf91faSSean Farley +  ts - the TS context
47450910c330SBarry Smith .  u - input vector
4746325fc9f4SBarry Smith .  A, B - the matrices
4747325fc9f4SBarry Smith -  ctx - user context
4748325fc9f4SBarry Smith 
4749325fc9f4SBarry Smith    Level: developer
4750325fc9f4SBarry Smith 
4751325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4752325fc9f4SBarry Smith 
4753325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4754325fc9f4SBarry Smith @*/
4755f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
4756325fc9f4SBarry Smith {
4757325fc9f4SBarry Smith   PetscErrorCode  ierr;
4758325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4759325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
4760325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
4761325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
4762325fc9f4SBarry Smith 
4763325fc9f4SBarry Smith   PetscFunctionBegin;
4764cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47650910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
4766325fc9f4SBarry Smith 
47670910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
4768325fc9f4SBarry Smith 
4769cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
47700910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
47710910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
47720910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
47730910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
4774bbd56ea5SKarl Rupp 
4775325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4776325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
4777325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4778325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4779325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
4780325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
4781325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
4782325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
4783325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
4784325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
4785325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4786325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4787325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4788325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4789325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4790325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4791325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4792325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
4793325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
4794325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4795325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
4796325fc9f4SBarry Smith   PetscFunctionReturn(0);
4797325fc9f4SBarry Smith }
4798325fc9f4SBarry Smith 
4799325fc9f4SBarry Smith 
4800325fc9f4SBarry Smith #undef __FUNCT__
4801325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
4802325fc9f4SBarry Smith /*
4803325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
4804e3c5b3baSBarry 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
4805325fc9f4SBarry Smith 
4806325fc9f4SBarry Smith    Logically Collective on TS
4807325fc9f4SBarry Smith 
4808325fc9f4SBarry Smith    Input Parameters:
4809cdcf91faSSean Farley +  ts - the TS context
4810325fc9f4SBarry Smith .  A,B - Jacobian matrices
4811325fc9f4SBarry Smith .  func - function evaluation routine
4812325fc9f4SBarry Smith -  ctx - user context
4813325fc9f4SBarry Smith 
4814325fc9f4SBarry Smith    Calling sequence of func:
48150910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
4816325fc9f4SBarry Smith 
4817325fc9f4SBarry Smith 
4818325fc9f4SBarry Smith    Level: developer
4819325fc9f4SBarry Smith 
4820325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4821325fc9f4SBarry Smith 
4822325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4823325fc9f4SBarry Smith */
4824cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
4825325fc9f4SBarry Smith {
4826325fc9f4SBarry Smith   PetscErrorCode  ierr;
4827325fc9f4SBarry Smith   TSMatlabContext *sctx;
4828325fc9f4SBarry Smith 
4829325fc9f4SBarry Smith   PetscFunctionBegin;
4830325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4831325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4832325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4833325fc9f4SBarry Smith   /*
4834325fc9f4SBarry Smith      This should work, but it doesn't
4835325fc9f4SBarry Smith   sctx->ctx = ctx;
4836325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4837325fc9f4SBarry Smith   */
4838325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4839bbd56ea5SKarl Rupp 
4840cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
4841325fc9f4SBarry Smith   PetscFunctionReturn(0);
4842325fc9f4SBarry Smith }
4843325fc9f4SBarry Smith 
4844b5b1a830SBarry Smith #undef __FUNCT__
4845b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
4846b5b1a830SBarry Smith /*
4847b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
4848b5b1a830SBarry Smith 
4849b5b1a830SBarry Smith    Collective on TS
4850b5b1a830SBarry Smith 
4851b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4852b5b1a830SBarry Smith @*/
48530910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
4854b5b1a830SBarry Smith {
4855b5b1a830SBarry Smith   PetscErrorCode  ierr;
4856b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4857a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
4858b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
4859b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
4860b5b1a830SBarry Smith 
4861b5b1a830SBarry Smith   PetscFunctionBegin;
4862cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48630910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4864b5b1a830SBarry Smith 
4865cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
48660910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
4867bbd56ea5SKarl Rupp 
4868b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4869b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
4870b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
4871b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
4872b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
4873b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
4874b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
4875b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4876b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
4877b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
4878b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
4879b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
4880b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
4881b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
4882b5b1a830SBarry Smith   PetscFunctionReturn(0);
4883b5b1a830SBarry Smith }
4884b5b1a830SBarry Smith 
4885b5b1a830SBarry Smith 
4886b5b1a830SBarry Smith #undef __FUNCT__
4887b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
4888b5b1a830SBarry Smith /*
4889b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
4890b5b1a830SBarry Smith 
4891b5b1a830SBarry Smith    Level: developer
4892b5b1a830SBarry Smith 
4893b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
4894b5b1a830SBarry Smith 
4895b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4896b5b1a830SBarry Smith */
4897cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
4898b5b1a830SBarry Smith {
4899b5b1a830SBarry Smith   PetscErrorCode  ierr;
4900b5b1a830SBarry Smith   TSMatlabContext *sctx;
4901b5b1a830SBarry Smith 
4902b5b1a830SBarry Smith   PetscFunctionBegin;
4903b5b1a830SBarry Smith   /* currently sctx is memory bleed */
4904b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4905b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4906b5b1a830SBarry Smith   /*
4907b5b1a830SBarry Smith      This should work, but it doesn't
4908b5b1a830SBarry Smith   sctx->ctx = ctx;
4909b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4910b5b1a830SBarry Smith   */
4911b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4912bbd56ea5SKarl Rupp 
49130298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
4914b5b1a830SBarry Smith   PetscFunctionReturn(0);
4915b5b1a830SBarry Smith }
4916325fc9f4SBarry Smith #endif
4917b3603a34SBarry Smith 
49180b039ecaSBarry Smith 
49190b039ecaSBarry Smith 
4920b3603a34SBarry Smith #undef __FUNCT__
49214f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
4922b3603a34SBarry Smith /*@C
49234f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
4924b3603a34SBarry Smith        in a time based line graph
4925b3603a34SBarry Smith 
4926b3603a34SBarry Smith    Collective on TS
4927b3603a34SBarry Smith 
4928b3603a34SBarry Smith    Input Parameters:
4929b3603a34SBarry Smith +  ts - the TS context
4930b3603a34SBarry Smith .  step - current time-step
4931b3603a34SBarry Smith .  ptime - current time
4932b3603a34SBarry Smith -  lg - a line graph object
4933b3603a34SBarry Smith 
4934b3603a34SBarry Smith    Level: intermediate
4935b3603a34SBarry Smith 
49360b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
4937b3603a34SBarry Smith 
4938b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
4939b3603a34SBarry Smith 
4940b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4941b3603a34SBarry Smith @*/
49420910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
4943b3603a34SBarry Smith {
4944b3603a34SBarry Smith   PetscErrorCode    ierr;
49450b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
4946b3603a34SBarry Smith   const PetscScalar *yy;
494758ff32f7SBarry Smith   PetscInt          dim;
4948b3603a34SBarry Smith 
4949b3603a34SBarry Smith   PetscFunctionBegin;
495058ff32f7SBarry Smith   if (!step) {
4951a9f9c1f6SBarry Smith     PetscDrawAxis axis;
4952a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
4953a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
49540910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
49550b039ecaSBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
49560b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
495758ff32f7SBarry Smith   }
49580910c330SBarry Smith   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
4959e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
4960e3efe391SJed Brown   {
4961e3efe391SJed Brown     PetscReal *yreal;
4962e3efe391SJed Brown     PetscInt  i,n;
49630910c330SBarry Smith     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
4964785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
4965e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
49660b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
4967e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
4968e3efe391SJed Brown   }
4969e3efe391SJed Brown #else
49700b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
4971e3efe391SJed Brown #endif
49720910c330SBarry Smith   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
4973b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
49740b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
49753923b477SBarry Smith   }
4976b3603a34SBarry Smith   PetscFunctionReturn(0);
4977b3603a34SBarry Smith }
4978b3603a34SBarry Smith 
4979b3603a34SBarry Smith #undef __FUNCT__
49804f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
4981ef20d060SBarry Smith /*@C
49824f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
4983ef20d060SBarry Smith        in a time based line graph
4984ef20d060SBarry Smith 
4985ef20d060SBarry Smith    Collective on TS
4986ef20d060SBarry Smith 
4987ef20d060SBarry Smith    Input Parameters:
4988ef20d060SBarry Smith +  ts - the TS context
4989ef20d060SBarry Smith .  step - current time-step
4990ef20d060SBarry Smith .  ptime - current time
4991ef20d060SBarry Smith -  lg - a line graph object
4992ef20d060SBarry Smith 
4993ef20d060SBarry Smith    Level: intermediate
4994ef20d060SBarry Smith 
4995abd5a294SJed Brown    Notes:
4996abd5a294SJed Brown    Only for sequential solves.
4997abd5a294SJed Brown 
4998abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
4999abd5a294SJed Brown 
5000abd5a294SJed Brown    Options Database Keys:
50014f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
5002ef20d060SBarry Smith 
5003ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
5004ef20d060SBarry Smith 
5005abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5006ef20d060SBarry Smith @*/
50070910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5008ef20d060SBarry Smith {
5009ef20d060SBarry Smith   PetscErrorCode    ierr;
50100b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5011ef20d060SBarry Smith   const PetscScalar *yy;
5012ef20d060SBarry Smith   Vec               y;
5013a9f9c1f6SBarry Smith   PetscInt          dim;
5014ef20d060SBarry Smith 
5015ef20d060SBarry Smith   PetscFunctionBegin;
5016a9f9c1f6SBarry Smith   if (!step) {
5017a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5018a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
50191ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
50200910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5021a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5022a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5023a9f9c1f6SBarry Smith   }
50240910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5025ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
50260910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5027ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5028e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5029e3efe391SJed Brown   {
5030e3efe391SJed Brown     PetscReal *yreal;
5031e3efe391SJed Brown     PetscInt  i,n;
5032e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5033785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5034e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
50350b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5036e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5037e3efe391SJed Brown   }
5038e3efe391SJed Brown #else
50390b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5040e3efe391SJed Brown #endif
5041ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5042ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
5043b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
50440b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
50453923b477SBarry Smith   }
5046ef20d060SBarry Smith   PetscFunctionReturn(0);
5047ef20d060SBarry Smith }
5048ef20d060SBarry Smith 
5049201da799SBarry Smith #undef __FUNCT__
5050201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
5051201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5052201da799SBarry Smith {
5053201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5054201da799SBarry Smith   PetscReal      x   = ptime,y;
5055201da799SBarry Smith   PetscErrorCode ierr;
5056201da799SBarry Smith   PetscInt       its;
5057201da799SBarry Smith 
5058201da799SBarry Smith   PetscFunctionBegin;
5059201da799SBarry Smith   if (!n) {
5060201da799SBarry Smith     PetscDrawAxis axis;
5061bbd56ea5SKarl Rupp 
5062201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5063201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5064201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5065bbd56ea5SKarl Rupp 
5066201da799SBarry Smith     ctx->snes_its = 0;
5067201da799SBarry Smith   }
5068201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5069201da799SBarry Smith   y    = its - ctx->snes_its;
5070201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
50713fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5072201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5073201da799SBarry Smith   }
5074201da799SBarry Smith   ctx->snes_its = its;
5075201da799SBarry Smith   PetscFunctionReturn(0);
5076201da799SBarry Smith }
5077201da799SBarry Smith 
5078201da799SBarry Smith #undef __FUNCT__
5079201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
5080201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5081201da799SBarry Smith {
5082201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5083201da799SBarry Smith   PetscReal      x   = ptime,y;
5084201da799SBarry Smith   PetscErrorCode ierr;
5085201da799SBarry Smith   PetscInt       its;
5086201da799SBarry Smith 
5087201da799SBarry Smith   PetscFunctionBegin;
5088201da799SBarry Smith   if (!n) {
5089201da799SBarry Smith     PetscDrawAxis axis;
5090bbd56ea5SKarl Rupp 
5091201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5092201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
5093201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5094bbd56ea5SKarl Rupp 
5095201da799SBarry Smith     ctx->ksp_its = 0;
5096201da799SBarry Smith   }
5097201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
5098201da799SBarry Smith   y    = its - ctx->ksp_its;
5099201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
510099fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5101201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5102201da799SBarry Smith   }
5103201da799SBarry Smith   ctx->ksp_its = its;
5104201da799SBarry Smith   PetscFunctionReturn(0);
5105201da799SBarry Smith }
5106f9c1d6abSBarry Smith 
5107f9c1d6abSBarry Smith #undef __FUNCT__
5108f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
5109f9c1d6abSBarry Smith /*@
5110f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
5111f9c1d6abSBarry Smith 
5112f9c1d6abSBarry Smith    Collective on TS and Vec
5113f9c1d6abSBarry Smith 
5114f9c1d6abSBarry Smith    Input Parameters:
5115f9c1d6abSBarry Smith +  ts - the TS context
5116f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
5117f9c1d6abSBarry Smith 
5118f9c1d6abSBarry Smith    Output Parameters:
5119f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
5120f9c1d6abSBarry Smith 
5121f9c1d6abSBarry Smith    Level: developer
5122f9c1d6abSBarry Smith 
5123f9c1d6abSBarry Smith .keywords: TS, compute
5124f9c1d6abSBarry Smith 
5125f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
5126f9c1d6abSBarry Smith @*/
5127f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5128f9c1d6abSBarry Smith {
5129f9c1d6abSBarry Smith   PetscErrorCode ierr;
5130f9c1d6abSBarry Smith 
5131f9c1d6abSBarry Smith   PetscFunctionBegin;
5132f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5133ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5134f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
5135f9c1d6abSBarry Smith   PetscFunctionReturn(0);
5136f9c1d6abSBarry Smith }
513724655328SShri 
513824655328SShri #undef __FUNCT__
513924655328SShri #define __FUNCT__ "TSRollBack"
514024655328SShri /*@
514124655328SShri    TSRollBack - Rolls back one time step
514224655328SShri 
514324655328SShri    Collective on TS
514424655328SShri 
514524655328SShri    Input Parameter:
514624655328SShri .  ts - the TS context obtained from TSCreate()
514724655328SShri 
514824655328SShri    Level: advanced
514924655328SShri 
515024655328SShri .keywords: TS, timestep, rollback
515124655328SShri 
515224655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
515324655328SShri @*/
515424655328SShri PetscErrorCode  TSRollBack(TS ts)
515524655328SShri {
515624655328SShri   PetscErrorCode ierr;
515724655328SShri 
515824655328SShri   PetscFunctionBegin;
515924655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
516024655328SShri 
516124655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
516224655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
516324655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
516424655328SShri   ts->ptime = ts->ptime_prev;
516524655328SShri   PetscFunctionReturn(0);
516624655328SShri }
5167aeb4809dSShri Abhyankar 
5168ff22ae23SHong Zhang #undef __FUNCT__
5169ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
5170ff22ae23SHong Zhang /*@
5171ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
5172ff22ae23SHong Zhang 
5173ff22ae23SHong Zhang    Input Parameter:
5174ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
5175ff22ae23SHong Zhang 
5176ff22ae23SHong Zhang    Level: advanced
5177ff22ae23SHong Zhang 
5178ff22ae23SHong Zhang .keywords: TS, getstages
5179ff22ae23SHong Zhang 
5180ff22ae23SHong Zhang .seealso: TSCreate()
5181ff22ae23SHong Zhang @*/
5182ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
5183ff22ae23SHong Zhang {
5184ff22ae23SHong Zhang   PetscErrorCode ierr;
5185ff22ae23SHong Zhang 
5186ff22ae23SHong Zhang   PetscFunctionBegin;
5187ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5188ff22ae23SHong Zhang   PetscValidPointer(ns,2);
5189ff22ae23SHong Zhang 
5190ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
5191ff22ae23SHong Zhang   else {
5192ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
5193ff22ae23SHong Zhang   }
5194ff22ae23SHong Zhang   PetscFunctionReturn(0);
5195ff22ae23SHong Zhang }
5196ff22ae23SHong Zhang 
5197ff22ae23SHong Zhang 
5198ff22ae23SHong Zhang 
5199