xref: /petsc/src/ts/interface/ts.c (revision 3ef54c4a48e024efd6db2a76575ea5a2308db99f)
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);
3061c3436cfSJed Brown 
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 
330d763cef2SBarry Smith     /* Handle specific TS options */
331d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
3326991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
333d763cef2SBarry Smith   }
3346991f827SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
335d763cef2SBarry Smith 
336d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
337d763cef2SBarry 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) {
814214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
815bd373395SBarry Smith       } else {
816bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
817214bc6a2SJed 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);
837214bc6a2SJed Brown         }
838316643e7SJed 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);
842316643e7SJed 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);
14510298fd71SBarry Smith     ierr   = PetscDrawBoxedString(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 
18541c3436cfSJed Brown 
1855552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
1856277b19d0SLisandro Dalcin 
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);
1980b29392e1SShri   ierr = ISDestroy(&ts->is_diff);CHKERRQ(ierr);
1981bbd56ea5SKarl Rupp 
1982d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1983d8151eeaSBarry Smith   if (ts->vecs_drdp){
1984d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1985d8151eeaSBarry Smith   }
1986d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
1987d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
1988ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
19892c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
199036eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
1991277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
1992d763cef2SBarry Smith   PetscFunctionReturn(0);
1993d763cef2SBarry Smith }
1994d763cef2SBarry Smith 
19954a2ae208SSatish Balay #undef __FUNCT__
19964a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
1997d8e5e3e6SSatish Balay /*@
1998d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
1999d763cef2SBarry Smith    with TSCreate().
2000d763cef2SBarry Smith 
2001d763cef2SBarry Smith    Collective on TS
2002d763cef2SBarry Smith 
2003d763cef2SBarry Smith    Input Parameter:
2004d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2005d763cef2SBarry Smith 
2006d763cef2SBarry Smith    Level: beginner
2007d763cef2SBarry Smith 
2008d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2009d763cef2SBarry Smith 
2010d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2011d763cef2SBarry Smith @*/
20126bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2013d763cef2SBarry Smith {
20146849ba73SBarry Smith   PetscErrorCode ierr;
2015d763cef2SBarry Smith 
2016d763cef2SBarry Smith   PetscFunctionBegin;
20176bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
20186bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
20196bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2020d763cef2SBarry Smith 
20216bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2022277b19d0SLisandro Dalcin 
2023e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2024e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20256bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20266d4c513bSLisandro Dalcin 
2027bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2028bc952696SBarry Smith 
202984df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2030aeb4809dSShri Abhyankar   if ((*ts)->event) {
2031aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2032aeb4809dSShri Abhyankar   }
20336bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20346bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20356bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20366d4c513bSLisandro Dalcin 
2037a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2038d763cef2SBarry Smith   PetscFunctionReturn(0);
2039d763cef2SBarry Smith }
2040d763cef2SBarry Smith 
20414a2ae208SSatish Balay #undef __FUNCT__
20424a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2043d8e5e3e6SSatish Balay /*@
2044d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2045d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2046d763cef2SBarry Smith 
2047d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2048d763cef2SBarry Smith 
2049d763cef2SBarry Smith    Input Parameter:
2050d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2051d763cef2SBarry Smith 
2052d763cef2SBarry Smith    Output Parameter:
2053d763cef2SBarry Smith .  snes - the nonlinear solver context
2054d763cef2SBarry Smith 
2055d763cef2SBarry Smith    Notes:
2056d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2057d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
205894b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2059d763cef2SBarry Smith 
2060d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20610298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2062d763cef2SBarry Smith 
2063d763cef2SBarry Smith    Level: beginner
2064d763cef2SBarry Smith 
2065d763cef2SBarry Smith .keywords: timestep, get, SNES
2066d763cef2SBarry Smith @*/
20677087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2068d763cef2SBarry Smith {
2069d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2070d372ba47SLisandro Dalcin 
2071d763cef2SBarry Smith   PetscFunctionBegin;
20720700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20734482741eSBarry Smith   PetscValidPointer(snes,2);
2074d372ba47SLisandro Dalcin   if (!ts->snes) {
2075ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20760298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20773bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2078d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2079496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20809e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20819e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20829e2a6581SJed Brown     }
2083d372ba47SLisandro Dalcin   }
2084d763cef2SBarry Smith   *snes = ts->snes;
2085d763cef2SBarry Smith   PetscFunctionReturn(0);
2086d763cef2SBarry Smith }
2087d763cef2SBarry Smith 
20884a2ae208SSatish Balay #undef __FUNCT__
2089deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2090deb2cd25SJed Brown /*@
2091deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2092deb2cd25SJed Brown 
2093deb2cd25SJed Brown    Collective
2094deb2cd25SJed Brown 
2095deb2cd25SJed Brown    Input Parameter:
2096deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2097deb2cd25SJed Brown -  snes - the nonlinear solver context
2098deb2cd25SJed Brown 
2099deb2cd25SJed Brown    Notes:
2100deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2101deb2cd25SJed Brown 
2102deb2cd25SJed Brown    Level: developer
2103deb2cd25SJed Brown 
2104deb2cd25SJed Brown .keywords: timestep, set, SNES
2105deb2cd25SJed Brown @*/
2106deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2107deb2cd25SJed Brown {
2108deb2cd25SJed Brown   PetscErrorCode ierr;
2109d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2110deb2cd25SJed Brown 
2111deb2cd25SJed Brown   PetscFunctionBegin;
2112deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2113deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2114deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2115deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2116bbd56ea5SKarl Rupp 
2117deb2cd25SJed Brown   ts->snes = snes;
2118bbd56ea5SKarl Rupp 
21190298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21200298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2121740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
21220298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2123740132f1SEmil Constantinescu   }
2124deb2cd25SJed Brown   PetscFunctionReturn(0);
2125deb2cd25SJed Brown }
2126deb2cd25SJed Brown 
2127deb2cd25SJed Brown #undef __FUNCT__
212894b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2129d8e5e3e6SSatish Balay /*@
213094b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2131d763cef2SBarry Smith    a TS (timestepper) context.
2132d763cef2SBarry Smith 
213394b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2134d763cef2SBarry Smith 
2135d763cef2SBarry Smith    Input Parameter:
2136d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2137d763cef2SBarry Smith 
2138d763cef2SBarry Smith    Output Parameter:
213994b7f48cSBarry Smith .  ksp - the nonlinear solver context
2140d763cef2SBarry Smith 
2141d763cef2SBarry Smith    Notes:
214294b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2143d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2144d763cef2SBarry Smith    KSP and PC contexts as well.
2145d763cef2SBarry Smith 
214694b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21470298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2148d763cef2SBarry Smith 
2149d763cef2SBarry Smith    Level: beginner
2150d763cef2SBarry Smith 
215194b7f48cSBarry Smith .keywords: timestep, get, KSP
2152d763cef2SBarry Smith @*/
21537087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2154d763cef2SBarry Smith {
2155d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2156089b2837SJed Brown   SNES           snes;
2157d372ba47SLisandro Dalcin 
2158d763cef2SBarry Smith   PetscFunctionBegin;
21590700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21604482741eSBarry Smith   PetscValidPointer(ksp,2);
216117186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2162e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2163089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2164089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2165d763cef2SBarry Smith   PetscFunctionReturn(0);
2166d763cef2SBarry Smith }
2167d763cef2SBarry Smith 
2168d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2169d763cef2SBarry Smith 
21704a2ae208SSatish Balay #undef __FUNCT__
2171adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2172adb62b0dSMatthew Knepley /*@
2173adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2174adb62b0dSMatthew Knepley    maximum time for iteration.
2175adb62b0dSMatthew Knepley 
21763f9fe445SBarry Smith    Not Collective
2177adb62b0dSMatthew Knepley 
2178adb62b0dSMatthew Knepley    Input Parameters:
2179adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21800298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21810298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2182adb62b0dSMatthew Knepley 
2183adb62b0dSMatthew Knepley    Level: intermediate
2184adb62b0dSMatthew Knepley 
2185adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2186adb62b0dSMatthew Knepley @*/
21877087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2188adb62b0dSMatthew Knepley {
2189adb62b0dSMatthew Knepley   PetscFunctionBegin;
21900700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2191abc0a331SBarry Smith   if (maxsteps) {
21924482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2193adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2194adb62b0dSMatthew Knepley   }
2195abc0a331SBarry Smith   if (maxtime) {
21964482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2197adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2198adb62b0dSMatthew Knepley   }
2199adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2200adb62b0dSMatthew Knepley }
2201adb62b0dSMatthew Knepley 
2202adb62b0dSMatthew Knepley #undef __FUNCT__
22034a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2204d763cef2SBarry Smith /*@
2205d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2206d763cef2SBarry Smith    maximum time for iteration.
2207d763cef2SBarry Smith 
22083f9fe445SBarry Smith    Logically Collective on TS
2209d763cef2SBarry Smith 
2210d763cef2SBarry Smith    Input Parameters:
2211d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2212d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2213d763cef2SBarry Smith -  maxtime - final time to iterate to
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith    Options Database Keys:
2216d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
22173bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2218d763cef2SBarry Smith 
2219d763cef2SBarry Smith    Notes:
2220d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2221d763cef2SBarry Smith 
2222d763cef2SBarry Smith    Level: intermediate
2223d763cef2SBarry Smith 
2224d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2225a43b19c4SJed Brown 
2226a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2227d763cef2SBarry Smith @*/
22287087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2229d763cef2SBarry Smith {
2230d763cef2SBarry Smith   PetscFunctionBegin;
22310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2232c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2233c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
223439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
223539b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2236d763cef2SBarry Smith   PetscFunctionReturn(0);
2237d763cef2SBarry Smith }
2238d763cef2SBarry Smith 
22394a2ae208SSatish Balay #undef __FUNCT__
22404a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2241d763cef2SBarry Smith /*@
2242d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2243d763cef2SBarry Smith    for use by the TS routines.
2244d763cef2SBarry Smith 
22453f9fe445SBarry Smith    Logically Collective on TS and Vec
2246d763cef2SBarry Smith 
2247d763cef2SBarry Smith    Input Parameters:
2248d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22490910c330SBarry Smith -  u - the solution vector
2250d763cef2SBarry Smith 
2251d763cef2SBarry Smith    Level: beginner
2252d763cef2SBarry Smith 
2253d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2254d763cef2SBarry Smith @*/
22550910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2256d763cef2SBarry Smith {
22578737fe31SLisandro Dalcin   PetscErrorCode ierr;
2258496e6a7aSJed Brown   DM             dm;
22598737fe31SLisandro Dalcin 
2260d763cef2SBarry Smith   PetscFunctionBegin;
22610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22620910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22630910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22646bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2265bbd56ea5SKarl Rupp 
22660910c330SBarry Smith   ts->vec_sol = u;
2267bbd56ea5SKarl Rupp 
2268496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22690910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2270d763cef2SBarry Smith   PetscFunctionReturn(0);
2271d763cef2SBarry Smith }
2272d763cef2SBarry Smith 
2273e74ef692SMatthew Knepley #undef __FUNCT__
227473b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
227573b18844SBarry Smith /*@
227673b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
227773b18844SBarry Smith 
227873b18844SBarry Smith    Logically Collective on TS
227973b18844SBarry Smith 
228073b18844SBarry Smith    Input Parameters:
228173b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
228273b18844SBarry Smith .  steps - number of steps to use
228373b18844SBarry Smith 
228473b18844SBarry Smith    Level: intermediate
228573b18844SBarry Smith 
228673b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
228773b18844SBarry Smith           so as to integrate back to less than the original timestep
228873b18844SBarry Smith 
228973b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
229073b18844SBarry Smith 
229173b18844SBarry Smith .seealso: TSSetExactFinalTime()
229273b18844SBarry Smith @*/
229373b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
229473b18844SBarry Smith {
229573b18844SBarry Smith   PetscFunctionBegin;
229673b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
229773b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
229873b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
229973b18844SBarry 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");
230073b18844SBarry Smith   ts->adjoint_max_steps = steps;
230173b18844SBarry Smith   PetscFunctionReturn(0);
230273b18844SBarry Smith }
230373b18844SBarry Smith 
230473b18844SBarry Smith #undef __FUNCT__
23050cf82b59SBarry Smith #define __FUNCT__ "TSAdjointSetCostGradients"
2306c235aa8dSHong Zhang /*@
23070cf82b59SBarry 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
23080cf82b59SBarry Smith       for use by the TSAdjoint routines.
2309c235aa8dSHong Zhang 
2310c235aa8dSHong Zhang    Logically Collective on TS and Vec
2311c235aa8dSHong Zhang 
2312c235aa8dSHong Zhang    Input Parameters:
2313c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2314abc2977eSBarry 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
2315abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2316c235aa8dSHong Zhang 
2317c235aa8dSHong Zhang    Level: beginner
2318c235aa8dSHong Zhang 
2319abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
23200cf82b59SBarry Smith 
2321c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2322c235aa8dSHong Zhang @*/
2323abc2977eSBarry Smith PetscErrorCode  TSAdjointSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2324c235aa8dSHong Zhang {
2325c235aa8dSHong Zhang   PetscFunctionBegin;
2326c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2327abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2328abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2329abc2977eSBarry Smith   ts->vecs_sensip = mu;
2330abc2977eSBarry Smith   ts->numcost  = numcost;
2331ad8e2604SHong Zhang   PetscFunctionReturn(0);
2332ad8e2604SHong Zhang }
2333ad8e2604SHong Zhang 
2334ad8e2604SHong Zhang #undef __FUNCT__
23355bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2336ad8e2604SHong Zhang /*@C
23370cf82b59SBarry 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.
2338ad8e2604SHong Zhang 
2339ad8e2604SHong Zhang   Logically Collective on TS
2340ad8e2604SHong Zhang 
2341ad8e2604SHong Zhang   Input Parameters:
2342ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2343ad8e2604SHong Zhang - func - The function
2344ad8e2604SHong Zhang 
2345ad8e2604SHong Zhang   Calling sequence of func:
23460cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
234705755b9cSHong Zhang +   t - current timestep
23480cf82b59SBarry Smith .   y - input vector (current ODE solution)
234905755b9cSHong Zhang .   A - output matrix
235005755b9cSHong Zhang -   ctx - [optional] user-defined function context
2351ad8e2604SHong Zhang 
2352ad8e2604SHong Zhang   Level: intermediate
2353ad8e2604SHong Zhang 
23540cf82b59SBarry 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
23550cf82b59SBarry Smith 
2356ad8e2604SHong Zhang .keywords: TS, sensitivity
2357ad8e2604SHong Zhang .seealso:
2358ad8e2604SHong Zhang @*/
23595bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2360ad8e2604SHong Zhang {
2361ad8e2604SHong Zhang   PetscErrorCode ierr;
2362ad8e2604SHong Zhang 
2363ad8e2604SHong Zhang   PetscFunctionBegin;
2364ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2365ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2366ad8e2604SHong Zhang 
2367ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2368ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2369ad8e2604SHong Zhang   if(Amat) {
2370ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2371ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2372ad8e2604SHong Zhang     ts->Jacp = Amat;
2373ad8e2604SHong Zhang   }
2374ad8e2604SHong Zhang   PetscFunctionReturn(0);
2375ad8e2604SHong Zhang }
2376ad8e2604SHong Zhang 
2377ad8e2604SHong Zhang #undef __FUNCT__
23785bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
23790cf82b59SBarry Smith /*@C
23805bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2381ad8e2604SHong Zhang 
2382ad8e2604SHong Zhang   Collective on TS
2383ad8e2604SHong Zhang 
2384ad8e2604SHong Zhang   Input Parameters:
2385ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2386ad8e2604SHong Zhang 
2387ad8e2604SHong Zhang   Level: developer
2388ad8e2604SHong Zhang 
2389ad8e2604SHong Zhang .keywords: TS, sensitivity
23905bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2391ad8e2604SHong Zhang @*/
23925bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2393ad8e2604SHong Zhang {
2394ad8e2604SHong Zhang   PetscErrorCode ierr;
2395ad8e2604SHong Zhang 
2396ad8e2604SHong Zhang   PetscFunctionBegin;
2397ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2398ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2399ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2400ad8e2604SHong Zhang 
2401ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2402ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2403ad8e2604SHong Zhang   PetscStackPop;
2404c235aa8dSHong Zhang   PetscFunctionReturn(0);
2405c235aa8dSHong Zhang }
2406c235aa8dSHong Zhang 
2407c235aa8dSHong Zhang #undef __FUNCT__
2408d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointSetCostIntegrand"
24096fd0887fSHong Zhang /*@C
24100cf82b59SBarry Smith     TSAdjointSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
24116fd0887fSHong Zhang 
24126fd0887fSHong Zhang     Logically Collective on TS
24136fd0887fSHong Zhang 
24146fd0887fSHong Zhang     Input Parameters:
24156fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2416abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
24170cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2418b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2419b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2420b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
24216fd0887fSHong Zhang 
24220cf82b59SBarry Smith     Calling sequence of rf:
24230cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
24246fd0887fSHong Zhang 
24256fd0887fSHong Zhang +   t - current timestep
24260cf82b59SBarry Smith .   y - input vector
24270cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
24286fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24296fd0887fSHong Zhang 
2430b612ec54SBarry Smith    Calling sequence of drdyf:
24310cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2432b612ec54SBarry Smith 
2433b612ec54SBarry Smith    Calling sequence of drdpf:
24340cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2435b612ec54SBarry Smith 
2436b612ec54SBarry Smith     Level: intermediate
24376fd0887fSHong Zhang 
2438abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
24390cf82b59SBarry Smith 
24406fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24416fd0887fSHong Zhang 
24420cf82b59SBarry Smith .seealso: TSAdjointSetRHSJacobian(),TSAdjointGetCostGradients(), TSAdjointSetCostGradients()
24436fd0887fSHong Zhang @*/
2444abc2977eSBarry Smith PetscErrorCode  TSAdjointSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2445d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2446d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
24476fd0887fSHong Zhang {
24486fd0887fSHong Zhang   PetscErrorCode ierr;
24496fd0887fSHong Zhang 
24506fd0887fSHong Zhang   PetscFunctionBegin;
24516fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2452abc2977eSBarry Smith   if (!ts->numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Call TSAdjointSetCostGradients() first so that the number of cost functions can be determined.");
2453abc2977eSBarry 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()");
24546fd0887fSHong Zhang 
2455abc2977eSBarry Smith   ierr                  = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
24562c39e106SBarry Smith   ierr                  = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
24570cf82b59SBarry Smith   ts->costintegrand     = rf;
245805755b9cSHong Zhang   ts->costintegrandctx  = ctx;
2459b612ec54SBarry Smith   ts->drdyfunction    = drdyf;
2460b612ec54SBarry Smith   ts->drdpfunction    = drdpf;
24616fd0887fSHong Zhang   PetscFunctionReturn(0);
24626fd0887fSHong Zhang }
24636fd0887fSHong Zhang 
24646fd0887fSHong Zhang #undef __FUNCT__
24652c39e106SBarry Smith #define __FUNCT__ "TSAdjointGetCostIntegral"
246636eaed60SHong Zhang /*@
24672c39e106SBarry Smith    TSAdjointGetCostIntegral - Returns the values of the integral term in the cost functions.
246836eaed60SHong Zhang    It is valid to call the routine after a backward run.
246936eaed60SHong Zhang 
247036eaed60SHong Zhang    Not Collective
247136eaed60SHong Zhang 
247236eaed60SHong Zhang    Input Parameter:
247336eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
247436eaed60SHong Zhang 
247536eaed60SHong Zhang    Output Parameter:
24762c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
247736eaed60SHong Zhang 
247836eaed60SHong Zhang    Level: intermediate
247936eaed60SHong Zhang 
2480d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand()
248136eaed60SHong Zhang 
248236eaed60SHong Zhang .keywords: TS, sensitivity analysis
248336eaed60SHong Zhang @*/
24842c39e106SBarry Smith PetscErrorCode  TSAdjointGetCostIntegral(TS ts,Vec *v)
248536eaed60SHong Zhang {
248636eaed60SHong Zhang   PetscFunctionBegin;
248736eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
248836eaed60SHong Zhang   PetscValidPointer(v,2);
24892c39e106SBarry Smith   *v = ts->vec_costintegral;
249036eaed60SHong Zhang   PetscFunctionReturn(0);
249136eaed60SHong Zhang }
249236eaed60SHong Zhang 
249336eaed60SHong Zhang #undef __FUNCT__
2494d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
24956fd0887fSHong Zhang /*@
24962c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
24976fd0887fSHong Zhang 
24986fd0887fSHong Zhang    Input Parameters:
24996fd0887fSHong Zhang +  ts - the TS context
25006fd0887fSHong Zhang .  t - current time
25010cf82b59SBarry Smith -  y - state vector, i.e. current solution
25026fd0887fSHong Zhang 
25036fd0887fSHong Zhang    Output Parameter:
2504abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
25056fd0887fSHong Zhang 
25066fd0887fSHong Zhang    Note:
25076fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
25086fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
25096fd0887fSHong Zhang 
25106fd0887fSHong Zhang    Level: developer
25116fd0887fSHong Zhang 
25126fd0887fSHong Zhang .keywords: TS, compute
25136fd0887fSHong Zhang 
2514d4aa0a58SBarry Smith .seealso: TSAdjointSetCostIntegrand()
25156fd0887fSHong Zhang @*/
25160cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
25176fd0887fSHong Zhang {
25186fd0887fSHong Zhang   PetscErrorCode ierr;
25196fd0887fSHong Zhang 
25206fd0887fSHong Zhang   PetscFunctionBegin;
25216fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25220cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
25236fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
25246fd0887fSHong Zhang 
25250cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2526e4680132SHong Zhang   if (ts->costintegrand) {
2527e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
25280cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
25296fd0887fSHong Zhang     PetscStackPop;
25306fd0887fSHong Zhang   } else {
25316fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25326fd0887fSHong Zhang   }
25336fd0887fSHong Zhang 
25340cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
25356fd0887fSHong Zhang   PetscFunctionReturn(0);
25366fd0887fSHong Zhang }
25376fd0887fSHong Zhang 
25386fd0887fSHong Zhang #undef __FUNCT__
2539d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
254005755b9cSHong Zhang /*@
2541d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
254205755b9cSHong Zhang 
254305755b9cSHong Zhang   Collective on TS
254405755b9cSHong Zhang 
254505755b9cSHong Zhang   Input Parameters:
254605755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
254705755b9cSHong Zhang 
254805755b9cSHong Zhang   Notes:
2549d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
255005755b9cSHong Zhang   so most users would not generally call this routine themselves.
255105755b9cSHong Zhang 
255205755b9cSHong Zhang   Level: developer
255305755b9cSHong Zhang 
255405755b9cSHong Zhang .keywords: TS, sensitivity
2555d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
255605755b9cSHong Zhang @*/
25570cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
255805755b9cSHong Zhang {
255905755b9cSHong Zhang   PetscErrorCode ierr;
256005755b9cSHong Zhang 
256105755b9cSHong Zhang   PetscFunctionBegin;
256205755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25630cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
256405755b9cSHong Zhang 
256505755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
25660cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
256705755b9cSHong Zhang   PetscStackPop;
256805755b9cSHong Zhang   PetscFunctionReturn(0);
256905755b9cSHong Zhang }
257005755b9cSHong Zhang 
257105755b9cSHong Zhang #undef __FUNCT__
2572d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
257305755b9cSHong Zhang /*@
2574d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
257505755b9cSHong Zhang 
257605755b9cSHong Zhang   Collective on TS
257705755b9cSHong Zhang 
257805755b9cSHong Zhang   Input Parameters:
257905755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
258005755b9cSHong Zhang 
258105755b9cSHong Zhang   Notes:
258205755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
258305755b9cSHong Zhang   so most users would not generally call this routine themselves.
258405755b9cSHong Zhang 
258505755b9cSHong Zhang   Level: developer
258605755b9cSHong Zhang 
258705755b9cSHong Zhang .keywords: TS, sensitivity
2588d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
258905755b9cSHong Zhang @*/
25900cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
259105755b9cSHong Zhang {
259205755b9cSHong Zhang   PetscErrorCode ierr;
259305755b9cSHong Zhang 
259405755b9cSHong Zhang   PetscFunctionBegin;
259505755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25960cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
259705755b9cSHong Zhang 
259805755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
25990cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
260005755b9cSHong Zhang   PetscStackPop;
260105755b9cSHong Zhang   PetscFunctionReturn(0);
260205755b9cSHong Zhang }
260305755b9cSHong Zhang 
260405755b9cSHong Zhang #undef __FUNCT__
2605e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2606ac226902SBarry Smith /*@C
2607000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26083f2090d5SJed Brown   called once at the beginning of each time step.
2609000e7ae3SMatthew Knepley 
26103f9fe445SBarry Smith   Logically Collective on TS
2611000e7ae3SMatthew Knepley 
2612000e7ae3SMatthew Knepley   Input Parameters:
2613000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2614000e7ae3SMatthew Knepley - func - The function
2615000e7ae3SMatthew Knepley 
2616000e7ae3SMatthew Knepley   Calling sequence of func:
2617000e7ae3SMatthew Knepley . func (TS ts);
2618000e7ae3SMatthew Knepley 
2619000e7ae3SMatthew Knepley   Level: intermediate
2620000e7ae3SMatthew Knepley 
2621b8123daeSJed Brown   Note:
2622b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2623b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2624b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2625b8123daeSJed Brown 
2626000e7ae3SMatthew Knepley .keywords: TS, timestep
26279be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2628000e7ae3SMatthew Knepley @*/
26297087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2630000e7ae3SMatthew Knepley {
2631000e7ae3SMatthew Knepley   PetscFunctionBegin;
26320700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2633ae60f76fSBarry Smith   ts->prestep = func;
2634000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2635000e7ae3SMatthew Knepley }
2636000e7ae3SMatthew Knepley 
2637e74ef692SMatthew Knepley #undef __FUNCT__
26383f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
263909ee8438SJed Brown /*@
26403f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26413f2090d5SJed Brown 
26423f2090d5SJed Brown   Collective on TS
26433f2090d5SJed Brown 
26443f2090d5SJed Brown   Input Parameters:
26453f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26463f2090d5SJed Brown 
26473f2090d5SJed Brown   Notes:
26483f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
26493f2090d5SJed Brown   so most users would not generally call this routine themselves.
26503f2090d5SJed Brown 
26513f2090d5SJed Brown   Level: developer
26523f2090d5SJed Brown 
26533f2090d5SJed Brown .keywords: TS, timestep
26549be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
26553f2090d5SJed Brown @*/
26567087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
26573f2090d5SJed Brown {
26583f2090d5SJed Brown   PetscErrorCode ierr;
26593f2090d5SJed Brown 
26603f2090d5SJed Brown   PetscFunctionBegin;
26610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2662ae60f76fSBarry Smith   if (ts->prestep) {
2663ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2664312ce896SJed Brown   }
26653f2090d5SJed Brown   PetscFunctionReturn(0);
26663f2090d5SJed Brown }
26673f2090d5SJed Brown 
26683f2090d5SJed Brown #undef __FUNCT__
2669b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2670b8123daeSJed Brown /*@C
2671b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2672b8123daeSJed Brown   called once at the beginning of each stage.
2673b8123daeSJed Brown 
2674b8123daeSJed Brown   Logically Collective on TS
2675b8123daeSJed Brown 
2676b8123daeSJed Brown   Input Parameters:
2677b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2678b8123daeSJed Brown - func - The function
2679b8123daeSJed Brown 
2680b8123daeSJed Brown   Calling sequence of func:
2681b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2682b8123daeSJed Brown 
2683b8123daeSJed Brown   Level: intermediate
2684b8123daeSJed Brown 
2685b8123daeSJed Brown   Note:
2686b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2687b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2688b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2689b8123daeSJed Brown 
2690b8123daeSJed Brown .keywords: TS, timestep
26919be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2692b8123daeSJed Brown @*/
2693b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2694b8123daeSJed Brown {
2695b8123daeSJed Brown   PetscFunctionBegin;
2696b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2697ae60f76fSBarry Smith   ts->prestage = func;
2698b8123daeSJed Brown   PetscFunctionReturn(0);
2699b8123daeSJed Brown }
2700b8123daeSJed Brown 
2701b8123daeSJed Brown #undef __FUNCT__
27029be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27039be3e283SDebojyoti Ghosh /*@C
27049be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27059be3e283SDebojyoti Ghosh   called once at the end of each stage.
27069be3e283SDebojyoti Ghosh 
27079be3e283SDebojyoti Ghosh   Logically Collective on TS
27089be3e283SDebojyoti Ghosh 
27099be3e283SDebojyoti Ghosh   Input Parameters:
27109be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27119be3e283SDebojyoti Ghosh - func - The function
27129be3e283SDebojyoti Ghosh 
27139be3e283SDebojyoti Ghosh   Calling sequence of func:
27149be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27159be3e283SDebojyoti Ghosh 
27169be3e283SDebojyoti Ghosh   Level: intermediate
27179be3e283SDebojyoti Ghosh 
27189be3e283SDebojyoti Ghosh   Note:
27199be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27209be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27219be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27229be3e283SDebojyoti Ghosh 
27239be3e283SDebojyoti Ghosh .keywords: TS, timestep
27249be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27259be3e283SDebojyoti Ghosh @*/
27269be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27279be3e283SDebojyoti Ghosh {
27289be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27299be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27309be3e283SDebojyoti Ghosh   ts->poststage = func;
27319be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27329be3e283SDebojyoti Ghosh }
27339be3e283SDebojyoti Ghosh 
27349be3e283SDebojyoti Ghosh #undef __FUNCT__
2735b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2736b8123daeSJed Brown /*@
2737b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2738b8123daeSJed Brown 
2739b8123daeSJed Brown   Collective on TS
2740b8123daeSJed Brown 
2741b8123daeSJed Brown   Input Parameters:
2742b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27439be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2744b8123daeSJed Brown 
2745b8123daeSJed Brown   Notes:
2746b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2747b8123daeSJed Brown   most users would not generally call this routine themselves.
2748b8123daeSJed Brown 
2749b8123daeSJed Brown   Level: developer
2750b8123daeSJed Brown 
2751b8123daeSJed Brown .keywords: TS, timestep
27529be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2753b8123daeSJed Brown @*/
2754b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2755b8123daeSJed Brown {
2756b8123daeSJed Brown   PetscErrorCode ierr;
2757b8123daeSJed Brown 
2758b8123daeSJed Brown   PetscFunctionBegin;
2759b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2760ae60f76fSBarry Smith   if (ts->prestage) {
2761ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2762b8123daeSJed Brown   }
2763b8123daeSJed Brown   PetscFunctionReturn(0);
2764b8123daeSJed Brown }
2765b8123daeSJed Brown 
2766b8123daeSJed Brown #undef __FUNCT__
27679be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
27689be3e283SDebojyoti Ghosh /*@
27699be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
27709be3e283SDebojyoti Ghosh 
27719be3e283SDebojyoti Ghosh   Collective on TS
27729be3e283SDebojyoti Ghosh 
27739be3e283SDebojyoti Ghosh   Input Parameters:
27749be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
27759be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
27769be3e283SDebojyoti Ghosh   stageindex  - Stage number
27779be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
27789be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
27799be3e283SDebojyoti Ghosh 
27809be3e283SDebojyoti Ghosh   Notes:
27819be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
27829be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
27839be3e283SDebojyoti Ghosh 
27849be3e283SDebojyoti Ghosh   Level: developer
27859be3e283SDebojyoti Ghosh 
27869be3e283SDebojyoti Ghosh .keywords: TS, timestep
27879be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
27889be3e283SDebojyoti Ghosh @*/
27899be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
27909be3e283SDebojyoti Ghosh {
27919be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
27929be3e283SDebojyoti Ghosh 
27939be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27949be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
27954beae5d8SLisandro Dalcin   if (ts->poststage) {
27969be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
27979be3e283SDebojyoti Ghosh   }
27989be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27999be3e283SDebojyoti Ghosh }
28009be3e283SDebojyoti Ghosh 
28019be3e283SDebojyoti Ghosh #undef __FUNCT__
2802e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2803ac226902SBarry Smith /*@C
2804000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28053f2090d5SJed Brown   called once at the end of each time step.
2806000e7ae3SMatthew Knepley 
28073f9fe445SBarry Smith   Logically Collective on TS
2808000e7ae3SMatthew Knepley 
2809000e7ae3SMatthew Knepley   Input Parameters:
2810000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2811000e7ae3SMatthew Knepley - func - The function
2812000e7ae3SMatthew Knepley 
2813000e7ae3SMatthew Knepley   Calling sequence of func:
2814b8123daeSJed Brown $ func (TS ts);
2815000e7ae3SMatthew Knepley 
2816000e7ae3SMatthew Knepley   Level: intermediate
2817000e7ae3SMatthew Knepley 
2818000e7ae3SMatthew Knepley .keywords: TS, timestep
2819b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2820000e7ae3SMatthew Knepley @*/
28217087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2822000e7ae3SMatthew Knepley {
2823000e7ae3SMatthew Knepley   PetscFunctionBegin;
28240700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2825ae60f76fSBarry Smith   ts->poststep = func;
2826000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2827000e7ae3SMatthew Knepley }
2828000e7ae3SMatthew Knepley 
2829e74ef692SMatthew Knepley #undef __FUNCT__
28303f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
283109ee8438SJed Brown /*@
28323f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28333f2090d5SJed Brown 
28343f2090d5SJed Brown   Collective on TS
28353f2090d5SJed Brown 
28363f2090d5SJed Brown   Input Parameters:
28373f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28383f2090d5SJed Brown 
28393f2090d5SJed Brown   Notes:
28403f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28413f2090d5SJed Brown   so most users would not generally call this routine themselves.
28423f2090d5SJed Brown 
28433f2090d5SJed Brown   Level: developer
28443f2090d5SJed Brown 
28453f2090d5SJed Brown .keywords: TS, timestep
28463f2090d5SJed Brown @*/
28477087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28483f2090d5SJed Brown {
28493f2090d5SJed Brown   PetscErrorCode ierr;
28503f2090d5SJed Brown 
28513f2090d5SJed Brown   PetscFunctionBegin;
28520700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2853ae60f76fSBarry Smith   if (ts->poststep) {
2854ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
285572ac3e02SJed Brown   }
28563f2090d5SJed Brown   PetscFunctionReturn(0);
28573f2090d5SJed Brown }
28583f2090d5SJed Brown 
2859d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2860d763cef2SBarry Smith 
28614a2ae208SSatish Balay #undef __FUNCT__
2862a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2863d763cef2SBarry Smith /*@C
2864a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2865d763cef2SBarry Smith    timestep to display the iteration's  progress.
2866d763cef2SBarry Smith 
28673f9fe445SBarry Smith    Logically Collective on TS
2868d763cef2SBarry Smith 
2869d763cef2SBarry Smith    Input Parameters:
2870d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2871e213d8f1SJed Brown .  monitor - monitoring routine
2872329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
28730298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2874b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
28750298fd71SBarry Smith           (may be NULL)
2876d763cef2SBarry Smith 
2877e213d8f1SJed Brown    Calling sequence of monitor:
28780910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2879d763cef2SBarry Smith 
2880d763cef2SBarry Smith +    ts - the TS context
288188c05cc5SBarry 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
288288c05cc5SBarry Smith                                been interpolated to)
28831f06c33eSBarry Smith .    time - current time
28840910c330SBarry Smith .    u - current iterate
2885d763cef2SBarry Smith -    mctx - [optional] monitoring context
2886d763cef2SBarry Smith 
2887d763cef2SBarry Smith    Notes:
2888d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2889d763cef2SBarry Smith    already has been loaded.
2890d763cef2SBarry Smith 
2891025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2892025f1a04SBarry Smith 
2893d763cef2SBarry Smith    Level: intermediate
2894d763cef2SBarry Smith 
2895d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2896d763cef2SBarry Smith 
2897a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2898d763cef2SBarry Smith @*/
2899c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2900d763cef2SBarry Smith {
2901d763cef2SBarry Smith   PetscFunctionBegin;
29020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
290317186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2904d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29058704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2906d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2907d763cef2SBarry Smith   PetscFunctionReturn(0);
2908d763cef2SBarry Smith }
2909d763cef2SBarry Smith 
29104a2ae208SSatish Balay #undef __FUNCT__
2911a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2912d763cef2SBarry Smith /*@C
2913a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2914d763cef2SBarry Smith 
29153f9fe445SBarry Smith    Logically Collective on TS
2916d763cef2SBarry Smith 
2917d763cef2SBarry Smith    Input Parameters:
2918d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2919d763cef2SBarry Smith 
2920d763cef2SBarry Smith    Notes:
2921d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2922d763cef2SBarry Smith 
2923d763cef2SBarry Smith    Level: intermediate
2924d763cef2SBarry Smith 
2925d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2926d763cef2SBarry Smith 
2927a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2928d763cef2SBarry Smith @*/
29297087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2930d763cef2SBarry Smith {
2931d952e501SBarry Smith   PetscErrorCode ierr;
2932d952e501SBarry Smith   PetscInt       i;
2933d952e501SBarry Smith 
2934d763cef2SBarry Smith   PetscFunctionBegin;
29350700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2936d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29378704b422SBarry Smith     if (ts->monitordestroy[i]) {
29388704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2939d952e501SBarry Smith     }
2940d952e501SBarry Smith   }
2941d763cef2SBarry Smith   ts->numbermonitors = 0;
2942d763cef2SBarry Smith   PetscFunctionReturn(0);
2943d763cef2SBarry Smith }
2944d763cef2SBarry Smith 
29454a2ae208SSatish Balay #undef __FUNCT__
2946a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2947d8e5e3e6SSatish Balay /*@
2948a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
29495516499fSSatish Balay 
29505516499fSSatish Balay    Level: intermediate
295141251cbbSSatish Balay 
29525516499fSSatish Balay .keywords: TS, set, monitor
29535516499fSSatish Balay 
295441251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
295541251cbbSSatish Balay @*/
2956649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2957d763cef2SBarry Smith {
2958dfbe8321SBarry Smith   PetscErrorCode ierr;
2959ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2960d132466eSBarry Smith 
2961d763cef2SBarry Smith   PetscFunctionBegin;
2962649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
29638392e04aSShri 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);
2964649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2965d763cef2SBarry Smith   PetscFunctionReturn(0);
2966d763cef2SBarry Smith }
2967d763cef2SBarry Smith 
29684a2ae208SSatish Balay #undef __FUNCT__
2969cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2970cd652676SJed Brown /*@
2971cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2972cd652676SJed Brown 
2973cd652676SJed Brown    Logically Collective on TS
2974cd652676SJed Brown 
2975cd652676SJed Brown    Input Argument:
2976cd652676SJed Brown .  ts - time stepping context
2977cd652676SJed Brown 
2978cd652676SJed Brown    Output Argument:
2979cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2980cd652676SJed Brown 
2981cd652676SJed Brown    Level: intermediate
2982cd652676SJed Brown 
2983cd652676SJed Brown .keywords: TS, set
2984cd652676SJed Brown 
2985cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
2986cd652676SJed Brown @*/
2987cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
2988cd652676SJed Brown {
2989cd652676SJed Brown   PetscFunctionBegin;
2990cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2991cd652676SJed Brown   ts->retain_stages = flg;
2992cd652676SJed Brown   PetscFunctionReturn(0);
2993cd652676SJed Brown }
2994cd652676SJed Brown 
2995cd652676SJed Brown #undef __FUNCT__
2996cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
2997cd652676SJed Brown /*@
2998cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
2999cd652676SJed Brown 
3000cd652676SJed Brown    Collective on TS
3001cd652676SJed Brown 
3002cd652676SJed Brown    Input Argument:
3003cd652676SJed Brown +  ts - time stepping context
3004cd652676SJed Brown -  t - time to interpolate to
3005cd652676SJed Brown 
3006cd652676SJed Brown    Output Argument:
30070910c330SBarry Smith .  U - state at given time
3008cd652676SJed Brown 
3009cd652676SJed Brown    Notes:
3010cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3011cd652676SJed Brown 
3012cd652676SJed Brown    Level: intermediate
3013cd652676SJed Brown 
3014cd652676SJed Brown    Developer Notes:
3015cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3016cd652676SJed Brown 
3017cd652676SJed Brown .keywords: TS, set
3018cd652676SJed Brown 
3019cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3020cd652676SJed Brown @*/
30210910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3022cd652676SJed Brown {
3023cd652676SJed Brown   PetscErrorCode ierr;
3024cd652676SJed Brown 
3025cd652676SJed Brown   PetscFunctionBegin;
3026cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3027b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
30286712e2f1SBarry 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);
3029ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
30300910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3031cd652676SJed Brown   PetscFunctionReturn(0);
3032cd652676SJed Brown }
3033cd652676SJed Brown 
3034cd652676SJed Brown #undef __FUNCT__
30354a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3036d763cef2SBarry Smith /*@
30376d9e5789SSean Farley    TSStep - Steps one time step
3038d763cef2SBarry Smith 
3039d763cef2SBarry Smith    Collective on TS
3040d763cef2SBarry Smith 
3041d763cef2SBarry Smith    Input Parameter:
3042d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3043d763cef2SBarry Smith 
304427829d71SBarry Smith    Level: developer
3045d763cef2SBarry Smith 
3046b8123daeSJed Brown    Notes:
304727829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
304827829d71SBarry Smith 
3049b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3050b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3051b8123daeSJed Brown 
305225cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
305325cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
305425cb2221SBarry Smith 
3055d763cef2SBarry Smith .keywords: TS, timestep, solve
3056d763cef2SBarry Smith 
30579be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3058d763cef2SBarry Smith @*/
3059193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3060d763cef2SBarry Smith {
30612fb8446cSMatthew G. Knepley   DM               dm;
3062dfbe8321SBarry Smith   PetscErrorCode   ierr;
3063fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3064d763cef2SBarry Smith 
3065d763cef2SBarry Smith   PetscFunctionBegin;
30660700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3067fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3068fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3069fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3070fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3071fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3072fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3073fffbeea8SBarry Smith                                 "  year        = {2014}\n}\n",&cite);
3074fffbeea8SBarry Smith 
30752fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3076d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3077d405a339SMatthew Knepley 
3078362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
307924655328SShri   ts->ptime_prev = ts->ptime;
3080cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3081bbd56ea5SKarl Rupp 
3082e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3083d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3084193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3085d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3086bbd56ea5SKarl Rupp 
308724655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3088cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3089362cd11cSLisandro Dalcin 
3090362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3091cef5090cSJed Brown     if (ts->errorifstepfailed) {
309208c7845fSBarry 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]);
309308c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3094d2daff3dSHong Zhang     }
309508c7845fSBarry Smith   } else if (!ts->reason) {
309608c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
309708c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
309808c7845fSBarry Smith   }
30992c18e0fdSBarry Smith   ts->total_steps++;
31008392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
310108c7845fSBarry Smith   PetscFunctionReturn(0);
310208c7845fSBarry Smith }
310308c7845fSBarry Smith 
310408c7845fSBarry Smith #undef __FUNCT__
310508c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
310608c7845fSBarry Smith /*@
310708c7845fSBarry Smith    TSAdjointStep - Steps one time step
310808c7845fSBarry Smith 
310908c7845fSBarry Smith    Collective on TS
311008c7845fSBarry Smith 
311108c7845fSBarry Smith    Input Parameter:
311208c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
311308c7845fSBarry Smith 
31146a4d4014SLisandro Dalcin    Level: intermediate
31156a4d4014SLisandro Dalcin 
31167087cfbeSBarry Smith    Notes:
31176a4d4014SLisandro Dalcin    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
31186a4d4014SLisandro Dalcin    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
31196a4d4014SLisandro Dalcin 
31206a4d4014SLisandro Dalcin    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
3121f22f69f0SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
31226a4d4014SLisandro Dalcin 
31230700a824SBarry Smith .keywords: TS, timestep, solve
31246a4d4014SLisandro Dalcin 
312508c7845fSBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
31266a4d4014SLisandro Dalcin @*/
312708c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
31286a4d4014SLisandro Dalcin {
312908c7845fSBarry Smith   DM               dm;
31306a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
31316a4d4014SLisandro Dalcin 
31326a4d4014SLisandro Dalcin   PetscFunctionBegin;
31334a2ae208SSatish Balay   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
313408c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
313508c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3136d763cef2SBarry Smith 
3137d763cef2SBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
313808c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
313908c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
314008c7845fSBarry Smith   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3141d763cef2SBarry Smith 
31426849ba73SBarry Smith   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
314342f2b339SBarry 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);
314442f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
3145a6570f20SBarry Smith   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3146d763cef2SBarry Smith 
3147cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3148cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3149362cd11cSLisandro Dalcin 
3150362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3151cef5090cSJed Brown     if (ts->errorifstepfailed) {
3152cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3153ce94432eSBarry Smith         SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s, increase -ts_max_snes_failures or make negative to attempt recovery",TSConvergedReasons[ts->reason]);
31542a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
31552a3a10ceSLisandro 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]);
3156ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3157cef5090cSJed Brown     }
3158362cd11cSLisandro Dalcin   } else if (!ts->reason) {
315973b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3160db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3161362cd11cSLisandro Dalcin   }
31622c18e0fdSBarry Smith   ts->total_steps--;
3163d763cef2SBarry Smith   PetscFunctionReturn(0);
3164d763cef2SBarry Smith }
3165d763cef2SBarry Smith 
3166d763cef2SBarry Smith #undef __FUNCT__
316705175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
316805175c85SJed Brown /*@
316905175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
317005175c85SJed Brown 
31711c3436cfSJed Brown    Collective on TS
317205175c85SJed Brown 
317305175c85SJed Brown    Input Arguments:
31741c3436cfSJed Brown +  ts - time stepping context
31751c3436cfSJed Brown .  order - desired order of accuracy
31760298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
317705175c85SJed Brown 
317805175c85SJed Brown    Output Arguments:
31790910c330SBarry Smith .  U - state at the end of the current step
318005175c85SJed Brown 
318105175c85SJed Brown    Level: advanced
318205175c85SJed Brown 
3183108c343cSJed Brown    Notes:
3184108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3185108c343cSJed 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.
3186108c343cSJed Brown 
31871c3436cfSJed Brown .seealso: TSStep(), TSAdapt
318805175c85SJed Brown @*/
31890910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
319005175c85SJed Brown {
319105175c85SJed Brown   PetscErrorCode ierr;
319205175c85SJed Brown 
319305175c85SJed Brown   PetscFunctionBegin;
319405175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
319505175c85SJed Brown   PetscValidType(ts,1);
31960910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3197ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
31980910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
319905175c85SJed Brown   PetscFunctionReturn(0);
320005175c85SJed Brown }
320105175c85SJed Brown 
3202d67e68b7SBarry Smith 
320305175c85SJed Brown #undef __FUNCT__
3204d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3205d763cef2SBarry Smith /*@
3206d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3207d763cef2SBarry Smith 
3208d763cef2SBarry Smith    Collective on TS
3209d763cef2SBarry Smith 
3210d763cef2SBarry Smith    Input Parameter:
3211d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3212cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
32135a3a76d0SJed Brown 
3214d763cef2SBarry Smith    Level: beginner
3215d763cef2SBarry Smith 
32165a3a76d0SJed Brown    Notes:
32175a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
32185a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
32195a3a76d0SJed Brown    stepped over the final time.
32205a3a76d0SJed Brown 
3221d763cef2SBarry Smith .keywords: TS, timestep, solve
3222d763cef2SBarry Smith 
3223d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3224d763cef2SBarry Smith @*/
3225cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3226d763cef2SBarry Smith {
3227b06615a5SLisandro Dalcin   Vec               solution;
3228d763cef2SBarry Smith   PetscErrorCode    ierr;
3229d763cef2SBarry Smith 
3230d763cef2SBarry Smith   PetscFunctionBegin;
3231d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3232f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
323349354f04SShri 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 */
3234b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
32350910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3236b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3237b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3238b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
32395a3a76d0SJed Brown     }
32400910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3241bbd56ea5SKarl Rupp   } else if (u) {
32420910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
32435a3a76d0SJed Brown   }
3244b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3245d763cef2SBarry Smith   /* reset time step and iteration counters */
3246193ac0bcSJed Brown   ts->steps             = 0;
32475ef26d82SJed Brown   ts->ksp_its           = 0;
32485ef26d82SJed Brown   ts->snes_its          = 0;
3249c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3250c610991cSLisandro Dalcin   ts->reject            = 0;
3251193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3252193ac0bcSJed Brown 
3253ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3254f05ece33SBarry Smith 
3255193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3256193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
32570910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3258cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3259193ac0bcSJed Brown   } else {
3260d763cef2SBarry Smith     /* steps the requested number of timesteps. */
3261db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3262db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3263cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
32646fea3669SShri Abhyankar     if(ts->event) {
32656fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
32666fea3669SShri Abhyankar     }
3267e1a7a14fSJed Brown     while (!ts->reason) {
3268193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3269193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3270aeb4809dSShri Abhyankar       if (ts->event) {
3271aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
32721eda64f1SShri Abhyankar       }
32738392e04aSShri Abhyankar       if(!ts->steprollback) {
3274cdf0de3dSShri Abhyankar 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
32751eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3276aeb4809dSShri Abhyankar       }
3277193ac0bcSJed Brown     }
327849354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
32790910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3280cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3281b06615a5SLisandro Dalcin       solution = u;
32820574a7fbSJed Brown     } else {
3283ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3284cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3285b06615a5SLisandro Dalcin       solution = ts->vec_sol;
32860574a7fbSJed Brown     }
3287b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
328827829d71SBarry Smith     ierr = VecViewFromOptions(solution, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3289193ac0bcSJed Brown   }
3290d2daff3dSHong Zhang 
3291ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
329256f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3293ef222394SBarry Smith   if (ts->adjoint_solve) {
3294ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
32952b0a91c0SBarry Smith   }
3296d763cef2SBarry Smith   PetscFunctionReturn(0);
3297d763cef2SBarry Smith }
3298d763cef2SBarry Smith 
3299d763cef2SBarry Smith #undef __FUNCT__
3300c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3301c88f2d44SBarry Smith /*@
3302c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3303c88f2d44SBarry Smith 
3304c88f2d44SBarry Smith    Collective on TS
3305c88f2d44SBarry Smith 
3306c88f2d44SBarry Smith    Input Parameter:
33072c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3308c88f2d44SBarry Smith 
3309e87fd094SBarry Smith    Options Database:
3310e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3311e87fd094SBarry Smith 
3312c88f2d44SBarry Smith    Level: intermediate
3313c88f2d44SBarry Smith 
3314c88f2d44SBarry Smith    Notes:
3315c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3316c88f2d44SBarry Smith 
331773b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
331873b18844SBarry Smith 
3319c88f2d44SBarry Smith .keywords: TS, timestep, solve
3320c88f2d44SBarry Smith 
3321c88f2d44SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3322c88f2d44SBarry Smith @*/
33232c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3324c88f2d44SBarry Smith {
3325c88f2d44SBarry Smith   PetscErrorCode    ierr;
3326c88f2d44SBarry Smith 
3327c88f2d44SBarry Smith   PetscFunctionBegin;
3328c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3329c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3330c88f2d44SBarry Smith   /* reset time step and iteration counters */
3331c88f2d44SBarry Smith   ts->steps             = 0;
3332c88f2d44SBarry Smith   ts->ksp_its           = 0;
3333c88f2d44SBarry Smith   ts->snes_its          = 0;
3334c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3335c88f2d44SBarry Smith   ts->reject            = 0;
3336c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3337c88f2d44SBarry Smith 
333873b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3339c88f2d44SBarry Smith 
334073b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3341c88f2d44SBarry Smith   while (!ts->reason) {
334273b18844SBarry Smith     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->adjoint_max_steps-ts->steps,ts->ptime);CHKERRQ(ierr);
334373b18844SBarry Smith     ierr = TSMonitor(ts,ts->adjoint_max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
334408c7845fSBarry Smith     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3345c88f2d44SBarry Smith     if (ts->event) {
3346d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3347d0578d90SShri Abhyankar     }
3348d0578d90SShri Abhyankar 
3349d0578d90SShri Abhyankar #if 0 /* I don't think PostStep is needed in AdjointSolve */
3350c88f2d44SBarry Smith       if (ts->event->status != TSEVENT_PROCESSING) {
3351c88f2d44SBarry Smith         ierr = TSPostStep(ts);CHKERRQ(ierr);
3352c88f2d44SBarry Smith       }
3353c88f2d44SBarry Smith     } else {
3354c88f2d44SBarry Smith       ierr = TSPostStep(ts);CHKERRQ(ierr);
3355c88f2d44SBarry Smith     }
3356d0578d90SShri Abhyankar #endif
3357c88f2d44SBarry Smith   }
3358c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3359e87fd094SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0], ((PetscObject) ts)->prefix, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3360c88f2d44SBarry Smith   PetscFunctionReturn(0);
3361c88f2d44SBarry Smith }
3362c88f2d44SBarry Smith 
3363c88f2d44SBarry Smith #undef __FUNCT__
3364d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
3365228d79bcSJed Brown /*@
3366228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3367228d79bcSJed Brown 
3368228d79bcSJed Brown    Collective on TS
3369228d79bcSJed Brown 
3370228d79bcSJed Brown    Input Parameters:
3371228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3372228d79bcSJed Brown .  step - step number that has just completed
3373228d79bcSJed Brown .  ptime - model time of the state
33740910c330SBarry Smith -  u - state at the current model time
3375228d79bcSJed Brown 
3376228d79bcSJed Brown    Notes:
3377228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
3378228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
3379228d79bcSJed Brown 
3380228d79bcSJed Brown    Level: advanced
3381228d79bcSJed Brown 
3382228d79bcSJed Brown .keywords: TS, timestep
3383228d79bcSJed Brown @*/
33840910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3385d763cef2SBarry Smith {
3386d763cef2SBarry Smith   PetscErrorCode ierr;
3387d763cef2SBarry Smith   PetscInt       i,n = ts->numbermonitors;
3388d763cef2SBarry Smith 
3389d763cef2SBarry Smith   PetscFunctionBegin;
3390b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3391b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
33925edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3393d763cef2SBarry Smith   for (i=0; i<n; i++) {
33940910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3395d763cef2SBarry Smith   }
33965edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3397d763cef2SBarry Smith   PetscFunctionReturn(0);
3398d763cef2SBarry Smith }
3399d763cef2SBarry Smith 
3400d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
3401d763cef2SBarry Smith #undef __FUNCT__
3402a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3403d763cef2SBarry Smith /*@C
3404a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
3405a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3406d763cef2SBarry Smith 
3407d763cef2SBarry Smith    Collective on TS
3408d763cef2SBarry Smith 
3409d763cef2SBarry Smith    Input Parameters:
3410d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3411d763cef2SBarry Smith .  label - the title to put in the title bar
34127c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3413a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3414a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3415d763cef2SBarry Smith 
3416d763cef2SBarry Smith    Output Parameter:
34170b039ecaSBarry Smith .  ctx - the context
3418d763cef2SBarry Smith 
3419d763cef2SBarry Smith    Options Database Key:
34204f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
34214f09c107SBarry Smith .  -ts_monitor_lg_solution -
342299fdda47SBarry Smith .  -ts_monitor_lg_error -
342399fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
342499fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
342599fdda47SBarry Smith -  -lg_indicate_data_points <true,false> - indicate the data points (at each time step) on the plot; default is true
3426d763cef2SBarry Smith 
3427d763cef2SBarry Smith    Notes:
3428a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3429d763cef2SBarry Smith 
3430d763cef2SBarry Smith    Level: intermediate
3431d763cef2SBarry Smith 
34327c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
3433d763cef2SBarry Smith 
34344f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
34357c922b88SBarry Smith 
3436d763cef2SBarry Smith @*/
3437a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3438d763cef2SBarry Smith {
3439b0a32e0cSBarry Smith   PetscDraw      win;
3440dfbe8321SBarry Smith   PetscErrorCode ierr;
3441d763cef2SBarry Smith 
3442d763cef2SBarry Smith   PetscFunctionBegin;
3443b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3444a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
34453fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
34460b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
34473bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3448287de1a7SBarry Smith   ierr = PetscDrawLGIndicateDataPoints((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3449287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3450a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3451d763cef2SBarry Smith   PetscFunctionReturn(0);
3452d763cef2SBarry Smith }
3453d763cef2SBarry Smith 
34544a2ae208SSatish Balay #undef __FUNCT__
34554f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3456b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3457d763cef2SBarry Smith {
34580b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3459c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3460dfbe8321SBarry Smith   PetscErrorCode ierr;
3461d763cef2SBarry Smith 
3462d763cef2SBarry Smith   PetscFunctionBegin;
3463b06615a5SLisandro Dalcin   if (!step) {
3464a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3465a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3466a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3467a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3468287de1a7SBarry Smith     ierr = PetscDrawLGIndicateDataPoints(ctx->lg,PETSC_TRUE);CHKERRQ(ierr);
3469a9f9c1f6SBarry Smith   }
3470c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
34710b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3472b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
34730b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
34743923b477SBarry Smith   }
3475d763cef2SBarry Smith   PetscFunctionReturn(0);
3476d763cef2SBarry Smith }
3477d763cef2SBarry Smith 
34784a2ae208SSatish Balay #undef __FUNCT__
3479a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3480d763cef2SBarry Smith /*@C
3481a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3482a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3483d763cef2SBarry Smith 
34840b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3485d763cef2SBarry Smith 
3486d763cef2SBarry Smith    Input Parameter:
34870b039ecaSBarry Smith .  ctx - the monitor context
3488d763cef2SBarry Smith 
3489d763cef2SBarry Smith    Level: intermediate
3490d763cef2SBarry Smith 
3491d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3492d763cef2SBarry Smith 
34934f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3494d763cef2SBarry Smith @*/
3495a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3496d763cef2SBarry Smith {
3497b0a32e0cSBarry Smith   PetscDraw      draw;
3498dfbe8321SBarry Smith   PetscErrorCode ierr;
3499d763cef2SBarry Smith 
3500d763cef2SBarry Smith   PetscFunctionBegin;
35017684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
35027684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
35037684fa3eSBarry Smith   }
35040b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
35056bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
35060b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
350731152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3508387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3509387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3510387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
35110b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3512d763cef2SBarry Smith   PetscFunctionReturn(0);
3513d763cef2SBarry Smith }
3514d763cef2SBarry Smith 
35154a2ae208SSatish Balay #undef __FUNCT__
35164a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3517d763cef2SBarry Smith /*@
3518b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3519d763cef2SBarry Smith 
3520d763cef2SBarry Smith    Not Collective
3521d763cef2SBarry Smith 
3522d763cef2SBarry Smith    Input Parameter:
3523d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3524d763cef2SBarry Smith 
3525d763cef2SBarry Smith    Output Parameter:
3526d763cef2SBarry Smith .  t  - the current time
3527d763cef2SBarry Smith 
3528d763cef2SBarry Smith    Level: beginner
3529d763cef2SBarry Smith 
3530b8123daeSJed Brown    Note:
3531b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
35329be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3533b8123daeSJed Brown 
3534d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3535d763cef2SBarry Smith 
3536d763cef2SBarry Smith .keywords: TS, get, time
3537d763cef2SBarry Smith @*/
35387087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3539d763cef2SBarry Smith {
3540d763cef2SBarry Smith   PetscFunctionBegin;
35410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3542f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3543d763cef2SBarry Smith   *t = ts->ptime;
3544d763cef2SBarry Smith   PetscFunctionReturn(0);
3545d763cef2SBarry Smith }
3546d763cef2SBarry Smith 
35474a2ae208SSatish Balay #undef __FUNCT__
3548e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3549e5e524a1SHong Zhang /*@
3550e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3551e5e524a1SHong Zhang 
3552e5e524a1SHong Zhang    Not Collective
3553e5e524a1SHong Zhang 
3554e5e524a1SHong Zhang    Input Parameter:
3555e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3556e5e524a1SHong Zhang 
3557e5e524a1SHong Zhang    Output Parameter:
3558e5e524a1SHong Zhang .  t  - the previous time
3559e5e524a1SHong Zhang 
3560e5e524a1SHong Zhang    Level: beginner
3561e5e524a1SHong Zhang 
3562e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3563e5e524a1SHong Zhang 
3564e5e524a1SHong Zhang .keywords: TS, get, time
3565e5e524a1SHong Zhang @*/
3566e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3567e5e524a1SHong Zhang {
3568e5e524a1SHong Zhang   PetscFunctionBegin;
3569e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3570e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3571e5e524a1SHong Zhang   *t = ts->ptime_prev;
3572e5e524a1SHong Zhang   PetscFunctionReturn(0);
3573e5e524a1SHong Zhang }
3574e5e524a1SHong Zhang 
3575e5e524a1SHong Zhang #undef __FUNCT__
35766a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
35776a4d4014SLisandro Dalcin /*@
35786a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
35796a4d4014SLisandro Dalcin 
35803f9fe445SBarry Smith    Logically Collective on TS
35816a4d4014SLisandro Dalcin 
35826a4d4014SLisandro Dalcin    Input Parameters:
35836a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
35846a4d4014SLisandro Dalcin -  time - the time
35856a4d4014SLisandro Dalcin 
35866a4d4014SLisandro Dalcin    Level: intermediate
35876a4d4014SLisandro Dalcin 
35886a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
35896a4d4014SLisandro Dalcin 
35906a4d4014SLisandro Dalcin .keywords: TS, set, time
35916a4d4014SLisandro Dalcin @*/
35927087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
35936a4d4014SLisandro Dalcin {
35946a4d4014SLisandro Dalcin   PetscFunctionBegin;
35950700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3596c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
35976a4d4014SLisandro Dalcin   ts->ptime = t;
35986a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
35996a4d4014SLisandro Dalcin }
36006a4d4014SLisandro Dalcin 
36016a4d4014SLisandro Dalcin #undef __FUNCT__
36024a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3603d763cef2SBarry Smith /*@C
3604d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3605d763cef2SBarry Smith    TS options in the database.
3606d763cef2SBarry Smith 
36073f9fe445SBarry Smith    Logically Collective on TS
3608d763cef2SBarry Smith 
3609d763cef2SBarry Smith    Input Parameter:
3610d763cef2SBarry Smith +  ts     - The TS context
3611d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3612d763cef2SBarry Smith 
3613d763cef2SBarry Smith    Notes:
3614d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3615d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3616d763cef2SBarry Smith    hyphen.
3617d763cef2SBarry Smith 
3618d763cef2SBarry Smith    Level: advanced
3619d763cef2SBarry Smith 
3620d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3621d763cef2SBarry Smith 
3622d763cef2SBarry Smith .seealso: TSSetFromOptions()
3623d763cef2SBarry Smith 
3624d763cef2SBarry Smith @*/
36257087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3626d763cef2SBarry Smith {
3627dfbe8321SBarry Smith   PetscErrorCode ierr;
3628089b2837SJed Brown   SNES           snes;
3629d763cef2SBarry Smith 
3630d763cef2SBarry Smith   PetscFunctionBegin;
36310700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3632d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3633089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3634089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3635d763cef2SBarry Smith   PetscFunctionReturn(0);
3636d763cef2SBarry Smith }
3637d763cef2SBarry Smith 
3638d763cef2SBarry Smith 
36394a2ae208SSatish Balay #undef __FUNCT__
36404a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3641d763cef2SBarry Smith /*@C
3642d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3643d763cef2SBarry Smith    TS options in the database.
3644d763cef2SBarry Smith 
36453f9fe445SBarry Smith    Logically Collective on TS
3646d763cef2SBarry Smith 
3647d763cef2SBarry Smith    Input Parameter:
3648d763cef2SBarry Smith +  ts     - The TS context
3649d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3650d763cef2SBarry Smith 
3651d763cef2SBarry Smith    Notes:
3652d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3653d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3654d763cef2SBarry Smith    hyphen.
3655d763cef2SBarry Smith 
3656d763cef2SBarry Smith    Level: advanced
3657d763cef2SBarry Smith 
3658d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3659d763cef2SBarry Smith 
3660d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3661d763cef2SBarry Smith 
3662d763cef2SBarry Smith @*/
36637087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3664d763cef2SBarry Smith {
3665dfbe8321SBarry Smith   PetscErrorCode ierr;
3666089b2837SJed Brown   SNES           snes;
3667d763cef2SBarry Smith 
3668d763cef2SBarry Smith   PetscFunctionBegin;
36690700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3670d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3671089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3672089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3673d763cef2SBarry Smith   PetscFunctionReturn(0);
3674d763cef2SBarry Smith }
3675d763cef2SBarry Smith 
36764a2ae208SSatish Balay #undef __FUNCT__
36774a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3678d763cef2SBarry Smith /*@C
3679d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3680d763cef2SBarry Smith    TS options in the database.
3681d763cef2SBarry Smith 
3682d763cef2SBarry Smith    Not Collective
3683d763cef2SBarry Smith 
3684d763cef2SBarry Smith    Input Parameter:
3685d763cef2SBarry Smith .  ts - The TS context
3686d763cef2SBarry Smith 
3687d763cef2SBarry Smith    Output Parameter:
3688d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3689d763cef2SBarry Smith 
3690d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3691d763cef2SBarry Smith    sufficient length to hold the prefix.
3692d763cef2SBarry Smith 
3693d763cef2SBarry Smith    Level: intermediate
3694d763cef2SBarry Smith 
3695d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3696d763cef2SBarry Smith 
3697d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3698d763cef2SBarry Smith @*/
36997087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3700d763cef2SBarry Smith {
3701dfbe8321SBarry Smith   PetscErrorCode ierr;
3702d763cef2SBarry Smith 
3703d763cef2SBarry Smith   PetscFunctionBegin;
37040700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37054482741eSBarry Smith   PetscValidPointer(prefix,2);
3706d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3707d763cef2SBarry Smith   PetscFunctionReturn(0);
3708d763cef2SBarry Smith }
3709d763cef2SBarry Smith 
37104a2ae208SSatish Balay #undef __FUNCT__
37114a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3712d763cef2SBarry Smith /*@C
3713d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3714d763cef2SBarry Smith 
3715d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3716d763cef2SBarry Smith 
3717d763cef2SBarry Smith    Input Parameter:
3718d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3719d763cef2SBarry Smith 
3720d763cef2SBarry Smith    Output Parameters:
3721e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3722e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3723e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3724e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3725d763cef2SBarry Smith 
37260298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3727d763cef2SBarry Smith 
3728d763cef2SBarry Smith    Level: intermediate
3729d763cef2SBarry Smith 
373026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3731d763cef2SBarry Smith 
3732d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3733d763cef2SBarry Smith @*/
3734e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3735d763cef2SBarry Smith {
3736089b2837SJed Brown   PetscErrorCode ierr;
3737089b2837SJed Brown   SNES           snes;
373824989b8cSPeter Brune   DM             dm;
3739089b2837SJed Brown 
3740d763cef2SBarry Smith   PetscFunctionBegin;
3741089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3742e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
374324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
374424989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3745d763cef2SBarry Smith   PetscFunctionReturn(0);
3746d763cef2SBarry Smith }
3747d763cef2SBarry Smith 
37481713a123SBarry Smith #undef __FUNCT__
37492eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
37502eca1d9cSJed Brown /*@C
37512eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
37522eca1d9cSJed Brown 
37532eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
37542eca1d9cSJed Brown 
37552eca1d9cSJed Brown    Input Parameter:
37562eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
37572eca1d9cSJed Brown 
37582eca1d9cSJed Brown    Output Parameters:
3759e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3760e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
37612eca1d9cSJed Brown .  f   - The function to compute the matrices
37622eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
37632eca1d9cSJed Brown 
37640298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
37652eca1d9cSJed Brown 
37662eca1d9cSJed Brown    Level: advanced
37672eca1d9cSJed Brown 
37682eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
37692eca1d9cSJed Brown 
37702eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
37712eca1d9cSJed Brown @*/
3772e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
37732eca1d9cSJed Brown {
3774089b2837SJed Brown   PetscErrorCode ierr;
3775089b2837SJed Brown   SNES           snes;
377624989b8cSPeter Brune   DM             dm;
37770910c330SBarry Smith 
37782eca1d9cSJed Brown   PetscFunctionBegin;
3779089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3780f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3781e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
378224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
378324989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
37842eca1d9cSJed Brown   PetscFunctionReturn(0);
37852eca1d9cSJed Brown }
37862eca1d9cSJed Brown 
37876083293cSBarry Smith 
37882eca1d9cSJed Brown #undef __FUNCT__
378983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
37901713a123SBarry Smith /*@C
379183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
37921713a123SBarry Smith    VecView() for the solution at each timestep
37931713a123SBarry Smith 
37941713a123SBarry Smith    Collective on TS
37951713a123SBarry Smith 
37961713a123SBarry Smith    Input Parameters:
37971713a123SBarry Smith +  ts - the TS context
37981713a123SBarry Smith .  step - current time-step
3799142b95e3SSatish Balay .  ptime - current time
38000298fd71SBarry Smith -  dummy - either a viewer or NULL
38011713a123SBarry Smith 
380299fdda47SBarry Smith    Options Database:
380399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
380499fdda47SBarry Smith 
3805387f4636SBarry 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
380699fdda47SBarry Smith        will look bad
380799fdda47SBarry Smith 
38081713a123SBarry Smith    Level: intermediate
38091713a123SBarry Smith 
38101713a123SBarry Smith .keywords: TS,  vector, monitor, view
38111713a123SBarry Smith 
3812a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38131713a123SBarry Smith @*/
38140910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38151713a123SBarry Smith {
3816dfbe8321SBarry Smith   PetscErrorCode   ierr;
381783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3818473a3ab2SBarry Smith   PetscDraw        draw;
38191713a123SBarry Smith 
38201713a123SBarry Smith   PetscFunctionBegin;
38216083293cSBarry Smith   if (!step && ictx->showinitial) {
38226083293cSBarry Smith     if (!ictx->initialsolution) {
38230910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
38241713a123SBarry Smith     }
38250910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
38266083293cSBarry Smith   }
3827b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
38280dcf80beSBarry Smith 
38296083293cSBarry Smith   if (ictx->showinitial) {
38306083293cSBarry Smith     PetscReal pause;
38316083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
38326083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
38336083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
38346083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
38356083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
38366083293cSBarry Smith   }
38370910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3838473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
3839473a3ab2SBarry Smith     PetscReal xl,yl,xr,yr,tw,w,h;
3840473a3ab2SBarry Smith     char      time[32];
3841473a3ab2SBarry Smith     size_t    len;
3842473a3ab2SBarry Smith 
3843473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
384485b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
3845473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3846473a3ab2SBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
38470298fd71SBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
3848473a3ab2SBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
3849473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
3850473a3ab2SBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3851473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3852473a3ab2SBarry Smith   }
3853473a3ab2SBarry Smith 
38546083293cSBarry Smith   if (ictx->showinitial) {
38556083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
38566083293cSBarry Smith   }
38571713a123SBarry Smith   PetscFunctionReturn(0);
38581713a123SBarry Smith }
38591713a123SBarry Smith 
38602d5ee99bSBarry Smith #undef __FUNCT__
38612d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
38622d5ee99bSBarry Smith /*@C
38632d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
38642d5ee99bSBarry Smith 
38652d5ee99bSBarry Smith    Collective on TS
38662d5ee99bSBarry Smith 
38672d5ee99bSBarry Smith    Input Parameters:
38682d5ee99bSBarry Smith +  ts - the TS context
38692d5ee99bSBarry Smith .  step - current time-step
38702d5ee99bSBarry Smith .  ptime - current time
38712d5ee99bSBarry Smith -  dummy - either a viewer or NULL
38722d5ee99bSBarry Smith 
38732d5ee99bSBarry Smith    Level: intermediate
38742d5ee99bSBarry Smith 
38752d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
38762d5ee99bSBarry Smith 
38772d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38782d5ee99bSBarry Smith @*/
38792d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38802d5ee99bSBarry Smith {
38812d5ee99bSBarry Smith   PetscErrorCode    ierr;
38822d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
38832d5ee99bSBarry Smith   PetscDraw         draw;
38842d5ee99bSBarry Smith   MPI_Comm          comm;
38852d5ee99bSBarry Smith   PetscInt          n;
38862d5ee99bSBarry Smith   PetscMPIInt       size;
38872d5ee99bSBarry Smith   PetscReal         xl,yl,xr,yr,tw,w,h;
38882d5ee99bSBarry Smith   char              time[32];
38892d5ee99bSBarry Smith   size_t            len;
38902d5ee99bSBarry Smith   const PetscScalar *U;
38912d5ee99bSBarry Smith 
38922d5ee99bSBarry Smith   PetscFunctionBegin;
38932d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
38942d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
38952d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
38962d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
38972d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
38982d5ee99bSBarry Smith 
38992d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
39002d5ee99bSBarry Smith 
39012d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
39024b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3903ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3904a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3905a4494fc1SBarry Smith       PetscFunctionReturn(0);
3906a4494fc1SBarry Smith   }
39072d5ee99bSBarry Smith   if (!step) ictx->color++;
39082d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
39092d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
39102d5ee99bSBarry Smith 
39112d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
39124b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
391385b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
39142d5ee99bSBarry Smith     ierr = PetscStrlen(time,&len);CHKERRQ(ierr);
39152d5ee99bSBarry Smith     ierr = PetscDrawStringGetSize(draw,&tw,NULL);CHKERRQ(ierr);
39162d5ee99bSBarry Smith     w    = xl + .5*(xr - xl) - .5*len*tw;
39172d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
39182d5ee99bSBarry Smith     ierr = PetscDrawString(draw,w,h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
39192d5ee99bSBarry Smith   }
39202d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
39212d5ee99bSBarry Smith   PetscFunctionReturn(0);
39222d5ee99bSBarry Smith }
39232d5ee99bSBarry Smith 
39241713a123SBarry Smith 
39256c699258SBarry Smith #undef __FUNCT__
392683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
39276083293cSBarry Smith /*@C
392883a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
39296083293cSBarry Smith 
39306083293cSBarry Smith    Collective on TS
39316083293cSBarry Smith 
39326083293cSBarry Smith    Input Parameters:
39336083293cSBarry Smith .    ctx - the monitor context
39346083293cSBarry Smith 
39356083293cSBarry Smith    Level: intermediate
39366083293cSBarry Smith 
39376083293cSBarry Smith .keywords: TS,  vector, monitor, view
39386083293cSBarry Smith 
393983a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
39406083293cSBarry Smith @*/
394183a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
39426083293cSBarry Smith {
39436083293cSBarry Smith   PetscErrorCode ierr;
39446083293cSBarry Smith 
39456083293cSBarry Smith   PetscFunctionBegin;
39464b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
394783a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
394883a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
394983a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
39506083293cSBarry Smith   PetscFunctionReturn(0);
39516083293cSBarry Smith }
39526083293cSBarry Smith 
39536083293cSBarry Smith #undef __FUNCT__
395483a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
39556083293cSBarry Smith /*@C
395683a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
39576083293cSBarry Smith 
39586083293cSBarry Smith    Collective on TS
39596083293cSBarry Smith 
39606083293cSBarry Smith    Input Parameter:
39616083293cSBarry Smith .    ts - time-step context
39626083293cSBarry Smith 
39636083293cSBarry Smith    Output Patameter:
39646083293cSBarry Smith .    ctx - the monitor context
39656083293cSBarry Smith 
396699fdda47SBarry Smith    Options Database:
396799fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
396899fdda47SBarry Smith 
39696083293cSBarry Smith    Level: intermediate
39706083293cSBarry Smith 
39716083293cSBarry Smith .keywords: TS,  vector, monitor, view
39726083293cSBarry Smith 
397383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
39746083293cSBarry Smith @*/
397583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
39766083293cSBarry Smith {
39776083293cSBarry Smith   PetscErrorCode   ierr;
39786083293cSBarry Smith 
39796083293cSBarry Smith   PetscFunctionBegin;
3980b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
398183a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3982e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3983bbd56ea5SKarl Rupp 
398483a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3985473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
39860298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3987473a3ab2SBarry Smith 
3988473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
39890298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
39902d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
39916083293cSBarry Smith   PetscFunctionReturn(0);
39926083293cSBarry Smith }
39936083293cSBarry Smith 
39946083293cSBarry Smith #undef __FUNCT__
399583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
39963a471f94SBarry Smith /*@C
399783a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
39983a471f94SBarry Smith    VecView() for the error at each timestep
39993a471f94SBarry Smith 
40003a471f94SBarry Smith    Collective on TS
40013a471f94SBarry Smith 
40023a471f94SBarry Smith    Input Parameters:
40033a471f94SBarry Smith +  ts - the TS context
40043a471f94SBarry Smith .  step - current time-step
40053a471f94SBarry Smith .  ptime - current time
40060298fd71SBarry Smith -  dummy - either a viewer or NULL
40073a471f94SBarry Smith 
40083a471f94SBarry Smith    Level: intermediate
40093a471f94SBarry Smith 
40103a471f94SBarry Smith .keywords: TS,  vector, monitor, view
40113a471f94SBarry Smith 
40123a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
40133a471f94SBarry Smith @*/
40140910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
40153a471f94SBarry Smith {
40163a471f94SBarry Smith   PetscErrorCode   ierr;
401783a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
401883a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
40193a471f94SBarry Smith   Vec              work;
40203a471f94SBarry Smith 
40213a471f94SBarry Smith   PetscFunctionBegin;
4022b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40230910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
40243a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
40250910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
40263a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
40273a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
40283a471f94SBarry Smith   PetscFunctionReturn(0);
40293a471f94SBarry Smith }
40303a471f94SBarry Smith 
40312a34c10cSBarry Smith #include <petsc-private/dmimpl.h>
40323a471f94SBarry Smith #undef __FUNCT__
40336c699258SBarry Smith #define __FUNCT__ "TSSetDM"
40346c699258SBarry Smith /*@
40356c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
40366c699258SBarry Smith 
40373f9fe445SBarry Smith    Logically Collective on TS and DM
40386c699258SBarry Smith 
40396c699258SBarry Smith    Input Parameters:
40406c699258SBarry Smith +  ts - the preconditioner context
40416c699258SBarry Smith -  dm - the dm
40426c699258SBarry Smith 
40436c699258SBarry Smith    Level: intermediate
40446c699258SBarry Smith 
40456c699258SBarry Smith 
40466c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
40476c699258SBarry Smith @*/
40487087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
40496c699258SBarry Smith {
40506c699258SBarry Smith   PetscErrorCode ierr;
4051089b2837SJed Brown   SNES           snes;
4052942e3340SBarry Smith   DMTS           tsdm;
40536c699258SBarry Smith 
40546c699258SBarry Smith   PetscFunctionBegin;
40550700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
405670663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4057942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
40582a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4059942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4060942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
406124989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
406224989b8cSPeter Brune         tsdm->originaldm = dm;
406324989b8cSPeter Brune       }
406424989b8cSPeter Brune     }
40656bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
406624989b8cSPeter Brune   }
40676c699258SBarry Smith   ts->dm = dm;
4068bbd56ea5SKarl Rupp 
4069089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4070089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
40716c699258SBarry Smith   PetscFunctionReturn(0);
40726c699258SBarry Smith }
40736c699258SBarry Smith 
40746c699258SBarry Smith #undef __FUNCT__
40756c699258SBarry Smith #define __FUNCT__ "TSGetDM"
40766c699258SBarry Smith /*@
40776c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
40786c699258SBarry Smith 
40793f9fe445SBarry Smith    Not Collective
40806c699258SBarry Smith 
40816c699258SBarry Smith    Input Parameter:
40826c699258SBarry Smith . ts - the preconditioner context
40836c699258SBarry Smith 
40846c699258SBarry Smith    Output Parameter:
40856c699258SBarry Smith .  dm - the dm
40866c699258SBarry Smith 
40876c699258SBarry Smith    Level: intermediate
40886c699258SBarry Smith 
40896c699258SBarry Smith 
40906c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
40916c699258SBarry Smith @*/
40927087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
40936c699258SBarry Smith {
4094496e6a7aSJed Brown   PetscErrorCode ierr;
4095496e6a7aSJed Brown 
40966c699258SBarry Smith   PetscFunctionBegin;
40970700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4098496e6a7aSJed Brown   if (!ts->dm) {
4099ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4100496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4101496e6a7aSJed Brown   }
41026c699258SBarry Smith   *dm = ts->dm;
41036c699258SBarry Smith   PetscFunctionReturn(0);
41046c699258SBarry Smith }
41051713a123SBarry Smith 
41060f5c6efeSJed Brown #undef __FUNCT__
41070f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
41080f5c6efeSJed Brown /*@
41090f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
41100f5c6efeSJed Brown 
41113f9fe445SBarry Smith    Logically Collective on SNES
41120f5c6efeSJed Brown 
41130f5c6efeSJed Brown    Input Parameter:
4114d42a1c89SJed Brown + snes - nonlinear solver
41150910c330SBarry Smith . U - the current state at which to evaluate the residual
4116d42a1c89SJed Brown - ctx - user context, must be a TS
41170f5c6efeSJed Brown 
41180f5c6efeSJed Brown    Output Parameter:
41190f5c6efeSJed Brown . F - the nonlinear residual
41200f5c6efeSJed Brown 
41210f5c6efeSJed Brown    Notes:
41220f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41230f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
41240f5c6efeSJed Brown 
41250f5c6efeSJed Brown    Level: advanced
41260f5c6efeSJed Brown 
41270f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
41280f5c6efeSJed Brown @*/
41290910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
41300f5c6efeSJed Brown {
41310f5c6efeSJed Brown   TS             ts = (TS)ctx;
41320f5c6efeSJed Brown   PetscErrorCode ierr;
41330f5c6efeSJed Brown 
41340f5c6efeSJed Brown   PetscFunctionBegin;
41350f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41360910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41370f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
41380f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
41390910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
41400f5c6efeSJed Brown   PetscFunctionReturn(0);
41410f5c6efeSJed Brown }
41420f5c6efeSJed Brown 
41430f5c6efeSJed Brown #undef __FUNCT__
41440f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
41450f5c6efeSJed Brown /*@
41460f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
41470f5c6efeSJed Brown 
41480f5c6efeSJed Brown    Collective on SNES
41490f5c6efeSJed Brown 
41500f5c6efeSJed Brown    Input Parameter:
41510f5c6efeSJed Brown + snes - nonlinear solver
41520910c330SBarry Smith . U - the current state at which to evaluate the residual
41530f5c6efeSJed Brown - ctx - user context, must be a TS
41540f5c6efeSJed Brown 
41550f5c6efeSJed Brown    Output Parameter:
41560f5c6efeSJed Brown + A - the Jacobian
41570f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
41580f5c6efeSJed Brown - flag - indicates any structure change in the matrix
41590f5c6efeSJed Brown 
41600f5c6efeSJed Brown    Notes:
41610f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41620f5c6efeSJed Brown 
41630f5c6efeSJed Brown    Level: developer
41640f5c6efeSJed Brown 
41650f5c6efeSJed Brown .seealso: SNESSetJacobian()
41660f5c6efeSJed Brown @*/
4167d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
41680f5c6efeSJed Brown {
41690f5c6efeSJed Brown   TS             ts = (TS)ctx;
41700f5c6efeSJed Brown   PetscErrorCode ierr;
41710f5c6efeSJed Brown 
41720f5c6efeSJed Brown   PetscFunctionBegin;
41730f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41740910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41750f5c6efeSJed Brown   PetscValidPointer(A,3);
417694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
41770f5c6efeSJed Brown   PetscValidPointer(B,4);
417894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
41790f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4180d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
41810f5c6efeSJed Brown   PetscFunctionReturn(0);
41820f5c6efeSJed Brown }
4183325fc9f4SBarry Smith 
41840e4ef248SJed Brown #undef __FUNCT__
41850e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
41860e4ef248SJed Brown /*@C
41870e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
41880e4ef248SJed Brown 
41890e4ef248SJed Brown    Collective on TS
41900e4ef248SJed Brown 
41910e4ef248SJed Brown    Input Arguments:
41920e4ef248SJed Brown +  ts - time stepping context
41930e4ef248SJed Brown .  t - time at which to evaluate
41940910c330SBarry Smith .  U - state at which to evaluate
41950e4ef248SJed Brown -  ctx - context
41960e4ef248SJed Brown 
41970e4ef248SJed Brown    Output Arguments:
41980e4ef248SJed Brown .  F - right hand side
41990e4ef248SJed Brown 
42000e4ef248SJed Brown    Level: intermediate
42010e4ef248SJed Brown 
42020e4ef248SJed Brown    Notes:
42030e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
42040e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
42050e4ef248SJed Brown 
42060e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
42070e4ef248SJed Brown @*/
42080910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
42090e4ef248SJed Brown {
42100e4ef248SJed Brown   PetscErrorCode ierr;
42110e4ef248SJed Brown   Mat            Arhs,Brhs;
42120e4ef248SJed Brown 
42130e4ef248SJed Brown   PetscFunctionBegin;
42140e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4215d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
42160910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
42170e4ef248SJed Brown   PetscFunctionReturn(0);
42180e4ef248SJed Brown }
42190e4ef248SJed Brown 
42200e4ef248SJed Brown #undef __FUNCT__
42210e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
42220e4ef248SJed Brown /*@C
42230e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
42240e4ef248SJed Brown 
42250e4ef248SJed Brown    Collective on TS
42260e4ef248SJed Brown 
42270e4ef248SJed Brown    Input Arguments:
42280e4ef248SJed Brown +  ts - time stepping context
42290e4ef248SJed Brown .  t - time at which to evaluate
42300910c330SBarry Smith .  U - state at which to evaluate
42310e4ef248SJed Brown -  ctx - context
42320e4ef248SJed Brown 
42330e4ef248SJed Brown    Output Arguments:
42340e4ef248SJed Brown +  A - pointer to operator
42350e4ef248SJed Brown .  B - pointer to preconditioning matrix
42360e4ef248SJed Brown -  flg - matrix structure flag
42370e4ef248SJed Brown 
42380e4ef248SJed Brown    Level: intermediate
42390e4ef248SJed Brown 
42400e4ef248SJed Brown    Notes:
42410e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
42420e4ef248SJed Brown 
42430e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
42440e4ef248SJed Brown @*/
4245d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
42460e4ef248SJed Brown {
42470e4ef248SJed Brown   PetscFunctionBegin;
42480e4ef248SJed Brown   PetscFunctionReturn(0);
42490e4ef248SJed Brown }
42500e4ef248SJed Brown 
42510026cea9SSean Farley #undef __FUNCT__
42520026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
42530026cea9SSean Farley /*@C
42540026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
42550026cea9SSean Farley 
42560026cea9SSean Farley    Collective on TS
42570026cea9SSean Farley 
42580026cea9SSean Farley    Input Arguments:
42590026cea9SSean Farley +  ts - time stepping context
42600026cea9SSean Farley .  t - time at which to evaluate
42610910c330SBarry Smith .  U - state at which to evaluate
42620910c330SBarry Smith .  Udot - time derivative of state vector
42630026cea9SSean Farley -  ctx - context
42640026cea9SSean Farley 
42650026cea9SSean Farley    Output Arguments:
42660026cea9SSean Farley .  F - left hand side
42670026cea9SSean Farley 
42680026cea9SSean Farley    Level: intermediate
42690026cea9SSean Farley 
42700026cea9SSean Farley    Notes:
42710910c330SBarry 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
42720026cea9SSean Farley    user is required to write their own TSComputeIFunction.
42730026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
42740026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
42750026cea9SSean Farley 
42760026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
42770026cea9SSean Farley @*/
42780910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
42790026cea9SSean Farley {
42800026cea9SSean Farley   PetscErrorCode ierr;
42810026cea9SSean Farley   Mat            A,B;
42820026cea9SSean Farley 
42830026cea9SSean Farley   PetscFunctionBegin;
42840298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4285d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
42860910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
42870026cea9SSean Farley   PetscFunctionReturn(0);
42880026cea9SSean Farley }
42890026cea9SSean Farley 
42900026cea9SSean Farley #undef __FUNCT__
42910026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
42920026cea9SSean Farley /*@C
4293b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
42940026cea9SSean Farley 
42950026cea9SSean Farley    Collective on TS
42960026cea9SSean Farley 
42970026cea9SSean Farley    Input Arguments:
42980026cea9SSean Farley +  ts - time stepping context
42990026cea9SSean Farley .  t - time at which to evaluate
43000910c330SBarry Smith .  U - state at which to evaluate
43010910c330SBarry Smith .  Udot - time derivative of state vector
43020026cea9SSean Farley .  shift - shift to apply
43030026cea9SSean Farley -  ctx - context
43040026cea9SSean Farley 
43050026cea9SSean Farley    Output Arguments:
43060026cea9SSean Farley +  A - pointer to operator
43070026cea9SSean Farley .  B - pointer to preconditioning matrix
43080026cea9SSean Farley -  flg - matrix structure flag
43090026cea9SSean Farley 
4310b41af12eSJed Brown    Level: advanced
43110026cea9SSean Farley 
43120026cea9SSean Farley    Notes:
43130026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
43140026cea9SSean Farley 
4315b41af12eSJed Brown    It is only appropriate for problems of the form
4316b41af12eSJed Brown 
4317b41af12eSJed Brown $     M Udot = F(U,t)
4318b41af12eSJed Brown 
4319b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4320b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4321b41af12eSJed Brown   an implicit operator of the form
4322b41af12eSJed Brown 
4323b41af12eSJed Brown $    shift*M + J
4324b41af12eSJed Brown 
4325b41af12eSJed 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
4326b41af12eSJed Brown   a copy of M or reassemble it when requested.
4327b41af12eSJed Brown 
43280026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
43290026cea9SSean Farley @*/
4330d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
43310026cea9SSean Farley {
4332b41af12eSJed Brown   PetscErrorCode ierr;
4333b41af12eSJed Brown 
43340026cea9SSean Farley   PetscFunctionBegin;
433594ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4336b41af12eSJed Brown   ts->ijacobian.shift = shift;
43370026cea9SSean Farley   PetscFunctionReturn(0);
43380026cea9SSean Farley }
4339b41af12eSJed Brown 
4340e817cc15SEmil Constantinescu #undef __FUNCT__
4341e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4342e817cc15SEmil Constantinescu /*@
4343e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4344e817cc15SEmil Constantinescu 
4345e817cc15SEmil Constantinescu    Not Collective
4346e817cc15SEmil Constantinescu 
4347e817cc15SEmil Constantinescu    Input Parameter:
4348e817cc15SEmil Constantinescu .  ts - the TS context
4349e817cc15SEmil Constantinescu 
4350e817cc15SEmil Constantinescu    Output Parameter:
43514e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4352e817cc15SEmil Constantinescu 
4353e817cc15SEmil Constantinescu    Level: beginner
4354e817cc15SEmil Constantinescu 
4355e817cc15SEmil Constantinescu .keywords: TS, equation type
4356e817cc15SEmil Constantinescu 
4357e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4358e817cc15SEmil Constantinescu @*/
4359e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4360e817cc15SEmil Constantinescu {
4361e817cc15SEmil Constantinescu   PetscFunctionBegin;
4362e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4363e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4364e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4365e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4366e817cc15SEmil Constantinescu }
4367e817cc15SEmil Constantinescu 
4368e817cc15SEmil Constantinescu #undef __FUNCT__
4369e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4370e817cc15SEmil Constantinescu /*@
4371e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4372e817cc15SEmil Constantinescu 
4373e817cc15SEmil Constantinescu    Not Collective
4374e817cc15SEmil Constantinescu 
4375e817cc15SEmil Constantinescu    Input Parameter:
4376e817cc15SEmil Constantinescu +  ts - the TS context
43774e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4378e817cc15SEmil Constantinescu 
4379e817cc15SEmil Constantinescu    Level: advanced
4380e817cc15SEmil Constantinescu 
4381e817cc15SEmil Constantinescu .keywords: TS, equation type
4382e817cc15SEmil Constantinescu 
4383e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4384e817cc15SEmil Constantinescu @*/
4385e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4386e817cc15SEmil Constantinescu {
4387e817cc15SEmil Constantinescu   PetscFunctionBegin;
4388e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4389e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4390e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4391e817cc15SEmil Constantinescu }
43920026cea9SSean Farley 
43934af1b03aSJed Brown #undef __FUNCT__
43944af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
43954af1b03aSJed Brown /*@
43964af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
43974af1b03aSJed Brown 
43984af1b03aSJed Brown    Not Collective
43994af1b03aSJed Brown 
44004af1b03aSJed Brown    Input Parameter:
44014af1b03aSJed Brown .  ts - the TS context
44024af1b03aSJed Brown 
44034af1b03aSJed Brown    Output Parameter:
44044af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
44054af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
44064af1b03aSJed Brown 
4407487e0bb9SJed Brown    Level: beginner
44084af1b03aSJed Brown 
4409cd652676SJed Brown    Notes:
4410cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
44114af1b03aSJed Brown 
44124af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
44134af1b03aSJed Brown 
44144af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
44154af1b03aSJed Brown @*/
44164af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
44174af1b03aSJed Brown {
44184af1b03aSJed Brown   PetscFunctionBegin;
44194af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44204af1b03aSJed Brown   PetscValidPointer(reason,2);
44214af1b03aSJed Brown   *reason = ts->reason;
44224af1b03aSJed Brown   PetscFunctionReturn(0);
44234af1b03aSJed Brown }
44244af1b03aSJed Brown 
4425fb1732b5SBarry Smith #undef __FUNCT__
4426d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4427d6ad946cSShri Abhyankar /*@
4428d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4429d6ad946cSShri Abhyankar 
4430d6ad946cSShri Abhyankar    Not Collective
4431d6ad946cSShri Abhyankar 
4432d6ad946cSShri Abhyankar    Input Parameter:
4433d6ad946cSShri Abhyankar +  ts - the TS context
4434d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4435d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4436d6ad946cSShri Abhyankar 
4437f5abba47SShri Abhyankar    Level: advanced
4438d6ad946cSShri Abhyankar 
4439d6ad946cSShri Abhyankar    Notes:
4440d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4441d6ad946cSShri Abhyankar 
4442d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4443d6ad946cSShri Abhyankar 
4444d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4445d6ad946cSShri Abhyankar @*/
4446d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4447d6ad946cSShri Abhyankar {
4448d6ad946cSShri Abhyankar   PetscFunctionBegin;
4449d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4450d6ad946cSShri Abhyankar   ts->reason = reason;
4451d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4452d6ad946cSShri Abhyankar }
4453d6ad946cSShri Abhyankar 
4454d6ad946cSShri Abhyankar #undef __FUNCT__
4455cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4456cc708dedSBarry Smith /*@
4457cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4458cc708dedSBarry Smith 
4459cc708dedSBarry Smith    Not Collective
4460cc708dedSBarry Smith 
4461cc708dedSBarry Smith    Input Parameter:
4462cc708dedSBarry Smith .  ts - the TS context
4463cc708dedSBarry Smith 
4464cc708dedSBarry Smith    Output Parameter:
4465cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4466cc708dedSBarry Smith 
4467487e0bb9SJed Brown    Level: beginner
4468cc708dedSBarry Smith 
4469cc708dedSBarry Smith    Notes:
4470cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4471cc708dedSBarry Smith 
4472cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4473cc708dedSBarry Smith 
4474cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4475cc708dedSBarry Smith @*/
4476cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4477cc708dedSBarry Smith {
4478cc708dedSBarry Smith   PetscFunctionBegin;
4479cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4480cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4481cc708dedSBarry Smith   *ftime = ts->solvetime;
4482cc708dedSBarry Smith   PetscFunctionReturn(0);
4483cc708dedSBarry Smith }
4484cc708dedSBarry Smith 
4485cc708dedSBarry Smith #undef __FUNCT__
44862c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
44872c18e0fdSBarry Smith /*@
44882c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
44892c18e0fdSBarry Smith 
44902c18e0fdSBarry Smith    Not Collective
44912c18e0fdSBarry Smith 
44922c18e0fdSBarry Smith    Input Parameter:
44932c18e0fdSBarry Smith .  ts - the TS context
44942c18e0fdSBarry Smith 
44952c18e0fdSBarry Smith    Output Parameter:
44962c18e0fdSBarry Smith .  steps - the number of steps
44972c18e0fdSBarry Smith 
44982c18e0fdSBarry Smith    Level: beginner
44992c18e0fdSBarry Smith 
45002c18e0fdSBarry Smith    Notes:
45012c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
45022c18e0fdSBarry Smith 
45032c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
45042c18e0fdSBarry Smith 
45052c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
45062c18e0fdSBarry Smith @*/
45072c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
45082c18e0fdSBarry Smith {
45092c18e0fdSBarry Smith   PetscFunctionBegin;
45102c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45112c18e0fdSBarry Smith   PetscValidPointer(steps,2);
45122c18e0fdSBarry Smith   *steps = ts->total_steps;
45132c18e0fdSBarry Smith   PetscFunctionReturn(0);
45142c18e0fdSBarry Smith }
45152c18e0fdSBarry Smith 
45162c18e0fdSBarry Smith #undef __FUNCT__
45175ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
45189f67acb7SJed Brown /*@
45195ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
45209f67acb7SJed Brown    used by the time integrator.
45219f67acb7SJed Brown 
45229f67acb7SJed Brown    Not Collective
45239f67acb7SJed Brown 
45249f67acb7SJed Brown    Input Parameter:
45259f67acb7SJed Brown .  ts - TS context
45269f67acb7SJed Brown 
45279f67acb7SJed Brown    Output Parameter:
45289f67acb7SJed Brown .  nits - number of nonlinear iterations
45299f67acb7SJed Brown 
45309f67acb7SJed Brown    Notes:
45319f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45329f67acb7SJed Brown 
45339f67acb7SJed Brown    Level: intermediate
45349f67acb7SJed Brown 
45359f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
45369f67acb7SJed Brown 
45375ef26d82SJed Brown .seealso:  TSGetKSPIterations()
45389f67acb7SJed Brown @*/
45395ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
45409f67acb7SJed Brown {
45419f67acb7SJed Brown   PetscFunctionBegin;
45429f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45439f67acb7SJed Brown   PetscValidIntPointer(nits,2);
45445ef26d82SJed Brown   *nits = ts->snes_its;
45459f67acb7SJed Brown   PetscFunctionReturn(0);
45469f67acb7SJed Brown }
45479f67acb7SJed Brown 
45489f67acb7SJed Brown #undef __FUNCT__
45495ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
45509f67acb7SJed Brown /*@
45515ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
45529f67acb7SJed Brown    used by the time integrator.
45539f67acb7SJed Brown 
45549f67acb7SJed Brown    Not Collective
45559f67acb7SJed Brown 
45569f67acb7SJed Brown    Input Parameter:
45579f67acb7SJed Brown .  ts - TS context
45589f67acb7SJed Brown 
45599f67acb7SJed Brown    Output Parameter:
45609f67acb7SJed Brown .  lits - number of linear iterations
45619f67acb7SJed Brown 
45629f67acb7SJed Brown    Notes:
45639f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45649f67acb7SJed Brown 
45659f67acb7SJed Brown    Level: intermediate
45669f67acb7SJed Brown 
45679f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
45689f67acb7SJed Brown 
45695ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
45709f67acb7SJed Brown @*/
45715ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
45729f67acb7SJed Brown {
45739f67acb7SJed Brown   PetscFunctionBegin;
45749f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45759f67acb7SJed Brown   PetscValidIntPointer(lits,2);
45765ef26d82SJed Brown   *lits = ts->ksp_its;
45779f67acb7SJed Brown   PetscFunctionReturn(0);
45789f67acb7SJed Brown }
45799f67acb7SJed Brown 
45809f67acb7SJed Brown #undef __FUNCT__
4581cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4582cef5090cSJed Brown /*@
4583cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4584cef5090cSJed Brown 
4585cef5090cSJed Brown    Not Collective
4586cef5090cSJed Brown 
4587cef5090cSJed Brown    Input Parameter:
4588cef5090cSJed Brown .  ts - TS context
4589cef5090cSJed Brown 
4590cef5090cSJed Brown    Output Parameter:
4591cef5090cSJed Brown .  rejects - number of steps rejected
4592cef5090cSJed Brown 
4593cef5090cSJed Brown    Notes:
4594cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4595cef5090cSJed Brown 
4596cef5090cSJed Brown    Level: intermediate
4597cef5090cSJed Brown 
4598cef5090cSJed Brown .keywords: TS, get, number
4599cef5090cSJed Brown 
46005ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4601cef5090cSJed Brown @*/
4602cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4603cef5090cSJed Brown {
4604cef5090cSJed Brown   PetscFunctionBegin;
4605cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4606cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4607cef5090cSJed Brown   *rejects = ts->reject;
4608cef5090cSJed Brown   PetscFunctionReturn(0);
4609cef5090cSJed Brown }
4610cef5090cSJed Brown 
4611cef5090cSJed Brown #undef __FUNCT__
4612cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4613cef5090cSJed Brown /*@
4614cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4615cef5090cSJed Brown 
4616cef5090cSJed Brown    Not Collective
4617cef5090cSJed Brown 
4618cef5090cSJed Brown    Input Parameter:
4619cef5090cSJed Brown .  ts - TS context
4620cef5090cSJed Brown 
4621cef5090cSJed Brown    Output Parameter:
4622cef5090cSJed Brown .  fails - number of failed nonlinear solves
4623cef5090cSJed Brown 
4624cef5090cSJed Brown    Notes:
4625cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4626cef5090cSJed Brown 
4627cef5090cSJed Brown    Level: intermediate
4628cef5090cSJed Brown 
4629cef5090cSJed Brown .keywords: TS, get, number
4630cef5090cSJed Brown 
46315ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4632cef5090cSJed Brown @*/
4633cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4634cef5090cSJed Brown {
4635cef5090cSJed Brown   PetscFunctionBegin;
4636cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4637cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4638cef5090cSJed Brown   *fails = ts->num_snes_failures;
4639cef5090cSJed Brown   PetscFunctionReturn(0);
4640cef5090cSJed Brown }
4641cef5090cSJed Brown 
4642cef5090cSJed Brown #undef __FUNCT__
4643cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4644cef5090cSJed Brown /*@
4645cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4646cef5090cSJed Brown 
4647cef5090cSJed Brown    Not Collective
4648cef5090cSJed Brown 
4649cef5090cSJed Brown    Input Parameter:
4650cef5090cSJed Brown +  ts - TS context
4651cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4652cef5090cSJed Brown 
4653cef5090cSJed Brown    Notes:
4654cef5090cSJed Brown    The counter is reset to zero for each step
4655cef5090cSJed Brown 
4656cef5090cSJed Brown    Options Database Key:
4657cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4658cef5090cSJed Brown 
4659cef5090cSJed Brown    Level: intermediate
4660cef5090cSJed Brown 
4661cef5090cSJed Brown .keywords: TS, set, maximum, number
4662cef5090cSJed Brown 
46635ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4664cef5090cSJed Brown @*/
4665cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4666cef5090cSJed Brown {
4667cef5090cSJed Brown   PetscFunctionBegin;
4668cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4669cef5090cSJed Brown   ts->max_reject = rejects;
4670cef5090cSJed Brown   PetscFunctionReturn(0);
4671cef5090cSJed Brown }
4672cef5090cSJed Brown 
4673cef5090cSJed Brown #undef __FUNCT__
4674cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4675cef5090cSJed Brown /*@
4676cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4677cef5090cSJed Brown 
4678cef5090cSJed Brown    Not Collective
4679cef5090cSJed Brown 
4680cef5090cSJed Brown    Input Parameter:
4681cef5090cSJed Brown +  ts - TS context
4682cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4683cef5090cSJed Brown 
4684cef5090cSJed Brown    Notes:
4685cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4686cef5090cSJed Brown 
4687cef5090cSJed Brown    Options Database Key:
4688cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4689cef5090cSJed Brown 
4690cef5090cSJed Brown    Level: intermediate
4691cef5090cSJed Brown 
4692cef5090cSJed Brown .keywords: TS, set, maximum, number
4693cef5090cSJed Brown 
46945ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4695cef5090cSJed Brown @*/
4696cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4697cef5090cSJed Brown {
4698cef5090cSJed Brown   PetscFunctionBegin;
4699cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4700cef5090cSJed Brown   ts->max_snes_failures = fails;
4701cef5090cSJed Brown   PetscFunctionReturn(0);
4702cef5090cSJed Brown }
4703cef5090cSJed Brown 
4704cef5090cSJed Brown #undef __FUNCT__
47054e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4706cef5090cSJed Brown /*@
4707cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4708cef5090cSJed Brown 
4709cef5090cSJed Brown    Not Collective
4710cef5090cSJed Brown 
4711cef5090cSJed Brown    Input Parameter:
4712cef5090cSJed Brown +  ts - TS context
4713cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4714cef5090cSJed Brown 
4715cef5090cSJed Brown    Options Database Key:
4716cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4717cef5090cSJed Brown 
4718cef5090cSJed Brown    Level: intermediate
4719cef5090cSJed Brown 
4720cef5090cSJed Brown .keywords: TS, set, error
4721cef5090cSJed Brown 
47225ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4723cef5090cSJed Brown @*/
4724cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4725cef5090cSJed Brown {
4726cef5090cSJed Brown   PetscFunctionBegin;
4727cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4728cef5090cSJed Brown   ts->errorifstepfailed = err;
4729cef5090cSJed Brown   PetscFunctionReturn(0);
4730cef5090cSJed Brown }
4731cef5090cSJed Brown 
4732cef5090cSJed Brown #undef __FUNCT__
4733fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4734fb1732b5SBarry Smith /*@C
4735fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4736fb1732b5SBarry Smith 
4737fb1732b5SBarry Smith    Collective on TS
4738fb1732b5SBarry Smith 
4739fb1732b5SBarry Smith    Input Parameters:
4740fb1732b5SBarry Smith +  ts - the TS context
4741fb1732b5SBarry Smith .  step - current time-step
4742fb1732b5SBarry Smith .  ptime - current time
47430910c330SBarry Smith .  u - current state
4744fb1732b5SBarry Smith -  viewer - binary viewer
4745fb1732b5SBarry Smith 
4746fb1732b5SBarry Smith    Level: intermediate
4747fb1732b5SBarry Smith 
4748fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4749fb1732b5SBarry Smith 
4750fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4751fb1732b5SBarry Smith @*/
47520910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4753fb1732b5SBarry Smith {
4754fb1732b5SBarry Smith   PetscErrorCode ierr;
4755ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4756fb1732b5SBarry Smith 
4757fb1732b5SBarry Smith   PetscFunctionBegin;
47580910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4759ed81e22dSJed Brown   PetscFunctionReturn(0);
4760ed81e22dSJed Brown }
4761ed81e22dSJed Brown 
4762ed81e22dSJed Brown #undef __FUNCT__
4763ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4764ed81e22dSJed Brown /*@C
4765ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4766ed81e22dSJed Brown 
4767ed81e22dSJed Brown    Collective on TS
4768ed81e22dSJed Brown 
4769ed81e22dSJed Brown    Input Parameters:
4770ed81e22dSJed Brown +  ts - the TS context
4771ed81e22dSJed Brown .  step - current time-step
4772ed81e22dSJed Brown .  ptime - current time
47730910c330SBarry Smith .  u - current state
4774ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4775ed81e22dSJed Brown 
4776ed81e22dSJed Brown    Level: intermediate
4777ed81e22dSJed Brown 
4778ed81e22dSJed Brown    Notes:
4779ed81e22dSJed 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.
4780ed81e22dSJed Brown    These are named according to the file name template.
4781ed81e22dSJed Brown 
4782ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4783ed81e22dSJed Brown 
4784ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4785ed81e22dSJed Brown 
4786ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4787ed81e22dSJed Brown @*/
47880910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4789ed81e22dSJed Brown {
4790ed81e22dSJed Brown   PetscErrorCode ierr;
4791ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4792ed81e22dSJed Brown   PetscViewer    viewer;
4793ed81e22dSJed Brown 
4794ed81e22dSJed Brown   PetscFunctionBegin;
47958caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4796ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
47970910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4798ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4799ed81e22dSJed Brown   PetscFunctionReturn(0);
4800ed81e22dSJed Brown }
4801ed81e22dSJed Brown 
4802ed81e22dSJed Brown #undef __FUNCT__
4803ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4804ed81e22dSJed Brown /*@C
4805ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4806ed81e22dSJed Brown 
4807ed81e22dSJed Brown    Collective on TS
4808ed81e22dSJed Brown 
4809ed81e22dSJed Brown    Input Parameters:
4810ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4811ed81e22dSJed Brown 
4812ed81e22dSJed Brown    Level: intermediate
4813ed81e22dSJed Brown 
4814ed81e22dSJed Brown    Note:
4815ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4816ed81e22dSJed Brown 
4817ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4818ed81e22dSJed Brown 
4819ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4820ed81e22dSJed Brown @*/
4821ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4822ed81e22dSJed Brown {
4823ed81e22dSJed Brown   PetscErrorCode ierr;
4824ed81e22dSJed Brown 
4825ed81e22dSJed Brown   PetscFunctionBegin;
4826ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4827fb1732b5SBarry Smith   PetscFunctionReturn(0);
4828fb1732b5SBarry Smith }
4829fb1732b5SBarry Smith 
483084df9cb4SJed Brown #undef __FUNCT__
4831552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
483284df9cb4SJed Brown /*@
4833552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
483484df9cb4SJed Brown 
4835ed81e22dSJed Brown    Collective on TS if controller has not been created yet
483684df9cb4SJed Brown 
483784df9cb4SJed Brown    Input Arguments:
4838ed81e22dSJed Brown .  ts - time stepping context
483984df9cb4SJed Brown 
484084df9cb4SJed Brown    Output Arguments:
4841ed81e22dSJed Brown .  adapt - adaptive controller
484284df9cb4SJed Brown 
484384df9cb4SJed Brown    Level: intermediate
484484df9cb4SJed Brown 
4845ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
484684df9cb4SJed Brown @*/
4847552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
484884df9cb4SJed Brown {
484984df9cb4SJed Brown   PetscErrorCode ierr;
485084df9cb4SJed Brown 
485184df9cb4SJed Brown   PetscFunctionBegin;
485284df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
485384df9cb4SJed Brown   PetscValidPointer(adapt,2);
485484df9cb4SJed Brown   if (!ts->adapt) {
4855ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
48563bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
48571c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
485884df9cb4SJed Brown   }
485984df9cb4SJed Brown   *adapt = ts->adapt;
486084df9cb4SJed Brown   PetscFunctionReturn(0);
486184df9cb4SJed Brown }
4862d6ebe24aSShri Abhyankar 
4863d6ebe24aSShri Abhyankar #undef __FUNCT__
48641c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
48651c3436cfSJed Brown /*@
48661c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
48671c3436cfSJed Brown 
48681c3436cfSJed Brown    Logically Collective
48691c3436cfSJed Brown 
48701c3436cfSJed Brown    Input Arguments:
48711c3436cfSJed Brown +  ts - time integration context
48721c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
48730298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
48741c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
48750298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
48761c3436cfSJed Brown 
4877a3cdaa26SBarry Smith    Options Database keys:
4878a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4879a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4880a3cdaa26SBarry Smith 
48811c3436cfSJed Brown    Level: beginner
48821c3436cfSJed Brown 
4883c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
48841c3436cfSJed Brown @*/
48851c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
48861c3436cfSJed Brown {
48871c3436cfSJed Brown   PetscErrorCode ierr;
48881c3436cfSJed Brown 
48891c3436cfSJed Brown   PetscFunctionBegin;
4890c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
48911c3436cfSJed Brown   if (vatol) {
48921c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
48931c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4894bbd56ea5SKarl Rupp 
48951c3436cfSJed Brown     ts->vatol = vatol;
48961c3436cfSJed Brown   }
4897c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
48981c3436cfSJed Brown   if (vrtol) {
48991c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
49001c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4901bbd56ea5SKarl Rupp 
49021c3436cfSJed Brown     ts->vrtol = vrtol;
49031c3436cfSJed Brown   }
49041c3436cfSJed Brown   PetscFunctionReturn(0);
49051c3436cfSJed Brown }
49061c3436cfSJed Brown 
49071c3436cfSJed Brown #undef __FUNCT__
4908c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4909c5033834SJed Brown /*@
4910c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4911c5033834SJed Brown 
4912c5033834SJed Brown    Logically Collective
4913c5033834SJed Brown 
4914c5033834SJed Brown    Input Arguments:
4915c5033834SJed Brown .  ts - time integration context
4916c5033834SJed Brown 
4917c5033834SJed Brown    Output Arguments:
49180298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
49190298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
49200298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
49210298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4922c5033834SJed Brown 
4923c5033834SJed Brown    Level: beginner
4924c5033834SJed Brown 
4925c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4926c5033834SJed Brown @*/
4927c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4928c5033834SJed Brown {
4929c5033834SJed Brown   PetscFunctionBegin;
4930c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4931c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4932c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4933c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4934c5033834SJed Brown   PetscFunctionReturn(0);
4935c5033834SJed Brown }
4936c5033834SJed Brown 
4937c5033834SJed Brown #undef __FUNCT__
4938b29392e1SShri #define __FUNCT__ "TSSetDifferentialEquationsIS"
4939b29392e1SShri /*@
4940b29392e1SShri    TSSetDifferentialEquationsIS - Sets an IS containing locations of differential equations in a DAE
4941b29392e1SShri 
4942b29392e1SShri    Not Collective
4943b29392e1SShri 
4944b29392e1SShri    Input Arguments:
4945b29392e1SShri +  ts - time stepping context
4946b29392e1SShri -  is_diff - Index set for differential equations
4947b29392e1SShri 
4948b29392e1SShri    Level: advanced
4949b29392e1SShri 
4950b29392e1SShri @*/
4951b29392e1SShri PetscErrorCode TSSetDifferentialEquationsIS(TS ts, IS is_diff)
4952b29392e1SShri {
4953b29392e1SShri   PetscErrorCode ierr;
4954b29392e1SShri 
4955b29392e1SShri   PetscFunctionBegin;
4956b29392e1SShri   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4957b29392e1SShri   PetscValidHeaderSpecific(is_diff,IS_CLASSID,2);
4958b29392e1SShri   PetscCheckSameComm(ts,1,is_diff,2);
4959b29392e1SShri   ierr = PetscObjectReference((PetscObject)is_diff);CHKERRQ(ierr);
4960b29392e1SShri   ierr = ISDestroy(&ts->is_diff);CHKERRQ(ierr);
4961b29392e1SShri   ts->is_diff = is_diff;
4962b29392e1SShri   PetscFunctionReturn(0);
4963b29392e1SShri }
4964b29392e1SShri 
4965b29392e1SShri #undef __FUNCT__
49669c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
49679c6b16b5SShri Abhyankar /*@
49689c6b16b5SShri Abhyankar    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between a vector and the current state
49699c6b16b5SShri Abhyankar 
49709c6b16b5SShri Abhyankar    Collective on TS
49719c6b16b5SShri Abhyankar 
49729c6b16b5SShri Abhyankar    Input Arguments:
49739c6b16b5SShri Abhyankar +  ts - time stepping context
49749c6b16b5SShri Abhyankar -  Y - state vector to be compared to ts->vec_sol
49759c6b16b5SShri Abhyankar 
49769c6b16b5SShri Abhyankar    Output Arguments:
49779c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
49789c6b16b5SShri Abhyankar 
49799c6b16b5SShri Abhyankar    Level: developer
49809c6b16b5SShri Abhyankar 
4981deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
49829c6b16b5SShri Abhyankar @*/
49839c6b16b5SShri Abhyankar PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec Y,PetscReal *norm)
49849c6b16b5SShri Abhyankar {
49859c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
49869c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
49879c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
49889c6b16b5SShri Abhyankar   Vec               U;
49899c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
49909c6b16b5SShri Abhyankar   PetscReal         tol;
49919c6b16b5SShri Abhyankar 
49929c6b16b5SShri Abhyankar   PetscFunctionBegin;
49939c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
49949c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
49959c6b16b5SShri Abhyankar   PetscValidPointer(norm,3);
49969c6b16b5SShri Abhyankar   U = ts->vec_sol;
49979c6b16b5SShri Abhyankar   PetscCheckSameTypeAndComm(U,1,Y,2);
49989c6b16b5SShri Abhyankar   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
49999c6b16b5SShri Abhyankar 
50009c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
50019c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
50029c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
50039c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
50049c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
50059c6b16b5SShri Abhyankar   sum  = 0.;
50069c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
50079c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
50089c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50099c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50109c6b16b5SShri Abhyankar     if(ts->is_diff) {
50119c6b16b5SShri Abhyankar       const PetscInt *idx;
50129c6b16b5SShri Abhyankar       PetscInt k;
50139c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50149c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
50159c6b16b5SShri Abhyankar       for(i=0; i < n; i++) {
50169c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
50179c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k])*PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
50189c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[k] - u[k]) / tol);
50199c6b16b5SShri Abhyankar       }
50209c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50219c6b16b5SShri Abhyankar     } else {
50229c6b16b5SShri Abhyankar       for (i=0; i<n; i++) {
50239c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50249c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50259c6b16b5SShri Abhyankar       }
50269c6b16b5SShri Abhyankar     }
50279c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50289c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50299c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
50309c6b16b5SShri Abhyankar     const PetscScalar *atol;
50319c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50329c6b16b5SShri Abhyankar     if(ts->is_diff) {
50339c6b16b5SShri Abhyankar       const PetscInt *idx;
50349c6b16b5SShri Abhyankar       PetscInt k;
50359c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50369c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
50379c6b16b5SShri Abhyankar       for(i=0; i < n; i++) {
50389c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
50399c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
50409c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[k] - u[k]) / tol);
50419c6b16b5SShri Abhyankar       }
50429c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50439c6b16b5SShri Abhyankar     } else {
50449c6b16b5SShri Abhyankar       for (i=0; i<n; i++) {
50459c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50469c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50479c6b16b5SShri Abhyankar       }
50489c6b16b5SShri Abhyankar     }
50499c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50509c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
50519c6b16b5SShri Abhyankar     const PetscScalar *rtol;
50529c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50539c6b16b5SShri Abhyankar     if(ts->is_diff) {
50549c6b16b5SShri Abhyankar       const PetscInt *idx;
50559c6b16b5SShri Abhyankar       PetscInt k;
50569c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50579c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
50589c6b16b5SShri Abhyankar       for(i=0; i < n; i++) {
50599c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
50609c6b16b5SShri Abhyankar 	tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
50619c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[k] - u[k]) / tol);
50629c6b16b5SShri Abhyankar       }
50639c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50649c6b16b5SShri Abhyankar     } else {
50659c6b16b5SShri Abhyankar       for (i=0; i<n; i++) {
50669c6b16b5SShri Abhyankar 	tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50679c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50689c6b16b5SShri Abhyankar       }
50699c6b16b5SShri Abhyankar     }
50709c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50719c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
50729c6b16b5SShri Abhyankar     if (ts->is_diff) {
50739c6b16b5SShri Abhyankar       const PetscInt *idx;
50749c6b16b5SShri Abhyankar       PetscInt k;
50759c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
50769c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
50779c6b16b5SShri Abhyankar       for (i=0; i<n; i++) {
50789c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
50799c6b16b5SShri Abhyankar 	tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
50809c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[k] - u[k]) / tol);
50819c6b16b5SShri Abhyankar       }
50829c6b16b5SShri Abhyankar     } else {
50839c6b16b5SShri Abhyankar       for (i=0; i<n; i++) {
50849c6b16b5SShri Abhyankar 	tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50859c6b16b5SShri Abhyankar 	sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50869c6b16b5SShri Abhyankar       }
50879c6b16b5SShri Abhyankar     }
50889c6b16b5SShri Abhyankar   }
50899c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
50909c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
50919c6b16b5SShri Abhyankar 
50929c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
50939c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
50949c6b16b5SShri Abhyankar 
50959c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
50969c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
50979c6b16b5SShri Abhyankar }
50989c6b16b5SShri Abhyankar 
50999c6b16b5SShri Abhyankar #undef __FUNCT__
51009c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
51019c6b16b5SShri Abhyankar /*@
51029c6b16b5SShri Abhyankar    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between a vector and the current state
51039c6b16b5SShri Abhyankar 
51049c6b16b5SShri Abhyankar    Collective on TS
51059c6b16b5SShri Abhyankar 
51069c6b16b5SShri Abhyankar    Input Arguments:
51079c6b16b5SShri Abhyankar +  ts - time stepping context
51089c6b16b5SShri Abhyankar -  Y - state vector to be compared to ts->vec_sol
51099c6b16b5SShri Abhyankar 
51109c6b16b5SShri Abhyankar    Output Arguments:
51119c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
51129c6b16b5SShri Abhyankar 
51139c6b16b5SShri Abhyankar    Level: developer
51149c6b16b5SShri Abhyankar 
5115deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
51169c6b16b5SShri Abhyankar @*/
51179c6b16b5SShri Abhyankar PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec Y,PetscReal *norm)
51189c6b16b5SShri Abhyankar {
51199c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
51209c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
51219c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
51229c6b16b5SShri Abhyankar   Vec               U;
51239c6b16b5SShri Abhyankar   PetscReal         max,gmax;
51249c6b16b5SShri Abhyankar   PetscReal         tol;
51259c6b16b5SShri Abhyankar 
51269c6b16b5SShri Abhyankar   PetscFunctionBegin;
51279c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
51289c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(Y,VEC_CLASSID,2);
51299c6b16b5SShri Abhyankar   PetscValidPointer(norm,3);
51309c6b16b5SShri Abhyankar   U = ts->vec_sol;
51319c6b16b5SShri Abhyankar   PetscCheckSameTypeAndComm(U,1,Y,2);
51329c6b16b5SShri Abhyankar   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"Y cannot be the TS solution vector");
51339c6b16b5SShri Abhyankar 
51349c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
51359c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
51369c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
51379c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
51389c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
51399c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
51409c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
51419c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
51429c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
51439c6b16b5SShri Abhyankar     if(ts->is_diff) {
51449c6b16b5SShri Abhyankar       const PetscInt *idx;
51459c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
51469c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
51479c6b16b5SShri Abhyankar 
51489c6b16b5SShri Abhyankar       k = idx[0];
51499c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51509c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
51519c6b16b5SShri Abhyankar       for(i=1; i < n; i++) {
51529c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
51539c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k])*PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51549c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[k] - u[k]) / tol);
51559c6b16b5SShri Abhyankar       }
51569c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
51579c6b16b5SShri Abhyankar     } else {
51589c6b16b5SShri Abhyankar       k = 0;
51599c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51609c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
51619c6b16b5SShri Abhyankar       for (i=1; i<n; i++) {
51629c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51639c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
51649c6b16b5SShri Abhyankar       }
51659c6b16b5SShri Abhyankar     }
51669c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
51679c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
51689c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
51699c6b16b5SShri Abhyankar     const PetscScalar *atol;
51709c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
51719c6b16b5SShri Abhyankar     if(ts->is_diff) {
51729c6b16b5SShri Abhyankar       const PetscInt *idx;
51739c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
51749c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
51759c6b16b5SShri Abhyankar 
51769c6b16b5SShri Abhyankar       k = idx[0];
51779c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51789c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
51799c6b16b5SShri Abhyankar       for(i=1; i < n; i++) {
51809c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
51819c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51829c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[k] - u[k]) / tol);
51839c6b16b5SShri Abhyankar       }
51849c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
51859c6b16b5SShri Abhyankar     } else {
51869c6b16b5SShri Abhyankar       k = 0;
51879c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51889c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
51899c6b16b5SShri Abhyankar       for (i=1; i<n; i++) {
51909c6b16b5SShri Abhyankar 	tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51919c6b16b5SShri Abhyankar         max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
51929c6b16b5SShri Abhyankar       }
51939c6b16b5SShri Abhyankar     }
51949c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
51959c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
51969c6b16b5SShri Abhyankar     const PetscScalar *rtol;
51979c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
51989c6b16b5SShri Abhyankar     if(ts->is_diff) {
51999c6b16b5SShri Abhyankar       const PetscInt *idx;
52009c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
52019c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
52029c6b16b5SShri Abhyankar 
52039c6b16b5SShri Abhyankar       k = idx[0];
52049c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[k])*PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
52059c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
52069c6b16b5SShri Abhyankar       for(i=1; i < n; i++) {
52079c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
52089c6b16b5SShri Abhyankar 	tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
52099c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[k] - u[k]) / tol);
52109c6b16b5SShri Abhyankar       }
52119c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
52129c6b16b5SShri Abhyankar     } else {
52139c6b16b5SShri Abhyankar       k = 0;
52149c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
52159c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
52169c6b16b5SShri Abhyankar       for (i=1; i<n; i++) {
52179c6b16b5SShri Abhyankar 	tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52189c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
52199c6b16b5SShri Abhyankar       }
52209c6b16b5SShri Abhyankar     }
52219c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52229c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
52239c6b16b5SShri Abhyankar     if (ts->is_diff) {
52249c6b16b5SShri Abhyankar       const PetscInt *idx;
52259c6b16b5SShri Abhyankar       ierr = ISGetIndices(ts->is_diff,&idx);CHKERRQ(ierr);
52269c6b16b5SShri Abhyankar       ierr = ISGetLocalSize(ts->is_diff,&n);CHKERRQ(ierr);
52279c6b16b5SShri Abhyankar 
52289c6b16b5SShri Abhyankar       k = idx[0];
52299c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
52309c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
52319c6b16b5SShri Abhyankar       for (i=1; i<n; i++) {
52329c6b16b5SShri Abhyankar 	k = idx[i] - rstart;
52339c6b16b5SShri Abhyankar 	tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
52349c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[k] - u[k]) / tol);
52359c6b16b5SShri Abhyankar       }
52369c6b16b5SShri Abhyankar       ierr = ISRestoreIndices(ts->is_diff,&idx);CHKERRQ(ierr);
52379c6b16b5SShri Abhyankar     } else {
52389c6b16b5SShri Abhyankar       k = 0;
52399c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
52409c6b16b5SShri Abhyankar       max = PetscAbsScalar(y[k] - u[k]) / tol;
52419c6b16b5SShri Abhyankar       for (i=1; i<n; i++) {
52429c6b16b5SShri Abhyankar 	tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52439c6b16b5SShri Abhyankar 	max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
52449c6b16b5SShri Abhyankar       }
52459c6b16b5SShri Abhyankar     }
52469c6b16b5SShri Abhyankar   }
52479c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
52489c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
52499c6b16b5SShri Abhyankar 
52509c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
52519c6b16b5SShri Abhyankar   *norm = gmax;
52529c6b16b5SShri Abhyankar 
52539c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
52549c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
52559c6b16b5SShri Abhyankar }
52569c6b16b5SShri Abhyankar 
52579c6b16b5SShri Abhyankar #undef __FUNCT__
52587619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
52591c3436cfSJed Brown /*@
52607619abb3SShri    TSErrorWeightedNorm - compute a weighted norm of the difference between a vector and the current state
52611c3436cfSJed Brown 
52621c3436cfSJed Brown    Collective on TS
52631c3436cfSJed Brown 
52641c3436cfSJed Brown    Input Arguments:
52651c3436cfSJed Brown +  ts - time stepping context
52661c3436cfSJed Brown -  Y - state vector to be compared to ts->vec_sol
52671c3436cfSJed Brown 
52687619abb3SShri    Options Database Keys:
52697619abb3SShri .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
52707619abb3SShri 
52711c3436cfSJed Brown    Output Arguments:
52721c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
52731c3436cfSJed Brown 
52741c3436cfSJed Brown    Level: developer
52751c3436cfSJed Brown 
5276deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
52771c3436cfSJed Brown @*/
52787619abb3SShri PetscErrorCode TSErrorWeightedNorm(TS ts,Vec Y,PetscReal *norm)
52791c3436cfSJed Brown {
52801c3436cfSJed Brown 
52811c3436cfSJed Brown   PetscFunctionBegin;
52821c3436cfSJed Brown 
52837619abb3SShri   if(ts->adapt->wnormtype == NORM_2) {
5284*3ef54c4aSShri Abhyankar     PetscErrorCode    ierr;
52859c6b16b5SShri Abhyankar     ierr = TSErrorWeightedNorm2(ts,Y,norm);
52869c6b16b5SShri Abhyankar   } else if(ts->adapt->wnormtype == NORM_INFINITY) {
5287*3ef54c4aSShri Abhyankar     PetscErrorCode    ierr;
52889c6b16b5SShri Abhyankar     ierr = TSErrorWeightedNormInfinity(ts,Y,norm);
52897619abb3SShri   }
52907619abb3SShri 
52911c3436cfSJed Brown   PetscFunctionReturn(0);
52921c3436cfSJed Brown }
52931c3436cfSJed Brown 
52949c6b16b5SShri Abhyankar 
52951c3436cfSJed Brown #undef __FUNCT__
52968d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
52978d59e960SJed Brown /*@
52988d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
52998d59e960SJed Brown 
53008d59e960SJed Brown    Logically Collective on TS
53018d59e960SJed Brown 
53028d59e960SJed Brown    Input Arguments:
53038d59e960SJed Brown +  ts - time stepping context
53048d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
53058d59e960SJed Brown 
53068d59e960SJed Brown    Note:
53078d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
53088d59e960SJed Brown 
53098d59e960SJed Brown    Level: intermediate
53108d59e960SJed Brown 
53118d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
53128d59e960SJed Brown @*/
53138d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
53148d59e960SJed Brown {
53158d59e960SJed Brown   PetscFunctionBegin;
53168d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
53178d59e960SJed Brown   ts->cfltime_local = cfltime;
53188d59e960SJed Brown   ts->cfltime       = -1.;
53198d59e960SJed Brown   PetscFunctionReturn(0);
53208d59e960SJed Brown }
53218d59e960SJed Brown 
53228d59e960SJed Brown #undef __FUNCT__
53238d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
53248d59e960SJed Brown /*@
53258d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
53268d59e960SJed Brown 
53278d59e960SJed Brown    Collective on TS
53288d59e960SJed Brown 
53298d59e960SJed Brown    Input Arguments:
53308d59e960SJed Brown .  ts - time stepping context
53318d59e960SJed Brown 
53328d59e960SJed Brown    Output Arguments:
53338d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
53348d59e960SJed Brown 
53358d59e960SJed Brown    Level: advanced
53368d59e960SJed Brown 
53378d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
53388d59e960SJed Brown @*/
53398d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
53408d59e960SJed Brown {
53418d59e960SJed Brown   PetscErrorCode ierr;
53428d59e960SJed Brown 
53438d59e960SJed Brown   PetscFunctionBegin;
53448d59e960SJed Brown   if (ts->cfltime < 0) {
5345ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
53468d59e960SJed Brown   }
53478d59e960SJed Brown   *cfltime = ts->cfltime;
53488d59e960SJed Brown   PetscFunctionReturn(0);
53498d59e960SJed Brown }
53508d59e960SJed Brown 
53518d59e960SJed Brown #undef __FUNCT__
5352d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5353d6ebe24aSShri Abhyankar /*@
5354d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5355d6ebe24aSShri Abhyankar 
5356d6ebe24aSShri Abhyankar    Input Parameters:
5357d6ebe24aSShri Abhyankar .  ts   - the TS context.
5358d6ebe24aSShri Abhyankar .  xl   - lower bound.
5359d6ebe24aSShri Abhyankar .  xu   - upper bound.
5360d6ebe24aSShri Abhyankar 
5361d6ebe24aSShri Abhyankar    Notes:
5362d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5363e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5364d6ebe24aSShri Abhyankar 
53652bd2b0e6SSatish Balay    Level: advanced
53662bd2b0e6SSatish Balay 
5367d6ebe24aSShri Abhyankar @*/
5368d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5369d6ebe24aSShri Abhyankar {
5370d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5371d6ebe24aSShri Abhyankar   SNES           snes;
5372d6ebe24aSShri Abhyankar 
5373d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5374d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5375d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5376d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5377d6ebe24aSShri Abhyankar }
5378d6ebe24aSShri Abhyankar 
5379325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5380c6db04a5SJed Brown #include <mex.h>
5381325fc9f4SBarry Smith 
5382325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5383325fc9f4SBarry Smith 
5384325fc9f4SBarry Smith #undef __FUNCT__
5385325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5386325fc9f4SBarry Smith /*
5387325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5388325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5389325fc9f4SBarry Smith 
5390325fc9f4SBarry Smith    Collective on TS
5391325fc9f4SBarry Smith 
5392325fc9f4SBarry Smith    Input Parameters:
5393325fc9f4SBarry Smith +  snes - the TS context
53940910c330SBarry Smith -  u - input vector
5395325fc9f4SBarry Smith 
5396325fc9f4SBarry Smith    Output Parameter:
5397325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5398325fc9f4SBarry Smith 
5399325fc9f4SBarry Smith    Notes:
5400325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5401325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5402325fc9f4SBarry Smith    themselves.
5403325fc9f4SBarry Smith 
5404325fc9f4SBarry Smith    Level: developer
5405325fc9f4SBarry Smith 
5406325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5407325fc9f4SBarry Smith 
5408325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5409325fc9f4SBarry Smith */
54100910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5411325fc9f4SBarry Smith {
5412325fc9f4SBarry Smith   PetscErrorCode  ierr;
5413325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5414325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5415325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5416325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5417325fc9f4SBarry Smith 
5418325fc9f4SBarry Smith   PetscFunctionBegin;
5419325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
54200910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
54210910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5422325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
54230910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5424325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5425325fc9f4SBarry Smith 
5426325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
54270910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
54280910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
54290910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5430bbd56ea5SKarl Rupp 
5431325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5432325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5433325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5434325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5435325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5436325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5437325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5438325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5439325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5440325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5441325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5442325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5443325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5444325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5445325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5446325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5447325fc9f4SBarry Smith   PetscFunctionReturn(0);
5448325fc9f4SBarry Smith }
5449325fc9f4SBarry Smith 
5450325fc9f4SBarry Smith 
5451325fc9f4SBarry Smith #undef __FUNCT__
5452325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5453325fc9f4SBarry Smith /*
5454325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5455325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5456e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5457325fc9f4SBarry Smith 
5458325fc9f4SBarry Smith    Logically Collective on TS
5459325fc9f4SBarry Smith 
5460325fc9f4SBarry Smith    Input Parameters:
5461325fc9f4SBarry Smith +  ts - the TS context
5462325fc9f4SBarry Smith -  func - function evaluation routine
5463325fc9f4SBarry Smith 
5464325fc9f4SBarry Smith    Calling sequence of func:
54650910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5466325fc9f4SBarry Smith 
5467325fc9f4SBarry Smith    Level: beginner
5468325fc9f4SBarry Smith 
5469325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5470325fc9f4SBarry Smith 
5471325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5472325fc9f4SBarry Smith */
5473cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5474325fc9f4SBarry Smith {
5475325fc9f4SBarry Smith   PetscErrorCode  ierr;
5476325fc9f4SBarry Smith   TSMatlabContext *sctx;
5477325fc9f4SBarry Smith 
5478325fc9f4SBarry Smith   PetscFunctionBegin;
5479325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5480325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5481325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5482325fc9f4SBarry Smith   /*
5483325fc9f4SBarry Smith      This should work, but it doesn't
5484325fc9f4SBarry Smith   sctx->ctx = ctx;
5485325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5486325fc9f4SBarry Smith   */
5487325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5488bbd56ea5SKarl Rupp 
54890298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5490325fc9f4SBarry Smith   PetscFunctionReturn(0);
5491325fc9f4SBarry Smith }
5492325fc9f4SBarry Smith 
5493325fc9f4SBarry Smith #undef __FUNCT__
5494325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5495325fc9f4SBarry Smith /*
5496325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5497325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5498325fc9f4SBarry Smith 
5499325fc9f4SBarry Smith    Collective on TS
5500325fc9f4SBarry Smith 
5501325fc9f4SBarry Smith    Input Parameters:
5502cdcf91faSSean Farley +  ts - the TS context
55030910c330SBarry Smith .  u - input vector
5504325fc9f4SBarry Smith .  A, B - the matrices
5505325fc9f4SBarry Smith -  ctx - user context
5506325fc9f4SBarry Smith 
5507325fc9f4SBarry Smith    Level: developer
5508325fc9f4SBarry Smith 
5509325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5510325fc9f4SBarry Smith 
5511325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5512325fc9f4SBarry Smith @*/
5513f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5514325fc9f4SBarry Smith {
5515325fc9f4SBarry Smith   PetscErrorCode  ierr;
5516325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5517325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5518325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5519325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5520325fc9f4SBarry Smith 
5521325fc9f4SBarry Smith   PetscFunctionBegin;
5522cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55230910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5524325fc9f4SBarry Smith 
55250910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5526325fc9f4SBarry Smith 
5527cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
55280910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
55290910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
55300910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
55310910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5532bbd56ea5SKarl Rupp 
5533325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5534325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5535325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5536325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5537325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5538325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5539325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5540325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5541325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5542325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5543325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5544325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5545325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5546325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5547325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5548325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5549325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5550325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5551325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5552325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5553325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5554325fc9f4SBarry Smith   PetscFunctionReturn(0);
5555325fc9f4SBarry Smith }
5556325fc9f4SBarry Smith 
5557325fc9f4SBarry Smith 
5558325fc9f4SBarry Smith #undef __FUNCT__
5559325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5560325fc9f4SBarry Smith /*
5561325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5562e3c5b3baSBarry 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
5563325fc9f4SBarry Smith 
5564325fc9f4SBarry Smith    Logically Collective on TS
5565325fc9f4SBarry Smith 
5566325fc9f4SBarry Smith    Input Parameters:
5567cdcf91faSSean Farley +  ts - the TS context
5568325fc9f4SBarry Smith .  A,B - Jacobian matrices
5569325fc9f4SBarry Smith .  func - function evaluation routine
5570325fc9f4SBarry Smith -  ctx - user context
5571325fc9f4SBarry Smith 
5572325fc9f4SBarry Smith    Calling sequence of func:
55730910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5574325fc9f4SBarry Smith 
5575325fc9f4SBarry Smith 
5576325fc9f4SBarry Smith    Level: developer
5577325fc9f4SBarry Smith 
5578325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5579325fc9f4SBarry Smith 
5580325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5581325fc9f4SBarry Smith */
5582cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5583325fc9f4SBarry Smith {
5584325fc9f4SBarry Smith   PetscErrorCode  ierr;
5585325fc9f4SBarry Smith   TSMatlabContext *sctx;
5586325fc9f4SBarry Smith 
5587325fc9f4SBarry Smith   PetscFunctionBegin;
5588325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5589325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5590325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5591325fc9f4SBarry Smith   /*
5592325fc9f4SBarry Smith      This should work, but it doesn't
5593325fc9f4SBarry Smith   sctx->ctx = ctx;
5594325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5595325fc9f4SBarry Smith   */
5596325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5597bbd56ea5SKarl Rupp 
5598cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5599325fc9f4SBarry Smith   PetscFunctionReturn(0);
5600325fc9f4SBarry Smith }
5601325fc9f4SBarry Smith 
5602b5b1a830SBarry Smith #undef __FUNCT__
5603b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5604b5b1a830SBarry Smith /*
5605b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5606b5b1a830SBarry Smith 
5607b5b1a830SBarry Smith    Collective on TS
5608b5b1a830SBarry Smith 
5609b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5610b5b1a830SBarry Smith @*/
56110910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5612b5b1a830SBarry Smith {
5613b5b1a830SBarry Smith   PetscErrorCode  ierr;
5614b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5615a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5616b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5617b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5618b5b1a830SBarry Smith 
5619b5b1a830SBarry Smith   PetscFunctionBegin;
5620cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56210910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5622b5b1a830SBarry Smith 
5623cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
56240910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5625bbd56ea5SKarl Rupp 
5626b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5627b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5628b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5629b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5630b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5631b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5632b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5633b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5634b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5635b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5636b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5637b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5638b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5639b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5640b5b1a830SBarry Smith   PetscFunctionReturn(0);
5641b5b1a830SBarry Smith }
5642b5b1a830SBarry Smith 
5643b5b1a830SBarry Smith 
5644b5b1a830SBarry Smith #undef __FUNCT__
5645b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5646b5b1a830SBarry Smith /*
5647b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5648b5b1a830SBarry Smith 
5649b5b1a830SBarry Smith    Level: developer
5650b5b1a830SBarry Smith 
5651b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5652b5b1a830SBarry Smith 
5653b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5654b5b1a830SBarry Smith */
5655cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5656b5b1a830SBarry Smith {
5657b5b1a830SBarry Smith   PetscErrorCode  ierr;
5658b5b1a830SBarry Smith   TSMatlabContext *sctx;
5659b5b1a830SBarry Smith 
5660b5b1a830SBarry Smith   PetscFunctionBegin;
5661b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5662b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5663b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5664b5b1a830SBarry Smith   /*
5665b5b1a830SBarry Smith      This should work, but it doesn't
5666b5b1a830SBarry Smith   sctx->ctx = ctx;
5667b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5668b5b1a830SBarry Smith   */
5669b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5670bbd56ea5SKarl Rupp 
56710298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5672b5b1a830SBarry Smith   PetscFunctionReturn(0);
5673b5b1a830SBarry Smith }
5674325fc9f4SBarry Smith #endif
5675b3603a34SBarry Smith 
5676b3603a34SBarry Smith #undef __FUNCT__
56774f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5678b3603a34SBarry Smith /*@C
56794f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5680b3603a34SBarry Smith        in a time based line graph
5681b3603a34SBarry Smith 
5682b3603a34SBarry Smith    Collective on TS
5683b3603a34SBarry Smith 
5684b3603a34SBarry Smith    Input Parameters:
5685b3603a34SBarry Smith +  ts - the TS context
5686b3603a34SBarry Smith .  step - current time-step
5687b3603a34SBarry Smith .  ptime - current time
5688b3603a34SBarry Smith -  lg - a line graph object
5689b3603a34SBarry Smith 
5690b3d3934dSBarry Smith    Options Database:
56919ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5692b3d3934dSBarry Smith 
5693b3603a34SBarry Smith    Level: intermediate
5694b3603a34SBarry Smith 
56950b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5696b3603a34SBarry Smith 
5697b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5698b3603a34SBarry Smith 
5699b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5700b3603a34SBarry Smith @*/
57010910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5702b3603a34SBarry Smith {
5703b3603a34SBarry Smith   PetscErrorCode    ierr;
57040b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5705b3603a34SBarry Smith   const PetscScalar *yy;
570658ff32f7SBarry Smith   PetscInt          dim;
570780666b62SBarry Smith   Vec               v;
5708b3603a34SBarry Smith 
5709b3603a34SBarry Smith   PetscFunctionBegin;
571058ff32f7SBarry Smith   if (!step) {
5711a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5712a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5713a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5714387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
5715387f4636SBarry Smith       char      **displaynames;
5716387f4636SBarry Smith       PetscBool flg;
5717387f4636SBarry Smith 
5718387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5719387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
5720387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
57219ae14b6eSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
5722387f4636SBarry Smith       if (flg) {
5723a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
5724387f4636SBarry Smith       }
5725387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
5726387f4636SBarry Smith     }
5727387f4636SBarry Smith     if (ctx->displaynames) {
5728387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
5729387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
5730387f4636SBarry Smith     } else if (ctx->names) {
57310910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
57320b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5733387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
5734387f4636SBarry Smith     }
57350b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
573658ff32f7SBarry Smith   }
573780666b62SBarry Smith   if (ctx->transform) {
5738e673d494SBarry Smith     ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);
573980666b62SBarry Smith   } else {
574080666b62SBarry Smith     v = u;
574180666b62SBarry Smith   }
574280666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
5743e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5744e3efe391SJed Brown   {
5745e3efe391SJed Brown     PetscReal *yreal;
5746e3efe391SJed Brown     PetscInt  i,n;
574780666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
5748785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5749e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
57500b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5751e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5752e3efe391SJed Brown   }
5753e3efe391SJed Brown #else
5754387f4636SBarry Smith   if (ctx->displaynames) {
5755387f4636SBarry Smith     PetscInt i;
5756387f4636SBarry Smith     for (i=0; i<ctx->ndisplayvariables; i++) {
5757387f4636SBarry Smith       ctx->displayvalues[i] = yy[ctx->displayvariables[i]];
5758387f4636SBarry Smith     }
5759387f4636SBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
5760387f4636SBarry Smith   } else {
57610b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5762387f4636SBarry Smith   }
5763e3efe391SJed Brown #endif
576480666b62SBarry Smith   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
576580666b62SBarry Smith   if (ctx->transform) {
576680666b62SBarry Smith     ierr = VecDestroy(&v);CHKERRQ(ierr);
576780666b62SBarry Smith   }
5768b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
57690b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
57703923b477SBarry Smith   }
5771b3603a34SBarry Smith   PetscFunctionReturn(0);
5772b3603a34SBarry Smith }
5773b3603a34SBarry Smith 
5774387f4636SBarry Smith 
5775b3603a34SBarry Smith #undef __FUNCT__
577631152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
5777b037adc7SBarry Smith /*@C
577831152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5779b037adc7SBarry Smith 
5780b037adc7SBarry Smith    Collective on TS
5781b037adc7SBarry Smith 
5782b037adc7SBarry Smith    Input Parameters:
5783b037adc7SBarry Smith +  ts - the TS context
5784b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
5785b037adc7SBarry Smith 
5786b037adc7SBarry Smith    Level: intermediate
5787b037adc7SBarry Smith 
5788b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
5789b037adc7SBarry Smith 
5790a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
5791b037adc7SBarry Smith @*/
579231152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
5793b037adc7SBarry Smith {
5794b037adc7SBarry Smith   PetscErrorCode    ierr;
5795b037adc7SBarry Smith   PetscInt          i;
5796b037adc7SBarry Smith 
5797b037adc7SBarry Smith   PetscFunctionBegin;
5798b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5799b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
58005537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
5801b3d3934dSBarry Smith       break;
5802b3d3934dSBarry Smith     }
5803b3d3934dSBarry Smith   }
5804b3d3934dSBarry Smith   PetscFunctionReturn(0);
5805b3d3934dSBarry Smith }
5806b3d3934dSBarry Smith 
5807b3d3934dSBarry Smith #undef __FUNCT__
5808e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
5809e673d494SBarry Smith /*@C
5810e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5811e673d494SBarry Smith 
5812e673d494SBarry Smith    Collective on TS
5813e673d494SBarry Smith 
5814e673d494SBarry Smith    Input Parameters:
5815e673d494SBarry Smith +  ts - the TS context
5816e673d494SBarry Smith -  names - the names of the components, final string must be NULL
5817e673d494SBarry Smith 
5818e673d494SBarry Smith    Level: intermediate
5819e673d494SBarry Smith 
5820e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5821e673d494SBarry Smith 
5822a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
5823e673d494SBarry Smith @*/
5824e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
5825e673d494SBarry Smith {
5826e673d494SBarry Smith   PetscErrorCode    ierr;
5827e673d494SBarry Smith 
5828e673d494SBarry Smith   PetscFunctionBegin;
5829e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
5830e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
5831e673d494SBarry Smith   PetscFunctionReturn(0);
5832e673d494SBarry Smith }
5833e673d494SBarry Smith 
5834e673d494SBarry Smith #undef __FUNCT__
5835b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
5836b3d3934dSBarry Smith /*@C
5837b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
5838b3d3934dSBarry Smith 
5839b3d3934dSBarry Smith    Collective on TS
5840b3d3934dSBarry Smith 
5841b3d3934dSBarry Smith    Input Parameter:
5842b3d3934dSBarry Smith .  ts - the TS context
5843b3d3934dSBarry Smith 
5844b3d3934dSBarry Smith    Output Parameter:
5845b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
5846b3d3934dSBarry Smith 
5847b3d3934dSBarry Smith    Level: intermediate
5848b3d3934dSBarry Smith 
5849b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5850b3d3934dSBarry Smith 
5851b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
5852b3d3934dSBarry Smith @*/
5853b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
5854b3d3934dSBarry Smith {
5855b3d3934dSBarry Smith   PetscInt       i;
5856b3d3934dSBarry Smith 
5857b3d3934dSBarry Smith   PetscFunctionBegin;
5858b3d3934dSBarry Smith   *names = NULL;
5859b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5860b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
58615537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
5862b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
5863b3d3934dSBarry Smith       break;
5864387f4636SBarry Smith     }
5865387f4636SBarry Smith   }
5866387f4636SBarry Smith   PetscFunctionReturn(0);
5867387f4636SBarry Smith }
5868387f4636SBarry Smith 
5869387f4636SBarry Smith #undef __FUNCT__
5870a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
5871a66092f1SBarry Smith /*@C
5872a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
5873a66092f1SBarry Smith 
5874a66092f1SBarry Smith    Collective on TS
5875a66092f1SBarry Smith 
5876a66092f1SBarry Smith    Input Parameters:
5877a66092f1SBarry Smith +  ctx - the TSMonitorLG context
5878a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
5879a66092f1SBarry Smith 
5880a66092f1SBarry Smith    Level: intermediate
5881a66092f1SBarry Smith 
5882a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
5883a66092f1SBarry Smith 
5884a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
5885a66092f1SBarry Smith @*/
5886a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
5887a66092f1SBarry Smith {
5888a66092f1SBarry Smith   PetscInt          j = 0,k;
5889a66092f1SBarry Smith   PetscErrorCode    ierr;
5890a66092f1SBarry Smith 
5891a66092f1SBarry Smith   PetscFunctionBegin;
5892a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
5893a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
5894a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
5895a66092f1SBarry Smith   while (displaynames[j]) j++;
5896a66092f1SBarry Smith   ctx->ndisplayvariables = j;
5897a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
5898a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
5899a66092f1SBarry Smith   j = 0;
5900a66092f1SBarry Smith   while (displaynames[j]) {
5901a66092f1SBarry Smith     k = 0;
5902a66092f1SBarry Smith     while (ctx->names[k]) {
5903a66092f1SBarry Smith       PetscBool flg;
5904a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
5905a66092f1SBarry Smith       if (flg) {
5906a66092f1SBarry Smith         ctx->displayvariables[j] = k;
5907a66092f1SBarry Smith         break;
5908a66092f1SBarry Smith       }
5909a66092f1SBarry Smith       k++;
5910a66092f1SBarry Smith     }
5911a66092f1SBarry Smith     j++;
5912a66092f1SBarry Smith   }
5913a66092f1SBarry Smith   PetscFunctionReturn(0);
5914a66092f1SBarry Smith }
5915a66092f1SBarry Smith 
5916a66092f1SBarry Smith 
5917a66092f1SBarry Smith #undef __FUNCT__
5918387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
5919387f4636SBarry Smith /*@C
5920387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
5921387f4636SBarry Smith 
5922387f4636SBarry Smith    Collective on TS
5923387f4636SBarry Smith 
5924387f4636SBarry Smith    Input Parameters:
5925387f4636SBarry Smith +  ts - the TS context
5926387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
5927387f4636SBarry Smith 
5928387f4636SBarry Smith    Level: intermediate
5929387f4636SBarry Smith 
5930387f4636SBarry Smith .keywords: TS,  vector, monitor, view
5931387f4636SBarry Smith 
5932387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
5933387f4636SBarry Smith @*/
5934387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
5935387f4636SBarry Smith {
5936a66092f1SBarry Smith   PetscInt          i;
5937387f4636SBarry Smith   PetscErrorCode    ierr;
5938387f4636SBarry Smith 
5939387f4636SBarry Smith   PetscFunctionBegin;
5940387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5941387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
59425537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
5943b3d3934dSBarry Smith       break;
5944b037adc7SBarry Smith     }
5945b037adc7SBarry Smith   }
5946b037adc7SBarry Smith   PetscFunctionReturn(0);
5947b037adc7SBarry Smith }
5948b037adc7SBarry Smith 
5949b037adc7SBarry Smith #undef __FUNCT__
595080666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
595180666b62SBarry Smith /*@C
595280666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
595380666b62SBarry Smith 
595480666b62SBarry Smith    Collective on TS
595580666b62SBarry Smith 
595680666b62SBarry Smith    Input Parameters:
595780666b62SBarry Smith +  ts - the TS context
595880666b62SBarry Smith .  transform - the transform function
59597684fa3eSBarry Smith .  destroy - function to destroy the optional context
596080666b62SBarry Smith -  ctx - optional context used by transform function
596180666b62SBarry Smith 
596280666b62SBarry Smith    Level: intermediate
596380666b62SBarry Smith 
596480666b62SBarry Smith .keywords: TS,  vector, monitor, view
596580666b62SBarry Smith 
5966a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
596780666b62SBarry Smith @*/
59687684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
596980666b62SBarry Smith {
597080666b62SBarry Smith   PetscInt          i;
5971a66092f1SBarry Smith   PetscErrorCode    ierr;
597280666b62SBarry Smith 
597380666b62SBarry Smith   PetscFunctionBegin;
597480666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
597580666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
59765537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
597780666b62SBarry Smith     }
597880666b62SBarry Smith   }
597980666b62SBarry Smith   PetscFunctionReturn(0);
598080666b62SBarry Smith }
598180666b62SBarry Smith 
598280666b62SBarry Smith #undef __FUNCT__
5983e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
5984e673d494SBarry Smith /*@C
5985e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
5986e673d494SBarry Smith 
5987e673d494SBarry Smith    Collective on TSLGCtx
5988e673d494SBarry Smith 
5989e673d494SBarry Smith    Input Parameters:
5990e673d494SBarry Smith +  ts - the TS context
5991e673d494SBarry Smith .  transform - the transform function
59927684fa3eSBarry Smith .  destroy - function to destroy the optional context
5993e673d494SBarry Smith -  ctx - optional context used by transform function
5994e673d494SBarry Smith 
5995e673d494SBarry Smith    Level: intermediate
5996e673d494SBarry Smith 
5997e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5998e673d494SBarry Smith 
5999a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6000e673d494SBarry Smith @*/
60017684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6002e673d494SBarry Smith {
6003e673d494SBarry Smith   PetscFunctionBegin;
6004e673d494SBarry Smith   ctx->transform    = transform;
60057684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6006e673d494SBarry Smith   ctx->transformctx = tctx;
6007e673d494SBarry Smith   PetscFunctionReturn(0);
6008e673d494SBarry Smith }
6009e673d494SBarry Smith 
6010b3603a34SBarry Smith #undef __FUNCT__
60114f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6012ef20d060SBarry Smith /*@C
60134f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6014ef20d060SBarry Smith        in a time based line graph
6015ef20d060SBarry Smith 
6016ef20d060SBarry Smith    Collective on TS
6017ef20d060SBarry Smith 
6018ef20d060SBarry Smith    Input Parameters:
6019ef20d060SBarry Smith +  ts - the TS context
6020ef20d060SBarry Smith .  step - current time-step
6021ef20d060SBarry Smith .  ptime - current time
6022ef20d060SBarry Smith -  lg - a line graph object
6023ef20d060SBarry Smith 
6024ef20d060SBarry Smith    Level: intermediate
6025ef20d060SBarry Smith 
6026abd5a294SJed Brown    Notes:
6027abd5a294SJed Brown    Only for sequential solves.
6028abd5a294SJed Brown 
6029abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6030abd5a294SJed Brown 
6031abd5a294SJed Brown    Options Database Keys:
60324f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6033ef20d060SBarry Smith 
6034ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6035ef20d060SBarry Smith 
6036abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6037ef20d060SBarry Smith @*/
60380910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6039ef20d060SBarry Smith {
6040ef20d060SBarry Smith   PetscErrorCode    ierr;
60410b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6042ef20d060SBarry Smith   const PetscScalar *yy;
6043ef20d060SBarry Smith   Vec               y;
6044a9f9c1f6SBarry Smith   PetscInt          dim;
6045ef20d060SBarry Smith 
6046ef20d060SBarry Smith   PetscFunctionBegin;
6047a9f9c1f6SBarry Smith   if (!step) {
6048a9f9c1f6SBarry Smith     PetscDrawAxis axis;
6049a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
60501ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
60510910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6052a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6053a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6054a9f9c1f6SBarry Smith   }
60550910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6056ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
60570910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6058ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6059e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6060e3efe391SJed Brown   {
6061e3efe391SJed Brown     PetscReal *yreal;
6062e3efe391SJed Brown     PetscInt  i,n;
6063e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6064785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6065e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
60660b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6067e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6068e3efe391SJed Brown   }
6069e3efe391SJed Brown #else
60700b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6071e3efe391SJed Brown #endif
6072ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6073ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6074b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
60750b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
60763923b477SBarry Smith   }
6077ef20d060SBarry Smith   PetscFunctionReturn(0);
6078ef20d060SBarry Smith }
6079ef20d060SBarry Smith 
6080201da799SBarry Smith #undef __FUNCT__
6081201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6082201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6083201da799SBarry Smith {
6084201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6085201da799SBarry Smith   PetscReal      x   = ptime,y;
6086201da799SBarry Smith   PetscErrorCode ierr;
6087201da799SBarry Smith   PetscInt       its;
6088201da799SBarry Smith 
6089201da799SBarry Smith   PetscFunctionBegin;
6090201da799SBarry Smith   if (!n) {
6091201da799SBarry Smith     PetscDrawAxis axis;
6092bbd56ea5SKarl Rupp 
6093201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6094201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6095201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6096bbd56ea5SKarl Rupp 
6097201da799SBarry Smith     ctx->snes_its = 0;
6098201da799SBarry Smith   }
6099201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6100201da799SBarry Smith   y    = its - ctx->snes_its;
6101201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
61023fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6103201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6104201da799SBarry Smith   }
6105201da799SBarry Smith   ctx->snes_its = its;
6106201da799SBarry Smith   PetscFunctionReturn(0);
6107201da799SBarry Smith }
6108201da799SBarry Smith 
6109201da799SBarry Smith #undef __FUNCT__
6110201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6111201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6112201da799SBarry Smith {
6113201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6114201da799SBarry Smith   PetscReal      x   = ptime,y;
6115201da799SBarry Smith   PetscErrorCode ierr;
6116201da799SBarry Smith   PetscInt       its;
6117201da799SBarry Smith 
6118201da799SBarry Smith   PetscFunctionBegin;
6119201da799SBarry Smith   if (!n) {
6120201da799SBarry Smith     PetscDrawAxis axis;
6121bbd56ea5SKarl Rupp 
6122201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6123201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6124201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6125bbd56ea5SKarl Rupp 
6126201da799SBarry Smith     ctx->ksp_its = 0;
6127201da799SBarry Smith   }
6128201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6129201da799SBarry Smith   y    = its - ctx->ksp_its;
6130201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
613199fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6132201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6133201da799SBarry Smith   }
6134201da799SBarry Smith   ctx->ksp_its = its;
6135201da799SBarry Smith   PetscFunctionReturn(0);
6136201da799SBarry Smith }
6137f9c1d6abSBarry Smith 
6138f9c1d6abSBarry Smith #undef __FUNCT__
6139f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6140f9c1d6abSBarry Smith /*@
6141f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6142f9c1d6abSBarry Smith 
6143f9c1d6abSBarry Smith    Collective on TS and Vec
6144f9c1d6abSBarry Smith 
6145f9c1d6abSBarry Smith    Input Parameters:
6146f9c1d6abSBarry Smith +  ts - the TS context
6147f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6148f9c1d6abSBarry Smith 
6149f9c1d6abSBarry Smith    Output Parameters:
6150f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6151f9c1d6abSBarry Smith 
6152f9c1d6abSBarry Smith    Level: developer
6153f9c1d6abSBarry Smith 
6154f9c1d6abSBarry Smith .keywords: TS, compute
6155f9c1d6abSBarry Smith 
6156f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6157f9c1d6abSBarry Smith @*/
6158f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6159f9c1d6abSBarry Smith {
6160f9c1d6abSBarry Smith   PetscErrorCode ierr;
6161f9c1d6abSBarry Smith 
6162f9c1d6abSBarry Smith   PetscFunctionBegin;
6163f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6164ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6165f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6166f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6167f9c1d6abSBarry Smith }
616824655328SShri 
6169b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6170b3d3934dSBarry Smith #undef __FUNCT__
6171b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6172b3d3934dSBarry Smith /*@C
6173b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6174b3d3934dSBarry Smith 
6175b3d3934dSBarry Smith    Collective on TS
6176b3d3934dSBarry Smith 
6177b3d3934dSBarry Smith    Input Parameters:
6178b3d3934dSBarry Smith .  ts  - the ODE solver object
6179b3d3934dSBarry Smith 
6180b3d3934dSBarry Smith    Output Parameter:
6181b3d3934dSBarry Smith .  ctx - the context
6182b3d3934dSBarry Smith 
6183b3d3934dSBarry Smith    Level: intermediate
6184b3d3934dSBarry Smith 
6185b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6186b3d3934dSBarry Smith 
6187b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6188b3d3934dSBarry Smith 
6189b3d3934dSBarry Smith @*/
6190b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6191b3d3934dSBarry Smith {
6192b3d3934dSBarry Smith   PetscErrorCode ierr;
6193b3d3934dSBarry Smith 
6194b3d3934dSBarry Smith   PetscFunctionBegin;
6195a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6196b3d3934dSBarry Smith   PetscFunctionReturn(0);
6197b3d3934dSBarry Smith }
6198b3d3934dSBarry Smith 
6199b3d3934dSBarry Smith #undef __FUNCT__
6200b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6201b3d3934dSBarry Smith /*@C
6202b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6203b3d3934dSBarry Smith 
6204b3d3934dSBarry Smith    Collective on TS
6205b3d3934dSBarry Smith 
6206b3d3934dSBarry Smith    Input Parameters:
6207b3d3934dSBarry Smith +  ts - the TS context
6208b3d3934dSBarry Smith .  step - current time-step
6209b3d3934dSBarry Smith .  ptime - current time
6210b3d3934dSBarry Smith -  ctx - the envelope context
6211b3d3934dSBarry Smith 
6212b3d3934dSBarry Smith    Options Database:
6213b3d3934dSBarry Smith .  -ts_monitor_envelope
6214b3d3934dSBarry Smith 
6215b3d3934dSBarry Smith    Level: intermediate
6216b3d3934dSBarry Smith 
6217b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6218b3d3934dSBarry Smith 
6219b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6220b3d3934dSBarry Smith 
6221b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds()
6222b3d3934dSBarry Smith @*/
6223b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6224b3d3934dSBarry Smith {
6225b3d3934dSBarry Smith   PetscErrorCode       ierr;
6226b3d3934dSBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dummy;
6227b3d3934dSBarry Smith 
6228b3d3934dSBarry Smith   PetscFunctionBegin;
6229b3d3934dSBarry Smith   if (!ctx->max) {
6230b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6231b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6232b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6233b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6234b3d3934dSBarry Smith   } else {
6235b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6236b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6237b3d3934dSBarry Smith   }
6238b3d3934dSBarry Smith   PetscFunctionReturn(0);
6239b3d3934dSBarry Smith }
6240b3d3934dSBarry Smith 
6241b3d3934dSBarry Smith 
6242b3d3934dSBarry Smith #undef __FUNCT__
6243b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6244b3d3934dSBarry Smith /*@C
6245b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6246b3d3934dSBarry Smith 
6247b3d3934dSBarry Smith    Collective on TS
6248b3d3934dSBarry Smith 
6249b3d3934dSBarry Smith    Input Parameter:
6250b3d3934dSBarry Smith .  ts - the TS context
6251b3d3934dSBarry Smith 
6252b3d3934dSBarry Smith    Output Parameter:
6253b3d3934dSBarry Smith +  max - the maximum values
6254b3d3934dSBarry Smith -  min - the minimum values
6255b3d3934dSBarry Smith 
6256b3d3934dSBarry Smith    Level: intermediate
6257b3d3934dSBarry Smith 
6258b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6259b3d3934dSBarry Smith 
6260b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6261b3d3934dSBarry Smith @*/
6262b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6263b3d3934dSBarry Smith {
6264b3d3934dSBarry Smith   PetscInt i;
6265b3d3934dSBarry Smith 
6266b3d3934dSBarry Smith   PetscFunctionBegin;
6267b3d3934dSBarry Smith   if (max) *max = NULL;
6268b3d3934dSBarry Smith   if (min) *min = NULL;
6269b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6270b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
62715537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6272b3d3934dSBarry Smith       if (max) *max = ctx->max;
6273b3d3934dSBarry Smith       if (min) *min = ctx->min;
6274b3d3934dSBarry Smith       break;
6275b3d3934dSBarry Smith     }
6276b3d3934dSBarry Smith   }
6277b3d3934dSBarry Smith   PetscFunctionReturn(0);
6278b3d3934dSBarry Smith }
6279b3d3934dSBarry Smith 
6280b3d3934dSBarry Smith #undef __FUNCT__
6281b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6282b3d3934dSBarry Smith /*@C
6283b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6284b3d3934dSBarry Smith 
6285b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6286b3d3934dSBarry Smith 
6287b3d3934dSBarry Smith    Input Parameter:
6288b3d3934dSBarry Smith .  ctx - the monitor context
6289b3d3934dSBarry Smith 
6290b3d3934dSBarry Smith    Level: intermediate
6291b3d3934dSBarry Smith 
6292b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6293b3d3934dSBarry Smith 
6294b3d3934dSBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
6295b3d3934dSBarry Smith @*/
6296b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6297b3d3934dSBarry Smith {
6298b3d3934dSBarry Smith   PetscErrorCode ierr;
6299b3d3934dSBarry Smith 
6300b3d3934dSBarry Smith   PetscFunctionBegin;
6301b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6302b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6303b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6304b3d3934dSBarry Smith   PetscFunctionReturn(0);
6305b3d3934dSBarry Smith }
6306f2dee214SBarry Smith 
630724655328SShri #undef __FUNCT__
630824655328SShri #define __FUNCT__ "TSRollBack"
630924655328SShri /*@
631024655328SShri    TSRollBack - Rolls back one time step
631124655328SShri 
631224655328SShri    Collective on TS
631324655328SShri 
631424655328SShri    Input Parameter:
631524655328SShri .  ts - the TS context obtained from TSCreate()
631624655328SShri 
631724655328SShri    Level: advanced
631824655328SShri 
631924655328SShri .keywords: TS, timestep, rollback
632024655328SShri 
632124655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
632224655328SShri @*/
632324655328SShri PetscErrorCode  TSRollBack(TS ts)
632424655328SShri {
632524655328SShri   PetscErrorCode ierr;
632624655328SShri 
632724655328SShri   PetscFunctionBegin;
632824655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
632924655328SShri 
633024655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
633124655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
633224655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
633324655328SShri   ts->ptime = ts->ptime_prev;
63348392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
633524655328SShri   PetscFunctionReturn(0);
633624655328SShri }
6337aeb4809dSShri Abhyankar 
6338ff22ae23SHong Zhang #undef __FUNCT__
6339ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6340ff22ae23SHong Zhang /*@
6341ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6342ff22ae23SHong Zhang 
6343ff22ae23SHong Zhang    Input Parameter:
6344ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6345ff22ae23SHong Zhang 
6346ff22ae23SHong Zhang    Level: advanced
6347ff22ae23SHong Zhang 
6348ff22ae23SHong Zhang .keywords: TS, getstages
6349ff22ae23SHong Zhang 
6350ff22ae23SHong Zhang .seealso: TSCreate()
6351ff22ae23SHong Zhang @*/
6352ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6353ff22ae23SHong Zhang {
6354ff22ae23SHong Zhang   PetscErrorCode ierr;
6355ff22ae23SHong Zhang 
6356ff22ae23SHong Zhang   PetscFunctionBegin;
6357ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6358ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6359ff22ae23SHong Zhang 
6360ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6361ff22ae23SHong Zhang   else {
6362ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6363ff22ae23SHong Zhang   }
6364ff22ae23SHong Zhang   PetscFunctionReturn(0);
6365ff22ae23SHong Zhang }
6366ff22ae23SHong Zhang 
6367