xref: /petsc/src/ts/interface/ts.c (revision 51fa3d41ed3feb8cf78b09fc9e5a282491d54f25)
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 
142d5ee99bSBarry Smith struct _n_TSMonitorDrawCtx {
152d5ee99bSBarry Smith   PetscViewer   viewer;
164b363babSBarry Smith   PetscDrawAxis axis;
172d5ee99bSBarry Smith   Vec           initialsolution;
182d5ee99bSBarry Smith   PetscBool     showinitial;
192d5ee99bSBarry Smith   PetscInt      howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
202d5ee99bSBarry Smith   PetscBool     showtimestepandtime;
212d5ee99bSBarry Smith   int           color;
222d5ee99bSBarry Smith };
232d5ee99bSBarry Smith 
24bdad233fSMatthew Knepley #undef __FUNCT__
25bdad233fSMatthew Knepley #define __FUNCT__ "TSSetFromOptions"
26bdad233fSMatthew Knepley /*@
27bdad233fSMatthew Knepley    TSSetFromOptions - Sets various TS parameters from user options.
28bdad233fSMatthew Knepley 
29bdad233fSMatthew Knepley    Collective on TS
30bdad233fSMatthew Knepley 
31bdad233fSMatthew Knepley    Input Parameter:
32bdad233fSMatthew Knepley .  ts - the TS context obtained from TSCreate()
33bdad233fSMatthew Knepley 
34bdad233fSMatthew Knepley    Options Database Keys:
354d91e141SJed Brown +  -ts_type <type> - TSEULER, TSBEULER, TSSUNDIALS, TSPSEUDO, TSCN, TSRK, TSTHETA, TSGL, TSSSP
36ef222394SBarry Smith .  -ts_save_trajectory - checkpoint the solution at each time-step
373e4cdcaaSBarry Smith .  -ts_max_steps <maxsteps> - maximum number of time-steps to take
383e4cdcaaSBarry Smith .  -ts_final_time <time> - maximum time to compute to
393e4cdcaaSBarry Smith .  -ts_dt <dt> - initial time step
40a3cdaa26SBarry 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
41a3cdaa26SBarry Smith .  -ts_max_snes_failures <maxfailures> - Maximum number of nonlinear solve failures allowed
42a3cdaa26SBarry Smith .  -ts_max_reject <maxrejects> - Maximum number of step rejections before step fails
43a3cdaa26SBarry Smith .  -ts_error_if_step_fails <true,false> - Error if no step succeeds
44a3cdaa26SBarry Smith .  -ts_rtol <rtol> - relative tolerance for local truncation error
45a3cdaa26SBarry Smith .  -ts_atol <atol> Absolute tolerance for local truncation error
46ef222394SBarry Smith .  -ts_adjoint_solve <yes,no> After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
47bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
48de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
49de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
50de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
51de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
52de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
53de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
54de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
553e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
563e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
5791b97e58SBarry Smith .  -ts_monitor_solution_binary <filename> - Save each solution to a binary file
58b3d3934dSBarry Smith .  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
59b3d3934dSBarry Smith -  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
6091b97e58SBarry Smith 
6191b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
62bdad233fSMatthew Knepley 
63bdad233fSMatthew Knepley    Level: beginner
64bdad233fSMatthew Knepley 
65bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
66bdad233fSMatthew Knepley 
67a313700dSBarry Smith .seealso: TSGetType()
68bdad233fSMatthew Knepley @*/
697087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
70bdad233fSMatthew Knepley {
71bc952696SBarry Smith   PetscBool              opt,flg,tflg;
72dfbe8321SBarry Smith   PetscErrorCode         ierr;
73649052a6SBarry Smith   PetscViewer            monviewer;
74eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
75089b2837SJed Brown   SNES                   snes;
761c3436cfSJed Brown   TSAdapt                adapt;
7731748224SBarry Smith   PetscReal              time_step;
7849354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
79d1212d36SBarry Smith   char                   dir[16];
806991f827SBarry Smith   const char             *defaultType;
816991f827SBarry Smith   char                   typeName[256];
82bdad233fSMatthew Knepley 
83bdad233fSMatthew Knepley   PetscFunctionBegin;
840700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
853194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
866991f827SBarry Smith   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
876991f827SBarry Smith   else defaultType = TSEULER;
886991f827SBarry Smith 
896991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
906991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
916991f827SBarry Smith   if (opt) {
926991f827SBarry Smith     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
936991f827SBarry Smith   } else {
946991f827SBarry Smith     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
956991f827SBarry Smith   }
96bdad233fSMatthew Knepley 
97bdad233fSMatthew Knepley   /* Handle generic TS options */
98844594baSBarry Smith   if (ts->trajectory) tflg = PETSC_TRUE;
99844594baSBarry Smith   else tflg = PETSC_FALSE;
100920aabf2SBarry Smith   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
101bc952696SBarry Smith   if (tflg) {ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);}
102ef222394SBarry Smith   if (ts->adjoint_solve) tflg = PETSC_TRUE;
103ef222394SBarry Smith   else tflg = PETSC_FALSE;
104ef222394SBarry Smith   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
105ef222394SBarry Smith   if (flg) {
106ef222394SBarry Smith     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
107e87fd094SBarry Smith     ts->adjoint_solve = tflg;
108ef222394SBarry Smith   }
1090298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1100298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1110298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
11231748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
11331748224SBarry Smith   if (flg) {
11431748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
11531748224SBarry Smith   }
11649354f04SShri 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);
11749354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1180298fd71SBarry 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);
1190298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1200298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1210298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1220298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
123bdad233fSMatthew Knepley 
12456f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
12556f85f32SBarry Smith   {
12656f85f32SBarry Smith   PetscBool set;
12756f85f32SBarry Smith   flg  = PETSC_FALSE;
12856f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
12956f85f32SBarry Smith   if (set) {
13056f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
13156f85f32SBarry Smith   }
13256f85f32SBarry Smith   }
13356f85f32SBarry Smith #endif
13456f85f32SBarry Smith 
135bdad233fSMatthew Knepley   /* Monitor options */
136a6570f20SBarry Smith   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
137eabae89aSBarry Smith   if (flg) {
138ce94432eSBarry Smith     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
139649052a6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
140bdad233fSMatthew Knepley   }
1415180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1425180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1435180491cSLisandro Dalcin 
1444f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
145a7cc72afSBarry Smith   if (opt) {
1460b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1473923b477SBarry Smith     PetscInt       howoften = 1;
148a80ad3e0SBarry Smith 
1490298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
150ce94432eSBarry Smith     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1514f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
152b3603a34SBarry Smith   }
1534f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
154b3603a34SBarry Smith   if (opt) {
1550b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1563923b477SBarry Smith     PetscInt       howoften = 1;
157b3603a34SBarry Smith 
1580298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
15922d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1604f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
161bdad233fSMatthew Knepley   }
1624f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
163ef20d060SBarry Smith   if (opt) {
1640b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1653923b477SBarry Smith     PetscInt       howoften = 1;
166ef20d060SBarry Smith 
1670298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
16822d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1694f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
170ef20d060SBarry Smith   }
171201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
172201da799SBarry Smith   if (opt) {
173201da799SBarry Smith     TSMonitorLGCtx ctx;
174201da799SBarry Smith     PetscInt       howoften = 1;
175201da799SBarry Smith 
1760298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
17722d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
178201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
179201da799SBarry Smith   }
180201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
181201da799SBarry Smith   if (opt) {
182201da799SBarry Smith     TSMonitorLGCtx ctx;
183201da799SBarry Smith     PetscInt       howoften = 1;
184201da799SBarry Smith 
1850298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
18622d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
187201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
188201da799SBarry Smith   }
1898189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
1908189c53fSBarry Smith   if (opt) {
1918189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
1928189c53fSBarry Smith     PetscInt          howoften = 1;
1938189c53fSBarry Smith 
1940298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
19522d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1968189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
1978189c53fSBarry Smith   }
198ef20d060SBarry Smith   opt  = PETSC_FALSE;
1990dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
200a7cc72afSBarry Smith   if (opt) {
20183a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
20283a4ac43SBarry Smith     PetscInt         howoften = 1;
203a80ad3e0SBarry Smith 
2040298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
205ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
20683a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
207bdad233fSMatthew Knepley   }
208fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2092d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2102d5ee99bSBarry Smith   if (opt) {
2112d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2122d5ee99bSBarry Smith     PetscReal        bounds[4];
2132d5ee99bSBarry Smith     PetscInt         n = 4;
2142d5ee99bSBarry Smith     PetscDraw        draw;
2152d5ee99bSBarry Smith 
2162d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2172d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2182d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
2192d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2202d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
2214b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
2224b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
223f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2244b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
22507995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
2262d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2272d5ee99bSBarry Smith   }
2282d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2290dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2303a471f94SBarry Smith   if (opt) {
23183a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
23283a4ac43SBarry Smith     PetscInt         howoften = 1;
2333a471f94SBarry Smith 
2340298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
235ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
23683a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2373a471f94SBarry Smith   }
2383a471f94SBarry Smith   opt  = PETSC_FALSE;
23991b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
240fb1732b5SBarry Smith   if (flg) {
241fb1732b5SBarry Smith     PetscViewer ctx;
242fb1732b5SBarry Smith     if (monfilename[0]) {
243ce94432eSBarry Smith       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
244c2fbc07fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
245fb1732b5SBarry Smith     } else {
246ce94432eSBarry Smith       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
2470298fd71SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
248fb1732b5SBarry Smith     }
249fb1732b5SBarry Smith   }
250ed81e22dSJed Brown   opt  = PETSC_FALSE;
25191b97e58SBarry 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);
252ed81e22dSJed Brown   if (flg) {
253ed81e22dSJed Brown     const char *ptr,*ptr2;
254ed81e22dSJed Brown     char       *filetemplate;
255ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
256ed81e22dSJed Brown     /* Do some cursory validation of the input. */
257ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
258ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
259ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
260ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
261ce94432eSBarry 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");
262ed81e22dSJed Brown       if (ptr2) break;
263ed81e22dSJed Brown     }
264ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
265ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
266ed81e22dSJed Brown   }
267bdad233fSMatthew Knepley 
268d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
269d1212d36SBarry Smith   if (flg) {
270d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
271d1212d36SBarry Smith     int                  ray = 0;
272d1212d36SBarry Smith     DMDADirection        ddir;
273d1212d36SBarry Smith     DM                   da;
274d1212d36SBarry Smith     PetscMPIInt          rank;
275d1212d36SBarry Smith 
276ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
277d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
278d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
279ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
280d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
281d1212d36SBarry Smith 
282d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
283b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
284d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
285d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
286ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
287d1212d36SBarry Smith     if (!rank) {
288d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
289d1212d36SBarry Smith     }
29051b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
291d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
292d1212d36SBarry Smith   }
29351b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
29451b4a12fSMatthew G. Knepley   if (flg) {
29551b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
29651b4a12fSMatthew G. Knepley     int                 ray = 0;
29751b4a12fSMatthew G. Knepley     DMDADirection       ddir;
29851b4a12fSMatthew G. Knepley     DM                  da;
29951b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
300d1212d36SBarry Smith 
30151b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
30251b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
30351b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
30451b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
30551b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
30651b4a12fSMatthew G. Knepley 
30751b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
308b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
30951b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
31051b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
31151b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
31251b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
31351b4a12fSMatthew G. Knepley   }
314a7a1495cSBarry Smith 
315b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
316b3d3934dSBarry Smith   if (opt) {
317b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
318b3d3934dSBarry Smith 
319b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
320b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
321b3d3934dSBarry Smith   }
322b3d3934dSBarry Smith 
3237781c08eSBarry Smith   /*
3247781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
3257781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
3267781c08eSBarry Smith   */
327552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
328e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
329d763cef2SBarry Smith 
3306991f827SBarry Smith     /* Handle specific TS options */
3316991f827SBarry Smith   if (ts->ops->setfromoptions) {
3326991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
3336991f827SBarry Smith   }
3346991f827SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
3356991f827SBarry Smith 
3366991f827SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
3376991f827SBarry Smith   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
338d763cef2SBarry Smith 
339bc952696SBarry Smith   if (ts->trajectory) {
340bc952696SBarry Smith     ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr);
341bc952696SBarry Smith   }
342bc952696SBarry Smith 
3436991f827SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3446991f827SBarry Smith   if (snes) {
3456991f827SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
3466991f827SBarry Smith     ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
347d763cef2SBarry Smith   }
348d763cef2SBarry Smith   PetscFunctionReturn(0);
349d763cef2SBarry Smith }
350d763cef2SBarry Smith 
351d763cef2SBarry Smith #undef __FUNCT__
352bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
353d2daff3dSHong Zhang /*@
354bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
355d2daff3dSHong Zhang 
356d2daff3dSHong Zhang    Collective on TS
357d2daff3dSHong Zhang 
358d2daff3dSHong Zhang    Input Parameters:
359bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
360bc952696SBarry Smith 
361d2daff3dSHong Zhang 
362d2daff3dSHong Zhang    Level: intermediate
363d2daff3dSHong Zhang 
364bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
365d2daff3dSHong Zhang 
366bc952696SBarry Smith .keywords: TS, set, checkpoint,
367d2daff3dSHong Zhang @*/
368bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
369d2daff3dSHong Zhang {
370bc952696SBarry Smith   PetscErrorCode ierr;
371bc952696SBarry Smith 
372d2daff3dSHong Zhang   PetscFunctionBegin;
373d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
374bc952696SBarry Smith   if (!ts->trajectory) {
375bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
376920aabf2SBarry Smith     ierr = TSTrajectorySetType(ts->trajectory,TSTRAJECTORYBASIC);CHKERRQ(ierr);
377bc952696SBarry Smith   }
378d2daff3dSHong Zhang   PetscFunctionReturn(0);
379d2daff3dSHong Zhang }
380d2daff3dSHong Zhang 
381a7a1495cSBarry Smith #undef __FUNCT__
382a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
383a7a1495cSBarry Smith /*@
384a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
385a7a1495cSBarry Smith       set with TSSetRHSJacobian().
386a7a1495cSBarry Smith 
387a7a1495cSBarry Smith    Collective on TS and Vec
388a7a1495cSBarry Smith 
389a7a1495cSBarry Smith    Input Parameters:
390316643e7SJed Brown +  ts - the TS context
391a7a1495cSBarry Smith .  t - current timestep
3920910c330SBarry Smith -  U - input vector
393a7a1495cSBarry Smith 
394a7a1495cSBarry Smith    Output Parameters:
395a7a1495cSBarry Smith +  A - Jacobian matrix
396a7a1495cSBarry Smith .  B - optional preconditioning matrix
397a7a1495cSBarry Smith -  flag - flag indicating matrix structure
398a7a1495cSBarry Smith 
399a7a1495cSBarry Smith    Notes:
400a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
401a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
402a7a1495cSBarry Smith 
40394b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
404a7a1495cSBarry Smith    flag parameter.
405a7a1495cSBarry Smith 
406a7a1495cSBarry Smith    Level: developer
407a7a1495cSBarry Smith 
408a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
409a7a1495cSBarry Smith 
41094b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
411a7a1495cSBarry Smith @*/
412d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
413a7a1495cSBarry Smith {
414dfbe8321SBarry Smith   PetscErrorCode ierr;
415270bf2e7SJed Brown   PetscObjectState Ustate;
41624989b8cSPeter Brune   DM             dm;
417942e3340SBarry Smith   DMTS           tsdm;
41824989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
41924989b8cSPeter Brune   void           *ctx;
42024989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
421a7a1495cSBarry Smith 
422a7a1495cSBarry Smith   PetscFunctionBegin;
4230700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4240910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4250910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
42624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
427942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
42824989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4290298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
43059e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
4310910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4320e4ef248SJed Brown     PetscFunctionReturn(0);
433f8ede8e7SJed Brown   }
434d90be118SSean Farley 
435ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
436d90be118SSean Farley 
437e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
43894ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
43994ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
44094ab13aaSBarry Smith     if (A != B) {
44194ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
44294ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
443e1244c69SJed Brown     }
444e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
445e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
446e1244c69SJed Brown   }
447e1244c69SJed Brown 
44824989b8cSPeter Brune   if (rhsjacobianfunc) {
44994ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
450a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
451d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
452a7a1495cSBarry Smith     PetscStackPop;
45394ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
454a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
45594ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
45694ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
457ef66eb69SBarry Smith   } else {
45894ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
45994ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
460ef66eb69SBarry Smith   }
4610e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4620910c330SBarry Smith   ts->rhsjacobian.X          = U;
46359e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
464a7a1495cSBarry Smith   PetscFunctionReturn(0);
465a7a1495cSBarry Smith }
466a7a1495cSBarry Smith 
4674a2ae208SSatish Balay #undef __FUNCT__
4684a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
469316643e7SJed Brown /*@
470d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
471d763cef2SBarry Smith 
472316643e7SJed Brown    Collective on TS and Vec
473316643e7SJed Brown 
474316643e7SJed Brown    Input Parameters:
475316643e7SJed Brown +  ts - the TS context
476316643e7SJed Brown .  t - current time
4770910c330SBarry Smith -  U - state vector
478316643e7SJed Brown 
479316643e7SJed Brown    Output Parameter:
480316643e7SJed Brown .  y - right hand side
481316643e7SJed Brown 
482316643e7SJed Brown    Note:
483316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
484316643e7SJed Brown    is used internally within the nonlinear solvers.
485316643e7SJed Brown 
486316643e7SJed Brown    Level: developer
487316643e7SJed Brown 
488316643e7SJed Brown .keywords: TS, compute
489316643e7SJed Brown 
490316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
491316643e7SJed Brown @*/
4920910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
493d763cef2SBarry Smith {
494dfbe8321SBarry Smith   PetscErrorCode ierr;
49524989b8cSPeter Brune   TSRHSFunction  rhsfunction;
49624989b8cSPeter Brune   TSIFunction    ifunction;
49724989b8cSPeter Brune   void           *ctx;
49824989b8cSPeter Brune   DM             dm;
49924989b8cSPeter Brune 
500d763cef2SBarry Smith   PetscFunctionBegin;
5010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5020910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5030700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
50424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
50524989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5060298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
507d763cef2SBarry Smith 
508ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
509d763cef2SBarry Smith 
5100910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
51124989b8cSPeter Brune   if (rhsfunction) {
512d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5130910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
514d763cef2SBarry Smith     PetscStackPop;
515214bc6a2SJed Brown   } else {
516214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
517b2cd27e8SJed Brown   }
51844a41b28SSean Farley 
5190910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
520d763cef2SBarry Smith   PetscFunctionReturn(0);
521d763cef2SBarry Smith }
522d763cef2SBarry Smith 
5234a2ae208SSatish Balay #undef __FUNCT__
524ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
525ef20d060SBarry Smith /*@
526ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
527ef20d060SBarry Smith 
528ef20d060SBarry Smith    Collective on TS and Vec
529ef20d060SBarry Smith 
530ef20d060SBarry Smith    Input Parameters:
531ef20d060SBarry Smith +  ts - the TS context
532ef20d060SBarry Smith -  t - current time
533ef20d060SBarry Smith 
534ef20d060SBarry Smith    Output Parameter:
5350910c330SBarry Smith .  U - the solution
536ef20d060SBarry Smith 
537ef20d060SBarry Smith    Note:
538ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
539ef20d060SBarry Smith    is used internally within the nonlinear solvers.
540ef20d060SBarry Smith 
541ef20d060SBarry Smith    Level: developer
542ef20d060SBarry Smith 
543ef20d060SBarry Smith .keywords: TS, compute
544ef20d060SBarry Smith 
545abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
546ef20d060SBarry Smith @*/
5470910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
548ef20d060SBarry Smith {
549ef20d060SBarry Smith   PetscErrorCode     ierr;
550ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
551ef20d060SBarry Smith   void               *ctx;
552ef20d060SBarry Smith   DM                 dm;
553ef20d060SBarry Smith 
554ef20d060SBarry Smith   PetscFunctionBegin;
555ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5560910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
557ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
558ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
559ef20d060SBarry Smith 
560ef20d060SBarry Smith   if (solutionfunction) {
5619b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5620910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
563ef20d060SBarry Smith     PetscStackPop;
564ef20d060SBarry Smith   }
565ef20d060SBarry Smith   PetscFunctionReturn(0);
566ef20d060SBarry Smith }
5679b7cd975SBarry Smith #undef __FUNCT__
5689b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5699b7cd975SBarry Smith /*@
5709b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5719b7cd975SBarry Smith 
5729b7cd975SBarry Smith    Collective on TS and Vec
5739b7cd975SBarry Smith 
5749b7cd975SBarry Smith    Input Parameters:
5759b7cd975SBarry Smith +  ts - the TS context
5769b7cd975SBarry Smith -  t - current time
5779b7cd975SBarry Smith 
5789b7cd975SBarry Smith    Output Parameter:
5799b7cd975SBarry Smith .  U - the function value
5809b7cd975SBarry Smith 
5819b7cd975SBarry Smith    Note:
5829b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
5839b7cd975SBarry Smith    is used internally within the nonlinear solvers.
5849b7cd975SBarry Smith 
5859b7cd975SBarry Smith    Level: developer
5869b7cd975SBarry Smith 
5879b7cd975SBarry Smith .keywords: TS, compute
5889b7cd975SBarry Smith 
5899b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
5909b7cd975SBarry Smith @*/
5919b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
5929b7cd975SBarry Smith {
5939b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
5949b7cd975SBarry Smith   void               *ctx;
5959b7cd975SBarry Smith   DM                 dm;
5969b7cd975SBarry Smith 
5979b7cd975SBarry Smith   PetscFunctionBegin;
5989b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5999b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6009b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6019b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6029b7cd975SBarry Smith 
6039b7cd975SBarry Smith   if (forcing) {
6049b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6059b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6069b7cd975SBarry Smith     PetscStackPop;
6079b7cd975SBarry Smith   }
6089b7cd975SBarry Smith   PetscFunctionReturn(0);
6099b7cd975SBarry Smith }
610ef20d060SBarry Smith 
611ef20d060SBarry Smith #undef __FUNCT__
612214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
613214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
614214bc6a2SJed Brown {
6152dd45cf8SJed Brown   Vec            F;
616214bc6a2SJed Brown   PetscErrorCode ierr;
617214bc6a2SJed Brown 
618214bc6a2SJed Brown   PetscFunctionBegin;
6190298fd71SBarry Smith   *Frhs = NULL;
6200298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
621214bc6a2SJed Brown   if (!ts->Frhs) {
6222dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
623214bc6a2SJed Brown   }
624214bc6a2SJed Brown   *Frhs = ts->Frhs;
625214bc6a2SJed Brown   PetscFunctionReturn(0);
626214bc6a2SJed Brown }
627214bc6a2SJed Brown 
628214bc6a2SJed Brown #undef __FUNCT__
629214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
630214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
631214bc6a2SJed Brown {
632214bc6a2SJed Brown   Mat            A,B;
6332dd45cf8SJed Brown   PetscErrorCode ierr;
634214bc6a2SJed Brown 
635214bc6a2SJed Brown   PetscFunctionBegin;
636c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
637c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6380298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
639214bc6a2SJed Brown   if (Arhs) {
640214bc6a2SJed Brown     if (!ts->Arhs) {
641214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
642214bc6a2SJed Brown     }
643214bc6a2SJed Brown     *Arhs = ts->Arhs;
644214bc6a2SJed Brown   }
645214bc6a2SJed Brown   if (Brhs) {
646214bc6a2SJed Brown     if (!ts->Brhs) {
647bdb70873SJed Brown       if (A != B) {
648214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
649bdb70873SJed Brown       } else {
650bdb70873SJed Brown         ts->Brhs = ts->Arhs;
651bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
652bdb70873SJed Brown       }
653214bc6a2SJed Brown     }
654214bc6a2SJed Brown     *Brhs = ts->Brhs;
655214bc6a2SJed Brown   }
656214bc6a2SJed Brown   PetscFunctionReturn(0);
657214bc6a2SJed Brown }
658214bc6a2SJed Brown 
659214bc6a2SJed Brown #undef __FUNCT__
660316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
661316643e7SJed Brown /*@
6620910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
663316643e7SJed Brown 
664316643e7SJed Brown    Collective on TS and Vec
665316643e7SJed Brown 
666316643e7SJed Brown    Input Parameters:
667316643e7SJed Brown +  ts - the TS context
668316643e7SJed Brown .  t - current time
6690910c330SBarry Smith .  U - state vector
6700910c330SBarry Smith .  Udot - time derivative of state vector
671214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
672316643e7SJed Brown 
673316643e7SJed Brown    Output Parameter:
674316643e7SJed Brown .  Y - right hand side
675316643e7SJed Brown 
676316643e7SJed Brown    Note:
677316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
678316643e7SJed Brown    is used internally within the nonlinear solvers.
679316643e7SJed Brown 
680316643e7SJed Brown    If the user did did not write their equations in implicit form, this
681316643e7SJed Brown    function recasts them in implicit form.
682316643e7SJed Brown 
683316643e7SJed Brown    Level: developer
684316643e7SJed Brown 
685316643e7SJed Brown .keywords: TS, compute
686316643e7SJed Brown 
687316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
688316643e7SJed Brown @*/
6890910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
690316643e7SJed Brown {
691316643e7SJed Brown   PetscErrorCode ierr;
69224989b8cSPeter Brune   TSIFunction    ifunction;
69324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
69424989b8cSPeter Brune   void           *ctx;
69524989b8cSPeter Brune   DM             dm;
696316643e7SJed Brown 
697316643e7SJed Brown   PetscFunctionBegin;
6980700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6990910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7000910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7010700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
702316643e7SJed Brown 
70324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
70424989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7050298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
70624989b8cSPeter Brune 
707ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
708d90be118SSean Farley 
7090910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
71024989b8cSPeter Brune   if (ifunction) {
711316643e7SJed Brown     PetscStackPush("TS user implicit function");
7120910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
713316643e7SJed Brown     PetscStackPop;
714214bc6a2SJed Brown   }
715214bc6a2SJed Brown   if (imex) {
71624989b8cSPeter Brune     if (!ifunction) {
7170910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7182dd45cf8SJed Brown     }
71924989b8cSPeter Brune   } else if (rhsfunction) {
72024989b8cSPeter Brune     if (ifunction) {
721214bc6a2SJed Brown       Vec Frhs;
722214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7230910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
724214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7252dd45cf8SJed Brown     } else {
7260910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7270910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
728316643e7SJed Brown     }
7294a6899ffSJed Brown   }
7300910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
731316643e7SJed Brown   PetscFunctionReturn(0);
732316643e7SJed Brown }
733316643e7SJed Brown 
734316643e7SJed Brown #undef __FUNCT__
735316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
736316643e7SJed Brown /*@
737316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
738316643e7SJed Brown 
739316643e7SJed Brown    Collective on TS and Vec
740316643e7SJed Brown 
741316643e7SJed Brown    Input
742316643e7SJed Brown       Input Parameters:
743316643e7SJed Brown +  ts - the TS context
744316643e7SJed Brown .  t - current timestep
7450910c330SBarry Smith .  U - state vector
7460910c330SBarry Smith .  Udot - time derivative of state vector
747214bc6a2SJed Brown .  shift - shift to apply, see note below
748214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
749316643e7SJed Brown 
750316643e7SJed Brown    Output Parameters:
751316643e7SJed Brown +  A - Jacobian matrix
752316643e7SJed Brown .  B - optional preconditioning matrix
753316643e7SJed Brown -  flag - flag indicating matrix structure
754316643e7SJed Brown 
755316643e7SJed Brown    Notes:
7560910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
757316643e7SJed Brown 
7580910c330SBarry Smith    dF/dU + shift*dF/dUdot
759316643e7SJed Brown 
760316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
761316643e7SJed Brown    is used internally within the nonlinear solvers.
762316643e7SJed Brown 
763316643e7SJed Brown    Level: developer
764316643e7SJed Brown 
765316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
766316643e7SJed Brown 
767316643e7SJed Brown .seealso:  TSSetIJacobian()
76863495f91SJed Brown @*/
769d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
770316643e7SJed Brown {
771316643e7SJed Brown   PetscErrorCode ierr;
77224989b8cSPeter Brune   TSIJacobian    ijacobian;
77324989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
77424989b8cSPeter Brune   DM             dm;
77524989b8cSPeter Brune   void           *ctx;
776316643e7SJed Brown 
777316643e7SJed Brown   PetscFunctionBegin;
7780700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7790910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7800910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
781316643e7SJed Brown   PetscValidPointer(A,6);
78294ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
783316643e7SJed Brown   PetscValidPointer(B,7);
78494ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
78524989b8cSPeter Brune 
78624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
78724989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
7880298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
78924989b8cSPeter Brune 
790ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
791316643e7SJed Brown 
79294ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
79324989b8cSPeter Brune   if (ijacobian) {
794316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
795d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
796316643e7SJed Brown     PetscStackPop;
797214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
79894ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
79994ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8004a6899ffSJed Brown   }
801214bc6a2SJed Brown   if (imex) {
802b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
80394ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
80494ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
80594ab13aaSBarry Smith       if (A != B) {
80694ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
80794ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
808214bc6a2SJed Brown       }
809214bc6a2SJed Brown     }
810214bc6a2SJed Brown   } else {
811e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
812e1244c69SJed Brown     if (rhsjacobian) {
813bd373395SBarry Smith       if (ijacobian) {
814e1244c69SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
815bd373395SBarry Smith       } else {
816bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
817e1244c69SJed Brown       }
818d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
819e1244c69SJed Brown     }
82094ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
821e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
822e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
82394ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
82494ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
82594ab13aaSBarry Smith       if (A != B) {
82694ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
82794ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
828316643e7SJed Brown       }
829e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
830e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
831e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
83294ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
83394ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
83494ab13aaSBarry Smith         if (A != B) {
83594ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
83694ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
837e1244c69SJed Brown         }
838e1244c69SJed Brown       }
83994ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
84094ab13aaSBarry Smith       if (A != B) {
84194ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
842214bc6a2SJed Brown       }
843316643e7SJed Brown     }
844316643e7SJed Brown   }
84594ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
846316643e7SJed Brown   PetscFunctionReturn(0);
847316643e7SJed Brown }
848316643e7SJed Brown 
849316643e7SJed Brown #undef __FUNCT__
8504a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
851d763cef2SBarry Smith /*@C
852d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
853b5abc632SBarry Smith     where U_t = G(t,u).
854d763cef2SBarry Smith 
8553f9fe445SBarry Smith     Logically Collective on TS
856d763cef2SBarry Smith 
857d763cef2SBarry Smith     Input Parameters:
858d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8590298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
860d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
861d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8620298fd71SBarry Smith           function evaluation routine (may be NULL)
863d763cef2SBarry Smith 
864d763cef2SBarry Smith     Calling sequence of func:
86587828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
866d763cef2SBarry Smith 
867d763cef2SBarry Smith +   t - current timestep
868d763cef2SBarry Smith .   u - input vector
869d763cef2SBarry Smith .   F - function vector
870d763cef2SBarry Smith -   ctx - [optional] user-defined function context
871d763cef2SBarry Smith 
872d763cef2SBarry Smith     Level: beginner
873d763cef2SBarry Smith 
8742bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
8752bbac0d3SBarry Smith 
876d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
877d763cef2SBarry Smith 
878ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
879d763cef2SBarry Smith @*/
880089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
881d763cef2SBarry Smith {
882089b2837SJed Brown   PetscErrorCode ierr;
883089b2837SJed Brown   SNES           snes;
8840298fd71SBarry Smith   Vec            ralloc = NULL;
88524989b8cSPeter Brune   DM             dm;
886d763cef2SBarry Smith 
887089b2837SJed Brown   PetscFunctionBegin;
8880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
889ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
89024989b8cSPeter Brune 
89124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
89224989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
893089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
894e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
895e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
896e856ceecSJed Brown     r    = ralloc;
897e856ceecSJed Brown   }
898089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
899e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
900d763cef2SBarry Smith   PetscFunctionReturn(0);
901d763cef2SBarry Smith }
902d763cef2SBarry Smith 
9034a2ae208SSatish Balay #undef __FUNCT__
904ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
905ef20d060SBarry Smith /*@C
906abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
907ef20d060SBarry Smith 
908ef20d060SBarry Smith     Logically Collective on TS
909ef20d060SBarry Smith 
910ef20d060SBarry Smith     Input Parameters:
911ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
912ef20d060SBarry Smith .   f - routine for evaluating the solution
913ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9140298fd71SBarry Smith           function evaluation routine (may be NULL)
915ef20d060SBarry Smith 
916ef20d060SBarry Smith     Calling sequence of func:
917ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
918ef20d060SBarry Smith 
919ef20d060SBarry Smith +   t - current timestep
920ef20d060SBarry Smith .   u - output vector
921ef20d060SBarry Smith -   ctx - [optional] user-defined function context
922ef20d060SBarry Smith 
923abd5a294SJed Brown     Notes:
924abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
925abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
926abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
927abd5a294SJed Brown 
9284f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
929abd5a294SJed Brown 
930ef20d060SBarry Smith     Level: beginner
931ef20d060SBarry Smith 
932ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
933ef20d060SBarry Smith 
9349b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
935ef20d060SBarry Smith @*/
936ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
937ef20d060SBarry Smith {
938ef20d060SBarry Smith   PetscErrorCode ierr;
939ef20d060SBarry Smith   DM             dm;
940ef20d060SBarry Smith 
941ef20d060SBarry Smith   PetscFunctionBegin;
942ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
943ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
944ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
945ef20d060SBarry Smith   PetscFunctionReturn(0);
946ef20d060SBarry Smith }
947ef20d060SBarry Smith 
948ef20d060SBarry Smith #undef __FUNCT__
9499b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9509b7cd975SBarry Smith /*@C
9519b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9529b7cd975SBarry Smith 
9539b7cd975SBarry Smith     Logically Collective on TS
9549b7cd975SBarry Smith 
9559b7cd975SBarry Smith     Input Parameters:
9569b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9579b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9589b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9590298fd71SBarry Smith           function evaluation routine (may be NULL)
9609b7cd975SBarry Smith 
9619b7cd975SBarry Smith     Calling sequence of func:
9629b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9639b7cd975SBarry Smith 
9649b7cd975SBarry Smith +   t - current timestep
9659b7cd975SBarry Smith .   u - output vector
9669b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9679b7cd975SBarry Smith 
9689b7cd975SBarry Smith     Notes:
9699b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9709b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9719b7cd975SBarry Smith 
9729b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9739b7cd975SBarry Smith 
9749b7cd975SBarry Smith     Level: beginner
9759b7cd975SBarry Smith 
9769b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9779b7cd975SBarry Smith 
9789b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
9799b7cd975SBarry Smith @*/
9809b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
9819b7cd975SBarry Smith {
9829b7cd975SBarry Smith   PetscErrorCode ierr;
9839b7cd975SBarry Smith   DM             dm;
9849b7cd975SBarry Smith 
9859b7cd975SBarry Smith   PetscFunctionBegin;
9869b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
9879b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
9889b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
9899b7cd975SBarry Smith   PetscFunctionReturn(0);
9909b7cd975SBarry Smith }
9919b7cd975SBarry Smith 
9929b7cd975SBarry Smith #undef __FUNCT__
9934a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
994d763cef2SBarry Smith /*@C
995f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
996b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
997d763cef2SBarry Smith 
9983f9fe445SBarry Smith    Logically Collective on TS
999d763cef2SBarry Smith 
1000d763cef2SBarry Smith    Input Parameters:
1001d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1002e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1003e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1004d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1005d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10060298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1007d763cef2SBarry Smith 
1008f7ab8db6SBarry Smith    Calling sequence of f:
1009ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1010d763cef2SBarry Smith 
1011d763cef2SBarry Smith +  t - current timestep
1012d763cef2SBarry Smith .  u - input vector
1013e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1014e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1015d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1016d763cef2SBarry Smith 
1017d763cef2SBarry Smith 
1018d763cef2SBarry Smith    Level: beginner
1019d763cef2SBarry Smith 
1020d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1021d763cef2SBarry Smith 
1022ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1023d763cef2SBarry Smith 
1024d763cef2SBarry Smith @*/
1025e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1026d763cef2SBarry Smith {
1027277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1028089b2837SJed Brown   SNES           snes;
102924989b8cSPeter Brune   DM             dm;
103024989b8cSPeter Brune   TSIJacobian    ijacobian;
1031277b19d0SLisandro Dalcin 
1032d763cef2SBarry Smith   PetscFunctionBegin;
10330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1034e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1035e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1036e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1037e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1038d763cef2SBarry Smith 
103924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
104024989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1041e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1042e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1043e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1044e1244c69SJed Brown   }
10450298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1046089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10475f659677SPeter Brune   if (!ijacobian) {
1048e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10490e4ef248SJed Brown   }
1050e5d3d808SBarry Smith   if (Amat) {
1051e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10520e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1053bbd56ea5SKarl Rupp 
1054e5d3d808SBarry Smith     ts->Arhs = Amat;
10550e4ef248SJed Brown   }
1056e5d3d808SBarry Smith   if (Pmat) {
1057e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10580e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1059bbd56ea5SKarl Rupp 
1060e5d3d808SBarry Smith     ts->Brhs = Pmat;
10610e4ef248SJed Brown   }
1062d763cef2SBarry Smith   PetscFunctionReturn(0);
1063d763cef2SBarry Smith }
1064d763cef2SBarry Smith 
1065316643e7SJed Brown 
1066316643e7SJed Brown #undef __FUNCT__
1067316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1068316643e7SJed Brown /*@C
1069b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1070316643e7SJed Brown 
10713f9fe445SBarry Smith    Logically Collective on TS
1072316643e7SJed Brown 
1073316643e7SJed Brown    Input Parameters:
1074316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10750298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1076316643e7SJed Brown .  f   - the function evaluation routine
10770298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1078316643e7SJed Brown 
1079316643e7SJed Brown    Calling sequence of f:
1080316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1081316643e7SJed Brown 
1082316643e7SJed Brown +  t   - time at step/stage being solved
1083316643e7SJed Brown .  u   - state vector
1084316643e7SJed Brown .  u_t - time derivative of state vector
1085316643e7SJed Brown .  F   - function vector
1086316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1087316643e7SJed Brown 
1088316643e7SJed Brown    Important:
10892bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1090316643e7SJed Brown 
1091316643e7SJed Brown    Level: beginner
1092316643e7SJed Brown 
1093316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1094316643e7SJed Brown 
1095d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1096316643e7SJed Brown @*/
1097089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1098316643e7SJed Brown {
1099089b2837SJed Brown   PetscErrorCode ierr;
1100089b2837SJed Brown   SNES           snes;
11010298fd71SBarry Smith   Vec            resalloc = NULL;
110224989b8cSPeter Brune   DM             dm;
1103316643e7SJed Brown 
1104316643e7SJed Brown   PetscFunctionBegin;
11050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1106ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
110724989b8cSPeter Brune 
110824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
110924989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
111024989b8cSPeter Brune 
1111089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1112e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1113e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1114e856ceecSJed Brown     res  = resalloc;
1115e856ceecSJed Brown   }
1116089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1117e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1118089b2837SJed Brown   PetscFunctionReturn(0);
1119089b2837SJed Brown }
1120089b2837SJed Brown 
1121089b2837SJed Brown #undef __FUNCT__
1122089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1123089b2837SJed Brown /*@C
1124089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1125089b2837SJed Brown 
1126089b2837SJed Brown    Not Collective
1127089b2837SJed Brown 
1128089b2837SJed Brown    Input Parameter:
1129089b2837SJed Brown .  ts - the TS context
1130089b2837SJed Brown 
1131089b2837SJed Brown    Output Parameter:
11320298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11330298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11340298fd71SBarry Smith -  ctx - the function context (or NULL)
1135089b2837SJed Brown 
1136089b2837SJed Brown    Level: advanced
1137089b2837SJed Brown 
1138089b2837SJed Brown .keywords: TS, nonlinear, get, function
1139089b2837SJed Brown 
1140089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1141089b2837SJed Brown @*/
1142089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1143089b2837SJed Brown {
1144089b2837SJed Brown   PetscErrorCode ierr;
1145089b2837SJed Brown   SNES           snes;
114624989b8cSPeter Brune   DM             dm;
1147089b2837SJed Brown 
1148089b2837SJed Brown   PetscFunctionBegin;
1149089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1150089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11510298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
115224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
115324989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1154089b2837SJed Brown   PetscFunctionReturn(0);
1155089b2837SJed Brown }
1156089b2837SJed Brown 
1157089b2837SJed Brown #undef __FUNCT__
1158089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1159089b2837SJed Brown /*@C
1160089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1161089b2837SJed Brown 
1162089b2837SJed Brown    Not Collective
1163089b2837SJed Brown 
1164089b2837SJed Brown    Input Parameter:
1165089b2837SJed Brown .  ts - the TS context
1166089b2837SJed Brown 
1167089b2837SJed Brown    Output Parameter:
11680298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11690298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11700298fd71SBarry Smith -  ctx - the function context (or NULL)
1171089b2837SJed Brown 
1172089b2837SJed Brown    Level: advanced
1173089b2837SJed Brown 
1174089b2837SJed Brown .keywords: TS, nonlinear, get, function
1175089b2837SJed Brown 
11762bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1177089b2837SJed Brown @*/
1178089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1179089b2837SJed Brown {
1180089b2837SJed Brown   PetscErrorCode ierr;
1181089b2837SJed Brown   SNES           snes;
118224989b8cSPeter Brune   DM             dm;
1183089b2837SJed Brown 
1184089b2837SJed Brown   PetscFunctionBegin;
1185089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1186089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11870298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
118824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
118924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1190316643e7SJed Brown   PetscFunctionReturn(0);
1191316643e7SJed Brown }
1192316643e7SJed Brown 
1193316643e7SJed Brown #undef __FUNCT__
1194316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1195316643e7SJed Brown /*@C
1196a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1197ae8867d6SBarry Smith         provided with TSSetIFunction().
1198316643e7SJed Brown 
11993f9fe445SBarry Smith    Logically Collective on TS
1200316643e7SJed Brown 
1201316643e7SJed Brown    Input Parameters:
1202316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1203e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1204e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1205316643e7SJed Brown .  f   - the Jacobian evaluation routine
12060298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1207316643e7SJed Brown 
1208316643e7SJed Brown    Calling sequence of f:
1209ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1210316643e7SJed Brown 
1211316643e7SJed Brown +  t    - time at step/stage being solved
12121b4a444bSJed Brown .  U    - state vector
12131b4a444bSJed Brown .  U_t  - time derivative of state vector
1214316643e7SJed Brown .  a    - shift
1215e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1216e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1217316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1218316643e7SJed Brown 
1219316643e7SJed Brown    Notes:
1220e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1221316643e7SJed Brown 
1222a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1223b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1224a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1225a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1226a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1227a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1228a4f0a591SBarry Smith 
1229316643e7SJed Brown    Level: beginner
1230316643e7SJed Brown 
1231316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1232316643e7SJed Brown 
1233ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1234316643e7SJed Brown 
1235316643e7SJed Brown @*/
1236e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1237316643e7SJed Brown {
1238316643e7SJed Brown   PetscErrorCode ierr;
1239089b2837SJed Brown   SNES           snes;
124024989b8cSPeter Brune   DM             dm;
1241316643e7SJed Brown 
1242316643e7SJed Brown   PetscFunctionBegin;
12430700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1244e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1245e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1246e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1247e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
124824989b8cSPeter Brune 
124924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
125024989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
125124989b8cSPeter Brune 
1252089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1253e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1254316643e7SJed Brown   PetscFunctionReturn(0);
1255316643e7SJed Brown }
1256316643e7SJed Brown 
12574a2ae208SSatish Balay #undef __FUNCT__
1258e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1259e1244c69SJed Brown /*@
1260e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1261e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1262e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1263e1244c69SJed Brown    not been changed by the TS.
1264e1244c69SJed Brown 
1265e1244c69SJed Brown    Logically Collective
1266e1244c69SJed Brown 
1267e1244c69SJed Brown    Input Arguments:
1268e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1269e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1270e1244c69SJed Brown 
1271e1244c69SJed Brown    Level: intermediate
1272e1244c69SJed Brown 
1273e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1274e1244c69SJed Brown @*/
1275e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1276e1244c69SJed Brown {
1277e1244c69SJed Brown   PetscFunctionBegin;
1278e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1279e1244c69SJed Brown   PetscFunctionReturn(0);
1280e1244c69SJed Brown }
1281e1244c69SJed Brown 
1282e1244c69SJed Brown #undef __FUNCT__
128355849f57SBarry Smith #define __FUNCT__ "TSLoad"
128455849f57SBarry Smith /*@C
128555849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
128655849f57SBarry Smith 
128755849f57SBarry Smith   Collective on PetscViewer
128855849f57SBarry Smith 
128955849f57SBarry Smith   Input Parameters:
129055849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
129155849f57SBarry Smith            some related function before a call to TSLoad().
129255849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
129355849f57SBarry Smith 
129455849f57SBarry Smith    Level: intermediate
129555849f57SBarry Smith 
129655849f57SBarry Smith   Notes:
129755849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
129855849f57SBarry Smith 
129955849f57SBarry Smith   Notes for advanced users:
130055849f57SBarry Smith   Most users should not need to know the details of the binary storage
130155849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
130255849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
130355849f57SBarry Smith   format is
130455849f57SBarry Smith .vb
130555849f57SBarry Smith      has not yet been determined
130655849f57SBarry Smith .ve
130755849f57SBarry Smith 
130855849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
130955849f57SBarry Smith @*/
1310f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
131155849f57SBarry Smith {
131255849f57SBarry Smith   PetscErrorCode ierr;
131355849f57SBarry Smith   PetscBool      isbinary;
131455849f57SBarry Smith   PetscInt       classid;
131555849f57SBarry Smith   char           type[256];
13162d53ad75SBarry Smith   DMTS           sdm;
1317ad6bc421SBarry Smith   DM             dm;
131855849f57SBarry Smith 
131955849f57SBarry Smith   PetscFunctionBegin;
1320f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
132155849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
132255849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
132355849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
132455849f57SBarry Smith 
132555849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,&classid,1,PETSC_INT);CHKERRQ(ierr);
1326ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
132755849f57SBarry Smith   ierr = PetscViewerBinaryRead(viewer,type,256,PETSC_CHAR);CHKERRQ(ierr);
1328f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1329f2c2a1b9SBarry Smith   if (ts->ops->load) {
1330f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1331f2c2a1b9SBarry Smith   }
1332ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1333ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1334ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1335f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1336f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13372d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13382d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
133955849f57SBarry Smith   PetscFunctionReturn(0);
134055849f57SBarry Smith }
134155849f57SBarry Smith 
13429804daf3SBarry Smith #include <petscdraw.h>
1343e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1344e04113cfSBarry Smith #include <petscviewersaws.h>
1345f05ece33SBarry Smith #endif
134655849f57SBarry Smith #undef __FUNCT__
13474a2ae208SSatish Balay #define __FUNCT__ "TSView"
13487e2c5f70SBarry Smith /*@C
1349d763cef2SBarry Smith     TSView - Prints the TS data structure.
1350d763cef2SBarry Smith 
13514c49b128SBarry Smith     Collective on TS
1352d763cef2SBarry Smith 
1353d763cef2SBarry Smith     Input Parameters:
1354d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1355d763cef2SBarry Smith -   viewer - visualization context
1356d763cef2SBarry Smith 
1357d763cef2SBarry Smith     Options Database Key:
1358d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1359d763cef2SBarry Smith 
1360d763cef2SBarry Smith     Notes:
1361d763cef2SBarry Smith     The available visualization contexts include
1362b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1363b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1364d763cef2SBarry Smith          output where only the first processor opens
1365d763cef2SBarry Smith          the file.  All other processors send their
1366d763cef2SBarry Smith          data to the first processor to print.
1367d763cef2SBarry Smith 
1368d763cef2SBarry Smith     The user can open an alternative visualization context with
1369b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1370d763cef2SBarry Smith 
1371d763cef2SBarry Smith     Level: beginner
1372d763cef2SBarry Smith 
1373d763cef2SBarry Smith .keywords: TS, timestep, view
1374d763cef2SBarry Smith 
1375b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1376d763cef2SBarry Smith @*/
13777087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1378d763cef2SBarry Smith {
1379dfbe8321SBarry Smith   PetscErrorCode ierr;
138019fd82e9SBarry Smith   TSType         type;
13812b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
13822d53ad75SBarry Smith   DMTS           sdm;
1383e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1384536b137fSBarry Smith   PetscBool      issaws;
1385f05ece33SBarry Smith #endif
1386d763cef2SBarry Smith 
1387d763cef2SBarry Smith   PetscFunctionBegin;
13880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
13893050cee2SBarry Smith   if (!viewer) {
1390ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
13913050cee2SBarry Smith   }
13920700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1393c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1394fd16b177SBarry Smith 
1395251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1396251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
139755849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
13982b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1399e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1400536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1401f05ece33SBarry Smith #endif
140232077d6dSBarry Smith   if (iascii) {
1403dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
140477431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14057c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1406d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14075ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1408c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1409d763cef2SBarry Smith     }
14105ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1411193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14122d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14132d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1414d52bd9f3SBarry Smith     if (ts->ops->view) {
1415d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1416d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1417d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1418d52bd9f3SBarry Smith     }
14190f5bd95cSBarry Smith   } else if (isstring) {
1420a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1421b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
142255849f57SBarry Smith   } else if (isbinary) {
142355849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
142455849f57SBarry Smith     MPI_Comm    comm;
142555849f57SBarry Smith     PetscMPIInt rank;
142655849f57SBarry Smith     char        type[256];
142755849f57SBarry Smith 
142855849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
142955849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
143055849f57SBarry Smith     if (!rank) {
143155849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
143255849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
143355849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
143455849f57SBarry Smith     }
143555849f57SBarry Smith     if (ts->ops->view) {
143655849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
143755849f57SBarry Smith     }
1438f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1439f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14402d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14412d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14422b0a91c0SBarry Smith   } else if (isdraw) {
14432b0a91c0SBarry Smith     PetscDraw draw;
14442b0a91c0SBarry Smith     char      str[36];
144589fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14462b0a91c0SBarry Smith 
14472b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14482b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14492b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14502b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
1451*51fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
145289fd9fafSBarry Smith     bottom = y - h;
14532b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14542b0a91c0SBarry Smith     if (ts->ops->view) {
14552b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14562b0a91c0SBarry Smith     }
14572b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1458e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1459536b137fSBarry Smith   } else if (issaws) {
1460d45a07a7SBarry Smith     PetscMPIInt rank;
14612657e9d9SBarry Smith     const char  *name;
14622657e9d9SBarry Smith 
14632657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1464d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1465d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1466d45a07a7SBarry Smith       char       dir[1024];
1467d45a07a7SBarry Smith 
1468e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1469a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14702657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14712657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14722657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1473d763cef2SBarry Smith     }
14740acecf5bSBarry Smith     if (ts->ops->view) {
14750acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14760acecf5bSBarry Smith     }
1477f05ece33SBarry Smith #endif
1478f05ece33SBarry Smith   }
1479f05ece33SBarry Smith 
1480b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1481251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1482b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1483d763cef2SBarry Smith   PetscFunctionReturn(0);
1484d763cef2SBarry Smith }
1485d763cef2SBarry Smith 
1486d763cef2SBarry Smith 
14874a2ae208SSatish Balay #undef __FUNCT__
14884a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1489b07ff414SBarry Smith /*@
1490d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1491d763cef2SBarry Smith    the timesteppers.
1492d763cef2SBarry Smith 
14933f9fe445SBarry Smith    Logically Collective on TS
1494d763cef2SBarry Smith 
1495d763cef2SBarry Smith    Input Parameters:
1496d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1497d763cef2SBarry Smith -  usrP - optional user context
1498d763cef2SBarry Smith 
1499d763cef2SBarry Smith    Level: intermediate
1500d763cef2SBarry Smith 
1501d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1502d763cef2SBarry Smith 
1503d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1504d763cef2SBarry Smith @*/
15057087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1506d763cef2SBarry Smith {
1507d763cef2SBarry Smith   PetscFunctionBegin;
15080700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1509d763cef2SBarry Smith   ts->user = usrP;
1510d763cef2SBarry Smith   PetscFunctionReturn(0);
1511d763cef2SBarry Smith }
1512d763cef2SBarry Smith 
15134a2ae208SSatish Balay #undef __FUNCT__
15144a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1515b07ff414SBarry Smith /*@
1516d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1517d763cef2SBarry Smith     timestepper.
1518d763cef2SBarry Smith 
1519d763cef2SBarry Smith     Not Collective
1520d763cef2SBarry Smith 
1521d763cef2SBarry Smith     Input Parameter:
1522d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1523d763cef2SBarry Smith 
1524d763cef2SBarry Smith     Output Parameter:
1525d763cef2SBarry Smith .   usrP - user context
1526d763cef2SBarry Smith 
1527d763cef2SBarry Smith     Level: intermediate
1528d763cef2SBarry Smith 
1529d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1530d763cef2SBarry Smith 
1531d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1532d763cef2SBarry Smith @*/
1533e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1534d763cef2SBarry Smith {
1535d763cef2SBarry Smith   PetscFunctionBegin;
15360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1537e71120c6SJed Brown   *(void**)usrP = ts->user;
1538d763cef2SBarry Smith   PetscFunctionReturn(0);
1539d763cef2SBarry Smith }
1540d763cef2SBarry Smith 
15414a2ae208SSatish Balay #undef __FUNCT__
15424a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1543d763cef2SBarry Smith /*@
1544b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1545d763cef2SBarry Smith 
1546d763cef2SBarry Smith    Not Collective
1547d763cef2SBarry Smith 
1548d763cef2SBarry Smith    Input Parameter:
1549d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1550d763cef2SBarry Smith 
1551d763cef2SBarry Smith    Output Parameter:
1552b8123daeSJed Brown .  iter - number of steps completed so far
1553d763cef2SBarry Smith 
1554d763cef2SBarry Smith    Level: intermediate
1555d763cef2SBarry Smith 
1556d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15579be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1558d763cef2SBarry Smith @*/
15597087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1560d763cef2SBarry Smith {
1561d763cef2SBarry Smith   PetscFunctionBegin;
15620700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15634482741eSBarry Smith   PetscValidIntPointer(iter,2);
1564d763cef2SBarry Smith   *iter = ts->steps;
1565d763cef2SBarry Smith   PetscFunctionReturn(0);
1566d763cef2SBarry Smith }
1567d763cef2SBarry Smith 
15684a2ae208SSatish Balay #undef __FUNCT__
15694a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1570d763cef2SBarry Smith /*@
1571d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1572d763cef2SBarry Smith    as well as the initial time.
1573d763cef2SBarry Smith 
15743f9fe445SBarry Smith    Logically Collective on TS
1575d763cef2SBarry Smith 
1576d763cef2SBarry Smith    Input Parameters:
1577d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1578d763cef2SBarry Smith .  initial_time - the initial time
1579d763cef2SBarry Smith -  time_step - the size of the timestep
1580d763cef2SBarry Smith 
1581d763cef2SBarry Smith    Level: intermediate
1582d763cef2SBarry Smith 
1583d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1584d763cef2SBarry Smith 
1585d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1586d763cef2SBarry Smith @*/
15877087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1588d763cef2SBarry Smith {
1589e144a568SJed Brown   PetscErrorCode ierr;
1590e144a568SJed Brown 
1591d763cef2SBarry Smith   PetscFunctionBegin;
15920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1593e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1594d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1595d763cef2SBarry Smith   PetscFunctionReturn(0);
1596d763cef2SBarry Smith }
1597d763cef2SBarry Smith 
15984a2ae208SSatish Balay #undef __FUNCT__
15994a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1600d763cef2SBarry Smith /*@
1601d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1602d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1603d763cef2SBarry Smith 
16043f9fe445SBarry Smith    Logically Collective on TS
1605d763cef2SBarry Smith 
1606d763cef2SBarry Smith    Input Parameters:
1607d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1608d763cef2SBarry Smith -  time_step - the size of the timestep
1609d763cef2SBarry Smith 
1610d763cef2SBarry Smith    Level: intermediate
1611d763cef2SBarry Smith 
1612d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1613d763cef2SBarry Smith 
1614d763cef2SBarry Smith .keywords: TS, set, timestep
1615d763cef2SBarry Smith @*/
16167087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1617d763cef2SBarry Smith {
1618d763cef2SBarry Smith   PetscFunctionBegin;
16190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1620c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1621d763cef2SBarry Smith   ts->time_step      = time_step;
162231748224SBarry Smith   ts->time_step_orig = time_step;
1623d763cef2SBarry Smith   PetscFunctionReturn(0);
1624d763cef2SBarry Smith }
1625d763cef2SBarry Smith 
16264a2ae208SSatish Balay #undef __FUNCT__
1627a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1628a43b19c4SJed Brown /*@
162949354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
163049354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
163149354f04SShri Abhyankar      or just return at the final time TS computed.
1632a43b19c4SJed Brown 
1633a43b19c4SJed Brown   Logically Collective on TS
1634a43b19c4SJed Brown 
1635a43b19c4SJed Brown    Input Parameter:
1636a43b19c4SJed Brown +   ts - the time-step context
163749354f04SShri Abhyankar -   eftopt - exact final time option
1638a43b19c4SJed Brown 
1639a43b19c4SJed Brown    Level: beginner
1640a43b19c4SJed Brown 
1641a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1642a43b19c4SJed Brown @*/
164349354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1644a43b19c4SJed Brown {
1645a43b19c4SJed Brown   PetscFunctionBegin;
1646a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
164749354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
164849354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1649a43b19c4SJed Brown   PetscFunctionReturn(0);
1650a43b19c4SJed Brown }
1651a43b19c4SJed Brown 
1652a43b19c4SJed Brown #undef __FUNCT__
16534a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1654d763cef2SBarry Smith /*@
1655d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1656d763cef2SBarry Smith 
1657d763cef2SBarry Smith    Not Collective
1658d763cef2SBarry Smith 
1659d763cef2SBarry Smith    Input Parameter:
1660d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1661d763cef2SBarry Smith 
1662d763cef2SBarry Smith    Output Parameter:
1663d763cef2SBarry Smith .  dt - the current timestep size
1664d763cef2SBarry Smith 
1665d763cef2SBarry Smith    Level: intermediate
1666d763cef2SBarry Smith 
1667d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1668d763cef2SBarry Smith 
1669d763cef2SBarry Smith .keywords: TS, get, timestep
1670d763cef2SBarry Smith @*/
16717087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1672d763cef2SBarry Smith {
1673d763cef2SBarry Smith   PetscFunctionBegin;
16740700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1675f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1676d763cef2SBarry Smith   *dt = ts->time_step;
1677d763cef2SBarry Smith   PetscFunctionReturn(0);
1678d763cef2SBarry Smith }
1679d763cef2SBarry Smith 
16804a2ae208SSatish Balay #undef __FUNCT__
16814a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1682d8e5e3e6SSatish Balay /*@
1683d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1684d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1685d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1686d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1687d763cef2SBarry Smith 
1688d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1689d763cef2SBarry Smith 
1690d763cef2SBarry Smith    Input Parameter:
1691d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1692d763cef2SBarry Smith 
1693d763cef2SBarry Smith    Output Parameter:
1694d763cef2SBarry Smith .  v - the vector containing the solution
1695d763cef2SBarry Smith 
1696d763cef2SBarry Smith    Level: intermediate
1697d763cef2SBarry Smith 
1698d763cef2SBarry Smith .seealso: TSGetTimeStep()
1699d763cef2SBarry Smith 
1700d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1701d763cef2SBarry Smith @*/
17027087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1703d763cef2SBarry Smith {
1704d763cef2SBarry Smith   PetscFunctionBegin;
17050700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17064482741eSBarry Smith   PetscValidPointer(v,2);
17078737fe31SLisandro Dalcin   *v = ts->vec_sol;
1708d763cef2SBarry Smith   PetscFunctionReturn(0);
1709d763cef2SBarry Smith }
1710d763cef2SBarry Smith 
1711c235aa8dSHong Zhang #undef __FUNCT__
17120cf82b59SBarry Smith #define __FUNCT__ "TSAdjointGetCostGradients"
1713c235aa8dSHong Zhang /*@
17140cf82b59SBarry Smith    TSAdjointGetCostGradients - Returns the gradients from the TSAdjointSolve()
1715c235aa8dSHong Zhang 
1716c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1717c235aa8dSHong Zhang 
1718c235aa8dSHong Zhang    Input Parameter:
1719c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1720c235aa8dSHong Zhang 
1721c235aa8dSHong Zhang    Output Parameter:
1722abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1723abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1724c235aa8dSHong Zhang 
1725c235aa8dSHong Zhang    Level: intermediate
1726c235aa8dSHong Zhang 
1727c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1728c235aa8dSHong Zhang 
1729c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1730c235aa8dSHong Zhang @*/
1731abc2977eSBarry Smith PetscErrorCode  TSAdjointGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1732c235aa8dSHong Zhang {
1733c235aa8dSHong Zhang   PetscFunctionBegin;
1734c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1735abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1736abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1737abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1738c235aa8dSHong Zhang   PetscFunctionReturn(0);
1739c235aa8dSHong Zhang }
1740c235aa8dSHong Zhang 
1741bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17424a2ae208SSatish Balay #undef __FUNCT__
1743bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1744d8e5e3e6SSatish Balay /*@
1745bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1746d763cef2SBarry Smith 
1747bdad233fSMatthew Knepley   Not collective
1748d763cef2SBarry Smith 
1749bdad233fSMatthew Knepley   Input Parameters:
1750bdad233fSMatthew Knepley + ts   - The TS
1751bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1752d763cef2SBarry Smith .vb
17530910c330SBarry Smith          U_t - A U = 0      (linear)
17540910c330SBarry Smith          U_t - A(t) U = 0   (linear)
17550910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1756d763cef2SBarry Smith .ve
1757d763cef2SBarry Smith 
1758d763cef2SBarry Smith    Level: beginner
1759d763cef2SBarry Smith 
1760bdad233fSMatthew Knepley .keywords: TS, problem type
1761bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1762d763cef2SBarry Smith @*/
17637087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1764a7cc72afSBarry Smith {
17659e2a6581SJed Brown   PetscErrorCode ierr;
17669e2a6581SJed Brown 
1767d763cef2SBarry Smith   PetscFunctionBegin;
17680700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1769bdad233fSMatthew Knepley   ts->problem_type = type;
17709e2a6581SJed Brown   if (type == TS_LINEAR) {
17719e2a6581SJed Brown     SNES snes;
17729e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17739e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17749e2a6581SJed Brown   }
1775d763cef2SBarry Smith   PetscFunctionReturn(0);
1776d763cef2SBarry Smith }
1777d763cef2SBarry Smith 
1778bdad233fSMatthew Knepley #undef __FUNCT__
1779bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1780bdad233fSMatthew Knepley /*@C
1781bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1782bdad233fSMatthew Knepley 
1783bdad233fSMatthew Knepley   Not collective
1784bdad233fSMatthew Knepley 
1785bdad233fSMatthew Knepley   Input Parameter:
1786bdad233fSMatthew Knepley . ts   - The TS
1787bdad233fSMatthew Knepley 
1788bdad233fSMatthew Knepley   Output Parameter:
1789bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1790bdad233fSMatthew Knepley .vb
1791089b2837SJed Brown          M U_t = A U
1792089b2837SJed Brown          M(t) U_t = A(t) U
1793b5abc632SBarry Smith          F(t,U,U_t)
1794bdad233fSMatthew Knepley .ve
1795bdad233fSMatthew Knepley 
1796bdad233fSMatthew Knepley    Level: beginner
1797bdad233fSMatthew Knepley 
1798bdad233fSMatthew Knepley .keywords: TS, problem type
1799bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1800bdad233fSMatthew Knepley @*/
18017087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1802a7cc72afSBarry Smith {
1803bdad233fSMatthew Knepley   PetscFunctionBegin;
18040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18054482741eSBarry Smith   PetscValidIntPointer(type,2);
1806bdad233fSMatthew Knepley   *type = ts->problem_type;
1807bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1808bdad233fSMatthew Knepley }
1809d763cef2SBarry Smith 
18104a2ae208SSatish Balay #undef __FUNCT__
18114a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1812d763cef2SBarry Smith /*@
1813d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1814d763cef2SBarry Smith    of a timestepper.
1815d763cef2SBarry Smith 
1816d763cef2SBarry Smith    Collective on TS
1817d763cef2SBarry Smith 
1818d763cef2SBarry Smith    Input Parameter:
1819d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1820d763cef2SBarry Smith 
1821d763cef2SBarry Smith    Notes:
1822d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1823d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1824d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1825d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1826d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1827d763cef2SBarry Smith 
1828d763cef2SBarry Smith    Level: advanced
1829d763cef2SBarry Smith 
1830d763cef2SBarry Smith .keywords: TS, timestep, setup
1831d763cef2SBarry Smith 
1832d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1833d763cef2SBarry Smith @*/
18347087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1835d763cef2SBarry Smith {
1836dfbe8321SBarry Smith   PetscErrorCode ierr;
18376c6b9e74SPeter Brune   DM             dm;
18386c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1839d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18406c6b9e74SPeter Brune   TSIJacobian    ijac;
18416c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1842d763cef2SBarry Smith 
1843d763cef2SBarry Smith   PetscFunctionBegin;
18440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1845277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1846277b19d0SLisandro Dalcin 
18472c18e0fdSBarry Smith   ts->total_steps = 0;
18487adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18499596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1850d763cef2SBarry Smith   }
1851277b19d0SLisandro Dalcin 
1852277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1853277b19d0SLisandro Dalcin 
1854c235aa8dSHong Zhang 
1855552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
18561c3436cfSJed Brown 
1857e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1858e1244c69SJed Brown     Mat Amat,Pmat;
1859e1244c69SJed Brown     SNES snes;
1860e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1861e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1862e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1863e1244c69SJed Brown      * have displaced the RHS matrix */
1864e1244c69SJed Brown     if (Amat == ts->Arhs) {
1865e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1866e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1867e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1868e1244c69SJed Brown     }
1869e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1870e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1871e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1872e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1873e1244c69SJed Brown     }
1874e1244c69SJed Brown   }
1875277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1876000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1877277b19d0SLisandro Dalcin   }
1878277b19d0SLisandro Dalcin 
18796c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
18806c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
18816c6b9e74SPeter Brune    */
18826c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
18830298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
18846c6b9e74SPeter Brune   if (!func) {
18856c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
18866c6b9e74SPeter Brune   }
18876c6b9e74SPeter 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.
18886c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
18896c6b9e74SPeter Brune    */
18900298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
18910298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
18920298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
18936c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
18946c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
18956c6b9e74SPeter Brune   }
1896277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1897277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1898277b19d0SLisandro Dalcin }
1899277b19d0SLisandro Dalcin 
1900277b19d0SLisandro Dalcin #undef __FUNCT__
1901f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
1902f6a906c0SBarry Smith /*@
1903f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
1904f6a906c0SBarry Smith    of an adjoint solver
1905f6a906c0SBarry Smith 
1906f6a906c0SBarry Smith    Collective on TS
1907f6a906c0SBarry Smith 
1908f6a906c0SBarry Smith    Input Parameter:
1909f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
1910f6a906c0SBarry Smith 
1911f6a906c0SBarry Smith    Notes:
1912f6a906c0SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1913f6a906c0SBarry Smith    TSSetUp(), since these actions will automatically occur during
1914f6a906c0SBarry Smith    the call to TSStep().  However, if one wishes to control this
1915f6a906c0SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1916f6a906c0SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1917f6a906c0SBarry Smith 
1918f6a906c0SBarry Smith    Level: advanced
1919f6a906c0SBarry Smith 
1920f6a906c0SBarry Smith .keywords: TS, timestep, setup
1921f6a906c0SBarry Smith 
1922f6a906c0SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1923f6a906c0SBarry Smith @*/
1924f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
1925f6a906c0SBarry Smith {
1926f6a906c0SBarry Smith   PetscErrorCode ierr;
1927f6a906c0SBarry Smith 
1928f6a906c0SBarry Smith   PetscFunctionBegin;
1929f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1930f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
19310cf82b59SBarry Smith   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSAdjointSetCostGradients() first");
1932d8151eeaSBarry Smith 
1933d8151eeaSBarry Smith   ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1934d8151eeaSBarry Smith   if (ts->vecs_sensip){
1935d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1936d8151eeaSBarry Smith   }
1937d8151eeaSBarry Smith 
193842f2b339SBarry Smith   if (ts->ops->adjointsetup) {
193942f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
1940f6a906c0SBarry Smith   }
1941f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
1942f6a906c0SBarry Smith   PetscFunctionReturn(0);
1943f6a906c0SBarry Smith }
1944f6a906c0SBarry Smith 
1945f6a906c0SBarry Smith #undef __FUNCT__
1946277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1947277b19d0SLisandro Dalcin /*@
1948277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1949277b19d0SLisandro Dalcin 
1950277b19d0SLisandro Dalcin    Collective on TS
1951277b19d0SLisandro Dalcin 
1952277b19d0SLisandro Dalcin    Input Parameter:
1953277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1954277b19d0SLisandro Dalcin 
1955277b19d0SLisandro Dalcin    Level: beginner
1956277b19d0SLisandro Dalcin 
1957277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1958277b19d0SLisandro Dalcin 
1959277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1960277b19d0SLisandro Dalcin @*/
1961277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1962277b19d0SLisandro Dalcin {
1963277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1964277b19d0SLisandro Dalcin 
1965277b19d0SLisandro Dalcin   PetscFunctionBegin;
1966277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1967b18ea86cSHong Zhang 
1968277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1969277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1970277b19d0SLisandro Dalcin   }
1971277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1972bbd56ea5SKarl Rupp 
19734e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
19744e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1975214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
19766bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1977e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1978e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
197938637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1980d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1981d8151eeaSBarry Smith   if (ts->vecs_drdp){
1982d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1983d8151eeaSBarry Smith   }
1984d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
1985d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
1986ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
19872c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
198836eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
1989277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1990d763cef2SBarry Smith   PetscFunctionReturn(0);
1991d763cef2SBarry Smith }
1992d763cef2SBarry Smith 
19934a2ae208SSatish Balay #undef __FUNCT__
19944a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1995d8e5e3e6SSatish Balay /*@
1996d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1997d763cef2SBarry Smith    with TSCreate().
1998d763cef2SBarry Smith 
1999d763cef2SBarry Smith    Collective on TS
2000d763cef2SBarry Smith 
2001d763cef2SBarry Smith    Input Parameter:
2002d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2003d763cef2SBarry Smith 
2004d763cef2SBarry Smith    Level: beginner
2005d763cef2SBarry Smith 
2006d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2007d763cef2SBarry Smith 
2008d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2009d763cef2SBarry Smith @*/
20106bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2011d763cef2SBarry Smith {
20126849ba73SBarry Smith   PetscErrorCode ierr;
2013d763cef2SBarry Smith 
2014d763cef2SBarry Smith   PetscFunctionBegin;
20156bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
20166bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
20176bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2018d763cef2SBarry Smith 
20196bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2020277b19d0SLisandro Dalcin 
2021e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2022e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20236bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20246d4c513bSLisandro Dalcin 
2025bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2026bc952696SBarry Smith 
202784df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2028aeb4809dSShri Abhyankar   if ((*ts)->event) {
2029aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2030aeb4809dSShri Abhyankar   }
20316bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20326bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20336bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20346d4c513bSLisandro Dalcin 
2035a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2036d763cef2SBarry Smith   PetscFunctionReturn(0);
2037d763cef2SBarry Smith }
2038d763cef2SBarry Smith 
20394a2ae208SSatish Balay #undef __FUNCT__
20404a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2041d8e5e3e6SSatish Balay /*@
2042d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2043d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2044d763cef2SBarry Smith 
2045d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2046d763cef2SBarry Smith 
2047d763cef2SBarry Smith    Input Parameter:
2048d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2049d763cef2SBarry Smith 
2050d763cef2SBarry Smith    Output Parameter:
2051d763cef2SBarry Smith .  snes - the nonlinear solver context
2052d763cef2SBarry Smith 
2053d763cef2SBarry Smith    Notes:
2054d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2055d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
205694b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2057d763cef2SBarry Smith 
2058d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20590298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2060d763cef2SBarry Smith 
2061d763cef2SBarry Smith    Level: beginner
2062d763cef2SBarry Smith 
2063d763cef2SBarry Smith .keywords: timestep, get, SNES
2064d763cef2SBarry Smith @*/
20657087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2066d763cef2SBarry Smith {
2067d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2068d372ba47SLisandro Dalcin 
2069d763cef2SBarry Smith   PetscFunctionBegin;
20700700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20714482741eSBarry Smith   PetscValidPointer(snes,2);
2072d372ba47SLisandro Dalcin   if (!ts->snes) {
2073ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20740298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20753bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2076d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2077496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20789e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20799e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20809e2a6581SJed Brown     }
2081d372ba47SLisandro Dalcin   }
2082d763cef2SBarry Smith   *snes = ts->snes;
2083d763cef2SBarry Smith   PetscFunctionReturn(0);
2084d763cef2SBarry Smith }
2085d763cef2SBarry Smith 
20864a2ae208SSatish Balay #undef __FUNCT__
2087deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2088deb2cd25SJed Brown /*@
2089deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2090deb2cd25SJed Brown 
2091deb2cd25SJed Brown    Collective
2092deb2cd25SJed Brown 
2093deb2cd25SJed Brown    Input Parameter:
2094deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2095deb2cd25SJed Brown -  snes - the nonlinear solver context
2096deb2cd25SJed Brown 
2097deb2cd25SJed Brown    Notes:
2098deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2099deb2cd25SJed Brown 
2100deb2cd25SJed Brown    Level: developer
2101deb2cd25SJed Brown 
2102deb2cd25SJed Brown .keywords: timestep, set, SNES
2103deb2cd25SJed Brown @*/
2104deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2105deb2cd25SJed Brown {
2106deb2cd25SJed Brown   PetscErrorCode ierr;
2107d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2108deb2cd25SJed Brown 
2109deb2cd25SJed Brown   PetscFunctionBegin;
2110deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2111deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2112deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2113deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2114bbd56ea5SKarl Rupp 
2115deb2cd25SJed Brown   ts->snes = snes;
2116bbd56ea5SKarl Rupp 
21170298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21180298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2119740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
21200298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2121740132f1SEmil Constantinescu   }
2122deb2cd25SJed Brown   PetscFunctionReturn(0);
2123deb2cd25SJed Brown }
2124deb2cd25SJed Brown 
2125deb2cd25SJed Brown #undef __FUNCT__
212694b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2127d8e5e3e6SSatish Balay /*@
212894b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2129d763cef2SBarry Smith    a TS (timestepper) context.
2130d763cef2SBarry Smith 
213194b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2132d763cef2SBarry Smith 
2133d763cef2SBarry Smith    Input Parameter:
2134d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2135d763cef2SBarry Smith 
2136d763cef2SBarry Smith    Output Parameter:
213794b7f48cSBarry Smith .  ksp - the nonlinear solver context
2138d763cef2SBarry Smith 
2139d763cef2SBarry Smith    Notes:
214094b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2141d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2142d763cef2SBarry Smith    KSP and PC contexts as well.
2143d763cef2SBarry Smith 
214494b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21450298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2146d763cef2SBarry Smith 
2147d763cef2SBarry Smith    Level: beginner
2148d763cef2SBarry Smith 
214994b7f48cSBarry Smith .keywords: timestep, get, KSP
2150d763cef2SBarry Smith @*/
21517087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2152d763cef2SBarry Smith {
2153d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2154089b2837SJed Brown   SNES           snes;
2155d372ba47SLisandro Dalcin 
2156d763cef2SBarry Smith   PetscFunctionBegin;
21570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21584482741eSBarry Smith   PetscValidPointer(ksp,2);
215917186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2160e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2161089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2162089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2163d763cef2SBarry Smith   PetscFunctionReturn(0);
2164d763cef2SBarry Smith }
2165d763cef2SBarry Smith 
2166d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2167d763cef2SBarry Smith 
21684a2ae208SSatish Balay #undef __FUNCT__
2169adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2170adb62b0dSMatthew Knepley /*@
2171adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2172adb62b0dSMatthew Knepley    maximum time for iteration.
2173adb62b0dSMatthew Knepley 
21743f9fe445SBarry Smith    Not Collective
2175adb62b0dSMatthew Knepley 
2176adb62b0dSMatthew Knepley    Input Parameters:
2177adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21780298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21790298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2180adb62b0dSMatthew Knepley 
2181adb62b0dSMatthew Knepley    Level: intermediate
2182adb62b0dSMatthew Knepley 
2183adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2184adb62b0dSMatthew Knepley @*/
21857087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2186adb62b0dSMatthew Knepley {
2187adb62b0dSMatthew Knepley   PetscFunctionBegin;
21880700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2189abc0a331SBarry Smith   if (maxsteps) {
21904482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2191adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2192adb62b0dSMatthew Knepley   }
2193abc0a331SBarry Smith   if (maxtime) {
21944482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2195adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2196adb62b0dSMatthew Knepley   }
2197adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2198adb62b0dSMatthew Knepley }
2199adb62b0dSMatthew Knepley 
2200adb62b0dSMatthew Knepley #undef __FUNCT__
22014a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2202d763cef2SBarry Smith /*@
2203d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2204d763cef2SBarry Smith    maximum time for iteration.
2205d763cef2SBarry Smith 
22063f9fe445SBarry Smith    Logically Collective on TS
2207d763cef2SBarry Smith 
2208d763cef2SBarry Smith    Input Parameters:
2209d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2210d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2211d763cef2SBarry Smith -  maxtime - final time to iterate to
2212d763cef2SBarry Smith 
2213d763cef2SBarry Smith    Options Database Keys:
2214d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
22153bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2216d763cef2SBarry Smith 
2217d763cef2SBarry Smith    Notes:
2218d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2219d763cef2SBarry Smith 
2220d763cef2SBarry Smith    Level: intermediate
2221d763cef2SBarry Smith 
2222d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2223a43b19c4SJed Brown 
2224a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2225d763cef2SBarry Smith @*/
22267087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2227d763cef2SBarry Smith {
2228d763cef2SBarry Smith   PetscFunctionBegin;
22290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2230c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2231c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
223239b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
223339b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2234d763cef2SBarry Smith   PetscFunctionReturn(0);
2235d763cef2SBarry Smith }
2236d763cef2SBarry Smith 
22374a2ae208SSatish Balay #undef __FUNCT__
22384a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2239d763cef2SBarry Smith /*@
2240d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2241d763cef2SBarry Smith    for use by the TS routines.
2242d763cef2SBarry Smith 
22433f9fe445SBarry Smith    Logically Collective on TS and Vec
2244d763cef2SBarry Smith 
2245d763cef2SBarry Smith    Input Parameters:
2246d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22470910c330SBarry Smith -  u - the solution vector
2248d763cef2SBarry Smith 
2249d763cef2SBarry Smith    Level: beginner
2250d763cef2SBarry Smith 
2251d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2252d763cef2SBarry Smith @*/
22530910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2254d763cef2SBarry Smith {
22558737fe31SLisandro Dalcin   PetscErrorCode ierr;
2256496e6a7aSJed Brown   DM             dm;
22578737fe31SLisandro Dalcin 
2258d763cef2SBarry Smith   PetscFunctionBegin;
22590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22600910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22610910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22626bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2263bbd56ea5SKarl Rupp 
22640910c330SBarry Smith   ts->vec_sol = u;
2265bbd56ea5SKarl Rupp 
2266496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22670910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2268d763cef2SBarry Smith   PetscFunctionReturn(0);
2269d763cef2SBarry Smith }
2270d763cef2SBarry Smith 
2271e74ef692SMatthew Knepley #undef __FUNCT__
227273b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
227373b18844SBarry Smith /*@
227473b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
227573b18844SBarry Smith 
227673b18844SBarry Smith    Logically Collective on TS
227773b18844SBarry Smith 
227873b18844SBarry Smith    Input Parameters:
227973b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
228073b18844SBarry Smith .  steps - number of steps to use
228173b18844SBarry Smith 
228273b18844SBarry Smith    Level: intermediate
228373b18844SBarry Smith 
228473b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
228573b18844SBarry Smith           so as to integrate back to less than the original timestep
228673b18844SBarry Smith 
228773b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
228873b18844SBarry Smith 
228973b18844SBarry Smith .seealso: TSSetExactFinalTime()
229073b18844SBarry Smith @*/
229173b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
229273b18844SBarry Smith {
229373b18844SBarry Smith   PetscFunctionBegin;
229473b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
229573b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
229673b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
229773b18844SBarry Smith   if (steps > ts->total_steps) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back more than the total number of forward steps");
229873b18844SBarry Smith   ts->adjoint_max_steps = steps;
229973b18844SBarry Smith   PetscFunctionReturn(0);
230073b18844SBarry Smith }
230173b18844SBarry Smith 
230273b18844SBarry Smith #undef __FUNCT__
23030cf82b59SBarry Smith #define __FUNCT__ "TSAdjointSetCostGradients"
2304c235aa8dSHong Zhang /*@
23050cf82b59SBarry Smith    TSAdjointSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters
23060cf82b59SBarry Smith       for use by the TSAdjoint routines.
2307c235aa8dSHong Zhang 
2308c235aa8dSHong Zhang    Logically Collective on TS and Vec
2309c235aa8dSHong Zhang 
2310c235aa8dSHong Zhang    Input Parameters:
2311c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2312abc2977eSBarry Smith .  lambda - gradients with respect to the initial condition variables, the dimension and parallel layout of these vectors is the same as the ODE solution vector
2313abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2314c235aa8dSHong Zhang 
2315c235aa8dSHong Zhang    Level: beginner
2316c235aa8dSHong Zhang 
2317abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
23180cf82b59SBarry Smith 
2319c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2320c235aa8dSHong Zhang @*/
2321abc2977eSBarry Smith PetscErrorCode  TSAdjointSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2322c235aa8dSHong Zhang {
2323c235aa8dSHong Zhang   PetscFunctionBegin;
2324c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2325abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2326abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2327abc2977eSBarry Smith   ts->vecs_sensip = mu;
2328abc2977eSBarry Smith   ts->numcost  = numcost;
2329ad8e2604SHong Zhang   PetscFunctionReturn(0);
2330ad8e2604SHong Zhang }
2331ad8e2604SHong Zhang 
2332ad8e2604SHong Zhang #undef __FUNCT__
23335bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2334ad8e2604SHong Zhang /*@C
23350cf82b59SBarry Smith   TSAdjointSetRHSJacobian - Sets the function that computes the Jacobian of G w.r.t. the parameters p where y_t = G(y,p,t), as well as the location to store the matrix.
2336ad8e2604SHong Zhang 
2337ad8e2604SHong Zhang   Logically Collective on TS
2338ad8e2604SHong Zhang 
2339ad8e2604SHong Zhang   Input Parameters:
2340ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2341ad8e2604SHong Zhang - func - The function
2342ad8e2604SHong Zhang 
2343ad8e2604SHong Zhang   Calling sequence of func:
23440cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
234505755b9cSHong Zhang +   t - current timestep
23460cf82b59SBarry Smith .   y - input vector (current ODE solution)
234705755b9cSHong Zhang .   A - output matrix
234805755b9cSHong Zhang -   ctx - [optional] user-defined function context
2349ad8e2604SHong Zhang 
2350ad8e2604SHong Zhang   Level: intermediate
2351ad8e2604SHong Zhang 
23520cf82b59SBarry Smith   Notes: Amat has the same number of rows and the same row parallel layout as u, Amat has the same number of columns and parallel layout as p
23530cf82b59SBarry Smith 
2354ad8e2604SHong Zhang .keywords: TS, sensitivity
2355ad8e2604SHong Zhang .seealso:
2356ad8e2604SHong Zhang @*/
23575bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2358ad8e2604SHong Zhang {
2359ad8e2604SHong Zhang   PetscErrorCode ierr;
2360ad8e2604SHong Zhang 
2361ad8e2604SHong Zhang   PetscFunctionBegin;
2362ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2363ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2364ad8e2604SHong Zhang 
2365ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2366ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2367ad8e2604SHong Zhang   if(Amat) {
2368ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2369ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2370ad8e2604SHong Zhang     ts->Jacp = Amat;
2371ad8e2604SHong Zhang   }
2372ad8e2604SHong Zhang   PetscFunctionReturn(0);
2373ad8e2604SHong Zhang }
2374ad8e2604SHong Zhang 
2375ad8e2604SHong Zhang #undef __FUNCT__
23765bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
23770cf82b59SBarry Smith /*@C
23785bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2379ad8e2604SHong Zhang 
2380ad8e2604SHong Zhang   Collective on TS
2381ad8e2604SHong Zhang 
2382ad8e2604SHong Zhang   Input Parameters:
2383ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2384ad8e2604SHong Zhang 
2385ad8e2604SHong Zhang   Level: developer
2386ad8e2604SHong Zhang 
2387ad8e2604SHong Zhang .keywords: TS, sensitivity
23885bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2389ad8e2604SHong Zhang @*/
23905bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2391ad8e2604SHong Zhang {
2392ad8e2604SHong Zhang   PetscErrorCode ierr;
2393ad8e2604SHong Zhang 
2394ad8e2604SHong Zhang   PetscFunctionBegin;
2395ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2396ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2397ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2398ad8e2604SHong Zhang 
2399ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2400ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2401ad8e2604SHong Zhang   PetscStackPop;
2402c235aa8dSHong Zhang   PetscFunctionReturn(0);
2403c235aa8dSHong Zhang }
2404c235aa8dSHong Zhang 
2405c235aa8dSHong Zhang #undef __FUNCT__
2406d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetCostIntegrand"
24076fd0887fSHong Zhang /*@C
24080cf82b59SBarry Smith     TSAdjointSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
24096fd0887fSHong Zhang 
24106fd0887fSHong Zhang     Logically Collective on TS
24116fd0887fSHong Zhang 
24126fd0887fSHong Zhang     Input Parameters:
24136fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2414abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
24150cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2416b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2417b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2418b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
24196fd0887fSHong Zhang 
24200cf82b59SBarry Smith     Calling sequence of rf:
24210cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
24226fd0887fSHong Zhang 
24236fd0887fSHong Zhang +   t - current timestep
24240cf82b59SBarry Smith .   y - input vector
24250cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
24266fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24276fd0887fSHong Zhang 
2428b612ec54SBarry Smith    Calling sequence of drdyf:
24290cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2430b612ec54SBarry Smith 
2431b612ec54SBarry Smith    Calling sequence of drdpf:
24320cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2433b612ec54SBarry Smith 
2434b612ec54SBarry Smith     Level: intermediate
24356fd0887fSHong Zhang 
2436abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
24370cf82b59SBarry Smith 
24386fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24396fd0887fSHong Zhang 
24400cf82b59SBarry Smith .seealso: TSAdjointSetRHSJacobian(),TSAdjointGetCostGradients(), TSAdjointSetCostGradients()
24416fd0887fSHong Zhang @*/
2442abc2977eSBarry Smith PetscErrorCode  TSAdjointSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2443d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2444d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
24456fd0887fSHong Zhang {
24466fd0887fSHong Zhang   PetscErrorCode ierr;
24476fd0887fSHong Zhang 
24486fd0887fSHong Zhang   PetscFunctionBegin;
24496fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2450abc2977eSBarry Smith   if (!ts->numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSAdjointSetCostGradients() first so that the number of cost functions can be determined.");
2451abc2977eSBarry Smith   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSAdjointSetCostIntegrand()) is inconsistent with the one set by TSAdjointSetCostGradients()");
24526fd0887fSHong Zhang 
2453abc2977eSBarry Smith   ierr                  = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
24542c39e106SBarry Smith   ierr                  = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
24550cf82b59SBarry Smith   ts->costintegrand     = rf;
245605755b9cSHong Zhang   ts->costintegrandctx  = ctx;
2457b612ec54SBarry Smith   ts->drdyfunction    = drdyf;
2458b612ec54SBarry Smith   ts->drdpfunction    = drdpf;
24596fd0887fSHong Zhang   PetscFunctionReturn(0);
24606fd0887fSHong Zhang }
24616fd0887fSHong Zhang 
24626fd0887fSHong Zhang #undef __FUNCT__
24632c39e106SBarry Smith #define __FUNCT__ "TSAdjointGetCostIntegral"
246436eaed60SHong Zhang /*@
24652c39e106SBarry Smith    TSAdjointGetCostIntegral - Returns the values of the integral term in the cost functions.
246636eaed60SHong Zhang    It is valid to call the routine after a backward run.
246736eaed60SHong Zhang 
246836eaed60SHong Zhang    Not Collective
246936eaed60SHong Zhang 
247036eaed60SHong Zhang    Input Parameter:
247136eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
247236eaed60SHong Zhang 
247336eaed60SHong Zhang    Output Parameter:
24742c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
247536eaed60SHong Zhang 
247636eaed60SHong Zhang    Level: intermediate
247736eaed60SHong Zhang 
2478d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand()
247936eaed60SHong Zhang 
248036eaed60SHong Zhang .keywords: TS, sensitivity analysis
248136eaed60SHong Zhang @*/
24822c39e106SBarry Smith PetscErrorCode  TSAdjointGetCostIntegral(TS ts,Vec *v)
248336eaed60SHong Zhang {
248436eaed60SHong Zhang   PetscFunctionBegin;
248536eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
248636eaed60SHong Zhang   PetscValidPointer(v,2);
24872c39e106SBarry Smith   *v = ts->vec_costintegral;
248836eaed60SHong Zhang   PetscFunctionReturn(0);
248936eaed60SHong Zhang }
249036eaed60SHong Zhang 
249136eaed60SHong Zhang #undef __FUNCT__
2492d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
24936fd0887fSHong Zhang /*@
24942c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
24956fd0887fSHong Zhang 
24966fd0887fSHong Zhang    Input Parameters:
24976fd0887fSHong Zhang +  ts - the TS context
24986fd0887fSHong Zhang .  t - current time
24990cf82b59SBarry Smith -  y - state vector, i.e. current solution
25006fd0887fSHong Zhang 
25016fd0887fSHong Zhang    Output Parameter:
2502abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
25036fd0887fSHong Zhang 
25046fd0887fSHong Zhang    Note:
25056fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
25066fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
25076fd0887fSHong Zhang 
25086fd0887fSHong Zhang    Level: developer
25096fd0887fSHong Zhang 
25106fd0887fSHong Zhang .keywords: TS, compute
25116fd0887fSHong Zhang 
2512d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand()
25136fd0887fSHong Zhang @*/
25140cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
25156fd0887fSHong Zhang {
25166fd0887fSHong Zhang   PetscErrorCode ierr;
25176fd0887fSHong Zhang 
25186fd0887fSHong Zhang   PetscFunctionBegin;
25196fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25200cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
25216fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
25226fd0887fSHong Zhang 
25230cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2524e4680132SHong Zhang   if (ts->costintegrand) {
2525e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
25260cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
25276fd0887fSHong Zhang     PetscStackPop;
25286fd0887fSHong Zhang   } else {
25296fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25306fd0887fSHong Zhang   }
25316fd0887fSHong Zhang 
25320cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
25336fd0887fSHong Zhang   PetscFunctionReturn(0);
25346fd0887fSHong Zhang }
25356fd0887fSHong Zhang 
25366fd0887fSHong Zhang #undef __FUNCT__
2537d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
253805755b9cSHong Zhang /*@
2539d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
254005755b9cSHong Zhang 
254105755b9cSHong Zhang   Collective on TS
254205755b9cSHong Zhang 
254305755b9cSHong Zhang   Input Parameters:
254405755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
254505755b9cSHong Zhang 
254605755b9cSHong Zhang   Notes:
2547d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
254805755b9cSHong Zhang   so most users would not generally call this routine themselves.
254905755b9cSHong Zhang 
255005755b9cSHong Zhang   Level: developer
255105755b9cSHong Zhang 
255205755b9cSHong Zhang .keywords: TS, sensitivity
2553d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
255405755b9cSHong Zhang @*/
25550cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
255605755b9cSHong Zhang {
255705755b9cSHong Zhang   PetscErrorCode ierr;
255805755b9cSHong Zhang 
255905755b9cSHong Zhang   PetscFunctionBegin;
256005755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25610cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
256205755b9cSHong Zhang 
256305755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
25640cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
256505755b9cSHong Zhang   PetscStackPop;
256605755b9cSHong Zhang   PetscFunctionReturn(0);
256705755b9cSHong Zhang }
256805755b9cSHong Zhang 
256905755b9cSHong Zhang #undef __FUNCT__
2570d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
257105755b9cSHong Zhang /*@
2572d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
257305755b9cSHong Zhang 
257405755b9cSHong Zhang   Collective on TS
257505755b9cSHong Zhang 
257605755b9cSHong Zhang   Input Parameters:
257705755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
257805755b9cSHong Zhang 
257905755b9cSHong Zhang   Notes:
258005755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
258105755b9cSHong Zhang   so most users would not generally call this routine themselves.
258205755b9cSHong Zhang 
258305755b9cSHong Zhang   Level: developer
258405755b9cSHong Zhang 
258505755b9cSHong Zhang .keywords: TS, sensitivity
2586d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
258705755b9cSHong Zhang @*/
25880cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
258905755b9cSHong Zhang {
259005755b9cSHong Zhang   PetscErrorCode ierr;
259105755b9cSHong Zhang 
259205755b9cSHong Zhang   PetscFunctionBegin;
259305755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25940cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
259505755b9cSHong Zhang 
259605755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
25970cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
259805755b9cSHong Zhang   PetscStackPop;
259905755b9cSHong Zhang   PetscFunctionReturn(0);
260005755b9cSHong Zhang }
260105755b9cSHong Zhang 
260205755b9cSHong Zhang #undef __FUNCT__
2603e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2604ac226902SBarry Smith /*@C
2605000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26063f2090d5SJed Brown   called once at the beginning of each time step.
2607000e7ae3SMatthew Knepley 
26083f9fe445SBarry Smith   Logically Collective on TS
2609000e7ae3SMatthew Knepley 
2610000e7ae3SMatthew Knepley   Input Parameters:
2611000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2612000e7ae3SMatthew Knepley - func - The function
2613000e7ae3SMatthew Knepley 
2614000e7ae3SMatthew Knepley   Calling sequence of func:
2615000e7ae3SMatthew Knepley . func (TS ts);
2616000e7ae3SMatthew Knepley 
2617000e7ae3SMatthew Knepley   Level: intermediate
2618000e7ae3SMatthew Knepley 
2619b8123daeSJed Brown   Note:
2620b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2621b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2622b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2623b8123daeSJed Brown 
2624000e7ae3SMatthew Knepley .keywords: TS, timestep
26259be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2626000e7ae3SMatthew Knepley @*/
26277087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2628000e7ae3SMatthew Knepley {
2629000e7ae3SMatthew Knepley   PetscFunctionBegin;
26300700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2631ae60f76fSBarry Smith   ts->prestep = func;
2632000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2633000e7ae3SMatthew Knepley }
2634000e7ae3SMatthew Knepley 
2635e74ef692SMatthew Knepley #undef __FUNCT__
26363f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
263709ee8438SJed Brown /*@
26383f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26393f2090d5SJed Brown 
26403f2090d5SJed Brown   Collective on TS
26413f2090d5SJed Brown 
26423f2090d5SJed Brown   Input Parameters:
26433f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26443f2090d5SJed Brown 
26453f2090d5SJed Brown   Notes:
26463f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
26473f2090d5SJed Brown   so most users would not generally call this routine themselves.
26483f2090d5SJed Brown 
26493f2090d5SJed Brown   Level: developer
26503f2090d5SJed Brown 
26513f2090d5SJed Brown .keywords: TS, timestep
26529be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
26533f2090d5SJed Brown @*/
26547087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
26553f2090d5SJed Brown {
26563f2090d5SJed Brown   PetscErrorCode ierr;
26573f2090d5SJed Brown 
26583f2090d5SJed Brown   PetscFunctionBegin;
26590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2660ae60f76fSBarry Smith   if (ts->prestep) {
2661ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2662312ce896SJed Brown   }
26633f2090d5SJed Brown   PetscFunctionReturn(0);
26643f2090d5SJed Brown }
26653f2090d5SJed Brown 
26663f2090d5SJed Brown #undef __FUNCT__
2667b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2668b8123daeSJed Brown /*@C
2669b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2670b8123daeSJed Brown   called once at the beginning of each stage.
2671b8123daeSJed Brown 
2672b8123daeSJed Brown   Logically Collective on TS
2673b8123daeSJed Brown 
2674b8123daeSJed Brown   Input Parameters:
2675b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2676b8123daeSJed Brown - func - The function
2677b8123daeSJed Brown 
2678b8123daeSJed Brown   Calling sequence of func:
2679b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2680b8123daeSJed Brown 
2681b8123daeSJed Brown   Level: intermediate
2682b8123daeSJed Brown 
2683b8123daeSJed Brown   Note:
2684b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2685b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2686b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2687b8123daeSJed Brown 
2688b8123daeSJed Brown .keywords: TS, timestep
26899be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2690b8123daeSJed Brown @*/
2691b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2692b8123daeSJed Brown {
2693b8123daeSJed Brown   PetscFunctionBegin;
2694b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2695ae60f76fSBarry Smith   ts->prestage = func;
2696b8123daeSJed Brown   PetscFunctionReturn(0);
2697b8123daeSJed Brown }
2698b8123daeSJed Brown 
2699b8123daeSJed Brown #undef __FUNCT__
27009be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27019be3e283SDebojyoti Ghosh /*@C
27029be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27039be3e283SDebojyoti Ghosh   called once at the end of each stage.
27049be3e283SDebojyoti Ghosh 
27059be3e283SDebojyoti Ghosh   Logically Collective on TS
27069be3e283SDebojyoti Ghosh 
27079be3e283SDebojyoti Ghosh   Input Parameters:
27089be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27099be3e283SDebojyoti Ghosh - func - The function
27109be3e283SDebojyoti Ghosh 
27119be3e283SDebojyoti Ghosh   Calling sequence of func:
27129be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27139be3e283SDebojyoti Ghosh 
27149be3e283SDebojyoti Ghosh   Level: intermediate
27159be3e283SDebojyoti Ghosh 
27169be3e283SDebojyoti Ghosh   Note:
27179be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27189be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27199be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27209be3e283SDebojyoti Ghosh 
27219be3e283SDebojyoti Ghosh .keywords: TS, timestep
27229be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27239be3e283SDebojyoti Ghosh @*/
27249be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27259be3e283SDebojyoti Ghosh {
27269be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27279be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27289be3e283SDebojyoti Ghosh   ts->poststage = func;
27299be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27309be3e283SDebojyoti Ghosh }
27319be3e283SDebojyoti Ghosh 
27329be3e283SDebojyoti Ghosh #undef __FUNCT__
2733b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2734b8123daeSJed Brown /*@
2735b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2736b8123daeSJed Brown 
2737b8123daeSJed Brown   Collective on TS
2738b8123daeSJed Brown 
2739b8123daeSJed Brown   Input Parameters:
2740b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27419be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2742b8123daeSJed Brown 
2743b8123daeSJed Brown   Notes:
2744b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2745b8123daeSJed Brown   most users would not generally call this routine themselves.
2746b8123daeSJed Brown 
2747b8123daeSJed Brown   Level: developer
2748b8123daeSJed Brown 
2749b8123daeSJed Brown .keywords: TS, timestep
27509be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2751b8123daeSJed Brown @*/
2752b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2753b8123daeSJed Brown {
2754b8123daeSJed Brown   PetscErrorCode ierr;
2755b8123daeSJed Brown 
2756b8123daeSJed Brown   PetscFunctionBegin;
2757b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2758ae60f76fSBarry Smith   if (ts->prestage) {
2759ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2760b8123daeSJed Brown   }
2761b8123daeSJed Brown   PetscFunctionReturn(0);
2762b8123daeSJed Brown }
2763b8123daeSJed Brown 
2764b8123daeSJed Brown #undef __FUNCT__
27659be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
27669be3e283SDebojyoti Ghosh /*@
27679be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
27689be3e283SDebojyoti Ghosh 
27699be3e283SDebojyoti Ghosh   Collective on TS
27709be3e283SDebojyoti Ghosh 
27719be3e283SDebojyoti Ghosh   Input Parameters:
27729be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
27739be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
27749be3e283SDebojyoti Ghosh   stageindex  - Stage number
27759be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
27769be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
27779be3e283SDebojyoti Ghosh 
27789be3e283SDebojyoti Ghosh   Notes:
27799be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
27809be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
27819be3e283SDebojyoti Ghosh 
27829be3e283SDebojyoti Ghosh   Level: developer
27839be3e283SDebojyoti Ghosh 
27849be3e283SDebojyoti Ghosh .keywords: TS, timestep
27859be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
27869be3e283SDebojyoti Ghosh @*/
27879be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
27889be3e283SDebojyoti Ghosh {
27899be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
27909be3e283SDebojyoti Ghosh 
27919be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27929be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27934beae5d8SLisandro Dalcin   if (ts->poststage) {
27949be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
27959be3e283SDebojyoti Ghosh   }
27969be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27979be3e283SDebojyoti Ghosh }
27989be3e283SDebojyoti Ghosh 
27999be3e283SDebojyoti Ghosh #undef __FUNCT__
2800e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2801ac226902SBarry Smith /*@C
2802000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28033f2090d5SJed Brown   called once at the end of each time step.
2804000e7ae3SMatthew Knepley 
28053f9fe445SBarry Smith   Logically Collective on TS
2806000e7ae3SMatthew Knepley 
2807000e7ae3SMatthew Knepley   Input Parameters:
2808000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2809000e7ae3SMatthew Knepley - func - The function
2810000e7ae3SMatthew Knepley 
2811000e7ae3SMatthew Knepley   Calling sequence of func:
2812b8123daeSJed Brown $ func (TS ts);
2813000e7ae3SMatthew Knepley 
2814000e7ae3SMatthew Knepley   Level: intermediate
2815000e7ae3SMatthew Knepley 
2816000e7ae3SMatthew Knepley .keywords: TS, timestep
2817b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2818000e7ae3SMatthew Knepley @*/
28197087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2820000e7ae3SMatthew Knepley {
2821000e7ae3SMatthew Knepley   PetscFunctionBegin;
28220700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2823ae60f76fSBarry Smith   ts->poststep = func;
2824000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2825000e7ae3SMatthew Knepley }
2826000e7ae3SMatthew Knepley 
2827e74ef692SMatthew Knepley #undef __FUNCT__
28283f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
282909ee8438SJed Brown /*@
28303f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28313f2090d5SJed Brown 
28323f2090d5SJed Brown   Collective on TS
28333f2090d5SJed Brown 
28343f2090d5SJed Brown   Input Parameters:
28353f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28363f2090d5SJed Brown 
28373f2090d5SJed Brown   Notes:
28383f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28393f2090d5SJed Brown   so most users would not generally call this routine themselves.
28403f2090d5SJed Brown 
28413f2090d5SJed Brown   Level: developer
28423f2090d5SJed Brown 
28433f2090d5SJed Brown .keywords: TS, timestep
28443f2090d5SJed Brown @*/
28457087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28463f2090d5SJed Brown {
28473f2090d5SJed Brown   PetscErrorCode ierr;
28483f2090d5SJed Brown 
28493f2090d5SJed Brown   PetscFunctionBegin;
28500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2851ae60f76fSBarry Smith   if (ts->poststep) {
2852ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
285372ac3e02SJed Brown   }
28543f2090d5SJed Brown   PetscFunctionReturn(0);
28553f2090d5SJed Brown }
28563f2090d5SJed Brown 
2857d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2858d763cef2SBarry Smith 
28594a2ae208SSatish Balay #undef __FUNCT__
2860a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2861d763cef2SBarry Smith /*@C
2862a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2863d763cef2SBarry Smith    timestep to display the iteration's  progress.
2864d763cef2SBarry Smith 
28653f9fe445SBarry Smith    Logically Collective on TS
2866d763cef2SBarry Smith 
2867d763cef2SBarry Smith    Input Parameters:
2868d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2869e213d8f1SJed Brown .  monitor - monitoring routine
2870329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
28710298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2872b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
28730298fd71SBarry Smith           (may be NULL)
2874d763cef2SBarry Smith 
2875e213d8f1SJed Brown    Calling sequence of monitor:
28760910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2877d763cef2SBarry Smith 
2878d763cef2SBarry Smith +    ts - the TS context
287988c05cc5SBarry 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
288088c05cc5SBarry Smith                                been interpolated to)
28811f06c33eSBarry Smith .    time - current time
28820910c330SBarry Smith .    u - current iterate
2883d763cef2SBarry Smith -    mctx - [optional] monitoring context
2884d763cef2SBarry Smith 
2885d763cef2SBarry Smith    Notes:
2886d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2887d763cef2SBarry Smith    already has been loaded.
2888d763cef2SBarry Smith 
2889025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2890025f1a04SBarry Smith 
2891d763cef2SBarry Smith    Level: intermediate
2892d763cef2SBarry Smith 
2893d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2894d763cef2SBarry Smith 
2895a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2896d763cef2SBarry Smith @*/
2897c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2898d763cef2SBarry Smith {
2899d763cef2SBarry Smith   PetscFunctionBegin;
29000700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
290117186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2902d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29038704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2904d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2905d763cef2SBarry Smith   PetscFunctionReturn(0);
2906d763cef2SBarry Smith }
2907d763cef2SBarry Smith 
29084a2ae208SSatish Balay #undef __FUNCT__
2909a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2910d763cef2SBarry Smith /*@C
2911a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2912d763cef2SBarry Smith 
29133f9fe445SBarry Smith    Logically Collective on TS
2914d763cef2SBarry Smith 
2915d763cef2SBarry Smith    Input Parameters:
2916d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2917d763cef2SBarry Smith 
2918d763cef2SBarry Smith    Notes:
2919d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2920d763cef2SBarry Smith 
2921d763cef2SBarry Smith    Level: intermediate
2922d763cef2SBarry Smith 
2923d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2924d763cef2SBarry Smith 
2925a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2926d763cef2SBarry Smith @*/
29277087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2928d763cef2SBarry Smith {
2929d952e501SBarry Smith   PetscErrorCode ierr;
2930d952e501SBarry Smith   PetscInt       i;
2931d952e501SBarry Smith 
2932d763cef2SBarry Smith   PetscFunctionBegin;
29330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2934d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29358704b422SBarry Smith     if (ts->monitordestroy[i]) {
29368704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2937d952e501SBarry Smith     }
2938d952e501SBarry Smith   }
2939d763cef2SBarry Smith   ts->numbermonitors = 0;
2940d763cef2SBarry Smith   PetscFunctionReturn(0);
2941d763cef2SBarry Smith }
2942d763cef2SBarry Smith 
29434a2ae208SSatish Balay #undef __FUNCT__
2944a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2945d8e5e3e6SSatish Balay /*@
2946a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
29475516499fSSatish Balay 
29485516499fSSatish Balay    Level: intermediate
294941251cbbSSatish Balay 
29505516499fSSatish Balay .keywords: TS, set, monitor
29515516499fSSatish Balay 
295241251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
295341251cbbSSatish Balay @*/
2954649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2955d763cef2SBarry Smith {
2956dfbe8321SBarry Smith   PetscErrorCode ierr;
2957ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2958d132466eSBarry Smith 
2959d763cef2SBarry Smith   PetscFunctionBegin;
2960649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
29618392e04aSShri Abhyankar   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g %s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? "(r)\n" : "\n");CHKERRQ(ierr);
2962649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2963d763cef2SBarry Smith   PetscFunctionReturn(0);
2964d763cef2SBarry Smith }
2965d763cef2SBarry Smith 
29664a2ae208SSatish Balay #undef __FUNCT__
2967cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2968cd652676SJed Brown /*@
2969cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2970cd652676SJed Brown 
2971cd652676SJed Brown    Logically Collective on TS
2972cd652676SJed Brown 
2973cd652676SJed Brown    Input Argument:
2974cd652676SJed Brown .  ts - time stepping context
2975cd652676SJed Brown 
2976cd652676SJed Brown    Output Argument:
2977cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2978cd652676SJed Brown 
2979cd652676SJed Brown    Level: intermediate
2980cd652676SJed Brown 
2981cd652676SJed Brown .keywords: TS, set
2982cd652676SJed Brown 
2983cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
2984cd652676SJed Brown @*/
2985cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2986cd652676SJed Brown {
2987cd652676SJed Brown   PetscFunctionBegin;
2988cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2989cd652676SJed Brown   ts->retain_stages = flg;
2990cd652676SJed Brown   PetscFunctionReturn(0);
2991cd652676SJed Brown }
2992cd652676SJed Brown 
2993cd652676SJed Brown #undef __FUNCT__
2994cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
2995cd652676SJed Brown /*@
2996cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2997cd652676SJed Brown 
2998cd652676SJed Brown    Collective on TS
2999cd652676SJed Brown 
3000cd652676SJed Brown    Input Argument:
3001cd652676SJed Brown +  ts - time stepping context
3002cd652676SJed Brown -  t - time to interpolate to
3003cd652676SJed Brown 
3004cd652676SJed Brown    Output Argument:
30050910c330SBarry Smith .  U - state at given time
3006cd652676SJed Brown 
3007cd652676SJed Brown    Notes:
3008cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3009cd652676SJed Brown 
3010cd652676SJed Brown    Level: intermediate
3011cd652676SJed Brown 
3012cd652676SJed Brown    Developer Notes:
3013cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3014cd652676SJed Brown 
3015cd652676SJed Brown .keywords: TS, set
3016cd652676SJed Brown 
3017cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3018cd652676SJed Brown @*/
30190910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3020cd652676SJed Brown {
3021cd652676SJed Brown   PetscErrorCode ierr;
3022cd652676SJed Brown 
3023cd652676SJed Brown   PetscFunctionBegin;
3024cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3025b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
30266712e2f1SBarry 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);
3027ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
30280910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3029cd652676SJed Brown   PetscFunctionReturn(0);
3030cd652676SJed Brown }
3031cd652676SJed Brown 
3032cd652676SJed Brown #undef __FUNCT__
30334a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3034d763cef2SBarry Smith /*@
30356d9e5789SSean Farley    TSStep - Steps one time step
3036d763cef2SBarry Smith 
3037d763cef2SBarry Smith    Collective on TS
3038d763cef2SBarry Smith 
3039d763cef2SBarry Smith    Input Parameter:
3040d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3041d763cef2SBarry Smith 
304227829d71SBarry Smith    Level: developer
3043d763cef2SBarry Smith 
3044b8123daeSJed Brown    Notes:
304527829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
304627829d71SBarry Smith 
3047b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3048b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3049b8123daeSJed Brown 
305025cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
305125cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
305225cb2221SBarry Smith 
3053d763cef2SBarry Smith .keywords: TS, timestep, solve
3054d763cef2SBarry Smith 
30559be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3056d763cef2SBarry Smith @*/
3057193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3058d763cef2SBarry Smith {
30592fb8446cSMatthew G. Knepley   DM               dm;
3060dfbe8321SBarry Smith   PetscErrorCode   ierr;
3061fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3062d763cef2SBarry Smith 
3063d763cef2SBarry Smith   PetscFunctionBegin;
30640700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3065fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3066fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3067fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3068fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3069fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3070fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3071fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
3072fffbeea8SBarry Smith 
30732fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3074d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3075d405a339SMatthew Knepley 
3076362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
307724655328SShri   ts->ptime_prev = ts->ptime;
3078cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3079bbd56ea5SKarl Rupp 
3080e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3081d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3082193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3083d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3084bbd56ea5SKarl Rupp 
308524655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3086cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3087362cd11cSLisandro Dalcin 
3088362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3089cef5090cSJed Brown     if (ts->errorifstepfailed) {
309008c7845fSBarry Smith       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
309108c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3092d2daff3dSHong Zhang     }
309308c7845fSBarry Smith   } else if (!ts->reason) {
309408c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
309508c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
309608c7845fSBarry Smith   }
30972c18e0fdSBarry Smith   ts->total_steps++;
30988392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
309908c7845fSBarry Smith   PetscFunctionReturn(0);
310008c7845fSBarry Smith }
310108c7845fSBarry Smith 
310208c7845fSBarry Smith #undef __FUNCT__
310308c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
310408c7845fSBarry Smith /*@
310508c7845fSBarry Smith    TSAdjointStep - Steps one time step
310608c7845fSBarry Smith 
310708c7845fSBarry Smith    Collective on TS
310808c7845fSBarry Smith 
310908c7845fSBarry Smith    Input Parameter:
311008c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
311108c7845fSBarry Smith 
311208c7845fSBarry Smith    Level: intermediate
311308c7845fSBarry Smith 
311408c7845fSBarry Smith    Notes:
311508c7845fSBarry Smith    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
311608c7845fSBarry Smith    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
311708c7845fSBarry Smith 
311808c7845fSBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
311908c7845fSBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
312008c7845fSBarry Smith 
312108c7845fSBarry Smith .keywords: TS, timestep, solve
312208c7845fSBarry Smith 
312308c7845fSBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
312408c7845fSBarry Smith @*/
312508c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
312608c7845fSBarry Smith {
312708c7845fSBarry Smith   DM               dm;
312808c7845fSBarry Smith   PetscErrorCode   ierr;
312908c7845fSBarry Smith 
313008c7845fSBarry Smith   PetscFunctionBegin;
313108c7845fSBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
313208c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
313308c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
313408c7845fSBarry Smith 
313508c7845fSBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
313608c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
313708c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
313808c7845fSBarry Smith   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
313908c7845fSBarry Smith 
314008c7845fSBarry Smith   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
314142f2b339SBarry Smith   if (!ts->ops->adjointstep) 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);
314242f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
3143362cd11cSLisandro Dalcin   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3144362cd11cSLisandro Dalcin 
3145cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3146cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3147ce94432eSBarry Smith 
3148ce94432eSBarry Smith   if (ts->reason < 0) {
3149cef5090cSJed Brown     if (ts->errorifstepfailed) {
3150362cd11cSLisandro Dalcin       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3151db4deed7SKarl Rupp         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]);
31522a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
31532a3a10ceSLisandro 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]);
3154362cd11cSLisandro Dalcin       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3155362cd11cSLisandro Dalcin     }
3156362cd11cSLisandro Dalcin   } else if (!ts->reason) {
315773b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3158db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3159362cd11cSLisandro Dalcin   }
31602c18e0fdSBarry Smith   ts->total_steps--;
3161d763cef2SBarry Smith   PetscFunctionReturn(0);
3162d763cef2SBarry Smith }
3163d763cef2SBarry Smith 
31644a2ae208SSatish Balay #undef __FUNCT__
316505175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
316605175c85SJed Brown /*@
316705175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
316805175c85SJed Brown 
31691c3436cfSJed Brown    Collective on TS
317005175c85SJed Brown 
317105175c85SJed Brown    Input Arguments:
31721c3436cfSJed Brown +  ts - time stepping context
31731c3436cfSJed Brown .  order - desired order of accuracy
31740298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
317505175c85SJed Brown 
317605175c85SJed Brown    Output Arguments:
31770910c330SBarry Smith .  U - state at the end of the current step
317805175c85SJed Brown 
317905175c85SJed Brown    Level: advanced
318005175c85SJed Brown 
3181108c343cSJed Brown    Notes:
3182108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3183108c343cSJed 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.
3184108c343cSJed Brown 
31851c3436cfSJed Brown .seealso: TSStep(), TSAdapt
318605175c85SJed Brown @*/
31870910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
318805175c85SJed Brown {
318905175c85SJed Brown   PetscErrorCode ierr;
319005175c85SJed Brown 
319105175c85SJed Brown   PetscFunctionBegin;
319205175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
319305175c85SJed Brown   PetscValidType(ts,1);
31940910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3195ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
31960910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
319705175c85SJed Brown   PetscFunctionReturn(0);
319805175c85SJed Brown }
319905175c85SJed Brown 
3200d67e68b7SBarry Smith 
320105175c85SJed Brown #undef __FUNCT__
32026a4d4014SLisandro Dalcin #define __FUNCT__ "TSSolve"
32036a4d4014SLisandro Dalcin /*@
32046a4d4014SLisandro Dalcin    TSSolve - Steps the requested number of timesteps.
32056a4d4014SLisandro Dalcin 
32066a4d4014SLisandro Dalcin    Collective on TS
32076a4d4014SLisandro Dalcin 
32086a4d4014SLisandro Dalcin    Input Parameter:
32096a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
3210cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
32115a3a76d0SJed Brown 
32126a4d4014SLisandro Dalcin    Level: beginner
32136a4d4014SLisandro Dalcin 
32145a3a76d0SJed Brown    Notes:
32155a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
32165a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
32175a3a76d0SJed Brown    stepped over the final time.
32185a3a76d0SJed Brown 
32196a4d4014SLisandro Dalcin .keywords: TS, timestep, solve
32206a4d4014SLisandro Dalcin 
32216a4d4014SLisandro Dalcin .seealso: TSCreate(), TSSetSolution(), TSStep()
32226a4d4014SLisandro Dalcin @*/
3223cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
32246a4d4014SLisandro Dalcin {
3225b06615a5SLisandro Dalcin   Vec               solution;
32266a4d4014SLisandro Dalcin   PetscErrorCode    ierr;
3227f22f69f0SBarry Smith 
32286a4d4014SLisandro Dalcin   PetscFunctionBegin;
32290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3230f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
323149354f04SShri Abhyankar   if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE) {   /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
3232b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
32330910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3234b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3235b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3236b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
32375a3a76d0SJed Brown     }
32380910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3239bbd56ea5SKarl Rupp   } else if (u) {
32400910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
32415a3a76d0SJed Brown   }
3242a74656a8SBarry Smith   ierr = TSSetUp(ts);CHKERRQ(ierr);
32436a4d4014SLisandro Dalcin   /* reset time step and iteration counters */
3244193ac0bcSJed Brown   ts->steps             = 0;
32455ef26d82SJed Brown   ts->ksp_its           = 0;
32465ef26d82SJed Brown   ts->snes_its          = 0;
3247c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3248c610991cSLisandro Dalcin   ts->reject            = 0;
3249193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3250193ac0bcSJed Brown 
3251ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3252f05ece33SBarry Smith 
3253193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3254193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
32550910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3256cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3257193ac0bcSJed Brown   } else {
32586a4d4014SLisandro Dalcin     /* steps the requested number of timesteps. */
3259db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3260db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3261cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
32626fea3669SShri Abhyankar     if(ts->event) {
32636fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
32646fea3669SShri Abhyankar     }
3265e1a7a14fSJed Brown     while (!ts->reason) {
3266b06615a5SLisandro Dalcin       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3267193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3268aeb4809dSShri Abhyankar       if (ts->event) {
3269aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
32701eda64f1SShri Abhyankar       }
32718392e04aSShri Abhyankar       if(!ts->steprollback) {
3272cdf0de3dSShri Abhyankar 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
32731eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3274aeb4809dSShri Abhyankar       }
3275193ac0bcSJed Brown     }
327649354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
32770910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3278cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3279b06615a5SLisandro Dalcin       solution = u;
32800574a7fbSJed Brown     } else {
3281ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3282cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3283b06615a5SLisandro Dalcin       solution = ts->vec_sol;
32840574a7fbSJed Brown     }
3285b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
328627829d71SBarry Smith     ierr = VecViewFromOptions(solution, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3287193ac0bcSJed Brown   }
3288d2daff3dSHong Zhang 
3289ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
329056f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3291ef222394SBarry Smith   if (ts->adjoint_solve) {
3292ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
3293ef222394SBarry Smith   }
32946a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
32956a4d4014SLisandro Dalcin }
32966a4d4014SLisandro Dalcin 
32976a4d4014SLisandro Dalcin #undef __FUNCT__
3298c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3299c88f2d44SBarry Smith /*@
3300c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3301c88f2d44SBarry Smith 
3302c88f2d44SBarry Smith    Collective on TS
3303c88f2d44SBarry Smith 
3304c88f2d44SBarry Smith    Input Parameter:
33052c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3306c88f2d44SBarry Smith 
3307e87fd094SBarry Smith    Options Database:
3308e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3309e87fd094SBarry Smith 
3310c88f2d44SBarry Smith    Level: intermediate
3311c88f2d44SBarry Smith 
3312c88f2d44SBarry Smith    Notes:
3313c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3314c88f2d44SBarry Smith 
331573b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
331673b18844SBarry Smith 
3317c88f2d44SBarry Smith .keywords: TS, timestep, solve
3318c88f2d44SBarry Smith 
3319c88f2d44SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3320c88f2d44SBarry Smith @*/
33212c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3322c88f2d44SBarry Smith {
3323c88f2d44SBarry Smith   PetscErrorCode    ierr;
3324c88f2d44SBarry Smith 
3325c88f2d44SBarry Smith   PetscFunctionBegin;
3326c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3327c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3328c88f2d44SBarry Smith   /* reset time step and iteration counters */
3329c88f2d44SBarry Smith   ts->steps             = 0;
3330c88f2d44SBarry Smith   ts->ksp_its           = 0;
3331c88f2d44SBarry Smith   ts->snes_its          = 0;
3332c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3333c88f2d44SBarry Smith   ts->reject            = 0;
3334c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3335c88f2d44SBarry Smith 
333673b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3337c88f2d44SBarry Smith 
333873b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3339c88f2d44SBarry Smith   while (!ts->reason) {
334073b18844SBarry Smith     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->adjoint_max_steps-ts->steps,ts->ptime);CHKERRQ(ierr);
334173b18844SBarry Smith     ierr = TSMonitor(ts,ts->adjoint_max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
334208c7845fSBarry Smith     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3343c88f2d44SBarry Smith     if (ts->event) {
3344d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3345d0578d90SShri Abhyankar     }
3346d0578d90SShri Abhyankar 
3347d0578d90SShri Abhyankar #if 0 /* I don't think PostStep is needed in AdjointSolve */
3348c88f2d44SBarry Smith       if (ts->event->status != TSEVENT_PROCESSING) {
3349c88f2d44SBarry Smith         ierr = TSPostStep(ts);CHKERRQ(ierr);
3350c88f2d44SBarry Smith       }
3351c88f2d44SBarry Smith     } else {
3352c88f2d44SBarry Smith       ierr = TSPostStep(ts);CHKERRQ(ierr);
3353c88f2d44SBarry Smith     }
3354d0578d90SShri Abhyankar #endif
3355c88f2d44SBarry Smith   }
3356c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3357e87fd094SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0], ((PetscObject) ts)->prefix, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3358c88f2d44SBarry Smith   PetscFunctionReturn(0);
3359c88f2d44SBarry Smith }
3360c88f2d44SBarry Smith 
3361c88f2d44SBarry Smith #undef __FUNCT__
33624a2ae208SSatish Balay #define __FUNCT__ "TSMonitor"
3363228d79bcSJed Brown /*@
3364228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3365228d79bcSJed Brown 
3366228d79bcSJed Brown    Collective on TS
3367228d79bcSJed Brown 
3368228d79bcSJed Brown    Input Parameters:
3369228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3370228d79bcSJed Brown .  step - step number that has just completed
3371228d79bcSJed Brown .  ptime - model time of the state
33720910c330SBarry Smith -  u - state at the current model time
3373228d79bcSJed Brown 
3374228d79bcSJed Brown    Notes:
3375228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
3376228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
3377228d79bcSJed Brown 
3378228d79bcSJed Brown    Level: advanced
3379228d79bcSJed Brown 
3380228d79bcSJed Brown .keywords: TS, timestep
3381228d79bcSJed Brown @*/
33820910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3383d763cef2SBarry Smith {
33846849ba73SBarry Smith   PetscErrorCode ierr;
3385a7cc72afSBarry Smith   PetscInt       i,n = ts->numbermonitors;
3386d763cef2SBarry Smith 
3387d763cef2SBarry Smith   PetscFunctionBegin;
3388b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3389b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
33905edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3391d763cef2SBarry Smith   for (i=0; i<n; i++) {
33920910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3393d763cef2SBarry Smith   }
33945edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3395d763cef2SBarry Smith   PetscFunctionReturn(0);
3396d763cef2SBarry Smith }
3397d763cef2SBarry Smith 
3398d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
33994a2ae208SSatish Balay #undef __FUNCT__
3400a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3401d763cef2SBarry Smith /*@C
3402a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
3403a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3404d763cef2SBarry Smith 
3405d763cef2SBarry Smith    Collective on TS
3406d763cef2SBarry Smith 
3407d763cef2SBarry Smith    Input Parameters:
3408d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3409d763cef2SBarry Smith .  label - the title to put in the title bar
34107c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3411a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3412a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3413d763cef2SBarry Smith 
3414d763cef2SBarry Smith    Output Parameter:
34150b039ecaSBarry Smith .  ctx - the context
3416d763cef2SBarry Smith 
3417d763cef2SBarry Smith    Options Database Key:
34184f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
34194f09c107SBarry Smith .  -ts_monitor_lg_solution -
342099fdda47SBarry Smith .  -ts_monitor_lg_error -
342199fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
342299fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
342399fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
3424d763cef2SBarry Smith 
3425d763cef2SBarry Smith    Notes:
3426a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3427d763cef2SBarry Smith 
3428d763cef2SBarry Smith    Level: intermediate
3429d763cef2SBarry Smith 
34307c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
3431d763cef2SBarry Smith 
34324f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
34337c922b88SBarry Smith 
3434d763cef2SBarry Smith @*/
3435a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3436d763cef2SBarry Smith {
3437b0a32e0cSBarry Smith   PetscDraw      win;
3438dfbe8321SBarry Smith   PetscErrorCode ierr;
3439d763cef2SBarry Smith 
3440d763cef2SBarry Smith   PetscFunctionBegin;
3441b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3442a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
34433fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
34440b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
34453bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3446287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3447287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3448a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3449d763cef2SBarry Smith   PetscFunctionReturn(0);
3450d763cef2SBarry Smith }
3451d763cef2SBarry Smith 
34524a2ae208SSatish Balay #undef __FUNCT__
34534f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3454b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3455d763cef2SBarry Smith {
34560b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3457c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3458dfbe8321SBarry Smith   PetscErrorCode ierr;
3459d763cef2SBarry Smith 
3460d763cef2SBarry Smith   PetscFunctionBegin;
3461b06615a5SLisandro Dalcin   if (!step) {
3462a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3463a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3464a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3465a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3466287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3467a9f9c1f6SBarry Smith   }
3468c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
34690b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3470b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
34710b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
34723923b477SBarry Smith   }
3473d763cef2SBarry Smith   PetscFunctionReturn(0);
3474d763cef2SBarry Smith }
3475d763cef2SBarry Smith 
34764a2ae208SSatish Balay #undef __FUNCT__
3477a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3478d763cef2SBarry Smith /*@C
3479a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3480a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3481d763cef2SBarry Smith 
34820b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3483d763cef2SBarry Smith 
3484d763cef2SBarry Smith    Input Parameter:
34850b039ecaSBarry Smith .  ctx - the monitor context
3486d763cef2SBarry Smith 
3487d763cef2SBarry Smith    Level: intermediate
3488d763cef2SBarry Smith 
3489d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3490d763cef2SBarry Smith 
34914f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3492d763cef2SBarry Smith @*/
3493a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3494d763cef2SBarry Smith {
3495b0a32e0cSBarry Smith   PetscDraw      draw;
3496dfbe8321SBarry Smith   PetscErrorCode ierr;
3497d763cef2SBarry Smith 
3498d763cef2SBarry Smith   PetscFunctionBegin;
34997684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
35007684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
35017684fa3eSBarry Smith   }
35020b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
35036bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
35040b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
350531152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3506387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3507387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3508387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
35090b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3510d763cef2SBarry Smith   PetscFunctionReturn(0);
3511d763cef2SBarry Smith }
3512d763cef2SBarry Smith 
35134a2ae208SSatish Balay #undef __FUNCT__
35144a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3515d763cef2SBarry Smith /*@
3516b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3517d763cef2SBarry Smith 
3518d763cef2SBarry Smith    Not Collective
3519d763cef2SBarry Smith 
3520d763cef2SBarry Smith    Input Parameter:
3521d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3522d763cef2SBarry Smith 
3523d763cef2SBarry Smith    Output Parameter:
3524d763cef2SBarry Smith .  t  - the current time
3525d763cef2SBarry Smith 
3526d763cef2SBarry Smith    Level: beginner
3527d763cef2SBarry Smith 
3528b8123daeSJed Brown    Note:
3529b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
35309be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3531b8123daeSJed Brown 
3532d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3533d763cef2SBarry Smith 
3534d763cef2SBarry Smith .keywords: TS, get, time
3535d763cef2SBarry Smith @*/
35367087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3537d763cef2SBarry Smith {
3538d763cef2SBarry Smith   PetscFunctionBegin;
35390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3540f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3541d763cef2SBarry Smith   *t = ts->ptime;
3542d763cef2SBarry Smith   PetscFunctionReturn(0);
3543d763cef2SBarry Smith }
3544d763cef2SBarry Smith 
35454a2ae208SSatish Balay #undef __FUNCT__
3546e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3547e5e524a1SHong Zhang /*@
3548e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3549e5e524a1SHong Zhang 
3550e5e524a1SHong Zhang    Not Collective
3551e5e524a1SHong Zhang 
3552e5e524a1SHong Zhang    Input Parameter:
3553e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3554e5e524a1SHong Zhang 
3555e5e524a1SHong Zhang    Output Parameter:
3556e5e524a1SHong Zhang .  t  - the previous time
3557e5e524a1SHong Zhang 
3558e5e524a1SHong Zhang    Level: beginner
3559e5e524a1SHong Zhang 
3560e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3561e5e524a1SHong Zhang 
3562e5e524a1SHong Zhang .keywords: TS, get, time
3563e5e524a1SHong Zhang @*/
3564e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3565e5e524a1SHong Zhang {
3566e5e524a1SHong Zhang   PetscFunctionBegin;
3567e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3568e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3569e5e524a1SHong Zhang   *t = ts->ptime_prev;
3570e5e524a1SHong Zhang   PetscFunctionReturn(0);
3571e5e524a1SHong Zhang }
3572e5e524a1SHong Zhang 
3573e5e524a1SHong Zhang #undef __FUNCT__
35746a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
35756a4d4014SLisandro Dalcin /*@
35766a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
35776a4d4014SLisandro Dalcin 
35783f9fe445SBarry Smith    Logically Collective on TS
35796a4d4014SLisandro Dalcin 
35806a4d4014SLisandro Dalcin    Input Parameters:
35816a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
35826a4d4014SLisandro Dalcin -  time - the time
35836a4d4014SLisandro Dalcin 
35846a4d4014SLisandro Dalcin    Level: intermediate
35856a4d4014SLisandro Dalcin 
35866a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
35876a4d4014SLisandro Dalcin 
35886a4d4014SLisandro Dalcin .keywords: TS, set, time
35896a4d4014SLisandro Dalcin @*/
35907087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
35916a4d4014SLisandro Dalcin {
35926a4d4014SLisandro Dalcin   PetscFunctionBegin;
35930700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3594c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
35956a4d4014SLisandro Dalcin   ts->ptime = t;
35966a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
35976a4d4014SLisandro Dalcin }
35986a4d4014SLisandro Dalcin 
35996a4d4014SLisandro Dalcin #undef __FUNCT__
36004a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3601d763cef2SBarry Smith /*@C
3602d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3603d763cef2SBarry Smith    TS options in the database.
3604d763cef2SBarry Smith 
36053f9fe445SBarry Smith    Logically Collective on TS
3606d763cef2SBarry Smith 
3607d763cef2SBarry Smith    Input Parameter:
3608d763cef2SBarry Smith +  ts     - The TS context
3609d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3610d763cef2SBarry Smith 
3611d763cef2SBarry Smith    Notes:
3612d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3613d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3614d763cef2SBarry Smith    hyphen.
3615d763cef2SBarry Smith 
3616d763cef2SBarry Smith    Level: advanced
3617d763cef2SBarry Smith 
3618d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3619d763cef2SBarry Smith 
3620d763cef2SBarry Smith .seealso: TSSetFromOptions()
3621d763cef2SBarry Smith 
3622d763cef2SBarry Smith @*/
36237087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3624d763cef2SBarry Smith {
3625dfbe8321SBarry Smith   PetscErrorCode ierr;
3626089b2837SJed Brown   SNES           snes;
3627d763cef2SBarry Smith 
3628d763cef2SBarry Smith   PetscFunctionBegin;
36290700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3630d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3631089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3632089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3633d763cef2SBarry Smith   PetscFunctionReturn(0);
3634d763cef2SBarry Smith }
3635d763cef2SBarry Smith 
3636d763cef2SBarry Smith 
36374a2ae208SSatish Balay #undef __FUNCT__
36384a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3639d763cef2SBarry Smith /*@C
3640d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3641d763cef2SBarry Smith    TS options in the database.
3642d763cef2SBarry Smith 
36433f9fe445SBarry Smith    Logically Collective on TS
3644d763cef2SBarry Smith 
3645d763cef2SBarry Smith    Input Parameter:
3646d763cef2SBarry Smith +  ts     - The TS context
3647d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3648d763cef2SBarry Smith 
3649d763cef2SBarry Smith    Notes:
3650d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3651d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3652d763cef2SBarry Smith    hyphen.
3653d763cef2SBarry Smith 
3654d763cef2SBarry Smith    Level: advanced
3655d763cef2SBarry Smith 
3656d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3657d763cef2SBarry Smith 
3658d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3659d763cef2SBarry Smith 
3660d763cef2SBarry Smith @*/
36617087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3662d763cef2SBarry Smith {
3663dfbe8321SBarry Smith   PetscErrorCode ierr;
3664089b2837SJed Brown   SNES           snes;
3665d763cef2SBarry Smith 
3666d763cef2SBarry Smith   PetscFunctionBegin;
36670700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3668d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3669089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3670089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3671d763cef2SBarry Smith   PetscFunctionReturn(0);
3672d763cef2SBarry Smith }
3673d763cef2SBarry Smith 
36744a2ae208SSatish Balay #undef __FUNCT__
36754a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3676d763cef2SBarry Smith /*@C
3677d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3678d763cef2SBarry Smith    TS options in the database.
3679d763cef2SBarry Smith 
3680d763cef2SBarry Smith    Not Collective
3681d763cef2SBarry Smith 
3682d763cef2SBarry Smith    Input Parameter:
3683d763cef2SBarry Smith .  ts - The TS context
3684d763cef2SBarry Smith 
3685d763cef2SBarry Smith    Output Parameter:
3686d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3687d763cef2SBarry Smith 
3688d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3689d763cef2SBarry Smith    sufficient length to hold the prefix.
3690d763cef2SBarry Smith 
3691d763cef2SBarry Smith    Level: intermediate
3692d763cef2SBarry Smith 
3693d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3694d763cef2SBarry Smith 
3695d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3696d763cef2SBarry Smith @*/
36977087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3698d763cef2SBarry Smith {
3699dfbe8321SBarry Smith   PetscErrorCode ierr;
3700d763cef2SBarry Smith 
3701d763cef2SBarry Smith   PetscFunctionBegin;
37020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37034482741eSBarry Smith   PetscValidPointer(prefix,2);
3704d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3705d763cef2SBarry Smith   PetscFunctionReturn(0);
3706d763cef2SBarry Smith }
3707d763cef2SBarry Smith 
37084a2ae208SSatish Balay #undef __FUNCT__
37094a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3710d763cef2SBarry Smith /*@C
3711d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3712d763cef2SBarry Smith 
3713d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3714d763cef2SBarry Smith 
3715d763cef2SBarry Smith    Input Parameter:
3716d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3717d763cef2SBarry Smith 
3718d763cef2SBarry Smith    Output Parameters:
3719e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3720e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3721e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3722e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3723d763cef2SBarry Smith 
37240298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3725d763cef2SBarry Smith 
3726d763cef2SBarry Smith    Level: intermediate
3727d763cef2SBarry Smith 
372826d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3729d763cef2SBarry Smith 
3730d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3731d763cef2SBarry Smith @*/
3732e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3733d763cef2SBarry Smith {
3734089b2837SJed Brown   PetscErrorCode ierr;
3735089b2837SJed Brown   SNES           snes;
373624989b8cSPeter Brune   DM             dm;
3737089b2837SJed Brown 
3738d763cef2SBarry Smith   PetscFunctionBegin;
3739089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3740e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
374124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
374224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3743d763cef2SBarry Smith   PetscFunctionReturn(0);
3744d763cef2SBarry Smith }
3745d763cef2SBarry Smith 
37461713a123SBarry Smith #undef __FUNCT__
37472eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
37482eca1d9cSJed Brown /*@C
37492eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
37502eca1d9cSJed Brown 
37512eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
37522eca1d9cSJed Brown 
37532eca1d9cSJed Brown    Input Parameter:
37542eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
37552eca1d9cSJed Brown 
37562eca1d9cSJed Brown    Output Parameters:
3757e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3758e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
37592eca1d9cSJed Brown .  f   - The function to compute the matrices
37602eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
37612eca1d9cSJed Brown 
37620298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
37632eca1d9cSJed Brown 
37642eca1d9cSJed Brown    Level: advanced
37652eca1d9cSJed Brown 
37662eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
37672eca1d9cSJed Brown 
37682eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
37692eca1d9cSJed Brown @*/
3770e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
37712eca1d9cSJed Brown {
3772089b2837SJed Brown   PetscErrorCode ierr;
3773089b2837SJed Brown   SNES           snes;
377424989b8cSPeter Brune   DM             dm;
37750910c330SBarry Smith 
37762eca1d9cSJed Brown   PetscFunctionBegin;
3777089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3778f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3779e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
378024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
378124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
37822eca1d9cSJed Brown   PetscFunctionReturn(0);
37832eca1d9cSJed Brown }
37842eca1d9cSJed Brown 
37856083293cSBarry Smith 
37862eca1d9cSJed Brown #undef __FUNCT__
378783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
37881713a123SBarry Smith /*@C
378983a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
37901713a123SBarry Smith    VecView() for the solution at each timestep
37911713a123SBarry Smith 
37921713a123SBarry Smith    Collective on TS
37931713a123SBarry Smith 
37941713a123SBarry Smith    Input Parameters:
37951713a123SBarry Smith +  ts - the TS context
37961713a123SBarry Smith .  step - current time-step
3797142b95e3SSatish Balay .  ptime - current time
37980298fd71SBarry Smith -  dummy - either a viewer or NULL
37991713a123SBarry Smith 
380099fdda47SBarry Smith    Options Database:
380199fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
380299fdda47SBarry Smith 
3803387f4636SBarry Smith    Notes: the initial solution and current solution are not display with a common axis scaling so generally the option -ts_monitor_draw_solution_initial
380499fdda47SBarry Smith        will look bad
380599fdda47SBarry Smith 
38061713a123SBarry Smith    Level: intermediate
38071713a123SBarry Smith 
38081713a123SBarry Smith .keywords: TS,  vector, monitor, view
38091713a123SBarry Smith 
3810a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38111713a123SBarry Smith @*/
38120910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38131713a123SBarry Smith {
3814dfbe8321SBarry Smith   PetscErrorCode   ierr;
381583a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3816473a3ab2SBarry Smith   PetscDraw        draw;
38171713a123SBarry Smith 
38181713a123SBarry Smith   PetscFunctionBegin;
38196083293cSBarry Smith   if (!step && ictx->showinitial) {
38206083293cSBarry Smith     if (!ictx->initialsolution) {
38210910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
38221713a123SBarry Smith     }
38230910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
38246083293cSBarry Smith   }
3825b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
38260dcf80beSBarry Smith 
38276083293cSBarry Smith   if (ictx->showinitial) {
38286083293cSBarry Smith     PetscReal pause;
38296083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
38306083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
38316083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
38326083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
38336083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
38346083293cSBarry Smith   }
38350910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3836473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3837*51fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
3838473a3ab2SBarry Smith     char      time[32];
3839473a3ab2SBarry Smith 
3840473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
384185b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
3842473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3843473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3844*51fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3845473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3846473a3ab2SBarry Smith   }
3847473a3ab2SBarry Smith 
38486083293cSBarry Smith   if (ictx->showinitial) {
38496083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
38506083293cSBarry Smith   }
38511713a123SBarry Smith   PetscFunctionReturn(0);
38521713a123SBarry Smith }
38531713a123SBarry Smith 
38542d5ee99bSBarry Smith #undef __FUNCT__
38552d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
38562d5ee99bSBarry Smith /*@C
38572d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
38582d5ee99bSBarry Smith 
38592d5ee99bSBarry Smith    Collective on TS
38602d5ee99bSBarry Smith 
38612d5ee99bSBarry Smith    Input Parameters:
38622d5ee99bSBarry Smith +  ts - the TS context
38632d5ee99bSBarry Smith .  step - current time-step
38642d5ee99bSBarry Smith .  ptime - current time
38652d5ee99bSBarry Smith -  dummy - either a viewer or NULL
38662d5ee99bSBarry Smith 
38672d5ee99bSBarry Smith    Level: intermediate
38682d5ee99bSBarry Smith 
38692d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
38702d5ee99bSBarry Smith 
38712d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38722d5ee99bSBarry Smith @*/
38732d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38742d5ee99bSBarry Smith {
38752d5ee99bSBarry Smith   PetscErrorCode    ierr;
38762d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
38772d5ee99bSBarry Smith   PetscDraw         draw;
38782d5ee99bSBarry Smith   MPI_Comm          comm;
38792d5ee99bSBarry Smith   PetscInt          n;
38802d5ee99bSBarry Smith   PetscMPIInt       size;
3881*51fa3d41SBarry Smith   PetscReal         xl,yl,xr,yr,h;
38822d5ee99bSBarry Smith   char              time[32];
38832d5ee99bSBarry Smith   const PetscScalar *U;
38842d5ee99bSBarry Smith 
38852d5ee99bSBarry Smith   PetscFunctionBegin;
38862d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
38872d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
38882d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
38892d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
38902d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
38912d5ee99bSBarry Smith 
38922d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
38932d5ee99bSBarry Smith 
38942d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
38954b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3896ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3897a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3898a4494fc1SBarry Smith       PetscFunctionReturn(0);
3899a4494fc1SBarry Smith   }
39002d5ee99bSBarry Smith   if (!step) ictx->color++;
39012d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
39022d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
39032d5ee99bSBarry Smith 
39042d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
39054b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
390685b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
39072d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
3908*51fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
39092d5ee99bSBarry Smith   }
39102d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
39112d5ee99bSBarry Smith   PetscFunctionReturn(0);
39122d5ee99bSBarry Smith }
39132d5ee99bSBarry Smith 
39141713a123SBarry Smith 
39156c699258SBarry Smith #undef __FUNCT__
391683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
39176083293cSBarry Smith /*@C
391883a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
39196083293cSBarry Smith 
39206083293cSBarry Smith    Collective on TS
39216083293cSBarry Smith 
39226083293cSBarry Smith    Input Parameters:
39236083293cSBarry Smith .    ctx - the monitor context
39246083293cSBarry Smith 
39256083293cSBarry Smith    Level: intermediate
39266083293cSBarry Smith 
39276083293cSBarry Smith .keywords: TS,  vector, monitor, view
39286083293cSBarry Smith 
392983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
39306083293cSBarry Smith @*/
393183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
39326083293cSBarry Smith {
39336083293cSBarry Smith   PetscErrorCode ierr;
39346083293cSBarry Smith 
39356083293cSBarry Smith   PetscFunctionBegin;
39364b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
393783a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
393883a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
393983a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
39406083293cSBarry Smith   PetscFunctionReturn(0);
39416083293cSBarry Smith }
39426083293cSBarry Smith 
39436083293cSBarry Smith #undef __FUNCT__
394483a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
39456083293cSBarry Smith /*@C
394683a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
39476083293cSBarry Smith 
39486083293cSBarry Smith    Collective on TS
39496083293cSBarry Smith 
39506083293cSBarry Smith    Input Parameter:
39516083293cSBarry Smith .    ts - time-step context
39526083293cSBarry Smith 
39536083293cSBarry Smith    Output Patameter:
39546083293cSBarry Smith .    ctx - the monitor context
39556083293cSBarry Smith 
395699fdda47SBarry Smith    Options Database:
395799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
395899fdda47SBarry Smith 
39596083293cSBarry Smith    Level: intermediate
39606083293cSBarry Smith 
39616083293cSBarry Smith .keywords: TS,  vector, monitor, view
39626083293cSBarry Smith 
396383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
39646083293cSBarry Smith @*/
396583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
39666083293cSBarry Smith {
39676083293cSBarry Smith   PetscErrorCode   ierr;
39686083293cSBarry Smith 
39696083293cSBarry Smith   PetscFunctionBegin;
3970b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
397183a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3972e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3973bbd56ea5SKarl Rupp 
397483a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3975473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
39760298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3977473a3ab2SBarry Smith 
3978473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
39790298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
39802d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
39816083293cSBarry Smith   PetscFunctionReturn(0);
39826083293cSBarry Smith }
39836083293cSBarry Smith 
39846083293cSBarry Smith #undef __FUNCT__
398583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
39863a471f94SBarry Smith /*@C
398783a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
39883a471f94SBarry Smith    VecView() for the error at each timestep
39893a471f94SBarry Smith 
39903a471f94SBarry Smith    Collective on TS
39913a471f94SBarry Smith 
39923a471f94SBarry Smith    Input Parameters:
39933a471f94SBarry Smith +  ts - the TS context
39943a471f94SBarry Smith .  step - current time-step
39953a471f94SBarry Smith .  ptime - current time
39960298fd71SBarry Smith -  dummy - either a viewer or NULL
39973a471f94SBarry Smith 
39983a471f94SBarry Smith    Level: intermediate
39993a471f94SBarry Smith 
40003a471f94SBarry Smith .keywords: TS,  vector, monitor, view
40013a471f94SBarry Smith 
40023a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
40033a471f94SBarry Smith @*/
40040910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
40053a471f94SBarry Smith {
40063a471f94SBarry Smith   PetscErrorCode   ierr;
400783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
400883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
40093a471f94SBarry Smith   Vec              work;
40103a471f94SBarry Smith 
40113a471f94SBarry Smith   PetscFunctionBegin;
4012b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40130910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
40143a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
40150910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
40163a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
40173a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
40183a471f94SBarry Smith   PetscFunctionReturn(0);
40193a471f94SBarry Smith }
40203a471f94SBarry Smith 
40212a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
40223a471f94SBarry Smith #undef __FUNCT__
40236c699258SBarry Smith #define __FUNCT__ "TSSetDM"
40246c699258SBarry Smith /*@
40256c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
40266c699258SBarry Smith 
40273f9fe445SBarry Smith    Logically Collective on TS and DM
40286c699258SBarry Smith 
40296c699258SBarry Smith    Input Parameters:
40306c699258SBarry Smith +  ts - the preconditioner context
40316c699258SBarry Smith -  dm - the dm
40326c699258SBarry Smith 
40336c699258SBarry Smith    Level: intermediate
40346c699258SBarry Smith 
40356c699258SBarry Smith 
40366c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
40376c699258SBarry Smith @*/
40387087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
40396c699258SBarry Smith {
40406c699258SBarry Smith   PetscErrorCode ierr;
4041089b2837SJed Brown   SNES           snes;
4042942e3340SBarry Smith   DMTS           tsdm;
40436c699258SBarry Smith 
40446c699258SBarry Smith   PetscFunctionBegin;
40450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
404670663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4047942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
40482a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4049942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4050942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
405124989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
405224989b8cSPeter Brune         tsdm->originaldm = dm;
405324989b8cSPeter Brune       }
405424989b8cSPeter Brune     }
40556bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
405624989b8cSPeter Brune   }
40576c699258SBarry Smith   ts->dm = dm;
4058bbd56ea5SKarl Rupp 
4059089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4060089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
40616c699258SBarry Smith   PetscFunctionReturn(0);
40626c699258SBarry Smith }
40636c699258SBarry Smith 
40646c699258SBarry Smith #undef __FUNCT__
40656c699258SBarry Smith #define __FUNCT__ "TSGetDM"
40666c699258SBarry Smith /*@
40676c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
40686c699258SBarry Smith 
40693f9fe445SBarry Smith    Not Collective
40706c699258SBarry Smith 
40716c699258SBarry Smith    Input Parameter:
40726c699258SBarry Smith . ts - the preconditioner context
40736c699258SBarry Smith 
40746c699258SBarry Smith    Output Parameter:
40756c699258SBarry Smith .  dm - the dm
40766c699258SBarry Smith 
40776c699258SBarry Smith    Level: intermediate
40786c699258SBarry Smith 
40796c699258SBarry Smith 
40806c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
40816c699258SBarry Smith @*/
40827087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
40836c699258SBarry Smith {
4084496e6a7aSJed Brown   PetscErrorCode ierr;
4085496e6a7aSJed Brown 
40866c699258SBarry Smith   PetscFunctionBegin;
40870700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4088496e6a7aSJed Brown   if (!ts->dm) {
4089ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4090496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4091496e6a7aSJed Brown   }
40926c699258SBarry Smith   *dm = ts->dm;
40936c699258SBarry Smith   PetscFunctionReturn(0);
40946c699258SBarry Smith }
40951713a123SBarry Smith 
40960f5c6efeSJed Brown #undef __FUNCT__
40970f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
40980f5c6efeSJed Brown /*@
40990f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
41000f5c6efeSJed Brown 
41013f9fe445SBarry Smith    Logically Collective on SNES
41020f5c6efeSJed Brown 
41030f5c6efeSJed Brown    Input Parameter:
4104d42a1c89SJed Brown + snes - nonlinear solver
41050910c330SBarry Smith . U - the current state at which to evaluate the residual
4106d42a1c89SJed Brown - ctx - user context, must be a TS
41070f5c6efeSJed Brown 
41080f5c6efeSJed Brown    Output Parameter:
41090f5c6efeSJed Brown . F - the nonlinear residual
41100f5c6efeSJed Brown 
41110f5c6efeSJed Brown    Notes:
41120f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41130f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
41140f5c6efeSJed Brown 
41150f5c6efeSJed Brown    Level: advanced
41160f5c6efeSJed Brown 
41170f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
41180f5c6efeSJed Brown @*/
41190910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
41200f5c6efeSJed Brown {
41210f5c6efeSJed Brown   TS             ts = (TS)ctx;
41220f5c6efeSJed Brown   PetscErrorCode ierr;
41230f5c6efeSJed Brown 
41240f5c6efeSJed Brown   PetscFunctionBegin;
41250f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41260910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41270f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
41280f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
41290910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
41300f5c6efeSJed Brown   PetscFunctionReturn(0);
41310f5c6efeSJed Brown }
41320f5c6efeSJed Brown 
41330f5c6efeSJed Brown #undef __FUNCT__
41340f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
41350f5c6efeSJed Brown /*@
41360f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
41370f5c6efeSJed Brown 
41380f5c6efeSJed Brown    Collective on SNES
41390f5c6efeSJed Brown 
41400f5c6efeSJed Brown    Input Parameter:
41410f5c6efeSJed Brown + snes - nonlinear solver
41420910c330SBarry Smith . U - the current state at which to evaluate the residual
41430f5c6efeSJed Brown - ctx - user context, must be a TS
41440f5c6efeSJed Brown 
41450f5c6efeSJed Brown    Output Parameter:
41460f5c6efeSJed Brown + A - the Jacobian
41470f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
41480f5c6efeSJed Brown - flag - indicates any structure change in the matrix
41490f5c6efeSJed Brown 
41500f5c6efeSJed Brown    Notes:
41510f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41520f5c6efeSJed Brown 
41530f5c6efeSJed Brown    Level: developer
41540f5c6efeSJed Brown 
41550f5c6efeSJed Brown .seealso: SNESSetJacobian()
41560f5c6efeSJed Brown @*/
4157d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
41580f5c6efeSJed Brown {
41590f5c6efeSJed Brown   TS             ts = (TS)ctx;
41600f5c6efeSJed Brown   PetscErrorCode ierr;
41610f5c6efeSJed Brown 
41620f5c6efeSJed Brown   PetscFunctionBegin;
41630f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41640910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41650f5c6efeSJed Brown   PetscValidPointer(A,3);
416694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
41670f5c6efeSJed Brown   PetscValidPointer(B,4);
416894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
41690f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4170d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
41710f5c6efeSJed Brown   PetscFunctionReturn(0);
41720f5c6efeSJed Brown }
4173325fc9f4SBarry Smith 
41740e4ef248SJed Brown #undef __FUNCT__
41750e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
41760e4ef248SJed Brown /*@C
41770e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
41780e4ef248SJed Brown 
41790e4ef248SJed Brown    Collective on TS
41800e4ef248SJed Brown 
41810e4ef248SJed Brown    Input Arguments:
41820e4ef248SJed Brown +  ts - time stepping context
41830e4ef248SJed Brown .  t - time at which to evaluate
41840910c330SBarry Smith .  U - state at which to evaluate
41850e4ef248SJed Brown -  ctx - context
41860e4ef248SJed Brown 
41870e4ef248SJed Brown    Output Arguments:
41880e4ef248SJed Brown .  F - right hand side
41890e4ef248SJed Brown 
41900e4ef248SJed Brown    Level: intermediate
41910e4ef248SJed Brown 
41920e4ef248SJed Brown    Notes:
41930e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
41940e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
41950e4ef248SJed Brown 
41960e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
41970e4ef248SJed Brown @*/
41980910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
41990e4ef248SJed Brown {
42000e4ef248SJed Brown   PetscErrorCode ierr;
42010e4ef248SJed Brown   Mat            Arhs,Brhs;
42020e4ef248SJed Brown 
42030e4ef248SJed Brown   PetscFunctionBegin;
42040e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4205d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
42060910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
42070e4ef248SJed Brown   PetscFunctionReturn(0);
42080e4ef248SJed Brown }
42090e4ef248SJed Brown 
42100e4ef248SJed Brown #undef __FUNCT__
42110e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
42120e4ef248SJed Brown /*@C
42130e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
42140e4ef248SJed Brown 
42150e4ef248SJed Brown    Collective on TS
42160e4ef248SJed Brown 
42170e4ef248SJed Brown    Input Arguments:
42180e4ef248SJed Brown +  ts - time stepping context
42190e4ef248SJed Brown .  t - time at which to evaluate
42200910c330SBarry Smith .  U - state at which to evaluate
42210e4ef248SJed Brown -  ctx - context
42220e4ef248SJed Brown 
42230e4ef248SJed Brown    Output Arguments:
42240e4ef248SJed Brown +  A - pointer to operator
42250e4ef248SJed Brown .  B - pointer to preconditioning matrix
42260e4ef248SJed Brown -  flg - matrix structure flag
42270e4ef248SJed Brown 
42280e4ef248SJed Brown    Level: intermediate
42290e4ef248SJed Brown 
42300e4ef248SJed Brown    Notes:
42310e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
42320e4ef248SJed Brown 
42330e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
42340e4ef248SJed Brown @*/
4235d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
42360e4ef248SJed Brown {
42370e4ef248SJed Brown   PetscFunctionBegin;
42380e4ef248SJed Brown   PetscFunctionReturn(0);
42390e4ef248SJed Brown }
42400e4ef248SJed Brown 
42410026cea9SSean Farley #undef __FUNCT__
42420026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
42430026cea9SSean Farley /*@C
42440026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
42450026cea9SSean Farley 
42460026cea9SSean Farley    Collective on TS
42470026cea9SSean Farley 
42480026cea9SSean Farley    Input Arguments:
42490026cea9SSean Farley +  ts - time stepping context
42500026cea9SSean Farley .  t - time at which to evaluate
42510910c330SBarry Smith .  U - state at which to evaluate
42520910c330SBarry Smith .  Udot - time derivative of state vector
42530026cea9SSean Farley -  ctx - context
42540026cea9SSean Farley 
42550026cea9SSean Farley    Output Arguments:
42560026cea9SSean Farley .  F - left hand side
42570026cea9SSean Farley 
42580026cea9SSean Farley    Level: intermediate
42590026cea9SSean Farley 
42600026cea9SSean Farley    Notes:
42610910c330SBarry 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
42620026cea9SSean Farley    user is required to write their own TSComputeIFunction.
42630026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
42640026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
42650026cea9SSean Farley 
42660026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
42670026cea9SSean Farley @*/
42680910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
42690026cea9SSean Farley {
42700026cea9SSean Farley   PetscErrorCode ierr;
42710026cea9SSean Farley   Mat            A,B;
42720026cea9SSean Farley 
42730026cea9SSean Farley   PetscFunctionBegin;
42740298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4275d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
42760910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
42770026cea9SSean Farley   PetscFunctionReturn(0);
42780026cea9SSean Farley }
42790026cea9SSean Farley 
42800026cea9SSean Farley #undef __FUNCT__
42810026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
42820026cea9SSean Farley /*@C
4283b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
42840026cea9SSean Farley 
42850026cea9SSean Farley    Collective on TS
42860026cea9SSean Farley 
42870026cea9SSean Farley    Input Arguments:
42880026cea9SSean Farley +  ts - time stepping context
42890026cea9SSean Farley .  t - time at which to evaluate
42900910c330SBarry Smith .  U - state at which to evaluate
42910910c330SBarry Smith .  Udot - time derivative of state vector
42920026cea9SSean Farley .  shift - shift to apply
42930026cea9SSean Farley -  ctx - context
42940026cea9SSean Farley 
42950026cea9SSean Farley    Output Arguments:
42960026cea9SSean Farley +  A - pointer to operator
42970026cea9SSean Farley .  B - pointer to preconditioning matrix
42980026cea9SSean Farley -  flg - matrix structure flag
42990026cea9SSean Farley 
4300b41af12eSJed Brown    Level: advanced
43010026cea9SSean Farley 
43020026cea9SSean Farley    Notes:
43030026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
43040026cea9SSean Farley 
4305b41af12eSJed Brown    It is only appropriate for problems of the form
4306b41af12eSJed Brown 
4307b41af12eSJed Brown $     M Udot = F(U,t)
4308b41af12eSJed Brown 
4309b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4310b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4311b41af12eSJed Brown   an implicit operator of the form
4312b41af12eSJed Brown 
4313b41af12eSJed Brown $    shift*M + J
4314b41af12eSJed Brown 
4315b41af12eSJed 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
4316b41af12eSJed Brown   a copy of M or reassemble it when requested.
4317b41af12eSJed Brown 
43180026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
43190026cea9SSean Farley @*/
4320d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
43210026cea9SSean Farley {
4322b41af12eSJed Brown   PetscErrorCode ierr;
4323b41af12eSJed Brown 
43240026cea9SSean Farley   PetscFunctionBegin;
432594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4326b41af12eSJed Brown   ts->ijacobian.shift = shift;
43270026cea9SSean Farley   PetscFunctionReturn(0);
43280026cea9SSean Farley }
4329b41af12eSJed Brown 
4330e817cc15SEmil Constantinescu #undef __FUNCT__
4331e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4332e817cc15SEmil Constantinescu /*@
4333e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4334e817cc15SEmil Constantinescu 
4335e817cc15SEmil Constantinescu    Not Collective
4336e817cc15SEmil Constantinescu 
4337e817cc15SEmil Constantinescu    Input Parameter:
4338e817cc15SEmil Constantinescu .  ts - the TS context
4339e817cc15SEmil Constantinescu 
4340e817cc15SEmil Constantinescu    Output Parameter:
43414e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4342e817cc15SEmil Constantinescu 
4343e817cc15SEmil Constantinescu    Level: beginner
4344e817cc15SEmil Constantinescu 
4345e817cc15SEmil Constantinescu .keywords: TS, equation type
4346e817cc15SEmil Constantinescu 
4347e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4348e817cc15SEmil Constantinescu @*/
4349e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4350e817cc15SEmil Constantinescu {
4351e817cc15SEmil Constantinescu   PetscFunctionBegin;
4352e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4353e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4354e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4355e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4356e817cc15SEmil Constantinescu }
4357e817cc15SEmil Constantinescu 
4358e817cc15SEmil Constantinescu #undef __FUNCT__
4359e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4360e817cc15SEmil Constantinescu /*@
4361e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4362e817cc15SEmil Constantinescu 
4363e817cc15SEmil Constantinescu    Not Collective
4364e817cc15SEmil Constantinescu 
4365e817cc15SEmil Constantinescu    Input Parameter:
4366e817cc15SEmil Constantinescu +  ts - the TS context
43674e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4368e817cc15SEmil Constantinescu 
4369e817cc15SEmil Constantinescu    Level: advanced
4370e817cc15SEmil Constantinescu 
4371e817cc15SEmil Constantinescu .keywords: TS, equation type
4372e817cc15SEmil Constantinescu 
4373e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4374e817cc15SEmil Constantinescu @*/
4375e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4376e817cc15SEmil Constantinescu {
4377e817cc15SEmil Constantinescu   PetscFunctionBegin;
4378e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4379e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4380e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4381e817cc15SEmil Constantinescu }
43820026cea9SSean Farley 
43834af1b03aSJed Brown #undef __FUNCT__
43844af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
43854af1b03aSJed Brown /*@
43864af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
43874af1b03aSJed Brown 
43884af1b03aSJed Brown    Not Collective
43894af1b03aSJed Brown 
43904af1b03aSJed Brown    Input Parameter:
43914af1b03aSJed Brown .  ts - the TS context
43924af1b03aSJed Brown 
43934af1b03aSJed Brown    Output Parameter:
43944af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
43954af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
43964af1b03aSJed Brown 
4397487e0bb9SJed Brown    Level: beginner
43984af1b03aSJed Brown 
4399cd652676SJed Brown    Notes:
4400cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
44014af1b03aSJed Brown 
44024af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
44034af1b03aSJed Brown 
44044af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
44054af1b03aSJed Brown @*/
44064af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
44074af1b03aSJed Brown {
44084af1b03aSJed Brown   PetscFunctionBegin;
44094af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44104af1b03aSJed Brown   PetscValidPointer(reason,2);
44114af1b03aSJed Brown   *reason = ts->reason;
44124af1b03aSJed Brown   PetscFunctionReturn(0);
44134af1b03aSJed Brown }
44144af1b03aSJed Brown 
4415fb1732b5SBarry Smith #undef __FUNCT__
4416d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4417d6ad946cSShri Abhyankar /*@
4418d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4419d6ad946cSShri Abhyankar 
4420d6ad946cSShri Abhyankar    Not Collective
4421d6ad946cSShri Abhyankar 
4422d6ad946cSShri Abhyankar    Input Parameter:
4423d6ad946cSShri Abhyankar +  ts - the TS context
4424d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4425d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4426d6ad946cSShri Abhyankar 
4427f5abba47SShri Abhyankar    Level: advanced
4428d6ad946cSShri Abhyankar 
4429d6ad946cSShri Abhyankar    Notes:
4430d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4431d6ad946cSShri Abhyankar 
4432d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4433d6ad946cSShri Abhyankar 
4434d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4435d6ad946cSShri Abhyankar @*/
4436d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4437d6ad946cSShri Abhyankar {
4438d6ad946cSShri Abhyankar   PetscFunctionBegin;
4439d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4440d6ad946cSShri Abhyankar   ts->reason = reason;
4441d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4442d6ad946cSShri Abhyankar }
4443d6ad946cSShri Abhyankar 
4444d6ad946cSShri Abhyankar #undef __FUNCT__
4445cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4446cc708dedSBarry Smith /*@
4447cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4448cc708dedSBarry Smith 
4449cc708dedSBarry Smith    Not Collective
4450cc708dedSBarry Smith 
4451cc708dedSBarry Smith    Input Parameter:
4452cc708dedSBarry Smith .  ts - the TS context
4453cc708dedSBarry Smith 
4454cc708dedSBarry Smith    Output Parameter:
4455cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4456cc708dedSBarry Smith 
4457487e0bb9SJed Brown    Level: beginner
4458cc708dedSBarry Smith 
4459cc708dedSBarry Smith    Notes:
4460cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4461cc708dedSBarry Smith 
4462cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4463cc708dedSBarry Smith 
4464cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4465cc708dedSBarry Smith @*/
4466cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4467cc708dedSBarry Smith {
4468cc708dedSBarry Smith   PetscFunctionBegin;
4469cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4470cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4471cc708dedSBarry Smith   *ftime = ts->solvetime;
4472cc708dedSBarry Smith   PetscFunctionReturn(0);
4473cc708dedSBarry Smith }
4474cc708dedSBarry Smith 
4475cc708dedSBarry Smith #undef __FUNCT__
44762c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
44772c18e0fdSBarry Smith /*@
44782c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
44792c18e0fdSBarry Smith 
44802c18e0fdSBarry Smith    Not Collective
44812c18e0fdSBarry Smith 
44822c18e0fdSBarry Smith    Input Parameter:
44832c18e0fdSBarry Smith .  ts - the TS context
44842c18e0fdSBarry Smith 
44852c18e0fdSBarry Smith    Output Parameter:
44862c18e0fdSBarry Smith .  steps - the number of steps
44872c18e0fdSBarry Smith 
44882c18e0fdSBarry Smith    Level: beginner
44892c18e0fdSBarry Smith 
44902c18e0fdSBarry Smith    Notes:
44912c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
44922c18e0fdSBarry Smith 
44932c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
44942c18e0fdSBarry Smith 
44952c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
44962c18e0fdSBarry Smith @*/
44972c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
44982c18e0fdSBarry Smith {
44992c18e0fdSBarry Smith   PetscFunctionBegin;
45002c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45012c18e0fdSBarry Smith   PetscValidPointer(steps,2);
45022c18e0fdSBarry Smith   *steps = ts->total_steps;
45032c18e0fdSBarry Smith   PetscFunctionReturn(0);
45042c18e0fdSBarry Smith }
45052c18e0fdSBarry Smith 
45062c18e0fdSBarry Smith #undef __FUNCT__
45075ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
45089f67acb7SJed Brown /*@
45095ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
45109f67acb7SJed Brown    used by the time integrator.
45119f67acb7SJed Brown 
45129f67acb7SJed Brown    Not Collective
45139f67acb7SJed Brown 
45149f67acb7SJed Brown    Input Parameter:
45159f67acb7SJed Brown .  ts - TS context
45169f67acb7SJed Brown 
45179f67acb7SJed Brown    Output Parameter:
45189f67acb7SJed Brown .  nits - number of nonlinear iterations
45199f67acb7SJed Brown 
45209f67acb7SJed Brown    Notes:
45219f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45229f67acb7SJed Brown 
45239f67acb7SJed Brown    Level: intermediate
45249f67acb7SJed Brown 
45259f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
45269f67acb7SJed Brown 
45275ef26d82SJed Brown .seealso:  TSGetKSPIterations()
45289f67acb7SJed Brown @*/
45295ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
45309f67acb7SJed Brown {
45319f67acb7SJed Brown   PetscFunctionBegin;
45329f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45339f67acb7SJed Brown   PetscValidIntPointer(nits,2);
45345ef26d82SJed Brown   *nits = ts->snes_its;
45359f67acb7SJed Brown   PetscFunctionReturn(0);
45369f67acb7SJed Brown }
45379f67acb7SJed Brown 
45389f67acb7SJed Brown #undef __FUNCT__
45395ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
45409f67acb7SJed Brown /*@
45415ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
45429f67acb7SJed Brown    used by the time integrator.
45439f67acb7SJed Brown 
45449f67acb7SJed Brown    Not Collective
45459f67acb7SJed Brown 
45469f67acb7SJed Brown    Input Parameter:
45479f67acb7SJed Brown .  ts - TS context
45489f67acb7SJed Brown 
45499f67acb7SJed Brown    Output Parameter:
45509f67acb7SJed Brown .  lits - number of linear iterations
45519f67acb7SJed Brown 
45529f67acb7SJed Brown    Notes:
45539f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45549f67acb7SJed Brown 
45559f67acb7SJed Brown    Level: intermediate
45569f67acb7SJed Brown 
45579f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
45589f67acb7SJed Brown 
45595ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
45609f67acb7SJed Brown @*/
45615ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
45629f67acb7SJed Brown {
45639f67acb7SJed Brown   PetscFunctionBegin;
45649f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45659f67acb7SJed Brown   PetscValidIntPointer(lits,2);
45665ef26d82SJed Brown   *lits = ts->ksp_its;
45679f67acb7SJed Brown   PetscFunctionReturn(0);
45689f67acb7SJed Brown }
45699f67acb7SJed Brown 
45709f67acb7SJed Brown #undef __FUNCT__
4571cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4572cef5090cSJed Brown /*@
4573cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4574cef5090cSJed Brown 
4575cef5090cSJed Brown    Not Collective
4576cef5090cSJed Brown 
4577cef5090cSJed Brown    Input Parameter:
4578cef5090cSJed Brown .  ts - TS context
4579cef5090cSJed Brown 
4580cef5090cSJed Brown    Output Parameter:
4581cef5090cSJed Brown .  rejects - number of steps rejected
4582cef5090cSJed Brown 
4583cef5090cSJed Brown    Notes:
4584cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4585cef5090cSJed Brown 
4586cef5090cSJed Brown    Level: intermediate
4587cef5090cSJed Brown 
4588cef5090cSJed Brown .keywords: TS, get, number
4589cef5090cSJed Brown 
45905ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4591cef5090cSJed Brown @*/
4592cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4593cef5090cSJed Brown {
4594cef5090cSJed Brown   PetscFunctionBegin;
4595cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4596cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4597cef5090cSJed Brown   *rejects = ts->reject;
4598cef5090cSJed Brown   PetscFunctionReturn(0);
4599cef5090cSJed Brown }
4600cef5090cSJed Brown 
4601cef5090cSJed Brown #undef __FUNCT__
4602cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4603cef5090cSJed Brown /*@
4604cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4605cef5090cSJed Brown 
4606cef5090cSJed Brown    Not Collective
4607cef5090cSJed Brown 
4608cef5090cSJed Brown    Input Parameter:
4609cef5090cSJed Brown .  ts - TS context
4610cef5090cSJed Brown 
4611cef5090cSJed Brown    Output Parameter:
4612cef5090cSJed Brown .  fails - number of failed nonlinear solves
4613cef5090cSJed Brown 
4614cef5090cSJed Brown    Notes:
4615cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4616cef5090cSJed Brown 
4617cef5090cSJed Brown    Level: intermediate
4618cef5090cSJed Brown 
4619cef5090cSJed Brown .keywords: TS, get, number
4620cef5090cSJed Brown 
46215ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4622cef5090cSJed Brown @*/
4623cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4624cef5090cSJed Brown {
4625cef5090cSJed Brown   PetscFunctionBegin;
4626cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4627cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4628cef5090cSJed Brown   *fails = ts->num_snes_failures;
4629cef5090cSJed Brown   PetscFunctionReturn(0);
4630cef5090cSJed Brown }
4631cef5090cSJed Brown 
4632cef5090cSJed Brown #undef __FUNCT__
4633cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4634cef5090cSJed Brown /*@
4635cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4636cef5090cSJed Brown 
4637cef5090cSJed Brown    Not Collective
4638cef5090cSJed Brown 
4639cef5090cSJed Brown    Input Parameter:
4640cef5090cSJed Brown +  ts - TS context
4641cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4642cef5090cSJed Brown 
4643cef5090cSJed Brown    Notes:
4644cef5090cSJed Brown    The counter is reset to zero for each step
4645cef5090cSJed Brown 
4646cef5090cSJed Brown    Options Database Key:
4647cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4648cef5090cSJed Brown 
4649cef5090cSJed Brown    Level: intermediate
4650cef5090cSJed Brown 
4651cef5090cSJed Brown .keywords: TS, set, maximum, number
4652cef5090cSJed Brown 
46535ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4654cef5090cSJed Brown @*/
4655cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4656cef5090cSJed Brown {
4657cef5090cSJed Brown   PetscFunctionBegin;
4658cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4659cef5090cSJed Brown   ts->max_reject = rejects;
4660cef5090cSJed Brown   PetscFunctionReturn(0);
4661cef5090cSJed Brown }
4662cef5090cSJed Brown 
4663cef5090cSJed Brown #undef __FUNCT__
4664cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4665cef5090cSJed Brown /*@
4666cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4667cef5090cSJed Brown 
4668cef5090cSJed Brown    Not Collective
4669cef5090cSJed Brown 
4670cef5090cSJed Brown    Input Parameter:
4671cef5090cSJed Brown +  ts - TS context
4672cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4673cef5090cSJed Brown 
4674cef5090cSJed Brown    Notes:
4675cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4676cef5090cSJed Brown 
4677cef5090cSJed Brown    Options Database Key:
4678cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4679cef5090cSJed Brown 
4680cef5090cSJed Brown    Level: intermediate
4681cef5090cSJed Brown 
4682cef5090cSJed Brown .keywords: TS, set, maximum, number
4683cef5090cSJed Brown 
46845ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4685cef5090cSJed Brown @*/
4686cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4687cef5090cSJed Brown {
4688cef5090cSJed Brown   PetscFunctionBegin;
4689cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4690cef5090cSJed Brown   ts->max_snes_failures = fails;
4691cef5090cSJed Brown   PetscFunctionReturn(0);
4692cef5090cSJed Brown }
4693cef5090cSJed Brown 
4694cef5090cSJed Brown #undef __FUNCT__
46954e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4696cef5090cSJed Brown /*@
4697cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4698cef5090cSJed Brown 
4699cef5090cSJed Brown    Not Collective
4700cef5090cSJed Brown 
4701cef5090cSJed Brown    Input Parameter:
4702cef5090cSJed Brown +  ts - TS context
4703cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4704cef5090cSJed Brown 
4705cef5090cSJed Brown    Options Database Key:
4706cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4707cef5090cSJed Brown 
4708cef5090cSJed Brown    Level: intermediate
4709cef5090cSJed Brown 
4710cef5090cSJed Brown .keywords: TS, set, error
4711cef5090cSJed Brown 
47125ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4713cef5090cSJed Brown @*/
4714cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4715cef5090cSJed Brown {
4716cef5090cSJed Brown   PetscFunctionBegin;
4717cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4718cef5090cSJed Brown   ts->errorifstepfailed = err;
4719cef5090cSJed Brown   PetscFunctionReturn(0);
4720cef5090cSJed Brown }
4721cef5090cSJed Brown 
4722cef5090cSJed Brown #undef __FUNCT__
4723fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4724fb1732b5SBarry Smith /*@C
4725fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4726fb1732b5SBarry Smith 
4727fb1732b5SBarry Smith    Collective on TS
4728fb1732b5SBarry Smith 
4729fb1732b5SBarry Smith    Input Parameters:
4730fb1732b5SBarry Smith +  ts - the TS context
4731fb1732b5SBarry Smith .  step - current time-step
4732fb1732b5SBarry Smith .  ptime - current time
47330910c330SBarry Smith .  u - current state
4734fb1732b5SBarry Smith -  viewer - binary viewer
4735fb1732b5SBarry Smith 
4736fb1732b5SBarry Smith    Level: intermediate
4737fb1732b5SBarry Smith 
4738fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4739fb1732b5SBarry Smith 
4740fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4741fb1732b5SBarry Smith @*/
47420910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4743fb1732b5SBarry Smith {
4744fb1732b5SBarry Smith   PetscErrorCode ierr;
4745ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4746fb1732b5SBarry Smith 
4747fb1732b5SBarry Smith   PetscFunctionBegin;
47480910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4749ed81e22dSJed Brown   PetscFunctionReturn(0);
4750ed81e22dSJed Brown }
4751ed81e22dSJed Brown 
4752ed81e22dSJed Brown #undef __FUNCT__
4753ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4754ed81e22dSJed Brown /*@C
4755ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4756ed81e22dSJed Brown 
4757ed81e22dSJed Brown    Collective on TS
4758ed81e22dSJed Brown 
4759ed81e22dSJed Brown    Input Parameters:
4760ed81e22dSJed Brown +  ts - the TS context
4761ed81e22dSJed Brown .  step - current time-step
4762ed81e22dSJed Brown .  ptime - current time
47630910c330SBarry Smith .  u - current state
4764ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4765ed81e22dSJed Brown 
4766ed81e22dSJed Brown    Level: intermediate
4767ed81e22dSJed Brown 
4768ed81e22dSJed Brown    Notes:
4769ed81e22dSJed 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.
4770ed81e22dSJed Brown    These are named according to the file name template.
4771ed81e22dSJed Brown 
4772ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4773ed81e22dSJed Brown 
4774ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4775ed81e22dSJed Brown 
4776ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4777ed81e22dSJed Brown @*/
47780910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4779ed81e22dSJed Brown {
4780ed81e22dSJed Brown   PetscErrorCode ierr;
4781ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4782ed81e22dSJed Brown   PetscViewer    viewer;
4783ed81e22dSJed Brown 
4784ed81e22dSJed Brown   PetscFunctionBegin;
47858caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4786ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
47870910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4788ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4789ed81e22dSJed Brown   PetscFunctionReturn(0);
4790ed81e22dSJed Brown }
4791ed81e22dSJed Brown 
4792ed81e22dSJed Brown #undef __FUNCT__
4793ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4794ed81e22dSJed Brown /*@C
4795ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4796ed81e22dSJed Brown 
4797ed81e22dSJed Brown    Collective on TS
4798ed81e22dSJed Brown 
4799ed81e22dSJed Brown    Input Parameters:
4800ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4801ed81e22dSJed Brown 
4802ed81e22dSJed Brown    Level: intermediate
4803ed81e22dSJed Brown 
4804ed81e22dSJed Brown    Note:
4805ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4806ed81e22dSJed Brown 
4807ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4808ed81e22dSJed Brown 
4809ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4810ed81e22dSJed Brown @*/
4811ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4812ed81e22dSJed Brown {
4813ed81e22dSJed Brown   PetscErrorCode ierr;
4814ed81e22dSJed Brown 
4815ed81e22dSJed Brown   PetscFunctionBegin;
4816ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4817fb1732b5SBarry Smith   PetscFunctionReturn(0);
4818fb1732b5SBarry Smith }
4819fb1732b5SBarry Smith 
482084df9cb4SJed Brown #undef __FUNCT__
4821552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
482284df9cb4SJed Brown /*@
4823552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
482484df9cb4SJed Brown 
4825ed81e22dSJed Brown    Collective on TS if controller has not been created yet
482684df9cb4SJed Brown 
482784df9cb4SJed Brown    Input Arguments:
4828ed81e22dSJed Brown .  ts - time stepping context
482984df9cb4SJed Brown 
483084df9cb4SJed Brown    Output Arguments:
4831ed81e22dSJed Brown .  adapt - adaptive controller
483284df9cb4SJed Brown 
483384df9cb4SJed Brown    Level: intermediate
483484df9cb4SJed Brown 
4835ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
483684df9cb4SJed Brown @*/
4837552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
483884df9cb4SJed Brown {
483984df9cb4SJed Brown   PetscErrorCode ierr;
484084df9cb4SJed Brown 
484184df9cb4SJed Brown   PetscFunctionBegin;
484284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
484384df9cb4SJed Brown   PetscValidPointer(adapt,2);
484484df9cb4SJed Brown   if (!ts->adapt) {
4845ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
48463bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
48471c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
484884df9cb4SJed Brown   }
484984df9cb4SJed Brown   *adapt = ts->adapt;
485084df9cb4SJed Brown   PetscFunctionReturn(0);
485184df9cb4SJed Brown }
4852d6ebe24aSShri Abhyankar 
4853d6ebe24aSShri Abhyankar #undef __FUNCT__
48541c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
48551c3436cfSJed Brown /*@
48561c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
48571c3436cfSJed Brown 
48581c3436cfSJed Brown    Logically Collective
48591c3436cfSJed Brown 
48601c3436cfSJed Brown    Input Arguments:
48611c3436cfSJed Brown +  ts - time integration context
48621c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
48630298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
48641c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
48650298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
48661c3436cfSJed Brown 
4867a3cdaa26SBarry Smith    Options Database keys:
4868a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4869a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4870a3cdaa26SBarry Smith 
48711c3436cfSJed Brown    Level: beginner
48721c3436cfSJed Brown 
4873c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
48741c3436cfSJed Brown @*/
48751c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
48761c3436cfSJed Brown {
48771c3436cfSJed Brown   PetscErrorCode ierr;
48781c3436cfSJed Brown 
48791c3436cfSJed Brown   PetscFunctionBegin;
4880c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
48811c3436cfSJed Brown   if (vatol) {
48821c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
48831c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4884bbd56ea5SKarl Rupp 
48851c3436cfSJed Brown     ts->vatol = vatol;
48861c3436cfSJed Brown   }
4887c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
48881c3436cfSJed Brown   if (vrtol) {
48891c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
48901c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4891bbd56ea5SKarl Rupp 
48921c3436cfSJed Brown     ts->vrtol = vrtol;
48931c3436cfSJed Brown   }
48941c3436cfSJed Brown   PetscFunctionReturn(0);
48951c3436cfSJed Brown }
48961c3436cfSJed Brown 
48971c3436cfSJed Brown #undef __FUNCT__
4898c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4899c5033834SJed Brown /*@
4900c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4901c5033834SJed Brown 
4902c5033834SJed Brown    Logically Collective
4903c5033834SJed Brown 
4904c5033834SJed Brown    Input Arguments:
4905c5033834SJed Brown .  ts - time integration context
4906c5033834SJed Brown 
4907c5033834SJed Brown    Output Arguments:
49080298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
49090298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
49100298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
49110298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4912c5033834SJed Brown 
4913c5033834SJed Brown    Level: beginner
4914c5033834SJed Brown 
4915c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4916c5033834SJed Brown @*/
4917c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4918c5033834SJed Brown {
4919c5033834SJed Brown   PetscFunctionBegin;
4920c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4921c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4922c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4923c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4924c5033834SJed Brown   PetscFunctionReturn(0);
4925c5033834SJed Brown }
4926c5033834SJed Brown 
4927c5033834SJed Brown #undef __FUNCT__
49281c3436cfSJed Brown #define __FUNCT__ "TSErrorNormWRMS"
49291c3436cfSJed Brown /*@
49301c3436cfSJed Brown    TSErrorNormWRMS - compute a weighted norm of the difference between a vector and the current state
49311c3436cfSJed Brown 
49321c3436cfSJed Brown    Collective on TS
49331c3436cfSJed Brown 
49341c3436cfSJed Brown    Input Arguments:
49351c3436cfSJed Brown +  ts - time stepping context
49361c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
49371c3436cfSJed Brown 
49381c3436cfSJed Brown    Output Arguments:
49391c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
49401c3436cfSJed Brown 
49411c3436cfSJed Brown    Level: developer
49421c3436cfSJed Brown 
49431c3436cfSJed Brown .seealso: TSSetTolerances()
49441c3436cfSJed Brown @*/
49451c3436cfSJed Brown PetscErrorCode TSErrorNormWRMS(TS ts,Vec Y,PetscReal *norm)
49461c3436cfSJed Brown {
49471c3436cfSJed Brown   PetscErrorCode    ierr;
49481c3436cfSJed Brown   PetscInt          i,n,N;
49490910c330SBarry Smith   const PetscScalar *u,*y;
49500910c330SBarry Smith   Vec               U;
49511c3436cfSJed Brown   PetscReal         sum,gsum;
49521c3436cfSJed Brown 
49531c3436cfSJed Brown   PetscFunctionBegin;
49541c3436cfSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49551c3436cfSJed Brown   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
49561c3436cfSJed Brown   PetscValidPointer(norm,3);
49570910c330SBarry Smith   U = ts->vec_sol;
49580910c330SBarry Smith   PetscCheckSameTypeAndComm(U,1,Y,2);
4959ce94432eSBarry Smith   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
49601c3436cfSJed Brown 
49610910c330SBarry Smith   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
49620910c330SBarry Smith   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
49630910c330SBarry Smith   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
49641c3436cfSJed Brown   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
49651c3436cfSJed Brown   sum  = 0.;
4966ceefc113SJed Brown   if (ts->vatol && ts->vrtol) {
4967ceefc113SJed Brown     const PetscScalar *atol,*rtol;
4968ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4969ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4970ceefc113SJed Brown     for (i=0; i<n; i++) {
49710910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49720910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4973ceefc113SJed Brown     }
4974ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4975ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4976ceefc113SJed Brown   } else if (ts->vatol) {       /* vector atol, scalar rtol */
4977ceefc113SJed Brown     const PetscScalar *atol;
4978ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4979ceefc113SJed Brown     for (i=0; i<n; i++) {
49800910c330SBarry Smith       PetscReal tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49810910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4982ceefc113SJed Brown     }
4983ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
4984ceefc113SJed Brown   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
4985ceefc113SJed Brown     const PetscScalar *rtol;
4986ceefc113SJed Brown     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4987ceefc113SJed Brown     for (i=0; i<n; i++) {
49880910c330SBarry Smith       PetscReal tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49890910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
4990ceefc113SJed Brown     }
4991ceefc113SJed Brown     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
4992ceefc113SJed Brown   } else {                      /* scalar atol, scalar rtol */
49931c3436cfSJed Brown     for (i=0; i<n; i++) {
49940910c330SBarry Smith       PetscReal tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
49950910c330SBarry Smith       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
49961c3436cfSJed Brown     }
4997ceefc113SJed Brown   }
49980910c330SBarry Smith   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
49991c3436cfSJed Brown   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
50001c3436cfSJed Brown 
5001ce94432eSBarry Smith   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
50021c3436cfSJed Brown   *norm = PetscSqrtReal(gsum / N);
5003620fc8aaSSatish Balay   if (PetscIsInfOrNanReal(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
50041c3436cfSJed Brown   PetscFunctionReturn(0);
50051c3436cfSJed Brown }
50061c3436cfSJed Brown 
50071c3436cfSJed Brown #undef __FUNCT__
50088d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
50098d59e960SJed Brown /*@
50108d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
50118d59e960SJed Brown 
50128d59e960SJed Brown    Logically Collective on TS
50138d59e960SJed Brown 
50148d59e960SJed Brown    Input Arguments:
50158d59e960SJed Brown +  ts - time stepping context
50168d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
50178d59e960SJed Brown 
50188d59e960SJed Brown    Note:
50198d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
50208d59e960SJed Brown 
50218d59e960SJed Brown    Level: intermediate
50228d59e960SJed Brown 
50238d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
50248d59e960SJed Brown @*/
50258d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
50268d59e960SJed Brown {
50278d59e960SJed Brown   PetscFunctionBegin;
50288d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
50298d59e960SJed Brown   ts->cfltime_local = cfltime;
50308d59e960SJed Brown   ts->cfltime       = -1.;
50318d59e960SJed Brown   PetscFunctionReturn(0);
50328d59e960SJed Brown }
50338d59e960SJed Brown 
50348d59e960SJed Brown #undef __FUNCT__
50358d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
50368d59e960SJed Brown /*@
50378d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
50388d59e960SJed Brown 
50398d59e960SJed Brown    Collective on TS
50408d59e960SJed Brown 
50418d59e960SJed Brown    Input Arguments:
50428d59e960SJed Brown .  ts - time stepping context
50438d59e960SJed Brown 
50448d59e960SJed Brown    Output Arguments:
50458d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
50468d59e960SJed Brown 
50478d59e960SJed Brown    Level: advanced
50488d59e960SJed Brown 
50498d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
50508d59e960SJed Brown @*/
50518d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
50528d59e960SJed Brown {
50538d59e960SJed Brown   PetscErrorCode ierr;
50548d59e960SJed Brown 
50558d59e960SJed Brown   PetscFunctionBegin;
50568d59e960SJed Brown   if (ts->cfltime < 0) {
5057ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
50588d59e960SJed Brown   }
50598d59e960SJed Brown   *cfltime = ts->cfltime;
50608d59e960SJed Brown   PetscFunctionReturn(0);
50618d59e960SJed Brown }
50628d59e960SJed Brown 
50638d59e960SJed Brown #undef __FUNCT__
5064d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5065d6ebe24aSShri Abhyankar /*@
5066d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5067d6ebe24aSShri Abhyankar 
5068d6ebe24aSShri Abhyankar    Input Parameters:
5069d6ebe24aSShri Abhyankar .  ts   - the TS context.
5070d6ebe24aSShri Abhyankar .  xl   - lower bound.
5071d6ebe24aSShri Abhyankar .  xu   - upper bound.
5072d6ebe24aSShri Abhyankar 
5073d6ebe24aSShri Abhyankar    Notes:
5074d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5075e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5076d6ebe24aSShri Abhyankar 
50772bd2b0e6SSatish Balay    Level: advanced
50782bd2b0e6SSatish Balay 
5079d6ebe24aSShri Abhyankar @*/
5080d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5081d6ebe24aSShri Abhyankar {
5082d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5083d6ebe24aSShri Abhyankar   SNES           snes;
5084d6ebe24aSShri Abhyankar 
5085d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5086d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5087d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5088d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5089d6ebe24aSShri Abhyankar }
5090d6ebe24aSShri Abhyankar 
5091325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5092c6db04a5SJed Brown #include <mex.h>
5093325fc9f4SBarry Smith 
5094325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5095325fc9f4SBarry Smith 
5096325fc9f4SBarry Smith #undef __FUNCT__
5097325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5098325fc9f4SBarry Smith /*
5099325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5100325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5101325fc9f4SBarry Smith 
5102325fc9f4SBarry Smith    Collective on TS
5103325fc9f4SBarry Smith 
5104325fc9f4SBarry Smith    Input Parameters:
5105325fc9f4SBarry Smith +  snes - the TS context
51060910c330SBarry Smith -  u - input vector
5107325fc9f4SBarry Smith 
5108325fc9f4SBarry Smith    Output Parameter:
5109325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5110325fc9f4SBarry Smith 
5111325fc9f4SBarry Smith    Notes:
5112325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5113325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5114325fc9f4SBarry Smith    themselves.
5115325fc9f4SBarry Smith 
5116325fc9f4SBarry Smith    Level: developer
5117325fc9f4SBarry Smith 
5118325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5119325fc9f4SBarry Smith 
5120325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5121325fc9f4SBarry Smith */
51220910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5123325fc9f4SBarry Smith {
5124325fc9f4SBarry Smith   PetscErrorCode  ierr;
5125325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5126325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5127325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5128325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5129325fc9f4SBarry Smith 
5130325fc9f4SBarry Smith   PetscFunctionBegin;
5131325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
51320910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
51330910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5134325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
51350910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5136325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5137325fc9f4SBarry Smith 
5138325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
51390910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
51400910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
51410910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5142bbd56ea5SKarl Rupp 
5143325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5144325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5145325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5146325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5147325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5148325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5149325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5150325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5151325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5152325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5153325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5154325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5155325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5156325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5157325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5158325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5159325fc9f4SBarry Smith   PetscFunctionReturn(0);
5160325fc9f4SBarry Smith }
5161325fc9f4SBarry Smith 
5162325fc9f4SBarry Smith 
5163325fc9f4SBarry Smith #undef __FUNCT__
5164325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5165325fc9f4SBarry Smith /*
5166325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5167325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5168e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5169325fc9f4SBarry Smith 
5170325fc9f4SBarry Smith    Logically Collective on TS
5171325fc9f4SBarry Smith 
5172325fc9f4SBarry Smith    Input Parameters:
5173325fc9f4SBarry Smith +  ts - the TS context
5174325fc9f4SBarry Smith -  func - function evaluation routine
5175325fc9f4SBarry Smith 
5176325fc9f4SBarry Smith    Calling sequence of func:
51770910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5178325fc9f4SBarry Smith 
5179325fc9f4SBarry Smith    Level: beginner
5180325fc9f4SBarry Smith 
5181325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5182325fc9f4SBarry Smith 
5183325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5184325fc9f4SBarry Smith */
5185cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5186325fc9f4SBarry Smith {
5187325fc9f4SBarry Smith   PetscErrorCode  ierr;
5188325fc9f4SBarry Smith   TSMatlabContext *sctx;
5189325fc9f4SBarry Smith 
5190325fc9f4SBarry Smith   PetscFunctionBegin;
5191325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5192325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5193325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5194325fc9f4SBarry Smith   /*
5195325fc9f4SBarry Smith      This should work, but it doesn't
5196325fc9f4SBarry Smith   sctx->ctx = ctx;
5197325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5198325fc9f4SBarry Smith   */
5199325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5200bbd56ea5SKarl Rupp 
52010298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5202325fc9f4SBarry Smith   PetscFunctionReturn(0);
5203325fc9f4SBarry Smith }
5204325fc9f4SBarry Smith 
5205325fc9f4SBarry Smith #undef __FUNCT__
5206325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5207325fc9f4SBarry Smith /*
5208325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5209325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5210325fc9f4SBarry Smith 
5211325fc9f4SBarry Smith    Collective on TS
5212325fc9f4SBarry Smith 
5213325fc9f4SBarry Smith    Input Parameters:
5214cdcf91faSSean Farley +  ts - the TS context
52150910c330SBarry Smith .  u - input vector
5216325fc9f4SBarry Smith .  A, B - the matrices
5217325fc9f4SBarry Smith -  ctx - user context
5218325fc9f4SBarry Smith 
5219325fc9f4SBarry Smith    Level: developer
5220325fc9f4SBarry Smith 
5221325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5222325fc9f4SBarry Smith 
5223325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5224325fc9f4SBarry Smith @*/
5225f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5226325fc9f4SBarry Smith {
5227325fc9f4SBarry Smith   PetscErrorCode  ierr;
5228325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5229325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5230325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5231325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5232325fc9f4SBarry Smith 
5233325fc9f4SBarry Smith   PetscFunctionBegin;
5234cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
52350910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5236325fc9f4SBarry Smith 
52370910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5238325fc9f4SBarry Smith 
5239cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
52400910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
52410910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
52420910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
52430910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5244bbd56ea5SKarl Rupp 
5245325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5246325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5247325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5248325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5249325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5250325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5251325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5252325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5253325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5254325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5255325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5256325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5257325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5258325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5259325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5260325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5261325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5262325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5263325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5264325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5265325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5266325fc9f4SBarry Smith   PetscFunctionReturn(0);
5267325fc9f4SBarry Smith }
5268325fc9f4SBarry Smith 
5269325fc9f4SBarry Smith 
5270325fc9f4SBarry Smith #undef __FUNCT__
5271325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5272325fc9f4SBarry Smith /*
5273325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5274e3c5b3baSBarry 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
5275325fc9f4SBarry Smith 
5276325fc9f4SBarry Smith    Logically Collective on TS
5277325fc9f4SBarry Smith 
5278325fc9f4SBarry Smith    Input Parameters:
5279cdcf91faSSean Farley +  ts - the TS context
5280325fc9f4SBarry Smith .  A,B - Jacobian matrices
5281325fc9f4SBarry Smith .  func - function evaluation routine
5282325fc9f4SBarry Smith -  ctx - user context
5283325fc9f4SBarry Smith 
5284325fc9f4SBarry Smith    Calling sequence of func:
52850910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5286325fc9f4SBarry Smith 
5287325fc9f4SBarry Smith 
5288325fc9f4SBarry Smith    Level: developer
5289325fc9f4SBarry Smith 
5290325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5291325fc9f4SBarry Smith 
5292325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5293325fc9f4SBarry Smith */
5294cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5295325fc9f4SBarry Smith {
5296325fc9f4SBarry Smith   PetscErrorCode  ierr;
5297325fc9f4SBarry Smith   TSMatlabContext *sctx;
5298325fc9f4SBarry Smith 
5299325fc9f4SBarry Smith   PetscFunctionBegin;
5300325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5301325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5302325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5303325fc9f4SBarry Smith   /*
5304325fc9f4SBarry Smith      This should work, but it doesn't
5305325fc9f4SBarry Smith   sctx->ctx = ctx;
5306325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5307325fc9f4SBarry Smith   */
5308325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5309bbd56ea5SKarl Rupp 
5310cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5311325fc9f4SBarry Smith   PetscFunctionReturn(0);
5312325fc9f4SBarry Smith }
5313325fc9f4SBarry Smith 
5314b5b1a830SBarry Smith #undef __FUNCT__
5315b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5316b5b1a830SBarry Smith /*
5317b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5318b5b1a830SBarry Smith 
5319b5b1a830SBarry Smith    Collective on TS
5320b5b1a830SBarry Smith 
5321b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5322b5b1a830SBarry Smith @*/
53230910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5324b5b1a830SBarry Smith {
5325b5b1a830SBarry Smith   PetscErrorCode  ierr;
5326b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5327a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5328b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5329b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5330b5b1a830SBarry Smith 
5331b5b1a830SBarry Smith   PetscFunctionBegin;
5332cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53330910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5334b5b1a830SBarry Smith 
5335cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
53360910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5337bbd56ea5SKarl Rupp 
5338b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5339b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5340b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5341b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5342b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5343b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5344b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5345b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5346b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5347b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5348b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5349b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5350b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5351b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5352b5b1a830SBarry Smith   PetscFunctionReturn(0);
5353b5b1a830SBarry Smith }
5354b5b1a830SBarry Smith 
5355b5b1a830SBarry Smith 
5356b5b1a830SBarry Smith #undef __FUNCT__
5357b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5358b5b1a830SBarry Smith /*
5359b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5360b5b1a830SBarry Smith 
5361b5b1a830SBarry Smith    Level: developer
5362b5b1a830SBarry Smith 
5363b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5364b5b1a830SBarry Smith 
5365b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5366b5b1a830SBarry Smith */
5367cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5368b5b1a830SBarry Smith {
5369b5b1a830SBarry Smith   PetscErrorCode  ierr;
5370b5b1a830SBarry Smith   TSMatlabContext *sctx;
5371b5b1a830SBarry Smith 
5372b5b1a830SBarry Smith   PetscFunctionBegin;
5373b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5374b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5375b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5376b5b1a830SBarry Smith   /*
5377b5b1a830SBarry Smith      This should work, but it doesn't
5378b5b1a830SBarry Smith   sctx->ctx = ctx;
5379b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5380b5b1a830SBarry Smith   */
5381b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5382bbd56ea5SKarl Rupp 
53830298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5384b5b1a830SBarry Smith   PetscFunctionReturn(0);
5385b5b1a830SBarry Smith }
5386325fc9f4SBarry Smith #endif
5387b3603a34SBarry Smith 
5388b3603a34SBarry Smith #undef __FUNCT__
53894f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5390b3603a34SBarry Smith /*@C
53914f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5392b3603a34SBarry Smith        in a time based line graph
5393b3603a34SBarry Smith 
5394b3603a34SBarry Smith    Collective on TS
5395b3603a34SBarry Smith 
5396b3603a34SBarry Smith    Input Parameters:
5397b3603a34SBarry Smith +  ts - the TS context
5398b3603a34SBarry Smith .  step - current time-step
5399b3603a34SBarry Smith .  ptime - current time
5400b3603a34SBarry Smith -  lg - a line graph object
5401b3603a34SBarry Smith 
5402b3d3934dSBarry Smith    Options Database:
54039ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5404b3d3934dSBarry Smith 
5405b3603a34SBarry Smith    Level: intermediate
5406b3603a34SBarry Smith 
54070b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5408b3603a34SBarry Smith 
5409b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5410b3603a34SBarry Smith 
5411b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5412b3603a34SBarry Smith @*/
54130910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5414b3603a34SBarry Smith {
5415b3603a34SBarry Smith   PetscErrorCode    ierr;
54160b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5417b3603a34SBarry Smith   const PetscScalar *yy;
541858ff32f7SBarry Smith   PetscInt          dim;
541980666b62SBarry Smith   Vec               v;
5420b3603a34SBarry Smith 
5421b3603a34SBarry Smith   PetscFunctionBegin;
542258ff32f7SBarry Smith   if (!step) {
5423a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5424a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5425a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5426387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
5427387f4636SBarry Smith       char      **displaynames;
5428387f4636SBarry Smith       PetscBool flg;
5429387f4636SBarry Smith 
5430387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5431387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
5432387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
54339ae14b6eSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
5434387f4636SBarry Smith       if (flg) {
5435a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
5436387f4636SBarry Smith       }
5437387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
5438387f4636SBarry Smith     }
5439387f4636SBarry Smith     if (ctx->displaynames) {
5440387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
5441387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
5442387f4636SBarry Smith     } else if (ctx->names) {
54430910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
54440b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5445387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
5446387f4636SBarry Smith     }
54470b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
544858ff32f7SBarry Smith   }
544980666b62SBarry Smith   if (ctx->transform) {
5450e673d494SBarry Smith     ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);
545180666b62SBarry Smith   } else {
545280666b62SBarry Smith     v = u;
545380666b62SBarry Smith   }
545480666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
5455e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5456e3efe391SJed Brown   {
5457e3efe391SJed Brown     PetscReal *yreal;
5458e3efe391SJed Brown     PetscInt  i,n;
545980666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
5460785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5461e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
54620b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5463e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5464e3efe391SJed Brown   }
5465e3efe391SJed Brown #else
5466387f4636SBarry Smith   if (ctx->displaynames) {
5467387f4636SBarry Smith     PetscInt i;
5468387f4636SBarry Smith     for (i=0; i<ctx->ndisplayvariables; i++) {
5469387f4636SBarry Smith       ctx->displayvalues[i] = yy[ctx->displayvariables[i]];
5470387f4636SBarry Smith     }
5471387f4636SBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
5472387f4636SBarry Smith   } else {
54730b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5474387f4636SBarry Smith   }
5475e3efe391SJed Brown #endif
547680666b62SBarry Smith   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
547780666b62SBarry Smith   if (ctx->transform) {
547880666b62SBarry Smith     ierr = VecDestroy(&v);CHKERRQ(ierr);
547980666b62SBarry Smith   }
5480b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
54810b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
54823923b477SBarry Smith   }
5483b3603a34SBarry Smith   PetscFunctionReturn(0);
5484b3603a34SBarry Smith }
5485b3603a34SBarry Smith 
5486387f4636SBarry Smith 
5487b3603a34SBarry Smith #undef __FUNCT__
548831152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
5489b037adc7SBarry Smith /*@C
549031152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5491b037adc7SBarry Smith 
5492b037adc7SBarry Smith    Collective on TS
5493b037adc7SBarry Smith 
5494b037adc7SBarry Smith    Input Parameters:
5495b037adc7SBarry Smith +  ts - the TS context
5496b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
5497b037adc7SBarry Smith 
5498b037adc7SBarry Smith    Level: intermediate
5499b037adc7SBarry Smith 
5500b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
5501b037adc7SBarry Smith 
5502a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
5503b037adc7SBarry Smith @*/
550431152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
5505b037adc7SBarry Smith {
5506b037adc7SBarry Smith   PetscErrorCode    ierr;
5507b037adc7SBarry Smith   PetscInt          i;
5508b037adc7SBarry Smith 
5509b037adc7SBarry Smith   PetscFunctionBegin;
5510b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5511b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
55125537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
5513b3d3934dSBarry Smith       break;
5514b3d3934dSBarry Smith     }
5515b3d3934dSBarry Smith   }
5516b3d3934dSBarry Smith   PetscFunctionReturn(0);
5517b3d3934dSBarry Smith }
5518b3d3934dSBarry Smith 
5519b3d3934dSBarry Smith #undef __FUNCT__
5520e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
5521e673d494SBarry Smith /*@C
5522e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5523e673d494SBarry Smith 
5524e673d494SBarry Smith    Collective on TS
5525e673d494SBarry Smith 
5526e673d494SBarry Smith    Input Parameters:
5527e673d494SBarry Smith +  ts - the TS context
5528e673d494SBarry Smith -  names - the names of the components, final string must be NULL
5529e673d494SBarry Smith 
5530e673d494SBarry Smith    Level: intermediate
5531e673d494SBarry Smith 
5532e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5533e673d494SBarry Smith 
5534a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
5535e673d494SBarry Smith @*/
5536e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
5537e673d494SBarry Smith {
5538e673d494SBarry Smith   PetscErrorCode    ierr;
5539e673d494SBarry Smith 
5540e673d494SBarry Smith   PetscFunctionBegin;
5541e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
5542e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
5543e673d494SBarry Smith   PetscFunctionReturn(0);
5544e673d494SBarry Smith }
5545e673d494SBarry Smith 
5546e673d494SBarry Smith #undef __FUNCT__
5547b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
5548b3d3934dSBarry Smith /*@C
5549b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
5550b3d3934dSBarry Smith 
5551b3d3934dSBarry Smith    Collective on TS
5552b3d3934dSBarry Smith 
5553b3d3934dSBarry Smith    Input Parameter:
5554b3d3934dSBarry Smith .  ts - the TS context
5555b3d3934dSBarry Smith 
5556b3d3934dSBarry Smith    Output Parameter:
5557b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
5558b3d3934dSBarry Smith 
5559b3d3934dSBarry Smith    Level: intermediate
5560b3d3934dSBarry Smith 
5561b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5562b3d3934dSBarry Smith 
5563b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
5564b3d3934dSBarry Smith @*/
5565b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
5566b3d3934dSBarry Smith {
5567b3d3934dSBarry Smith   PetscInt       i;
5568b3d3934dSBarry Smith 
5569b3d3934dSBarry Smith   PetscFunctionBegin;
5570b3d3934dSBarry Smith   *names = NULL;
5571b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5572b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
55735537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
5574b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
5575b3d3934dSBarry Smith       break;
5576387f4636SBarry Smith     }
5577387f4636SBarry Smith   }
5578387f4636SBarry Smith   PetscFunctionReturn(0);
5579387f4636SBarry Smith }
5580387f4636SBarry Smith 
5581387f4636SBarry Smith #undef __FUNCT__
5582a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
5583a66092f1SBarry Smith /*@C
5584a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
5585a66092f1SBarry Smith 
5586a66092f1SBarry Smith    Collective on TS
5587a66092f1SBarry Smith 
5588a66092f1SBarry Smith    Input Parameters:
5589a66092f1SBarry Smith +  ctx - the TSMonitorLG context
5590a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
5591a66092f1SBarry Smith 
5592a66092f1SBarry Smith    Level: intermediate
5593a66092f1SBarry Smith 
5594a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
5595a66092f1SBarry Smith 
5596a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
5597a66092f1SBarry Smith @*/
5598a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
5599a66092f1SBarry Smith {
5600a66092f1SBarry Smith   PetscInt          j = 0,k;
5601a66092f1SBarry Smith   PetscErrorCode    ierr;
5602a66092f1SBarry Smith 
5603a66092f1SBarry Smith   PetscFunctionBegin;
5604a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
5605a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
5606a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
5607a66092f1SBarry Smith   while (displaynames[j]) j++;
5608a66092f1SBarry Smith   ctx->ndisplayvariables = j;
5609a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
5610a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
5611a66092f1SBarry Smith   j = 0;
5612a66092f1SBarry Smith   while (displaynames[j]) {
5613a66092f1SBarry Smith     k = 0;
5614a66092f1SBarry Smith     while (ctx->names[k]) {
5615a66092f1SBarry Smith       PetscBool flg;
5616a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
5617a66092f1SBarry Smith       if (flg) {
5618a66092f1SBarry Smith         ctx->displayvariables[j] = k;
5619a66092f1SBarry Smith         break;
5620a66092f1SBarry Smith       }
5621a66092f1SBarry Smith       k++;
5622a66092f1SBarry Smith     }
5623a66092f1SBarry Smith     j++;
5624a66092f1SBarry Smith   }
5625a66092f1SBarry Smith   PetscFunctionReturn(0);
5626a66092f1SBarry Smith }
5627a66092f1SBarry Smith 
5628a66092f1SBarry Smith 
5629a66092f1SBarry Smith #undef __FUNCT__
5630387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
5631387f4636SBarry Smith /*@C
5632387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
5633387f4636SBarry Smith 
5634387f4636SBarry Smith    Collective on TS
5635387f4636SBarry Smith 
5636387f4636SBarry Smith    Input Parameters:
5637387f4636SBarry Smith +  ts - the TS context
5638387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
5639387f4636SBarry Smith 
5640387f4636SBarry Smith    Level: intermediate
5641387f4636SBarry Smith 
5642387f4636SBarry Smith .keywords: TS,  vector, monitor, view
5643387f4636SBarry Smith 
5644387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
5645387f4636SBarry Smith @*/
5646387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
5647387f4636SBarry Smith {
5648a66092f1SBarry Smith   PetscInt          i;
5649387f4636SBarry Smith   PetscErrorCode    ierr;
5650387f4636SBarry Smith 
5651387f4636SBarry Smith   PetscFunctionBegin;
5652387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5653387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
56545537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
5655b3d3934dSBarry Smith       break;
5656b037adc7SBarry Smith     }
5657b037adc7SBarry Smith   }
5658b037adc7SBarry Smith   PetscFunctionReturn(0);
5659b037adc7SBarry Smith }
5660b037adc7SBarry Smith 
5661b037adc7SBarry Smith #undef __FUNCT__
566280666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
566380666b62SBarry Smith /*@C
566480666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
566580666b62SBarry Smith 
566680666b62SBarry Smith    Collective on TS
566780666b62SBarry Smith 
566880666b62SBarry Smith    Input Parameters:
566980666b62SBarry Smith +  ts - the TS context
567080666b62SBarry Smith .  transform - the transform function
56717684fa3eSBarry Smith .  destroy - function to destroy the optional context
567280666b62SBarry Smith -  ctx - optional context used by transform function
567380666b62SBarry Smith 
567480666b62SBarry Smith    Level: intermediate
567580666b62SBarry Smith 
567680666b62SBarry Smith .keywords: TS,  vector, monitor, view
567780666b62SBarry Smith 
5678a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
567980666b62SBarry Smith @*/
56807684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
568180666b62SBarry Smith {
568280666b62SBarry Smith   PetscInt          i;
5683a66092f1SBarry Smith   PetscErrorCode    ierr;
568480666b62SBarry Smith 
568580666b62SBarry Smith   PetscFunctionBegin;
568680666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
568780666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
56885537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
568980666b62SBarry Smith     }
569080666b62SBarry Smith   }
569180666b62SBarry Smith   PetscFunctionReturn(0);
569280666b62SBarry Smith }
569380666b62SBarry Smith 
569480666b62SBarry Smith #undef __FUNCT__
5695e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
5696e673d494SBarry Smith /*@C
5697e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
5698e673d494SBarry Smith 
5699e673d494SBarry Smith    Collective on TSLGCtx
5700e673d494SBarry Smith 
5701e673d494SBarry Smith    Input Parameters:
5702e673d494SBarry Smith +  ts - the TS context
5703e673d494SBarry Smith .  transform - the transform function
57047684fa3eSBarry Smith .  destroy - function to destroy the optional context
5705e673d494SBarry Smith -  ctx - optional context used by transform function
5706e673d494SBarry Smith 
5707e673d494SBarry Smith    Level: intermediate
5708e673d494SBarry Smith 
5709e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5710e673d494SBarry Smith 
5711a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
5712e673d494SBarry Smith @*/
57137684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
5714e673d494SBarry Smith {
5715e673d494SBarry Smith   PetscFunctionBegin;
5716e673d494SBarry Smith   ctx->transform    = transform;
57177684fa3eSBarry Smith   ctx->transformdestroy = destroy;
5718e673d494SBarry Smith   ctx->transformctx = tctx;
5719e673d494SBarry Smith   PetscFunctionReturn(0);
5720e673d494SBarry Smith }
5721e673d494SBarry Smith 
5722b3603a34SBarry Smith #undef __FUNCT__
57234f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
5724ef20d060SBarry Smith /*@C
57254f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
5726ef20d060SBarry Smith        in a time based line graph
5727ef20d060SBarry Smith 
5728ef20d060SBarry Smith    Collective on TS
5729ef20d060SBarry Smith 
5730ef20d060SBarry Smith    Input Parameters:
5731ef20d060SBarry Smith +  ts - the TS context
5732ef20d060SBarry Smith .  step - current time-step
5733ef20d060SBarry Smith .  ptime - current time
5734ef20d060SBarry Smith -  lg - a line graph object
5735ef20d060SBarry Smith 
5736ef20d060SBarry Smith    Level: intermediate
5737ef20d060SBarry Smith 
5738abd5a294SJed Brown    Notes:
5739abd5a294SJed Brown    Only for sequential solves.
5740abd5a294SJed Brown 
5741abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
5742abd5a294SJed Brown 
5743abd5a294SJed Brown    Options Database Keys:
57444f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
5745ef20d060SBarry Smith 
5746ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
5747ef20d060SBarry Smith 
5748abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5749ef20d060SBarry Smith @*/
57500910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5751ef20d060SBarry Smith {
5752ef20d060SBarry Smith   PetscErrorCode    ierr;
57530b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5754ef20d060SBarry Smith   const PetscScalar *yy;
5755ef20d060SBarry Smith   Vec               y;
5756a9f9c1f6SBarry Smith   PetscInt          dim;
5757ef20d060SBarry Smith 
5758ef20d060SBarry Smith   PetscFunctionBegin;
5759a9f9c1f6SBarry Smith   if (!step) {
5760a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5761a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
57621ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
57630910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5764a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5765a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5766a9f9c1f6SBarry Smith   }
57670910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5768ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
57690910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5770ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5771e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5772e3efe391SJed Brown   {
5773e3efe391SJed Brown     PetscReal *yreal;
5774e3efe391SJed Brown     PetscInt  i,n;
5775e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5776785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5777e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
57780b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5779e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5780e3efe391SJed Brown   }
5781e3efe391SJed Brown #else
57820b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5783e3efe391SJed Brown #endif
5784ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5785ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
5786b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
57870b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
57883923b477SBarry Smith   }
5789ef20d060SBarry Smith   PetscFunctionReturn(0);
5790ef20d060SBarry Smith }
5791ef20d060SBarry Smith 
5792201da799SBarry Smith #undef __FUNCT__
5793201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
5794201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5795201da799SBarry Smith {
5796201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5797201da799SBarry Smith   PetscReal      x   = ptime,y;
5798201da799SBarry Smith   PetscErrorCode ierr;
5799201da799SBarry Smith   PetscInt       its;
5800201da799SBarry Smith 
5801201da799SBarry Smith   PetscFunctionBegin;
5802201da799SBarry Smith   if (!n) {
5803201da799SBarry Smith     PetscDrawAxis axis;
5804bbd56ea5SKarl Rupp 
5805201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5806201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5807201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5808bbd56ea5SKarl Rupp 
5809201da799SBarry Smith     ctx->snes_its = 0;
5810201da799SBarry Smith   }
5811201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5812201da799SBarry Smith   y    = its - ctx->snes_its;
5813201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
58143fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5815201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5816201da799SBarry Smith   }
5817201da799SBarry Smith   ctx->snes_its = its;
5818201da799SBarry Smith   PetscFunctionReturn(0);
5819201da799SBarry Smith }
5820201da799SBarry Smith 
5821201da799SBarry Smith #undef __FUNCT__
5822201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
5823201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5824201da799SBarry Smith {
5825201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5826201da799SBarry Smith   PetscReal      x   = ptime,y;
5827201da799SBarry Smith   PetscErrorCode ierr;
5828201da799SBarry Smith   PetscInt       its;
5829201da799SBarry Smith 
5830201da799SBarry Smith   PetscFunctionBegin;
5831201da799SBarry Smith   if (!n) {
5832201da799SBarry Smith     PetscDrawAxis axis;
5833bbd56ea5SKarl Rupp 
5834201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5835201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
5836201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5837bbd56ea5SKarl Rupp 
5838201da799SBarry Smith     ctx->ksp_its = 0;
5839201da799SBarry Smith   }
5840201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
5841201da799SBarry Smith   y    = its - ctx->ksp_its;
5842201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
584399fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5844201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5845201da799SBarry Smith   }
5846201da799SBarry Smith   ctx->ksp_its = its;
5847201da799SBarry Smith   PetscFunctionReturn(0);
5848201da799SBarry Smith }
5849f9c1d6abSBarry Smith 
5850f9c1d6abSBarry Smith #undef __FUNCT__
5851f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
5852f9c1d6abSBarry Smith /*@
5853f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
5854f9c1d6abSBarry Smith 
5855f9c1d6abSBarry Smith    Collective on TS and Vec
5856f9c1d6abSBarry Smith 
5857f9c1d6abSBarry Smith    Input Parameters:
5858f9c1d6abSBarry Smith +  ts - the TS context
5859f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
5860f9c1d6abSBarry Smith 
5861f9c1d6abSBarry Smith    Output Parameters:
5862f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
5863f9c1d6abSBarry Smith 
5864f9c1d6abSBarry Smith    Level: developer
5865f9c1d6abSBarry Smith 
5866f9c1d6abSBarry Smith .keywords: TS, compute
5867f9c1d6abSBarry Smith 
5868f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
5869f9c1d6abSBarry Smith @*/
5870f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
5871f9c1d6abSBarry Smith {
5872f9c1d6abSBarry Smith   PetscErrorCode ierr;
5873f9c1d6abSBarry Smith 
5874f9c1d6abSBarry Smith   PetscFunctionBegin;
5875f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5876ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
5877f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
5878f9c1d6abSBarry Smith   PetscFunctionReturn(0);
5879f9c1d6abSBarry Smith }
588024655328SShri 
5881b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
5882b3d3934dSBarry Smith #undef __FUNCT__
5883b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
5884b3d3934dSBarry Smith /*@C
5885b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
5886b3d3934dSBarry Smith 
5887b3d3934dSBarry Smith    Collective on TS
5888b3d3934dSBarry Smith 
5889b3d3934dSBarry Smith    Input Parameters:
5890b3d3934dSBarry Smith .  ts  - the ODE solver object
5891b3d3934dSBarry Smith 
5892b3d3934dSBarry Smith    Output Parameter:
5893b3d3934dSBarry Smith .  ctx - the context
5894b3d3934dSBarry Smith 
5895b3d3934dSBarry Smith    Level: intermediate
5896b3d3934dSBarry Smith 
5897b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
5898b3d3934dSBarry Smith 
5899b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
5900b3d3934dSBarry Smith 
5901b3d3934dSBarry Smith @*/
5902b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
5903b3d3934dSBarry Smith {
5904b3d3934dSBarry Smith   PetscErrorCode ierr;
5905b3d3934dSBarry Smith 
5906b3d3934dSBarry Smith   PetscFunctionBegin;
5907a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
5908b3d3934dSBarry Smith   PetscFunctionReturn(0);
5909b3d3934dSBarry Smith }
5910b3d3934dSBarry Smith 
5911b3d3934dSBarry Smith #undef __FUNCT__
5912b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
5913b3d3934dSBarry Smith /*@C
5914b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
5915b3d3934dSBarry Smith 
5916b3d3934dSBarry Smith    Collective on TS
5917b3d3934dSBarry Smith 
5918b3d3934dSBarry Smith    Input Parameters:
5919b3d3934dSBarry Smith +  ts - the TS context
5920b3d3934dSBarry Smith .  step - current time-step
5921b3d3934dSBarry Smith .  ptime - current time
5922b3d3934dSBarry Smith -  ctx - the envelope context
5923b3d3934dSBarry Smith 
5924b3d3934dSBarry Smith    Options Database:
5925b3d3934dSBarry Smith .  -ts_monitor_envelope
5926b3d3934dSBarry Smith 
5927b3d3934dSBarry Smith    Level: intermediate
5928b3d3934dSBarry Smith 
5929b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
5930b3d3934dSBarry Smith 
5931b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5932b3d3934dSBarry Smith 
5933b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds()
5934b3d3934dSBarry Smith @*/
5935b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5936b3d3934dSBarry Smith {
5937b3d3934dSBarry Smith   PetscErrorCode       ierr;
5938b3d3934dSBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dummy;
5939b3d3934dSBarry Smith 
5940b3d3934dSBarry Smith   PetscFunctionBegin;
5941b3d3934dSBarry Smith   if (!ctx->max) {
5942b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
5943b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
5944b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
5945b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
5946b3d3934dSBarry Smith   } else {
5947b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
5948b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
5949b3d3934dSBarry Smith   }
5950b3d3934dSBarry Smith   PetscFunctionReturn(0);
5951b3d3934dSBarry Smith }
5952b3d3934dSBarry Smith 
5953b3d3934dSBarry Smith 
5954b3d3934dSBarry Smith #undef __FUNCT__
5955b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
5956b3d3934dSBarry Smith /*@C
5957b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
5958b3d3934dSBarry Smith 
5959b3d3934dSBarry Smith    Collective on TS
5960b3d3934dSBarry Smith 
5961b3d3934dSBarry Smith    Input Parameter:
5962b3d3934dSBarry Smith .  ts - the TS context
5963b3d3934dSBarry Smith 
5964b3d3934dSBarry Smith    Output Parameter:
5965b3d3934dSBarry Smith +  max - the maximum values
5966b3d3934dSBarry Smith -  min - the minimum values
5967b3d3934dSBarry Smith 
5968b3d3934dSBarry Smith    Level: intermediate
5969b3d3934dSBarry Smith 
5970b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5971b3d3934dSBarry Smith 
5972b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
5973b3d3934dSBarry Smith @*/
5974b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
5975b3d3934dSBarry Smith {
5976b3d3934dSBarry Smith   PetscInt i;
5977b3d3934dSBarry Smith 
5978b3d3934dSBarry Smith   PetscFunctionBegin;
5979b3d3934dSBarry Smith   if (max) *max = NULL;
5980b3d3934dSBarry Smith   if (min) *min = NULL;
5981b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5982b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
59835537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
5984b3d3934dSBarry Smith       if (max) *max = ctx->max;
5985b3d3934dSBarry Smith       if (min) *min = ctx->min;
5986b3d3934dSBarry Smith       break;
5987b3d3934dSBarry Smith     }
5988b3d3934dSBarry Smith   }
5989b3d3934dSBarry Smith   PetscFunctionReturn(0);
5990b3d3934dSBarry Smith }
5991b3d3934dSBarry Smith 
5992b3d3934dSBarry Smith #undef __FUNCT__
5993b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
5994b3d3934dSBarry Smith /*@C
5995b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
5996b3d3934dSBarry Smith 
5997b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
5998b3d3934dSBarry Smith 
5999b3d3934dSBarry Smith    Input Parameter:
6000b3d3934dSBarry Smith .  ctx - the monitor context
6001b3d3934dSBarry Smith 
6002b3d3934dSBarry Smith    Level: intermediate
6003b3d3934dSBarry Smith 
6004b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6005b3d3934dSBarry Smith 
6006b3d3934dSBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
6007b3d3934dSBarry Smith @*/
6008b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6009b3d3934dSBarry Smith {
6010b3d3934dSBarry Smith   PetscErrorCode ierr;
6011b3d3934dSBarry Smith 
6012b3d3934dSBarry Smith   PetscFunctionBegin;
6013b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6014b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6015b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6016b3d3934dSBarry Smith   PetscFunctionReturn(0);
6017b3d3934dSBarry Smith }
6018f2dee214SBarry Smith 
601924655328SShri #undef __FUNCT__
602024655328SShri #define __FUNCT__ "TSRollBack"
602124655328SShri /*@
602224655328SShri    TSRollBack - Rolls back one time step
602324655328SShri 
602424655328SShri    Collective on TS
602524655328SShri 
602624655328SShri    Input Parameter:
602724655328SShri .  ts - the TS context obtained from TSCreate()
602824655328SShri 
602924655328SShri    Level: advanced
603024655328SShri 
603124655328SShri .keywords: TS, timestep, rollback
603224655328SShri 
603324655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
603424655328SShri @*/
603524655328SShri PetscErrorCode  TSRollBack(TS ts)
603624655328SShri {
603724655328SShri   PetscErrorCode ierr;
603824655328SShri 
603924655328SShri   PetscFunctionBegin;
604024655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
604124655328SShri 
604224655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
604324655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
604424655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
604524655328SShri   ts->ptime = ts->ptime_prev;
60468392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
604724655328SShri   PetscFunctionReturn(0);
604824655328SShri }
6049aeb4809dSShri Abhyankar 
6050ff22ae23SHong Zhang #undef __FUNCT__
6051ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6052ff22ae23SHong Zhang /*@
6053ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6054ff22ae23SHong Zhang 
6055ff22ae23SHong Zhang    Input Parameter:
6056ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6057ff22ae23SHong Zhang 
6058ff22ae23SHong Zhang    Level: advanced
6059ff22ae23SHong Zhang 
6060ff22ae23SHong Zhang .keywords: TS, getstages
6061ff22ae23SHong Zhang 
6062ff22ae23SHong Zhang .seealso: TSCreate()
6063ff22ae23SHong Zhang @*/
6064ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6065ff22ae23SHong Zhang {
6066ff22ae23SHong Zhang   PetscErrorCode ierr;
6067ff22ae23SHong Zhang 
6068ff22ae23SHong Zhang   PetscFunctionBegin;
6069ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6070ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6071ff22ae23SHong Zhang 
6072ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6073ff22ae23SHong Zhang   else {
6074ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6075ff22ae23SHong Zhang   }
6076ff22ae23SHong Zhang   PetscFunctionReturn(0);
6077ff22ae23SHong Zhang }
6078ff22ae23SHong Zhang 
6079