xref: /petsc/src/ts/interface/ts.c (revision 3ff766be1a676532727eb526f3540330b1782530)
163dd3a1aSKris Buschelman 
2af0996ceSBarry Smith #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)
47847ff0e1SMatthew G. Knepley .  -ts_fd_color - Use finite differences with coloring to compute IJacobian
48bdad233fSMatthew Knepley .  -ts_monitor - print information at each timestep
49de06c3feSJed Brown .  -ts_monitor_lg_timestep - Monitor timestep size graphically
50de06c3feSJed Brown .  -ts_monitor_lg_solution - Monitor solution graphically
51de06c3feSJed Brown .  -ts_monitor_lg_error - Monitor error graphically
52de06c3feSJed Brown .  -ts_monitor_lg_snes_iterations - Monitor number nonlinear iterations for each timestep graphically
53de06c3feSJed Brown .  -ts_monitor_lg_ksp_iterations - Monitor number nonlinear iterations for each timestep graphically
54de06c3feSJed Brown .  -ts_monitor_sp_eig - Monitor eigenvalues of linearized operator graphically
55de06c3feSJed Brown .  -ts_monitor_draw_solution - Monitor solution graphically
563e4cdcaaSBarry Smith .  -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright> - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
573e4cdcaaSBarry Smith .  -ts_monitor_draw_error - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
5891b97e58SBarry Smith .  -ts_monitor_solution_binary <filename> - Save each solution to a binary file
59b3d3934dSBarry Smith .  -ts_monitor_solution_vtk <filename.vts> - Save each time step to a binary file, use filename-%%03D.vts
60b3d3934dSBarry Smith -  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
6191b97e58SBarry Smith 
6291b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
63bdad233fSMatthew Knepley 
64bdad233fSMatthew Knepley    Level: beginner
65bdad233fSMatthew Knepley 
66bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
67bdad233fSMatthew Knepley 
68a313700dSBarry Smith .seealso: TSGetType()
69bdad233fSMatthew Knepley @*/
707087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
71bdad233fSMatthew Knepley {
72bc952696SBarry Smith   PetscBool              opt,flg,tflg;
73dfbe8321SBarry Smith   PetscErrorCode         ierr;
74649052a6SBarry Smith   PetscViewer            monviewer;
75eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
76089b2837SJed Brown   SNES                   snes;
771c3436cfSJed Brown   TSAdapt                adapt;
7831748224SBarry Smith   PetscReal              time_step;
7949354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
80d1212d36SBarry Smith   char                   dir[16];
816991f827SBarry Smith   const char             *defaultType;
826991f827SBarry Smith   char                   typeName[256];
83bdad233fSMatthew Knepley 
84bdad233fSMatthew Knepley   PetscFunctionBegin;
850700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
863194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
876991f827SBarry Smith   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
886991f827SBarry Smith   else defaultType = TSEULER;
896991f827SBarry Smith 
906991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
916991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
926991f827SBarry Smith   if (opt) {
936991f827SBarry Smith     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
946991f827SBarry Smith   } else {
956991f827SBarry Smith     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
966991f827SBarry Smith   }
97bdad233fSMatthew Knepley 
98bdad233fSMatthew Knepley   /* Handle generic TS options */
99844594baSBarry Smith   if (ts->trajectory) tflg = PETSC_TRUE;
100844594baSBarry Smith   else tflg = PETSC_FALSE;
101920aabf2SBarry Smith   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
102bc952696SBarry Smith   if (tflg) {ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);}
103ef222394SBarry Smith   if (ts->adjoint_solve) tflg = PETSC_TRUE;
104ef222394SBarry Smith   else tflg = PETSC_FALSE;
105ef222394SBarry Smith   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
106ef222394SBarry Smith   if (flg) {
107ef222394SBarry Smith     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
108e87fd094SBarry Smith     ts->adjoint_solve = tflg;
109ef222394SBarry Smith   }
1100298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1110298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1120298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
11331748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
11431748224SBarry Smith   if (flg) {
11531748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
11631748224SBarry Smith   }
11749354f04SShri 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);
11849354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1190298fd71SBarry 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);
1200298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1210298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1220298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1230298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
124bdad233fSMatthew Knepley 
12556f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
12656f85f32SBarry Smith   {
12756f85f32SBarry Smith   PetscBool set;
12856f85f32SBarry Smith   flg  = PETSC_FALSE;
12956f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
13056f85f32SBarry Smith   if (set) {
13156f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
13256f85f32SBarry Smith   }
13356f85f32SBarry Smith   }
13456f85f32SBarry Smith #endif
13556f85f32SBarry Smith 
136bdad233fSMatthew Knepley   /* Monitor options */
137a6570f20SBarry Smith   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
138eabae89aSBarry Smith   if (flg) {
139ce94432eSBarry Smith     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
140649052a6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
141bdad233fSMatthew Knepley   }
1425180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1435180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1445180491cSLisandro Dalcin 
1454f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
146a7cc72afSBarry Smith   if (opt) {
1470b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1483923b477SBarry Smith     PetscInt       howoften = 1;
149a80ad3e0SBarry Smith 
1500298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
151ce94432eSBarry Smith     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1524f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
153b3603a34SBarry Smith   }
1544f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
155b3603a34SBarry Smith   if (opt) {
1560b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1573923b477SBarry Smith     PetscInt       howoften = 1;
158b3603a34SBarry Smith 
1590298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
16022d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1614f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
162bdad233fSMatthew Knepley   }
1634f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
164ef20d060SBarry Smith   if (opt) {
1650b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1663923b477SBarry Smith     PetscInt       howoften = 1;
167ef20d060SBarry Smith 
1680298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",howoften,&howoften,NULL);CHKERRQ(ierr);
16922d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1704f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
171ef20d060SBarry Smith   }
172201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
173201da799SBarry Smith   if (opt) {
174201da799SBarry Smith     TSMonitorLGCtx ctx;
175201da799SBarry Smith     PetscInt       howoften = 1;
176201da799SBarry Smith 
1770298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
17822d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
179201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
180201da799SBarry Smith   }
181201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&opt);CHKERRQ(ierr);
182201da799SBarry Smith   if (opt) {
183201da799SBarry Smith     TSMonitorLGCtx ctx;
184201da799SBarry Smith     PetscInt       howoften = 1;
185201da799SBarry Smith 
1860298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
18722d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
188201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
189201da799SBarry Smith   }
1908189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
1918189c53fSBarry Smith   if (opt) {
1928189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
1938189c53fSBarry Smith     PetscInt          howoften = 1;
1948189c53fSBarry Smith 
1950298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
19622d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1978189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
1988189c53fSBarry Smith   }
199ef20d060SBarry Smith   opt  = PETSC_FALSE;
2000dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
201a7cc72afSBarry Smith   if (opt) {
20283a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
20383a4ac43SBarry Smith     PetscInt         howoften = 1;
204a80ad3e0SBarry Smith 
2050298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
206ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
20783a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
208bdad233fSMatthew Knepley   }
209fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2102d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2112d5ee99bSBarry Smith   if (opt) {
2122d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2132d5ee99bSBarry Smith     PetscReal        bounds[4];
2142d5ee99bSBarry Smith     PetscInt         n = 4;
2152d5ee99bSBarry Smith     PetscDraw        draw;
2162d5ee99bSBarry Smith 
2172d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2182d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2192d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
2202d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2212d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
2224b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
2234b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
224f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2254b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
22607995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
2272d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2282d5ee99bSBarry Smith   }
2292d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2300dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2313a471f94SBarry Smith   if (opt) {
23283a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
23383a4ac43SBarry Smith     PetscInt         howoften = 1;
2343a471f94SBarry Smith 
2350298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
236ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
23783a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2383a471f94SBarry Smith   }
2393a471f94SBarry Smith   opt  = PETSC_FALSE;
24091b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
241fb1732b5SBarry Smith   if (flg) {
242fb1732b5SBarry Smith     PetscViewer ctx;
243fb1732b5SBarry Smith     if (monfilename[0]) {
244ce94432eSBarry Smith       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
245c2fbc07fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
246fb1732b5SBarry Smith     } else {
247ce94432eSBarry Smith       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
2480298fd71SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
249fb1732b5SBarry Smith     }
250fb1732b5SBarry Smith   }
251ed81e22dSJed Brown   opt  = PETSC_FALSE;
25291b97e58SBarry 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);
253ed81e22dSJed Brown   if (flg) {
254ed81e22dSJed Brown     const char *ptr,*ptr2;
255ed81e22dSJed Brown     char       *filetemplate;
256ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
257ed81e22dSJed Brown     /* Do some cursory validation of the input. */
258ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
259ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
260ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
261ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
262ce94432eSBarry 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");
263ed81e22dSJed Brown       if (ptr2) break;
264ed81e22dSJed Brown     }
265ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
266ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
267ed81e22dSJed Brown   }
268bdad233fSMatthew Knepley 
269d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
270d1212d36SBarry Smith   if (flg) {
271d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
272d1212d36SBarry Smith     int                  ray = 0;
273d1212d36SBarry Smith     DMDADirection        ddir;
274d1212d36SBarry Smith     DM                   da;
275d1212d36SBarry Smith     PetscMPIInt          rank;
276d1212d36SBarry Smith 
277ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
278d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
279d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
280ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
281d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
282d1212d36SBarry Smith 
283d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
284b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
285d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
286d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
287ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
288d1212d36SBarry Smith     if (!rank) {
289d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
290d1212d36SBarry Smith     }
29151b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
292d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
293d1212d36SBarry Smith   }
29451b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
29551b4a12fSMatthew G. Knepley   if (flg) {
29651b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
29751b4a12fSMatthew G. Knepley     int                 ray = 0;
29851b4a12fSMatthew G. Knepley     DMDADirection       ddir;
29951b4a12fSMatthew G. Knepley     DM                  da;
30051b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
301d1212d36SBarry Smith 
30251b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
30351b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
30451b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
30551b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
30651b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3071c3436cfSJed Brown 
30851b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
309b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
31051b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
31151b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
31251b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
31351b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
31451b4a12fSMatthew G. Knepley   }
315a7a1495cSBarry Smith 
316b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
317b3d3934dSBarry Smith   if (opt) {
318b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
319b3d3934dSBarry Smith 
320b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
321b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
322b3d3934dSBarry Smith   }
323b3d3934dSBarry Smith 
324847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
325847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
326847ff0e1SMatthew G. Knepley   if (flg) {
327847ff0e1SMatthew G. Knepley     DM   dm;
328847ff0e1SMatthew G. Knepley     DMTS tdm;
329847ff0e1SMatthew G. Knepley 
330847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
331847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
332847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
333847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
334847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
335847ff0e1SMatthew G. Knepley   }
336847ff0e1SMatthew G. Knepley 
3377781c08eSBarry Smith   /*
3387781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
3397781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
3407781c08eSBarry Smith   */
341552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
342e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
343d763cef2SBarry Smith 
344d763cef2SBarry Smith     /* Handle specific TS options */
345d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
3466991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
347d763cef2SBarry Smith   }
3486991f827SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
349d763cef2SBarry Smith 
350d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
351d763cef2SBarry Smith   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
352d763cef2SBarry Smith 
353bc952696SBarry Smith   if (ts->trajectory) {
354bc952696SBarry Smith     ierr = TSTrajectorySetFromOptions(ts->trajectory);CHKERRQ(ierr);
355bc952696SBarry Smith   }
356bc952696SBarry Smith 
3576991f827SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3586991f827SBarry Smith   if (snes) {
3596991f827SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
3606991f827SBarry Smith     ierr = SNESSetFromOptions(ts->snes);CHKERRQ(ierr);
361d763cef2SBarry Smith   }
362d763cef2SBarry Smith   PetscFunctionReturn(0);
363d763cef2SBarry Smith }
364d763cef2SBarry Smith 
365d763cef2SBarry Smith #undef __FUNCT__
366bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
367d2daff3dSHong Zhang /*@
368bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
369d2daff3dSHong Zhang 
370d2daff3dSHong Zhang    Collective on TS
371d2daff3dSHong Zhang 
372d2daff3dSHong Zhang    Input Parameters:
373bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
374bc952696SBarry Smith 
375d2daff3dSHong Zhang 
376d2daff3dSHong Zhang    Level: intermediate
377d2daff3dSHong Zhang 
378bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
379d2daff3dSHong Zhang 
380bc952696SBarry Smith .keywords: TS, set, checkpoint,
381d2daff3dSHong Zhang @*/
382bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
383d2daff3dSHong Zhang {
384bc952696SBarry Smith   PetscErrorCode ierr;
385bc952696SBarry Smith 
386d2daff3dSHong Zhang   PetscFunctionBegin;
387d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
388bc952696SBarry Smith   if (!ts->trajectory) {
389bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
390920aabf2SBarry Smith     ierr = TSTrajectorySetType(ts->trajectory,TSTRAJECTORYBASIC);CHKERRQ(ierr);
391bc952696SBarry Smith   }
392d2daff3dSHong Zhang   PetscFunctionReturn(0);
393d2daff3dSHong Zhang }
394d2daff3dSHong Zhang 
395a7a1495cSBarry Smith #undef __FUNCT__
396a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
397a7a1495cSBarry Smith /*@
398a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
399a7a1495cSBarry Smith       set with TSSetRHSJacobian().
400a7a1495cSBarry Smith 
401a7a1495cSBarry Smith    Collective on TS and Vec
402a7a1495cSBarry Smith 
403a7a1495cSBarry Smith    Input Parameters:
404316643e7SJed Brown +  ts - the TS context
405a7a1495cSBarry Smith .  t - current timestep
4060910c330SBarry Smith -  U - input vector
407a7a1495cSBarry Smith 
408a7a1495cSBarry Smith    Output Parameters:
409a7a1495cSBarry Smith +  A - Jacobian matrix
410a7a1495cSBarry Smith .  B - optional preconditioning matrix
411a7a1495cSBarry Smith -  flag - flag indicating matrix structure
412a7a1495cSBarry Smith 
413a7a1495cSBarry Smith    Notes:
414a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
415a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
416a7a1495cSBarry Smith 
41794b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
418a7a1495cSBarry Smith    flag parameter.
419a7a1495cSBarry Smith 
420a7a1495cSBarry Smith    Level: developer
421a7a1495cSBarry Smith 
422a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
423a7a1495cSBarry Smith 
42494b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
425a7a1495cSBarry Smith @*/
426d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
427a7a1495cSBarry Smith {
428dfbe8321SBarry Smith   PetscErrorCode ierr;
429270bf2e7SJed Brown   PetscObjectState Ustate;
43024989b8cSPeter Brune   DM             dm;
431942e3340SBarry Smith   DMTS           tsdm;
43224989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
43324989b8cSPeter Brune   void           *ctx;
43424989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
435a7a1495cSBarry Smith 
436a7a1495cSBarry Smith   PetscFunctionBegin;
4370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4380910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4390910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
44024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
441942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
44224989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4430298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
44459e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
4450910c330SBarry Smith   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate))) {
4460e4ef248SJed Brown     PetscFunctionReturn(0);
447f8ede8e7SJed Brown   }
448d90be118SSean Farley 
449ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
450d90be118SSean Farley 
451e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
45294ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
45394ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
45494ab13aaSBarry Smith     if (A != B) {
45594ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
45694ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
457e1244c69SJed Brown     }
458e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
459e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
460e1244c69SJed Brown   }
461e1244c69SJed Brown 
46224989b8cSPeter Brune   if (rhsjacobianfunc) {
46394ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
464a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
465d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
466a7a1495cSBarry Smith     PetscStackPop;
46794ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
468a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
46994ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
47094ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
471ef66eb69SBarry Smith   } else {
47294ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
47394ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
474ef66eb69SBarry Smith   }
4750e4ef248SJed Brown   ts->rhsjacobian.time       = t;
4760910c330SBarry Smith   ts->rhsjacobian.X          = U;
47759e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
478a7a1495cSBarry Smith   PetscFunctionReturn(0);
479a7a1495cSBarry Smith }
480a7a1495cSBarry Smith 
4814a2ae208SSatish Balay #undef __FUNCT__
4824a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
483316643e7SJed Brown /*@
484d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
485d763cef2SBarry Smith 
486316643e7SJed Brown    Collective on TS and Vec
487316643e7SJed Brown 
488316643e7SJed Brown    Input Parameters:
489316643e7SJed Brown +  ts - the TS context
490316643e7SJed Brown .  t - current time
4910910c330SBarry Smith -  U - state vector
492316643e7SJed Brown 
493316643e7SJed Brown    Output Parameter:
494316643e7SJed Brown .  y - right hand side
495316643e7SJed Brown 
496316643e7SJed Brown    Note:
497316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
498316643e7SJed Brown    is used internally within the nonlinear solvers.
499316643e7SJed Brown 
500316643e7SJed Brown    Level: developer
501316643e7SJed Brown 
502316643e7SJed Brown .keywords: TS, compute
503316643e7SJed Brown 
504316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
505316643e7SJed Brown @*/
5060910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
507d763cef2SBarry Smith {
508dfbe8321SBarry Smith   PetscErrorCode ierr;
50924989b8cSPeter Brune   TSRHSFunction  rhsfunction;
51024989b8cSPeter Brune   TSIFunction    ifunction;
51124989b8cSPeter Brune   void           *ctx;
51224989b8cSPeter Brune   DM             dm;
51324989b8cSPeter Brune 
514d763cef2SBarry Smith   PetscFunctionBegin;
5150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5160910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5170700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
51824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
51924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5200298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
521d763cef2SBarry Smith 
522ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
523d763cef2SBarry Smith 
5240910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
52524989b8cSPeter Brune   if (rhsfunction) {
526d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5270910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
528d763cef2SBarry Smith     PetscStackPop;
529214bc6a2SJed Brown   } else {
530214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
531b2cd27e8SJed Brown   }
53244a41b28SSean Farley 
5330910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
534d763cef2SBarry Smith   PetscFunctionReturn(0);
535d763cef2SBarry Smith }
536d763cef2SBarry Smith 
5374a2ae208SSatish Balay #undef __FUNCT__
538ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
539ef20d060SBarry Smith /*@
540ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
541ef20d060SBarry Smith 
542ef20d060SBarry Smith    Collective on TS and Vec
543ef20d060SBarry Smith 
544ef20d060SBarry Smith    Input Parameters:
545ef20d060SBarry Smith +  ts - the TS context
546ef20d060SBarry Smith -  t - current time
547ef20d060SBarry Smith 
548ef20d060SBarry Smith    Output Parameter:
5490910c330SBarry Smith .  U - the solution
550ef20d060SBarry Smith 
551ef20d060SBarry Smith    Note:
552ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
553ef20d060SBarry Smith    is used internally within the nonlinear solvers.
554ef20d060SBarry Smith 
555ef20d060SBarry Smith    Level: developer
556ef20d060SBarry Smith 
557ef20d060SBarry Smith .keywords: TS, compute
558ef20d060SBarry Smith 
559abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
560ef20d060SBarry Smith @*/
5610910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
562ef20d060SBarry Smith {
563ef20d060SBarry Smith   PetscErrorCode     ierr;
564ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
565ef20d060SBarry Smith   void               *ctx;
566ef20d060SBarry Smith   DM                 dm;
567ef20d060SBarry Smith 
568ef20d060SBarry Smith   PetscFunctionBegin;
569ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5700910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
571ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
572ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
573ef20d060SBarry Smith 
574ef20d060SBarry Smith   if (solutionfunction) {
5759b7cd975SBarry Smith     PetscStackPush("TS user solution function");
5760910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
577ef20d060SBarry Smith     PetscStackPop;
578ef20d060SBarry Smith   }
579ef20d060SBarry Smith   PetscFunctionReturn(0);
580ef20d060SBarry Smith }
5819b7cd975SBarry Smith #undef __FUNCT__
5829b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
5839b7cd975SBarry Smith /*@
5849b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
5859b7cd975SBarry Smith 
5869b7cd975SBarry Smith    Collective on TS and Vec
5879b7cd975SBarry Smith 
5889b7cd975SBarry Smith    Input Parameters:
5899b7cd975SBarry Smith +  ts - the TS context
5909b7cd975SBarry Smith -  t - current time
5919b7cd975SBarry Smith 
5929b7cd975SBarry Smith    Output Parameter:
5939b7cd975SBarry Smith .  U - the function value
5949b7cd975SBarry Smith 
5959b7cd975SBarry Smith    Note:
5969b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
5979b7cd975SBarry Smith    is used internally within the nonlinear solvers.
5989b7cd975SBarry Smith 
5999b7cd975SBarry Smith    Level: developer
6009b7cd975SBarry Smith 
6019b7cd975SBarry Smith .keywords: TS, compute
6029b7cd975SBarry Smith 
6039b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6049b7cd975SBarry Smith @*/
6059b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
6069b7cd975SBarry Smith {
6079b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
6089b7cd975SBarry Smith   void               *ctx;
6099b7cd975SBarry Smith   DM                 dm;
6109b7cd975SBarry Smith 
6119b7cd975SBarry Smith   PetscFunctionBegin;
6129b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6139b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6149b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6159b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6169b7cd975SBarry Smith 
6179b7cd975SBarry Smith   if (forcing) {
6189b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6199b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6209b7cd975SBarry Smith     PetscStackPop;
6219b7cd975SBarry Smith   }
6229b7cd975SBarry Smith   PetscFunctionReturn(0);
6239b7cd975SBarry Smith }
624ef20d060SBarry Smith 
625ef20d060SBarry Smith #undef __FUNCT__
626214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
627214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
628214bc6a2SJed Brown {
6292dd45cf8SJed Brown   Vec            F;
630214bc6a2SJed Brown   PetscErrorCode ierr;
631214bc6a2SJed Brown 
632214bc6a2SJed Brown   PetscFunctionBegin;
6330298fd71SBarry Smith   *Frhs = NULL;
6340298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
635214bc6a2SJed Brown   if (!ts->Frhs) {
6362dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
637214bc6a2SJed Brown   }
638214bc6a2SJed Brown   *Frhs = ts->Frhs;
639214bc6a2SJed Brown   PetscFunctionReturn(0);
640214bc6a2SJed Brown }
641214bc6a2SJed Brown 
642214bc6a2SJed Brown #undef __FUNCT__
643214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
644214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
645214bc6a2SJed Brown {
646214bc6a2SJed Brown   Mat            A,B;
6472dd45cf8SJed Brown   PetscErrorCode ierr;
648214bc6a2SJed Brown 
649214bc6a2SJed Brown   PetscFunctionBegin;
650c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
651c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6520298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
653214bc6a2SJed Brown   if (Arhs) {
654214bc6a2SJed Brown     if (!ts->Arhs) {
655214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
656214bc6a2SJed Brown     }
657214bc6a2SJed Brown     *Arhs = ts->Arhs;
658214bc6a2SJed Brown   }
659214bc6a2SJed Brown   if (Brhs) {
660214bc6a2SJed Brown     if (!ts->Brhs) {
661bdb70873SJed Brown       if (A != B) {
662214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
663bdb70873SJed Brown       } else {
664bdb70873SJed Brown         ts->Brhs = ts->Arhs;
665bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
666bdb70873SJed Brown       }
667214bc6a2SJed Brown     }
668214bc6a2SJed Brown     *Brhs = ts->Brhs;
669214bc6a2SJed Brown   }
670214bc6a2SJed Brown   PetscFunctionReturn(0);
671214bc6a2SJed Brown }
672214bc6a2SJed Brown 
673214bc6a2SJed Brown #undef __FUNCT__
674316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
675316643e7SJed Brown /*@
6760910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
677316643e7SJed Brown 
678316643e7SJed Brown    Collective on TS and Vec
679316643e7SJed Brown 
680316643e7SJed Brown    Input Parameters:
681316643e7SJed Brown +  ts - the TS context
682316643e7SJed Brown .  t - current time
6830910c330SBarry Smith .  U - state vector
6840910c330SBarry Smith .  Udot - time derivative of state vector
685214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
686316643e7SJed Brown 
687316643e7SJed Brown    Output Parameter:
688316643e7SJed Brown .  Y - right hand side
689316643e7SJed Brown 
690316643e7SJed Brown    Note:
691316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
692316643e7SJed Brown    is used internally within the nonlinear solvers.
693316643e7SJed Brown 
694316643e7SJed Brown    If the user did did not write their equations in implicit form, this
695316643e7SJed Brown    function recasts them in implicit form.
696316643e7SJed Brown 
697316643e7SJed Brown    Level: developer
698316643e7SJed Brown 
699316643e7SJed Brown .keywords: TS, compute
700316643e7SJed Brown 
701316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
702316643e7SJed Brown @*/
7030910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
704316643e7SJed Brown {
705316643e7SJed Brown   PetscErrorCode ierr;
70624989b8cSPeter Brune   TSIFunction    ifunction;
70724989b8cSPeter Brune   TSRHSFunction  rhsfunction;
70824989b8cSPeter Brune   void           *ctx;
70924989b8cSPeter Brune   DM             dm;
710316643e7SJed Brown 
711316643e7SJed Brown   PetscFunctionBegin;
7120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7130910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7140910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7150700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
716316643e7SJed Brown 
71724989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
71824989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7190298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
72024989b8cSPeter Brune 
721ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
722d90be118SSean Farley 
7230910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
72424989b8cSPeter Brune   if (ifunction) {
725316643e7SJed Brown     PetscStackPush("TS user implicit function");
7260910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
727316643e7SJed Brown     PetscStackPop;
728214bc6a2SJed Brown   }
729214bc6a2SJed Brown   if (imex) {
73024989b8cSPeter Brune     if (!ifunction) {
7310910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7322dd45cf8SJed Brown     }
73324989b8cSPeter Brune   } else if (rhsfunction) {
73424989b8cSPeter Brune     if (ifunction) {
735214bc6a2SJed Brown       Vec Frhs;
736214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7370910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
738214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7392dd45cf8SJed Brown     } else {
7400910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7410910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
742316643e7SJed Brown     }
7434a6899ffSJed Brown   }
7440910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
745316643e7SJed Brown   PetscFunctionReturn(0);
746316643e7SJed Brown }
747316643e7SJed Brown 
748316643e7SJed Brown #undef __FUNCT__
749316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
750316643e7SJed Brown /*@
751316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
752316643e7SJed Brown 
753316643e7SJed Brown    Collective on TS and Vec
754316643e7SJed Brown 
755316643e7SJed Brown    Input
756316643e7SJed Brown       Input Parameters:
757316643e7SJed Brown +  ts - the TS context
758316643e7SJed Brown .  t - current timestep
7590910c330SBarry Smith .  U - state vector
7600910c330SBarry Smith .  Udot - time derivative of state vector
761214bc6a2SJed Brown .  shift - shift to apply, see note below
762214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
763316643e7SJed Brown 
764316643e7SJed Brown    Output Parameters:
765316643e7SJed Brown +  A - Jacobian matrix
766316643e7SJed Brown .  B - optional preconditioning matrix
767316643e7SJed Brown -  flag - flag indicating matrix structure
768316643e7SJed Brown 
769316643e7SJed Brown    Notes:
7700910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
771316643e7SJed Brown 
7720910c330SBarry Smith    dF/dU + shift*dF/dUdot
773316643e7SJed Brown 
774316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
775316643e7SJed Brown    is used internally within the nonlinear solvers.
776316643e7SJed Brown 
777316643e7SJed Brown    Level: developer
778316643e7SJed Brown 
779316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
780316643e7SJed Brown 
781316643e7SJed Brown .seealso:  TSSetIJacobian()
78263495f91SJed Brown @*/
783d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
784316643e7SJed Brown {
785316643e7SJed Brown   PetscErrorCode ierr;
78624989b8cSPeter Brune   TSIJacobian    ijacobian;
78724989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
78824989b8cSPeter Brune   DM             dm;
78924989b8cSPeter Brune   void           *ctx;
790316643e7SJed Brown 
791316643e7SJed Brown   PetscFunctionBegin;
7920700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7930910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7940910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
795316643e7SJed Brown   PetscValidPointer(A,6);
79694ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
797316643e7SJed Brown   PetscValidPointer(B,7);
79894ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
79924989b8cSPeter Brune 
80024989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
80124989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8020298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
80324989b8cSPeter Brune 
804ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
805316643e7SJed Brown 
80694ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
80724989b8cSPeter Brune   if (ijacobian) {
808316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
809d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
810316643e7SJed Brown     PetscStackPop;
811214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
81294ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
81394ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8144a6899ffSJed Brown   }
815214bc6a2SJed Brown   if (imex) {
816b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
81794ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
81894ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
81994ab13aaSBarry Smith       if (A != B) {
82094ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
82194ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
822214bc6a2SJed Brown       }
823214bc6a2SJed Brown     }
824214bc6a2SJed Brown   } else {
825e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
826e1244c69SJed Brown     if (rhsjacobian) {
827bd373395SBarry Smith       if (ijacobian) {
828214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
829bd373395SBarry Smith       } else {
830bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
831214bc6a2SJed Brown       }
832d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
833e1244c69SJed Brown     }
83494ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
835e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
836e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
83794ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
83894ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
83994ab13aaSBarry Smith       if (A != B) {
84094ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
84194ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
842316643e7SJed Brown       }
843e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
844e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
845e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
84694ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
84794ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
84894ab13aaSBarry Smith         if (A != B) {
84994ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
85094ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
851214bc6a2SJed Brown         }
852316643e7SJed Brown       }
85394ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
85494ab13aaSBarry Smith       if (A != B) {
85594ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
856316643e7SJed Brown       }
857316643e7SJed Brown     }
858316643e7SJed Brown   }
85994ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
860316643e7SJed Brown   PetscFunctionReturn(0);
861316643e7SJed Brown }
862316643e7SJed Brown 
863316643e7SJed Brown #undef __FUNCT__
8644a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
865d763cef2SBarry Smith /*@C
866d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
867b5abc632SBarry Smith     where U_t = G(t,u).
868d763cef2SBarry Smith 
8693f9fe445SBarry Smith     Logically Collective on TS
870d763cef2SBarry Smith 
871d763cef2SBarry Smith     Input Parameters:
872d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8730298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
874d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
875d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
8760298fd71SBarry Smith           function evaluation routine (may be NULL)
877d763cef2SBarry Smith 
878d763cef2SBarry Smith     Calling sequence of func:
87987828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
880d763cef2SBarry Smith 
881d763cef2SBarry Smith +   t - current timestep
882d763cef2SBarry Smith .   u - input vector
883d763cef2SBarry Smith .   F - function vector
884d763cef2SBarry Smith -   ctx - [optional] user-defined function context
885d763cef2SBarry Smith 
886d763cef2SBarry Smith     Level: beginner
887d763cef2SBarry Smith 
8882bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
8892bbac0d3SBarry Smith 
890d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
891d763cef2SBarry Smith 
892ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
893d763cef2SBarry Smith @*/
894089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
895d763cef2SBarry Smith {
896089b2837SJed Brown   PetscErrorCode ierr;
897089b2837SJed Brown   SNES           snes;
8980298fd71SBarry Smith   Vec            ralloc = NULL;
89924989b8cSPeter Brune   DM             dm;
900d763cef2SBarry Smith 
901089b2837SJed Brown   PetscFunctionBegin;
9020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
903ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
90424989b8cSPeter Brune 
90524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
90624989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
907089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
908e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
909e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
910e856ceecSJed Brown     r    = ralloc;
911e856ceecSJed Brown   }
912089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
913e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
914d763cef2SBarry Smith   PetscFunctionReturn(0);
915d763cef2SBarry Smith }
916d763cef2SBarry Smith 
9174a2ae208SSatish Balay #undef __FUNCT__
918ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
919ef20d060SBarry Smith /*@C
920abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
921ef20d060SBarry Smith 
922ef20d060SBarry Smith     Logically Collective on TS
923ef20d060SBarry Smith 
924ef20d060SBarry Smith     Input Parameters:
925ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
926ef20d060SBarry Smith .   f - routine for evaluating the solution
927ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9280298fd71SBarry Smith           function evaluation routine (may be NULL)
929ef20d060SBarry Smith 
930ef20d060SBarry Smith     Calling sequence of func:
931ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
932ef20d060SBarry Smith 
933ef20d060SBarry Smith +   t - current timestep
934ef20d060SBarry Smith .   u - output vector
935ef20d060SBarry Smith -   ctx - [optional] user-defined function context
936ef20d060SBarry Smith 
937abd5a294SJed Brown     Notes:
938abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
939abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
940abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
941abd5a294SJed Brown 
9424f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
943abd5a294SJed Brown 
944ef20d060SBarry Smith     Level: beginner
945ef20d060SBarry Smith 
946ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
947ef20d060SBarry Smith 
9489b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
949ef20d060SBarry Smith @*/
950ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
951ef20d060SBarry Smith {
952ef20d060SBarry Smith   PetscErrorCode ierr;
953ef20d060SBarry Smith   DM             dm;
954ef20d060SBarry Smith 
955ef20d060SBarry Smith   PetscFunctionBegin;
956ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
957ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
958ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
959ef20d060SBarry Smith   PetscFunctionReturn(0);
960ef20d060SBarry Smith }
961ef20d060SBarry Smith 
962ef20d060SBarry Smith #undef __FUNCT__
9639b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9649b7cd975SBarry Smith /*@C
9659b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9669b7cd975SBarry Smith 
9679b7cd975SBarry Smith     Logically Collective on TS
9689b7cd975SBarry Smith 
9699b7cd975SBarry Smith     Input Parameters:
9709b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9719b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9729b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9730298fd71SBarry Smith           function evaluation routine (may be NULL)
9749b7cd975SBarry Smith 
9759b7cd975SBarry Smith     Calling sequence of func:
9769b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
9779b7cd975SBarry Smith 
9789b7cd975SBarry Smith +   t - current timestep
9799b7cd975SBarry Smith .   u - output vector
9809b7cd975SBarry Smith -   ctx - [optional] user-defined function context
9819b7cd975SBarry Smith 
9829b7cd975SBarry Smith     Notes:
9839b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
9849b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
9859b7cd975SBarry Smith 
9869b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
9879b7cd975SBarry Smith 
9889b7cd975SBarry Smith     Level: beginner
9899b7cd975SBarry Smith 
9909b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
9919b7cd975SBarry Smith 
9929b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
9939b7cd975SBarry Smith @*/
9949b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
9959b7cd975SBarry Smith {
9969b7cd975SBarry Smith   PetscErrorCode ierr;
9979b7cd975SBarry Smith   DM             dm;
9989b7cd975SBarry Smith 
9999b7cd975SBarry Smith   PetscFunctionBegin;
10009b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10019b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
10029b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
10039b7cd975SBarry Smith   PetscFunctionReturn(0);
10049b7cd975SBarry Smith }
10059b7cd975SBarry Smith 
10069b7cd975SBarry Smith #undef __FUNCT__
10074a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1008d763cef2SBarry Smith /*@C
1009f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1010b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1011d763cef2SBarry Smith 
10123f9fe445SBarry Smith    Logically Collective on TS
1013d763cef2SBarry Smith 
1014d763cef2SBarry Smith    Input Parameters:
1015d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1016e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1017e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1018d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1019d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10200298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1021d763cef2SBarry Smith 
1022f7ab8db6SBarry Smith    Calling sequence of f:
1023ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1024d763cef2SBarry Smith 
1025d763cef2SBarry Smith +  t - current timestep
1026d763cef2SBarry Smith .  u - input vector
1027e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1028e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1029d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1030d763cef2SBarry Smith 
1031d763cef2SBarry Smith 
1032d763cef2SBarry Smith    Level: beginner
1033d763cef2SBarry Smith 
1034d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1035d763cef2SBarry Smith 
1036ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1037d763cef2SBarry Smith 
1038d763cef2SBarry Smith @*/
1039e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1040d763cef2SBarry Smith {
1041277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1042089b2837SJed Brown   SNES           snes;
104324989b8cSPeter Brune   DM             dm;
104424989b8cSPeter Brune   TSIJacobian    ijacobian;
1045277b19d0SLisandro Dalcin 
1046d763cef2SBarry Smith   PetscFunctionBegin;
10470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1048e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1049e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1050e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1051e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1052d763cef2SBarry Smith 
105324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
105424989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1055e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1056e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1057e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1058e1244c69SJed Brown   }
10590298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1060089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10615f659677SPeter Brune   if (!ijacobian) {
1062e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10630e4ef248SJed Brown   }
1064e5d3d808SBarry Smith   if (Amat) {
1065e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10660e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1067bbd56ea5SKarl Rupp 
1068e5d3d808SBarry Smith     ts->Arhs = Amat;
10690e4ef248SJed Brown   }
1070e5d3d808SBarry Smith   if (Pmat) {
1071e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10720e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1073bbd56ea5SKarl Rupp 
1074e5d3d808SBarry Smith     ts->Brhs = Pmat;
10750e4ef248SJed Brown   }
1076d763cef2SBarry Smith   PetscFunctionReturn(0);
1077d763cef2SBarry Smith }
1078d763cef2SBarry Smith 
1079316643e7SJed Brown 
1080316643e7SJed Brown #undef __FUNCT__
1081316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1082316643e7SJed Brown /*@C
1083b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1084316643e7SJed Brown 
10853f9fe445SBarry Smith    Logically Collective on TS
1086316643e7SJed Brown 
1087316643e7SJed Brown    Input Parameters:
1088316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
10890298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1090316643e7SJed Brown .  f   - the function evaluation routine
10910298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1092316643e7SJed Brown 
1093316643e7SJed Brown    Calling sequence of f:
1094316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1095316643e7SJed Brown 
1096316643e7SJed Brown +  t   - time at step/stage being solved
1097316643e7SJed Brown .  u   - state vector
1098316643e7SJed Brown .  u_t - time derivative of state vector
1099316643e7SJed Brown .  F   - function vector
1100316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1101316643e7SJed Brown 
1102316643e7SJed Brown    Important:
11032bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1104316643e7SJed Brown 
1105316643e7SJed Brown    Level: beginner
1106316643e7SJed Brown 
1107316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1108316643e7SJed Brown 
1109d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1110316643e7SJed Brown @*/
1111089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1112316643e7SJed Brown {
1113089b2837SJed Brown   PetscErrorCode ierr;
1114089b2837SJed Brown   SNES           snes;
11150298fd71SBarry Smith   Vec            resalloc = NULL;
111624989b8cSPeter Brune   DM             dm;
1117316643e7SJed Brown 
1118316643e7SJed Brown   PetscFunctionBegin;
11190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1120ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
112124989b8cSPeter Brune 
112224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
112324989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
112424989b8cSPeter Brune 
1125089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1126e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1127e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1128e856ceecSJed Brown     res  = resalloc;
1129e856ceecSJed Brown   }
1130089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1131e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1132089b2837SJed Brown   PetscFunctionReturn(0);
1133089b2837SJed Brown }
1134089b2837SJed Brown 
1135089b2837SJed Brown #undef __FUNCT__
1136089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1137089b2837SJed Brown /*@C
1138089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1139089b2837SJed Brown 
1140089b2837SJed Brown    Not Collective
1141089b2837SJed Brown 
1142089b2837SJed Brown    Input Parameter:
1143089b2837SJed Brown .  ts - the TS context
1144089b2837SJed Brown 
1145089b2837SJed Brown    Output Parameter:
11460298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11470298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11480298fd71SBarry Smith -  ctx - the function context (or NULL)
1149089b2837SJed Brown 
1150089b2837SJed Brown    Level: advanced
1151089b2837SJed Brown 
1152089b2837SJed Brown .keywords: TS, nonlinear, get, function
1153089b2837SJed Brown 
1154089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1155089b2837SJed Brown @*/
1156089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1157089b2837SJed Brown {
1158089b2837SJed Brown   PetscErrorCode ierr;
1159089b2837SJed Brown   SNES           snes;
116024989b8cSPeter Brune   DM             dm;
1161089b2837SJed Brown 
1162089b2837SJed Brown   PetscFunctionBegin;
1163089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1164089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11650298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
116624989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
116724989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1168089b2837SJed Brown   PetscFunctionReturn(0);
1169089b2837SJed Brown }
1170089b2837SJed Brown 
1171089b2837SJed Brown #undef __FUNCT__
1172089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1173089b2837SJed Brown /*@C
1174089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1175089b2837SJed Brown 
1176089b2837SJed Brown    Not Collective
1177089b2837SJed Brown 
1178089b2837SJed Brown    Input Parameter:
1179089b2837SJed Brown .  ts - the TS context
1180089b2837SJed Brown 
1181089b2837SJed Brown    Output Parameter:
11820298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
11830298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
11840298fd71SBarry Smith -  ctx - the function context (or NULL)
1185089b2837SJed Brown 
1186089b2837SJed Brown    Level: advanced
1187089b2837SJed Brown 
1188089b2837SJed Brown .keywords: TS, nonlinear, get, function
1189089b2837SJed Brown 
11902bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1191089b2837SJed Brown @*/
1192089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1193089b2837SJed Brown {
1194089b2837SJed Brown   PetscErrorCode ierr;
1195089b2837SJed Brown   SNES           snes;
119624989b8cSPeter Brune   DM             dm;
1197089b2837SJed Brown 
1198089b2837SJed Brown   PetscFunctionBegin;
1199089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1200089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12010298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
120224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
120324989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1204316643e7SJed Brown   PetscFunctionReturn(0);
1205316643e7SJed Brown }
1206316643e7SJed Brown 
1207316643e7SJed Brown #undef __FUNCT__
1208316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1209316643e7SJed Brown /*@C
1210a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1211ae8867d6SBarry Smith         provided with TSSetIFunction().
1212316643e7SJed Brown 
12133f9fe445SBarry Smith    Logically Collective on TS
1214316643e7SJed Brown 
1215316643e7SJed Brown    Input Parameters:
1216316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1217e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1218e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1219316643e7SJed Brown .  f   - the Jacobian evaluation routine
12200298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1221316643e7SJed Brown 
1222316643e7SJed Brown    Calling sequence of f:
1223ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1224316643e7SJed Brown 
1225316643e7SJed Brown +  t    - time at step/stage being solved
12261b4a444bSJed Brown .  U    - state vector
12271b4a444bSJed Brown .  U_t  - time derivative of state vector
1228316643e7SJed Brown .  a    - shift
1229e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1230e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1231316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1232316643e7SJed Brown 
1233316643e7SJed Brown    Notes:
1234e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1235316643e7SJed Brown 
1236a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1237b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1238a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1239a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1240a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1241a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1242a4f0a591SBarry Smith 
1243316643e7SJed Brown    Level: beginner
1244316643e7SJed Brown 
1245316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1246316643e7SJed Brown 
1247ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1248316643e7SJed Brown 
1249316643e7SJed Brown @*/
1250e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1251316643e7SJed Brown {
1252316643e7SJed Brown   PetscErrorCode ierr;
1253089b2837SJed Brown   SNES           snes;
125424989b8cSPeter Brune   DM             dm;
1255316643e7SJed Brown 
1256316643e7SJed Brown   PetscFunctionBegin;
12570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1258e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1259e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1260e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1261e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
126224989b8cSPeter Brune 
126324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
126424989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
126524989b8cSPeter Brune 
1266089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1267e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1268316643e7SJed Brown   PetscFunctionReturn(0);
1269316643e7SJed Brown }
1270316643e7SJed Brown 
12714a2ae208SSatish Balay #undef __FUNCT__
1272e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1273e1244c69SJed Brown /*@
1274e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1275e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1276e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1277e1244c69SJed Brown    not been changed by the TS.
1278e1244c69SJed Brown 
1279e1244c69SJed Brown    Logically Collective
1280e1244c69SJed Brown 
1281e1244c69SJed Brown    Input Arguments:
1282e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1283e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1284e1244c69SJed Brown 
1285e1244c69SJed Brown    Level: intermediate
1286e1244c69SJed Brown 
1287e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1288e1244c69SJed Brown @*/
1289e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1290e1244c69SJed Brown {
1291e1244c69SJed Brown   PetscFunctionBegin;
1292e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1293e1244c69SJed Brown   PetscFunctionReturn(0);
1294e1244c69SJed Brown }
1295e1244c69SJed Brown 
1296e1244c69SJed Brown #undef __FUNCT__
129755849f57SBarry Smith #define __FUNCT__ "TSLoad"
129855849f57SBarry Smith /*@C
129955849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
130055849f57SBarry Smith 
130155849f57SBarry Smith   Collective on PetscViewer
130255849f57SBarry Smith 
130355849f57SBarry Smith   Input Parameters:
130455849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
130555849f57SBarry Smith            some related function before a call to TSLoad().
130655849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
130755849f57SBarry Smith 
130855849f57SBarry Smith    Level: intermediate
130955849f57SBarry Smith 
131055849f57SBarry Smith   Notes:
131155849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
131255849f57SBarry Smith 
131355849f57SBarry Smith   Notes for advanced users:
131455849f57SBarry Smith   Most users should not need to know the details of the binary storage
131555849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
131655849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
131755849f57SBarry Smith   format is
131855849f57SBarry Smith .vb
131955849f57SBarry Smith      has not yet been determined
132055849f57SBarry Smith .ve
132155849f57SBarry Smith 
132255849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
132355849f57SBarry Smith @*/
1324f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
132555849f57SBarry Smith {
132655849f57SBarry Smith   PetscErrorCode ierr;
132755849f57SBarry Smith   PetscBool      isbinary;
132855849f57SBarry Smith   PetscInt       classid;
132955849f57SBarry Smith   char           type[256];
13302d53ad75SBarry Smith   DMTS           sdm;
1331ad6bc421SBarry Smith   DM             dm;
133255849f57SBarry Smith 
133355849f57SBarry Smith   PetscFunctionBegin;
1334f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
133555849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
133655849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
133755849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
133855849f57SBarry Smith 
1339060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1340ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1341060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1342f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1343f2c2a1b9SBarry Smith   if (ts->ops->load) {
1344f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1345f2c2a1b9SBarry Smith   }
1346ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1347ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1348ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1349f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1350f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13512d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13522d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
135355849f57SBarry Smith   PetscFunctionReturn(0);
135455849f57SBarry Smith }
135555849f57SBarry Smith 
13569804daf3SBarry Smith #include <petscdraw.h>
1357e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1358e04113cfSBarry Smith #include <petscviewersaws.h>
1359f05ece33SBarry Smith #endif
136055849f57SBarry Smith #undef __FUNCT__
13614a2ae208SSatish Balay #define __FUNCT__ "TSView"
13627e2c5f70SBarry Smith /*@C
1363d763cef2SBarry Smith     TSView - Prints the TS data structure.
1364d763cef2SBarry Smith 
13654c49b128SBarry Smith     Collective on TS
1366d763cef2SBarry Smith 
1367d763cef2SBarry Smith     Input Parameters:
1368d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1369d763cef2SBarry Smith -   viewer - visualization context
1370d763cef2SBarry Smith 
1371d763cef2SBarry Smith     Options Database Key:
1372d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1373d763cef2SBarry Smith 
1374d763cef2SBarry Smith     Notes:
1375d763cef2SBarry Smith     The available visualization contexts include
1376b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1377b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1378d763cef2SBarry Smith          output where only the first processor opens
1379d763cef2SBarry Smith          the file.  All other processors send their
1380d763cef2SBarry Smith          data to the first processor to print.
1381d763cef2SBarry Smith 
1382d763cef2SBarry Smith     The user can open an alternative visualization context with
1383b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1384d763cef2SBarry Smith 
1385d763cef2SBarry Smith     Level: beginner
1386d763cef2SBarry Smith 
1387d763cef2SBarry Smith .keywords: TS, timestep, view
1388d763cef2SBarry Smith 
1389b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1390d763cef2SBarry Smith @*/
13917087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1392d763cef2SBarry Smith {
1393dfbe8321SBarry Smith   PetscErrorCode ierr;
139419fd82e9SBarry Smith   TSType         type;
13952b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
13962d53ad75SBarry Smith   DMTS           sdm;
1397e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1398536b137fSBarry Smith   PetscBool      issaws;
1399f05ece33SBarry Smith #endif
1400d763cef2SBarry Smith 
1401d763cef2SBarry Smith   PetscFunctionBegin;
14020700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14033050cee2SBarry Smith   if (!viewer) {
1404ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
14053050cee2SBarry Smith   }
14060700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1407c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1408fd16b177SBarry Smith 
1409251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1410251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
141155849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
14122b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1413e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1414536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1415f05ece33SBarry Smith #endif
141632077d6dSBarry Smith   if (iascii) {
1417dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
141877431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14197c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1420d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14215ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1422c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1423d763cef2SBarry Smith     }
14245ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1425193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14262d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14272d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1428d52bd9f3SBarry Smith     if (ts->ops->view) {
1429d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1430d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1431d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1432d52bd9f3SBarry Smith     }
14330f5bd95cSBarry Smith   } else if (isstring) {
1434a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1435b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
143655849f57SBarry Smith   } else if (isbinary) {
143755849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
143855849f57SBarry Smith     MPI_Comm    comm;
143955849f57SBarry Smith     PetscMPIInt rank;
144055849f57SBarry Smith     char        type[256];
144155849f57SBarry Smith 
144255849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
144355849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
144455849f57SBarry Smith     if (!rank) {
144555849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
144655849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
144755849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
144855849f57SBarry Smith     }
144955849f57SBarry Smith     if (ts->ops->view) {
145055849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
145155849f57SBarry Smith     }
1452f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1453f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14542d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14552d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14562b0a91c0SBarry Smith   } else if (isdraw) {
14572b0a91c0SBarry Smith     PetscDraw draw;
14582b0a91c0SBarry Smith     char      str[36];
145989fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14602b0a91c0SBarry Smith 
14612b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14622b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14632b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14642b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
146551fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
146689fd9fafSBarry Smith     bottom = y - h;
14672b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
14682b0a91c0SBarry Smith     if (ts->ops->view) {
14692b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14702b0a91c0SBarry Smith     }
14712b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1472e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1473536b137fSBarry Smith   } else if (issaws) {
1474d45a07a7SBarry Smith     PetscMPIInt rank;
14752657e9d9SBarry Smith     const char  *name;
14762657e9d9SBarry Smith 
14772657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1478d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1479d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1480d45a07a7SBarry Smith       char       dir[1024];
1481d45a07a7SBarry Smith 
1482e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1483a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
14842657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
14852657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
14862657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1487d763cef2SBarry Smith     }
14880acecf5bSBarry Smith     if (ts->ops->view) {
14890acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
14900acecf5bSBarry Smith     }
1491f05ece33SBarry Smith #endif
1492f05ece33SBarry Smith   }
1493f05ece33SBarry Smith 
1494b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1495251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1496b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1497d763cef2SBarry Smith   PetscFunctionReturn(0);
1498d763cef2SBarry Smith }
1499d763cef2SBarry Smith 
1500d763cef2SBarry Smith 
15014a2ae208SSatish Balay #undef __FUNCT__
15024a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1503b07ff414SBarry Smith /*@
1504d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1505d763cef2SBarry Smith    the timesteppers.
1506d763cef2SBarry Smith 
15073f9fe445SBarry Smith    Logically Collective on TS
1508d763cef2SBarry Smith 
1509d763cef2SBarry Smith    Input Parameters:
1510d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1511d763cef2SBarry Smith -  usrP - optional user context
1512d763cef2SBarry Smith 
1513d763cef2SBarry Smith    Level: intermediate
1514d763cef2SBarry Smith 
1515d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1516d763cef2SBarry Smith 
1517d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1518d763cef2SBarry Smith @*/
15197087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1520d763cef2SBarry Smith {
1521d763cef2SBarry Smith   PetscFunctionBegin;
15220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1523d763cef2SBarry Smith   ts->user = usrP;
1524d763cef2SBarry Smith   PetscFunctionReturn(0);
1525d763cef2SBarry Smith }
1526d763cef2SBarry Smith 
15274a2ae208SSatish Balay #undef __FUNCT__
15284a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1529b07ff414SBarry Smith /*@
1530d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1531d763cef2SBarry Smith     timestepper.
1532d763cef2SBarry Smith 
1533d763cef2SBarry Smith     Not Collective
1534d763cef2SBarry Smith 
1535d763cef2SBarry Smith     Input Parameter:
1536d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1537d763cef2SBarry Smith 
1538d763cef2SBarry Smith     Output Parameter:
1539d763cef2SBarry Smith .   usrP - user context
1540d763cef2SBarry Smith 
1541d763cef2SBarry Smith     Level: intermediate
1542d763cef2SBarry Smith 
1543d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1544d763cef2SBarry Smith 
1545d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1546d763cef2SBarry Smith @*/
1547e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1548d763cef2SBarry Smith {
1549d763cef2SBarry Smith   PetscFunctionBegin;
15500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1551e71120c6SJed Brown   *(void**)usrP = ts->user;
1552d763cef2SBarry Smith   PetscFunctionReturn(0);
1553d763cef2SBarry Smith }
1554d763cef2SBarry Smith 
15554a2ae208SSatish Balay #undef __FUNCT__
15564a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1557d763cef2SBarry Smith /*@
1558b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1559d763cef2SBarry Smith 
1560d763cef2SBarry Smith    Not Collective
1561d763cef2SBarry Smith 
1562d763cef2SBarry Smith    Input Parameter:
1563d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1564d763cef2SBarry Smith 
1565d763cef2SBarry Smith    Output Parameter:
1566b8123daeSJed Brown .  iter - number of steps completed so far
1567d763cef2SBarry Smith 
1568d763cef2SBarry Smith    Level: intermediate
1569d763cef2SBarry Smith 
1570d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
15719be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1572d763cef2SBarry Smith @*/
15737087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1574d763cef2SBarry Smith {
1575d763cef2SBarry Smith   PetscFunctionBegin;
15760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
15774482741eSBarry Smith   PetscValidIntPointer(iter,2);
1578d763cef2SBarry Smith   *iter = ts->steps;
1579d763cef2SBarry Smith   PetscFunctionReturn(0);
1580d763cef2SBarry Smith }
1581d763cef2SBarry Smith 
15824a2ae208SSatish Balay #undef __FUNCT__
15834a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1584d763cef2SBarry Smith /*@
1585d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1586d763cef2SBarry Smith    as well as the initial time.
1587d763cef2SBarry Smith 
15883f9fe445SBarry Smith    Logically Collective on TS
1589d763cef2SBarry Smith 
1590d763cef2SBarry Smith    Input Parameters:
1591d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1592d763cef2SBarry Smith .  initial_time - the initial time
1593d763cef2SBarry Smith -  time_step - the size of the timestep
1594d763cef2SBarry Smith 
1595d763cef2SBarry Smith    Level: intermediate
1596d763cef2SBarry Smith 
1597d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1598d763cef2SBarry Smith 
1599d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1600d763cef2SBarry Smith @*/
16017087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1602d763cef2SBarry Smith {
1603e144a568SJed Brown   PetscErrorCode ierr;
1604e144a568SJed Brown 
1605d763cef2SBarry Smith   PetscFunctionBegin;
16060700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1607e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1608d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1609d763cef2SBarry Smith   PetscFunctionReturn(0);
1610d763cef2SBarry Smith }
1611d763cef2SBarry Smith 
16124a2ae208SSatish Balay #undef __FUNCT__
16134a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1614d763cef2SBarry Smith /*@
1615d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1616d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1617d763cef2SBarry Smith 
16183f9fe445SBarry Smith    Logically Collective on TS
1619d763cef2SBarry Smith 
1620d763cef2SBarry Smith    Input Parameters:
1621d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1622d763cef2SBarry Smith -  time_step - the size of the timestep
1623d763cef2SBarry Smith 
1624d763cef2SBarry Smith    Level: intermediate
1625d763cef2SBarry Smith 
1626d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1627d763cef2SBarry Smith 
1628d763cef2SBarry Smith .keywords: TS, set, timestep
1629d763cef2SBarry Smith @*/
16307087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1631d763cef2SBarry Smith {
1632d763cef2SBarry Smith   PetscFunctionBegin;
16330700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1634c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1635d763cef2SBarry Smith   ts->time_step      = time_step;
163631748224SBarry Smith   ts->time_step_orig = time_step;
1637d763cef2SBarry Smith   PetscFunctionReturn(0);
1638d763cef2SBarry Smith }
1639d763cef2SBarry Smith 
16404a2ae208SSatish Balay #undef __FUNCT__
1641a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1642a43b19c4SJed Brown /*@
164349354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
164449354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
164549354f04SShri Abhyankar      or just return at the final time TS computed.
1646a43b19c4SJed Brown 
1647a43b19c4SJed Brown   Logically Collective on TS
1648a43b19c4SJed Brown 
1649a43b19c4SJed Brown    Input Parameter:
1650a43b19c4SJed Brown +   ts - the time-step context
165149354f04SShri Abhyankar -   eftopt - exact final time option
1652a43b19c4SJed Brown 
1653a43b19c4SJed Brown    Level: beginner
1654a43b19c4SJed Brown 
1655a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1656a43b19c4SJed Brown @*/
165749354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1658a43b19c4SJed Brown {
1659a43b19c4SJed Brown   PetscFunctionBegin;
1660a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
166149354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
166249354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1663a43b19c4SJed Brown   PetscFunctionReturn(0);
1664a43b19c4SJed Brown }
1665a43b19c4SJed Brown 
1666a43b19c4SJed Brown #undef __FUNCT__
16674a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1668d763cef2SBarry Smith /*@
1669d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1670d763cef2SBarry Smith 
1671d763cef2SBarry Smith    Not Collective
1672d763cef2SBarry Smith 
1673d763cef2SBarry Smith    Input Parameter:
1674d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1675d763cef2SBarry Smith 
1676d763cef2SBarry Smith    Output Parameter:
1677d763cef2SBarry Smith .  dt - the current timestep size
1678d763cef2SBarry Smith 
1679d763cef2SBarry Smith    Level: intermediate
1680d763cef2SBarry Smith 
1681d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1682d763cef2SBarry Smith 
1683d763cef2SBarry Smith .keywords: TS, get, timestep
1684d763cef2SBarry Smith @*/
16857087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1686d763cef2SBarry Smith {
1687d763cef2SBarry Smith   PetscFunctionBegin;
16880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1689f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1690d763cef2SBarry Smith   *dt = ts->time_step;
1691d763cef2SBarry Smith   PetscFunctionReturn(0);
1692d763cef2SBarry Smith }
1693d763cef2SBarry Smith 
16944a2ae208SSatish Balay #undef __FUNCT__
16954a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1696d8e5e3e6SSatish Balay /*@
1697d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1698d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1699d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1700d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1701d763cef2SBarry Smith 
1702d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1703d763cef2SBarry Smith 
1704d763cef2SBarry Smith    Input Parameter:
1705d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1706d763cef2SBarry Smith 
1707d763cef2SBarry Smith    Output Parameter:
1708d763cef2SBarry Smith .  v - the vector containing the solution
1709d763cef2SBarry Smith 
1710d763cef2SBarry Smith    Level: intermediate
1711d763cef2SBarry Smith 
1712d763cef2SBarry Smith .seealso: TSGetTimeStep()
1713d763cef2SBarry Smith 
1714d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1715d763cef2SBarry Smith @*/
17167087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1717d763cef2SBarry Smith {
1718d763cef2SBarry Smith   PetscFunctionBegin;
17190700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17204482741eSBarry Smith   PetscValidPointer(v,2);
17218737fe31SLisandro Dalcin   *v = ts->vec_sol;
1722d763cef2SBarry Smith   PetscFunctionReturn(0);
1723d763cef2SBarry Smith }
1724d763cef2SBarry Smith 
1725c235aa8dSHong Zhang #undef __FUNCT__
1726dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
1727c235aa8dSHong Zhang /*@
1728dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
1729c235aa8dSHong Zhang 
1730c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1731c235aa8dSHong Zhang 
1732c235aa8dSHong Zhang    Input Parameter:
1733c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1734c235aa8dSHong Zhang 
1735c235aa8dSHong Zhang    Output Parameter:
1736abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1737abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1738c235aa8dSHong Zhang 
1739c235aa8dSHong Zhang    Level: intermediate
1740c235aa8dSHong Zhang 
1741c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1742c235aa8dSHong Zhang 
1743c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1744c235aa8dSHong Zhang @*/
1745dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1746c235aa8dSHong Zhang {
1747c235aa8dSHong Zhang   PetscFunctionBegin;
1748c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1749abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1750abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1751abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1752c235aa8dSHong Zhang   PetscFunctionReturn(0);
1753c235aa8dSHong Zhang }
1754c235aa8dSHong Zhang 
1755bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17564a2ae208SSatish Balay #undef __FUNCT__
1757bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1758d8e5e3e6SSatish Balay /*@
1759bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1760d763cef2SBarry Smith 
1761bdad233fSMatthew Knepley   Not collective
1762d763cef2SBarry Smith 
1763bdad233fSMatthew Knepley   Input Parameters:
1764bdad233fSMatthew Knepley + ts   - The TS
1765bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1766d763cef2SBarry Smith .vb
17670910c330SBarry Smith          U_t - A U = 0      (linear)
17680910c330SBarry Smith          U_t - A(t) U = 0   (linear)
17690910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1770d763cef2SBarry Smith .ve
1771d763cef2SBarry Smith 
1772d763cef2SBarry Smith    Level: beginner
1773d763cef2SBarry Smith 
1774bdad233fSMatthew Knepley .keywords: TS, problem type
1775bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1776d763cef2SBarry Smith @*/
17777087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1778a7cc72afSBarry Smith {
17799e2a6581SJed Brown   PetscErrorCode ierr;
17809e2a6581SJed Brown 
1781d763cef2SBarry Smith   PetscFunctionBegin;
17820700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1783bdad233fSMatthew Knepley   ts->problem_type = type;
17849e2a6581SJed Brown   if (type == TS_LINEAR) {
17859e2a6581SJed Brown     SNES snes;
17869e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
17879e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
17889e2a6581SJed Brown   }
1789d763cef2SBarry Smith   PetscFunctionReturn(0);
1790d763cef2SBarry Smith }
1791d763cef2SBarry Smith 
1792bdad233fSMatthew Knepley #undef __FUNCT__
1793bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1794bdad233fSMatthew Knepley /*@C
1795bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1796bdad233fSMatthew Knepley 
1797bdad233fSMatthew Knepley   Not collective
1798bdad233fSMatthew Knepley 
1799bdad233fSMatthew Knepley   Input Parameter:
1800bdad233fSMatthew Knepley . ts   - The TS
1801bdad233fSMatthew Knepley 
1802bdad233fSMatthew Knepley   Output Parameter:
1803bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1804bdad233fSMatthew Knepley .vb
1805089b2837SJed Brown          M U_t = A U
1806089b2837SJed Brown          M(t) U_t = A(t) U
1807b5abc632SBarry Smith          F(t,U,U_t)
1808bdad233fSMatthew Knepley .ve
1809bdad233fSMatthew Knepley 
1810bdad233fSMatthew Knepley    Level: beginner
1811bdad233fSMatthew Knepley 
1812bdad233fSMatthew Knepley .keywords: TS, problem type
1813bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1814bdad233fSMatthew Knepley @*/
18157087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1816a7cc72afSBarry Smith {
1817bdad233fSMatthew Knepley   PetscFunctionBegin;
18180700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18194482741eSBarry Smith   PetscValidIntPointer(type,2);
1820bdad233fSMatthew Knepley   *type = ts->problem_type;
1821bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1822bdad233fSMatthew Knepley }
1823d763cef2SBarry Smith 
18244a2ae208SSatish Balay #undef __FUNCT__
18254a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1826d763cef2SBarry Smith /*@
1827d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1828d763cef2SBarry Smith    of a timestepper.
1829d763cef2SBarry Smith 
1830d763cef2SBarry Smith    Collective on TS
1831d763cef2SBarry Smith 
1832d763cef2SBarry Smith    Input Parameter:
1833d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1834d763cef2SBarry Smith 
1835d763cef2SBarry Smith    Notes:
1836d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1837d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1838d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1839d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1840d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1841d763cef2SBarry Smith 
1842d763cef2SBarry Smith    Level: advanced
1843d763cef2SBarry Smith 
1844d763cef2SBarry Smith .keywords: TS, timestep, setup
1845d763cef2SBarry Smith 
1846d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1847d763cef2SBarry Smith @*/
18487087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1849d763cef2SBarry Smith {
1850dfbe8321SBarry Smith   PetscErrorCode ierr;
18516c6b9e74SPeter Brune   DM             dm;
18526c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1853d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18546c6b9e74SPeter Brune   TSIJacobian    ijac;
18556c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1856d763cef2SBarry Smith 
1857d763cef2SBarry Smith   PetscFunctionBegin;
18580700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1859277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1860277b19d0SLisandro Dalcin 
18612c18e0fdSBarry Smith   ts->total_steps = 0;
18627adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
18639596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1864d763cef2SBarry Smith   }
1865277b19d0SLisandro Dalcin 
1866277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1867277b19d0SLisandro Dalcin 
18681c3436cfSJed Brown 
1869552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
1870277b19d0SLisandro Dalcin 
1871e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1872e1244c69SJed Brown     Mat Amat,Pmat;
1873e1244c69SJed Brown     SNES snes;
1874e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1875e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1876e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1877e1244c69SJed Brown      * have displaced the RHS matrix */
1878e1244c69SJed Brown     if (Amat == ts->Arhs) {
1879e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1880e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1881e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1882e1244c69SJed Brown     }
1883e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1884e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1885e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1886e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1887e1244c69SJed Brown     }
1888e1244c69SJed Brown   }
1889277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1890000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1891277b19d0SLisandro Dalcin   }
1892277b19d0SLisandro Dalcin 
18936c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
18946c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
18956c6b9e74SPeter Brune    */
18966c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
18970298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
18986c6b9e74SPeter Brune   if (!func) {
18996c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
19006c6b9e74SPeter Brune   }
19016c6b9e74SPeter 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.
19026c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
19036c6b9e74SPeter Brune    */
19040298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
19050298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
19060298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
19076c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
19086c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
19096c6b9e74SPeter Brune   }
1910277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1911277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1912277b19d0SLisandro Dalcin }
1913277b19d0SLisandro Dalcin 
1914277b19d0SLisandro Dalcin #undef __FUNCT__
1915f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
1916f6a906c0SBarry Smith /*@
1917f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
1918f6a906c0SBarry Smith    of an adjoint solver
1919f6a906c0SBarry Smith 
1920f6a906c0SBarry Smith    Collective on TS
1921f6a906c0SBarry Smith 
1922f6a906c0SBarry Smith    Input Parameter:
1923f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
1924f6a906c0SBarry Smith 
1925f6a906c0SBarry Smith    Notes:
1926f6a906c0SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1927f6a906c0SBarry Smith    TSSetUp(), since these actions will automatically occur during
1928f6a906c0SBarry Smith    the call to TSStep().  However, if one wishes to control this
1929f6a906c0SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1930f6a906c0SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1931f6a906c0SBarry Smith 
1932f6a906c0SBarry Smith    Level: advanced
1933f6a906c0SBarry Smith 
1934f6a906c0SBarry Smith .keywords: TS, timestep, setup
1935f6a906c0SBarry Smith 
1936f6a906c0SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1937f6a906c0SBarry Smith @*/
1938f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
1939f6a906c0SBarry Smith {
1940f6a906c0SBarry Smith   PetscErrorCode ierr;
1941f6a906c0SBarry Smith 
1942f6a906c0SBarry Smith   PetscFunctionBegin;
1943f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1944f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
1945dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
1946d8151eeaSBarry Smith 
1947d8151eeaSBarry Smith   ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1948d8151eeaSBarry Smith   if (ts->vecs_sensip){
1949d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1950d8151eeaSBarry Smith   }
1951d8151eeaSBarry Smith 
195242f2b339SBarry Smith   if (ts->ops->adjointsetup) {
195342f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
1954f6a906c0SBarry Smith   }
1955f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
1956f6a906c0SBarry Smith   PetscFunctionReturn(0);
1957f6a906c0SBarry Smith }
1958f6a906c0SBarry Smith 
1959f6a906c0SBarry Smith #undef __FUNCT__
1960277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1961277b19d0SLisandro Dalcin /*@
1962277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1963277b19d0SLisandro Dalcin 
1964277b19d0SLisandro Dalcin    Collective on TS
1965277b19d0SLisandro Dalcin 
1966277b19d0SLisandro Dalcin    Input Parameter:
1967277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
1968277b19d0SLisandro Dalcin 
1969277b19d0SLisandro Dalcin    Level: beginner
1970277b19d0SLisandro Dalcin 
1971277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
1972277b19d0SLisandro Dalcin 
1973277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
1974277b19d0SLisandro Dalcin @*/
1975277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
1976277b19d0SLisandro Dalcin {
1977277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1978277b19d0SLisandro Dalcin 
1979277b19d0SLisandro Dalcin   PetscFunctionBegin;
1980277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1981b18ea86cSHong Zhang 
1982277b19d0SLisandro Dalcin   if (ts->ops->reset) {
1983277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
1984277b19d0SLisandro Dalcin   }
1985277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
1986e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
1987bbd56ea5SKarl Rupp 
19884e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
19894e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1990214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
19916bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
1992e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
1993e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
199438637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
1995bbd56ea5SKarl Rupp 
1996d8151eeaSBarry Smith   ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1997d8151eeaSBarry Smith   if (ts->vecs_drdp){
1998d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1999d8151eeaSBarry Smith   }
2000d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2001d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2002ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
20032c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
200436eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2005277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2006d763cef2SBarry Smith   PetscFunctionReturn(0);
2007d763cef2SBarry Smith }
2008d763cef2SBarry Smith 
20094a2ae208SSatish Balay #undef __FUNCT__
20104a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2011d8e5e3e6SSatish Balay /*@
2012d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2013d763cef2SBarry Smith    with TSCreate().
2014d763cef2SBarry Smith 
2015d763cef2SBarry Smith    Collective on TS
2016d763cef2SBarry Smith 
2017d763cef2SBarry Smith    Input Parameter:
2018d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2019d763cef2SBarry Smith 
2020d763cef2SBarry Smith    Level: beginner
2021d763cef2SBarry Smith 
2022d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2023d763cef2SBarry Smith 
2024d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2025d763cef2SBarry Smith @*/
20266bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2027d763cef2SBarry Smith {
20286849ba73SBarry Smith   PetscErrorCode ierr;
2029d763cef2SBarry Smith 
2030d763cef2SBarry Smith   PetscFunctionBegin;
20316bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
20326bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
20336bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2034d763cef2SBarry Smith 
20356bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2036277b19d0SLisandro Dalcin 
2037e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2038e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20396bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20406d4c513bSLisandro Dalcin 
2041bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2042bc952696SBarry Smith 
204384df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2044aeb4809dSShri Abhyankar   if ((*ts)->event) {
2045aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2046aeb4809dSShri Abhyankar   }
20476bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20486bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20496bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20506d4c513bSLisandro Dalcin 
2051a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2052d763cef2SBarry Smith   PetscFunctionReturn(0);
2053d763cef2SBarry Smith }
2054d763cef2SBarry Smith 
20554a2ae208SSatish Balay #undef __FUNCT__
20564a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2057d8e5e3e6SSatish Balay /*@
2058d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2059d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2060d763cef2SBarry Smith 
2061d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2062d763cef2SBarry Smith 
2063d763cef2SBarry Smith    Input Parameter:
2064d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2065d763cef2SBarry Smith 
2066d763cef2SBarry Smith    Output Parameter:
2067d763cef2SBarry Smith .  snes - the nonlinear solver context
2068d763cef2SBarry Smith 
2069d763cef2SBarry Smith    Notes:
2070d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2071d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
207294b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2073d763cef2SBarry Smith 
2074d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
20750298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2076d763cef2SBarry Smith 
2077d763cef2SBarry Smith    Level: beginner
2078d763cef2SBarry Smith 
2079d763cef2SBarry Smith .keywords: timestep, get, SNES
2080d763cef2SBarry Smith @*/
20817087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2082d763cef2SBarry Smith {
2083d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2084d372ba47SLisandro Dalcin 
2085d763cef2SBarry Smith   PetscFunctionBegin;
20860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
20874482741eSBarry Smith   PetscValidPointer(snes,2);
2088d372ba47SLisandro Dalcin   if (!ts->snes) {
2089ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
20900298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
20913bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2092d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2093496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
20949e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
20959e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
20969e2a6581SJed Brown     }
2097d372ba47SLisandro Dalcin   }
2098d763cef2SBarry Smith   *snes = ts->snes;
2099d763cef2SBarry Smith   PetscFunctionReturn(0);
2100d763cef2SBarry Smith }
2101d763cef2SBarry Smith 
21024a2ae208SSatish Balay #undef __FUNCT__
2103deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2104deb2cd25SJed Brown /*@
2105deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2106deb2cd25SJed Brown 
2107deb2cd25SJed Brown    Collective
2108deb2cd25SJed Brown 
2109deb2cd25SJed Brown    Input Parameter:
2110deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2111deb2cd25SJed Brown -  snes - the nonlinear solver context
2112deb2cd25SJed Brown 
2113deb2cd25SJed Brown    Notes:
2114deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2115deb2cd25SJed Brown 
2116deb2cd25SJed Brown    Level: developer
2117deb2cd25SJed Brown 
2118deb2cd25SJed Brown .keywords: timestep, set, SNES
2119deb2cd25SJed Brown @*/
2120deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2121deb2cd25SJed Brown {
2122deb2cd25SJed Brown   PetscErrorCode ierr;
2123d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2124deb2cd25SJed Brown 
2125deb2cd25SJed Brown   PetscFunctionBegin;
2126deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2127deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2128deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2129deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2130bbd56ea5SKarl Rupp 
2131deb2cd25SJed Brown   ts->snes = snes;
2132bbd56ea5SKarl Rupp 
21330298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21340298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2135740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
21360298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2137740132f1SEmil Constantinescu   }
2138deb2cd25SJed Brown   PetscFunctionReturn(0);
2139deb2cd25SJed Brown }
2140deb2cd25SJed Brown 
2141deb2cd25SJed Brown #undef __FUNCT__
214294b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2143d8e5e3e6SSatish Balay /*@
214494b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2145d763cef2SBarry Smith    a TS (timestepper) context.
2146d763cef2SBarry Smith 
214794b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2148d763cef2SBarry Smith 
2149d763cef2SBarry Smith    Input Parameter:
2150d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2151d763cef2SBarry Smith 
2152d763cef2SBarry Smith    Output Parameter:
215394b7f48cSBarry Smith .  ksp - the nonlinear solver context
2154d763cef2SBarry Smith 
2155d763cef2SBarry Smith    Notes:
215694b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2157d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2158d763cef2SBarry Smith    KSP and PC contexts as well.
2159d763cef2SBarry Smith 
216094b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21610298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2162d763cef2SBarry Smith 
2163d763cef2SBarry Smith    Level: beginner
2164d763cef2SBarry Smith 
216594b7f48cSBarry Smith .keywords: timestep, get, KSP
2166d763cef2SBarry Smith @*/
21677087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2168d763cef2SBarry Smith {
2169d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2170089b2837SJed Brown   SNES           snes;
2171d372ba47SLisandro Dalcin 
2172d763cef2SBarry Smith   PetscFunctionBegin;
21730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21744482741eSBarry Smith   PetscValidPointer(ksp,2);
217517186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2176e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2177089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2178089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2179d763cef2SBarry Smith   PetscFunctionReturn(0);
2180d763cef2SBarry Smith }
2181d763cef2SBarry Smith 
2182d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2183d763cef2SBarry Smith 
21844a2ae208SSatish Balay #undef __FUNCT__
2185adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2186adb62b0dSMatthew Knepley /*@
2187adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2188adb62b0dSMatthew Knepley    maximum time for iteration.
2189adb62b0dSMatthew Knepley 
21903f9fe445SBarry Smith    Not Collective
2191adb62b0dSMatthew Knepley 
2192adb62b0dSMatthew Knepley    Input Parameters:
2193adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
21940298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
21950298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2196adb62b0dSMatthew Knepley 
2197adb62b0dSMatthew Knepley    Level: intermediate
2198adb62b0dSMatthew Knepley 
2199adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2200adb62b0dSMatthew Knepley @*/
22017087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2202adb62b0dSMatthew Knepley {
2203adb62b0dSMatthew Knepley   PetscFunctionBegin;
22040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2205abc0a331SBarry Smith   if (maxsteps) {
22064482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2207adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2208adb62b0dSMatthew Knepley   }
2209abc0a331SBarry Smith   if (maxtime) {
22104482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2211adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2212adb62b0dSMatthew Knepley   }
2213adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2214adb62b0dSMatthew Knepley }
2215adb62b0dSMatthew Knepley 
2216adb62b0dSMatthew Knepley #undef __FUNCT__
22174a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2218d763cef2SBarry Smith /*@
2219d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2220d763cef2SBarry Smith    maximum time for iteration.
2221d763cef2SBarry Smith 
22223f9fe445SBarry Smith    Logically Collective on TS
2223d763cef2SBarry Smith 
2224d763cef2SBarry Smith    Input Parameters:
2225d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2226d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2227d763cef2SBarry Smith -  maxtime - final time to iterate to
2228d763cef2SBarry Smith 
2229d763cef2SBarry Smith    Options Database Keys:
2230d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
22313bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2232d763cef2SBarry Smith 
2233d763cef2SBarry Smith    Notes:
2234d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2235d763cef2SBarry Smith 
2236d763cef2SBarry Smith    Level: intermediate
2237d763cef2SBarry Smith 
2238d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2239a43b19c4SJed Brown 
2240a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2241d763cef2SBarry Smith @*/
22427087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2243d763cef2SBarry Smith {
2244d763cef2SBarry Smith   PetscFunctionBegin;
22450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2246c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2247c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
224839b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
224939b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2250d763cef2SBarry Smith   PetscFunctionReturn(0);
2251d763cef2SBarry Smith }
2252d763cef2SBarry Smith 
22534a2ae208SSatish Balay #undef __FUNCT__
22544a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2255d763cef2SBarry Smith /*@
2256d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2257d763cef2SBarry Smith    for use by the TS routines.
2258d763cef2SBarry Smith 
22593f9fe445SBarry Smith    Logically Collective on TS and Vec
2260d763cef2SBarry Smith 
2261d763cef2SBarry Smith    Input Parameters:
2262d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22630910c330SBarry Smith -  u - the solution vector
2264d763cef2SBarry Smith 
2265d763cef2SBarry Smith    Level: beginner
2266d763cef2SBarry Smith 
2267d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2268d763cef2SBarry Smith @*/
22690910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2270d763cef2SBarry Smith {
22718737fe31SLisandro Dalcin   PetscErrorCode ierr;
2272496e6a7aSJed Brown   DM             dm;
22738737fe31SLisandro Dalcin 
2274d763cef2SBarry Smith   PetscFunctionBegin;
22750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22760910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
22770910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
22786bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2279bbd56ea5SKarl Rupp 
22800910c330SBarry Smith   ts->vec_sol = u;
2281bbd56ea5SKarl Rupp 
2282496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
22830910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2284d763cef2SBarry Smith   PetscFunctionReturn(0);
2285d763cef2SBarry Smith }
2286d763cef2SBarry Smith 
2287e74ef692SMatthew Knepley #undef __FUNCT__
228873b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
228973b18844SBarry Smith /*@
229073b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
229173b18844SBarry Smith 
229273b18844SBarry Smith    Logically Collective on TS
229373b18844SBarry Smith 
229473b18844SBarry Smith    Input Parameters:
229573b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
229673b18844SBarry Smith .  steps - number of steps to use
229773b18844SBarry Smith 
229873b18844SBarry Smith    Level: intermediate
229973b18844SBarry Smith 
230073b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
230173b18844SBarry Smith           so as to integrate back to less than the original timestep
230273b18844SBarry Smith 
230373b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
230473b18844SBarry Smith 
230573b18844SBarry Smith .seealso: TSSetExactFinalTime()
230673b18844SBarry Smith @*/
230773b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
230873b18844SBarry Smith {
230973b18844SBarry Smith   PetscFunctionBegin;
231073b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
231173b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
231273b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
231373b18844SBarry 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");
231473b18844SBarry Smith   ts->adjoint_max_steps = steps;
231573b18844SBarry Smith   PetscFunctionReturn(0);
231673b18844SBarry Smith }
231773b18844SBarry Smith 
231873b18844SBarry Smith #undef __FUNCT__
2319dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2320c235aa8dSHong Zhang /*@
2321dfb21088SHong Zhang    TSSetCostGradients - Sets the initial value of the gradients of the cost function w.r.t. initial conditions and w.r.t. the problem parameters
23220cf82b59SBarry Smith       for use by the TSAdjoint routines.
2323c235aa8dSHong Zhang 
2324c235aa8dSHong Zhang    Logically Collective on TS and Vec
2325c235aa8dSHong Zhang 
2326c235aa8dSHong Zhang    Input Parameters:
2327c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2328abc2977eSBarry 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
2329abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2330c235aa8dSHong Zhang 
2331c235aa8dSHong Zhang    Level: beginner
2332c235aa8dSHong Zhang 
2333abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
23340cf82b59SBarry Smith 
2335c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2336c235aa8dSHong Zhang @*/
2337dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2338c235aa8dSHong Zhang {
2339c235aa8dSHong Zhang   PetscFunctionBegin;
2340c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2341abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2342abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2343abc2977eSBarry Smith   ts->vecs_sensip = mu;
2344dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostIntegrand");
2345abc2977eSBarry Smith   ts->numcost  = numcost;
2346ad8e2604SHong Zhang   PetscFunctionReturn(0);
2347ad8e2604SHong Zhang }
2348ad8e2604SHong Zhang 
2349ad8e2604SHong Zhang #undef __FUNCT__
23505bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2351ad8e2604SHong Zhang /*@C
23520cf82b59SBarry 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.
2353ad8e2604SHong Zhang 
2354ad8e2604SHong Zhang   Logically Collective on TS
2355ad8e2604SHong Zhang 
2356ad8e2604SHong Zhang   Input Parameters:
2357ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2358ad8e2604SHong Zhang - func - The function
2359ad8e2604SHong Zhang 
2360ad8e2604SHong Zhang   Calling sequence of func:
23610cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
236205755b9cSHong Zhang +   t - current timestep
23630cf82b59SBarry Smith .   y - input vector (current ODE solution)
236405755b9cSHong Zhang .   A - output matrix
236505755b9cSHong Zhang -   ctx - [optional] user-defined function context
2366ad8e2604SHong Zhang 
2367ad8e2604SHong Zhang   Level: intermediate
2368ad8e2604SHong Zhang 
23690cf82b59SBarry 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
23700cf82b59SBarry Smith 
2371ad8e2604SHong Zhang .keywords: TS, sensitivity
2372ad8e2604SHong Zhang .seealso:
2373ad8e2604SHong Zhang @*/
23745bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2375ad8e2604SHong Zhang {
2376ad8e2604SHong Zhang   PetscErrorCode ierr;
2377ad8e2604SHong Zhang 
2378ad8e2604SHong Zhang   PetscFunctionBegin;
2379ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2380ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2381ad8e2604SHong Zhang 
2382ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2383ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2384ad8e2604SHong Zhang   if(Amat) {
2385ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2386ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2387ad8e2604SHong Zhang     ts->Jacp = Amat;
2388ad8e2604SHong Zhang   }
2389ad8e2604SHong Zhang   PetscFunctionReturn(0);
2390ad8e2604SHong Zhang }
2391ad8e2604SHong Zhang 
2392ad8e2604SHong Zhang #undef __FUNCT__
23935bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
23940cf82b59SBarry Smith /*@C
23955bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2396ad8e2604SHong Zhang 
2397ad8e2604SHong Zhang   Collective on TS
2398ad8e2604SHong Zhang 
2399ad8e2604SHong Zhang   Input Parameters:
2400ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2401ad8e2604SHong Zhang 
2402ad8e2604SHong Zhang   Level: developer
2403ad8e2604SHong Zhang 
2404ad8e2604SHong Zhang .keywords: TS, sensitivity
24055bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2406ad8e2604SHong Zhang @*/
24075bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2408ad8e2604SHong Zhang {
2409ad8e2604SHong Zhang   PetscErrorCode ierr;
2410ad8e2604SHong Zhang 
2411ad8e2604SHong Zhang   PetscFunctionBegin;
2412ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2413ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2414ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2415ad8e2604SHong Zhang 
2416ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2417ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2418ad8e2604SHong Zhang   PetscStackPop;
2419c235aa8dSHong Zhang   PetscFunctionReturn(0);
2420c235aa8dSHong Zhang }
2421c235aa8dSHong Zhang 
2422c235aa8dSHong Zhang #undef __FUNCT__
2423dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
24246fd0887fSHong Zhang /*@C
2425dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
24266fd0887fSHong Zhang 
24276fd0887fSHong Zhang     Logically Collective on TS
24286fd0887fSHong Zhang 
24296fd0887fSHong Zhang     Input Parameters:
24306fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2431abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
24320cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2433b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2434b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2435b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
24366fd0887fSHong Zhang 
24370cf82b59SBarry Smith     Calling sequence of rf:
24380cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
24396fd0887fSHong Zhang 
24406fd0887fSHong Zhang +   t - current timestep
24410cf82b59SBarry Smith .   y - input vector
24420cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
24436fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24446fd0887fSHong Zhang 
2445b612ec54SBarry Smith    Calling sequence of drdyf:
24460cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2447b612ec54SBarry Smith 
2448b612ec54SBarry Smith    Calling sequence of drdpf:
24490cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2450b612ec54SBarry Smith 
2451b612ec54SBarry Smith     Level: intermediate
24526fd0887fSHong Zhang 
2453abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
24540cf82b59SBarry Smith 
24556fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24566fd0887fSHong Zhang 
2457dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
24586fd0887fSHong Zhang @*/
2459dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2460d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2461d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
24626fd0887fSHong Zhang {
24636fd0887fSHong Zhang   PetscErrorCode ierr;
24646fd0887fSHong Zhang 
24656fd0887fSHong Zhang   PetscFunctionBegin;
24666fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2467dfb21088SHong Zhang   if (ts->numcost && ts->numcost!=numcost) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"The number of cost functions (2rd parameter of TSSetCostIntegrand()) is inconsistent with the one set by TSSetCostGradients()");
2468c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
24696fd0887fSHong Zhang 
2470abc2977eSBarry Smith   ierr                  = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
24712c39e106SBarry Smith   ierr                  = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
24720cf82b59SBarry Smith   ts->costintegrand     = rf;
247305755b9cSHong Zhang   ts->costintegrandctx  = ctx;
2474b612ec54SBarry Smith   ts->drdyfunction    = drdyf;
2475b612ec54SBarry Smith   ts->drdpfunction    = drdpf;
24766fd0887fSHong Zhang   PetscFunctionReturn(0);
24776fd0887fSHong Zhang }
24786fd0887fSHong Zhang 
24796fd0887fSHong Zhang #undef __FUNCT__
2480dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
248136eaed60SHong Zhang /*@
2482dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
248336eaed60SHong Zhang    It is valid to call the routine after a backward run.
248436eaed60SHong Zhang 
248536eaed60SHong Zhang    Not Collective
248636eaed60SHong Zhang 
248736eaed60SHong Zhang    Input Parameter:
248836eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
248936eaed60SHong Zhang 
249036eaed60SHong Zhang    Output Parameter:
24912c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
249236eaed60SHong Zhang 
249336eaed60SHong Zhang    Level: intermediate
249436eaed60SHong Zhang 
2495dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
249636eaed60SHong Zhang 
249736eaed60SHong Zhang .keywords: TS, sensitivity analysis
249836eaed60SHong Zhang @*/
2499dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
250036eaed60SHong Zhang {
250136eaed60SHong Zhang   PetscFunctionBegin;
250236eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
250336eaed60SHong Zhang   PetscValidPointer(v,2);
25042c39e106SBarry Smith   *v = ts->vec_costintegral;
250536eaed60SHong Zhang   PetscFunctionReturn(0);
250636eaed60SHong Zhang }
250736eaed60SHong Zhang 
250836eaed60SHong Zhang #undef __FUNCT__
2509d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
25106fd0887fSHong Zhang /*@
25112c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
25126fd0887fSHong Zhang 
25136fd0887fSHong Zhang    Input Parameters:
25146fd0887fSHong Zhang +  ts - the TS context
25156fd0887fSHong Zhang .  t - current time
25160cf82b59SBarry Smith -  y - state vector, i.e. current solution
25176fd0887fSHong Zhang 
25186fd0887fSHong Zhang    Output Parameter:
2519abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
25206fd0887fSHong Zhang 
25216fd0887fSHong Zhang    Note:
25226fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
25236fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
25246fd0887fSHong Zhang 
25256fd0887fSHong Zhang    Level: developer
25266fd0887fSHong Zhang 
25276fd0887fSHong Zhang .keywords: TS, compute
25286fd0887fSHong Zhang 
2529dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
25306fd0887fSHong Zhang @*/
25310cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
25326fd0887fSHong Zhang {
25336fd0887fSHong Zhang   PetscErrorCode ierr;
25346fd0887fSHong Zhang 
25356fd0887fSHong Zhang   PetscFunctionBegin;
25366fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25370cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
25386fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
25396fd0887fSHong Zhang 
25400cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2541e4680132SHong Zhang   if (ts->costintegrand) {
2542e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
25430cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
25446fd0887fSHong Zhang     PetscStackPop;
25456fd0887fSHong Zhang   } else {
25466fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25476fd0887fSHong Zhang   }
25486fd0887fSHong Zhang 
25490cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
25506fd0887fSHong Zhang   PetscFunctionReturn(0);
25516fd0887fSHong Zhang }
25526fd0887fSHong Zhang 
25536fd0887fSHong Zhang #undef __FUNCT__
2554d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
255505755b9cSHong Zhang /*@
2556d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
255705755b9cSHong Zhang 
255805755b9cSHong Zhang   Collective on TS
255905755b9cSHong Zhang 
256005755b9cSHong Zhang   Input Parameters:
256105755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
256205755b9cSHong Zhang 
256305755b9cSHong Zhang   Notes:
2564d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
256505755b9cSHong Zhang   so most users would not generally call this routine themselves.
256605755b9cSHong Zhang 
256705755b9cSHong Zhang   Level: developer
256805755b9cSHong Zhang 
256905755b9cSHong Zhang .keywords: TS, sensitivity
2570d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
257105755b9cSHong Zhang @*/
25720cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
257305755b9cSHong Zhang {
257405755b9cSHong Zhang   PetscErrorCode ierr;
257505755b9cSHong Zhang 
257605755b9cSHong Zhang   PetscFunctionBegin;
257705755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25780cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
257905755b9cSHong Zhang 
258005755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
25810cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
258205755b9cSHong Zhang   PetscStackPop;
258305755b9cSHong Zhang   PetscFunctionReturn(0);
258405755b9cSHong Zhang }
258505755b9cSHong Zhang 
258605755b9cSHong Zhang #undef __FUNCT__
2587d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
258805755b9cSHong Zhang /*@
2589d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
259005755b9cSHong Zhang 
259105755b9cSHong Zhang   Collective on TS
259205755b9cSHong Zhang 
259305755b9cSHong Zhang   Input Parameters:
259405755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
259505755b9cSHong Zhang 
259605755b9cSHong Zhang   Notes:
259705755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
259805755b9cSHong Zhang   so most users would not generally call this routine themselves.
259905755b9cSHong Zhang 
260005755b9cSHong Zhang   Level: developer
260105755b9cSHong Zhang 
260205755b9cSHong Zhang .keywords: TS, sensitivity
2603d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
260405755b9cSHong Zhang @*/
26050cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
260605755b9cSHong Zhang {
260705755b9cSHong Zhang   PetscErrorCode ierr;
260805755b9cSHong Zhang 
260905755b9cSHong Zhang   PetscFunctionBegin;
261005755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26110cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
261205755b9cSHong Zhang 
261305755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
26140cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
261505755b9cSHong Zhang   PetscStackPop;
261605755b9cSHong Zhang   PetscFunctionReturn(0);
261705755b9cSHong Zhang }
261805755b9cSHong Zhang 
261905755b9cSHong Zhang #undef __FUNCT__
2620e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2621ac226902SBarry Smith /*@C
2622000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26233f2090d5SJed Brown   called once at the beginning of each time step.
2624000e7ae3SMatthew Knepley 
26253f9fe445SBarry Smith   Logically Collective on TS
2626000e7ae3SMatthew Knepley 
2627000e7ae3SMatthew Knepley   Input Parameters:
2628000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2629000e7ae3SMatthew Knepley - func - The function
2630000e7ae3SMatthew Knepley 
2631000e7ae3SMatthew Knepley   Calling sequence of func:
2632000e7ae3SMatthew Knepley . func (TS ts);
2633000e7ae3SMatthew Knepley 
2634000e7ae3SMatthew Knepley   Level: intermediate
2635000e7ae3SMatthew Knepley 
2636b8123daeSJed Brown   Note:
2637b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2638b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2639b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2640b8123daeSJed Brown 
2641000e7ae3SMatthew Knepley .keywords: TS, timestep
26429be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2643000e7ae3SMatthew Knepley @*/
26447087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2645000e7ae3SMatthew Knepley {
2646000e7ae3SMatthew Knepley   PetscFunctionBegin;
26470700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2648ae60f76fSBarry Smith   ts->prestep = func;
2649000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2650000e7ae3SMatthew Knepley }
2651000e7ae3SMatthew Knepley 
2652e74ef692SMatthew Knepley #undef __FUNCT__
26533f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
265409ee8438SJed Brown /*@
26553f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26563f2090d5SJed Brown 
26573f2090d5SJed Brown   Collective on TS
26583f2090d5SJed Brown 
26593f2090d5SJed Brown   Input Parameters:
26603f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26613f2090d5SJed Brown 
26623f2090d5SJed Brown   Notes:
26633f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
26643f2090d5SJed Brown   so most users would not generally call this routine themselves.
26653f2090d5SJed Brown 
26663f2090d5SJed Brown   Level: developer
26673f2090d5SJed Brown 
26683f2090d5SJed Brown .keywords: TS, timestep
26699be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
26703f2090d5SJed Brown @*/
26717087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
26723f2090d5SJed Brown {
26733f2090d5SJed Brown   PetscErrorCode ierr;
26743f2090d5SJed Brown 
26753f2090d5SJed Brown   PetscFunctionBegin;
26760700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2677ae60f76fSBarry Smith   if (ts->prestep) {
2678ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2679312ce896SJed Brown   }
26803f2090d5SJed Brown   PetscFunctionReturn(0);
26813f2090d5SJed Brown }
26823f2090d5SJed Brown 
26833f2090d5SJed Brown #undef __FUNCT__
2684b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2685b8123daeSJed Brown /*@C
2686b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2687b8123daeSJed Brown   called once at the beginning of each stage.
2688b8123daeSJed Brown 
2689b8123daeSJed Brown   Logically Collective on TS
2690b8123daeSJed Brown 
2691b8123daeSJed Brown   Input Parameters:
2692b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2693b8123daeSJed Brown - func - The function
2694b8123daeSJed Brown 
2695b8123daeSJed Brown   Calling sequence of func:
2696b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2697b8123daeSJed Brown 
2698b8123daeSJed Brown   Level: intermediate
2699b8123daeSJed Brown 
2700b8123daeSJed Brown   Note:
2701b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2702b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2703b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2704b8123daeSJed Brown 
2705b8123daeSJed Brown .keywords: TS, timestep
27069be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2707b8123daeSJed Brown @*/
2708b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2709b8123daeSJed Brown {
2710b8123daeSJed Brown   PetscFunctionBegin;
2711b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2712ae60f76fSBarry Smith   ts->prestage = func;
2713b8123daeSJed Brown   PetscFunctionReturn(0);
2714b8123daeSJed Brown }
2715b8123daeSJed Brown 
2716b8123daeSJed Brown #undef __FUNCT__
27179be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27189be3e283SDebojyoti Ghosh /*@C
27199be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27209be3e283SDebojyoti Ghosh   called once at the end of each stage.
27219be3e283SDebojyoti Ghosh 
27229be3e283SDebojyoti Ghosh   Logically Collective on TS
27239be3e283SDebojyoti Ghosh 
27249be3e283SDebojyoti Ghosh   Input Parameters:
27259be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27269be3e283SDebojyoti Ghosh - func - The function
27279be3e283SDebojyoti Ghosh 
27289be3e283SDebojyoti Ghosh   Calling sequence of func:
27299be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27309be3e283SDebojyoti Ghosh 
27319be3e283SDebojyoti Ghosh   Level: intermediate
27329be3e283SDebojyoti Ghosh 
27339be3e283SDebojyoti Ghosh   Note:
27349be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27359be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27369be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27379be3e283SDebojyoti Ghosh 
27389be3e283SDebojyoti Ghosh .keywords: TS, timestep
27399be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27409be3e283SDebojyoti Ghosh @*/
27419be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27429be3e283SDebojyoti Ghosh {
27439be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27449be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27459be3e283SDebojyoti Ghosh   ts->poststage = func;
27469be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27479be3e283SDebojyoti Ghosh }
27489be3e283SDebojyoti Ghosh 
27499be3e283SDebojyoti Ghosh #undef __FUNCT__
2750b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2751b8123daeSJed Brown /*@
2752b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2753b8123daeSJed Brown 
2754b8123daeSJed Brown   Collective on TS
2755b8123daeSJed Brown 
2756b8123daeSJed Brown   Input Parameters:
2757b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27589be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2759b8123daeSJed Brown 
2760b8123daeSJed Brown   Notes:
2761b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2762b8123daeSJed Brown   most users would not generally call this routine themselves.
2763b8123daeSJed Brown 
2764b8123daeSJed Brown   Level: developer
2765b8123daeSJed Brown 
2766b8123daeSJed Brown .keywords: TS, timestep
27679be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2768b8123daeSJed Brown @*/
2769b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2770b8123daeSJed Brown {
2771b8123daeSJed Brown   PetscErrorCode ierr;
2772b8123daeSJed Brown 
2773b8123daeSJed Brown   PetscFunctionBegin;
2774b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2775ae60f76fSBarry Smith   if (ts->prestage) {
2776ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2777b8123daeSJed Brown   }
2778b8123daeSJed Brown   PetscFunctionReturn(0);
2779b8123daeSJed Brown }
2780b8123daeSJed Brown 
2781b8123daeSJed Brown #undef __FUNCT__
27829be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
27839be3e283SDebojyoti Ghosh /*@
27849be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
27859be3e283SDebojyoti Ghosh 
27869be3e283SDebojyoti Ghosh   Collective on TS
27879be3e283SDebojyoti Ghosh 
27889be3e283SDebojyoti Ghosh   Input Parameters:
27899be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
27909be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
27919be3e283SDebojyoti Ghosh   stageindex  - Stage number
27929be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
27939be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
27949be3e283SDebojyoti Ghosh 
27959be3e283SDebojyoti Ghosh   Notes:
27969be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
27979be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
27989be3e283SDebojyoti Ghosh 
27999be3e283SDebojyoti Ghosh   Level: developer
28009be3e283SDebojyoti Ghosh 
28019be3e283SDebojyoti Ghosh .keywords: TS, timestep
28029be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
28039be3e283SDebojyoti Ghosh @*/
28049be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
28059be3e283SDebojyoti Ghosh {
28069be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
28079be3e283SDebojyoti Ghosh 
28089be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28099be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28104beae5d8SLisandro Dalcin   if (ts->poststage) {
28119be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
28129be3e283SDebojyoti Ghosh   }
28139be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28149be3e283SDebojyoti Ghosh }
28159be3e283SDebojyoti Ghosh 
28169be3e283SDebojyoti Ghosh #undef __FUNCT__
2817e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2818ac226902SBarry Smith /*@C
2819000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28203f2090d5SJed Brown   called once at the end of each time step.
2821000e7ae3SMatthew Knepley 
28223f9fe445SBarry Smith   Logically Collective on TS
2823000e7ae3SMatthew Knepley 
2824000e7ae3SMatthew Knepley   Input Parameters:
2825000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2826000e7ae3SMatthew Knepley - func - The function
2827000e7ae3SMatthew Knepley 
2828000e7ae3SMatthew Knepley   Calling sequence of func:
2829b8123daeSJed Brown $ func (TS ts);
2830000e7ae3SMatthew Knepley 
2831000e7ae3SMatthew Knepley   Level: intermediate
2832000e7ae3SMatthew Knepley 
2833000e7ae3SMatthew Knepley .keywords: TS, timestep
2834b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2835000e7ae3SMatthew Knepley @*/
28367087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2837000e7ae3SMatthew Knepley {
2838000e7ae3SMatthew Knepley   PetscFunctionBegin;
28390700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2840ae60f76fSBarry Smith   ts->poststep = func;
2841000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2842000e7ae3SMatthew Knepley }
2843000e7ae3SMatthew Knepley 
2844e74ef692SMatthew Knepley #undef __FUNCT__
28453f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
284609ee8438SJed Brown /*@
28473f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28483f2090d5SJed Brown 
28493f2090d5SJed Brown   Collective on TS
28503f2090d5SJed Brown 
28513f2090d5SJed Brown   Input Parameters:
28523f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28533f2090d5SJed Brown 
28543f2090d5SJed Brown   Notes:
28553f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28563f2090d5SJed Brown   so most users would not generally call this routine themselves.
28573f2090d5SJed Brown 
28583f2090d5SJed Brown   Level: developer
28593f2090d5SJed Brown 
28603f2090d5SJed Brown .keywords: TS, timestep
28613f2090d5SJed Brown @*/
28627087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28633f2090d5SJed Brown {
28643f2090d5SJed Brown   PetscErrorCode ierr;
28653f2090d5SJed Brown 
28663f2090d5SJed Brown   PetscFunctionBegin;
28670700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2868ae60f76fSBarry Smith   if (ts->poststep) {
2869ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
287072ac3e02SJed Brown   }
28713f2090d5SJed Brown   PetscFunctionReturn(0);
28723f2090d5SJed Brown }
28733f2090d5SJed Brown 
2874d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2875d763cef2SBarry Smith 
28764a2ae208SSatish Balay #undef __FUNCT__
2877a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2878d763cef2SBarry Smith /*@C
2879a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2880d763cef2SBarry Smith    timestep to display the iteration's  progress.
2881d763cef2SBarry Smith 
28823f9fe445SBarry Smith    Logically Collective on TS
2883d763cef2SBarry Smith 
2884d763cef2SBarry Smith    Input Parameters:
2885d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2886e213d8f1SJed Brown .  monitor - monitoring routine
2887329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
28880298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2889b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
28900298fd71SBarry Smith           (may be NULL)
2891d763cef2SBarry Smith 
2892e213d8f1SJed Brown    Calling sequence of monitor:
28930910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2894d763cef2SBarry Smith 
2895d763cef2SBarry Smith +    ts - the TS context
289688c05cc5SBarry 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
289788c05cc5SBarry Smith                                been interpolated to)
28981f06c33eSBarry Smith .    time - current time
28990910c330SBarry Smith .    u - current iterate
2900d763cef2SBarry Smith -    mctx - [optional] monitoring context
2901d763cef2SBarry Smith 
2902d763cef2SBarry Smith    Notes:
2903d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2904d763cef2SBarry Smith    already has been loaded.
2905d763cef2SBarry Smith 
2906025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2907025f1a04SBarry Smith 
2908d763cef2SBarry Smith    Level: intermediate
2909d763cef2SBarry Smith 
2910d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2911d763cef2SBarry Smith 
2912a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2913d763cef2SBarry Smith @*/
2914c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2915d763cef2SBarry Smith {
2916d763cef2SBarry Smith   PetscFunctionBegin;
29170700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
291817186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2919d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29208704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2921d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2922d763cef2SBarry Smith   PetscFunctionReturn(0);
2923d763cef2SBarry Smith }
2924d763cef2SBarry Smith 
29254a2ae208SSatish Balay #undef __FUNCT__
2926a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2927d763cef2SBarry Smith /*@C
2928a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2929d763cef2SBarry Smith 
29303f9fe445SBarry Smith    Logically Collective on TS
2931d763cef2SBarry Smith 
2932d763cef2SBarry Smith    Input Parameters:
2933d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2934d763cef2SBarry Smith 
2935d763cef2SBarry Smith    Notes:
2936d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2937d763cef2SBarry Smith 
2938d763cef2SBarry Smith    Level: intermediate
2939d763cef2SBarry Smith 
2940d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2941d763cef2SBarry Smith 
2942a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2943d763cef2SBarry Smith @*/
29447087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2945d763cef2SBarry Smith {
2946d952e501SBarry Smith   PetscErrorCode ierr;
2947d952e501SBarry Smith   PetscInt       i;
2948d952e501SBarry Smith 
2949d763cef2SBarry Smith   PetscFunctionBegin;
29500700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2951d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29528704b422SBarry Smith     if (ts->monitordestroy[i]) {
29538704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2954d952e501SBarry Smith     }
2955d952e501SBarry Smith   }
2956d763cef2SBarry Smith   ts->numbermonitors = 0;
2957d763cef2SBarry Smith   PetscFunctionReturn(0);
2958d763cef2SBarry Smith }
2959d763cef2SBarry Smith 
29604a2ae208SSatish Balay #undef __FUNCT__
2961a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2962d8e5e3e6SSatish Balay /*@
2963a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
29645516499fSSatish Balay 
29655516499fSSatish Balay    Level: intermediate
296641251cbbSSatish Balay 
29675516499fSSatish Balay .keywords: TS, set, monitor
29685516499fSSatish Balay 
296941251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
297041251cbbSSatish Balay @*/
2971649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
2972d763cef2SBarry Smith {
2973dfbe8321SBarry Smith   PetscErrorCode ierr;
2974ce94432eSBarry Smith   PetscViewer    viewer = dummy ? (PetscViewer) dummy : PETSC_VIEWER_STDOUT_(PetscObjectComm((PetscObject)ts));
2975d132466eSBarry Smith 
2976d763cef2SBarry Smith   PetscFunctionBegin;
2977649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
29788392e04aSShri 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);
2979649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
2980d763cef2SBarry Smith   PetscFunctionReturn(0);
2981d763cef2SBarry Smith }
2982d763cef2SBarry Smith 
29834a2ae208SSatish Balay #undef __FUNCT__
2984cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
2985cd652676SJed Brown /*@
2986cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
2987cd652676SJed Brown 
2988cd652676SJed Brown    Logically Collective on TS
2989cd652676SJed Brown 
2990cd652676SJed Brown    Input Argument:
2991cd652676SJed Brown .  ts - time stepping context
2992cd652676SJed Brown 
2993cd652676SJed Brown    Output Argument:
2994cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
2995cd652676SJed Brown 
2996cd652676SJed Brown    Level: intermediate
2997cd652676SJed Brown 
2998cd652676SJed Brown .keywords: TS, set
2999cd652676SJed Brown 
3000cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3001cd652676SJed Brown @*/
3002cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3003cd652676SJed Brown {
3004cd652676SJed Brown   PetscFunctionBegin;
3005cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3006cd652676SJed Brown   ts->retain_stages = flg;
3007cd652676SJed Brown   PetscFunctionReturn(0);
3008cd652676SJed Brown }
3009cd652676SJed Brown 
3010cd652676SJed Brown #undef __FUNCT__
3011cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3012cd652676SJed Brown /*@
3013cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3014cd652676SJed Brown 
3015cd652676SJed Brown    Collective on TS
3016cd652676SJed Brown 
3017cd652676SJed Brown    Input Argument:
3018cd652676SJed Brown +  ts - time stepping context
3019cd652676SJed Brown -  t - time to interpolate to
3020cd652676SJed Brown 
3021cd652676SJed Brown    Output Argument:
30220910c330SBarry Smith .  U - state at given time
3023cd652676SJed Brown 
3024cd652676SJed Brown    Notes:
3025cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3026cd652676SJed Brown 
3027cd652676SJed Brown    Level: intermediate
3028cd652676SJed Brown 
3029cd652676SJed Brown    Developer Notes:
3030cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3031cd652676SJed Brown 
3032cd652676SJed Brown .keywords: TS, set
3033cd652676SJed Brown 
3034cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3035cd652676SJed Brown @*/
30360910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3037cd652676SJed Brown {
3038cd652676SJed Brown   PetscErrorCode ierr;
3039cd652676SJed Brown 
3040cd652676SJed Brown   PetscFunctionBegin;
3041cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3042b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
30436712e2f1SBarry 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);
3044ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
30450910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3046cd652676SJed Brown   PetscFunctionReturn(0);
3047cd652676SJed Brown }
3048cd652676SJed Brown 
3049cd652676SJed Brown #undef __FUNCT__
30504a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3051d763cef2SBarry Smith /*@
30526d9e5789SSean Farley    TSStep - Steps one time step
3053d763cef2SBarry Smith 
3054d763cef2SBarry Smith    Collective on TS
3055d763cef2SBarry Smith 
3056d763cef2SBarry Smith    Input Parameter:
3057d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3058d763cef2SBarry Smith 
305927829d71SBarry Smith    Level: developer
3060d763cef2SBarry Smith 
3061b8123daeSJed Brown    Notes:
306227829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
306327829d71SBarry Smith 
3064b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3065b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3066b8123daeSJed Brown 
306725cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
306825cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
306925cb2221SBarry Smith 
3070d763cef2SBarry Smith .keywords: TS, timestep, solve
3071d763cef2SBarry Smith 
30729be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3073d763cef2SBarry Smith @*/
3074193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3075d763cef2SBarry Smith {
30762fb8446cSMatthew G. Knepley   DM               dm;
3077dfbe8321SBarry Smith   PetscErrorCode   ierr;
3078fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3079d763cef2SBarry Smith 
3080d763cef2SBarry Smith   PetscFunctionBegin;
30810700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3082fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3083fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3084fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3085fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3086fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3087fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3088302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3089fffbeea8SBarry Smith 
30902fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3091d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3092d405a339SMatthew Knepley 
3093362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
309424655328SShri   ts->ptime_prev = ts->ptime;
3095cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3096bbd56ea5SKarl Rupp 
3097e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3098d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3099193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3100d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3101bbd56ea5SKarl Rupp 
310224655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3103cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3104362cd11cSLisandro Dalcin 
3105362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3106cef5090cSJed Brown     if (ts->errorifstepfailed) {
310708c7845fSBarry 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]);
310808c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3109d2daff3dSHong Zhang     }
311008c7845fSBarry Smith   } else if (!ts->reason) {
311108c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
311208c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
311308c7845fSBarry Smith   }
31142c18e0fdSBarry Smith   ts->total_steps++;
31158392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
311608c7845fSBarry Smith   PetscFunctionReturn(0);
311708c7845fSBarry Smith }
311808c7845fSBarry Smith 
311908c7845fSBarry Smith #undef __FUNCT__
312008c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
312108c7845fSBarry Smith /*@
312208c7845fSBarry Smith    TSAdjointStep - Steps one time step
312308c7845fSBarry Smith 
312408c7845fSBarry Smith    Collective on TS
312508c7845fSBarry Smith 
312608c7845fSBarry Smith    Input Parameter:
312708c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
312808c7845fSBarry Smith 
31296a4d4014SLisandro Dalcin    Level: intermediate
31306a4d4014SLisandro Dalcin 
31317087cfbeSBarry Smith    Notes:
31326a4d4014SLisandro Dalcin    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
31336a4d4014SLisandro Dalcin    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
31346a4d4014SLisandro Dalcin 
31356a4d4014SLisandro Dalcin    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
3136f22f69f0SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
31376a4d4014SLisandro Dalcin 
31380700a824SBarry Smith .keywords: TS, timestep, solve
31396a4d4014SLisandro Dalcin 
314008c7845fSBarry Smith .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
31416a4d4014SLisandro Dalcin @*/
314208c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
31436a4d4014SLisandro Dalcin {
314408c7845fSBarry Smith   DM               dm;
31456a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
31466a4d4014SLisandro Dalcin 
31476a4d4014SLisandro Dalcin   PetscFunctionBegin;
31484a2ae208SSatish Balay   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
314908c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
315008c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3151d763cef2SBarry Smith 
3152d763cef2SBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
315308c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
315408c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
315508c7845fSBarry Smith   ierr = VecViewFromOptions(ts->vec_sol, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3156d763cef2SBarry Smith 
31576849ba73SBarry Smith   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
315842f2b339SBarry 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);
315942f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
3160a6570f20SBarry Smith   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3161d763cef2SBarry Smith 
3162cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3163cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3164362cd11cSLisandro Dalcin 
3165362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3166cef5090cSJed Brown     if (ts->errorifstepfailed) {
3167cef5090cSJed Brown       if (ts->reason == TS_DIVERGED_NONLINEAR_SOLVE) {
3168ce94432eSBarry 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]);
31692a3a10ceSLisandro Dalcin       } else if (ts->reason == TS_DIVERGED_STEP_REJECTED) {
31702a3a10ceSLisandro 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]);
3171ce94432eSBarry Smith       } else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3172cef5090cSJed Brown     }
3173362cd11cSLisandro Dalcin   } else if (!ts->reason) {
317473b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3175db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3176362cd11cSLisandro Dalcin   }
31772c18e0fdSBarry Smith   ts->total_steps--;
3178d763cef2SBarry Smith   PetscFunctionReturn(0);
3179d763cef2SBarry Smith }
3180d763cef2SBarry Smith 
3181d763cef2SBarry Smith #undef __FUNCT__
318205175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
318305175c85SJed Brown /*@
318405175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
318505175c85SJed Brown 
31861c3436cfSJed Brown    Collective on TS
318705175c85SJed Brown 
318805175c85SJed Brown    Input Arguments:
31891c3436cfSJed Brown +  ts - time stepping context
31901c3436cfSJed Brown .  order - desired order of accuracy
31910298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
319205175c85SJed Brown 
319305175c85SJed Brown    Output Arguments:
31940910c330SBarry Smith .  U - state at the end of the current step
319505175c85SJed Brown 
319605175c85SJed Brown    Level: advanced
319705175c85SJed Brown 
3198108c343cSJed Brown    Notes:
3199108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3200108c343cSJed 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.
3201108c343cSJed Brown 
32021c3436cfSJed Brown .seealso: TSStep(), TSAdapt
320305175c85SJed Brown @*/
32040910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
320505175c85SJed Brown {
320605175c85SJed Brown   PetscErrorCode ierr;
320705175c85SJed Brown 
320805175c85SJed Brown   PetscFunctionBegin;
320905175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
321005175c85SJed Brown   PetscValidType(ts,1);
32110910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3212ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
32130910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
321405175c85SJed Brown   PetscFunctionReturn(0);
321505175c85SJed Brown }
321605175c85SJed Brown 
3217d67e68b7SBarry Smith 
321805175c85SJed Brown #undef __FUNCT__
3219d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3220d763cef2SBarry Smith /*@
3221d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3222d763cef2SBarry Smith 
3223d763cef2SBarry Smith    Collective on TS
3224d763cef2SBarry Smith 
3225d763cef2SBarry Smith    Input Parameter:
3226d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3227cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
32285a3a76d0SJed Brown 
3229d763cef2SBarry Smith    Level: beginner
3230d763cef2SBarry Smith 
32315a3a76d0SJed Brown    Notes:
32325a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
32335a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
32345a3a76d0SJed Brown    stepped over the final time.
32355a3a76d0SJed Brown 
3236d763cef2SBarry Smith .keywords: TS, timestep, solve
3237d763cef2SBarry Smith 
3238d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3239d763cef2SBarry Smith @*/
3240cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3241d763cef2SBarry Smith {
3242b06615a5SLisandro Dalcin   Vec               solution;
3243d763cef2SBarry Smith   PetscErrorCode    ierr;
3244d763cef2SBarry Smith 
3245d763cef2SBarry Smith   PetscFunctionBegin;
3246d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3247f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
324849354f04SShri 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 */
3249b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
32500910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3251b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3252b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3253b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
32545a3a76d0SJed Brown     }
32550910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3256bbd56ea5SKarl Rupp   } else if (u) {
32570910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
32585a3a76d0SJed Brown   }
3259b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3260d763cef2SBarry Smith   /* reset time step and iteration counters */
3261193ac0bcSJed Brown   ts->steps             = 0;
32625ef26d82SJed Brown   ts->ksp_its           = 0;
32635ef26d82SJed Brown   ts->snes_its          = 0;
3264c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3265c610991cSLisandro Dalcin   ts->reject            = 0;
3266193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3267193ac0bcSJed Brown 
3268ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3269ec8db0baSMatthew G. Knepley   {
3270ec8db0baSMatthew G. Knepley     DM dm;
3271ec8db0baSMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3272ec8db0baSMatthew G. Knepley     ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3273ec8db0baSMatthew G. Knepley   }
3274f05ece33SBarry Smith 
3275193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3276193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
32770910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3278cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3279193ac0bcSJed Brown   } else {
3280d763cef2SBarry Smith     /* steps the requested number of timesteps. */
3281db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3282db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3283cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
328411b05f00SHong Zhang     if (ts->vec_costintegral) ts->costintegralfwd=PETSC_TRUE;
32856fea3669SShri Abhyankar     if(ts->event) {
32866fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
32876fea3669SShri Abhyankar     }
3288e1a7a14fSJed Brown     while (!ts->reason) {
3289193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3290193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3291aeb4809dSShri Abhyankar       if (ts->event) {
3292aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
32931eda64f1SShri Abhyankar       }
32948392e04aSShri Abhyankar       if(!ts->steprollback) {
3295cdf0de3dSShri Abhyankar 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
32961eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3297aeb4809dSShri Abhyankar       }
3298193ac0bcSJed Brown     }
329949354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
33000910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3301cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3302b06615a5SLisandro Dalcin       solution = u;
33030574a7fbSJed Brown     } else {
3304ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3305cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3306b06615a5SLisandro Dalcin       solution = ts->vec_sol;
33070574a7fbSJed Brown     }
3308b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
330927829d71SBarry Smith     ierr = VecViewFromOptions(solution, ((PetscObject) ts)->prefix, "-ts_view_solution");CHKERRQ(ierr);
3310193ac0bcSJed Brown   }
3311d2daff3dSHong Zhang 
3312ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
331356f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3314ef222394SBarry Smith   if (ts->adjoint_solve) {
3315ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
33162b0a91c0SBarry Smith   }
3317d763cef2SBarry Smith   PetscFunctionReturn(0);
3318d763cef2SBarry Smith }
3319d763cef2SBarry Smith 
3320d763cef2SBarry Smith #undef __FUNCT__
3321c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3322c88f2d44SBarry Smith /*@
3323c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3324c88f2d44SBarry Smith 
3325c88f2d44SBarry Smith    Collective on TS
3326c88f2d44SBarry Smith 
3327c88f2d44SBarry Smith    Input Parameter:
33282c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3329c88f2d44SBarry Smith 
3330e87fd094SBarry Smith    Options Database:
3331e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3332e87fd094SBarry Smith 
3333c88f2d44SBarry Smith    Level: intermediate
3334c88f2d44SBarry Smith 
3335c88f2d44SBarry Smith    Notes:
3336c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3337c88f2d44SBarry Smith 
333873b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
333973b18844SBarry Smith 
3340c88f2d44SBarry Smith .keywords: TS, timestep, solve
3341c88f2d44SBarry Smith 
3342c88f2d44SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3343c88f2d44SBarry Smith @*/
33442c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3345c88f2d44SBarry Smith {
3346c88f2d44SBarry Smith   PetscErrorCode    ierr;
3347c88f2d44SBarry Smith 
3348c88f2d44SBarry Smith   PetscFunctionBegin;
3349c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3350c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3351c88f2d44SBarry Smith   /* reset time step and iteration counters */
3352c88f2d44SBarry Smith   ts->steps             = 0;
3353c88f2d44SBarry Smith   ts->ksp_its           = 0;
3354c88f2d44SBarry Smith   ts->snes_its          = 0;
3355c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3356c88f2d44SBarry Smith   ts->reject            = 0;
3357c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3358c88f2d44SBarry Smith 
335973b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3360c88f2d44SBarry Smith 
336173b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3362c88f2d44SBarry Smith   while (!ts->reason) {
336373b18844SBarry Smith     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->adjoint_max_steps-ts->steps,ts->ptime);CHKERRQ(ierr);
336473b18844SBarry Smith     ierr = TSMonitor(ts,ts->adjoint_max_steps-ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
336508c7845fSBarry Smith     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3366c88f2d44SBarry Smith     if (ts->event) {
3367d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3368d0578d90SShri Abhyankar     }
3369d0578d90SShri Abhyankar 
3370d0578d90SShri Abhyankar #if 0 /* I don't think PostStep is needed in AdjointSolve */
3371c88f2d44SBarry Smith       if (ts->event->status != TSEVENT_PROCESSING) {
3372c88f2d44SBarry Smith         ierr = TSPostStep(ts);CHKERRQ(ierr);
3373c88f2d44SBarry Smith       }
3374c88f2d44SBarry Smith     } else {
3375c88f2d44SBarry Smith       ierr = TSPostStep(ts);CHKERRQ(ierr);
3376c88f2d44SBarry Smith     }
3377d0578d90SShri Abhyankar #endif
3378c88f2d44SBarry Smith   }
3379c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3380e87fd094SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0], ((PetscObject) ts)->prefix, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3381c88f2d44SBarry Smith   PetscFunctionReturn(0);
3382c88f2d44SBarry Smith }
3383c88f2d44SBarry Smith 
3384c88f2d44SBarry Smith #undef __FUNCT__
3385d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
3386228d79bcSJed Brown /*@
3387228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3388228d79bcSJed Brown 
3389228d79bcSJed Brown    Collective on TS
3390228d79bcSJed Brown 
3391228d79bcSJed Brown    Input Parameters:
3392228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3393228d79bcSJed Brown .  step - step number that has just completed
3394228d79bcSJed Brown .  ptime - model time of the state
33950910c330SBarry Smith -  u - state at the current model time
3396228d79bcSJed Brown 
3397228d79bcSJed Brown    Notes:
3398228d79bcSJed Brown    TSMonitor() is typically used within the time stepping implementations.
3399228d79bcSJed Brown    Users might call this function when using the TSStep() interface instead of TSSolve().
3400228d79bcSJed Brown 
3401228d79bcSJed Brown    Level: advanced
3402228d79bcSJed Brown 
3403228d79bcSJed Brown .keywords: TS, timestep
3404228d79bcSJed Brown @*/
34050910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3406d763cef2SBarry Smith {
3407d763cef2SBarry Smith   PetscErrorCode ierr;
3408d763cef2SBarry Smith   PetscInt       i,n = ts->numbermonitors;
3409d763cef2SBarry Smith 
3410d763cef2SBarry Smith   PetscFunctionBegin;
3411b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3412b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
34135edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3414d763cef2SBarry Smith   for (i=0; i<n; i++) {
34150910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3416d763cef2SBarry Smith   }
34175edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3418d763cef2SBarry Smith   PetscFunctionReturn(0);
3419d763cef2SBarry Smith }
3420d763cef2SBarry Smith 
3421d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
3422d763cef2SBarry Smith #undef __FUNCT__
3423a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3424d763cef2SBarry Smith /*@C
3425a9f9c1f6SBarry Smith    TSMonitorLGCtxCreate - Creates a line graph context for use with
3426a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3427d763cef2SBarry Smith 
3428d763cef2SBarry Smith    Collective on TS
3429d763cef2SBarry Smith 
3430d763cef2SBarry Smith    Input Parameters:
3431d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3432d763cef2SBarry Smith .  label - the title to put in the title bar
34337c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3434a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3435a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3436d763cef2SBarry Smith 
3437d763cef2SBarry Smith    Output Parameter:
34380b039ecaSBarry Smith .  ctx - the context
3439d763cef2SBarry Smith 
3440d763cef2SBarry Smith    Options Database Key:
34414f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
34424f09c107SBarry Smith .  -ts_monitor_lg_solution -
344399fdda47SBarry Smith .  -ts_monitor_lg_error -
344499fdda47SBarry Smith .  -ts_monitor_lg_ksp_iterations -
344599fdda47SBarry Smith .  -ts_monitor_lg_snes_iterations -
3446b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3447d763cef2SBarry Smith 
3448d763cef2SBarry Smith    Notes:
3449a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3450d763cef2SBarry Smith 
3451d763cef2SBarry Smith    Level: intermediate
3452d763cef2SBarry Smith 
34537c922b88SBarry Smith .keywords: TS, monitor, line graph, residual, seealso
3454d763cef2SBarry Smith 
34554f09c107SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
34567c922b88SBarry Smith 
3457d763cef2SBarry Smith @*/
3458a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3459d763cef2SBarry Smith {
3460b0a32e0cSBarry Smith   PetscDraw      win;
3461dfbe8321SBarry Smith   PetscErrorCode ierr;
3462d763cef2SBarry Smith 
3463d763cef2SBarry Smith   PetscFunctionBegin;
3464b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
3465a80ad3e0SBarry Smith   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&win);CHKERRQ(ierr);
34663fbbecb0SBarry Smith   ierr = PetscDrawSetFromOptions(win);CHKERRQ(ierr);
34670b039ecaSBarry Smith   ierr = PetscDrawLGCreate(win,1,&(*ctx)->lg);CHKERRQ(ierr);
34683bb1ff40SBarry Smith   ierr = PetscLogObjectParent((PetscObject)(*ctx)->lg,(PetscObject)win);CHKERRQ(ierr);
3469b6fe0379SLisandro Dalcin   ierr = PetscDrawLGSetUseMarkers((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3470287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
3471a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3472d763cef2SBarry Smith   PetscFunctionReturn(0);
3473d763cef2SBarry Smith }
3474d763cef2SBarry Smith 
34754a2ae208SSatish Balay #undef __FUNCT__
34764f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3477b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3478d763cef2SBarry Smith {
34790b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3480c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3481dfbe8321SBarry Smith   PetscErrorCode ierr;
3482d763cef2SBarry Smith 
3483d763cef2SBarry Smith   PetscFunctionBegin;
3484b06615a5SLisandro Dalcin   if (!step) {
3485a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3486a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3487a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3488a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3489a9f9c1f6SBarry Smith   }
3490c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
34910b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3492b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
34930b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
34943923b477SBarry Smith   }
3495d763cef2SBarry Smith   PetscFunctionReturn(0);
3496d763cef2SBarry Smith }
3497d763cef2SBarry Smith 
34984a2ae208SSatish Balay #undef __FUNCT__
3499a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3500d763cef2SBarry Smith /*@C
3501a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3502a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3503d763cef2SBarry Smith 
35040b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3505d763cef2SBarry Smith 
3506d763cef2SBarry Smith    Input Parameter:
35070b039ecaSBarry Smith .  ctx - the monitor context
3508d763cef2SBarry Smith 
3509d763cef2SBarry Smith    Level: intermediate
3510d763cef2SBarry Smith 
3511d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3512d763cef2SBarry Smith 
35134f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3514d763cef2SBarry Smith @*/
3515a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3516d763cef2SBarry Smith {
3517b0a32e0cSBarry Smith   PetscDraw      draw;
3518dfbe8321SBarry Smith   PetscErrorCode ierr;
3519d763cef2SBarry Smith 
3520d763cef2SBarry Smith   PetscFunctionBegin;
35217684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
35227684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
35237684fa3eSBarry Smith   }
35240b039ecaSBarry Smith   ierr = PetscDrawLGGetDraw((*ctx)->lg,&draw);CHKERRQ(ierr);
35256bf464f9SBarry Smith   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
35260b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
352731152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3528387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3529387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3530387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
35310b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3532d763cef2SBarry Smith   PetscFunctionReturn(0);
3533d763cef2SBarry Smith }
3534d763cef2SBarry Smith 
35354a2ae208SSatish Balay #undef __FUNCT__
35364a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3537d763cef2SBarry Smith /*@
3538b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3539d763cef2SBarry Smith 
3540d763cef2SBarry Smith    Not Collective
3541d763cef2SBarry Smith 
3542d763cef2SBarry Smith    Input Parameter:
3543d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3544d763cef2SBarry Smith 
3545d763cef2SBarry Smith    Output Parameter:
3546d763cef2SBarry Smith .  t  - the current time
3547d763cef2SBarry Smith 
3548d763cef2SBarry Smith    Level: beginner
3549d763cef2SBarry Smith 
3550b8123daeSJed Brown    Note:
3551b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
35529be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3553b8123daeSJed Brown 
3554d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3555d763cef2SBarry Smith 
3556d763cef2SBarry Smith .keywords: TS, get, time
3557d763cef2SBarry Smith @*/
35587087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3559d763cef2SBarry Smith {
3560d763cef2SBarry Smith   PetscFunctionBegin;
35610700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3562f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3563d763cef2SBarry Smith   *t = ts->ptime;
3564d763cef2SBarry Smith   PetscFunctionReturn(0);
3565d763cef2SBarry Smith }
3566d763cef2SBarry Smith 
35674a2ae208SSatish Balay #undef __FUNCT__
3568e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3569e5e524a1SHong Zhang /*@
3570e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3571e5e524a1SHong Zhang 
3572e5e524a1SHong Zhang    Not Collective
3573e5e524a1SHong Zhang 
3574e5e524a1SHong Zhang    Input Parameter:
3575e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3576e5e524a1SHong Zhang 
3577e5e524a1SHong Zhang    Output Parameter:
3578e5e524a1SHong Zhang .  t  - the previous time
3579e5e524a1SHong Zhang 
3580e5e524a1SHong Zhang    Level: beginner
3581e5e524a1SHong Zhang 
3582e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3583e5e524a1SHong Zhang 
3584e5e524a1SHong Zhang .keywords: TS, get, time
3585e5e524a1SHong Zhang @*/
3586e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3587e5e524a1SHong Zhang {
3588e5e524a1SHong Zhang   PetscFunctionBegin;
3589e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3590e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3591e5e524a1SHong Zhang   *t = ts->ptime_prev;
3592e5e524a1SHong Zhang   PetscFunctionReturn(0);
3593e5e524a1SHong Zhang }
3594e5e524a1SHong Zhang 
3595e5e524a1SHong Zhang #undef __FUNCT__
35966a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
35976a4d4014SLisandro Dalcin /*@
35986a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
35996a4d4014SLisandro Dalcin 
36003f9fe445SBarry Smith    Logically Collective on TS
36016a4d4014SLisandro Dalcin 
36026a4d4014SLisandro Dalcin    Input Parameters:
36036a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
36046a4d4014SLisandro Dalcin -  time - the time
36056a4d4014SLisandro Dalcin 
36066a4d4014SLisandro Dalcin    Level: intermediate
36076a4d4014SLisandro Dalcin 
36086a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
36096a4d4014SLisandro Dalcin 
36106a4d4014SLisandro Dalcin .keywords: TS, set, time
36116a4d4014SLisandro Dalcin @*/
36127087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
36136a4d4014SLisandro Dalcin {
36146a4d4014SLisandro Dalcin   PetscFunctionBegin;
36150700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3616c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
36176a4d4014SLisandro Dalcin   ts->ptime = t;
36186a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
36196a4d4014SLisandro Dalcin }
36206a4d4014SLisandro Dalcin 
36216a4d4014SLisandro Dalcin #undef __FUNCT__
36224a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3623d763cef2SBarry Smith /*@C
3624d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3625d763cef2SBarry Smith    TS options in the database.
3626d763cef2SBarry Smith 
36273f9fe445SBarry Smith    Logically Collective on TS
3628d763cef2SBarry Smith 
3629d763cef2SBarry Smith    Input Parameter:
3630d763cef2SBarry Smith +  ts     - The TS context
3631d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3632d763cef2SBarry Smith 
3633d763cef2SBarry Smith    Notes:
3634d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3635d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3636d763cef2SBarry Smith    hyphen.
3637d763cef2SBarry Smith 
3638d763cef2SBarry Smith    Level: advanced
3639d763cef2SBarry Smith 
3640d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3641d763cef2SBarry Smith 
3642d763cef2SBarry Smith .seealso: TSSetFromOptions()
3643d763cef2SBarry Smith 
3644d763cef2SBarry Smith @*/
36457087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3646d763cef2SBarry Smith {
3647dfbe8321SBarry Smith   PetscErrorCode ierr;
3648089b2837SJed Brown   SNES           snes;
3649d763cef2SBarry Smith 
3650d763cef2SBarry Smith   PetscFunctionBegin;
36510700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3652d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3653089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3654089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3655d763cef2SBarry Smith   PetscFunctionReturn(0);
3656d763cef2SBarry Smith }
3657d763cef2SBarry Smith 
3658d763cef2SBarry Smith 
36594a2ae208SSatish Balay #undef __FUNCT__
36604a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3661d763cef2SBarry Smith /*@C
3662d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3663d763cef2SBarry Smith    TS options in the database.
3664d763cef2SBarry Smith 
36653f9fe445SBarry Smith    Logically Collective on TS
3666d763cef2SBarry Smith 
3667d763cef2SBarry Smith    Input Parameter:
3668d763cef2SBarry Smith +  ts     - The TS context
3669d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3670d763cef2SBarry Smith 
3671d763cef2SBarry Smith    Notes:
3672d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3673d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3674d763cef2SBarry Smith    hyphen.
3675d763cef2SBarry Smith 
3676d763cef2SBarry Smith    Level: advanced
3677d763cef2SBarry Smith 
3678d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3679d763cef2SBarry Smith 
3680d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3681d763cef2SBarry Smith 
3682d763cef2SBarry Smith @*/
36837087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3684d763cef2SBarry Smith {
3685dfbe8321SBarry Smith   PetscErrorCode ierr;
3686089b2837SJed Brown   SNES           snes;
3687d763cef2SBarry Smith 
3688d763cef2SBarry Smith   PetscFunctionBegin;
36890700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3690d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3691089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3692089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3693d763cef2SBarry Smith   PetscFunctionReturn(0);
3694d763cef2SBarry Smith }
3695d763cef2SBarry Smith 
36964a2ae208SSatish Balay #undef __FUNCT__
36974a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3698d763cef2SBarry Smith /*@C
3699d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3700d763cef2SBarry Smith    TS options in the database.
3701d763cef2SBarry Smith 
3702d763cef2SBarry Smith    Not Collective
3703d763cef2SBarry Smith 
3704d763cef2SBarry Smith    Input Parameter:
3705d763cef2SBarry Smith .  ts - The TS context
3706d763cef2SBarry Smith 
3707d763cef2SBarry Smith    Output Parameter:
3708d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3709d763cef2SBarry Smith 
3710d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3711d763cef2SBarry Smith    sufficient length to hold the prefix.
3712d763cef2SBarry Smith 
3713d763cef2SBarry Smith    Level: intermediate
3714d763cef2SBarry Smith 
3715d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3716d763cef2SBarry Smith 
3717d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3718d763cef2SBarry Smith @*/
37197087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3720d763cef2SBarry Smith {
3721dfbe8321SBarry Smith   PetscErrorCode ierr;
3722d763cef2SBarry Smith 
3723d763cef2SBarry Smith   PetscFunctionBegin;
37240700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
37254482741eSBarry Smith   PetscValidPointer(prefix,2);
3726d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3727d763cef2SBarry Smith   PetscFunctionReturn(0);
3728d763cef2SBarry Smith }
3729d763cef2SBarry Smith 
37304a2ae208SSatish Balay #undef __FUNCT__
37314a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3732d763cef2SBarry Smith /*@C
3733d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3734d763cef2SBarry Smith 
3735d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3736d763cef2SBarry Smith 
3737d763cef2SBarry Smith    Input Parameter:
3738d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3739d763cef2SBarry Smith 
3740d763cef2SBarry Smith    Output Parameters:
3741e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3742e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3743e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3744e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3745d763cef2SBarry Smith 
37460298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3747d763cef2SBarry Smith 
3748d763cef2SBarry Smith    Level: intermediate
3749d763cef2SBarry Smith 
375026d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3751d763cef2SBarry Smith 
3752d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3753d763cef2SBarry Smith @*/
3754e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3755d763cef2SBarry Smith {
3756089b2837SJed Brown   PetscErrorCode ierr;
3757089b2837SJed Brown   SNES           snes;
375824989b8cSPeter Brune   DM             dm;
3759089b2837SJed Brown 
3760d763cef2SBarry Smith   PetscFunctionBegin;
3761089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3762e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
376324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
376424989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3765d763cef2SBarry Smith   PetscFunctionReturn(0);
3766d763cef2SBarry Smith }
3767d763cef2SBarry Smith 
37681713a123SBarry Smith #undef __FUNCT__
37692eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
37702eca1d9cSJed Brown /*@C
37712eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
37722eca1d9cSJed Brown 
37732eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
37742eca1d9cSJed Brown 
37752eca1d9cSJed Brown    Input Parameter:
37762eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
37772eca1d9cSJed Brown 
37782eca1d9cSJed Brown    Output Parameters:
3779e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3780e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
37812eca1d9cSJed Brown .  f   - The function to compute the matrices
37822eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
37832eca1d9cSJed Brown 
37840298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
37852eca1d9cSJed Brown 
37862eca1d9cSJed Brown    Level: advanced
37872eca1d9cSJed Brown 
37882eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
37892eca1d9cSJed Brown 
37902eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
37912eca1d9cSJed Brown @*/
3792e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
37932eca1d9cSJed Brown {
3794089b2837SJed Brown   PetscErrorCode ierr;
3795089b2837SJed Brown   SNES           snes;
379624989b8cSPeter Brune   DM             dm;
37970910c330SBarry Smith 
37982eca1d9cSJed Brown   PetscFunctionBegin;
3799089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3800f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3801e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
380224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
380324989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
38042eca1d9cSJed Brown   PetscFunctionReturn(0);
38052eca1d9cSJed Brown }
38062eca1d9cSJed Brown 
38076083293cSBarry Smith 
38082eca1d9cSJed Brown #undef __FUNCT__
380983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
38101713a123SBarry Smith /*@C
381183a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
38121713a123SBarry Smith    VecView() for the solution at each timestep
38131713a123SBarry Smith 
38141713a123SBarry Smith    Collective on TS
38151713a123SBarry Smith 
38161713a123SBarry Smith    Input Parameters:
38171713a123SBarry Smith +  ts - the TS context
38181713a123SBarry Smith .  step - current time-step
3819142b95e3SSatish Balay .  ptime - current time
38200298fd71SBarry Smith -  dummy - either a viewer or NULL
38211713a123SBarry Smith 
382299fdda47SBarry Smith    Options Database:
382399fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
382499fdda47SBarry Smith 
3825387f4636SBarry 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
382699fdda47SBarry Smith        will look bad
382799fdda47SBarry Smith 
38281713a123SBarry Smith    Level: intermediate
38291713a123SBarry Smith 
38301713a123SBarry Smith .keywords: TS,  vector, monitor, view
38311713a123SBarry Smith 
3832a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38331713a123SBarry Smith @*/
38340910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38351713a123SBarry Smith {
3836dfbe8321SBarry Smith   PetscErrorCode   ierr;
383783a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
3838473a3ab2SBarry Smith   PetscDraw        draw;
38391713a123SBarry Smith 
38401713a123SBarry Smith   PetscFunctionBegin;
38416083293cSBarry Smith   if (!step && ictx->showinitial) {
38426083293cSBarry Smith     if (!ictx->initialsolution) {
38430910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
38441713a123SBarry Smith     }
38450910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
38466083293cSBarry Smith   }
3847b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
38480dcf80beSBarry Smith 
38496083293cSBarry Smith   if (ictx->showinitial) {
38506083293cSBarry Smith     PetscReal pause;
38516083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
38526083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
38536083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
38546083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
38556083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
38566083293cSBarry Smith   }
38570910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
3858473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
385951fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
3860473a3ab2SBarry Smith     char      time[32];
3861473a3ab2SBarry Smith 
3862473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
386385b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
3864473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
3865473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
386651fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
3867473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
3868473a3ab2SBarry Smith   }
3869473a3ab2SBarry Smith 
38706083293cSBarry Smith   if (ictx->showinitial) {
38716083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
38726083293cSBarry Smith   }
38731713a123SBarry Smith   PetscFunctionReturn(0);
38741713a123SBarry Smith }
38751713a123SBarry Smith 
38762d5ee99bSBarry Smith #undef __FUNCT__
38772d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
38782d5ee99bSBarry Smith /*@C
38792d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
38802d5ee99bSBarry Smith 
38812d5ee99bSBarry Smith    Collective on TS
38822d5ee99bSBarry Smith 
38832d5ee99bSBarry Smith    Input Parameters:
38842d5ee99bSBarry Smith +  ts - the TS context
38852d5ee99bSBarry Smith .  step - current time-step
38862d5ee99bSBarry Smith .  ptime - current time
38872d5ee99bSBarry Smith -  dummy - either a viewer or NULL
38882d5ee99bSBarry Smith 
38892d5ee99bSBarry Smith    Level: intermediate
38902d5ee99bSBarry Smith 
38912d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
38922d5ee99bSBarry Smith 
38932d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
38942d5ee99bSBarry Smith @*/
38952d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
38962d5ee99bSBarry Smith {
38972d5ee99bSBarry Smith   PetscErrorCode    ierr;
38982d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
38992d5ee99bSBarry Smith   PetscDraw         draw;
39002d5ee99bSBarry Smith   MPI_Comm          comm;
39012d5ee99bSBarry Smith   PetscInt          n;
39022d5ee99bSBarry Smith   PetscMPIInt       size;
390351fa3d41SBarry Smith   PetscReal         xl,yl,xr,yr,h;
39042d5ee99bSBarry Smith   char              time[32];
39052d5ee99bSBarry Smith   const PetscScalar *U;
39062d5ee99bSBarry Smith 
39072d5ee99bSBarry Smith   PetscFunctionBegin;
39082d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
39092d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
39102d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
39112d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
39122d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
39132d5ee99bSBarry Smith 
39142d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
39152d5ee99bSBarry Smith 
39162d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
39174b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
3918ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
3919a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
3920a4494fc1SBarry Smith       PetscFunctionReturn(0);
3921a4494fc1SBarry Smith   }
39222d5ee99bSBarry Smith   if (!step) ictx->color++;
39232d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
39242d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
39252d5ee99bSBarry Smith 
39262d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
39274b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
392885b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
39292d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
393051fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
39312d5ee99bSBarry Smith   }
39322d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
39332d5ee99bSBarry Smith   PetscFunctionReturn(0);
39342d5ee99bSBarry Smith }
39352d5ee99bSBarry Smith 
39361713a123SBarry Smith 
39376c699258SBarry Smith #undef __FUNCT__
393883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
39396083293cSBarry Smith /*@C
394083a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
39416083293cSBarry Smith 
39426083293cSBarry Smith    Collective on TS
39436083293cSBarry Smith 
39446083293cSBarry Smith    Input Parameters:
39456083293cSBarry Smith .    ctx - the monitor context
39466083293cSBarry Smith 
39476083293cSBarry Smith    Level: intermediate
39486083293cSBarry Smith 
39496083293cSBarry Smith .keywords: TS,  vector, monitor, view
39506083293cSBarry Smith 
395183a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
39526083293cSBarry Smith @*/
395383a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
39546083293cSBarry Smith {
39556083293cSBarry Smith   PetscErrorCode ierr;
39566083293cSBarry Smith 
39576083293cSBarry Smith   PetscFunctionBegin;
39584b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
395983a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
396083a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
396183a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
39626083293cSBarry Smith   PetscFunctionReturn(0);
39636083293cSBarry Smith }
39646083293cSBarry Smith 
39656083293cSBarry Smith #undef __FUNCT__
396683a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
39676083293cSBarry Smith /*@C
396883a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
39696083293cSBarry Smith 
39706083293cSBarry Smith    Collective on TS
39716083293cSBarry Smith 
39726083293cSBarry Smith    Input Parameter:
39736083293cSBarry Smith .    ts - time-step context
39746083293cSBarry Smith 
39756083293cSBarry Smith    Output Patameter:
39766083293cSBarry Smith .    ctx - the monitor context
39776083293cSBarry Smith 
397899fdda47SBarry Smith    Options Database:
397999fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
398099fdda47SBarry Smith 
39816083293cSBarry Smith    Level: intermediate
39826083293cSBarry Smith 
39836083293cSBarry Smith .keywords: TS,  vector, monitor, view
39846083293cSBarry Smith 
398583a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
39866083293cSBarry Smith @*/
398783a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
39886083293cSBarry Smith {
39896083293cSBarry Smith   PetscErrorCode   ierr;
39906083293cSBarry Smith 
39916083293cSBarry Smith   PetscFunctionBegin;
3992b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
399383a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
3994e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
3995bbd56ea5SKarl Rupp 
399683a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
3997473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
39980298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
3999473a3ab2SBarry Smith 
4000473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
40010298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
40022d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
40036083293cSBarry Smith   PetscFunctionReturn(0);
40046083293cSBarry Smith }
40056083293cSBarry Smith 
40066083293cSBarry Smith #undef __FUNCT__
400783a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
40083a471f94SBarry Smith /*@C
400983a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
40103a471f94SBarry Smith    VecView() for the error at each timestep
40113a471f94SBarry Smith 
40123a471f94SBarry Smith    Collective on TS
40133a471f94SBarry Smith 
40143a471f94SBarry Smith    Input Parameters:
40153a471f94SBarry Smith +  ts - the TS context
40163a471f94SBarry Smith .  step - current time-step
40173a471f94SBarry Smith .  ptime - current time
40180298fd71SBarry Smith -  dummy - either a viewer or NULL
40193a471f94SBarry Smith 
40203a471f94SBarry Smith    Level: intermediate
40213a471f94SBarry Smith 
40223a471f94SBarry Smith .keywords: TS,  vector, monitor, view
40233a471f94SBarry Smith 
40243a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
40253a471f94SBarry Smith @*/
40260910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
40273a471f94SBarry Smith {
40283a471f94SBarry Smith   PetscErrorCode   ierr;
402983a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
403083a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
40313a471f94SBarry Smith   Vec              work;
40323a471f94SBarry Smith 
40333a471f94SBarry Smith   PetscFunctionBegin;
4034b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40350910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
40363a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
40370910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
40383a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
40393a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
40403a471f94SBarry Smith   PetscFunctionReturn(0);
40413a471f94SBarry Smith }
40423a471f94SBarry Smith 
4043af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
40443a471f94SBarry Smith #undef __FUNCT__
40456c699258SBarry Smith #define __FUNCT__ "TSSetDM"
40466c699258SBarry Smith /*@
40476c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
40486c699258SBarry Smith 
40493f9fe445SBarry Smith    Logically Collective on TS and DM
40506c699258SBarry Smith 
40516c699258SBarry Smith    Input Parameters:
40526c699258SBarry Smith +  ts - the preconditioner context
40536c699258SBarry Smith -  dm - the dm
40546c699258SBarry Smith 
40556c699258SBarry Smith    Level: intermediate
40566c699258SBarry Smith 
40576c699258SBarry Smith 
40586c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
40596c699258SBarry Smith @*/
40607087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
40616c699258SBarry Smith {
40626c699258SBarry Smith   PetscErrorCode ierr;
4063089b2837SJed Brown   SNES           snes;
4064942e3340SBarry Smith   DMTS           tsdm;
40656c699258SBarry Smith 
40666c699258SBarry Smith   PetscFunctionBegin;
40670700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
406870663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4069942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
40702a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4071942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4072942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
407324989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
407424989b8cSPeter Brune         tsdm->originaldm = dm;
407524989b8cSPeter Brune       }
407624989b8cSPeter Brune     }
40776bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
407824989b8cSPeter Brune   }
40796c699258SBarry Smith   ts->dm = dm;
4080bbd56ea5SKarl Rupp 
4081089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4082089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
40836c699258SBarry Smith   PetscFunctionReturn(0);
40846c699258SBarry Smith }
40856c699258SBarry Smith 
40866c699258SBarry Smith #undef __FUNCT__
40876c699258SBarry Smith #define __FUNCT__ "TSGetDM"
40886c699258SBarry Smith /*@
40896c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
40906c699258SBarry Smith 
40913f9fe445SBarry Smith    Not Collective
40926c699258SBarry Smith 
40936c699258SBarry Smith    Input Parameter:
40946c699258SBarry Smith . ts - the preconditioner context
40956c699258SBarry Smith 
40966c699258SBarry Smith    Output Parameter:
40976c699258SBarry Smith .  dm - the dm
40986c699258SBarry Smith 
40996c699258SBarry Smith    Level: intermediate
41006c699258SBarry Smith 
41016c699258SBarry Smith 
41026c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
41036c699258SBarry Smith @*/
41047087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
41056c699258SBarry Smith {
4106496e6a7aSJed Brown   PetscErrorCode ierr;
4107496e6a7aSJed Brown 
41086c699258SBarry Smith   PetscFunctionBegin;
41090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4110496e6a7aSJed Brown   if (!ts->dm) {
4111ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4112496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4113496e6a7aSJed Brown   }
41146c699258SBarry Smith   *dm = ts->dm;
41156c699258SBarry Smith   PetscFunctionReturn(0);
41166c699258SBarry Smith }
41171713a123SBarry Smith 
41180f5c6efeSJed Brown #undef __FUNCT__
41190f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
41200f5c6efeSJed Brown /*@
41210f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
41220f5c6efeSJed Brown 
41233f9fe445SBarry Smith    Logically Collective on SNES
41240f5c6efeSJed Brown 
41250f5c6efeSJed Brown    Input Parameter:
4126d42a1c89SJed Brown + snes - nonlinear solver
41270910c330SBarry Smith . U - the current state at which to evaluate the residual
4128d42a1c89SJed Brown - ctx - user context, must be a TS
41290f5c6efeSJed Brown 
41300f5c6efeSJed Brown    Output Parameter:
41310f5c6efeSJed Brown . F - the nonlinear residual
41320f5c6efeSJed Brown 
41330f5c6efeSJed Brown    Notes:
41340f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41350f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
41360f5c6efeSJed Brown 
41370f5c6efeSJed Brown    Level: advanced
41380f5c6efeSJed Brown 
41390f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
41400f5c6efeSJed Brown @*/
41410910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
41420f5c6efeSJed Brown {
41430f5c6efeSJed Brown   TS             ts = (TS)ctx;
41440f5c6efeSJed Brown   PetscErrorCode ierr;
41450f5c6efeSJed Brown 
41460f5c6efeSJed Brown   PetscFunctionBegin;
41470f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41480910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41490f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
41500f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
41510910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
41520f5c6efeSJed Brown   PetscFunctionReturn(0);
41530f5c6efeSJed Brown }
41540f5c6efeSJed Brown 
41550f5c6efeSJed Brown #undef __FUNCT__
41560f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
41570f5c6efeSJed Brown /*@
41580f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
41590f5c6efeSJed Brown 
41600f5c6efeSJed Brown    Collective on SNES
41610f5c6efeSJed Brown 
41620f5c6efeSJed Brown    Input Parameter:
41630f5c6efeSJed Brown + snes - nonlinear solver
41640910c330SBarry Smith . U - the current state at which to evaluate the residual
41650f5c6efeSJed Brown - ctx - user context, must be a TS
41660f5c6efeSJed Brown 
41670f5c6efeSJed Brown    Output Parameter:
41680f5c6efeSJed Brown + A - the Jacobian
41690f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
41700f5c6efeSJed Brown - flag - indicates any structure change in the matrix
41710f5c6efeSJed Brown 
41720f5c6efeSJed Brown    Notes:
41730f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
41740f5c6efeSJed Brown 
41750f5c6efeSJed Brown    Level: developer
41760f5c6efeSJed Brown 
41770f5c6efeSJed Brown .seealso: SNESSetJacobian()
41780f5c6efeSJed Brown @*/
4179d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
41800f5c6efeSJed Brown {
41810f5c6efeSJed Brown   TS             ts = (TS)ctx;
41820f5c6efeSJed Brown   PetscErrorCode ierr;
41830f5c6efeSJed Brown 
41840f5c6efeSJed Brown   PetscFunctionBegin;
41850f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
41860910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
41870f5c6efeSJed Brown   PetscValidPointer(A,3);
418894ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
41890f5c6efeSJed Brown   PetscValidPointer(B,4);
419094ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
41910f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4192d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
41930f5c6efeSJed Brown   PetscFunctionReturn(0);
41940f5c6efeSJed Brown }
4195325fc9f4SBarry Smith 
41960e4ef248SJed Brown #undef __FUNCT__
41970e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
41980e4ef248SJed Brown /*@C
41990e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
42000e4ef248SJed Brown 
42010e4ef248SJed Brown    Collective on TS
42020e4ef248SJed Brown 
42030e4ef248SJed Brown    Input Arguments:
42040e4ef248SJed Brown +  ts - time stepping context
42050e4ef248SJed Brown .  t - time at which to evaluate
42060910c330SBarry Smith .  U - state at which to evaluate
42070e4ef248SJed Brown -  ctx - context
42080e4ef248SJed Brown 
42090e4ef248SJed Brown    Output Arguments:
42100e4ef248SJed Brown .  F - right hand side
42110e4ef248SJed Brown 
42120e4ef248SJed Brown    Level: intermediate
42130e4ef248SJed Brown 
42140e4ef248SJed Brown    Notes:
42150e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
42160e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
42170e4ef248SJed Brown 
42180e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
42190e4ef248SJed Brown @*/
42200910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
42210e4ef248SJed Brown {
42220e4ef248SJed Brown   PetscErrorCode ierr;
42230e4ef248SJed Brown   Mat            Arhs,Brhs;
42240e4ef248SJed Brown 
42250e4ef248SJed Brown   PetscFunctionBegin;
42260e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4227d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
42280910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
42290e4ef248SJed Brown   PetscFunctionReturn(0);
42300e4ef248SJed Brown }
42310e4ef248SJed Brown 
42320e4ef248SJed Brown #undef __FUNCT__
42330e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
42340e4ef248SJed Brown /*@C
42350e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
42360e4ef248SJed Brown 
42370e4ef248SJed Brown    Collective on TS
42380e4ef248SJed Brown 
42390e4ef248SJed Brown    Input Arguments:
42400e4ef248SJed Brown +  ts - time stepping context
42410e4ef248SJed Brown .  t - time at which to evaluate
42420910c330SBarry Smith .  U - state at which to evaluate
42430e4ef248SJed Brown -  ctx - context
42440e4ef248SJed Brown 
42450e4ef248SJed Brown    Output Arguments:
42460e4ef248SJed Brown +  A - pointer to operator
42470e4ef248SJed Brown .  B - pointer to preconditioning matrix
42480e4ef248SJed Brown -  flg - matrix structure flag
42490e4ef248SJed Brown 
42500e4ef248SJed Brown    Level: intermediate
42510e4ef248SJed Brown 
42520e4ef248SJed Brown    Notes:
42530e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
42540e4ef248SJed Brown 
42550e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
42560e4ef248SJed Brown @*/
4257d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
42580e4ef248SJed Brown {
42590e4ef248SJed Brown   PetscFunctionBegin;
42600e4ef248SJed Brown   PetscFunctionReturn(0);
42610e4ef248SJed Brown }
42620e4ef248SJed Brown 
42630026cea9SSean Farley #undef __FUNCT__
42640026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
42650026cea9SSean Farley /*@C
42660026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
42670026cea9SSean Farley 
42680026cea9SSean Farley    Collective on TS
42690026cea9SSean Farley 
42700026cea9SSean Farley    Input Arguments:
42710026cea9SSean Farley +  ts - time stepping context
42720026cea9SSean Farley .  t - time at which to evaluate
42730910c330SBarry Smith .  U - state at which to evaluate
42740910c330SBarry Smith .  Udot - time derivative of state vector
42750026cea9SSean Farley -  ctx - context
42760026cea9SSean Farley 
42770026cea9SSean Farley    Output Arguments:
42780026cea9SSean Farley .  F - left hand side
42790026cea9SSean Farley 
42800026cea9SSean Farley    Level: intermediate
42810026cea9SSean Farley 
42820026cea9SSean Farley    Notes:
42830910c330SBarry 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
42840026cea9SSean Farley    user is required to write their own TSComputeIFunction.
42850026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
42860026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
42870026cea9SSean Farley 
42880026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
42890026cea9SSean Farley @*/
42900910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
42910026cea9SSean Farley {
42920026cea9SSean Farley   PetscErrorCode ierr;
42930026cea9SSean Farley   Mat            A,B;
42940026cea9SSean Farley 
42950026cea9SSean Farley   PetscFunctionBegin;
42960298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4297d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
42980910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
42990026cea9SSean Farley   PetscFunctionReturn(0);
43000026cea9SSean Farley }
43010026cea9SSean Farley 
43020026cea9SSean Farley #undef __FUNCT__
43030026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
43040026cea9SSean Farley /*@C
4305b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
43060026cea9SSean Farley 
43070026cea9SSean Farley    Collective on TS
43080026cea9SSean Farley 
43090026cea9SSean Farley    Input Arguments:
43100026cea9SSean Farley +  ts - time stepping context
43110026cea9SSean Farley .  t - time at which to evaluate
43120910c330SBarry Smith .  U - state at which to evaluate
43130910c330SBarry Smith .  Udot - time derivative of state vector
43140026cea9SSean Farley .  shift - shift to apply
43150026cea9SSean Farley -  ctx - context
43160026cea9SSean Farley 
43170026cea9SSean Farley    Output Arguments:
43180026cea9SSean Farley +  A - pointer to operator
43190026cea9SSean Farley .  B - pointer to preconditioning matrix
43200026cea9SSean Farley -  flg - matrix structure flag
43210026cea9SSean Farley 
4322b41af12eSJed Brown    Level: advanced
43230026cea9SSean Farley 
43240026cea9SSean Farley    Notes:
43250026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
43260026cea9SSean Farley 
4327b41af12eSJed Brown    It is only appropriate for problems of the form
4328b41af12eSJed Brown 
4329b41af12eSJed Brown $     M Udot = F(U,t)
4330b41af12eSJed Brown 
4331b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4332b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4333b41af12eSJed Brown   an implicit operator of the form
4334b41af12eSJed Brown 
4335b41af12eSJed Brown $    shift*M + J
4336b41af12eSJed Brown 
4337b41af12eSJed 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
4338b41af12eSJed Brown   a copy of M or reassemble it when requested.
4339b41af12eSJed Brown 
43400026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
43410026cea9SSean Farley @*/
4342d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
43430026cea9SSean Farley {
4344b41af12eSJed Brown   PetscErrorCode ierr;
4345b41af12eSJed Brown 
43460026cea9SSean Farley   PetscFunctionBegin;
434794ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4348b41af12eSJed Brown   ts->ijacobian.shift = shift;
43490026cea9SSean Farley   PetscFunctionReturn(0);
43500026cea9SSean Farley }
4351b41af12eSJed Brown 
4352e817cc15SEmil Constantinescu #undef __FUNCT__
4353e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4354e817cc15SEmil Constantinescu /*@
4355e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4356e817cc15SEmil Constantinescu 
4357e817cc15SEmil Constantinescu    Not Collective
4358e817cc15SEmil Constantinescu 
4359e817cc15SEmil Constantinescu    Input Parameter:
4360e817cc15SEmil Constantinescu .  ts - the TS context
4361e817cc15SEmil Constantinescu 
4362e817cc15SEmil Constantinescu    Output Parameter:
43634e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4364e817cc15SEmil Constantinescu 
4365e817cc15SEmil Constantinescu    Level: beginner
4366e817cc15SEmil Constantinescu 
4367e817cc15SEmil Constantinescu .keywords: TS, equation type
4368e817cc15SEmil Constantinescu 
4369e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4370e817cc15SEmil Constantinescu @*/
4371e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4372e817cc15SEmil Constantinescu {
4373e817cc15SEmil Constantinescu   PetscFunctionBegin;
4374e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4375e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4376e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4377e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4378e817cc15SEmil Constantinescu }
4379e817cc15SEmil Constantinescu 
4380e817cc15SEmil Constantinescu #undef __FUNCT__
4381e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4382e817cc15SEmil Constantinescu /*@
4383e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4384e817cc15SEmil Constantinescu 
4385e817cc15SEmil Constantinescu    Not Collective
4386e817cc15SEmil Constantinescu 
4387e817cc15SEmil Constantinescu    Input Parameter:
4388e817cc15SEmil Constantinescu +  ts - the TS context
43894e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4390e817cc15SEmil Constantinescu 
4391e817cc15SEmil Constantinescu    Level: advanced
4392e817cc15SEmil Constantinescu 
4393e817cc15SEmil Constantinescu .keywords: TS, equation type
4394e817cc15SEmil Constantinescu 
4395e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4396e817cc15SEmil Constantinescu @*/
4397e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4398e817cc15SEmil Constantinescu {
4399e817cc15SEmil Constantinescu   PetscFunctionBegin;
4400e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4401e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4402e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4403e817cc15SEmil Constantinescu }
44040026cea9SSean Farley 
44054af1b03aSJed Brown #undef __FUNCT__
44064af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
44074af1b03aSJed Brown /*@
44084af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
44094af1b03aSJed Brown 
44104af1b03aSJed Brown    Not Collective
44114af1b03aSJed Brown 
44124af1b03aSJed Brown    Input Parameter:
44134af1b03aSJed Brown .  ts - the TS context
44144af1b03aSJed Brown 
44154af1b03aSJed Brown    Output Parameter:
44164af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
44174af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
44184af1b03aSJed Brown 
4419487e0bb9SJed Brown    Level: beginner
44204af1b03aSJed Brown 
4421cd652676SJed Brown    Notes:
4422cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
44234af1b03aSJed Brown 
44244af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
44254af1b03aSJed Brown 
44264af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
44274af1b03aSJed Brown @*/
44284af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
44294af1b03aSJed Brown {
44304af1b03aSJed Brown   PetscFunctionBegin;
44314af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
44324af1b03aSJed Brown   PetscValidPointer(reason,2);
44334af1b03aSJed Brown   *reason = ts->reason;
44344af1b03aSJed Brown   PetscFunctionReturn(0);
44354af1b03aSJed Brown }
44364af1b03aSJed Brown 
4437fb1732b5SBarry Smith #undef __FUNCT__
4438d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4439d6ad946cSShri Abhyankar /*@
4440d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4441d6ad946cSShri Abhyankar 
4442d6ad946cSShri Abhyankar    Not Collective
4443d6ad946cSShri Abhyankar 
4444d6ad946cSShri Abhyankar    Input Parameter:
4445d6ad946cSShri Abhyankar +  ts - the TS context
4446d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4447d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4448d6ad946cSShri Abhyankar 
4449f5abba47SShri Abhyankar    Level: advanced
4450d6ad946cSShri Abhyankar 
4451d6ad946cSShri Abhyankar    Notes:
4452d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4453d6ad946cSShri Abhyankar 
4454d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4455d6ad946cSShri Abhyankar 
4456d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4457d6ad946cSShri Abhyankar @*/
4458d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4459d6ad946cSShri Abhyankar {
4460d6ad946cSShri Abhyankar   PetscFunctionBegin;
4461d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4462d6ad946cSShri Abhyankar   ts->reason = reason;
4463d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4464d6ad946cSShri Abhyankar }
4465d6ad946cSShri Abhyankar 
4466d6ad946cSShri Abhyankar #undef __FUNCT__
4467cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4468cc708dedSBarry Smith /*@
4469cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4470cc708dedSBarry Smith 
4471cc708dedSBarry Smith    Not Collective
4472cc708dedSBarry Smith 
4473cc708dedSBarry Smith    Input Parameter:
4474cc708dedSBarry Smith .  ts - the TS context
4475cc708dedSBarry Smith 
4476cc708dedSBarry Smith    Output Parameter:
4477cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4478cc708dedSBarry Smith 
4479487e0bb9SJed Brown    Level: beginner
4480cc708dedSBarry Smith 
4481cc708dedSBarry Smith    Notes:
4482cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4483cc708dedSBarry Smith 
4484cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4485cc708dedSBarry Smith 
4486cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4487cc708dedSBarry Smith @*/
4488cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4489cc708dedSBarry Smith {
4490cc708dedSBarry Smith   PetscFunctionBegin;
4491cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4492cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4493cc708dedSBarry Smith   *ftime = ts->solvetime;
4494cc708dedSBarry Smith   PetscFunctionReturn(0);
4495cc708dedSBarry Smith }
4496cc708dedSBarry Smith 
4497cc708dedSBarry Smith #undef __FUNCT__
44982c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
44992c18e0fdSBarry Smith /*@
45002c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
45012c18e0fdSBarry Smith 
45022c18e0fdSBarry Smith    Not Collective
45032c18e0fdSBarry Smith 
45042c18e0fdSBarry Smith    Input Parameter:
45052c18e0fdSBarry Smith .  ts - the TS context
45062c18e0fdSBarry Smith 
45072c18e0fdSBarry Smith    Output Parameter:
45082c18e0fdSBarry Smith .  steps - the number of steps
45092c18e0fdSBarry Smith 
45102c18e0fdSBarry Smith    Level: beginner
45112c18e0fdSBarry Smith 
45122c18e0fdSBarry Smith    Notes:
45132c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
45142c18e0fdSBarry Smith 
45152c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
45162c18e0fdSBarry Smith 
45172c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
45182c18e0fdSBarry Smith @*/
45192c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
45202c18e0fdSBarry Smith {
45212c18e0fdSBarry Smith   PetscFunctionBegin;
45222c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45232c18e0fdSBarry Smith   PetscValidPointer(steps,2);
45242c18e0fdSBarry Smith   *steps = ts->total_steps;
45252c18e0fdSBarry Smith   PetscFunctionReturn(0);
45262c18e0fdSBarry Smith }
45272c18e0fdSBarry Smith 
45282c18e0fdSBarry Smith #undef __FUNCT__
45295ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
45309f67acb7SJed Brown /*@
45315ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
45329f67acb7SJed Brown    used by the time integrator.
45339f67acb7SJed Brown 
45349f67acb7SJed Brown    Not Collective
45359f67acb7SJed Brown 
45369f67acb7SJed Brown    Input Parameter:
45379f67acb7SJed Brown .  ts - TS context
45389f67acb7SJed Brown 
45399f67acb7SJed Brown    Output Parameter:
45409f67acb7SJed Brown .  nits - number of nonlinear iterations
45419f67acb7SJed Brown 
45429f67acb7SJed Brown    Notes:
45439f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45449f67acb7SJed Brown 
45459f67acb7SJed Brown    Level: intermediate
45469f67acb7SJed Brown 
45479f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
45489f67acb7SJed Brown 
45495ef26d82SJed Brown .seealso:  TSGetKSPIterations()
45509f67acb7SJed Brown @*/
45515ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
45529f67acb7SJed Brown {
45539f67acb7SJed Brown   PetscFunctionBegin;
45549f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45559f67acb7SJed Brown   PetscValidIntPointer(nits,2);
45565ef26d82SJed Brown   *nits = ts->snes_its;
45579f67acb7SJed Brown   PetscFunctionReturn(0);
45589f67acb7SJed Brown }
45599f67acb7SJed Brown 
45609f67acb7SJed Brown #undef __FUNCT__
45615ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
45629f67acb7SJed Brown /*@
45635ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
45649f67acb7SJed Brown    used by the time integrator.
45659f67acb7SJed Brown 
45669f67acb7SJed Brown    Not Collective
45679f67acb7SJed Brown 
45689f67acb7SJed Brown    Input Parameter:
45699f67acb7SJed Brown .  ts - TS context
45709f67acb7SJed Brown 
45719f67acb7SJed Brown    Output Parameter:
45729f67acb7SJed Brown .  lits - number of linear iterations
45739f67acb7SJed Brown 
45749f67acb7SJed Brown    Notes:
45759f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
45769f67acb7SJed Brown 
45779f67acb7SJed Brown    Level: intermediate
45789f67acb7SJed Brown 
45799f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
45809f67acb7SJed Brown 
45815ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
45829f67acb7SJed Brown @*/
45835ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
45849f67acb7SJed Brown {
45859f67acb7SJed Brown   PetscFunctionBegin;
45869f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
45879f67acb7SJed Brown   PetscValidIntPointer(lits,2);
45885ef26d82SJed Brown   *lits = ts->ksp_its;
45899f67acb7SJed Brown   PetscFunctionReturn(0);
45909f67acb7SJed Brown }
45919f67acb7SJed Brown 
45929f67acb7SJed Brown #undef __FUNCT__
4593cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4594cef5090cSJed Brown /*@
4595cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4596cef5090cSJed Brown 
4597cef5090cSJed Brown    Not Collective
4598cef5090cSJed Brown 
4599cef5090cSJed Brown    Input Parameter:
4600cef5090cSJed Brown .  ts - TS context
4601cef5090cSJed Brown 
4602cef5090cSJed Brown    Output Parameter:
4603cef5090cSJed Brown .  rejects - number of steps rejected
4604cef5090cSJed Brown 
4605cef5090cSJed Brown    Notes:
4606cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4607cef5090cSJed Brown 
4608cef5090cSJed Brown    Level: intermediate
4609cef5090cSJed Brown 
4610cef5090cSJed Brown .keywords: TS, get, number
4611cef5090cSJed Brown 
46125ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4613cef5090cSJed Brown @*/
4614cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4615cef5090cSJed Brown {
4616cef5090cSJed Brown   PetscFunctionBegin;
4617cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4618cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4619cef5090cSJed Brown   *rejects = ts->reject;
4620cef5090cSJed Brown   PetscFunctionReturn(0);
4621cef5090cSJed Brown }
4622cef5090cSJed Brown 
4623cef5090cSJed Brown #undef __FUNCT__
4624cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4625cef5090cSJed Brown /*@
4626cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4627cef5090cSJed Brown 
4628cef5090cSJed Brown    Not Collective
4629cef5090cSJed Brown 
4630cef5090cSJed Brown    Input Parameter:
4631cef5090cSJed Brown .  ts - TS context
4632cef5090cSJed Brown 
4633cef5090cSJed Brown    Output Parameter:
4634cef5090cSJed Brown .  fails - number of failed nonlinear solves
4635cef5090cSJed Brown 
4636cef5090cSJed Brown    Notes:
4637cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4638cef5090cSJed Brown 
4639cef5090cSJed Brown    Level: intermediate
4640cef5090cSJed Brown 
4641cef5090cSJed Brown .keywords: TS, get, number
4642cef5090cSJed Brown 
46435ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4644cef5090cSJed Brown @*/
4645cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4646cef5090cSJed Brown {
4647cef5090cSJed Brown   PetscFunctionBegin;
4648cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4649cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4650cef5090cSJed Brown   *fails = ts->num_snes_failures;
4651cef5090cSJed Brown   PetscFunctionReturn(0);
4652cef5090cSJed Brown }
4653cef5090cSJed Brown 
4654cef5090cSJed Brown #undef __FUNCT__
4655cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4656cef5090cSJed Brown /*@
4657cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4658cef5090cSJed Brown 
4659cef5090cSJed Brown    Not Collective
4660cef5090cSJed Brown 
4661cef5090cSJed Brown    Input Parameter:
4662cef5090cSJed Brown +  ts - TS context
4663cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4664cef5090cSJed Brown 
4665cef5090cSJed Brown    Notes:
4666cef5090cSJed Brown    The counter is reset to zero for each step
4667cef5090cSJed Brown 
4668cef5090cSJed Brown    Options Database Key:
4669cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4670cef5090cSJed Brown 
4671cef5090cSJed Brown    Level: intermediate
4672cef5090cSJed Brown 
4673cef5090cSJed Brown .keywords: TS, set, maximum, number
4674cef5090cSJed Brown 
46755ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4676cef5090cSJed Brown @*/
4677cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4678cef5090cSJed Brown {
4679cef5090cSJed Brown   PetscFunctionBegin;
4680cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4681cef5090cSJed Brown   ts->max_reject = rejects;
4682cef5090cSJed Brown   PetscFunctionReturn(0);
4683cef5090cSJed Brown }
4684cef5090cSJed Brown 
4685cef5090cSJed Brown #undef __FUNCT__
4686cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4687cef5090cSJed Brown /*@
4688cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4689cef5090cSJed Brown 
4690cef5090cSJed Brown    Not Collective
4691cef5090cSJed Brown 
4692cef5090cSJed Brown    Input Parameter:
4693cef5090cSJed Brown +  ts - TS context
4694cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4695cef5090cSJed Brown 
4696cef5090cSJed Brown    Notes:
4697cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4698cef5090cSJed Brown 
4699cef5090cSJed Brown    Options Database Key:
4700cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4701cef5090cSJed Brown 
4702cef5090cSJed Brown    Level: intermediate
4703cef5090cSJed Brown 
4704cef5090cSJed Brown .keywords: TS, set, maximum, number
4705cef5090cSJed Brown 
47065ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4707cef5090cSJed Brown @*/
4708cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4709cef5090cSJed Brown {
4710cef5090cSJed Brown   PetscFunctionBegin;
4711cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4712cef5090cSJed Brown   ts->max_snes_failures = fails;
4713cef5090cSJed Brown   PetscFunctionReturn(0);
4714cef5090cSJed Brown }
4715cef5090cSJed Brown 
4716cef5090cSJed Brown #undef __FUNCT__
47174e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4718cef5090cSJed Brown /*@
4719cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4720cef5090cSJed Brown 
4721cef5090cSJed Brown    Not Collective
4722cef5090cSJed Brown 
4723cef5090cSJed Brown    Input Parameter:
4724cef5090cSJed Brown +  ts - TS context
4725cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4726cef5090cSJed Brown 
4727cef5090cSJed Brown    Options Database Key:
4728cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4729cef5090cSJed Brown 
4730cef5090cSJed Brown    Level: intermediate
4731cef5090cSJed Brown 
4732cef5090cSJed Brown .keywords: TS, set, error
4733cef5090cSJed Brown 
47345ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4735cef5090cSJed Brown @*/
4736cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4737cef5090cSJed Brown {
4738cef5090cSJed Brown   PetscFunctionBegin;
4739cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4740cef5090cSJed Brown   ts->errorifstepfailed = err;
4741cef5090cSJed Brown   PetscFunctionReturn(0);
4742cef5090cSJed Brown }
4743cef5090cSJed Brown 
4744cef5090cSJed Brown #undef __FUNCT__
4745fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4746fb1732b5SBarry Smith /*@C
4747fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4748fb1732b5SBarry Smith 
4749fb1732b5SBarry Smith    Collective on TS
4750fb1732b5SBarry Smith 
4751fb1732b5SBarry Smith    Input Parameters:
4752fb1732b5SBarry Smith +  ts - the TS context
4753fb1732b5SBarry Smith .  step - current time-step
4754fb1732b5SBarry Smith .  ptime - current time
47550910c330SBarry Smith .  u - current state
4756fb1732b5SBarry Smith -  viewer - binary viewer
4757fb1732b5SBarry Smith 
4758fb1732b5SBarry Smith    Level: intermediate
4759fb1732b5SBarry Smith 
4760fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4761fb1732b5SBarry Smith 
4762fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4763fb1732b5SBarry Smith @*/
47640910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4765fb1732b5SBarry Smith {
4766fb1732b5SBarry Smith   PetscErrorCode ierr;
4767ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
4768fb1732b5SBarry Smith 
4769fb1732b5SBarry Smith   PetscFunctionBegin;
47700910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
4771ed81e22dSJed Brown   PetscFunctionReturn(0);
4772ed81e22dSJed Brown }
4773ed81e22dSJed Brown 
4774ed81e22dSJed Brown #undef __FUNCT__
4775ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
4776ed81e22dSJed Brown /*@C
4777ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
4778ed81e22dSJed Brown 
4779ed81e22dSJed Brown    Collective on TS
4780ed81e22dSJed Brown 
4781ed81e22dSJed Brown    Input Parameters:
4782ed81e22dSJed Brown +  ts - the TS context
4783ed81e22dSJed Brown .  step - current time-step
4784ed81e22dSJed Brown .  ptime - current time
47850910c330SBarry Smith .  u - current state
4786ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4787ed81e22dSJed Brown 
4788ed81e22dSJed Brown    Level: intermediate
4789ed81e22dSJed Brown 
4790ed81e22dSJed Brown    Notes:
4791ed81e22dSJed 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.
4792ed81e22dSJed Brown    These are named according to the file name template.
4793ed81e22dSJed Brown 
4794ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
4795ed81e22dSJed Brown 
4796ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4797ed81e22dSJed Brown 
4798ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4799ed81e22dSJed Brown @*/
48000910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
4801ed81e22dSJed Brown {
4802ed81e22dSJed Brown   PetscErrorCode ierr;
4803ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
4804ed81e22dSJed Brown   PetscViewer    viewer;
4805ed81e22dSJed Brown 
4806ed81e22dSJed Brown   PetscFunctionBegin;
48078caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
4808ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
48090910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
4810ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
4811ed81e22dSJed Brown   PetscFunctionReturn(0);
4812ed81e22dSJed Brown }
4813ed81e22dSJed Brown 
4814ed81e22dSJed Brown #undef __FUNCT__
4815ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
4816ed81e22dSJed Brown /*@C
4817ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
4818ed81e22dSJed Brown 
4819ed81e22dSJed Brown    Collective on TS
4820ed81e22dSJed Brown 
4821ed81e22dSJed Brown    Input Parameters:
4822ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
4823ed81e22dSJed Brown 
4824ed81e22dSJed Brown    Level: intermediate
4825ed81e22dSJed Brown 
4826ed81e22dSJed Brown    Note:
4827ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
4828ed81e22dSJed Brown 
4829ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
4830ed81e22dSJed Brown 
4831ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
4832ed81e22dSJed Brown @*/
4833ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
4834ed81e22dSJed Brown {
4835ed81e22dSJed Brown   PetscErrorCode ierr;
4836ed81e22dSJed Brown 
4837ed81e22dSJed Brown   PetscFunctionBegin;
4838ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
4839fb1732b5SBarry Smith   PetscFunctionReturn(0);
4840fb1732b5SBarry Smith }
4841fb1732b5SBarry Smith 
484284df9cb4SJed Brown #undef __FUNCT__
4843552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
484484df9cb4SJed Brown /*@
4845552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
484684df9cb4SJed Brown 
4847ed81e22dSJed Brown    Collective on TS if controller has not been created yet
484884df9cb4SJed Brown 
484984df9cb4SJed Brown    Input Arguments:
4850ed81e22dSJed Brown .  ts - time stepping context
485184df9cb4SJed Brown 
485284df9cb4SJed Brown    Output Arguments:
4853ed81e22dSJed Brown .  adapt - adaptive controller
485484df9cb4SJed Brown 
485584df9cb4SJed Brown    Level: intermediate
485684df9cb4SJed Brown 
4857ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
485884df9cb4SJed Brown @*/
4859552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
486084df9cb4SJed Brown {
486184df9cb4SJed Brown   PetscErrorCode ierr;
486284df9cb4SJed Brown 
486384df9cb4SJed Brown   PetscFunctionBegin;
486484df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
486584df9cb4SJed Brown   PetscValidPointer(adapt,2);
486684df9cb4SJed Brown   if (!ts->adapt) {
4867ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
48683bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
48691c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
487084df9cb4SJed Brown   }
487184df9cb4SJed Brown   *adapt = ts->adapt;
487284df9cb4SJed Brown   PetscFunctionReturn(0);
487384df9cb4SJed Brown }
4874d6ebe24aSShri Abhyankar 
4875d6ebe24aSShri Abhyankar #undef __FUNCT__
48761c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
48771c3436cfSJed Brown /*@
48781c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
48791c3436cfSJed Brown 
48801c3436cfSJed Brown    Logically Collective
48811c3436cfSJed Brown 
48821c3436cfSJed Brown    Input Arguments:
48831c3436cfSJed Brown +  ts - time integration context
48841c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
48850298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
48861c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
48870298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
48881c3436cfSJed Brown 
4889a3cdaa26SBarry Smith    Options Database keys:
4890a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
4891a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
4892a3cdaa26SBarry Smith 
4893*3ff766beSShri Abhyankar    Notes:
4894*3ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
4895*3ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
4896*3ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
4897*3ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
4898*3ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
4899*3ff766beSShri Abhyankar    differential variables.
4900*3ff766beSShri Abhyankar 
49011c3436cfSJed Brown    Level: beginner
49021c3436cfSJed Brown 
4903c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
49041c3436cfSJed Brown @*/
49051c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
49061c3436cfSJed Brown {
49071c3436cfSJed Brown   PetscErrorCode ierr;
49081c3436cfSJed Brown 
49091c3436cfSJed Brown   PetscFunctionBegin;
4910c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
49111c3436cfSJed Brown   if (vatol) {
49121c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
49131c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
4914bbd56ea5SKarl Rupp 
49151c3436cfSJed Brown     ts->vatol = vatol;
49161c3436cfSJed Brown   }
4917c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
49181c3436cfSJed Brown   if (vrtol) {
49191c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
49201c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
4921bbd56ea5SKarl Rupp 
49221c3436cfSJed Brown     ts->vrtol = vrtol;
49231c3436cfSJed Brown   }
49241c3436cfSJed Brown   PetscFunctionReturn(0);
49251c3436cfSJed Brown }
49261c3436cfSJed Brown 
49271c3436cfSJed Brown #undef __FUNCT__
4928c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
4929c5033834SJed Brown /*@
4930c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4931c5033834SJed Brown 
4932c5033834SJed Brown    Logically Collective
4933c5033834SJed Brown 
4934c5033834SJed Brown    Input Arguments:
4935c5033834SJed Brown .  ts - time integration context
4936c5033834SJed Brown 
4937c5033834SJed Brown    Output Arguments:
49380298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
49390298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
49400298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
49410298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
4942c5033834SJed Brown 
4943c5033834SJed Brown    Level: beginner
4944c5033834SJed Brown 
4945c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
4946c5033834SJed Brown @*/
4947c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
4948c5033834SJed Brown {
4949c5033834SJed Brown   PetscFunctionBegin;
4950c5033834SJed Brown   if (atol)  *atol  = ts->atol;
4951c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
4952c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
4953c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
4954c5033834SJed Brown   PetscFunctionReturn(0);
4955c5033834SJed Brown }
4956c5033834SJed Brown 
4957c5033834SJed Brown #undef __FUNCT__
49589c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
49599c6b16b5SShri Abhyankar /*@
4960a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
49619c6b16b5SShri Abhyankar 
49629c6b16b5SShri Abhyankar    Collective on TS
49639c6b16b5SShri Abhyankar 
49649c6b16b5SShri Abhyankar    Input Arguments:
49659c6b16b5SShri Abhyankar +  ts - time stepping context
4966a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
4967a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
49689c6b16b5SShri Abhyankar 
49699c6b16b5SShri Abhyankar    Output Arguments:
49709c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
49719c6b16b5SShri Abhyankar 
49729c6b16b5SShri Abhyankar    Level: developer
49739c6b16b5SShri Abhyankar 
4974deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
49759c6b16b5SShri Abhyankar @*/
4976a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
49779c6b16b5SShri Abhyankar {
49789c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
49799c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
49809c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
49819c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
49829c6b16b5SShri Abhyankar   PetscReal         tol;
49839c6b16b5SShri Abhyankar 
49849c6b16b5SShri Abhyankar   PetscFunctionBegin;
49859c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4986a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
4987a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
4988a4868fbcSLisandro Dalcin   PetscValidType(U,2);
4989a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
4990a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
4991a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
4992a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
49939c6b16b5SShri Abhyankar 
49949c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
49959c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
49969c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
49979c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
49989c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
49999c6b16b5SShri Abhyankar   sum  = 0.;
50009c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
50019c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
50029c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50039c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50049c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
50059c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50069c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50079c6b16b5SShri Abhyankar     }
50089c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50099c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50109c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
50119c6b16b5SShri Abhyankar     const PetscScalar *atol;
50129c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50139c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
50149c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50159c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50169c6b16b5SShri Abhyankar     }
50179c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50189c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
50199c6b16b5SShri Abhyankar     const PetscScalar *rtol;
50209c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50219c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
50229c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50239c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50249c6b16b5SShri Abhyankar     }
50259c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50269c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
50279c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
50289c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50299c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
50309c6b16b5SShri Abhyankar     }
50319c6b16b5SShri Abhyankar   }
50329c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
50339c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
50349c6b16b5SShri Abhyankar 
50359c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
50369c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
50379c6b16b5SShri Abhyankar 
50389c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
50399c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
50409c6b16b5SShri Abhyankar }
50419c6b16b5SShri Abhyankar 
50429c6b16b5SShri Abhyankar #undef __FUNCT__
50439c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
50449c6b16b5SShri Abhyankar /*@
5045a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
50469c6b16b5SShri Abhyankar 
50479c6b16b5SShri Abhyankar    Collective on TS
50489c6b16b5SShri Abhyankar 
50499c6b16b5SShri Abhyankar    Input Arguments:
50509c6b16b5SShri Abhyankar +  ts - time stepping context
5051a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5052a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
50539c6b16b5SShri Abhyankar 
50549c6b16b5SShri Abhyankar    Output Arguments:
50559c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
50569c6b16b5SShri Abhyankar 
50579c6b16b5SShri Abhyankar    Level: developer
50589c6b16b5SShri Abhyankar 
5059deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
50609c6b16b5SShri Abhyankar @*/
5061a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
50629c6b16b5SShri Abhyankar {
50639c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
50649c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
50659c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
50669c6b16b5SShri Abhyankar   PetscReal         max,gmax;
50679c6b16b5SShri Abhyankar   PetscReal         tol;
50689c6b16b5SShri Abhyankar 
50699c6b16b5SShri Abhyankar   PetscFunctionBegin;
50709c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5071a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5072a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5073a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5074a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5075a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5076a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5077a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
50789c6b16b5SShri Abhyankar 
50799c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
50809c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
50819c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
50829c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
50839c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
50849c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
50859c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
50869c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50879c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50889c6b16b5SShri Abhyankar     k = 0;
50899c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
50909c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
50919c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
50929c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
50939c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
50949c6b16b5SShri Abhyankar     }
50959c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
50969c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
50979c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
50989c6b16b5SShri Abhyankar     const PetscScalar *atol;
50999c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
51009c6b16b5SShri Abhyankar     k = 0;
51019c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51029c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
51039c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
51049c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51059c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
51069c6b16b5SShri Abhyankar     }
51079c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
51089c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
51099c6b16b5SShri Abhyankar     const PetscScalar *rtol;
51109c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
51119c6b16b5SShri Abhyankar     k = 0;
51129c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51139c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
51149c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
51159c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51169c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
51179c6b16b5SShri Abhyankar     }
51189c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
51199c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
51209c6b16b5SShri Abhyankar     k = 0;
51219c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
51229c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
51239c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
51249c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
51259c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
51269c6b16b5SShri Abhyankar     }
51279c6b16b5SShri Abhyankar   }
51289c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
51299c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
51309c6b16b5SShri Abhyankar 
51319c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
51329c6b16b5SShri Abhyankar   *norm = gmax;
51339c6b16b5SShri Abhyankar 
51349c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
51359c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
51369c6b16b5SShri Abhyankar }
51379c6b16b5SShri Abhyankar 
51389c6b16b5SShri Abhyankar #undef __FUNCT__
51397619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
51401c3436cfSJed Brown /*@
5141a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
51421c3436cfSJed Brown 
51431c3436cfSJed Brown    Collective on TS
51441c3436cfSJed Brown 
51451c3436cfSJed Brown    Input Arguments:
51461c3436cfSJed Brown +  ts - time stepping context
5147a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5148a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5149a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
51507619abb3SShri 
51511c3436cfSJed Brown    Output Arguments:
51521c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
51531c3436cfSJed Brown 
5154a4868fbcSLisandro Dalcin 
5155a4868fbcSLisandro Dalcin    Options Database Keys:
5156a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5157a4868fbcSLisandro Dalcin 
51581c3436cfSJed Brown    Level: developer
51591c3436cfSJed Brown 
5160deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
51611c3436cfSJed Brown @*/
5162a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
51631c3436cfSJed Brown {
51648beabaa1SBarry Smith   PetscErrorCode ierr;
51651c3436cfSJed Brown 
51661c3436cfSJed Brown   PetscFunctionBegin;
5167a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5168a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5169a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5170a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5171a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
51721c3436cfSJed Brown   PetscFunctionReturn(0);
51731c3436cfSJed Brown }
51741c3436cfSJed Brown 
51751c3436cfSJed Brown #undef __FUNCT__
51768d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
51778d59e960SJed Brown /*@
51788d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
51798d59e960SJed Brown 
51808d59e960SJed Brown    Logically Collective on TS
51818d59e960SJed Brown 
51828d59e960SJed Brown    Input Arguments:
51838d59e960SJed Brown +  ts - time stepping context
51848d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
51858d59e960SJed Brown 
51868d59e960SJed Brown    Note:
51878d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
51888d59e960SJed Brown 
51898d59e960SJed Brown    Level: intermediate
51908d59e960SJed Brown 
51918d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
51928d59e960SJed Brown @*/
51938d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
51948d59e960SJed Brown {
51958d59e960SJed Brown   PetscFunctionBegin;
51968d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
51978d59e960SJed Brown   ts->cfltime_local = cfltime;
51988d59e960SJed Brown   ts->cfltime       = -1.;
51998d59e960SJed Brown   PetscFunctionReturn(0);
52008d59e960SJed Brown }
52018d59e960SJed Brown 
52028d59e960SJed Brown #undef __FUNCT__
52038d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
52048d59e960SJed Brown /*@
52058d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
52068d59e960SJed Brown 
52078d59e960SJed Brown    Collective on TS
52088d59e960SJed Brown 
52098d59e960SJed Brown    Input Arguments:
52108d59e960SJed Brown .  ts - time stepping context
52118d59e960SJed Brown 
52128d59e960SJed Brown    Output Arguments:
52138d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
52148d59e960SJed Brown 
52158d59e960SJed Brown    Level: advanced
52168d59e960SJed Brown 
52178d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
52188d59e960SJed Brown @*/
52198d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
52208d59e960SJed Brown {
52218d59e960SJed Brown   PetscErrorCode ierr;
52228d59e960SJed Brown 
52238d59e960SJed Brown   PetscFunctionBegin;
52248d59e960SJed Brown   if (ts->cfltime < 0) {
5225ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
52268d59e960SJed Brown   }
52278d59e960SJed Brown   *cfltime = ts->cfltime;
52288d59e960SJed Brown   PetscFunctionReturn(0);
52298d59e960SJed Brown }
52308d59e960SJed Brown 
52318d59e960SJed Brown #undef __FUNCT__
5232d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5233d6ebe24aSShri Abhyankar /*@
5234d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5235d6ebe24aSShri Abhyankar 
5236d6ebe24aSShri Abhyankar    Input Parameters:
5237d6ebe24aSShri Abhyankar .  ts   - the TS context.
5238d6ebe24aSShri Abhyankar .  xl   - lower bound.
5239d6ebe24aSShri Abhyankar .  xu   - upper bound.
5240d6ebe24aSShri Abhyankar 
5241d6ebe24aSShri Abhyankar    Notes:
5242d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5243e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5244d6ebe24aSShri Abhyankar 
52452bd2b0e6SSatish Balay    Level: advanced
52462bd2b0e6SSatish Balay 
5247d6ebe24aSShri Abhyankar @*/
5248d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5249d6ebe24aSShri Abhyankar {
5250d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5251d6ebe24aSShri Abhyankar   SNES           snes;
5252d6ebe24aSShri Abhyankar 
5253d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5254d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5255d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5256d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5257d6ebe24aSShri Abhyankar }
5258d6ebe24aSShri Abhyankar 
5259325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5260c6db04a5SJed Brown #include <mex.h>
5261325fc9f4SBarry Smith 
5262325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5263325fc9f4SBarry Smith 
5264325fc9f4SBarry Smith #undef __FUNCT__
5265325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5266325fc9f4SBarry Smith /*
5267325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5268325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5269325fc9f4SBarry Smith 
5270325fc9f4SBarry Smith    Collective on TS
5271325fc9f4SBarry Smith 
5272325fc9f4SBarry Smith    Input Parameters:
5273325fc9f4SBarry Smith +  snes - the TS context
52740910c330SBarry Smith -  u - input vector
5275325fc9f4SBarry Smith 
5276325fc9f4SBarry Smith    Output Parameter:
5277325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5278325fc9f4SBarry Smith 
5279325fc9f4SBarry Smith    Notes:
5280325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5281325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5282325fc9f4SBarry Smith    themselves.
5283325fc9f4SBarry Smith 
5284325fc9f4SBarry Smith    Level: developer
5285325fc9f4SBarry Smith 
5286325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5287325fc9f4SBarry Smith 
5288325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5289325fc9f4SBarry Smith */
52900910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5291325fc9f4SBarry Smith {
5292325fc9f4SBarry Smith   PetscErrorCode  ierr;
5293325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5294325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5295325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5296325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5297325fc9f4SBarry Smith 
5298325fc9f4SBarry Smith   PetscFunctionBegin;
5299325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
53000910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
53010910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5302325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
53030910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5304325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5305325fc9f4SBarry Smith 
5306325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
53070910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
53080910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
53090910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5310bbd56ea5SKarl Rupp 
5311325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5312325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5313325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5314325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5315325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5316325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5317325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5318325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5319325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5320325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5321325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5322325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5323325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5324325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5325325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5326325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5327325fc9f4SBarry Smith   PetscFunctionReturn(0);
5328325fc9f4SBarry Smith }
5329325fc9f4SBarry Smith 
5330325fc9f4SBarry Smith 
5331325fc9f4SBarry Smith #undef __FUNCT__
5332325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5333325fc9f4SBarry Smith /*
5334325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5335325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5336e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5337325fc9f4SBarry Smith 
5338325fc9f4SBarry Smith    Logically Collective on TS
5339325fc9f4SBarry Smith 
5340325fc9f4SBarry Smith    Input Parameters:
5341325fc9f4SBarry Smith +  ts - the TS context
5342325fc9f4SBarry Smith -  func - function evaluation routine
5343325fc9f4SBarry Smith 
5344325fc9f4SBarry Smith    Calling sequence of func:
53450910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5346325fc9f4SBarry Smith 
5347325fc9f4SBarry Smith    Level: beginner
5348325fc9f4SBarry Smith 
5349325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5350325fc9f4SBarry Smith 
5351325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5352325fc9f4SBarry Smith */
5353cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5354325fc9f4SBarry Smith {
5355325fc9f4SBarry Smith   PetscErrorCode  ierr;
5356325fc9f4SBarry Smith   TSMatlabContext *sctx;
5357325fc9f4SBarry Smith 
5358325fc9f4SBarry Smith   PetscFunctionBegin;
5359325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5360325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5361325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5362325fc9f4SBarry Smith   /*
5363325fc9f4SBarry Smith      This should work, but it doesn't
5364325fc9f4SBarry Smith   sctx->ctx = ctx;
5365325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5366325fc9f4SBarry Smith   */
5367325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5368bbd56ea5SKarl Rupp 
53690298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5370325fc9f4SBarry Smith   PetscFunctionReturn(0);
5371325fc9f4SBarry Smith }
5372325fc9f4SBarry Smith 
5373325fc9f4SBarry Smith #undef __FUNCT__
5374325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5375325fc9f4SBarry Smith /*
5376325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5377325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5378325fc9f4SBarry Smith 
5379325fc9f4SBarry Smith    Collective on TS
5380325fc9f4SBarry Smith 
5381325fc9f4SBarry Smith    Input Parameters:
5382cdcf91faSSean Farley +  ts - the TS context
53830910c330SBarry Smith .  u - input vector
5384325fc9f4SBarry Smith .  A, B - the matrices
5385325fc9f4SBarry Smith -  ctx - user context
5386325fc9f4SBarry Smith 
5387325fc9f4SBarry Smith    Level: developer
5388325fc9f4SBarry Smith 
5389325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5390325fc9f4SBarry Smith 
5391325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5392325fc9f4SBarry Smith @*/
5393f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5394325fc9f4SBarry Smith {
5395325fc9f4SBarry Smith   PetscErrorCode  ierr;
5396325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5397325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5398325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5399325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5400325fc9f4SBarry Smith 
5401325fc9f4SBarry Smith   PetscFunctionBegin;
5402cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
54030910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5404325fc9f4SBarry Smith 
54050910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5406325fc9f4SBarry Smith 
5407cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
54080910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
54090910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
54100910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
54110910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5412bbd56ea5SKarl Rupp 
5413325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5414325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5415325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5416325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5417325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5418325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5419325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5420325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5421325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5422325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5423325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5424325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5425325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5426325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5427325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5428325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5429325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5430325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5431325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5432325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5433325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5434325fc9f4SBarry Smith   PetscFunctionReturn(0);
5435325fc9f4SBarry Smith }
5436325fc9f4SBarry Smith 
5437325fc9f4SBarry Smith 
5438325fc9f4SBarry Smith #undef __FUNCT__
5439325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5440325fc9f4SBarry Smith /*
5441325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5442e3c5b3baSBarry 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
5443325fc9f4SBarry Smith 
5444325fc9f4SBarry Smith    Logically Collective on TS
5445325fc9f4SBarry Smith 
5446325fc9f4SBarry Smith    Input Parameters:
5447cdcf91faSSean Farley +  ts - the TS context
5448325fc9f4SBarry Smith .  A,B - Jacobian matrices
5449325fc9f4SBarry Smith .  func - function evaluation routine
5450325fc9f4SBarry Smith -  ctx - user context
5451325fc9f4SBarry Smith 
5452325fc9f4SBarry Smith    Calling sequence of func:
54530910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5454325fc9f4SBarry Smith 
5455325fc9f4SBarry Smith 
5456325fc9f4SBarry Smith    Level: developer
5457325fc9f4SBarry Smith 
5458325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5459325fc9f4SBarry Smith 
5460325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5461325fc9f4SBarry Smith */
5462cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5463325fc9f4SBarry Smith {
5464325fc9f4SBarry Smith   PetscErrorCode  ierr;
5465325fc9f4SBarry Smith   TSMatlabContext *sctx;
5466325fc9f4SBarry Smith 
5467325fc9f4SBarry Smith   PetscFunctionBegin;
5468325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5469325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5470325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5471325fc9f4SBarry Smith   /*
5472325fc9f4SBarry Smith      This should work, but it doesn't
5473325fc9f4SBarry Smith   sctx->ctx = ctx;
5474325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5475325fc9f4SBarry Smith   */
5476325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5477bbd56ea5SKarl Rupp 
5478cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5479325fc9f4SBarry Smith   PetscFunctionReturn(0);
5480325fc9f4SBarry Smith }
5481325fc9f4SBarry Smith 
5482b5b1a830SBarry Smith #undef __FUNCT__
5483b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5484b5b1a830SBarry Smith /*
5485b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5486b5b1a830SBarry Smith 
5487b5b1a830SBarry Smith    Collective on TS
5488b5b1a830SBarry Smith 
5489b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5490b5b1a830SBarry Smith @*/
54910910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5492b5b1a830SBarry Smith {
5493b5b1a830SBarry Smith   PetscErrorCode  ierr;
5494b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5495a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5496b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5497b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5498b5b1a830SBarry Smith 
5499b5b1a830SBarry Smith   PetscFunctionBegin;
5500cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
55010910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5502b5b1a830SBarry Smith 
5503cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
55040910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5505bbd56ea5SKarl Rupp 
5506b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5507b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5508b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5509b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5510b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5511b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5512b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5513b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5514b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5515b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5516b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5517b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5518b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5519b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5520b5b1a830SBarry Smith   PetscFunctionReturn(0);
5521b5b1a830SBarry Smith }
5522b5b1a830SBarry Smith 
5523b5b1a830SBarry Smith 
5524b5b1a830SBarry Smith #undef __FUNCT__
5525b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5526b5b1a830SBarry Smith /*
5527b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5528b5b1a830SBarry Smith 
5529b5b1a830SBarry Smith    Level: developer
5530b5b1a830SBarry Smith 
5531b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5532b5b1a830SBarry Smith 
5533b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5534b5b1a830SBarry Smith */
5535cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5536b5b1a830SBarry Smith {
5537b5b1a830SBarry Smith   PetscErrorCode  ierr;
5538b5b1a830SBarry Smith   TSMatlabContext *sctx;
5539b5b1a830SBarry Smith 
5540b5b1a830SBarry Smith   PetscFunctionBegin;
5541b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5542b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5543b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5544b5b1a830SBarry Smith   /*
5545b5b1a830SBarry Smith      This should work, but it doesn't
5546b5b1a830SBarry Smith   sctx->ctx = ctx;
5547b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5548b5b1a830SBarry Smith   */
5549b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5550bbd56ea5SKarl Rupp 
55510298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5552b5b1a830SBarry Smith   PetscFunctionReturn(0);
5553b5b1a830SBarry Smith }
5554325fc9f4SBarry Smith #endif
5555b3603a34SBarry Smith 
5556b3603a34SBarry Smith #undef __FUNCT__
55574f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5558b3603a34SBarry Smith /*@C
55594f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5560b3603a34SBarry Smith        in a time based line graph
5561b3603a34SBarry Smith 
5562b3603a34SBarry Smith    Collective on TS
5563b3603a34SBarry Smith 
5564b3603a34SBarry Smith    Input Parameters:
5565b3603a34SBarry Smith +  ts - the TS context
5566b3603a34SBarry Smith .  step - current time-step
5567b3603a34SBarry Smith .  ptime - current time
5568b3603a34SBarry Smith -  lg - a line graph object
5569b3603a34SBarry Smith 
5570b3d3934dSBarry Smith    Options Database:
55719ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5572b3d3934dSBarry Smith 
5573b3603a34SBarry Smith    Level: intermediate
5574b3603a34SBarry Smith 
55750b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5576b3603a34SBarry Smith 
5577b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5578b3603a34SBarry Smith 
5579b3603a34SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5580b3603a34SBarry Smith @*/
55810910c330SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5582b3603a34SBarry Smith {
5583b3603a34SBarry Smith   PetscErrorCode    ierr;
55840b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5585b3603a34SBarry Smith   const PetscScalar *yy;
558658ff32f7SBarry Smith   PetscInt          dim;
558780666b62SBarry Smith   Vec               v;
5588b3603a34SBarry Smith 
5589b3603a34SBarry Smith   PetscFunctionBegin;
559058ff32f7SBarry Smith   if (!step) {
5591a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5592a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5593a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5594387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
5595387f4636SBarry Smith       char      **displaynames;
5596387f4636SBarry Smith       PetscBool flg;
5597387f4636SBarry Smith 
5598387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5599387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
5600387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
56019ae14b6eSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
5602387f4636SBarry Smith       if (flg) {
5603a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
5604387f4636SBarry Smith       }
5605387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
5606387f4636SBarry Smith     }
5607387f4636SBarry Smith     if (ctx->displaynames) {
5608387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
5609387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
5610387f4636SBarry Smith     } else if (ctx->names) {
56110910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
56120b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5613387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
5614387f4636SBarry Smith     }
56150b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
561658ff32f7SBarry Smith   }
561780666b62SBarry Smith   if (ctx->transform) {
5618e673d494SBarry Smith     ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);
561980666b62SBarry Smith   } else {
562080666b62SBarry Smith     v = u;
562180666b62SBarry Smith   }
562280666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
5623e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5624e3efe391SJed Brown   {
5625e3efe391SJed Brown     PetscReal *yreal;
5626e3efe391SJed Brown     PetscInt  i,n;
562780666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
5628785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5629e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
56300b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5631e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5632e3efe391SJed Brown   }
5633e3efe391SJed Brown #else
5634387f4636SBarry Smith   if (ctx->displaynames) {
5635387f4636SBarry Smith     PetscInt i;
5636387f4636SBarry Smith     for (i=0; i<ctx->ndisplayvariables; i++) {
5637387f4636SBarry Smith       ctx->displayvalues[i] = yy[ctx->displayvariables[i]];
5638387f4636SBarry Smith     }
5639387f4636SBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
5640387f4636SBarry Smith   } else {
56410b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5642387f4636SBarry Smith   }
5643e3efe391SJed Brown #endif
564480666b62SBarry Smith   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
564580666b62SBarry Smith   if (ctx->transform) {
564680666b62SBarry Smith     ierr = VecDestroy(&v);CHKERRQ(ierr);
564780666b62SBarry Smith   }
5648b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
56490b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
56503923b477SBarry Smith   }
5651b3603a34SBarry Smith   PetscFunctionReturn(0);
5652b3603a34SBarry Smith }
5653b3603a34SBarry Smith 
5654387f4636SBarry Smith 
5655b3603a34SBarry Smith #undef __FUNCT__
565631152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
5657b037adc7SBarry Smith /*@C
565831152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5659b037adc7SBarry Smith 
5660b037adc7SBarry Smith    Collective on TS
5661b037adc7SBarry Smith 
5662b037adc7SBarry Smith    Input Parameters:
5663b037adc7SBarry Smith +  ts - the TS context
5664b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
5665b037adc7SBarry Smith 
5666b037adc7SBarry Smith    Level: intermediate
5667b037adc7SBarry Smith 
5668b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
5669b037adc7SBarry Smith 
5670a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
5671b037adc7SBarry Smith @*/
567231152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
5673b037adc7SBarry Smith {
5674b037adc7SBarry Smith   PetscErrorCode    ierr;
5675b037adc7SBarry Smith   PetscInt          i;
5676b037adc7SBarry Smith 
5677b037adc7SBarry Smith   PetscFunctionBegin;
5678b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5679b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
56805537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
5681b3d3934dSBarry Smith       break;
5682b3d3934dSBarry Smith     }
5683b3d3934dSBarry Smith   }
5684b3d3934dSBarry Smith   PetscFunctionReturn(0);
5685b3d3934dSBarry Smith }
5686b3d3934dSBarry Smith 
5687b3d3934dSBarry Smith #undef __FUNCT__
5688e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
5689e673d494SBarry Smith /*@C
5690e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5691e673d494SBarry Smith 
5692e673d494SBarry Smith    Collective on TS
5693e673d494SBarry Smith 
5694e673d494SBarry Smith    Input Parameters:
5695e673d494SBarry Smith +  ts - the TS context
5696e673d494SBarry Smith -  names - the names of the components, final string must be NULL
5697e673d494SBarry Smith 
5698e673d494SBarry Smith    Level: intermediate
5699e673d494SBarry Smith 
5700e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5701e673d494SBarry Smith 
5702a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
5703e673d494SBarry Smith @*/
5704e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
5705e673d494SBarry Smith {
5706e673d494SBarry Smith   PetscErrorCode    ierr;
5707e673d494SBarry Smith 
5708e673d494SBarry Smith   PetscFunctionBegin;
5709e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
5710e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
5711e673d494SBarry Smith   PetscFunctionReturn(0);
5712e673d494SBarry Smith }
5713e673d494SBarry Smith 
5714e673d494SBarry Smith #undef __FUNCT__
5715b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
5716b3d3934dSBarry Smith /*@C
5717b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
5718b3d3934dSBarry Smith 
5719b3d3934dSBarry Smith    Collective on TS
5720b3d3934dSBarry Smith 
5721b3d3934dSBarry Smith    Input Parameter:
5722b3d3934dSBarry Smith .  ts - the TS context
5723b3d3934dSBarry Smith 
5724b3d3934dSBarry Smith    Output Parameter:
5725b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
5726b3d3934dSBarry Smith 
5727b3d3934dSBarry Smith    Level: intermediate
5728b3d3934dSBarry Smith 
5729b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5730b3d3934dSBarry Smith 
5731b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
5732b3d3934dSBarry Smith @*/
5733b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
5734b3d3934dSBarry Smith {
5735b3d3934dSBarry Smith   PetscInt       i;
5736b3d3934dSBarry Smith 
5737b3d3934dSBarry Smith   PetscFunctionBegin;
5738b3d3934dSBarry Smith   *names = NULL;
5739b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5740b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
57415537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
5742b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
5743b3d3934dSBarry Smith       break;
5744387f4636SBarry Smith     }
5745387f4636SBarry Smith   }
5746387f4636SBarry Smith   PetscFunctionReturn(0);
5747387f4636SBarry Smith }
5748387f4636SBarry Smith 
5749387f4636SBarry Smith #undef __FUNCT__
5750a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
5751a66092f1SBarry Smith /*@C
5752a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
5753a66092f1SBarry Smith 
5754a66092f1SBarry Smith    Collective on TS
5755a66092f1SBarry Smith 
5756a66092f1SBarry Smith    Input Parameters:
5757a66092f1SBarry Smith +  ctx - the TSMonitorLG context
5758a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
5759a66092f1SBarry Smith 
5760a66092f1SBarry Smith    Level: intermediate
5761a66092f1SBarry Smith 
5762a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
5763a66092f1SBarry Smith 
5764a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
5765a66092f1SBarry Smith @*/
5766a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
5767a66092f1SBarry Smith {
5768a66092f1SBarry Smith   PetscInt          j = 0,k;
5769a66092f1SBarry Smith   PetscErrorCode    ierr;
5770a66092f1SBarry Smith 
5771a66092f1SBarry Smith   PetscFunctionBegin;
5772a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
5773a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
5774a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
5775a66092f1SBarry Smith   while (displaynames[j]) j++;
5776a66092f1SBarry Smith   ctx->ndisplayvariables = j;
5777a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
5778a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
5779a66092f1SBarry Smith   j = 0;
5780a66092f1SBarry Smith   while (displaynames[j]) {
5781a66092f1SBarry Smith     k = 0;
5782a66092f1SBarry Smith     while (ctx->names[k]) {
5783a66092f1SBarry Smith       PetscBool flg;
5784a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
5785a66092f1SBarry Smith       if (flg) {
5786a66092f1SBarry Smith         ctx->displayvariables[j] = k;
5787a66092f1SBarry Smith         break;
5788a66092f1SBarry Smith       }
5789a66092f1SBarry Smith       k++;
5790a66092f1SBarry Smith     }
5791a66092f1SBarry Smith     j++;
5792a66092f1SBarry Smith   }
5793a66092f1SBarry Smith   PetscFunctionReturn(0);
5794a66092f1SBarry Smith }
5795a66092f1SBarry Smith 
5796a66092f1SBarry Smith 
5797a66092f1SBarry Smith #undef __FUNCT__
5798387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
5799387f4636SBarry Smith /*@C
5800387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
5801387f4636SBarry Smith 
5802387f4636SBarry Smith    Collective on TS
5803387f4636SBarry Smith 
5804387f4636SBarry Smith    Input Parameters:
5805387f4636SBarry Smith +  ts - the TS context
5806387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
5807387f4636SBarry Smith 
5808387f4636SBarry Smith    Level: intermediate
5809387f4636SBarry Smith 
5810387f4636SBarry Smith .keywords: TS,  vector, monitor, view
5811387f4636SBarry Smith 
5812387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
5813387f4636SBarry Smith @*/
5814387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
5815387f4636SBarry Smith {
5816a66092f1SBarry Smith   PetscInt          i;
5817387f4636SBarry Smith   PetscErrorCode    ierr;
5818387f4636SBarry Smith 
5819387f4636SBarry Smith   PetscFunctionBegin;
5820387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5821387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
58225537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
5823b3d3934dSBarry Smith       break;
5824b037adc7SBarry Smith     }
5825b037adc7SBarry Smith   }
5826b037adc7SBarry Smith   PetscFunctionReturn(0);
5827b037adc7SBarry Smith }
5828b037adc7SBarry Smith 
5829b037adc7SBarry Smith #undef __FUNCT__
583080666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
583180666b62SBarry Smith /*@C
583280666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
583380666b62SBarry Smith 
583480666b62SBarry Smith    Collective on TS
583580666b62SBarry Smith 
583680666b62SBarry Smith    Input Parameters:
583780666b62SBarry Smith +  ts - the TS context
583880666b62SBarry Smith .  transform - the transform function
58397684fa3eSBarry Smith .  destroy - function to destroy the optional context
584080666b62SBarry Smith -  ctx - optional context used by transform function
584180666b62SBarry Smith 
584280666b62SBarry Smith    Level: intermediate
584380666b62SBarry Smith 
584480666b62SBarry Smith .keywords: TS,  vector, monitor, view
584580666b62SBarry Smith 
5846a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
584780666b62SBarry Smith @*/
58487684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
584980666b62SBarry Smith {
585080666b62SBarry Smith   PetscInt          i;
5851a66092f1SBarry Smith   PetscErrorCode    ierr;
585280666b62SBarry Smith 
585380666b62SBarry Smith   PetscFunctionBegin;
585480666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
585580666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
58565537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
585780666b62SBarry Smith     }
585880666b62SBarry Smith   }
585980666b62SBarry Smith   PetscFunctionReturn(0);
586080666b62SBarry Smith }
586180666b62SBarry Smith 
586280666b62SBarry Smith #undef __FUNCT__
5863e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
5864e673d494SBarry Smith /*@C
5865e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
5866e673d494SBarry Smith 
5867e673d494SBarry Smith    Collective on TSLGCtx
5868e673d494SBarry Smith 
5869e673d494SBarry Smith    Input Parameters:
5870e673d494SBarry Smith +  ts - the TS context
5871e673d494SBarry Smith .  transform - the transform function
58727684fa3eSBarry Smith .  destroy - function to destroy the optional context
5873e673d494SBarry Smith -  ctx - optional context used by transform function
5874e673d494SBarry Smith 
5875e673d494SBarry Smith    Level: intermediate
5876e673d494SBarry Smith 
5877e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5878e673d494SBarry Smith 
5879a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
5880e673d494SBarry Smith @*/
58817684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
5882e673d494SBarry Smith {
5883e673d494SBarry Smith   PetscFunctionBegin;
5884e673d494SBarry Smith   ctx->transform    = transform;
58857684fa3eSBarry Smith   ctx->transformdestroy = destroy;
5886e673d494SBarry Smith   ctx->transformctx = tctx;
5887e673d494SBarry Smith   PetscFunctionReturn(0);
5888e673d494SBarry Smith }
5889e673d494SBarry Smith 
5890b3603a34SBarry Smith #undef __FUNCT__
58914f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
5892ef20d060SBarry Smith /*@C
58934f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
5894ef20d060SBarry Smith        in a time based line graph
5895ef20d060SBarry Smith 
5896ef20d060SBarry Smith    Collective on TS
5897ef20d060SBarry Smith 
5898ef20d060SBarry Smith    Input Parameters:
5899ef20d060SBarry Smith +  ts - the TS context
5900ef20d060SBarry Smith .  step - current time-step
5901ef20d060SBarry Smith .  ptime - current time
5902ef20d060SBarry Smith -  lg - a line graph object
5903ef20d060SBarry Smith 
5904ef20d060SBarry Smith    Level: intermediate
5905ef20d060SBarry Smith 
5906abd5a294SJed Brown    Notes:
5907abd5a294SJed Brown    Only for sequential solves.
5908abd5a294SJed Brown 
5909abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
5910abd5a294SJed Brown 
5911abd5a294SJed Brown    Options Database Keys:
59124f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
5913ef20d060SBarry Smith 
5914ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
5915ef20d060SBarry Smith 
5916abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
5917ef20d060SBarry Smith @*/
59180910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
5919ef20d060SBarry Smith {
5920ef20d060SBarry Smith   PetscErrorCode    ierr;
59210b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
5922ef20d060SBarry Smith   const PetscScalar *yy;
5923ef20d060SBarry Smith   Vec               y;
5924a9f9c1f6SBarry Smith   PetscInt          dim;
5925ef20d060SBarry Smith 
5926ef20d060SBarry Smith   PetscFunctionBegin;
5927a9f9c1f6SBarry Smith   if (!step) {
5928a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5929a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
59301ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
59310910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5932a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5933a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5934a9f9c1f6SBarry Smith   }
59350910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
5936ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
59370910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
5938ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
5939e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5940e3efe391SJed Brown   {
5941e3efe391SJed Brown     PetscReal *yreal;
5942e3efe391SJed Brown     PetscInt  i,n;
5943e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
5944785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5945e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
59460b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5947e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5948e3efe391SJed Brown   }
5949e3efe391SJed Brown #else
59500b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5951e3efe391SJed Brown #endif
5952ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
5953ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
5954b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
59550b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
59563923b477SBarry Smith   }
5957ef20d060SBarry Smith   PetscFunctionReturn(0);
5958ef20d060SBarry Smith }
5959ef20d060SBarry Smith 
5960201da799SBarry Smith #undef __FUNCT__
5961201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
5962201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5963201da799SBarry Smith {
5964201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5965201da799SBarry Smith   PetscReal      x   = ptime,y;
5966201da799SBarry Smith   PetscErrorCode ierr;
5967201da799SBarry Smith   PetscInt       its;
5968201da799SBarry Smith 
5969201da799SBarry Smith   PetscFunctionBegin;
5970201da799SBarry Smith   if (!n) {
5971201da799SBarry Smith     PetscDrawAxis axis;
5972bbd56ea5SKarl Rupp 
5973201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5974201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
5975201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
5976bbd56ea5SKarl Rupp 
5977201da799SBarry Smith     ctx->snes_its = 0;
5978201da799SBarry Smith   }
5979201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
5980201da799SBarry Smith   y    = its - ctx->snes_its;
5981201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
59823fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
5983201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
5984201da799SBarry Smith   }
5985201da799SBarry Smith   ctx->snes_its = its;
5986201da799SBarry Smith   PetscFunctionReturn(0);
5987201da799SBarry Smith }
5988201da799SBarry Smith 
5989201da799SBarry Smith #undef __FUNCT__
5990201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
5991201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
5992201da799SBarry Smith {
5993201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
5994201da799SBarry Smith   PetscReal      x   = ptime,y;
5995201da799SBarry Smith   PetscErrorCode ierr;
5996201da799SBarry Smith   PetscInt       its;
5997201da799SBarry Smith 
5998201da799SBarry Smith   PetscFunctionBegin;
5999201da799SBarry Smith   if (!n) {
6000201da799SBarry Smith     PetscDrawAxis axis;
6001bbd56ea5SKarl Rupp 
6002201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6003201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6004201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6005bbd56ea5SKarl Rupp 
6006201da799SBarry Smith     ctx->ksp_its = 0;
6007201da799SBarry Smith   }
6008201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6009201da799SBarry Smith   y    = its - ctx->ksp_its;
6010201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
601199fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6012201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6013201da799SBarry Smith   }
6014201da799SBarry Smith   ctx->ksp_its = its;
6015201da799SBarry Smith   PetscFunctionReturn(0);
6016201da799SBarry Smith }
6017f9c1d6abSBarry Smith 
6018f9c1d6abSBarry Smith #undef __FUNCT__
6019f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6020f9c1d6abSBarry Smith /*@
6021f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6022f9c1d6abSBarry Smith 
6023f9c1d6abSBarry Smith    Collective on TS and Vec
6024f9c1d6abSBarry Smith 
6025f9c1d6abSBarry Smith    Input Parameters:
6026f9c1d6abSBarry Smith +  ts - the TS context
6027f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6028f9c1d6abSBarry Smith 
6029f9c1d6abSBarry Smith    Output Parameters:
6030f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6031f9c1d6abSBarry Smith 
6032f9c1d6abSBarry Smith    Level: developer
6033f9c1d6abSBarry Smith 
6034f9c1d6abSBarry Smith .keywords: TS, compute
6035f9c1d6abSBarry Smith 
6036f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6037f9c1d6abSBarry Smith @*/
6038f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6039f9c1d6abSBarry Smith {
6040f9c1d6abSBarry Smith   PetscErrorCode ierr;
6041f9c1d6abSBarry Smith 
6042f9c1d6abSBarry Smith   PetscFunctionBegin;
6043f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6044ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6045f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6046f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6047f9c1d6abSBarry Smith }
604824655328SShri 
6049b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6050b3d3934dSBarry Smith #undef __FUNCT__
6051b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6052b3d3934dSBarry Smith /*@C
6053b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6054b3d3934dSBarry Smith 
6055b3d3934dSBarry Smith    Collective on TS
6056b3d3934dSBarry Smith 
6057b3d3934dSBarry Smith    Input Parameters:
6058b3d3934dSBarry Smith .  ts  - the ODE solver object
6059b3d3934dSBarry Smith 
6060b3d3934dSBarry Smith    Output Parameter:
6061b3d3934dSBarry Smith .  ctx - the context
6062b3d3934dSBarry Smith 
6063b3d3934dSBarry Smith    Level: intermediate
6064b3d3934dSBarry Smith 
6065b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6066b3d3934dSBarry Smith 
6067b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6068b3d3934dSBarry Smith 
6069b3d3934dSBarry Smith @*/
6070b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6071b3d3934dSBarry Smith {
6072b3d3934dSBarry Smith   PetscErrorCode ierr;
6073b3d3934dSBarry Smith 
6074b3d3934dSBarry Smith   PetscFunctionBegin;
6075a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6076b3d3934dSBarry Smith   PetscFunctionReturn(0);
6077b3d3934dSBarry Smith }
6078b3d3934dSBarry Smith 
6079b3d3934dSBarry Smith #undef __FUNCT__
6080b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6081b3d3934dSBarry Smith /*@C
6082b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6083b3d3934dSBarry Smith 
6084b3d3934dSBarry Smith    Collective on TS
6085b3d3934dSBarry Smith 
6086b3d3934dSBarry Smith    Input Parameters:
6087b3d3934dSBarry Smith +  ts - the TS context
6088b3d3934dSBarry Smith .  step - current time-step
6089b3d3934dSBarry Smith .  ptime - current time
6090b3d3934dSBarry Smith -  ctx - the envelope context
6091b3d3934dSBarry Smith 
6092b3d3934dSBarry Smith    Options Database:
6093b3d3934dSBarry Smith .  -ts_monitor_envelope
6094b3d3934dSBarry Smith 
6095b3d3934dSBarry Smith    Level: intermediate
6096b3d3934dSBarry Smith 
6097b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6098b3d3934dSBarry Smith 
6099b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6100b3d3934dSBarry Smith 
6101b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds()
6102b3d3934dSBarry Smith @*/
6103b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6104b3d3934dSBarry Smith {
6105b3d3934dSBarry Smith   PetscErrorCode       ierr;
6106b3d3934dSBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dummy;
6107b3d3934dSBarry Smith 
6108b3d3934dSBarry Smith   PetscFunctionBegin;
6109b3d3934dSBarry Smith   if (!ctx->max) {
6110b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6111b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6112b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6113b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6114b3d3934dSBarry Smith   } else {
6115b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6116b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6117b3d3934dSBarry Smith   }
6118b3d3934dSBarry Smith   PetscFunctionReturn(0);
6119b3d3934dSBarry Smith }
6120b3d3934dSBarry Smith 
6121b3d3934dSBarry Smith 
6122b3d3934dSBarry Smith #undef __FUNCT__
6123b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6124b3d3934dSBarry Smith /*@C
6125b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6126b3d3934dSBarry Smith 
6127b3d3934dSBarry Smith    Collective on TS
6128b3d3934dSBarry Smith 
6129b3d3934dSBarry Smith    Input Parameter:
6130b3d3934dSBarry Smith .  ts - the TS context
6131b3d3934dSBarry Smith 
6132b3d3934dSBarry Smith    Output Parameter:
6133b3d3934dSBarry Smith +  max - the maximum values
6134b3d3934dSBarry Smith -  min - the minimum values
6135b3d3934dSBarry Smith 
6136b3d3934dSBarry Smith    Level: intermediate
6137b3d3934dSBarry Smith 
6138b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6139b3d3934dSBarry Smith 
6140b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6141b3d3934dSBarry Smith @*/
6142b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6143b3d3934dSBarry Smith {
6144b3d3934dSBarry Smith   PetscInt i;
6145b3d3934dSBarry Smith 
6146b3d3934dSBarry Smith   PetscFunctionBegin;
6147b3d3934dSBarry Smith   if (max) *max = NULL;
6148b3d3934dSBarry Smith   if (min) *min = NULL;
6149b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6150b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
61515537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6152b3d3934dSBarry Smith       if (max) *max = ctx->max;
6153b3d3934dSBarry Smith       if (min) *min = ctx->min;
6154b3d3934dSBarry Smith       break;
6155b3d3934dSBarry Smith     }
6156b3d3934dSBarry Smith   }
6157b3d3934dSBarry Smith   PetscFunctionReturn(0);
6158b3d3934dSBarry Smith }
6159b3d3934dSBarry Smith 
6160b3d3934dSBarry Smith #undef __FUNCT__
6161b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6162b3d3934dSBarry Smith /*@C
6163b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6164b3d3934dSBarry Smith 
6165b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6166b3d3934dSBarry Smith 
6167b3d3934dSBarry Smith    Input Parameter:
6168b3d3934dSBarry Smith .  ctx - the monitor context
6169b3d3934dSBarry Smith 
6170b3d3934dSBarry Smith    Level: intermediate
6171b3d3934dSBarry Smith 
6172b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6173b3d3934dSBarry Smith 
6174b3d3934dSBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
6175b3d3934dSBarry Smith @*/
6176b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6177b3d3934dSBarry Smith {
6178b3d3934dSBarry Smith   PetscErrorCode ierr;
6179b3d3934dSBarry Smith 
6180b3d3934dSBarry Smith   PetscFunctionBegin;
6181b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6182b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6183b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6184b3d3934dSBarry Smith   PetscFunctionReturn(0);
6185b3d3934dSBarry Smith }
6186f2dee214SBarry Smith 
618724655328SShri #undef __FUNCT__
618824655328SShri #define __FUNCT__ "TSRollBack"
618924655328SShri /*@
619024655328SShri    TSRollBack - Rolls back one time step
619124655328SShri 
619224655328SShri    Collective on TS
619324655328SShri 
619424655328SShri    Input Parameter:
619524655328SShri .  ts - the TS context obtained from TSCreate()
619624655328SShri 
619724655328SShri    Level: advanced
619824655328SShri 
619924655328SShri .keywords: TS, timestep, rollback
620024655328SShri 
620124655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
620224655328SShri @*/
620324655328SShri PetscErrorCode  TSRollBack(TS ts)
620424655328SShri {
620524655328SShri   PetscErrorCode ierr;
620624655328SShri 
620724655328SShri   PetscFunctionBegin;
620824655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
620924655328SShri 
621024655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
621124655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
621224655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
621324655328SShri   ts->ptime = ts->ptime_prev;
62148392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
621524655328SShri   PetscFunctionReturn(0);
621624655328SShri }
6217aeb4809dSShri Abhyankar 
6218ff22ae23SHong Zhang #undef __FUNCT__
6219ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6220ff22ae23SHong Zhang /*@
6221ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6222ff22ae23SHong Zhang 
6223ff22ae23SHong Zhang    Input Parameter:
6224ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6225ff22ae23SHong Zhang 
6226ff22ae23SHong Zhang    Level: advanced
6227ff22ae23SHong Zhang 
6228ff22ae23SHong Zhang .keywords: TS, getstages
6229ff22ae23SHong Zhang 
6230ff22ae23SHong Zhang .seealso: TSCreate()
6231ff22ae23SHong Zhang @*/
6232ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6233ff22ae23SHong Zhang {
6234ff22ae23SHong Zhang   PetscErrorCode ierr;
6235ff22ae23SHong Zhang 
6236ff22ae23SHong Zhang   PetscFunctionBegin;
6237ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6238ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6239ff22ae23SHong Zhang 
6240ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6241ff22ae23SHong Zhang   else {
6242ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6243ff22ae23SHong Zhang   }
6244ff22ae23SHong Zhang   PetscFunctionReturn(0);
6245ff22ae23SHong Zhang }
6246ff22ae23SHong Zhang 
6247847ff0e1SMatthew G. Knepley 
6248847ff0e1SMatthew G. Knepley #undef __FUNCT__
6249847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
6250847ff0e1SMatthew G. Knepley /*@C
6251847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
6252847ff0e1SMatthew G. Knepley 
6253847ff0e1SMatthew G. Knepley   Collective on SNES
6254847ff0e1SMatthew G. Knepley 
6255847ff0e1SMatthew G. Knepley   Input Parameters:
6256847ff0e1SMatthew G. Knepley + ts - the TS context
6257847ff0e1SMatthew G. Knepley . t - current timestep
6258847ff0e1SMatthew G. Knepley . U - state vector
6259847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
6260847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
6261847ff0e1SMatthew G. Knepley - ctx - an optional user context
6262847ff0e1SMatthew G. Knepley 
6263847ff0e1SMatthew G. Knepley   Output Parameters:
6264847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
6265847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
6266847ff0e1SMatthew G. Knepley 
6267847ff0e1SMatthew G. Knepley   Level: intermediate
6268847ff0e1SMatthew G. Knepley 
6269847ff0e1SMatthew G. Knepley   Notes:
6270847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
6271847ff0e1SMatthew G. Knepley 
6272847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
6273847ff0e1SMatthew G. Knepley 
6274847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
6275847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
6276847ff0e1SMatthew G. Knepley 
6277847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
6278847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
6279847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
6280847ff0e1SMatthew G. Knepley 
6281847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
6282847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
6283847ff0e1SMatthew G. Knepley @*/
6284847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
6285847ff0e1SMatthew G. Knepley {
6286847ff0e1SMatthew G. Knepley   SNES           snes;
6287847ff0e1SMatthew G. Knepley   MatFDColoring  color;
6288847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
6289847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
6290847ff0e1SMatthew G. Knepley 
6291847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
6292847ff0e1SMatthew G. Knepley   ierr = PetscOptionsGetBool(((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
6293847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
6294847ff0e1SMatthew G. Knepley   if (!color) {
6295847ff0e1SMatthew G. Knepley     DM         dm;
6296847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
6297847ff0e1SMatthew G. Knepley 
6298847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
6299847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
6300847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
6301847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
6302847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6303847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6304847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6305847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6306847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6307847ff0e1SMatthew G. Knepley     } else {
6308847ff0e1SMatthew G. Knepley       MatColoring mc;
6309847ff0e1SMatthew G. Knepley 
6310847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
6311847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
6312847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
6313847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
6314847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
6315847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
6316847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6317847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6318847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6319847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6320847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6321847ff0e1SMatthew G. Knepley     }
6322847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
6323847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
6324847ff0e1SMatthew G. Knepley   }
6325847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
6326847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
6327847ff0e1SMatthew G. Knepley   if (J != B) {
6328847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6329847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6330847ff0e1SMatthew G. Knepley   }
6331847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
6332847ff0e1SMatthew G. Knepley }
6333