xref: /petsc/src/ts/interface/ts.c (revision e6ad8bfb336110cc235745a0e20ee85561d5e6aa)
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 /*@
379*e6ad8bfbSHong Zhang    TSSetReverseMode - Allows one to reset the run mode,
380d2daff3dSHong Zhang    useful for adjoint sensitivity analysis.
381d2daff3dSHong Zhang 
382d2daff3dSHong Zhang    Collective on TS
383d2daff3dSHong Zhang 
384d2daff3dSHong Zhang    Input Parameters:
385d2daff3dSHong Zhang +  ts - the TS context obtained from TSCreate()
386d2daff3dSHong Zhang -  reverse_mode - run in forward (default) or reverse mode
387d2daff3dSHong Zhang 
388d2daff3dSHong Zhang    Level: intermediate
389d2daff3dSHong Zhang 
390d2daff3dSHong Zhang .seealso:
391d2daff3dSHong Zhang 
392d2daff3dSHong Zhang .keywords: TS, set, reverse
393d2daff3dSHong Zhang @*/
394d2daff3dSHong Zhang PetscErrorCode  TSSetReverseMode(TS ts,PetscBool reverse_mode)
395d2daff3dSHong Zhang {
396f8fee759SHong Zhang   PetscErrorCode ierr;
397d2daff3dSHong Zhang   PetscFunctionBegin;
398d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
399d2daff3dSHong Zhang   ts->reverse_mode = reverse_mode;
400f8fee759SHong Zhang   ts->setupcalled  = PETSC_FALSE;
401f8fee759SHong Zhang   ierr = TSSetUp(ts);CHKERRQ(ierr);
402d2daff3dSHong Zhang   PetscFunctionReturn(0);
403d2daff3dSHong Zhang }
404d2daff3dSHong Zhang 
405a7a1495cSBarry Smith #undef __FUNCT__
406a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
407a7a1495cSBarry Smith /*@
408a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
409a7a1495cSBarry Smith       set with TSSetRHSJacobian().
410a7a1495cSBarry Smith 
411a7a1495cSBarry Smith    Collective on TS and Vec
412a7a1495cSBarry Smith 
413a7a1495cSBarry Smith    Input Parameters:
414316643e7SJed Brown +  ts - the TS context
415a7a1495cSBarry Smith .  t - current timestep
4160910c330SBarry Smith -  U - input vector
417a7a1495cSBarry Smith 
418a7a1495cSBarry Smith    Output Parameters:
419a7a1495cSBarry Smith +  A - Jacobian matrix
420a7a1495cSBarry Smith .  B - optional preconditioning matrix
421a7a1495cSBarry Smith -  flag - flag indicating matrix structure
422a7a1495cSBarry Smith 
423a7a1495cSBarry Smith    Notes:
424a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
425a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
426a7a1495cSBarry Smith 
42794b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
428a7a1495cSBarry Smith    flag parameter.
429a7a1495cSBarry Smith 
430a7a1495cSBarry Smith    Level: developer
431a7a1495cSBarry Smith 
432a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
433a7a1495cSBarry Smith 
43494b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
435a7a1495cSBarry Smith @*/
436d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
437a7a1495cSBarry Smith {
438dfbe8321SBarry Smith   PetscErrorCode ierr;
439270bf2e7SJed Brown   PetscObjectState Ustate;
44024989b8cSPeter Brune   DM             dm;
441942e3340SBarry Smith   DMTS           tsdm;
44224989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
44324989b8cSPeter Brune   void           *ctx;
44424989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
445a7a1495cSBarry Smith 
446a7a1495cSBarry Smith   PetscFunctionBegin;
4470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4480910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4490910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
45024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
451942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
45224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4530298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
45459e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
4550910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4560e4ef248SJed Brown     PetscFunctionReturn(0);
457f8ede8e7SJed Brown   }
458d90be118SSean Farley 
459ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
460d90be118SSean Farley 
461e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
46294ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
46394ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
46494ab13aaSBarry Smith     if (A != B) {
46594ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
46694ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
467e1244c69SJed Brown     }
468e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
469e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
470e1244c69SJed Brown   }
471e1244c69SJed Brown 
47224989b8cSPeter Brune   if (rhsjacobianfunc) {
47394ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
474a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
475d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
476a7a1495cSBarry Smith     PetscStackPop;
47794ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
478a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
47994ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
48094ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
481ef66eb69SBarry Smith   } else {
48294ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
48394ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
484ef66eb69SBarry Smith   }
4850e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4860910c330SBarry Smith   ts->rhsjacobian.X          = U;
48759e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
488a7a1495cSBarry Smith   PetscFunctionReturn(0);
489a7a1495cSBarry Smith }
490a7a1495cSBarry Smith 
4914a2ae208SSatish Balay #undef __FUNCT__
4924a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
493316643e7SJed Brown /*@
494d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
495d763cef2SBarry Smith 
496316643e7SJed Brown    Collective on TS and Vec
497316643e7SJed Brown 
498316643e7SJed Brown    Input Parameters:
499316643e7SJed Brown +  ts - the TS context
500316643e7SJed Brown .  t - current time
5010910c330SBarry Smith -  U - state vector
502316643e7SJed Brown 
503316643e7SJed Brown    Output Parameter:
504316643e7SJed Brown .  y - right hand side
505316643e7SJed Brown 
506316643e7SJed Brown    Note:
507316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
508316643e7SJed Brown    is used internally within the nonlinear solvers.
509316643e7SJed Brown 
510316643e7SJed Brown    Level: developer
511316643e7SJed Brown 
512316643e7SJed Brown .keywords: TS, compute
513316643e7SJed Brown 
514316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
515316643e7SJed Brown @*/
5160910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
517d763cef2SBarry Smith {
518dfbe8321SBarry Smith   PetscErrorCode ierr;
51924989b8cSPeter Brune   TSRHSFunction  rhsfunction;
52024989b8cSPeter Brune   TSIFunction    ifunction;
52124989b8cSPeter Brune   void           *ctx;
52224989b8cSPeter Brune   DM             dm;
52324989b8cSPeter Brune 
524d763cef2SBarry Smith   PetscFunctionBegin;
5250700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5260910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5270700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
52824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
52924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5300298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
531d763cef2SBarry Smith 
532ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
533d763cef2SBarry Smith 
5340910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
53524989b8cSPeter Brune   if (rhsfunction) {
536d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5370910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
538d763cef2SBarry Smith     PetscStackPop;
539214bc6a2SJed Brown   } else {
540214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
541b2cd27e8SJed Brown   }
54244a41b28SSean Farley 
5430910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
544d763cef2SBarry Smith   PetscFunctionReturn(0);
545d763cef2SBarry Smith }
546d763cef2SBarry Smith 
5474a2ae208SSatish Balay #undef __FUNCT__
548ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
549ef20d060SBarry Smith /*@
550ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
551ef20d060SBarry Smith 
552ef20d060SBarry Smith    Collective on TS and Vec
553ef20d060SBarry Smith 
554ef20d060SBarry Smith    Input Parameters:
555ef20d060SBarry Smith +  ts - the TS context
556ef20d060SBarry Smith -  t - current time
557ef20d060SBarry Smith 
558ef20d060SBarry Smith    Output Parameter:
5590910c330SBarry Smith .  U - the solution
560ef20d060SBarry Smith 
561ef20d060SBarry Smith    Note:
562ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
563ef20d060SBarry Smith    is used internally within the nonlinear solvers.
564ef20d060SBarry Smith 
565ef20d060SBarry Smith    Level: developer
566ef20d060SBarry Smith 
567ef20d060SBarry Smith .keywords: TS, compute
568ef20d060SBarry Smith 
569abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
570ef20d060SBarry Smith @*/
5710910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
572ef20d060SBarry Smith {
573ef20d060SBarry Smith   PetscErrorCode     ierr;
574ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
575ef20d060SBarry Smith   void               *ctx;
576ef20d060SBarry Smith   DM                 dm;
577ef20d060SBarry Smith 
578ef20d060SBarry Smith   PetscFunctionBegin;
579ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5800910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
581ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
582ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
583ef20d060SBarry Smith 
584ef20d060SBarry Smith   if (solutionfunction) {
5859b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5860910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
587ef20d060SBarry Smith     PetscStackPop;
588ef20d060SBarry Smith   }
589ef20d060SBarry Smith   PetscFunctionReturn(0);
590ef20d060SBarry Smith }
5919b7cd975SBarry Smith #undef __FUNCT__
5929b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5939b7cd975SBarry Smith /*@
5949b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5959b7cd975SBarry Smith 
5969b7cd975SBarry Smith    Collective on TS and Vec
5979b7cd975SBarry Smith 
5989b7cd975SBarry Smith    Input Parameters:
5999b7cd975SBarry Smith +  ts - the TS context
6009b7cd975SBarry Smith -  t - current time
6019b7cd975SBarry Smith 
6029b7cd975SBarry Smith    Output Parameter:
6039b7cd975SBarry Smith .  U - the function value
6049b7cd975SBarry Smith 
6059b7cd975SBarry Smith    Note:
6069b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6079b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6089b7cd975SBarry Smith 
6099b7cd975SBarry Smith    Level: developer
6109b7cd975SBarry Smith 
6119b7cd975SBarry Smith .keywords: TS, compute
6129b7cd975SBarry Smith 
6139b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6149b7cd975SBarry Smith @*/
6159b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
6169b7cd975SBarry Smith {
6179b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
6189b7cd975SBarry Smith   void               *ctx;
6199b7cd975SBarry Smith   DM                 dm;
6209b7cd975SBarry Smith 
6219b7cd975SBarry Smith   PetscFunctionBegin;
6229b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6239b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6249b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6259b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6269b7cd975SBarry Smith 
6279b7cd975SBarry Smith   if (forcing) {
6289b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6299b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6309b7cd975SBarry Smith     PetscStackPop;
6319b7cd975SBarry Smith   }
6329b7cd975SBarry Smith   PetscFunctionReturn(0);
6339b7cd975SBarry Smith }
634ef20d060SBarry Smith 
635ef20d060SBarry Smith #undef __FUNCT__
636214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
637214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
638214bc6a2SJed Brown {
6392dd45cf8SJed Brown   Vec            F;
640214bc6a2SJed Brown   PetscErrorCode ierr;
641214bc6a2SJed Brown 
642214bc6a2SJed Brown   PetscFunctionBegin;
6430298fd71SBarry Smith   *Frhs = NULL;
6440298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
645214bc6a2SJed Brown   if (!ts->Frhs) {
6462dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
647214bc6a2SJed Brown   }
648214bc6a2SJed Brown   *Frhs = ts->Frhs;
649214bc6a2SJed Brown   PetscFunctionReturn(0);
650214bc6a2SJed Brown }
651214bc6a2SJed Brown 
652214bc6a2SJed Brown #undef __FUNCT__
653214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
654214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
655214bc6a2SJed Brown {
656214bc6a2SJed Brown   Mat            A,B;
6572dd45cf8SJed Brown   PetscErrorCode ierr;
658214bc6a2SJed Brown 
659214bc6a2SJed Brown   PetscFunctionBegin;
660c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
661c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6620298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
663214bc6a2SJed Brown   if (Arhs) {
664214bc6a2SJed Brown     if (!ts->Arhs) {
665214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
666214bc6a2SJed Brown     }
667214bc6a2SJed Brown     *Arhs = ts->Arhs;
668214bc6a2SJed Brown   }
669214bc6a2SJed Brown   if (Brhs) {
670214bc6a2SJed Brown     if (!ts->Brhs) {
671bdb70873SJed Brown       if (A != B) {
672214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
673bdb70873SJed Brown       } else {
674bdb70873SJed Brown         ts->Brhs = ts->Arhs;
675bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
676bdb70873SJed Brown       }
677214bc6a2SJed Brown     }
678214bc6a2SJed Brown     *Brhs = ts->Brhs;
679214bc6a2SJed Brown   }
680214bc6a2SJed Brown   PetscFunctionReturn(0);
681214bc6a2SJed Brown }
682214bc6a2SJed Brown 
683214bc6a2SJed Brown #undef __FUNCT__
684316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
685316643e7SJed Brown /*@
6860910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
687316643e7SJed Brown 
688316643e7SJed Brown    Collective on TS and Vec
689316643e7SJed Brown 
690316643e7SJed Brown    Input Parameters:
691316643e7SJed Brown +  ts - the TS context
692316643e7SJed Brown .  t - current time
6930910c330SBarry Smith .  U - state vector
6940910c330SBarry Smith .  Udot - time derivative of state vector
695214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
696316643e7SJed Brown 
697316643e7SJed Brown    Output Parameter:
698316643e7SJed Brown .  Y - right hand side
699316643e7SJed Brown 
700316643e7SJed Brown    Note:
701316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
702316643e7SJed Brown    is used internally within the nonlinear solvers.
703316643e7SJed Brown 
704316643e7SJed Brown    If the user did did not write their equations in implicit form, this
705316643e7SJed Brown    function recasts them in implicit form.
706316643e7SJed Brown 
707316643e7SJed Brown    Level: developer
708316643e7SJed Brown 
709316643e7SJed Brown .keywords: TS, compute
710316643e7SJed Brown 
711316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
712316643e7SJed Brown @*/
7130910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
714316643e7SJed Brown {
715316643e7SJed Brown   PetscErrorCode ierr;
71624989b8cSPeter Brune   TSIFunction    ifunction;
71724989b8cSPeter Brune   TSRHSFunction  rhsfunction;
71824989b8cSPeter Brune   void           *ctx;
71924989b8cSPeter Brune   DM             dm;
720316643e7SJed Brown 
721316643e7SJed Brown   PetscFunctionBegin;
7220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7230910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7240910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7250700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
726316643e7SJed Brown 
72724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
72824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7290298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
73024989b8cSPeter Brune 
731ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
732d90be118SSean Farley 
7330910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
73424989b8cSPeter Brune   if (ifunction) {
735316643e7SJed Brown     PetscStackPush("TS user implicit function");
7360910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
737316643e7SJed Brown     PetscStackPop;
738214bc6a2SJed Brown   }
739214bc6a2SJed Brown   if (imex) {
74024989b8cSPeter Brune     if (!ifunction) {
7410910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7422dd45cf8SJed Brown     }
74324989b8cSPeter Brune   } else if (rhsfunction) {
74424989b8cSPeter Brune     if (ifunction) {
745214bc6a2SJed Brown       Vec Frhs;
746214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7470910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
748214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7492dd45cf8SJed Brown     } else {
7500910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7510910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
752316643e7SJed Brown     }
7534a6899ffSJed Brown   }
7540910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
755316643e7SJed Brown   PetscFunctionReturn(0);
756316643e7SJed Brown }
757316643e7SJed Brown 
758316643e7SJed Brown #undef __FUNCT__
759316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
760316643e7SJed Brown /*@
761316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
762316643e7SJed Brown 
763316643e7SJed Brown    Collective on TS and Vec
764316643e7SJed Brown 
765316643e7SJed Brown    Input
766316643e7SJed Brown       Input Parameters:
767316643e7SJed Brown +  ts - the TS context
768316643e7SJed Brown .  t - current timestep
7690910c330SBarry Smith .  U - state vector
7700910c330SBarry Smith .  Udot - time derivative of state vector
771214bc6a2SJed Brown .  shift - shift to apply, see note below
772214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
773316643e7SJed Brown 
774316643e7SJed Brown    Output Parameters:
775316643e7SJed Brown +  A - Jacobian matrix
776316643e7SJed Brown .  B - optional preconditioning matrix
777316643e7SJed Brown -  flag - flag indicating matrix structure
778316643e7SJed Brown 
779316643e7SJed Brown    Notes:
7800910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
781316643e7SJed Brown 
7820910c330SBarry Smith    dF/dU + shift*dF/dUdot
783316643e7SJed Brown 
784316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
785316643e7SJed Brown    is used internally within the nonlinear solvers.
786316643e7SJed Brown 
787316643e7SJed Brown    Level: developer
788316643e7SJed Brown 
789316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
790316643e7SJed Brown 
791316643e7SJed Brown .seealso:  TSSetIJacobian()
79263495f91SJed Brown @*/
793d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
794316643e7SJed Brown {
795316643e7SJed Brown   PetscErrorCode ierr;
79624989b8cSPeter Brune   TSIJacobian    ijacobian;
79724989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
79824989b8cSPeter Brune   DM             dm;
79924989b8cSPeter Brune   void           *ctx;
800316643e7SJed Brown 
801316643e7SJed Brown   PetscFunctionBegin;
8020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8030910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8040910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
805316643e7SJed Brown   PetscValidPointer(A,6);
80694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
807316643e7SJed Brown   PetscValidPointer(B,7);
80894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
80924989b8cSPeter Brune 
81024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
81124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8120298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
81324989b8cSPeter Brune 
814ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
815316643e7SJed Brown 
81694ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
81724989b8cSPeter Brune   if (ijacobian) {
818316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
819d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
820316643e7SJed Brown     PetscStackPop;
821214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
82294ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
82394ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8244a6899ffSJed Brown   }
825214bc6a2SJed Brown   if (imex) {
826b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
82794ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
82894ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
82994ab13aaSBarry Smith       if (A != B) {
83094ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
83194ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
832214bc6a2SJed Brown       }
833214bc6a2SJed Brown     }
834214bc6a2SJed Brown   } else {
835e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
836e1244c69SJed Brown     if (rhsjacobian) {
837bd373395SBarry Smith       if (ijacobian) {
838e1244c69SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
839bd373395SBarry Smith       } else {
840bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
841e1244c69SJed Brown       }
842d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
843e1244c69SJed Brown     }
84494ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
845e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
846e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
84794ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
84894ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
84994ab13aaSBarry Smith       if (A != B) {
85094ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
85194ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
852316643e7SJed Brown       }
853e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
854e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
855e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
85694ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
85794ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
85894ab13aaSBarry Smith         if (A != B) {
85994ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
86094ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
861e1244c69SJed Brown         }
862e1244c69SJed Brown       }
86394ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
86494ab13aaSBarry Smith       if (A != B) {
86594ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
866214bc6a2SJed Brown       }
867316643e7SJed Brown     }
868316643e7SJed Brown   }
86994ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
870316643e7SJed Brown   PetscFunctionReturn(0);
871316643e7SJed Brown }
872316643e7SJed Brown 
873316643e7SJed Brown #undef __FUNCT__
8744a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
875d763cef2SBarry Smith /*@C
876d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
877b5abc632SBarry Smith     where U_t = G(t,u).
878d763cef2SBarry Smith 
8793f9fe445SBarry Smith     Logically Collective on TS
880d763cef2SBarry Smith 
881d763cef2SBarry Smith     Input Parameters:
882d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8830298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
884d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
885d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8860298fd71SBarry Smith           function evaluation routine (may be NULL)
887d763cef2SBarry Smith 
888d763cef2SBarry Smith     Calling sequence of func:
88987828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
890d763cef2SBarry Smith 
891d763cef2SBarry Smith +   t - current timestep
892d763cef2SBarry Smith .   u - input vector
893d763cef2SBarry Smith .   F - function vector
894d763cef2SBarry Smith -   ctx - [optional] user-defined function context
895d763cef2SBarry Smith 
896d763cef2SBarry Smith     Level: beginner
897d763cef2SBarry Smith 
898d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
899d763cef2SBarry Smith 
900ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
901d763cef2SBarry Smith @*/
902089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
903d763cef2SBarry Smith {
904089b2837SJed Brown   PetscErrorCode ierr;
905089b2837SJed Brown   SNES           snes;
9060298fd71SBarry Smith   Vec            ralloc = NULL;
90724989b8cSPeter Brune   DM             dm;
908d763cef2SBarry Smith 
909089b2837SJed Brown   PetscFunctionBegin;
9100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
911ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
91224989b8cSPeter Brune 
91324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
91424989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
915089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
916e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
917e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
918e856ceecSJed Brown     r    = ralloc;
919e856ceecSJed Brown   }
920089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
921e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
922d763cef2SBarry Smith   PetscFunctionReturn(0);
923d763cef2SBarry Smith }
924d763cef2SBarry Smith 
9254a2ae208SSatish Balay #undef __FUNCT__
926ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
927ef20d060SBarry Smith /*@C
928abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
929ef20d060SBarry Smith 
930ef20d060SBarry Smith     Logically Collective on TS
931ef20d060SBarry Smith 
932ef20d060SBarry Smith     Input Parameters:
933ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
934ef20d060SBarry Smith .   f - routine for evaluating the solution
935ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9360298fd71SBarry Smith           function evaluation routine (may be NULL)
937ef20d060SBarry Smith 
938ef20d060SBarry Smith     Calling sequence of func:
939ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
940ef20d060SBarry Smith 
941ef20d060SBarry Smith +   t - current timestep
942ef20d060SBarry Smith .   u - output vector
943ef20d060SBarry Smith -   ctx - [optional] user-defined function context
944ef20d060SBarry Smith 
945abd5a294SJed Brown     Notes:
946abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
947abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
948abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
949abd5a294SJed Brown 
9504f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
951abd5a294SJed Brown 
952ef20d060SBarry Smith     Level: beginner
953ef20d060SBarry Smith 
954ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
955ef20d060SBarry Smith 
9569b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
957ef20d060SBarry Smith @*/
958ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
959ef20d060SBarry Smith {
960ef20d060SBarry Smith   PetscErrorCode ierr;
961ef20d060SBarry Smith   DM             dm;
962ef20d060SBarry Smith 
963ef20d060SBarry Smith   PetscFunctionBegin;
964ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
965ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
966ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
967ef20d060SBarry Smith   PetscFunctionReturn(0);
968ef20d060SBarry Smith }
969ef20d060SBarry Smith 
970ef20d060SBarry Smith #undef __FUNCT__
9719b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9729b7cd975SBarry Smith /*@C
9739b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9749b7cd975SBarry Smith 
9759b7cd975SBarry Smith     Logically Collective on TS
9769b7cd975SBarry Smith 
9779b7cd975SBarry Smith     Input Parameters:
9789b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9799b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9809b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9810298fd71SBarry Smith           function evaluation routine (may be NULL)
9829b7cd975SBarry Smith 
9839b7cd975SBarry Smith     Calling sequence of func:
9849b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9859b7cd975SBarry Smith 
9869b7cd975SBarry Smith +   t - current timestep
9879b7cd975SBarry Smith .   u - output vector
9889b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9899b7cd975SBarry Smith 
9909b7cd975SBarry Smith     Notes:
9919b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9929b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9939b7cd975SBarry Smith 
9949b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9959b7cd975SBarry Smith 
9969b7cd975SBarry Smith     Level: beginner
9979b7cd975SBarry Smith 
9989b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9999b7cd975SBarry Smith 
10009b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10019b7cd975SBarry Smith @*/
10029b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
10039b7cd975SBarry Smith {
10049b7cd975SBarry Smith   PetscErrorCode ierr;
10059b7cd975SBarry Smith   DM             dm;
10069b7cd975SBarry Smith 
10079b7cd975SBarry Smith   PetscFunctionBegin;
10089b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10099b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
10109b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
10119b7cd975SBarry Smith   PetscFunctionReturn(0);
10129b7cd975SBarry Smith }
10139b7cd975SBarry Smith 
10149b7cd975SBarry Smith #undef __FUNCT__
10154a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1016d763cef2SBarry Smith /*@C
1017d763cef2SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of F,
1018b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1019d763cef2SBarry Smith 
10203f9fe445SBarry Smith    Logically Collective on TS
1021d763cef2SBarry Smith 
1022d763cef2SBarry Smith    Input Parameters:
1023d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1024e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1025e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1026d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1027d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10280298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1029d763cef2SBarry Smith 
1030d763cef2SBarry Smith    Calling sequence of func:
1031ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1032d763cef2SBarry Smith 
1033d763cef2SBarry Smith +  t - current timestep
1034d763cef2SBarry Smith .  u - input vector
1035e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1036e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1037d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1038d763cef2SBarry Smith 
1039d763cef2SBarry Smith 
1040d763cef2SBarry Smith    Level: beginner
1041d763cef2SBarry Smith 
1042d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1043d763cef2SBarry Smith 
1044ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1045d763cef2SBarry Smith 
1046d763cef2SBarry Smith @*/
1047e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1048d763cef2SBarry Smith {
1049277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1050089b2837SJed Brown   SNES           snes;
105124989b8cSPeter Brune   DM             dm;
105224989b8cSPeter Brune   TSIJacobian    ijacobian;
1053277b19d0SLisandro Dalcin 
1054d763cef2SBarry Smith   PetscFunctionBegin;
10550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1056e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1057e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1058e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1059e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1060d763cef2SBarry Smith 
106124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
106224989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1063e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1064e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1065e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1066e1244c69SJed Brown   }
10670298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1068089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10695f659677SPeter Brune   if (!ijacobian) {
1070e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10710e4ef248SJed Brown   }
1072e5d3d808SBarry Smith   if (Amat) {
1073e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10740e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1075bbd56ea5SKarl Rupp 
1076e5d3d808SBarry Smith     ts->Arhs = Amat;
10770e4ef248SJed Brown   }
1078e5d3d808SBarry Smith   if (Pmat) {
1079e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10800e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1081bbd56ea5SKarl Rupp 
1082e5d3d808SBarry Smith     ts->Brhs = Pmat;
10830e4ef248SJed Brown   }
1084d763cef2SBarry Smith   PetscFunctionReturn(0);
1085d763cef2SBarry Smith }
1086d763cef2SBarry Smith 
1087316643e7SJed Brown 
1088316643e7SJed Brown #undef __FUNCT__
1089316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1090316643e7SJed Brown /*@C
1091b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1092316643e7SJed Brown 
10933f9fe445SBarry Smith    Logically Collective on TS
1094316643e7SJed Brown 
1095316643e7SJed Brown    Input Parameters:
1096316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10970298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1098316643e7SJed Brown .  f   - the function evaluation routine
10990298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1100316643e7SJed Brown 
1101316643e7SJed Brown    Calling sequence of f:
1102316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1103316643e7SJed Brown 
1104316643e7SJed Brown +  t   - time at step/stage being solved
1105316643e7SJed Brown .  u   - state vector
1106316643e7SJed Brown .  u_t - time derivative of state vector
1107316643e7SJed Brown .  F   - function vector
1108316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1109316643e7SJed Brown 
1110316643e7SJed Brown    Important:
1111d6cbdb99SBarry Smith    The user MUST call either this routine, TSSetRHSFunction().  This routine must be used when not solving an ODE, for example a DAE.
1112316643e7SJed Brown 
1113316643e7SJed Brown    Level: beginner
1114316643e7SJed Brown 
1115316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1116316643e7SJed Brown 
1117d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1118316643e7SJed Brown @*/
1119089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1120316643e7SJed Brown {
1121089b2837SJed Brown   PetscErrorCode ierr;
1122089b2837SJed Brown   SNES           snes;
11230298fd71SBarry Smith   Vec            resalloc = NULL;
112424989b8cSPeter Brune   DM             dm;
1125316643e7SJed Brown 
1126316643e7SJed Brown   PetscFunctionBegin;
11270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1128ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
112924989b8cSPeter Brune 
113024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
113124989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
113224989b8cSPeter Brune 
1133089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1134e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1135e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1136e856ceecSJed Brown     res  = resalloc;
1137e856ceecSJed Brown   }
1138089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1139e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1140089b2837SJed Brown   PetscFunctionReturn(0);
1141089b2837SJed Brown }
1142089b2837SJed Brown 
1143089b2837SJed Brown #undef __FUNCT__
1144089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1145089b2837SJed Brown /*@C
1146089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1147089b2837SJed Brown 
1148089b2837SJed Brown    Not Collective
1149089b2837SJed Brown 
1150089b2837SJed Brown    Input Parameter:
1151089b2837SJed Brown .  ts - the TS context
1152089b2837SJed Brown 
1153089b2837SJed Brown    Output Parameter:
11540298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11550298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11560298fd71SBarry Smith -  ctx - the function context (or NULL)
1157089b2837SJed Brown 
1158089b2837SJed Brown    Level: advanced
1159089b2837SJed Brown 
1160089b2837SJed Brown .keywords: TS, nonlinear, get, function
1161089b2837SJed Brown 
1162089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1163089b2837SJed Brown @*/
1164089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1165089b2837SJed Brown {
1166089b2837SJed Brown   PetscErrorCode ierr;
1167089b2837SJed Brown   SNES           snes;
116824989b8cSPeter Brune   DM             dm;
1169089b2837SJed Brown 
1170089b2837SJed Brown   PetscFunctionBegin;
1171089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1172089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11730298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
117424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
117524989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1176089b2837SJed Brown   PetscFunctionReturn(0);
1177089b2837SJed Brown }
1178089b2837SJed Brown 
1179089b2837SJed Brown #undef __FUNCT__
1180089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1181089b2837SJed Brown /*@C
1182089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1183089b2837SJed Brown 
1184089b2837SJed Brown    Not Collective
1185089b2837SJed Brown 
1186089b2837SJed Brown    Input Parameter:
1187089b2837SJed Brown .  ts - the TS context
1188089b2837SJed Brown 
1189089b2837SJed Brown    Output Parameter:
11900298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11910298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11920298fd71SBarry Smith -  ctx - the function context (or NULL)
1193089b2837SJed Brown 
1194089b2837SJed Brown    Level: advanced
1195089b2837SJed Brown 
1196089b2837SJed Brown .keywords: TS, nonlinear, get, function
1197089b2837SJed Brown 
1198089b2837SJed Brown .seealso: TSSetRhsfunction(), SNESGetFunction()
1199089b2837SJed Brown @*/
1200089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1201089b2837SJed Brown {
1202089b2837SJed Brown   PetscErrorCode ierr;
1203089b2837SJed Brown   SNES           snes;
120424989b8cSPeter Brune   DM             dm;
1205089b2837SJed Brown 
1206089b2837SJed Brown   PetscFunctionBegin;
1207089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1208089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12090298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
121024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
121124989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1212316643e7SJed Brown   PetscFunctionReturn(0);
1213316643e7SJed Brown }
1214316643e7SJed Brown 
1215316643e7SJed Brown #undef __FUNCT__
1216316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1217316643e7SJed Brown /*@C
1218a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1219ae8867d6SBarry Smith         provided with TSSetIFunction().
1220316643e7SJed Brown 
12213f9fe445SBarry Smith    Logically Collective on TS
1222316643e7SJed Brown 
1223316643e7SJed Brown    Input Parameters:
1224316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1225e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1226e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1227316643e7SJed Brown .  f   - the Jacobian evaluation routine
12280298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1229316643e7SJed Brown 
1230316643e7SJed Brown    Calling sequence of f:
1231ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1232316643e7SJed Brown 
1233316643e7SJed Brown +  t    - time at step/stage being solved
12341b4a444bSJed Brown .  U    - state vector
12351b4a444bSJed Brown .  U_t  - time derivative of state vector
1236316643e7SJed Brown .  a    - shift
1237e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1238e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1239316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1240316643e7SJed Brown 
1241316643e7SJed Brown    Notes:
1242e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1243316643e7SJed Brown 
1244a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1245b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1246a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1247a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1248a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1249a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1250a4f0a591SBarry Smith 
1251316643e7SJed Brown    Level: beginner
1252316643e7SJed Brown 
1253316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1254316643e7SJed Brown 
1255ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1256316643e7SJed Brown 
1257316643e7SJed Brown @*/
1258e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1259316643e7SJed Brown {
1260316643e7SJed Brown   PetscErrorCode ierr;
1261089b2837SJed Brown   SNES           snes;
126224989b8cSPeter Brune   DM             dm;
1263316643e7SJed Brown 
1264316643e7SJed Brown   PetscFunctionBegin;
12650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1266e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1267e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1268e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1269e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
127024989b8cSPeter Brune 
127124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
127224989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
127324989b8cSPeter Brune 
1274089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1275e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1276316643e7SJed Brown   PetscFunctionReturn(0);
1277316643e7SJed Brown }
1278316643e7SJed Brown 
12794a2ae208SSatish Balay #undef __FUNCT__
1280e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1281e1244c69SJed Brown /*@
1282e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1283e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1284e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1285e1244c69SJed Brown    not been changed by the TS.
1286e1244c69SJed Brown 
1287e1244c69SJed Brown    Logically Collective
1288e1244c69SJed Brown 
1289e1244c69SJed Brown    Input Arguments:
1290e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1291e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1292e1244c69SJed Brown 
1293e1244c69SJed Brown    Level: intermediate
1294e1244c69SJed Brown 
1295e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1296e1244c69SJed Brown @*/
1297e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1298e1244c69SJed Brown {
1299e1244c69SJed Brown   PetscFunctionBegin;
1300e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1301e1244c69SJed Brown   PetscFunctionReturn(0);
1302e1244c69SJed Brown }
1303e1244c69SJed Brown 
1304e1244c69SJed Brown #undef __FUNCT__
130555849f57SBarry Smith #define __FUNCT__ "TSLoad"
130655849f57SBarry Smith /*@C
130755849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
130855849f57SBarry Smith 
130955849f57SBarry Smith   Collective on PetscViewer
131055849f57SBarry Smith 
131155849f57SBarry Smith   Input Parameters:
131255849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
131355849f57SBarry Smith            some related function before a call to TSLoad().
131455849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
131555849f57SBarry Smith 
131655849f57SBarry Smith    Level: intermediate
131755849f57SBarry Smith 
131855849f57SBarry Smith   Notes:
131955849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
132055849f57SBarry Smith 
132155849f57SBarry Smith   Notes for advanced users:
132255849f57SBarry Smith   Most users should not need to know the details of the binary storage
132355849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
132455849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
132555849f57SBarry Smith   format is
132655849f57SBarry Smith .vb
132755849f57SBarry Smith      has not yet been determined
132855849f57SBarry Smith .ve
132955849f57SBarry Smith 
133055849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
133155849f57SBarry Smith @*/
1332f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
133355849f57SBarry Smith {
133455849f57SBarry Smith   PetscErrorCode ierr;
133555849f57SBarry Smith   PetscBool      isbinary;
133655849f57SBarry Smith   PetscInt       classid;
133755849f57SBarry Smith   char           type[256];
13382d53ad75SBarry Smith   DMTS           sdm;
1339ad6bc421SBarry Smith   DM             dm;
134055849f57SBarry Smith 
134155849f57SBarry Smith   PetscFunctionBegin;
1342f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
134355849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
134455849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
134555849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
134655849f57SBarry Smith 
134755849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1348ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
134955849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1350f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1351f2c2a1b9SBarry Smith   if (ts->ops->load) {
1352f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1353f2c2a1b9SBarry Smith   }
1354ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1355ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1356ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1357f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1358f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13592d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13602d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
136155849f57SBarry Smith   PetscFunctionReturn(0);
136255849f57SBarry Smith }
136355849f57SBarry Smith 
13649804daf3SBarry Smith #include <petscdraw.h>
1365e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1366e04113cfSBarry Smith #include <petscviewersaws.h>
1367f05ece33SBarry Smith #endif
136855849f57SBarry Smith #undef __FUNCT__
13694a2ae208SSatish Balay #define __FUNCT__ "TSView"
13707e2c5f70SBarry Smith /*@C
1371d763cef2SBarry Smith     TSView - Prints the TS data structure.
1372d763cef2SBarry Smith 
13734c49b128SBarry Smith     Collective on TS
1374d763cef2SBarry Smith 
1375d763cef2SBarry Smith     Input Parameters:
1376d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1377d763cef2SBarry Smith -   viewer - visualization context
1378d763cef2SBarry Smith 
1379d763cef2SBarry Smith     Options Database Key:
1380d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1381d763cef2SBarry Smith 
1382d763cef2SBarry Smith     Notes:
1383d763cef2SBarry Smith     The available visualization contexts include
1384b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1385b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1386d763cef2SBarry Smith          output where only the first processor opens
1387d763cef2SBarry Smith          the file.  All other processors send their
1388d763cef2SBarry Smith          data to the first processor to print.
1389d763cef2SBarry Smith 
1390d763cef2SBarry Smith     The user can open an alternative visualization context with
1391b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1392d763cef2SBarry Smith 
1393d763cef2SBarry Smith     Level: beginner
1394d763cef2SBarry Smith 
1395d763cef2SBarry Smith .keywords: TS, timestep, view
1396d763cef2SBarry Smith 
1397b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1398d763cef2SBarry Smith @*/
13997087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1400d763cef2SBarry Smith {
1401dfbe8321SBarry Smith   PetscErrorCode ierr;
140219fd82e9SBarry Smith   TSType         type;
14032b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
14042d53ad75SBarry Smith   DMTS           sdm;
1405e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1406f05ece33SBarry Smith   PetscBool      isams;
1407f05ece33SBarry Smith #endif
1408d763cef2SBarry Smith 
1409d763cef2SBarry Smith   PetscFunctionBegin;
14100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14113050cee2SBarry Smith   if (!viewer) {
1412ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
14133050cee2SBarry Smith   }
14140700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1415c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1416fd16b177SBarry Smith 
1417251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1418251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
141955849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
14202b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1421e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1422e04113cfSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&isams);CHKERRQ(ierr);
1423f05ece33SBarry Smith #endif
142432077d6dSBarry Smith   if (iascii) {
1425dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
142677431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14277c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1428d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14295ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1430c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1431d763cef2SBarry Smith     }
14325ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1433193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14342d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14352d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1436d52bd9f3SBarry Smith     if (ts->ops->view) {
1437d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1438d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1439d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1440d52bd9f3SBarry Smith     }
14410f5bd95cSBarry Smith   } else if (isstring) {
1442a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1443b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
144455849f57SBarry Smith   } else if (isbinary) {
144555849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
144655849f57SBarry Smith     MPI_Comm    comm;
144755849f57SBarry Smith     PetscMPIInt rank;
144855849f57SBarry Smith     char        type[256];
144955849f57SBarry Smith 
145055849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
145155849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
145255849f57SBarry Smith     if (!rank) {
145355849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
145455849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
145555849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
145655849f57SBarry Smith     }
145755849f57SBarry Smith     if (ts->ops->view) {
145855849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
145955849f57SBarry Smith     }
1460f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1461f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14622d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14632d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14642b0a91c0SBarry Smith   } else if (isdraw) {
14652b0a91c0SBarry Smith     PetscDraw draw;
14662b0a91c0SBarry Smith     char      str[36];
146789fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14682b0a91c0SBarry Smith 
14692b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14702b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14712b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14722b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
14730298fd71SBarry Smith     ierr   = PetscDrawBoxedString(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
147489fd9fafSBarry Smith     bottom = y - h;
14752b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14762b0a91c0SBarry Smith     if (ts->ops->view) {
14772b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14782b0a91c0SBarry Smith     }
14792b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1480e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1481f05ece33SBarry Smith   } else if (isams) {
1482d45a07a7SBarry Smith     PetscMPIInt rank;
14832657e9d9SBarry Smith     const char  *name;
14842657e9d9SBarry Smith 
14852657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1486d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1487d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1488d45a07a7SBarry Smith       char       dir[1024];
1489d45a07a7SBarry Smith 
1490e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1491a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14922657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14932657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14942657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1495d763cef2SBarry Smith     }
14960acecf5bSBarry Smith     if (ts->ops->view) {
14970acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14980acecf5bSBarry Smith     }
1499f05ece33SBarry Smith #endif
1500f05ece33SBarry Smith   }
1501f05ece33SBarry Smith 
1502b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1503251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1504b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1505d763cef2SBarry Smith   PetscFunctionReturn(0);
1506d763cef2SBarry Smith }
1507d763cef2SBarry Smith 
1508d763cef2SBarry Smith 
15094a2ae208SSatish Balay #undef __FUNCT__
15104a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1511b07ff414SBarry Smith /*@
1512d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1513d763cef2SBarry Smith    the timesteppers.
1514d763cef2SBarry Smith 
15153f9fe445SBarry Smith    Logically Collective on TS
1516d763cef2SBarry Smith 
1517d763cef2SBarry Smith    Input Parameters:
1518d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1519d763cef2SBarry Smith -  usrP - optional user context
1520d763cef2SBarry Smith 
1521d763cef2SBarry Smith    Level: intermediate
1522d763cef2SBarry Smith 
1523d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1524d763cef2SBarry Smith 
1525d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1526d763cef2SBarry Smith @*/
15277087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1528d763cef2SBarry Smith {
1529d763cef2SBarry Smith   PetscFunctionBegin;
15300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1531d763cef2SBarry Smith   ts->user = usrP;
1532d763cef2SBarry Smith   PetscFunctionReturn(0);
1533d763cef2SBarry Smith }
1534d763cef2SBarry Smith 
15354a2ae208SSatish Balay #undef __FUNCT__
15364a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1537b07ff414SBarry Smith /*@
1538d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1539d763cef2SBarry Smith     timestepper.
1540d763cef2SBarry Smith 
1541d763cef2SBarry Smith     Not Collective
1542d763cef2SBarry Smith 
1543d763cef2SBarry Smith     Input Parameter:
1544d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1545d763cef2SBarry Smith 
1546d763cef2SBarry Smith     Output Parameter:
1547d763cef2SBarry Smith .   usrP - user context
1548d763cef2SBarry Smith 
1549d763cef2SBarry Smith     Level: intermediate
1550d763cef2SBarry Smith 
1551d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1552d763cef2SBarry Smith 
1553d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1554d763cef2SBarry Smith @*/
1555e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1556d763cef2SBarry Smith {
1557d763cef2SBarry Smith   PetscFunctionBegin;
15580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1559e71120c6SJed Brown   *(void**)usrP = ts->user;
1560d763cef2SBarry Smith   PetscFunctionReturn(0);
1561d763cef2SBarry Smith }
1562d763cef2SBarry Smith 
15634a2ae208SSatish Balay #undef __FUNCT__
15644a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1565d763cef2SBarry Smith /*@
1566b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1567d763cef2SBarry Smith 
1568d763cef2SBarry Smith    Not Collective
1569d763cef2SBarry Smith 
1570d763cef2SBarry Smith    Input Parameter:
1571d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1572d763cef2SBarry Smith 
1573d763cef2SBarry Smith    Output Parameter:
1574b8123daeSJed Brown .  iter - number of steps completed so far
1575d763cef2SBarry Smith 
1576d763cef2SBarry Smith    Level: intermediate
1577d763cef2SBarry Smith 
1578d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15799be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1580d763cef2SBarry Smith @*/
15817087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1582d763cef2SBarry Smith {
1583d763cef2SBarry Smith   PetscFunctionBegin;
15840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15854482741eSBarry Smith   PetscValidIntPointer(iter,2);
1586d763cef2SBarry Smith   *iter = ts->steps;
1587d763cef2SBarry Smith   PetscFunctionReturn(0);
1588d763cef2SBarry Smith }
1589d763cef2SBarry Smith 
15904a2ae208SSatish Balay #undef __FUNCT__
15914a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1592d763cef2SBarry Smith /*@
1593d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1594d763cef2SBarry Smith    as well as the initial time.
1595d763cef2SBarry Smith 
15963f9fe445SBarry Smith    Logically Collective on TS
1597d763cef2SBarry Smith 
1598d763cef2SBarry Smith    Input Parameters:
1599d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1600d763cef2SBarry Smith .  initial_time - the initial time
1601d763cef2SBarry Smith -  time_step - the size of the timestep
1602d763cef2SBarry Smith 
1603d763cef2SBarry Smith    Level: intermediate
1604d763cef2SBarry Smith 
1605d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1606d763cef2SBarry Smith 
1607d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1608d763cef2SBarry Smith @*/
16097087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1610d763cef2SBarry Smith {
1611e144a568SJed Brown   PetscErrorCode ierr;
1612e144a568SJed Brown 
1613d763cef2SBarry Smith   PetscFunctionBegin;
16140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1615e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1616d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1617d763cef2SBarry Smith   PetscFunctionReturn(0);
1618d763cef2SBarry Smith }
1619d763cef2SBarry Smith 
16204a2ae208SSatish Balay #undef __FUNCT__
16214a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1622d763cef2SBarry Smith /*@
1623d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1624d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1625d763cef2SBarry Smith 
16263f9fe445SBarry Smith    Logically Collective on TS
1627d763cef2SBarry Smith 
1628d763cef2SBarry Smith    Input Parameters:
1629d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1630d763cef2SBarry Smith -  time_step - the size of the timestep
1631d763cef2SBarry Smith 
1632d763cef2SBarry Smith    Level: intermediate
1633d763cef2SBarry Smith 
1634d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1635d763cef2SBarry Smith 
1636d763cef2SBarry Smith .keywords: TS, set, timestep
1637d763cef2SBarry Smith @*/
16387087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1639d763cef2SBarry Smith {
1640d763cef2SBarry Smith   PetscFunctionBegin;
16410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1642c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1643d763cef2SBarry Smith   ts->time_step      = time_step;
164431748224SBarry Smith   ts->time_step_orig = time_step;
1645d763cef2SBarry Smith   PetscFunctionReturn(0);
1646d763cef2SBarry Smith }
1647d763cef2SBarry Smith 
16484a2ae208SSatish Balay #undef __FUNCT__
1649a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1650a43b19c4SJed Brown /*@
165149354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
165249354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
165349354f04SShri Abhyankar      or just return at the final time TS computed.
1654a43b19c4SJed Brown 
1655a43b19c4SJed Brown   Logically Collective on TS
1656a43b19c4SJed Brown 
1657a43b19c4SJed Brown    Input Parameter:
1658a43b19c4SJed Brown +   ts - the time-step context
165949354f04SShri Abhyankar -   eftopt - exact final time option
1660a43b19c4SJed Brown 
1661a43b19c4SJed Brown    Level: beginner
1662a43b19c4SJed Brown 
1663a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1664a43b19c4SJed Brown @*/
166549354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1666a43b19c4SJed Brown {
1667a43b19c4SJed Brown   PetscFunctionBegin;
1668a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
166949354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
167049354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1671a43b19c4SJed Brown   PetscFunctionReturn(0);
1672a43b19c4SJed Brown }
1673a43b19c4SJed Brown 
1674a43b19c4SJed Brown #undef __FUNCT__
16754a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1676d763cef2SBarry Smith /*@
1677d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1678d763cef2SBarry Smith 
1679d763cef2SBarry Smith    Not Collective
1680d763cef2SBarry Smith 
1681d763cef2SBarry Smith    Input Parameter:
1682d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1683d763cef2SBarry Smith 
1684d763cef2SBarry Smith    Output Parameter:
1685d763cef2SBarry Smith .  dt - the current timestep size
1686d763cef2SBarry Smith 
1687d763cef2SBarry Smith    Level: intermediate
1688d763cef2SBarry Smith 
1689d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1690d763cef2SBarry Smith 
1691d763cef2SBarry Smith .keywords: TS, get, timestep
1692d763cef2SBarry Smith @*/
16937087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1694d763cef2SBarry Smith {
1695d763cef2SBarry Smith   PetscFunctionBegin;
16960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1697f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1698d763cef2SBarry Smith   *dt = ts->time_step;
1699d763cef2SBarry Smith   PetscFunctionReturn(0);
1700d763cef2SBarry Smith }
1701d763cef2SBarry Smith 
17024a2ae208SSatish Balay #undef __FUNCT__
17034a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1704d8e5e3e6SSatish Balay /*@
1705d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1706d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1707d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1708d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1709d763cef2SBarry Smith 
1710d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1711d763cef2SBarry Smith 
1712d763cef2SBarry Smith    Input Parameter:
1713d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1714d763cef2SBarry Smith 
1715d763cef2SBarry Smith    Output Parameter:
1716d763cef2SBarry Smith .  v - the vector containing the solution
1717d763cef2SBarry Smith 
1718d763cef2SBarry Smith    Level: intermediate
1719d763cef2SBarry Smith 
1720d763cef2SBarry Smith .seealso: TSGetTimeStep()
1721d763cef2SBarry Smith 
1722d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1723d763cef2SBarry Smith @*/
17247087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1725d763cef2SBarry Smith {
1726d763cef2SBarry Smith   PetscFunctionBegin;
17270700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17284482741eSBarry Smith   PetscValidPointer(v,2);
17298737fe31SLisandro Dalcin   *v = ts->vec_sol;
1730d763cef2SBarry Smith   PetscFunctionReturn(0);
1731d763cef2SBarry Smith }
1732d763cef2SBarry Smith 
1733c235aa8dSHong Zhang #undef __FUNCT__
1734c235aa8dSHong Zhang #define __FUNCT__ "TSGetSensitivity"
1735c235aa8dSHong Zhang /*@
1736c235aa8dSHong Zhang    TSGetSensitivity - Returns the sensitivity in the reverse mode.
1737c235aa8dSHong Zhang 
1738c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1739c235aa8dSHong Zhang 
1740c235aa8dSHong Zhang    Input Parameter:
1741c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1742c235aa8dSHong Zhang 
1743c235aa8dSHong Zhang    Output Parameter:
1744c235aa8dSHong Zhang .  v - the vector containing the solution
1745c235aa8dSHong Zhang 
1746c235aa8dSHong Zhang    Level: intermediate
1747c235aa8dSHong Zhang 
1748c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1749c235aa8dSHong Zhang 
1750c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1751c235aa8dSHong Zhang @*/
1752b18ea86cSHong Zhang PetscErrorCode  TSGetSensitivity(TS ts,Vec **v,PetscInt *numberadjs)
1753c235aa8dSHong Zhang {
1754c235aa8dSHong Zhang   PetscFunctionBegin;
1755c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1756c235aa8dSHong Zhang   PetscValidPointer(v,2);
1757b18ea86cSHong Zhang   *v          = ts->vecs_sensi;
1758b18ea86cSHong Zhang   if(numberadjs) *numberadjs = ts->numberadjs;
1759c235aa8dSHong Zhang   PetscFunctionReturn(0);
1760c235aa8dSHong Zhang }
1761c235aa8dSHong Zhang 
1762bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17634a2ae208SSatish Balay #undef __FUNCT__
1764bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1765d8e5e3e6SSatish Balay /*@
1766bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1767d763cef2SBarry Smith 
1768bdad233fSMatthew Knepley   Not collective
1769d763cef2SBarry Smith 
1770bdad233fSMatthew Knepley   Input Parameters:
1771bdad233fSMatthew Knepley + ts   - The TS
1772bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1773d763cef2SBarry Smith .vb
17740910c330SBarry Smith          U_t - A U = 0      (linear)
17750910c330SBarry Smith          U_t - A(t) U = 0   (linear)
17760910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1777d763cef2SBarry Smith .ve
1778d763cef2SBarry Smith 
1779d763cef2SBarry Smith    Level: beginner
1780d763cef2SBarry Smith 
1781bdad233fSMatthew Knepley .keywords: TS, problem type
1782bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1783d763cef2SBarry Smith @*/
17847087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1785a7cc72afSBarry Smith {
17869e2a6581SJed Brown   PetscErrorCode ierr;
17879e2a6581SJed Brown 
1788d763cef2SBarry Smith   PetscFunctionBegin;
17890700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1790bdad233fSMatthew Knepley   ts->problem_type = type;
17919e2a6581SJed Brown   if (type == TS_LINEAR) {
17929e2a6581SJed Brown     SNES snes;
17939e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17949e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17959e2a6581SJed Brown   }
1796d763cef2SBarry Smith   PetscFunctionReturn(0);
1797d763cef2SBarry Smith }
1798d763cef2SBarry Smith 
1799bdad233fSMatthew Knepley #undef __FUNCT__
1800bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1801bdad233fSMatthew Knepley /*@C
1802bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1803bdad233fSMatthew Knepley 
1804bdad233fSMatthew Knepley   Not collective
1805bdad233fSMatthew Knepley 
1806bdad233fSMatthew Knepley   Input Parameter:
1807bdad233fSMatthew Knepley . ts   - The TS
1808bdad233fSMatthew Knepley 
1809bdad233fSMatthew Knepley   Output Parameter:
1810bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1811bdad233fSMatthew Knepley .vb
1812089b2837SJed Brown          M U_t = A U
1813089b2837SJed Brown          M(t) U_t = A(t) U
1814b5abc632SBarry Smith          F(t,U,U_t)
1815bdad233fSMatthew Knepley .ve
1816bdad233fSMatthew Knepley 
1817bdad233fSMatthew Knepley    Level: beginner
1818bdad233fSMatthew Knepley 
1819bdad233fSMatthew Knepley .keywords: TS, problem type
1820bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1821bdad233fSMatthew Knepley @*/
18227087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1823a7cc72afSBarry Smith {
1824bdad233fSMatthew Knepley   PetscFunctionBegin;
18250700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18264482741eSBarry Smith   PetscValidIntPointer(type,2);
1827bdad233fSMatthew Knepley   *type = ts->problem_type;
1828bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1829bdad233fSMatthew Knepley }
1830d763cef2SBarry Smith 
18314a2ae208SSatish Balay #undef __FUNCT__
18324a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1833d763cef2SBarry Smith /*@
1834d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1835d763cef2SBarry Smith    of a timestepper.
1836d763cef2SBarry Smith 
1837d763cef2SBarry Smith    Collective on TS
1838d763cef2SBarry Smith 
1839d763cef2SBarry Smith    Input Parameter:
1840d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1841d763cef2SBarry Smith 
1842d763cef2SBarry Smith    Notes:
1843d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1844d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1845d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1846d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1847d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1848d763cef2SBarry Smith 
1849d763cef2SBarry Smith    Level: advanced
1850d763cef2SBarry Smith 
1851d763cef2SBarry Smith .keywords: TS, timestep, setup
1852d763cef2SBarry Smith 
1853d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1854d763cef2SBarry Smith @*/
18557087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1856d763cef2SBarry Smith {
1857dfbe8321SBarry Smith   PetscErrorCode ierr;
18586c6b9e74SPeter Brune   DM             dm;
18596c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1860d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18616c6b9e74SPeter Brune   TSIJacobian    ijac;
18626c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1863d763cef2SBarry Smith 
1864d763cef2SBarry Smith   PetscFunctionBegin;
18650700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1866277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1867277b19d0SLisandro Dalcin 
18687adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18699596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1870d763cef2SBarry Smith   }
1871277b19d0SLisandro Dalcin 
1872277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1873277b19d0SLisandro Dalcin 
1874b18ea86cSHong Zhang   if (ts->reverse_mode && !ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSensitivity() first");
1875c235aa8dSHong Zhang 
1876552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
18771c3436cfSJed Brown 
1878e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1879e1244c69SJed Brown     Mat Amat,Pmat;
1880e1244c69SJed Brown     SNES snes;
1881e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1882e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1883e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1884e1244c69SJed Brown      * have displaced the RHS matrix */
1885e1244c69SJed Brown     if (Amat == ts->Arhs) {
1886e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1887e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1888e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1889e1244c69SJed Brown     }
1890e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1891e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1892e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1893e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1894e1244c69SJed Brown     }
1895e1244c69SJed Brown   }
1896277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1897000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1898277b19d0SLisandro Dalcin   }
1899277b19d0SLisandro Dalcin 
19006c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
19016c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
19026c6b9e74SPeter Brune    */
19036c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
19040298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
19056c6b9e74SPeter Brune   if (!func) {
19066c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
19076c6b9e74SPeter Brune   }
19086c6b9e74SPeter Brune   /* if the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
19096c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
19106c6b9e74SPeter Brune    */
19110298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
19120298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
19130298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
19146c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
19156c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
19166c6b9e74SPeter Brune   }
1917277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1918277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1919277b19d0SLisandro Dalcin }
1920277b19d0SLisandro Dalcin 
1921277b19d0SLisandro Dalcin #undef __FUNCT__
1922277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1923277b19d0SLisandro Dalcin /*@
1924277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1925277b19d0SLisandro Dalcin 
1926277b19d0SLisandro Dalcin    Collective on TS
1927277b19d0SLisandro Dalcin 
1928277b19d0SLisandro Dalcin    Input Parameter:
1929277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1930277b19d0SLisandro Dalcin 
1931277b19d0SLisandro Dalcin    Level: beginner
1932277b19d0SLisandro Dalcin 
1933277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1934277b19d0SLisandro Dalcin 
1935277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1936277b19d0SLisandro Dalcin @*/
1937277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1938277b19d0SLisandro Dalcin {
1939277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1940277b19d0SLisandro Dalcin 
1941277b19d0SLisandro Dalcin   PetscFunctionBegin;
1942277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1943b18ea86cSHong Zhang 
1944277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1945277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1946277b19d0SLisandro Dalcin   }
1947277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1948bbd56ea5SKarl Rupp 
19494e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
19504e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1951214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
19526bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1953e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1954e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
195538637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1956b18ea86cSHong Zhang   if (ts->reverse_mode) {
1957f8fee759SHong Zhang     ts->vecs_sensi = 0;
1958ad8e2604SHong Zhang     if (ts->vecs_sensip) {
1959f8fee759SHong Zhang       ts->vecs_sensip = 0;
1960ad8e2604SHong Zhang       ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
1961ad8e2604SHong Zhang     }
1962b18ea86cSHong Zhang   }
1963277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1964d763cef2SBarry Smith   PetscFunctionReturn(0);
1965d763cef2SBarry Smith }
1966d763cef2SBarry Smith 
19674a2ae208SSatish Balay #undef __FUNCT__
19684a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1969d8e5e3e6SSatish Balay /*@
1970d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1971d763cef2SBarry Smith    with TSCreate().
1972d763cef2SBarry Smith 
1973d763cef2SBarry Smith    Collective on TS
1974d763cef2SBarry Smith 
1975d763cef2SBarry Smith    Input Parameter:
1976d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1977d763cef2SBarry Smith 
1978d763cef2SBarry Smith    Level: beginner
1979d763cef2SBarry Smith 
1980d763cef2SBarry Smith .keywords: TS, timestepper, destroy
1981d763cef2SBarry Smith 
1982d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
1983d763cef2SBarry Smith @*/
19846bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
1985d763cef2SBarry Smith {
19866849ba73SBarry Smith   PetscErrorCode ierr;
1987d763cef2SBarry Smith 
1988d763cef2SBarry Smith   PetscFunctionBegin;
19896bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
19906bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
19916bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
1992d763cef2SBarry Smith 
19936bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
1994277b19d0SLisandro Dalcin 
1995e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
1996e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
19976bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
19986d4c513bSLisandro Dalcin 
199984df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2000aeb4809dSShri Abhyankar   if ((*ts)->event) {
2001aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2002aeb4809dSShri Abhyankar   }
20036bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20046bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20056bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20066d4c513bSLisandro Dalcin 
2007a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2008d763cef2SBarry Smith   PetscFunctionReturn(0);
2009d763cef2SBarry Smith }
2010d763cef2SBarry Smith 
20114a2ae208SSatish Balay #undef __FUNCT__
20124a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2013d8e5e3e6SSatish Balay /*@
2014d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2015d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2016d763cef2SBarry Smith 
2017d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2018d763cef2SBarry Smith 
2019d763cef2SBarry Smith    Input Parameter:
2020d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2021d763cef2SBarry Smith 
2022d763cef2SBarry Smith    Output Parameter:
2023d763cef2SBarry Smith .  snes - the nonlinear solver context
2024d763cef2SBarry Smith 
2025d763cef2SBarry Smith    Notes:
2026d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2027d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
202894b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2029d763cef2SBarry Smith 
2030d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20310298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2032d763cef2SBarry Smith 
2033d763cef2SBarry Smith    Level: beginner
2034d763cef2SBarry Smith 
2035d763cef2SBarry Smith .keywords: timestep, get, SNES
2036d763cef2SBarry Smith @*/
20377087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2038d763cef2SBarry Smith {
2039d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2040d372ba47SLisandro Dalcin 
2041d763cef2SBarry Smith   PetscFunctionBegin;
20420700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20434482741eSBarry Smith   PetscValidPointer(snes,2);
2044d372ba47SLisandro Dalcin   if (!ts->snes) {
2045ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20460298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20473bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2048d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2049496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20509e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20519e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20529e2a6581SJed Brown     }
2053d372ba47SLisandro Dalcin   }
2054d763cef2SBarry Smith   *snes = ts->snes;
2055d763cef2SBarry Smith   PetscFunctionReturn(0);
2056d763cef2SBarry Smith }
2057d763cef2SBarry Smith 
20584a2ae208SSatish Balay #undef __FUNCT__
2059deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2060deb2cd25SJed Brown /*@
2061deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2062deb2cd25SJed Brown 
2063deb2cd25SJed Brown    Collective
2064deb2cd25SJed Brown 
2065deb2cd25SJed Brown    Input Parameter:
2066deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2067deb2cd25SJed Brown -  snes - the nonlinear solver context
2068deb2cd25SJed Brown 
2069deb2cd25SJed Brown    Notes:
2070deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2071deb2cd25SJed Brown 
2072deb2cd25SJed Brown    Level: developer
2073deb2cd25SJed Brown 
2074deb2cd25SJed Brown .keywords: timestep, set, SNES
2075deb2cd25SJed Brown @*/
2076deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2077deb2cd25SJed Brown {
2078deb2cd25SJed Brown   PetscErrorCode ierr;
2079d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2080deb2cd25SJed Brown 
2081deb2cd25SJed Brown   PetscFunctionBegin;
2082deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2083deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2084deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2085deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2086bbd56ea5SKarl Rupp 
2087deb2cd25SJed Brown   ts->snes = snes;
2088bbd56ea5SKarl Rupp 
20890298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20900298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2091740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
20920298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2093740132f1SEmil Constantinescu   }
2094deb2cd25SJed Brown   PetscFunctionReturn(0);
2095deb2cd25SJed Brown }
2096deb2cd25SJed Brown 
2097deb2cd25SJed Brown #undef __FUNCT__
209894b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2099d8e5e3e6SSatish Balay /*@
210094b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2101d763cef2SBarry Smith    a TS (timestepper) context.
2102d763cef2SBarry Smith 
210394b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2104d763cef2SBarry Smith 
2105d763cef2SBarry Smith    Input Parameter:
2106d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2107d763cef2SBarry Smith 
2108d763cef2SBarry Smith    Output Parameter:
210994b7f48cSBarry Smith .  ksp - the nonlinear solver context
2110d763cef2SBarry Smith 
2111d763cef2SBarry Smith    Notes:
211294b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2113d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2114d763cef2SBarry Smith    KSP and PC contexts as well.
2115d763cef2SBarry Smith 
211694b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21170298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2118d763cef2SBarry Smith 
2119d763cef2SBarry Smith    Level: beginner
2120d763cef2SBarry Smith 
212194b7f48cSBarry Smith .keywords: timestep, get, KSP
2122d763cef2SBarry Smith @*/
21237087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2124d763cef2SBarry Smith {
2125d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2126089b2837SJed Brown   SNES           snes;
2127d372ba47SLisandro Dalcin 
2128d763cef2SBarry Smith   PetscFunctionBegin;
21290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21304482741eSBarry Smith   PetscValidPointer(ksp,2);
213117186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2132e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2133089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2134089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2135d763cef2SBarry Smith   PetscFunctionReturn(0);
2136d763cef2SBarry Smith }
2137d763cef2SBarry Smith 
2138d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2139d763cef2SBarry Smith 
21404a2ae208SSatish Balay #undef __FUNCT__
2141adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2142adb62b0dSMatthew Knepley /*@
2143adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2144adb62b0dSMatthew Knepley    maximum time for iteration.
2145adb62b0dSMatthew Knepley 
21463f9fe445SBarry Smith    Not Collective
2147adb62b0dSMatthew Knepley 
2148adb62b0dSMatthew Knepley    Input Parameters:
2149adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21500298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21510298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2152adb62b0dSMatthew Knepley 
2153adb62b0dSMatthew Knepley    Level: intermediate
2154adb62b0dSMatthew Knepley 
2155adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2156adb62b0dSMatthew Knepley @*/
21577087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2158adb62b0dSMatthew Knepley {
2159adb62b0dSMatthew Knepley   PetscFunctionBegin;
21600700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2161abc0a331SBarry Smith   if (maxsteps) {
21624482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2163adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2164adb62b0dSMatthew Knepley   }
2165abc0a331SBarry Smith   if (maxtime) {
21664482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2167adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2168adb62b0dSMatthew Knepley   }
2169adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2170adb62b0dSMatthew Knepley }
2171adb62b0dSMatthew Knepley 
2172adb62b0dSMatthew Knepley #undef __FUNCT__
21734a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2174d763cef2SBarry Smith /*@
2175d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2176d763cef2SBarry Smith    maximum time for iteration.
2177d763cef2SBarry Smith 
21783f9fe445SBarry Smith    Logically Collective on TS
2179d763cef2SBarry Smith 
2180d763cef2SBarry Smith    Input Parameters:
2181d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2182d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2183d763cef2SBarry Smith -  maxtime - final time to iterate to
2184d763cef2SBarry Smith 
2185d763cef2SBarry Smith    Options Database Keys:
2186d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
21873bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2188d763cef2SBarry Smith 
2189d763cef2SBarry Smith    Notes:
2190d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2191d763cef2SBarry Smith 
2192d763cef2SBarry Smith    Level: intermediate
2193d763cef2SBarry Smith 
2194d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2195a43b19c4SJed Brown 
2196a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2197d763cef2SBarry Smith @*/
21987087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2199d763cef2SBarry Smith {
2200d763cef2SBarry Smith   PetscFunctionBegin;
22010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2202c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2203c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
220439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
220539b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2206d763cef2SBarry Smith   PetscFunctionReturn(0);
2207d763cef2SBarry Smith }
2208d763cef2SBarry Smith 
22094a2ae208SSatish Balay #undef __FUNCT__
22104a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2211d763cef2SBarry Smith /*@
2212d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2213d763cef2SBarry Smith    for use by the TS routines.
2214d763cef2SBarry Smith 
22153f9fe445SBarry Smith    Logically Collective on TS and Vec
2216d763cef2SBarry Smith 
2217d763cef2SBarry Smith    Input Parameters:
2218d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22190910c330SBarry Smith -  u - the solution vector
2220d763cef2SBarry Smith 
2221d763cef2SBarry Smith    Level: beginner
2222d763cef2SBarry Smith 
2223d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2224d763cef2SBarry Smith @*/
22250910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2226d763cef2SBarry Smith {
22278737fe31SLisandro Dalcin   PetscErrorCode ierr;
2228496e6a7aSJed Brown   DM             dm;
22298737fe31SLisandro Dalcin 
2230d763cef2SBarry Smith   PetscFunctionBegin;
22310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22320910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22330910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22346bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2235bbd56ea5SKarl Rupp 
22360910c330SBarry Smith   ts->vec_sol = u;
2237bbd56ea5SKarl Rupp 
2238496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22390910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2240d763cef2SBarry Smith   PetscFunctionReturn(0);
2241d763cef2SBarry Smith }
2242d763cef2SBarry Smith 
2243e74ef692SMatthew Knepley #undef __FUNCT__
2244c235aa8dSHong Zhang #define __FUNCT__ "TSSetSensitivity"
2245c235aa8dSHong Zhang /*@
2246ad8e2604SHong Zhang    TSSetSensitivity - Sets the initial value of sensitivity (w.r.t. initial conditions)
2247c235aa8dSHong Zhang    for use by the TS routines.
2248c235aa8dSHong Zhang 
2249c235aa8dSHong Zhang    Logically Collective on TS and Vec
2250c235aa8dSHong Zhang 
2251c235aa8dSHong Zhang    Input Parameters:
2252c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2253c235aa8dSHong Zhang -  u - the solution vector
2254c235aa8dSHong Zhang 
2255c235aa8dSHong Zhang    Level: beginner
2256c235aa8dSHong Zhang 
2257c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2258c235aa8dSHong Zhang @*/
2259b18ea86cSHong Zhang PetscErrorCode  TSSetSensitivity(TS ts,Vec *u,PetscInt numberadjs)
2260c235aa8dSHong Zhang {
2261c235aa8dSHong Zhang   PetscFunctionBegin;
2262c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2263b18ea86cSHong Zhang   PetscValidPointer(u,2);
2264b18ea86cSHong Zhang   ts->vecs_sensi = u;
2265ad8e2604SHong Zhang   if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of adjoint variables (3rd parameter) is inconsistent with the one set by TSSetSensitivityP()");
2266b18ea86cSHong Zhang   ts->numberadjs = numberadjs;
2267c235aa8dSHong Zhang 
2268ad8e2604SHong Zhang   PetscFunctionReturn(0);
2269ad8e2604SHong Zhang }
2270ad8e2604SHong Zhang 
2271ad8e2604SHong Zhang #undef __FUNCT__
2272ad8e2604SHong Zhang #define __FUNCT__ "TSSetSensitivityP"
2273ad8e2604SHong Zhang /*@
2274ad8e2604SHong Zhang    TSSetSensitivityP - Sets the initial value of sensitivity (w.r.t. parameters)
2275ad8e2604SHong Zhang    for use by the TS routines.
2276ad8e2604SHong Zhang 
2277ad8e2604SHong Zhang    Logically Collective on TS and Vec
2278ad8e2604SHong Zhang 
2279ad8e2604SHong Zhang    Input Parameters:
2280ad8e2604SHong Zhang +  ts - the TS context obtained from TSCreate()
2281ad8e2604SHong Zhang -  u - the solution vector
2282ad8e2604SHong Zhang 
2283ad8e2604SHong Zhang    Level: beginner
2284ad8e2604SHong Zhang 
2285ad8e2604SHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2286ad8e2604SHong Zhang @*/
2287ad8e2604SHong Zhang PetscErrorCode  TSSetSensitivityP(TS ts,Vec *u,PetscInt numberadjs)
2288ad8e2604SHong Zhang {
2289ad8e2604SHong Zhang   PetscFunctionBegin;
2290ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2291ad8e2604SHong Zhang   PetscValidPointer(u,2);
2292ad8e2604SHong Zhang   ts->vecs_sensip = u;
2293ad8e2604SHong Zhang   if(ts->numberadjs && ts->numberadjs!=numberadjs) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of adjoint variables (3rd parameter) is inconsistent with the one set by TSSetSensitivity()");
2294ad8e2604SHong Zhang   ts->numberadjs = numberadjs;
2295ad8e2604SHong Zhang 
2296ad8e2604SHong Zhang   PetscFunctionReturn(0);
2297ad8e2604SHong Zhang }
2298ad8e2604SHong Zhang 
2299ad8e2604SHong Zhang #undef __FUNCT__
2300ad8e2604SHong Zhang #define __FUNCT__ "TSSetRHSJacobianP"
2301ad8e2604SHong Zhang /*@C
2302ad8e2604SHong Zhang   TSSetRHSJacobianP - Sets the function that computes the Jacobian w.r.t. parameters.
2303ad8e2604SHong Zhang 
2304ad8e2604SHong Zhang   Logically Collective on TS
2305ad8e2604SHong Zhang 
2306ad8e2604SHong Zhang   Input Parameters:
2307ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2308ad8e2604SHong Zhang - func - The function
2309ad8e2604SHong Zhang 
2310ad8e2604SHong Zhang   Calling sequence of func:
2311ad8e2604SHong Zhang . func (TS ts);
2312ad8e2604SHong Zhang 
2313ad8e2604SHong Zhang   Level: intermediate
2314ad8e2604SHong Zhang 
2315ad8e2604SHong Zhang 
2316ad8e2604SHong Zhang .keywords: TS, sensitivity
2317ad8e2604SHong Zhang .seealso:
2318ad8e2604SHong Zhang @*/
2319ad8e2604SHong Zhang PetscErrorCode  TSSetRHSJacobianP(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2320ad8e2604SHong Zhang {
2321ad8e2604SHong Zhang   PetscErrorCode ierr;
2322ad8e2604SHong Zhang 
2323ad8e2604SHong Zhang   PetscFunctionBegin;
2324ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2325ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2326ad8e2604SHong Zhang 
2327ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2328ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2329ad8e2604SHong Zhang   if(Amat) {
2330ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2331ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2332ad8e2604SHong Zhang 
2333ad8e2604SHong Zhang     ts->Jacp = Amat;
2334ad8e2604SHong Zhang   }
2335ad8e2604SHong Zhang   PetscFunctionReturn(0);
2336ad8e2604SHong Zhang }
2337ad8e2604SHong Zhang 
2338ad8e2604SHong Zhang #undef __FUNCT__
2339ad8e2604SHong Zhang #define __FUNCT__ "TSRHSJacobianP"
2340ad8e2604SHong Zhang /*@
2341ad8e2604SHong Zhang   TSRHSJacobianP - Runs the user-defined JacobianP function.
2342ad8e2604SHong Zhang 
2343ad8e2604SHong Zhang   Collective on TS
2344ad8e2604SHong Zhang 
2345ad8e2604SHong Zhang   Input Parameters:
2346ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2347ad8e2604SHong Zhang 
2348ad8e2604SHong Zhang   Notes:
2349ad8e2604SHong Zhang   TSJacobianP() is typically used for sensitivity implementation,
2350ad8e2604SHong Zhang   so most users would not generally call this routine themselves.
2351ad8e2604SHong Zhang 
2352ad8e2604SHong Zhang   Level: developer
2353ad8e2604SHong Zhang 
2354ad8e2604SHong Zhang .keywords: TS, sensitivity
2355ad8e2604SHong Zhang .seealso: TSSetRHSJacobianP()
2356ad8e2604SHong Zhang @*/
2357ad8e2604SHong Zhang PetscErrorCode  TSRHSJacobianP(TS ts,PetscReal t,Vec X,Mat Amat)
2358ad8e2604SHong Zhang {
2359ad8e2604SHong Zhang   PetscErrorCode ierr;
2360ad8e2604SHong Zhang 
2361ad8e2604SHong Zhang   PetscFunctionBegin;
2362ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2363ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2364ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2365ad8e2604SHong Zhang 
2366ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2367ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2368ad8e2604SHong Zhang   PetscStackPop;
2369ad8e2604SHong Zhang 
2370c235aa8dSHong Zhang   PetscFunctionReturn(0);
2371c235aa8dSHong Zhang }
2372c235aa8dSHong Zhang 
2373c235aa8dSHong Zhang #undef __FUNCT__
2374e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2375ac226902SBarry Smith /*@C
2376000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
23773f2090d5SJed Brown   called once at the beginning of each time step.
2378000e7ae3SMatthew Knepley 
23793f9fe445SBarry Smith   Logically Collective on TS
2380000e7ae3SMatthew Knepley 
2381000e7ae3SMatthew Knepley   Input Parameters:
2382000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2383000e7ae3SMatthew Knepley - func - The function
2384000e7ae3SMatthew Knepley 
2385000e7ae3SMatthew Knepley   Calling sequence of func:
2386000e7ae3SMatthew Knepley . func (TS ts);
2387000e7ae3SMatthew Knepley 
2388000e7ae3SMatthew Knepley   Level: intermediate
2389000e7ae3SMatthew Knepley 
2390b8123daeSJed Brown   Note:
2391b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2392b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2393b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2394b8123daeSJed Brown 
2395000e7ae3SMatthew Knepley .keywords: TS, timestep
23969be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2397000e7ae3SMatthew Knepley @*/
23987087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2399000e7ae3SMatthew Knepley {
2400000e7ae3SMatthew Knepley   PetscFunctionBegin;
24010700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2402ae60f76fSBarry Smith   ts->prestep = func;
2403000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2404000e7ae3SMatthew Knepley }
2405000e7ae3SMatthew Knepley 
2406e74ef692SMatthew Knepley #undef __FUNCT__
24073f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
240809ee8438SJed Brown /*@
24093f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
24103f2090d5SJed Brown 
24113f2090d5SJed Brown   Collective on TS
24123f2090d5SJed Brown 
24133f2090d5SJed Brown   Input Parameters:
24143f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
24153f2090d5SJed Brown 
24163f2090d5SJed Brown   Notes:
24173f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
24183f2090d5SJed Brown   so most users would not generally call this routine themselves.
24193f2090d5SJed Brown 
24203f2090d5SJed Brown   Level: developer
24213f2090d5SJed Brown 
24223f2090d5SJed Brown .keywords: TS, timestep
24239be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
24243f2090d5SJed Brown @*/
24257087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
24263f2090d5SJed Brown {
24273f2090d5SJed Brown   PetscErrorCode ierr;
24283f2090d5SJed Brown 
24293f2090d5SJed Brown   PetscFunctionBegin;
24300700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2431ae60f76fSBarry Smith   if (ts->prestep) {
2432ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2433312ce896SJed Brown   }
24343f2090d5SJed Brown   PetscFunctionReturn(0);
24353f2090d5SJed Brown }
24363f2090d5SJed Brown 
24373f2090d5SJed Brown #undef __FUNCT__
2438b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2439b8123daeSJed Brown /*@C
2440b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2441b8123daeSJed Brown   called once at the beginning of each stage.
2442b8123daeSJed Brown 
2443b8123daeSJed Brown   Logically Collective on TS
2444b8123daeSJed Brown 
2445b8123daeSJed Brown   Input Parameters:
2446b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2447b8123daeSJed Brown - func - The function
2448b8123daeSJed Brown 
2449b8123daeSJed Brown   Calling sequence of func:
2450b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2451b8123daeSJed Brown 
2452b8123daeSJed Brown   Level: intermediate
2453b8123daeSJed Brown 
2454b8123daeSJed Brown   Note:
2455b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2456b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2457b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2458b8123daeSJed Brown 
2459b8123daeSJed Brown .keywords: TS, timestep
24609be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2461b8123daeSJed Brown @*/
2462b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2463b8123daeSJed Brown {
2464b8123daeSJed Brown   PetscFunctionBegin;
2465b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2466ae60f76fSBarry Smith   ts->prestage = func;
2467b8123daeSJed Brown   PetscFunctionReturn(0);
2468b8123daeSJed Brown }
2469b8123daeSJed Brown 
2470b8123daeSJed Brown #undef __FUNCT__
24719be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
24729be3e283SDebojyoti Ghosh /*@C
24739be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
24749be3e283SDebojyoti Ghosh   called once at the end of each stage.
24759be3e283SDebojyoti Ghosh 
24769be3e283SDebojyoti Ghosh   Logically Collective on TS
24779be3e283SDebojyoti Ghosh 
24789be3e283SDebojyoti Ghosh   Input Parameters:
24799be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
24809be3e283SDebojyoti Ghosh - func - The function
24819be3e283SDebojyoti Ghosh 
24829be3e283SDebojyoti Ghosh   Calling sequence of func:
24839be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
24849be3e283SDebojyoti Ghosh 
24859be3e283SDebojyoti Ghosh   Level: intermediate
24869be3e283SDebojyoti Ghosh 
24879be3e283SDebojyoti Ghosh   Note:
24889be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
24899be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
24909be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
24919be3e283SDebojyoti Ghosh 
24929be3e283SDebojyoti Ghosh .keywords: TS, timestep
24939be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
24949be3e283SDebojyoti Ghosh @*/
24959be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
24969be3e283SDebojyoti Ghosh {
24979be3e283SDebojyoti Ghosh   PetscFunctionBegin;
24989be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
24999be3e283SDebojyoti Ghosh   ts->poststage = func;
25009be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
25019be3e283SDebojyoti Ghosh }
25029be3e283SDebojyoti Ghosh 
25039be3e283SDebojyoti Ghosh #undef __FUNCT__
2504b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2505b8123daeSJed Brown /*@
2506b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2507b8123daeSJed Brown 
2508b8123daeSJed Brown   Collective on TS
2509b8123daeSJed Brown 
2510b8123daeSJed Brown   Input Parameters:
2511b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
25129be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2513b8123daeSJed Brown 
2514b8123daeSJed Brown   Notes:
2515b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2516b8123daeSJed Brown   most users would not generally call this routine themselves.
2517b8123daeSJed Brown 
2518b8123daeSJed Brown   Level: developer
2519b8123daeSJed Brown 
2520b8123daeSJed Brown .keywords: TS, timestep
25219be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2522b8123daeSJed Brown @*/
2523b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2524b8123daeSJed Brown {
2525b8123daeSJed Brown   PetscErrorCode ierr;
2526b8123daeSJed Brown 
2527b8123daeSJed Brown   PetscFunctionBegin;
2528b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2529ae60f76fSBarry Smith   if (ts->prestage) {
2530ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2531b8123daeSJed Brown   }
2532b8123daeSJed Brown   PetscFunctionReturn(0);
2533b8123daeSJed Brown }
2534b8123daeSJed Brown 
2535b8123daeSJed Brown #undef __FUNCT__
25369be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
25379be3e283SDebojyoti Ghosh /*@
25389be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
25399be3e283SDebojyoti Ghosh 
25409be3e283SDebojyoti Ghosh   Collective on TS
25419be3e283SDebojyoti Ghosh 
25429be3e283SDebojyoti Ghosh   Input Parameters:
25439be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
25449be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
25459be3e283SDebojyoti Ghosh   stageindex  - Stage number
25469be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
25479be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
25489be3e283SDebojyoti Ghosh 
25499be3e283SDebojyoti Ghosh   Notes:
25509be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
25519be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
25529be3e283SDebojyoti Ghosh 
25539be3e283SDebojyoti Ghosh   Level: developer
25549be3e283SDebojyoti Ghosh 
25559be3e283SDebojyoti Ghosh .keywords: TS, timestep
25569be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
25579be3e283SDebojyoti Ghosh @*/
25589be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
25599be3e283SDebojyoti Ghosh {
25609be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
25619be3e283SDebojyoti Ghosh 
25629be3e283SDebojyoti Ghosh   PetscFunctionBegin;
25639be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25644beae5d8SLisandro Dalcin   if (ts->poststage) {
25659be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
25669be3e283SDebojyoti Ghosh   }
25679be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
25689be3e283SDebojyoti Ghosh }
25699be3e283SDebojyoti Ghosh 
25709be3e283SDebojyoti Ghosh #undef __FUNCT__
2571e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2572ac226902SBarry Smith /*@C
2573000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
25743f2090d5SJed Brown   called once at the end of each time step.
2575000e7ae3SMatthew Knepley 
25763f9fe445SBarry Smith   Logically Collective on TS
2577000e7ae3SMatthew Knepley 
2578000e7ae3SMatthew Knepley   Input Parameters:
2579000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2580000e7ae3SMatthew Knepley - func - The function
2581000e7ae3SMatthew Knepley 
2582000e7ae3SMatthew Knepley   Calling sequence of func:
2583b8123daeSJed Brown $ func (TS ts);
2584000e7ae3SMatthew Knepley 
2585000e7ae3SMatthew Knepley   Level: intermediate
2586000e7ae3SMatthew Knepley 
2587000e7ae3SMatthew Knepley .keywords: TS, timestep
2588b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2589000e7ae3SMatthew Knepley @*/
25907087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2591000e7ae3SMatthew Knepley {
2592000e7ae3SMatthew Knepley   PetscFunctionBegin;
25930700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2594ae60f76fSBarry Smith   ts->poststep = func;
2595000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2596000e7ae3SMatthew Knepley }
2597000e7ae3SMatthew Knepley 
2598e74ef692SMatthew Knepley #undef __FUNCT__
25993f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
260009ee8438SJed Brown /*@
26013f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
26023f2090d5SJed Brown 
26033f2090d5SJed Brown   Collective on TS
26043f2090d5SJed Brown 
26053f2090d5SJed Brown   Input Parameters:
26063f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26073f2090d5SJed Brown 
26083f2090d5SJed Brown   Notes:
26093f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
26103f2090d5SJed Brown   so most users would not generally call this routine themselves.
26113f2090d5SJed Brown 
26123f2090d5SJed Brown   Level: developer
26133f2090d5SJed Brown 
26143f2090d5SJed Brown .keywords: TS, timestep
26153f2090d5SJed Brown @*/
26167087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
26173f2090d5SJed Brown {
26183f2090d5SJed Brown   PetscErrorCode ierr;
26193f2090d5SJed Brown 
26203f2090d5SJed Brown   PetscFunctionBegin;
26210700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2622ae60f76fSBarry Smith   if (ts->poststep) {
2623ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
262472ac3e02SJed Brown   }
26253f2090d5SJed Brown   PetscFunctionReturn(0);
26263f2090d5SJed Brown }
26273f2090d5SJed Brown 
2628d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2629d763cef2SBarry Smith 
26304a2ae208SSatish Balay #undef __FUNCT__
2631a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2632d763cef2SBarry Smith /*@C
2633a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2634d763cef2SBarry Smith    timestep to display the iteration's  progress.
2635d763cef2SBarry Smith 
26363f9fe445SBarry Smith    Logically Collective on TS
2637d763cef2SBarry Smith 
2638d763cef2SBarry Smith    Input Parameters:
2639d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2640e213d8f1SJed Brown .  monitor - monitoring routine
2641329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
26420298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2643b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
26440298fd71SBarry Smith           (may be NULL)
2645d763cef2SBarry Smith 
2646e213d8f1SJed Brown    Calling sequence of monitor:
26470910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2648d763cef2SBarry Smith 
2649d763cef2SBarry Smith +    ts - the TS context
265088c05cc5SBarry 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
265188c05cc5SBarry Smith                                been interpolated to)
26521f06c33eSBarry Smith .    time - current time
26530910c330SBarry Smith .    u - current iterate
2654d763cef2SBarry Smith -    mctx - [optional] monitoring context
2655d763cef2SBarry Smith 
2656d763cef2SBarry Smith    Notes:
2657d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2658d763cef2SBarry Smith    already has been loaded.
2659d763cef2SBarry Smith 
2660025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2661025f1a04SBarry Smith 
2662d763cef2SBarry Smith    Level: intermediate
2663d763cef2SBarry Smith 
2664d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2665d763cef2SBarry Smith 
2666a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2667d763cef2SBarry Smith @*/
2668c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2669d763cef2SBarry Smith {
2670d763cef2SBarry Smith   PetscFunctionBegin;
26710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
267217186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2673d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
26748704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2675d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2676d763cef2SBarry Smith   PetscFunctionReturn(0);
2677d763cef2SBarry Smith }
2678d763cef2SBarry Smith 
26794a2ae208SSatish Balay #undef __FUNCT__
2680a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2681d763cef2SBarry Smith /*@C
2682a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2683d763cef2SBarry Smith 
26843f9fe445SBarry Smith    Logically Collective on TS
2685d763cef2SBarry Smith 
2686d763cef2SBarry Smith    Input Parameters:
2687d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2688d763cef2SBarry Smith 
2689d763cef2SBarry Smith    Notes:
2690d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2691d763cef2SBarry Smith 
2692d763cef2SBarry Smith    Level: intermediate
2693d763cef2SBarry Smith 
2694d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2695d763cef2SBarry Smith 
2696a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2697d763cef2SBarry Smith @*/
26987087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2699d763cef2SBarry Smith {
2700d952e501SBarry Smith   PetscErrorCode ierr;
2701d952e501SBarry Smith   PetscInt       i;
2702d952e501SBarry Smith 
2703d763cef2SBarry Smith   PetscFunctionBegin;
27040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2705d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
27068704b422SBarry Smith     if (ts->monitordestroy[i]) {
27078704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2708d952e501SBarry Smith     }
2709d952e501SBarry Smith   }
2710d763cef2SBarry Smith   ts->numbermonitors = 0;
2711d763cef2SBarry Smith   PetscFunctionReturn(0);
2712d763cef2SBarry Smith }
2713d763cef2SBarry Smith 
27144a2ae208SSatish Balay #undef __FUNCT__
2715a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2716d8e5e3e6SSatish Balay /*@
2717a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
27185516499fSSatish Balay 
27195516499fSSatish Balay    Level: intermediate
272041251cbbSSatish Balay 
27215516499fSSatish Balay .keywords: TS, set, monitor
27225516499fSSatish Balay 
272341251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
272441251cbbSSatish Balay @*/
2725649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2726d763cef2SBarry Smith {
2727dfbe8321SBarry Smith   PetscErrorCode ierr;
2728ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2729d132466eSBarry Smith 
2730d763cef2SBarry Smith   PetscFunctionBegin;
2731649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2732971832b6SBarry Smith   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g\n",step,(double)ts->time_step,(double)ptime);CHKERRQ(ierr);
2733649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2734d763cef2SBarry Smith   PetscFunctionReturn(0);
2735d763cef2SBarry Smith }
2736d763cef2SBarry Smith 
27374a2ae208SSatish Balay #undef __FUNCT__
2738cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2739cd652676SJed Brown /*@
2740cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2741cd652676SJed Brown 
2742cd652676SJed Brown    Logically Collective on TS
2743cd652676SJed Brown 
2744cd652676SJed Brown    Input Argument:
2745cd652676SJed Brown .  ts - time stepping context
2746cd652676SJed Brown 
2747cd652676SJed Brown    Output Argument:
2748cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2749cd652676SJed Brown 
2750cd652676SJed Brown    Level: intermediate
2751cd652676SJed Brown 
2752cd652676SJed Brown .keywords: TS, set
2753cd652676SJed Brown 
2754cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
2755cd652676SJed Brown @*/
2756cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2757cd652676SJed Brown {
2758cd652676SJed Brown   PetscFunctionBegin;
2759cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2760cd652676SJed Brown   ts->retain_stages = flg;
2761cd652676SJed Brown   PetscFunctionReturn(0);
2762cd652676SJed Brown }
2763cd652676SJed Brown 
2764cd652676SJed Brown #undef __FUNCT__
2765cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
2766cd652676SJed Brown /*@
2767cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2768cd652676SJed Brown 
2769cd652676SJed Brown    Collective on TS
2770cd652676SJed Brown 
2771cd652676SJed Brown    Input Argument:
2772cd652676SJed Brown +  ts - time stepping context
2773cd652676SJed Brown -  t - time to interpolate to
2774cd652676SJed Brown 
2775cd652676SJed Brown    Output Argument:
27760910c330SBarry Smith .  U - state at given time
2777cd652676SJed Brown 
2778cd652676SJed Brown    Notes:
2779cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
2780cd652676SJed Brown 
2781cd652676SJed Brown    Level: intermediate
2782cd652676SJed Brown 
2783cd652676SJed Brown    Developer Notes:
2784cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
2785cd652676SJed Brown 
2786cd652676SJed Brown .keywords: TS, set
2787cd652676SJed Brown 
2788cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
2789cd652676SJed Brown @*/
27900910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
2791cd652676SJed Brown {
2792cd652676SJed Brown   PetscErrorCode ierr;
2793cd652676SJed Brown 
2794cd652676SJed Brown   PetscFunctionBegin;
2795cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2796b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
27976712e2f1SBarry 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);
2798ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
27990910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
2800cd652676SJed Brown   PetscFunctionReturn(0);
2801cd652676SJed Brown }
2802cd652676SJed Brown 
2803cd652676SJed Brown #undef __FUNCT__
28044a2ae208SSatish Balay #define __FUNCT__ "TSStep"
2805d763cef2SBarry Smith /*@
28066d9e5789SSean Farley    TSStep - Steps one time step
2807d763cef2SBarry Smith 
2808d763cef2SBarry Smith    Collective on TS
2809d763cef2SBarry Smith 
2810d763cef2SBarry Smith    Input Parameter:
2811d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2812d763cef2SBarry Smith 
28136d9e5789SSean Farley    Level: intermediate
2814d763cef2SBarry Smith 
2815b8123daeSJed Brown    Notes:
2816b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
2817b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
2818b8123daeSJed Brown 
281925cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
282025cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
282125cb2221SBarry Smith 
2822d763cef2SBarry Smith .keywords: TS, timestep, solve
2823d763cef2SBarry Smith 
28249be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
2825d763cef2SBarry Smith @*/
2826193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
2827d763cef2SBarry Smith {
28282fb8446cSMatthew G. Knepley   DM               dm;
2829dfbe8321SBarry Smith   PetscErrorCode   ierr;
2830fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
2831d763cef2SBarry Smith 
2832d763cef2SBarry Smith   PetscFunctionBegin;
28330700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2834fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
2835fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
2836fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
2837fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
2838fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
2839fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
2840fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
2841fffbeea8SBarry Smith 
28422fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
2843d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
2844d405a339SMatthew Knepley 
2845362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
284624655328SShri   ts->ptime_prev = ts->ptime;
2847cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
28484e9ba7eeSMatthew G. Knepley   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
2849bbd56ea5SKarl Rupp 
2850e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
2851d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2852d2daff3dSHong Zhang   if(ts->reverse_mode) {
2853d2daff3dSHong Zhang     if(!ts->ops->stepadj) {
2854d2daff3dSHong 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);
2855d2daff3dSHong Zhang     }else {
2856d2daff3dSHong Zhang       ierr = (*ts->ops->stepadj)(ts);CHKERRQ(ierr);
2857d2daff3dSHong Zhang     }
2858d2daff3dSHong Zhang   }else {
2859193ac0bcSJed Brown     ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
2860d2daff3dSHong Zhang   }
2861d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
2862bbd56ea5SKarl Rupp 
286324655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
2864cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
2865362cd11cSLisandro Dalcin 
2866362cd11cSLisandro Dalcin   if (ts->reason < 0) {
2867cef5090cSJed Brown     if (ts->errorifstepfailed) {
2868cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
2869ce94432eSBarry 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]);
28702a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
28712a3a10ceSLisandro 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]);
2872ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
2873cef5090cSJed Brown     }
2874362cd11cSLisandro Dalcin   } else if (!ts->reason) {
2875db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
2876db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
2877362cd11cSLisandro Dalcin   }
2878d763cef2SBarry Smith   PetscFunctionReturn(0);
2879d763cef2SBarry Smith }
2880d763cef2SBarry Smith 
28814a2ae208SSatish Balay #undef __FUNCT__
288205175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
288305175c85SJed Brown /*@
288405175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
288505175c85SJed Brown 
28861c3436cfSJed Brown    Collective on TS
288705175c85SJed Brown 
288805175c85SJed Brown    Input Arguments:
28891c3436cfSJed Brown +  ts - time stepping context
28901c3436cfSJed Brown .  order - desired order of accuracy
28910298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
289205175c85SJed Brown 
289305175c85SJed Brown    Output Arguments:
28940910c330SBarry Smith .  U - state at the end of the current step
289505175c85SJed Brown 
289605175c85SJed Brown    Level: advanced
289705175c85SJed Brown 
2898108c343cSJed Brown    Notes:
2899108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
2900108c343cSJed 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.
2901108c343cSJed Brown 
29021c3436cfSJed Brown .seealso: TSStep(), TSAdapt
290305175c85SJed Brown @*/
29040910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
290505175c85SJed Brown {
290605175c85SJed Brown   PetscErrorCode ierr;
290705175c85SJed Brown 
290805175c85SJed Brown   PetscFunctionBegin;
290905175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
291005175c85SJed Brown   PetscValidType(ts,1);
29110910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
2912ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
29130910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
291405175c85SJed Brown   PetscFunctionReturn(0);
291505175c85SJed Brown }
291605175c85SJed Brown 
291705175c85SJed Brown #undef __FUNCT__
29186a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
29196a4d4014SLisandro Dalcin /*@
29206a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
29216a4d4014SLisandro Dalcin 
29226a4d4014SLisandro Dalcin    Collective on TS
29236a4d4014SLisandro Dalcin 
29246a4d4014SLisandro Dalcin    Input Parameter:
29256a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
2926cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
29275a3a76d0SJed Brown 
29286a4d4014SLisandro Dalcin    Level: beginner
29296a4d4014SLisandro Dalcin 
29305a3a76d0SJed Brown    Notes:
29315a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
29325a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
29335a3a76d0SJed Brown    stepped over the final time.
29345a3a76d0SJed Brown 
29356a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
29366a4d4014SLisandro Dalcin 
29376a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
29386a4d4014SLisandro Dalcin @*/
2939cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
29406a4d4014SLisandro Dalcin {
2941b06615a5SLisandro Dalcin   Vec               solution;
29426a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
2943f22f69f0SBarry Smith 
29446a4d4014SLisandro Dalcin   PetscFunctionBegin;
29450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2946f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
2947d2daff3dSHong 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 */
2948b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
29490910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
2950b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
2951b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
2952b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
29535a3a76d0SJed Brown     }
29540910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
2955bbd56ea5SKarl Rupp   } else if (u) {
29560910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
29575a3a76d0SJed Brown   }
2958d2daff3dSHong Zhang   ierr = TSSetUp(ts);CHKERRQ(ierr); /*compute adj coefficients if the reverse mode is on*/
29596a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
2960193ac0bcSJed Brown   ts->steps             = 0;
29615ef26d82SJed Brown   ts->ksp_its           = 0;
29625ef26d82SJed Brown   ts->snes_its          = 0;
2963c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
2964c610991cSLisandro Dalcin   ts->reject            = 0;
2965193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
2966193ac0bcSJed Brown 
2967ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
2968f05ece33SBarry Smith 
2969193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
2970193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
29710910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
2972cc708dedSBarry Smith     ts->solvetime = ts->ptime;
2973193ac0bcSJed Brown   } else {
29746a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
2975db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
2976d2daff3dSHong Zhang     else if (!ts->reverse_mode && ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
2977e1a7a14fSJed Brown     while (!ts->reason) {
2978d2daff3dSHong Zhang       if(!ts->reverse_mode) {
2979b06615a5SLisandro Dalcin         ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2980d2daff3dSHong Zhang       }else {
2981d2daff3dSHong Zhang         ierr = TSMonitor(ts,ts->max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
2982d2daff3dSHong Zhang       }
2983193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
2984aeb4809dSShri Abhyankar       if (ts->event) {
2985aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
29861eda64f1SShri Abhyankar 	if (ts->event->status != TSEVENT_PROCESSING) {
29871eda64f1SShri Abhyankar 	  ierr = TSPostStep(ts);CHKERRQ(ierr);
29881eda64f1SShri Abhyankar 	}
29891eda64f1SShri Abhyankar       } else {
29901eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
2991aeb4809dSShri Abhyankar       }
2992193ac0bcSJed Brown     }
2993d2daff3dSHong Zhang     if (!ts->reverse_mode && ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
29940910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
2995cc708dedSBarry Smith       ts->solvetime = ts->max_time;
2996b06615a5SLisandro Dalcin       solution = u;
29970574a7fbSJed Brown     } else {
2998ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
2999cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3000b06615a5SLisandro Dalcin       solution = ts->vec_sol;
30010574a7fbSJed Brown     }
3002d2daff3dSHong Zhang     if(!ts->reverse_mode) {
3003b06615a5SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3004d2daff3dSHong Zhang     }
30054e9ba7eeSMatthew G. Knepley     ierr = VecViewFromOptions(u, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3006193ac0bcSJed Brown   }
3007d2daff3dSHong Zhang 
3008ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
300956f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
30106a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
30116a4d4014SLisandro Dalcin }
30126a4d4014SLisandro Dalcin 
30136a4d4014SLisandro Dalcin #undef __FUNCT__
30144a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
3015228d79bcSJed Brown /*@
3016228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3017228d79bcSJed Brown 
3018228d79bcSJed Brown    Collective on TS
3019228d79bcSJed Brown 
3020228d79bcSJed Brown    Input Parameters:
3021228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3022228d79bcSJed Brown .  step - step number that has just completed
3023228d79bcSJed Brown .  ptime - model time of the state
30240910c330SBarry Smith -  u - state at the current model time
3025228d79bcSJed Brown 
3026228d79bcSJed Brown    Notes:
3027228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
3028228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
3029228d79bcSJed Brown 
3030228d79bcSJed Brown    Level: advanced
3031228d79bcSJed Brown 
3032228d79bcSJed Brown .keywords: TS, timestep
3033228d79bcSJed Brown @*/
30340910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3035d763cef2SBarry Smith {
30366849ba73SBarry Smith   PetscErrorCode ierr;
3037a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3038d763cef2SBarry Smith 
3039d763cef2SBarry Smith   PetscFunctionBegin;
3040b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3041b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
30425edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3043d763cef2SBarry Smith   for (i=0; i<n; i++) {
30440910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3045d763cef2SBarry Smith   }
30465edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3047d763cef2SBarry Smith   PetscFunctionReturn(0);
3048d763cef2SBarry Smith }
3049d763cef2SBarry Smith 
3050d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
30514a2ae208SSatish Balay #undef __FUNCT__
3052a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3053d763cef2SBarry Smith /*@C
3054a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
3055a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3056d763cef2SBarry Smith 
3057d763cef2SBarry Smith    Collective on TS
3058d763cef2SBarry Smith 
3059d763cef2SBarry Smith    Input Parameters:
3060d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3061d763cef2SBarry Smith .  label - the title to put in the title bar
30627c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3063a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3064a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3065d763cef2SBarry Smith 
3066d763cef2SBarry Smith    Output Parameter:
30670b039ecaSBarry Smith .  ctx - the context
3068d763cef2SBarry Smith 
3069d763cef2SBarry Smith    Options Database Key:
30704f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
30714f09c107SBarry Smith .  -ts_monitor_lg_solution -
307299fdda47SBarry Smith .  -ts_monitor_lg_error -
307399fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
307499fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
307599fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
3076d763cef2SBarry Smith 
3077d763cef2SBarry Smith    Notes:
3078a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3079d763cef2SBarry Smith 
3080d763cef2SBarry Smith    Level: intermediate
3081d763cef2SBarry Smith 
30827c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
3083d763cef2SBarry Smith 
30844f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
30857c922b88SBarry Smith 
3086d763cef2SBarry Smith @*/
3087a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3088d763cef2SBarry Smith {
3089b0a32e0cSBarry Smith   PetscDraw      win;
3090dfbe8321SBarry Smith   PetscErrorCode ierr;
3091d763cef2SBarry Smith 
3092d763cef2SBarry Smith   PetscFunctionBegin;
3093b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3094a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
30953fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
30960b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
30973bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3098287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3099287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3100a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3101d763cef2SBarry Smith   PetscFunctionReturn(0);
3102d763cef2SBarry Smith }
3103d763cef2SBarry Smith 
31044a2ae208SSatish Balay #undef __FUNCT__
31054f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3106b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3107d763cef2SBarry Smith {
31080b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3109c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3110dfbe8321SBarry Smith   PetscErrorCode ierr;
3111d763cef2SBarry Smith 
3112d763cef2SBarry Smith   PetscFunctionBegin;
3113b06615a5SLisandro Dalcin   if (!step) {
3114a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3115a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3116a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3117a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3118287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3119a9f9c1f6SBarry Smith   }
3120c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
31210b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3122b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
31230b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
31243923b477SBarry Smith   }
3125d763cef2SBarry Smith   PetscFunctionReturn(0);
3126d763cef2SBarry Smith }
3127d763cef2SBarry Smith 
31284a2ae208SSatish Balay #undef __FUNCT__
3129a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3130d763cef2SBarry Smith /*@C
3131a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3132a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3133d763cef2SBarry Smith 
31340b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3135d763cef2SBarry Smith 
3136d763cef2SBarry Smith    Input Parameter:
31370b039ecaSBarry Smith .  ctx - the monitor context
3138d763cef2SBarry Smith 
3139d763cef2SBarry Smith    Level: intermediate
3140d763cef2SBarry Smith 
3141d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3142d763cef2SBarry Smith 
31434f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3144d763cef2SBarry Smith @*/
3145a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3146d763cef2SBarry Smith {
3147b0a32e0cSBarry Smith   PetscDraw      draw;
3148dfbe8321SBarry Smith   PetscErrorCode ierr;
3149d763cef2SBarry Smith 
3150d763cef2SBarry Smith   PetscFunctionBegin;
31510b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
31526bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
31530b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
31540b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3155d763cef2SBarry Smith   PetscFunctionReturn(0);
3156d763cef2SBarry Smith }
3157d763cef2SBarry Smith 
31584a2ae208SSatish Balay #undef __FUNCT__
31594a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3160d763cef2SBarry Smith /*@
3161b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3162d763cef2SBarry Smith 
3163d763cef2SBarry Smith    Not Collective
3164d763cef2SBarry Smith 
3165d763cef2SBarry Smith    Input Parameter:
3166d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3167d763cef2SBarry Smith 
3168d763cef2SBarry Smith    Output Parameter:
3169d763cef2SBarry Smith .  t  - the current time
3170d763cef2SBarry Smith 
3171d763cef2SBarry Smith    Level: beginner
3172d763cef2SBarry Smith 
3173b8123daeSJed Brown    Note:
3174b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
31759be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3176b8123daeSJed Brown 
3177d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3178d763cef2SBarry Smith 
3179d763cef2SBarry Smith .keywords: TS, get, time
3180d763cef2SBarry Smith @*/
31817087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3182d763cef2SBarry Smith {
3183d763cef2SBarry Smith   PetscFunctionBegin;
31840700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3185f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3186d763cef2SBarry Smith   *t = ts->ptime;
3187d763cef2SBarry Smith   PetscFunctionReturn(0);
3188d763cef2SBarry Smith }
3189d763cef2SBarry Smith 
31904a2ae208SSatish Balay #undef __FUNCT__
3191e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3192e5e524a1SHong Zhang /*@
3193e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3194e5e524a1SHong Zhang 
3195e5e524a1SHong Zhang    Not Collective
3196e5e524a1SHong Zhang 
3197e5e524a1SHong Zhang    Input Parameter:
3198e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3199e5e524a1SHong Zhang 
3200e5e524a1SHong Zhang    Output Parameter:
3201e5e524a1SHong Zhang .  t  - the previous time
3202e5e524a1SHong Zhang 
3203e5e524a1SHong Zhang    Level: beginner
3204e5e524a1SHong Zhang 
3205e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3206e5e524a1SHong Zhang 
3207e5e524a1SHong Zhang .keywords: TS, get, time
3208e5e524a1SHong Zhang @*/
3209e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3210e5e524a1SHong Zhang {
3211e5e524a1SHong Zhang   PetscFunctionBegin;
3212e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3213e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3214e5e524a1SHong Zhang   *t = ts->ptime_prev;
3215e5e524a1SHong Zhang   PetscFunctionReturn(0);
3216e5e524a1SHong Zhang }
3217e5e524a1SHong Zhang 
3218e5e524a1SHong Zhang #undef __FUNCT__
32196a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
32206a4d4014SLisandro Dalcin /*@
32216a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
32226a4d4014SLisandro Dalcin 
32233f9fe445SBarry Smith    Logically Collective on TS
32246a4d4014SLisandro Dalcin 
32256a4d4014SLisandro Dalcin    Input Parameters:
32266a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
32276a4d4014SLisandro Dalcin -  time - the time
32286a4d4014SLisandro Dalcin 
32296a4d4014SLisandro Dalcin    Level: intermediate
32306a4d4014SLisandro Dalcin 
32316a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
32326a4d4014SLisandro Dalcin 
32336a4d4014SLisandro Dalcin .keywords: TS, set, time
32346a4d4014SLisandro Dalcin @*/
32357087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
32366a4d4014SLisandro Dalcin {
32376a4d4014SLisandro Dalcin   PetscFunctionBegin;
32380700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3239c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
32406a4d4014SLisandro Dalcin   ts->ptime = t;
32416a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
32426a4d4014SLisandro Dalcin }
32436a4d4014SLisandro Dalcin 
32446a4d4014SLisandro Dalcin #undef __FUNCT__
32454a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3246d763cef2SBarry Smith /*@C
3247d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3248d763cef2SBarry Smith    TS options in the database.
3249d763cef2SBarry Smith 
32503f9fe445SBarry Smith    Logically Collective on TS
3251d763cef2SBarry Smith 
3252d763cef2SBarry Smith    Input Parameter:
3253d763cef2SBarry Smith +  ts     - The TS context
3254d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3255d763cef2SBarry Smith 
3256d763cef2SBarry Smith    Notes:
3257d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3258d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3259d763cef2SBarry Smith    hyphen.
3260d763cef2SBarry Smith 
3261d763cef2SBarry Smith    Level: advanced
3262d763cef2SBarry Smith 
3263d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3264d763cef2SBarry Smith 
3265d763cef2SBarry Smith .seealso: TSSetFromOptions()
3266d763cef2SBarry Smith 
3267d763cef2SBarry Smith @*/
32687087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3269d763cef2SBarry Smith {
3270dfbe8321SBarry Smith   PetscErrorCode ierr;
3271089b2837SJed Brown   SNES           snes;
3272d763cef2SBarry Smith 
3273d763cef2SBarry Smith   PetscFunctionBegin;
32740700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3275d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3276089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3277089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3278d763cef2SBarry Smith   PetscFunctionReturn(0);
3279d763cef2SBarry Smith }
3280d763cef2SBarry Smith 
3281d763cef2SBarry Smith 
32824a2ae208SSatish Balay #undef __FUNCT__
32834a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3284d763cef2SBarry Smith /*@C
3285d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3286d763cef2SBarry Smith    TS options in the database.
3287d763cef2SBarry Smith 
32883f9fe445SBarry Smith    Logically Collective on TS
3289d763cef2SBarry Smith 
3290d763cef2SBarry Smith    Input Parameter:
3291d763cef2SBarry Smith +  ts     - The TS context
3292d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3293d763cef2SBarry Smith 
3294d763cef2SBarry Smith    Notes:
3295d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3296d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3297d763cef2SBarry Smith    hyphen.
3298d763cef2SBarry Smith 
3299d763cef2SBarry Smith    Level: advanced
3300d763cef2SBarry Smith 
3301d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3302d763cef2SBarry Smith 
3303d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3304d763cef2SBarry Smith 
3305d763cef2SBarry Smith @*/
33067087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3307d763cef2SBarry Smith {
3308dfbe8321SBarry Smith   PetscErrorCode ierr;
3309089b2837SJed Brown   SNES           snes;
3310d763cef2SBarry Smith 
3311d763cef2SBarry Smith   PetscFunctionBegin;
33120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3313d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3314089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3315089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3316d763cef2SBarry Smith   PetscFunctionReturn(0);
3317d763cef2SBarry Smith }
3318d763cef2SBarry Smith 
33194a2ae208SSatish Balay #undef __FUNCT__
33204a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3321d763cef2SBarry Smith /*@C
3322d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3323d763cef2SBarry Smith    TS options in the database.
3324d763cef2SBarry Smith 
3325d763cef2SBarry Smith    Not Collective
3326d763cef2SBarry Smith 
3327d763cef2SBarry Smith    Input Parameter:
3328d763cef2SBarry Smith .  ts - The TS context
3329d763cef2SBarry Smith 
3330d763cef2SBarry Smith    Output Parameter:
3331d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3332d763cef2SBarry Smith 
3333d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3334d763cef2SBarry Smith    sufficient length to hold the prefix.
3335d763cef2SBarry Smith 
3336d763cef2SBarry Smith    Level: intermediate
3337d763cef2SBarry Smith 
3338d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3339d763cef2SBarry Smith 
3340d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3341d763cef2SBarry Smith @*/
33427087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3343d763cef2SBarry Smith {
3344dfbe8321SBarry Smith   PetscErrorCode ierr;
3345d763cef2SBarry Smith 
3346d763cef2SBarry Smith   PetscFunctionBegin;
33470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
33484482741eSBarry Smith   PetscValidPointer(prefix,2);
3349d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3350d763cef2SBarry Smith   PetscFunctionReturn(0);
3351d763cef2SBarry Smith }
3352d763cef2SBarry Smith 
33534a2ae208SSatish Balay #undef __FUNCT__
33544a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3355d763cef2SBarry Smith /*@C
3356d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3357d763cef2SBarry Smith 
3358d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3359d763cef2SBarry Smith 
3360d763cef2SBarry Smith    Input Parameter:
3361d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3362d763cef2SBarry Smith 
3363d763cef2SBarry Smith    Output Parameters:
3364e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3365e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3366e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3367e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3368d763cef2SBarry Smith 
33690298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3370d763cef2SBarry Smith 
3371d763cef2SBarry Smith    Level: intermediate
3372d763cef2SBarry Smith 
337326d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3374d763cef2SBarry Smith 
3375d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3376d763cef2SBarry Smith @*/
3377e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3378d763cef2SBarry Smith {
3379089b2837SJed Brown   PetscErrorCode ierr;
3380089b2837SJed Brown   SNES           snes;
338124989b8cSPeter Brune   DM             dm;
3382089b2837SJed Brown 
3383d763cef2SBarry Smith   PetscFunctionBegin;
3384089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3385e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
338624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
338724989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3388d763cef2SBarry Smith   PetscFunctionReturn(0);
3389d763cef2SBarry Smith }
3390d763cef2SBarry Smith 
33911713a123SBarry Smith #undef __FUNCT__
33922eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
33932eca1d9cSJed Brown /*@C
33942eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
33952eca1d9cSJed Brown 
33962eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
33972eca1d9cSJed Brown 
33982eca1d9cSJed Brown    Input Parameter:
33992eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
34002eca1d9cSJed Brown 
34012eca1d9cSJed Brown    Output Parameters:
3402e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3403e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
34042eca1d9cSJed Brown .  f   - The function to compute the matrices
34052eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
34062eca1d9cSJed Brown 
34070298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
34082eca1d9cSJed Brown 
34092eca1d9cSJed Brown    Level: advanced
34102eca1d9cSJed Brown 
34112eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
34122eca1d9cSJed Brown 
34132eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
34142eca1d9cSJed Brown @*/
3415e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
34162eca1d9cSJed Brown {
3417089b2837SJed Brown   PetscErrorCode ierr;
3418089b2837SJed Brown   SNES           snes;
341924989b8cSPeter Brune   DM             dm;
34200910c330SBarry Smith 
34212eca1d9cSJed Brown   PetscFunctionBegin;
3422089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3423f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3424e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
342524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
342624989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
34272eca1d9cSJed Brown   PetscFunctionReturn(0);
34282eca1d9cSJed Brown }
34292eca1d9cSJed Brown 
34306083293cSBarry Smith 
34312eca1d9cSJed Brown #undef __FUNCT__
343283a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
34331713a123SBarry Smith /*@C
343483a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
34351713a123SBarry Smith    VecView() for the solution at each timestep
34361713a123SBarry Smith 
34371713a123SBarry Smith    Collective on TS
34381713a123SBarry Smith 
34391713a123SBarry Smith    Input Parameters:
34401713a123SBarry Smith +  ts - the TS context
34411713a123SBarry Smith .  step - current time-step
3442142b95e3SSatish Balay .  ptime - current time
34430298fd71SBarry Smith -  dummy - either a viewer or NULL
34441713a123SBarry Smith 
344599fdda47SBarry Smith    Options Database:
344699fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
344799fdda47SBarry Smith 
344899fdda47SBarry 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
344999fdda47SBarry Smith        will look bad
345099fdda47SBarry Smith 
34511713a123SBarry Smith    Level: intermediate
34521713a123SBarry Smith 
34531713a123SBarry Smith .keywords: TS,  vector, monitor, view
34541713a123SBarry Smith 
3455a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
34561713a123SBarry Smith @*/
34570910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
34581713a123SBarry Smith {
3459dfbe8321SBarry Smith   PetscErrorCode   ierr;
346083a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3461473a3ab2SBarry Smith   PetscDraw        draw;
34621713a123SBarry Smith 
34631713a123SBarry Smith   PetscFunctionBegin;
34646083293cSBarry Smith   if (!step && ictx->showinitial) {
34656083293cSBarry Smith     if (!ictx->initialsolution) {
34660910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
34671713a123SBarry Smith     }
34680910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
34696083293cSBarry Smith   }
3470b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
34710dcf80beSBarry Smith 
34726083293cSBarry Smith   if (ictx->showinitial) {
34736083293cSBarry Smith     PetscReal pause;
34746083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
34756083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
34766083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
34776083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
34786083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
34796083293cSBarry Smith   }
34800910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3481473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3482473a3ab2SBarry Smith     PetscReal xl,yl,xr,yr,tw,w,h;
3483473a3ab2SBarry Smith     char      time[32];
3484473a3ab2SBarry Smith     size_t    len;
3485473a3ab2SBarry Smith 
3486473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
3487473a3ab2SBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
3488473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3489473a3ab2SBarry Smith     ierr =  PetscStrlen(time,&len);CHKERRQ(ierr);
34900298fd71SBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3491473a3ab2SBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
3492473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3493473a3ab2SBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3494473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3495473a3ab2SBarry Smith   }
3496473a3ab2SBarry Smith 
34976083293cSBarry Smith   if (ictx->showinitial) {
34986083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
34996083293cSBarry Smith   }
35001713a123SBarry Smith   PetscFunctionReturn(0);
35011713a123SBarry Smith }
35021713a123SBarry Smith 
35032d5ee99bSBarry Smith #undef __FUNCT__
35042d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
35052d5ee99bSBarry Smith /*@C
35062d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
35072d5ee99bSBarry Smith 
35082d5ee99bSBarry Smith    Collective on TS
35092d5ee99bSBarry Smith 
35102d5ee99bSBarry Smith    Input Parameters:
35112d5ee99bSBarry Smith +  ts - the TS context
35122d5ee99bSBarry Smith .  step - current time-step
35132d5ee99bSBarry Smith .  ptime - current time
35142d5ee99bSBarry Smith -  dummy - either a viewer or NULL
35152d5ee99bSBarry Smith 
35162d5ee99bSBarry Smith    Level: intermediate
35172d5ee99bSBarry Smith 
35182d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
35192d5ee99bSBarry Smith 
35202d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
35212d5ee99bSBarry Smith @*/
35222d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
35232d5ee99bSBarry Smith {
35242d5ee99bSBarry Smith   PetscErrorCode    ierr;
35252d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
35262d5ee99bSBarry Smith   PetscDraw         draw;
35272d5ee99bSBarry Smith   MPI_Comm          comm;
35282d5ee99bSBarry Smith   PetscInt          n;
35292d5ee99bSBarry Smith   PetscMPIInt       size;
35302d5ee99bSBarry Smith   PetscReal         xl,yl,xr,yr,tw,w,h;
35312d5ee99bSBarry Smith   char              time[32];
35322d5ee99bSBarry Smith   size_t            len;
35332d5ee99bSBarry Smith   const PetscScalar *U;
35342d5ee99bSBarry Smith 
35352d5ee99bSBarry Smith   PetscFunctionBegin;
35362d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
35372d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
35382d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
35392d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
35402d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
35412d5ee99bSBarry Smith 
35422d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
35432d5ee99bSBarry Smith 
35442d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
35454b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3546ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3547a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3548a4494fc1SBarry Smith       PetscFunctionReturn(0);
3549a4494fc1SBarry Smith   }
35502d5ee99bSBarry Smith   if (!step) ictx->color++;
35512d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
35522d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
35532d5ee99bSBarry Smith 
35542d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
35554b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
35562d5ee99bSBarry Smith     ierr = PetscSNPrintf(time,32,"Timestep %d Time %f",(int)step,(double)ptime);CHKERRQ(ierr);
35572d5ee99bSBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
35582d5ee99bSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
35592d5ee99bSBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
35602d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
35612d5ee99bSBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
35622d5ee99bSBarry Smith   }
35632d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
35642d5ee99bSBarry Smith   PetscFunctionReturn(0);
35652d5ee99bSBarry Smith }
35662d5ee99bSBarry Smith 
35671713a123SBarry Smith 
35686c699258SBarry Smith #undef __FUNCT__
356983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
35706083293cSBarry Smith /*@C
357183a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
35726083293cSBarry Smith 
35736083293cSBarry Smith    Collective on TS
35746083293cSBarry Smith 
35756083293cSBarry Smith    Input Parameters:
35766083293cSBarry Smith .    ctx - the monitor context
35776083293cSBarry Smith 
35786083293cSBarry Smith    Level: intermediate
35796083293cSBarry Smith 
35806083293cSBarry Smith .keywords: TS,  vector, monitor, view
35816083293cSBarry Smith 
358283a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
35836083293cSBarry Smith @*/
358483a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
35856083293cSBarry Smith {
35866083293cSBarry Smith   PetscErrorCode ierr;
35876083293cSBarry Smith 
35886083293cSBarry Smith   PetscFunctionBegin;
35894b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
359083a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
359183a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
359283a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
35936083293cSBarry Smith   PetscFunctionReturn(0);
35946083293cSBarry Smith }
35956083293cSBarry Smith 
35966083293cSBarry Smith #undef __FUNCT__
359783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
35986083293cSBarry Smith /*@C
359983a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
36006083293cSBarry Smith 
36016083293cSBarry Smith    Collective on TS
36026083293cSBarry Smith 
36036083293cSBarry Smith    Input Parameter:
36046083293cSBarry Smith .    ts - time-step context
36056083293cSBarry Smith 
36066083293cSBarry Smith    Output Patameter:
36076083293cSBarry Smith .    ctx - the monitor context
36086083293cSBarry Smith 
360999fdda47SBarry Smith    Options Database:
361099fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
361199fdda47SBarry Smith 
36126083293cSBarry Smith    Level: intermediate
36136083293cSBarry Smith 
36146083293cSBarry Smith .keywords: TS,  vector, monitor, view
36156083293cSBarry Smith 
361683a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
36176083293cSBarry Smith @*/
361883a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
36196083293cSBarry Smith {
36206083293cSBarry Smith   PetscErrorCode   ierr;
36216083293cSBarry Smith 
36226083293cSBarry Smith   PetscFunctionBegin;
3623b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
362483a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3625e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3626bbd56ea5SKarl Rupp 
362783a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3628473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
36290298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3630473a3ab2SBarry Smith 
3631473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
36320298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
36332d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
36346083293cSBarry Smith   PetscFunctionReturn(0);
36356083293cSBarry Smith }
36366083293cSBarry Smith 
36376083293cSBarry Smith #undef __FUNCT__
363883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
36393a471f94SBarry Smith /*@C
364083a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
36413a471f94SBarry Smith    VecView() for the error at each timestep
36423a471f94SBarry Smith 
36433a471f94SBarry Smith    Collective on TS
36443a471f94SBarry Smith 
36453a471f94SBarry Smith    Input Parameters:
36463a471f94SBarry Smith +  ts - the TS context
36473a471f94SBarry Smith .  step - current time-step
36483a471f94SBarry Smith .  ptime - current time
36490298fd71SBarry Smith -  dummy - either a viewer or NULL
36503a471f94SBarry Smith 
36513a471f94SBarry Smith    Level: intermediate
36523a471f94SBarry Smith 
36533a471f94SBarry Smith .keywords: TS,  vector, monitor, view
36543a471f94SBarry Smith 
36553a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
36563a471f94SBarry Smith @*/
36570910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
36583a471f94SBarry Smith {
36593a471f94SBarry Smith   PetscErrorCode   ierr;
366083a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
366183a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
36623a471f94SBarry Smith   Vec              work;
36633a471f94SBarry Smith 
36643a471f94SBarry Smith   PetscFunctionBegin;
3665b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
36660910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
36673a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
36680910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
36693a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
36703a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
36713a471f94SBarry Smith   PetscFunctionReturn(0);
36723a471f94SBarry Smith }
36733a471f94SBarry Smith 
36742a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
36753a471f94SBarry Smith #undef __FUNCT__
36766c699258SBarry Smith #define __FUNCT__ "TSSetDM"
36776c699258SBarry Smith /*@
36786c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
36796c699258SBarry Smith 
36803f9fe445SBarry Smith    Logically Collective on TS and DM
36816c699258SBarry Smith 
36826c699258SBarry Smith    Input Parameters:
36836c699258SBarry Smith +  ts - the preconditioner context
36846c699258SBarry Smith -  dm - the dm
36856c699258SBarry Smith 
36866c699258SBarry Smith    Level: intermediate
36876c699258SBarry Smith 
36886c699258SBarry Smith 
36896c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
36906c699258SBarry Smith @*/
36917087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
36926c699258SBarry Smith {
36936c699258SBarry Smith   PetscErrorCode ierr;
3694089b2837SJed Brown   SNES           snes;
3695942e3340SBarry Smith   DMTS           tsdm;
36966c699258SBarry Smith 
36976c699258SBarry Smith   PetscFunctionBegin;
36980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
369970663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
3700942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
37012a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
3702942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
3703942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
370424989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
370524989b8cSPeter Brune         tsdm->originaldm = dm;
370624989b8cSPeter Brune       }
370724989b8cSPeter Brune     }
37086bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
370924989b8cSPeter Brune   }
37106c699258SBarry Smith   ts->dm = dm;
3711bbd56ea5SKarl Rupp 
3712089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3713089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
37146c699258SBarry Smith   PetscFunctionReturn(0);
37156c699258SBarry Smith }
37166c699258SBarry Smith 
37176c699258SBarry Smith #undef __FUNCT__
37186c699258SBarry Smith #define __FUNCT__ "TSGetDM"
37196c699258SBarry Smith /*@
37206c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
37216c699258SBarry Smith 
37223f9fe445SBarry Smith    Not Collective
37236c699258SBarry Smith 
37246c699258SBarry Smith    Input Parameter:
37256c699258SBarry Smith . ts - the preconditioner context
37266c699258SBarry Smith 
37276c699258SBarry Smith    Output Parameter:
37286c699258SBarry Smith .  dm - the dm
37296c699258SBarry Smith 
37306c699258SBarry Smith    Level: intermediate
37316c699258SBarry Smith 
37326c699258SBarry Smith 
37336c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
37346c699258SBarry Smith @*/
37357087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
37366c699258SBarry Smith {
3737496e6a7aSJed Brown   PetscErrorCode ierr;
3738496e6a7aSJed Brown 
37396c699258SBarry Smith   PetscFunctionBegin;
37400700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3741496e6a7aSJed Brown   if (!ts->dm) {
3742ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
3743496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
3744496e6a7aSJed Brown   }
37456c699258SBarry Smith   *dm = ts->dm;
37466c699258SBarry Smith   PetscFunctionReturn(0);
37476c699258SBarry Smith }
37481713a123SBarry Smith 
37490f5c6efeSJed Brown #undef __FUNCT__
37500f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
37510f5c6efeSJed Brown /*@
37520f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
37530f5c6efeSJed Brown 
37543f9fe445SBarry Smith    Logically Collective on SNES
37550f5c6efeSJed Brown 
37560f5c6efeSJed Brown    Input Parameter:
3757d42a1c89SJed Brown + snes - nonlinear solver
37580910c330SBarry Smith . U - the current state at which to evaluate the residual
3759d42a1c89SJed Brown - ctx - user context, must be a TS
37600f5c6efeSJed Brown 
37610f5c6efeSJed Brown    Output Parameter:
37620f5c6efeSJed Brown . F - the nonlinear residual
37630f5c6efeSJed Brown 
37640f5c6efeSJed Brown    Notes:
37650f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
37660f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
37670f5c6efeSJed Brown 
37680f5c6efeSJed Brown    Level: advanced
37690f5c6efeSJed Brown 
37700f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
37710f5c6efeSJed Brown @*/
37720910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
37730f5c6efeSJed Brown {
37740f5c6efeSJed Brown   TS             ts = (TS)ctx;
37750f5c6efeSJed Brown   PetscErrorCode ierr;
37760f5c6efeSJed Brown 
37770f5c6efeSJed Brown   PetscFunctionBegin;
37780f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
37790910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
37800f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
37810f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
37820910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
37830f5c6efeSJed Brown   PetscFunctionReturn(0);
37840f5c6efeSJed Brown }
37850f5c6efeSJed Brown 
37860f5c6efeSJed Brown #undef __FUNCT__
37870f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
37880f5c6efeSJed Brown /*@
37890f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
37900f5c6efeSJed Brown 
37910f5c6efeSJed Brown    Collective on SNES
37920f5c6efeSJed Brown 
37930f5c6efeSJed Brown    Input Parameter:
37940f5c6efeSJed Brown + snes - nonlinear solver
37950910c330SBarry Smith . U - the current state at which to evaluate the residual
37960f5c6efeSJed Brown - ctx - user context, must be a TS
37970f5c6efeSJed Brown 
37980f5c6efeSJed Brown    Output Parameter:
37990f5c6efeSJed Brown + A - the Jacobian
38000f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
38010f5c6efeSJed Brown - flag - indicates any structure change in the matrix
38020f5c6efeSJed Brown 
38030f5c6efeSJed Brown    Notes:
38040f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
38050f5c6efeSJed Brown 
38060f5c6efeSJed Brown    Level: developer
38070f5c6efeSJed Brown 
38080f5c6efeSJed Brown .seealso: SNESSetJacobian()
38090f5c6efeSJed Brown @*/
3810d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
38110f5c6efeSJed Brown {
38120f5c6efeSJed Brown   TS             ts = (TS)ctx;
38130f5c6efeSJed Brown   PetscErrorCode ierr;
38140f5c6efeSJed Brown 
38150f5c6efeSJed Brown   PetscFunctionBegin;
38160f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
38170910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
38180f5c6efeSJed Brown   PetscValidPointer(A,3);
381994ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
38200f5c6efeSJed Brown   PetscValidPointer(B,4);
382194ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
38220f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
3823d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
38240f5c6efeSJed Brown   PetscFunctionReturn(0);
38250f5c6efeSJed Brown }
3826325fc9f4SBarry Smith 
38270e4ef248SJed Brown #undef __FUNCT__
38280e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
38290e4ef248SJed Brown /*@C
38300e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
38310e4ef248SJed Brown 
38320e4ef248SJed Brown    Collective on TS
38330e4ef248SJed Brown 
38340e4ef248SJed Brown    Input Arguments:
38350e4ef248SJed Brown +  ts - time stepping context
38360e4ef248SJed Brown .  t - time at which to evaluate
38370910c330SBarry Smith .  U - state at which to evaluate
38380e4ef248SJed Brown -  ctx - context
38390e4ef248SJed Brown 
38400e4ef248SJed Brown    Output Arguments:
38410e4ef248SJed Brown .  F - right hand side
38420e4ef248SJed Brown 
38430e4ef248SJed Brown    Level: intermediate
38440e4ef248SJed Brown 
38450e4ef248SJed Brown    Notes:
38460e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
38470e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
38480e4ef248SJed Brown 
38490e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
38500e4ef248SJed Brown @*/
38510910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
38520e4ef248SJed Brown {
38530e4ef248SJed Brown   PetscErrorCode ierr;
38540e4ef248SJed Brown   Mat            Arhs,Brhs;
38550e4ef248SJed Brown 
38560e4ef248SJed Brown   PetscFunctionBegin;
38570e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
3858d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
38590910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
38600e4ef248SJed Brown   PetscFunctionReturn(0);
38610e4ef248SJed Brown }
38620e4ef248SJed Brown 
38630e4ef248SJed Brown #undef __FUNCT__
38640e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
38650e4ef248SJed Brown /*@C
38660e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
38670e4ef248SJed Brown 
38680e4ef248SJed Brown    Collective on TS
38690e4ef248SJed Brown 
38700e4ef248SJed Brown    Input Arguments:
38710e4ef248SJed Brown +  ts - time stepping context
38720e4ef248SJed Brown .  t - time at which to evaluate
38730910c330SBarry Smith .  U - state at which to evaluate
38740e4ef248SJed Brown -  ctx - context
38750e4ef248SJed Brown 
38760e4ef248SJed Brown    Output Arguments:
38770e4ef248SJed Brown +  A - pointer to operator
38780e4ef248SJed Brown .  B - pointer to preconditioning matrix
38790e4ef248SJed Brown -  flg - matrix structure flag
38800e4ef248SJed Brown 
38810e4ef248SJed Brown    Level: intermediate
38820e4ef248SJed Brown 
38830e4ef248SJed Brown    Notes:
38840e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
38850e4ef248SJed Brown 
38860e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
38870e4ef248SJed Brown @*/
3888d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
38890e4ef248SJed Brown {
38900e4ef248SJed Brown   PetscFunctionBegin;
38910e4ef248SJed Brown   PetscFunctionReturn(0);
38920e4ef248SJed Brown }
38930e4ef248SJed Brown 
38940026cea9SSean Farley #undef __FUNCT__
38950026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
38960026cea9SSean Farley /*@C
38970026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
38980026cea9SSean Farley 
38990026cea9SSean Farley    Collective on TS
39000026cea9SSean Farley 
39010026cea9SSean Farley    Input Arguments:
39020026cea9SSean Farley +  ts - time stepping context
39030026cea9SSean Farley .  t - time at which to evaluate
39040910c330SBarry Smith .  U - state at which to evaluate
39050910c330SBarry Smith .  Udot - time derivative of state vector
39060026cea9SSean Farley -  ctx - context
39070026cea9SSean Farley 
39080026cea9SSean Farley    Output Arguments:
39090026cea9SSean Farley .  F - left hand side
39100026cea9SSean Farley 
39110026cea9SSean Farley    Level: intermediate
39120026cea9SSean Farley 
39130026cea9SSean Farley    Notes:
39140910c330SBarry 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
39150026cea9SSean Farley    user is required to write their own TSComputeIFunction.
39160026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
39170026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
39180026cea9SSean Farley 
39190026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
39200026cea9SSean Farley @*/
39210910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
39220026cea9SSean Farley {
39230026cea9SSean Farley   PetscErrorCode ierr;
39240026cea9SSean Farley   Mat            A,B;
39250026cea9SSean Farley 
39260026cea9SSean Farley   PetscFunctionBegin;
39270298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
3928d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
39290910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
39300026cea9SSean Farley   PetscFunctionReturn(0);
39310026cea9SSean Farley }
39320026cea9SSean Farley 
39330026cea9SSean Farley #undef __FUNCT__
39340026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
39350026cea9SSean Farley /*@C
3936b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
39370026cea9SSean Farley 
39380026cea9SSean Farley    Collective on TS
39390026cea9SSean Farley 
39400026cea9SSean Farley    Input Arguments:
39410026cea9SSean Farley +  ts - time stepping context
39420026cea9SSean Farley .  t - time at which to evaluate
39430910c330SBarry Smith .  U - state at which to evaluate
39440910c330SBarry Smith .  Udot - time derivative of state vector
39450026cea9SSean Farley .  shift - shift to apply
39460026cea9SSean Farley -  ctx - context
39470026cea9SSean Farley 
39480026cea9SSean Farley    Output Arguments:
39490026cea9SSean Farley +  A - pointer to operator
39500026cea9SSean Farley .  B - pointer to preconditioning matrix
39510026cea9SSean Farley -  flg - matrix structure flag
39520026cea9SSean Farley 
3953b41af12eSJed Brown    Level: advanced
39540026cea9SSean Farley 
39550026cea9SSean Farley    Notes:
39560026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
39570026cea9SSean Farley 
3958b41af12eSJed Brown    It is only appropriate for problems of the form
3959b41af12eSJed Brown 
3960b41af12eSJed Brown $     M Udot = F(U,t)
3961b41af12eSJed Brown 
3962b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
3963b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
3964b41af12eSJed Brown   an implicit operator of the form
3965b41af12eSJed Brown 
3966b41af12eSJed Brown $    shift*M + J
3967b41af12eSJed Brown 
3968b41af12eSJed 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
3969b41af12eSJed Brown   a copy of M or reassemble it when requested.
3970b41af12eSJed Brown 
39710026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
39720026cea9SSean Farley @*/
3973d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
39740026cea9SSean Farley {
3975b41af12eSJed Brown   PetscErrorCode ierr;
3976b41af12eSJed Brown 
39770026cea9SSean Farley   PetscFunctionBegin;
397894ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
3979b41af12eSJed Brown   ts->ijacobian.shift = shift;
39800026cea9SSean Farley   PetscFunctionReturn(0);
39810026cea9SSean Farley }
3982b41af12eSJed Brown 
3983e817cc15SEmil Constantinescu #undef __FUNCT__
3984e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
3985e817cc15SEmil Constantinescu /*@
3986e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
3987e817cc15SEmil Constantinescu 
3988e817cc15SEmil Constantinescu    Not Collective
3989e817cc15SEmil Constantinescu 
3990e817cc15SEmil Constantinescu    Input Parameter:
3991e817cc15SEmil Constantinescu .  ts - the TS context
3992e817cc15SEmil Constantinescu 
3993e817cc15SEmil Constantinescu    Output Parameter:
39944e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
3995e817cc15SEmil Constantinescu 
3996e817cc15SEmil Constantinescu    Level: beginner
3997e817cc15SEmil Constantinescu 
3998e817cc15SEmil Constantinescu .keywords: TS, equation type
3999e817cc15SEmil Constantinescu 
4000e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4001e817cc15SEmil Constantinescu @*/
4002e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4003e817cc15SEmil Constantinescu {
4004e817cc15SEmil Constantinescu   PetscFunctionBegin;
4005e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4006e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4007e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4008e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4009e817cc15SEmil Constantinescu }
4010e817cc15SEmil Constantinescu 
4011e817cc15SEmil Constantinescu #undef __FUNCT__
4012e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4013e817cc15SEmil Constantinescu /*@
4014e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4015e817cc15SEmil Constantinescu 
4016e817cc15SEmil Constantinescu    Not Collective
4017e817cc15SEmil Constantinescu 
4018e817cc15SEmil Constantinescu    Input Parameter:
4019e817cc15SEmil Constantinescu +  ts - the TS context
40204e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4021e817cc15SEmil Constantinescu 
4022e817cc15SEmil Constantinescu    Level: advanced
4023e817cc15SEmil Constantinescu 
4024e817cc15SEmil Constantinescu .keywords: TS, equation type
4025e817cc15SEmil Constantinescu 
4026e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4027e817cc15SEmil Constantinescu @*/
4028e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4029e817cc15SEmil Constantinescu {
4030e817cc15SEmil Constantinescu   PetscFunctionBegin;
4031e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4032e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4033e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4034e817cc15SEmil Constantinescu }
40350026cea9SSean Farley 
40364af1b03aSJed Brown #undef __FUNCT__
40374af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
40384af1b03aSJed Brown /*@
40394af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
40404af1b03aSJed Brown 
40414af1b03aSJed Brown    Not Collective
40424af1b03aSJed Brown 
40434af1b03aSJed Brown    Input Parameter:
40444af1b03aSJed Brown .  ts - the TS context
40454af1b03aSJed Brown 
40464af1b03aSJed Brown    Output Parameter:
40474af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
40484af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
40494af1b03aSJed Brown 
4050487e0bb9SJed Brown    Level: beginner
40514af1b03aSJed Brown 
4052cd652676SJed Brown    Notes:
4053cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
40544af1b03aSJed Brown 
40554af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
40564af1b03aSJed Brown 
40574af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
40584af1b03aSJed Brown @*/
40594af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
40604af1b03aSJed Brown {
40614af1b03aSJed Brown   PetscFunctionBegin;
40624af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
40634af1b03aSJed Brown   PetscValidPointer(reason,2);
40644af1b03aSJed Brown   *reason = ts->reason;
40654af1b03aSJed Brown   PetscFunctionReturn(0);
40664af1b03aSJed Brown }
40674af1b03aSJed Brown 
4068fb1732b5SBarry Smith #undef __FUNCT__
4069d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4070d6ad946cSShri Abhyankar /*@
4071d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4072d6ad946cSShri Abhyankar 
4073d6ad946cSShri Abhyankar    Not Collective
4074d6ad946cSShri Abhyankar 
4075d6ad946cSShri Abhyankar    Input Parameter:
4076d6ad946cSShri Abhyankar +  ts - the TS context
4077d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4078d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4079d6ad946cSShri Abhyankar 
4080f5abba47SShri Abhyankar    Level: advanced
4081d6ad946cSShri Abhyankar 
4082d6ad946cSShri Abhyankar    Notes:
4083d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4084d6ad946cSShri Abhyankar 
4085d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4086d6ad946cSShri Abhyankar 
4087d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4088d6ad946cSShri Abhyankar @*/
4089d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4090d6ad946cSShri Abhyankar {
4091d6ad946cSShri Abhyankar   PetscFunctionBegin;
4092d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4093d6ad946cSShri Abhyankar   ts->reason = reason;
4094d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4095d6ad946cSShri Abhyankar }
4096d6ad946cSShri Abhyankar 
4097d6ad946cSShri Abhyankar #undef __FUNCT__
4098cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4099cc708dedSBarry Smith /*@
4100cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4101cc708dedSBarry Smith 
4102cc708dedSBarry Smith    Not Collective
4103cc708dedSBarry Smith 
4104cc708dedSBarry Smith    Input Parameter:
4105cc708dedSBarry Smith .  ts - the TS context
4106cc708dedSBarry Smith 
4107cc708dedSBarry Smith    Output Parameter:
4108cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4109cc708dedSBarry Smith 
4110487e0bb9SJed Brown    Level: beginner
4111cc708dedSBarry Smith 
4112cc708dedSBarry Smith    Notes:
4113cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4114cc708dedSBarry Smith 
4115cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4116cc708dedSBarry Smith 
4117cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4118cc708dedSBarry Smith @*/
4119cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4120cc708dedSBarry Smith {
4121cc708dedSBarry Smith   PetscFunctionBegin;
4122cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4123cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4124cc708dedSBarry Smith   *ftime = ts->solvetime;
4125cc708dedSBarry Smith   PetscFunctionReturn(0);
4126cc708dedSBarry Smith }
4127cc708dedSBarry Smith 
4128cc708dedSBarry Smith #undef __FUNCT__
41295ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
41309f67acb7SJed Brown /*@
41315ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
41329f67acb7SJed Brown    used by the time integrator.
41339f67acb7SJed Brown 
41349f67acb7SJed Brown    Not Collective
41359f67acb7SJed Brown 
41369f67acb7SJed Brown    Input Parameter:
41379f67acb7SJed Brown .  ts - TS context
41389f67acb7SJed Brown 
41399f67acb7SJed Brown    Output Parameter:
41409f67acb7SJed Brown .  nits - number of nonlinear iterations
41419f67acb7SJed Brown 
41429f67acb7SJed Brown    Notes:
41439f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
41449f67acb7SJed Brown 
41459f67acb7SJed Brown    Level: intermediate
41469f67acb7SJed Brown 
41479f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
41489f67acb7SJed Brown 
41495ef26d82SJed Brown .seealso:  TSGetKSPIterations()
41509f67acb7SJed Brown @*/
41515ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
41529f67acb7SJed Brown {
41539f67acb7SJed Brown   PetscFunctionBegin;
41549f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
41559f67acb7SJed Brown   PetscValidIntPointer(nits,2);
41565ef26d82SJed Brown   *nits = ts->snes_its;
41579f67acb7SJed Brown   PetscFunctionReturn(0);
41589f67acb7SJed Brown }
41599f67acb7SJed Brown 
41609f67acb7SJed Brown #undef __FUNCT__
41615ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
41629f67acb7SJed Brown /*@
41635ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
41649f67acb7SJed Brown    used by the time integrator.
41659f67acb7SJed Brown 
41669f67acb7SJed Brown    Not Collective
41679f67acb7SJed Brown 
41689f67acb7SJed Brown    Input Parameter:
41699f67acb7SJed Brown .  ts - TS context
41709f67acb7SJed Brown 
41719f67acb7SJed Brown    Output Parameter:
41729f67acb7SJed Brown .  lits - number of linear iterations
41739f67acb7SJed Brown 
41749f67acb7SJed Brown    Notes:
41759f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
41769f67acb7SJed Brown 
41779f67acb7SJed Brown    Level: intermediate
41789f67acb7SJed Brown 
41799f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
41809f67acb7SJed Brown 
41815ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
41829f67acb7SJed Brown @*/
41835ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
41849f67acb7SJed Brown {
41859f67acb7SJed Brown   PetscFunctionBegin;
41869f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
41879f67acb7SJed Brown   PetscValidIntPointer(lits,2);
41885ef26d82SJed Brown   *lits = ts->ksp_its;
41899f67acb7SJed Brown   PetscFunctionReturn(0);
41909f67acb7SJed Brown }
41919f67acb7SJed Brown 
41929f67acb7SJed Brown #undef __FUNCT__
4193cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4194cef5090cSJed Brown /*@
4195cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4196cef5090cSJed Brown 
4197cef5090cSJed Brown    Not Collective
4198cef5090cSJed Brown 
4199cef5090cSJed Brown    Input Parameter:
4200cef5090cSJed Brown .  ts - TS context
4201cef5090cSJed Brown 
4202cef5090cSJed Brown    Output Parameter:
4203cef5090cSJed Brown .  rejects - number of steps rejected
4204cef5090cSJed Brown 
4205cef5090cSJed Brown    Notes:
4206cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4207cef5090cSJed Brown 
4208cef5090cSJed Brown    Level: intermediate
4209cef5090cSJed Brown 
4210cef5090cSJed Brown .keywords: TS, get, number
4211cef5090cSJed Brown 
42125ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4213cef5090cSJed Brown @*/
4214cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4215cef5090cSJed Brown {
4216cef5090cSJed Brown   PetscFunctionBegin;
4217cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4218cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4219cef5090cSJed Brown   *rejects = ts->reject;
4220cef5090cSJed Brown   PetscFunctionReturn(0);
4221cef5090cSJed Brown }
4222cef5090cSJed Brown 
4223cef5090cSJed Brown #undef __FUNCT__
4224cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4225cef5090cSJed Brown /*@
4226cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4227cef5090cSJed Brown 
4228cef5090cSJed Brown    Not Collective
4229cef5090cSJed Brown 
4230cef5090cSJed Brown    Input Parameter:
4231cef5090cSJed Brown .  ts - TS context
4232cef5090cSJed Brown 
4233cef5090cSJed Brown    Output Parameter:
4234cef5090cSJed Brown .  fails - number of failed nonlinear solves
4235cef5090cSJed Brown 
4236cef5090cSJed Brown    Notes:
4237cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4238cef5090cSJed Brown 
4239cef5090cSJed Brown    Level: intermediate
4240cef5090cSJed Brown 
4241cef5090cSJed Brown .keywords: TS, get, number
4242cef5090cSJed Brown 
42435ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4244cef5090cSJed Brown @*/
4245cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4246cef5090cSJed Brown {
4247cef5090cSJed Brown   PetscFunctionBegin;
4248cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4249cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4250cef5090cSJed Brown   *fails = ts->num_snes_failures;
4251cef5090cSJed Brown   PetscFunctionReturn(0);
4252cef5090cSJed Brown }
4253cef5090cSJed Brown 
4254cef5090cSJed Brown #undef __FUNCT__
4255cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4256cef5090cSJed Brown /*@
4257cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4258cef5090cSJed Brown 
4259cef5090cSJed Brown    Not Collective
4260cef5090cSJed Brown 
4261cef5090cSJed Brown    Input Parameter:
4262cef5090cSJed Brown +  ts - TS context
4263cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4264cef5090cSJed Brown 
4265cef5090cSJed Brown    Notes:
4266cef5090cSJed Brown    The counter is reset to zero for each step
4267cef5090cSJed Brown 
4268cef5090cSJed Brown    Options Database Key:
4269cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4270cef5090cSJed Brown 
4271cef5090cSJed Brown    Level: intermediate
4272cef5090cSJed Brown 
4273cef5090cSJed Brown .keywords: TS, set, maximum, number
4274cef5090cSJed Brown 
42755ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4276cef5090cSJed Brown @*/
4277cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4278cef5090cSJed Brown {
4279cef5090cSJed Brown   PetscFunctionBegin;
4280cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4281cef5090cSJed Brown   ts->max_reject = rejects;
4282cef5090cSJed Brown   PetscFunctionReturn(0);
4283cef5090cSJed Brown }
4284cef5090cSJed Brown 
4285cef5090cSJed Brown #undef __FUNCT__
4286cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4287cef5090cSJed Brown /*@
4288cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4289cef5090cSJed Brown 
4290cef5090cSJed Brown    Not Collective
4291cef5090cSJed Brown 
4292cef5090cSJed Brown    Input Parameter:
4293cef5090cSJed Brown +  ts - TS context
4294cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4295cef5090cSJed Brown 
4296cef5090cSJed Brown    Notes:
4297cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4298cef5090cSJed Brown 
4299cef5090cSJed Brown    Options Database Key:
4300cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4301cef5090cSJed Brown 
4302cef5090cSJed Brown    Level: intermediate
4303cef5090cSJed Brown 
4304cef5090cSJed Brown .keywords: TS, set, maximum, number
4305cef5090cSJed Brown 
43065ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4307cef5090cSJed Brown @*/
4308cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4309cef5090cSJed Brown {
4310cef5090cSJed Brown   PetscFunctionBegin;
4311cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4312cef5090cSJed Brown   ts->max_snes_failures = fails;
4313cef5090cSJed Brown   PetscFunctionReturn(0);
4314cef5090cSJed Brown }
4315cef5090cSJed Brown 
4316cef5090cSJed Brown #undef __FUNCT__
43174e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4318cef5090cSJed Brown /*@
4319cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4320cef5090cSJed Brown 
4321cef5090cSJed Brown    Not Collective
4322cef5090cSJed Brown 
4323cef5090cSJed Brown    Input Parameter:
4324cef5090cSJed Brown +  ts - TS context
4325cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4326cef5090cSJed Brown 
4327cef5090cSJed Brown    Options Database Key:
4328cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4329cef5090cSJed Brown 
4330cef5090cSJed Brown    Level: intermediate
4331cef5090cSJed Brown 
4332cef5090cSJed Brown .keywords: TS, set, error
4333cef5090cSJed Brown 
43345ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4335cef5090cSJed Brown @*/
4336cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4337cef5090cSJed Brown {
4338cef5090cSJed Brown   PetscFunctionBegin;
4339cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4340cef5090cSJed Brown   ts->errorifstepfailed = err;
4341cef5090cSJed Brown   PetscFunctionReturn(0);
4342cef5090cSJed Brown }
4343cef5090cSJed Brown 
4344cef5090cSJed Brown #undef __FUNCT__
4345fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4346fb1732b5SBarry Smith /*@C
4347fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4348fb1732b5SBarry Smith 
4349fb1732b5SBarry Smith    Collective on TS
4350fb1732b5SBarry Smith 
4351fb1732b5SBarry Smith    Input Parameters:
4352fb1732b5SBarry Smith +  ts - the TS context
4353fb1732b5SBarry Smith .  step - current time-step
4354fb1732b5SBarry Smith .  ptime - current time
43550910c330SBarry Smith .  u - current state
4356fb1732b5SBarry Smith -  viewer - binary viewer
4357fb1732b5SBarry Smith 
4358fb1732b5SBarry Smith    Level: intermediate
4359fb1732b5SBarry Smith 
4360fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4361fb1732b5SBarry Smith 
4362fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4363fb1732b5SBarry Smith @*/
43640910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4365fb1732b5SBarry Smith {
4366fb1732b5SBarry Smith   PetscErrorCode ierr;
4367ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4368fb1732b5SBarry Smith 
4369fb1732b5SBarry Smith   PetscFunctionBegin;
43700910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4371ed81e22dSJed Brown   PetscFunctionReturn(0);
4372ed81e22dSJed Brown }
4373ed81e22dSJed Brown 
4374ed81e22dSJed Brown #undef __FUNCT__
4375ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4376ed81e22dSJed Brown /*@C
4377ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4378ed81e22dSJed Brown 
4379ed81e22dSJed Brown    Collective on TS
4380ed81e22dSJed Brown 
4381ed81e22dSJed Brown    Input Parameters:
4382ed81e22dSJed Brown +  ts - the TS context
4383ed81e22dSJed Brown .  step - current time-step
4384ed81e22dSJed Brown .  ptime - current time
43850910c330SBarry Smith .  u - current state
4386ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4387ed81e22dSJed Brown 
4388ed81e22dSJed Brown    Level: intermediate
4389ed81e22dSJed Brown 
4390ed81e22dSJed Brown    Notes:
4391ed81e22dSJed 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.
4392ed81e22dSJed Brown    These are named according to the file name template.
4393ed81e22dSJed Brown 
4394ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4395ed81e22dSJed Brown 
4396ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4397ed81e22dSJed Brown 
4398ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4399ed81e22dSJed Brown @*/
44000910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4401ed81e22dSJed Brown {
4402ed81e22dSJed Brown   PetscErrorCode ierr;
4403ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4404ed81e22dSJed Brown   PetscViewer    viewer;
4405ed81e22dSJed Brown 
4406ed81e22dSJed Brown   PetscFunctionBegin;
44078caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4408ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
44090910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4410ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4411ed81e22dSJed Brown   PetscFunctionReturn(0);
4412ed81e22dSJed Brown }
4413ed81e22dSJed Brown 
4414ed81e22dSJed Brown #undef __FUNCT__
4415ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4416ed81e22dSJed Brown /*@C
4417ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4418ed81e22dSJed Brown 
4419ed81e22dSJed Brown    Collective on TS
4420ed81e22dSJed Brown 
4421ed81e22dSJed Brown    Input Parameters:
4422ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4423ed81e22dSJed Brown 
4424ed81e22dSJed Brown    Level: intermediate
4425ed81e22dSJed Brown 
4426ed81e22dSJed Brown    Note:
4427ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4428ed81e22dSJed Brown 
4429ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4430ed81e22dSJed Brown 
4431ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4432ed81e22dSJed Brown @*/
4433ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4434ed81e22dSJed Brown {
4435ed81e22dSJed Brown   PetscErrorCode ierr;
4436ed81e22dSJed Brown 
4437ed81e22dSJed Brown   PetscFunctionBegin;
4438ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4439fb1732b5SBarry Smith   PetscFunctionReturn(0);
4440fb1732b5SBarry Smith }
4441fb1732b5SBarry Smith 
444284df9cb4SJed Brown #undef __FUNCT__
4443552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
444484df9cb4SJed Brown /*@
4445552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
444684df9cb4SJed Brown 
4447ed81e22dSJed Brown    Collective on TS if controller has not been created yet
444884df9cb4SJed Brown 
444984df9cb4SJed Brown    Input Arguments:
4450ed81e22dSJed Brown .  ts - time stepping context
445184df9cb4SJed Brown 
445284df9cb4SJed Brown    Output Arguments:
4453ed81e22dSJed Brown .  adapt - adaptive controller
445484df9cb4SJed Brown 
445584df9cb4SJed Brown    Level: intermediate
445684df9cb4SJed Brown 
4457ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
445884df9cb4SJed Brown @*/
4459552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
446084df9cb4SJed Brown {
446184df9cb4SJed Brown   PetscErrorCode ierr;
446284df9cb4SJed Brown 
446384df9cb4SJed Brown   PetscFunctionBegin;
446484df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
446584df9cb4SJed Brown   PetscValidPointer(adapt,2);
446684df9cb4SJed Brown   if (!ts->adapt) {
4467ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
44683bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
44691c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
447084df9cb4SJed Brown   }
447184df9cb4SJed Brown   *adapt = ts->adapt;
447284df9cb4SJed Brown   PetscFunctionReturn(0);
447384df9cb4SJed Brown }
4474d6ebe24aSShri Abhyankar 
4475d6ebe24aSShri Abhyankar #undef __FUNCT__
44761c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
44771c3436cfSJed Brown /*@
44781c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
44791c3436cfSJed Brown 
44801c3436cfSJed Brown    Logically Collective
44811c3436cfSJed Brown 
44821c3436cfSJed Brown    Input Arguments:
44831c3436cfSJed Brown +  ts - time integration context
44841c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
44850298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
44861c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
44870298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
44881c3436cfSJed Brown 
4489a3cdaa26SBarry Smith    Options Database keys:
4490a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4491a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4492a3cdaa26SBarry Smith 
44931c3436cfSJed Brown    Level: beginner
44941c3436cfSJed Brown 
4495c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
44961c3436cfSJed Brown @*/
44971c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
44981c3436cfSJed Brown {
44991c3436cfSJed Brown   PetscErrorCode ierr;
45001c3436cfSJed Brown 
45011c3436cfSJed Brown   PetscFunctionBegin;
4502c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
45031c3436cfSJed Brown   if (vatol) {
45041c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
45051c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4506bbd56ea5SKarl Rupp 
45071c3436cfSJed Brown     ts->vatol = vatol;
45081c3436cfSJed Brown   }
4509c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
45101c3436cfSJed Brown   if (vrtol) {
45111c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
45121c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4513bbd56ea5SKarl Rupp 
45141c3436cfSJed Brown     ts->vrtol = vrtol;
45151c3436cfSJed Brown   }
45161c3436cfSJed Brown   PetscFunctionReturn(0);
45171c3436cfSJed Brown }
45181c3436cfSJed Brown 
45191c3436cfSJed Brown #undef __FUNCT__
4520c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4521c5033834SJed Brown /*@
4522c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4523c5033834SJed Brown 
4524c5033834SJed Brown    Logically Collective
4525c5033834SJed Brown 
4526c5033834SJed Brown    Input Arguments:
4527c5033834SJed Brown .  ts - time integration context
4528c5033834SJed Brown 
4529c5033834SJed Brown    Output Arguments:
45300298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
45310298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
45320298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
45330298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4534c5033834SJed Brown 
4535c5033834SJed Brown    Level: beginner
4536c5033834SJed Brown 
4537c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4538c5033834SJed Brown @*/
4539c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4540c5033834SJed Brown {
4541c5033834SJed Brown   PetscFunctionBegin;
4542c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4543c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4544c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4545c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4546c5033834SJed Brown   PetscFunctionReturn(0);
4547c5033834SJed Brown }
4548c5033834SJed Brown 
4549c5033834SJed Brown #undef __FUNCT__
45501c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
45511c3436cfSJed Brown /*@
45521c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
45531c3436cfSJed Brown 
45541c3436cfSJed Brown    Collective on TS
45551c3436cfSJed Brown 
45561c3436cfSJed Brown    Input Arguments:
45571c3436cfSJed Brown +  ts - time stepping context
45581c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
45591c3436cfSJed Brown 
45601c3436cfSJed Brown    Output Arguments:
45611c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
45621c3436cfSJed Brown 
45631c3436cfSJed Brown    Level: developer
45641c3436cfSJed Brown 
45651c3436cfSJed Brown .seealso: TSSetTolerances()
45661c3436cfSJed Brown @*/
45671c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
45681c3436cfSJed Brown {
45691c3436cfSJed Brown   PetscErrorCode    ierr;
45701c3436cfSJed Brown   PetscInt          i,n,N;
45710910c330SBarry Smith   const PetscScalar *u,*y;
45720910c330SBarry Smith   Vec               U;
45731c3436cfSJed Brown   PetscReal         sum,gsum;
45741c3436cfSJed Brown 
45751c3436cfSJed Brown   PetscFunctionBegin;
45761c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45771c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
45781c3436cfSJed Brown   PetscValidPointer(norm,3);
45790910c330SBarry Smith   U = ts->vec_sol;
45800910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
4581ce94432eSBarry Smith   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
45821c3436cfSJed Brown 
45830910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
45840910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
45850910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
45861c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
45871c3436cfSJed Brown   sum  = 0.;
4588ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
4589ceefc113SJed Brown     const PetscScalar *atol,*rtol;
4590ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4591ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4592ceefc113SJed Brown     for (i=0; i<n; i++) {
45930910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
45940910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4595ceefc113SJed Brown     }
4596ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4597ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4598ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4599ceefc113SJed Brown     const PetscScalar *atol;
4600ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4601ceefc113SJed Brown     for (i=0; i<n; i++) {
46020910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
46030910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4604ceefc113SJed Brown     }
4605ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4606ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4607ceefc113SJed Brown     const PetscScalar *rtol;
4608ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4609ceefc113SJed Brown     for (i=0; i<n; i++) {
46100910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
46110910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4612ceefc113SJed Brown     }
4613ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4614ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
46151c3436cfSJed Brown     for (i=0; i<n; i++) {
46160910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
46170910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
46181c3436cfSJed Brown     }
4619ceefc113SJed Brown   }
46200910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
46211c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
46221c3436cfSJed Brown 
4623ce94432eSBarry Smith   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
46241c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
4625620fc8aaSSatish Balay   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
46261c3436cfSJed Brown   PetscFunctionReturn(0);
46271c3436cfSJed Brown }
46281c3436cfSJed Brown 
46291c3436cfSJed Brown #undef __FUNCT__
46308d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
46318d59e960SJed Brown /*@
46328d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
46338d59e960SJed Brown 
46348d59e960SJed Brown    Logically Collective on TS
46358d59e960SJed Brown 
46368d59e960SJed Brown    Input Arguments:
46378d59e960SJed Brown +  ts - time stepping context
46388d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
46398d59e960SJed Brown 
46408d59e960SJed Brown    Note:
46418d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
46428d59e960SJed Brown 
46438d59e960SJed Brown    Level: intermediate
46448d59e960SJed Brown 
46458d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
46468d59e960SJed Brown @*/
46478d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
46488d59e960SJed Brown {
46498d59e960SJed Brown   PetscFunctionBegin;
46508d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46518d59e960SJed Brown   ts->cfltime_local = cfltime;
46528d59e960SJed Brown   ts->cfltime       = -1.;
46538d59e960SJed Brown   PetscFunctionReturn(0);
46548d59e960SJed Brown }
46558d59e960SJed Brown 
46568d59e960SJed Brown #undef __FUNCT__
46578d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
46588d59e960SJed Brown /*@
46598d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
46608d59e960SJed Brown 
46618d59e960SJed Brown    Collective on TS
46628d59e960SJed Brown 
46638d59e960SJed Brown    Input Arguments:
46648d59e960SJed Brown .  ts - time stepping context
46658d59e960SJed Brown 
46668d59e960SJed Brown    Output Arguments:
46678d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
46688d59e960SJed Brown 
46698d59e960SJed Brown    Level: advanced
46708d59e960SJed Brown 
46718d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
46728d59e960SJed Brown @*/
46738d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
46748d59e960SJed Brown {
46758d59e960SJed Brown   PetscErrorCode ierr;
46768d59e960SJed Brown 
46778d59e960SJed Brown   PetscFunctionBegin;
46788d59e960SJed Brown   if (ts->cfltime < 0) {
4679ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
46808d59e960SJed Brown   }
46818d59e960SJed Brown   *cfltime = ts->cfltime;
46828d59e960SJed Brown   PetscFunctionReturn(0);
46838d59e960SJed Brown }
46848d59e960SJed Brown 
46858d59e960SJed Brown #undef __FUNCT__
4686d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
4687d6ebe24aSShri Abhyankar /*@
4688d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
4689d6ebe24aSShri Abhyankar 
4690d6ebe24aSShri Abhyankar    Input Parameters:
4691d6ebe24aSShri Abhyankar .  ts   - the TS context.
4692d6ebe24aSShri Abhyankar .  xl   - lower bound.
4693d6ebe24aSShri Abhyankar .  xu   - upper bound.
4694d6ebe24aSShri Abhyankar 
4695d6ebe24aSShri Abhyankar    Notes:
4696d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
4697e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
4698d6ebe24aSShri Abhyankar 
46992bd2b0e6SSatish Balay    Level: advanced
47002bd2b0e6SSatish Balay 
4701d6ebe24aSShri Abhyankar @*/
4702d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
4703d6ebe24aSShri Abhyankar {
4704d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
4705d6ebe24aSShri Abhyankar   SNES           snes;
4706d6ebe24aSShri Abhyankar 
4707d6ebe24aSShri Abhyankar   PetscFunctionBegin;
4708d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4709d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
4710d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
4711d6ebe24aSShri Abhyankar }
4712d6ebe24aSShri Abhyankar 
4713325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
4714c6db04a5SJed Brown #include <mex.h>
4715325fc9f4SBarry Smith 
4716325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
4717325fc9f4SBarry Smith 
4718325fc9f4SBarry Smith #undef __FUNCT__
4719325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
4720325fc9f4SBarry Smith /*
4721325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
4722325fc9f4SBarry Smith                          TSSetFunctionMatlab().
4723325fc9f4SBarry Smith 
4724325fc9f4SBarry Smith    Collective on TS
4725325fc9f4SBarry Smith 
4726325fc9f4SBarry Smith    Input Parameters:
4727325fc9f4SBarry Smith +  snes - the TS context
47280910c330SBarry Smith -  u - input vector
4729325fc9f4SBarry Smith 
4730325fc9f4SBarry Smith    Output Parameter:
4731325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
4732325fc9f4SBarry Smith 
4733325fc9f4SBarry Smith    Notes:
4734325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
4735325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
4736325fc9f4SBarry Smith    themselves.
4737325fc9f4SBarry Smith 
4738325fc9f4SBarry Smith    Level: developer
4739325fc9f4SBarry Smith 
4740325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4741325fc9f4SBarry Smith 
4742325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4743325fc9f4SBarry Smith */
47440910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
4745325fc9f4SBarry Smith {
4746325fc9f4SBarry Smith   PetscErrorCode  ierr;
4747325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4748325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
4749325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
4750325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
4751325fc9f4SBarry Smith 
4752325fc9f4SBarry Smith   PetscFunctionBegin;
4753325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
47540910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
47550910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
4756325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
47570910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
4758325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
4759325fc9f4SBarry Smith 
4760325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
47610910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
47620910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
47630910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
4764bbd56ea5SKarl Rupp 
4765325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4766325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
4767325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4768325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4769325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
4770325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
4771325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
4772325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
4773325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4774325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4775325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4776325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4777325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4778325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4779325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4780325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4781325fc9f4SBarry Smith   PetscFunctionReturn(0);
4782325fc9f4SBarry Smith }
4783325fc9f4SBarry Smith 
4784325fc9f4SBarry Smith 
4785325fc9f4SBarry Smith #undef __FUNCT__
4786325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
4787325fc9f4SBarry Smith /*
4788325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
4789325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
4790e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
4791325fc9f4SBarry Smith 
4792325fc9f4SBarry Smith    Logically Collective on TS
4793325fc9f4SBarry Smith 
4794325fc9f4SBarry Smith    Input Parameters:
4795325fc9f4SBarry Smith +  ts - the TS context
4796325fc9f4SBarry Smith -  func - function evaluation routine
4797325fc9f4SBarry Smith 
4798325fc9f4SBarry Smith    Calling sequence of func:
47990910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
4800325fc9f4SBarry Smith 
4801325fc9f4SBarry Smith    Level: beginner
4802325fc9f4SBarry Smith 
4803325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4804325fc9f4SBarry Smith 
4805325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4806325fc9f4SBarry Smith */
4807cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
4808325fc9f4SBarry Smith {
4809325fc9f4SBarry Smith   PetscErrorCode  ierr;
4810325fc9f4SBarry Smith   TSMatlabContext *sctx;
4811325fc9f4SBarry Smith 
4812325fc9f4SBarry Smith   PetscFunctionBegin;
4813325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4814325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4815325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4816325fc9f4SBarry Smith   /*
4817325fc9f4SBarry Smith      This should work, but it doesn't
4818325fc9f4SBarry Smith   sctx->ctx = ctx;
4819325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4820325fc9f4SBarry Smith   */
4821325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4822bbd56ea5SKarl Rupp 
48230298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
4824325fc9f4SBarry Smith   PetscFunctionReturn(0);
4825325fc9f4SBarry Smith }
4826325fc9f4SBarry Smith 
4827325fc9f4SBarry Smith #undef __FUNCT__
4828325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
4829325fc9f4SBarry Smith /*
4830325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
4831325fc9f4SBarry Smith                          TSSetJacobianMatlab().
4832325fc9f4SBarry Smith 
4833325fc9f4SBarry Smith    Collective on TS
4834325fc9f4SBarry Smith 
4835325fc9f4SBarry Smith    Input Parameters:
4836cdcf91faSSean Farley +  ts - the TS context
48370910c330SBarry Smith .  u - input vector
4838325fc9f4SBarry Smith .  A, B - the matrices
4839325fc9f4SBarry Smith -  ctx - user context
4840325fc9f4SBarry Smith 
4841325fc9f4SBarry Smith    Level: developer
4842325fc9f4SBarry Smith 
4843325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
4844325fc9f4SBarry Smith 
4845325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4846325fc9f4SBarry Smith @*/
4847f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
4848325fc9f4SBarry Smith {
4849325fc9f4SBarry Smith   PetscErrorCode  ierr;
4850325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4851325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
4852325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
4853325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
4854325fc9f4SBarry Smith 
4855325fc9f4SBarry Smith   PetscFunctionBegin;
4856cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48570910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
4858325fc9f4SBarry Smith 
48590910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
4860325fc9f4SBarry Smith 
4861cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
48620910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
48630910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
48640910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
48650910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
4866bbd56ea5SKarl Rupp 
4867325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4868325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
4869325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
4870325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
4871325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
4872325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
4873325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
4874325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
4875325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
4876325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
4877325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4878325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
4879325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
4880325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
4881325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
4882325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
4883325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
4884325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
4885325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
4886325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
4887325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
4888325fc9f4SBarry Smith   PetscFunctionReturn(0);
4889325fc9f4SBarry Smith }
4890325fc9f4SBarry Smith 
4891325fc9f4SBarry Smith 
4892325fc9f4SBarry Smith #undef __FUNCT__
4893325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
4894325fc9f4SBarry Smith /*
4895325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
4896e3c5b3baSBarry 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
4897325fc9f4SBarry Smith 
4898325fc9f4SBarry Smith    Logically Collective on TS
4899325fc9f4SBarry Smith 
4900325fc9f4SBarry Smith    Input Parameters:
4901cdcf91faSSean Farley +  ts - the TS context
4902325fc9f4SBarry Smith .  A,B - Jacobian matrices
4903325fc9f4SBarry Smith .  func - function evaluation routine
4904325fc9f4SBarry Smith -  ctx - user context
4905325fc9f4SBarry Smith 
4906325fc9f4SBarry Smith    Calling sequence of func:
49070910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
4908325fc9f4SBarry Smith 
4909325fc9f4SBarry Smith 
4910325fc9f4SBarry Smith    Level: developer
4911325fc9f4SBarry Smith 
4912325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
4913325fc9f4SBarry Smith 
4914325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4915325fc9f4SBarry Smith */
4916cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
4917325fc9f4SBarry Smith {
4918325fc9f4SBarry Smith   PetscErrorCode  ierr;
4919325fc9f4SBarry Smith   TSMatlabContext *sctx;
4920325fc9f4SBarry Smith 
4921325fc9f4SBarry Smith   PetscFunctionBegin;
4922325fc9f4SBarry Smith   /* currently sctx is memory bleed */
4923325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4924325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4925325fc9f4SBarry Smith   /*
4926325fc9f4SBarry Smith      This should work, but it doesn't
4927325fc9f4SBarry Smith   sctx->ctx = ctx;
4928325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
4929325fc9f4SBarry Smith   */
4930325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
4931bbd56ea5SKarl Rupp 
4932cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
4933325fc9f4SBarry Smith   PetscFunctionReturn(0);
4934325fc9f4SBarry Smith }
4935325fc9f4SBarry Smith 
4936b5b1a830SBarry Smith #undef __FUNCT__
4937b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
4938b5b1a830SBarry Smith /*
4939b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
4940b5b1a830SBarry Smith 
4941b5b1a830SBarry Smith    Collective on TS
4942b5b1a830SBarry Smith 
4943b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
4944b5b1a830SBarry Smith @*/
49450910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
4946b5b1a830SBarry Smith {
4947b5b1a830SBarry Smith   PetscErrorCode  ierr;
4948b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
4949a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
4950b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
4951b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
4952b5b1a830SBarry Smith 
4953b5b1a830SBarry Smith   PetscFunctionBegin;
4954cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49550910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
4956b5b1a830SBarry Smith 
4957cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
49580910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
4959bbd56ea5SKarl Rupp 
4960b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
4961b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
4962b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
4963b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
4964b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
4965b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
4966b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
4967b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
4968b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
4969b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
4970b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
4971b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
4972b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
4973b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
4974b5b1a830SBarry Smith   PetscFunctionReturn(0);
4975b5b1a830SBarry Smith }
4976b5b1a830SBarry Smith 
4977b5b1a830SBarry Smith 
4978b5b1a830SBarry Smith #undef __FUNCT__
4979b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
4980b5b1a830SBarry Smith /*
4981b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
4982b5b1a830SBarry Smith 
4983b5b1a830SBarry Smith    Level: developer
4984b5b1a830SBarry Smith 
4985b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
4986b5b1a830SBarry Smith 
4987b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
4988b5b1a830SBarry Smith */
4989cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
4990b5b1a830SBarry Smith {
4991b5b1a830SBarry Smith   PetscErrorCode  ierr;
4992b5b1a830SBarry Smith   TSMatlabContext *sctx;
4993b5b1a830SBarry Smith 
4994b5b1a830SBarry Smith   PetscFunctionBegin;
4995b5b1a830SBarry Smith   /* currently sctx is memory bleed */
4996b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
4997b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
4998b5b1a830SBarry Smith   /*
4999b5b1a830SBarry Smith      This should work, but it doesn't
5000b5b1a830SBarry Smith   sctx->ctx = ctx;
5001b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5002b5b1a830SBarry Smith   */
5003b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5004bbd56ea5SKarl Rupp 
50050298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5006b5b1a830SBarry Smith   PetscFunctionReturn(0);
5007b5b1a830SBarry Smith }
5008325fc9f4SBarry Smith #endif
5009b3603a34SBarry Smith 
50100b039ecaSBarry Smith 
50110b039ecaSBarry Smith 
5012b3603a34SBarry Smith #undef __FUNCT__
50134f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5014b3603a34SBarry Smith /*@C
50154f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5016b3603a34SBarry Smith        in a time based line graph
5017b3603a34SBarry Smith 
5018b3603a34SBarry Smith    Collective on TS
5019b3603a34SBarry Smith 
5020b3603a34SBarry Smith    Input Parameters:
5021b3603a34SBarry Smith +  ts - the TS context
5022b3603a34SBarry Smith .  step - current time-step
5023b3603a34SBarry Smith .  ptime - current time
5024b3603a34SBarry Smith -  lg - a line graph object
5025b3603a34SBarry Smith 
5026b3603a34SBarry Smith    Level: intermediate
5027b3603a34SBarry Smith 
50280b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5029b3603a34SBarry Smith 
5030b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5031b3603a34SBarry Smith 
5032b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5033b3603a34SBarry Smith @*/
50340910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5035b3603a34SBarry Smith {
5036b3603a34SBarry Smith   PetscErrorCode    ierr;
50370b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5038b3603a34SBarry Smith   const PetscScalar *yy;
503958ff32f7SBarry Smith   PetscInt          dim;
5040b3603a34SBarry Smith 
5041b3603a34SBarry Smith   PetscFunctionBegin;
504258ff32f7SBarry Smith   if (!step) {
5043a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5044a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5045a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
50460910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
50470b039ecaSBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
50480b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
504958ff32f7SBarry Smith   }
50500910c330SBarry Smith   ierr = VecGetArrayRead(u,&yy);CHKERRQ(ierr);
5051e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5052e3efe391SJed Brown   {
5053e3efe391SJed Brown     PetscReal *yreal;
5054e3efe391SJed Brown     PetscInt  i,n;
50550910c330SBarry Smith     ierr = VecGetLocalSize(u,&n);CHKERRQ(ierr);
5056785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5057e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
50580b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5059e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5060e3efe391SJed Brown   }
5061e3efe391SJed Brown #else
50620b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5063e3efe391SJed Brown #endif
50640910c330SBarry Smith   ierr = VecRestoreArrayRead(u,&yy);CHKERRQ(ierr);
5065b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
50660b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
50673923b477SBarry Smith   }
5068b3603a34SBarry Smith   PetscFunctionReturn(0);
5069b3603a34SBarry Smith }
5070b3603a34SBarry Smith 
5071b3603a34SBarry Smith #undef __FUNCT__
50724f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
5073ef20d060SBarry Smith /*@C
50744f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
5075ef20d060SBarry Smith        in a time based line graph
5076ef20d060SBarry Smith 
5077ef20d060SBarry Smith    Collective on TS
5078ef20d060SBarry Smith 
5079ef20d060SBarry Smith    Input Parameters:
5080ef20d060SBarry Smith +  ts - the TS context
5081ef20d060SBarry Smith .  step - current time-step
5082ef20d060SBarry Smith .  ptime - current time
5083ef20d060SBarry Smith -  lg - a line graph object
5084ef20d060SBarry Smith 
5085ef20d060SBarry Smith    Level: intermediate
5086ef20d060SBarry Smith 
5087abd5a294SJed Brown    Notes:
5088abd5a294SJed Brown    Only for sequential solves.
5089abd5a294SJed Brown 
5090abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
5091abd5a294SJed Brown 
5092abd5a294SJed Brown    Options Database Keys:
50934f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
5094ef20d060SBarry Smith 
5095ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
5096ef20d060SBarry Smith 
5097abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5098ef20d060SBarry Smith @*/
50990910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5100ef20d060SBarry Smith {
5101ef20d060SBarry Smith   PetscErrorCode    ierr;
51020b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5103ef20d060SBarry Smith   const PetscScalar *yy;
5104ef20d060SBarry Smith   Vec               y;
5105a9f9c1f6SBarry Smith   PetscInt          dim;
5106ef20d060SBarry Smith 
5107ef20d060SBarry Smith   PetscFunctionBegin;
5108a9f9c1f6SBarry Smith   if (!step) {
5109a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5110a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
51111ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
51120910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5113a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5114a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5115a9f9c1f6SBarry Smith   }
51160910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5117ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
51180910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5119ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5120e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5121e3efe391SJed Brown   {
5122e3efe391SJed Brown     PetscReal *yreal;
5123e3efe391SJed Brown     PetscInt  i,n;
5124e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5125785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5126e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
51270b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5128e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5129e3efe391SJed Brown   }
5130e3efe391SJed Brown #else
51310b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5132e3efe391SJed Brown #endif
5133ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5134ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
5135b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
51360b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
51373923b477SBarry Smith   }
5138ef20d060SBarry Smith   PetscFunctionReturn(0);
5139ef20d060SBarry Smith }
5140ef20d060SBarry Smith 
5141201da799SBarry Smith #undef __FUNCT__
5142201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
5143201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5144201da799SBarry Smith {
5145201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5146201da799SBarry Smith   PetscReal      x   = ptime,y;
5147201da799SBarry Smith   PetscErrorCode ierr;
5148201da799SBarry Smith   PetscInt       its;
5149201da799SBarry Smith 
5150201da799SBarry Smith   PetscFunctionBegin;
5151201da799SBarry Smith   if (!n) {
5152201da799SBarry Smith     PetscDrawAxis axis;
5153bbd56ea5SKarl Rupp 
5154201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5155201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5156201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5157bbd56ea5SKarl Rupp 
5158201da799SBarry Smith     ctx->snes_its = 0;
5159201da799SBarry Smith   }
5160201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5161201da799SBarry Smith   y    = its - ctx->snes_its;
5162201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
51633fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5164201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5165201da799SBarry Smith   }
5166201da799SBarry Smith   ctx->snes_its = its;
5167201da799SBarry Smith   PetscFunctionReturn(0);
5168201da799SBarry Smith }
5169201da799SBarry Smith 
5170201da799SBarry Smith #undef __FUNCT__
5171201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
5172201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5173201da799SBarry Smith {
5174201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5175201da799SBarry Smith   PetscReal      x   = ptime,y;
5176201da799SBarry Smith   PetscErrorCode ierr;
5177201da799SBarry Smith   PetscInt       its;
5178201da799SBarry Smith 
5179201da799SBarry Smith   PetscFunctionBegin;
5180201da799SBarry Smith   if (!n) {
5181201da799SBarry Smith     PetscDrawAxis axis;
5182bbd56ea5SKarl Rupp 
5183201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5184201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
5185201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5186bbd56ea5SKarl Rupp 
5187201da799SBarry Smith     ctx->ksp_its = 0;
5188201da799SBarry Smith   }
5189201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
5190201da799SBarry Smith   y    = its - ctx->ksp_its;
5191201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
519299fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5193201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5194201da799SBarry Smith   }
5195201da799SBarry Smith   ctx->ksp_its = its;
5196201da799SBarry Smith   PetscFunctionReturn(0);
5197201da799SBarry Smith }
5198f9c1d6abSBarry Smith 
5199f9c1d6abSBarry Smith #undef __FUNCT__
5200f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
5201f9c1d6abSBarry Smith /*@
5202f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
5203f9c1d6abSBarry Smith 
5204f9c1d6abSBarry Smith    Collective on TS and Vec
5205f9c1d6abSBarry Smith 
5206f9c1d6abSBarry Smith    Input Parameters:
5207f9c1d6abSBarry Smith +  ts - the TS context
5208f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
5209f9c1d6abSBarry Smith 
5210f9c1d6abSBarry Smith    Output Parameters:
5211f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
5212f9c1d6abSBarry Smith 
5213f9c1d6abSBarry Smith    Level: developer
5214f9c1d6abSBarry Smith 
5215f9c1d6abSBarry Smith .keywords: TS, compute
5216f9c1d6abSBarry Smith 
5217f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
5218f9c1d6abSBarry Smith @*/
5219f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5220f9c1d6abSBarry Smith {
5221f9c1d6abSBarry Smith   PetscErrorCode ierr;
5222f9c1d6abSBarry Smith 
5223f9c1d6abSBarry Smith   PetscFunctionBegin;
5224f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5225ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5226f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
5227f9c1d6abSBarry Smith   PetscFunctionReturn(0);
5228f9c1d6abSBarry Smith }
522924655328SShri 
523024655328SShri #undef __FUNCT__
523124655328SShri #define __FUNCT__ "TSRollBack"
523224655328SShri /*@
523324655328SShri    TSRollBack - Rolls back one time step
523424655328SShri 
523524655328SShri    Collective on TS
523624655328SShri 
523724655328SShri    Input Parameter:
523824655328SShri .  ts - the TS context obtained from TSCreate()
523924655328SShri 
524024655328SShri    Level: advanced
524124655328SShri 
524224655328SShri .keywords: TS, timestep, rollback
524324655328SShri 
524424655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
524524655328SShri @*/
524624655328SShri PetscErrorCode  TSRollBack(TS ts)
524724655328SShri {
524824655328SShri   PetscErrorCode ierr;
524924655328SShri 
525024655328SShri   PetscFunctionBegin;
525124655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
525224655328SShri 
525324655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
525424655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
525524655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
525624655328SShri   ts->ptime = ts->ptime_prev;
525724655328SShri   PetscFunctionReturn(0);
525824655328SShri }
5259aeb4809dSShri Abhyankar 
5260ff22ae23SHong Zhang #undef __FUNCT__
5261ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
5262ff22ae23SHong Zhang /*@
5263ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
5264ff22ae23SHong Zhang 
5265ff22ae23SHong Zhang    Input Parameter:
5266ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
5267ff22ae23SHong Zhang 
5268ff22ae23SHong Zhang    Level: advanced
5269ff22ae23SHong Zhang 
5270ff22ae23SHong Zhang .keywords: TS, getstages
5271ff22ae23SHong Zhang 
5272ff22ae23SHong Zhang .seealso: TSCreate()
5273ff22ae23SHong Zhang @*/
5274ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
5275ff22ae23SHong Zhang {
5276ff22ae23SHong Zhang   PetscErrorCode ierr;
5277ff22ae23SHong Zhang 
5278ff22ae23SHong Zhang   PetscFunctionBegin;
5279ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
5280ff22ae23SHong Zhang   PetscValidPointer(ns,2);
5281ff22ae23SHong Zhang 
5282ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
5283ff22ae23SHong Zhang   else {
5284ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
5285ff22ae23SHong Zhang   }
5286ff22ae23SHong Zhang   PetscFunctionReturn(0);
5287ff22ae23SHong Zhang }
5288ff22ae23SHong Zhang 
5289ff22ae23SHong Zhang 
5290ff22ae23SHong Zhang 
5291