xref: /petsc/src/ts/interface/ts.c (revision 68bece0bd50004586d88ca9f2cea00cb61f23ba9)
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
60110eb670SHong Zhang .  -ts_monitor_envelope - determine maximum and minimum value of each component of the solution over the solution time
61110eb670SHong Zhang .  -ts_adjoint_monitor - print information at each adjoint time step
6253ea634cSHong Zhang -  -ts_adjoint_monitor_draw_sensi - monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
6353ea634cSHong Zhang 
6491b97e58SBarry Smith    Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
65bdad233fSMatthew Knepley 
66bdad233fSMatthew Knepley    Level: beginner
67bdad233fSMatthew Knepley 
68bdad233fSMatthew Knepley .keywords: TS, timestep, set, options, database
69bdad233fSMatthew Knepley 
70a313700dSBarry Smith .seealso: TSGetType()
71bdad233fSMatthew Knepley @*/
727087cfbeSBarry Smith PetscErrorCode  TSSetFromOptions(TS ts)
73bdad233fSMatthew Knepley {
74bc952696SBarry Smith   PetscBool              opt,flg,tflg;
75dfbe8321SBarry Smith   PetscErrorCode         ierr;
76649052a6SBarry Smith   PetscViewer            monviewer;
77eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
78089b2837SJed Brown   SNES                   snes;
791c3436cfSJed Brown   TSAdapt                adapt;
8031748224SBarry Smith   PetscReal              time_step;
8149354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
82d1212d36SBarry Smith   char                   dir[16];
836991f827SBarry Smith   const char             *defaultType;
846991f827SBarry Smith   char                   typeName[256];
85bdad233fSMatthew Knepley 
86bdad233fSMatthew Knepley   PetscFunctionBegin;
870700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
883194b578SJed Brown   ierr = PetscObjectOptionsBegin((PetscObject)ts);CHKERRQ(ierr);
896991f827SBarry Smith   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
906991f827SBarry Smith   else defaultType = TSEULER;
916991f827SBarry Smith 
926991f827SBarry Smith   ierr = TSRegisterAll();CHKERRQ(ierr);
936991f827SBarry Smith   ierr = PetscOptionsFList("-ts_type", "TS method"," TSSetType", TSList, defaultType, typeName, 256, &opt);CHKERRQ(ierr);
946991f827SBarry Smith   if (opt) {
956991f827SBarry Smith     ierr = TSSetType(ts, typeName);CHKERRQ(ierr);
966991f827SBarry Smith   } else {
976991f827SBarry Smith     ierr = TSSetType(ts, defaultType);CHKERRQ(ierr);
986991f827SBarry Smith   }
99bdad233fSMatthew Knepley 
100bdad233fSMatthew Knepley   /* Handle generic TS options */
1010298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_steps","Maximum number of time steps","TSSetDuration",ts->max_steps,&ts->max_steps,NULL);CHKERRQ(ierr);
1020298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_final_time","Time to run to","TSSetDuration",ts->max_time,&ts->max_time,NULL);CHKERRQ(ierr);
1030298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_init_time","Initial time","TSSetTime",ts->ptime,&ts->ptime,NULL);CHKERRQ(ierr);
10431748224SBarry Smith   ierr = PetscOptionsReal("-ts_dt","Initial time step","TSSetTimeStep",ts->time_step,&time_step,&flg);CHKERRQ(ierr);
10531748224SBarry Smith   if (flg) {
10631748224SBarry Smith     ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
10731748224SBarry Smith   }
10849354f04SShri 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);
10949354f04SShri Abhyankar   if (flg) {ierr = TSSetExactFinalTime(ts,eftopt);CHKERRQ(ierr);}
1100298fd71SBarry 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);
1110298fd71SBarry Smith   ierr = PetscOptionsInt("-ts_max_reject","Maximum number of step rejections before step fails","TSSetMaxStepRejections",ts->max_reject,&ts->max_reject,NULL);CHKERRQ(ierr);
1120298fd71SBarry Smith   ierr = PetscOptionsBool("-ts_error_if_step_fails","Error if no step succeeds","TSSetErrorIfStepFails",ts->errorifstepfailed,&ts->errorifstepfailed,NULL);CHKERRQ(ierr);
1130298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_rtol","Relative tolerance for local truncation error","TSSetTolerances",ts->rtol,&ts->rtol,NULL);CHKERRQ(ierr);
1140298fd71SBarry Smith   ierr = PetscOptionsReal("-ts_atol","Absolute tolerance for local truncation error","TSSetTolerances",ts->atol,&ts->atol,NULL);CHKERRQ(ierr);
115bdad233fSMatthew Knepley 
11656f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
11756f85f32SBarry Smith   {
11856f85f32SBarry Smith   PetscBool set;
11956f85f32SBarry Smith   flg  = PETSC_FALSE;
12056f85f32SBarry Smith   ierr = PetscOptionsBool("-ts_saws_block","Block for SAWs memory snooper at end of TSSolve","PetscObjectSAWsBlock",((PetscObject)ts)->amspublishblock,&flg,&set);CHKERRQ(ierr);
12156f85f32SBarry Smith   if (set) {
12256f85f32SBarry Smith     ierr = PetscObjectSAWsSetBlock((PetscObject)ts,flg);CHKERRQ(ierr);
12356f85f32SBarry Smith   }
12456f85f32SBarry Smith   }
12556f85f32SBarry Smith #endif
12656f85f32SBarry Smith 
127bdad233fSMatthew Knepley   /* Monitor options */
128a6570f20SBarry Smith   ierr = PetscOptionsString("-ts_monitor","Monitor timestep size","TSMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
129eabae89aSBarry Smith   if (flg) {
130ce94432eSBarry Smith     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
131649052a6SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
132bdad233fSMatthew Knepley   }
1335180491cSLisandro Dalcin   ierr = PetscOptionsString("-ts_monitor_python","Use Python function","TSMonitorSet",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
1345180491cSLisandro Dalcin   if (flg) {ierr = PetscPythonMonitorSet((PetscObject)ts,monfilename);CHKERRQ(ierr);}
1355180491cSLisandro Dalcin 
1364f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",&opt);CHKERRQ(ierr);
137a7cc72afSBarry Smith   if (opt) {
1380b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1393923b477SBarry Smith     PetscInt       howoften = 1;
140a80ad3e0SBarry Smith 
1410298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_timestep","Monitor timestep size graphically","TSMonitorLGTimeStep",howoften,&howoften,NULL);CHKERRQ(ierr);
1427f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
1434f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGTimeStep,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
144b3603a34SBarry Smith   }
1454f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",&opt);CHKERRQ(ierr);
146b3603a34SBarry Smith   if (opt) {
1470b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1483923b477SBarry Smith     PetscInt       howoften = 1;
149b3603a34SBarry Smith 
1500298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_solution","Monitor solution graphically","TSMonitorLGSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
15122d28d08SBarry Smith     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1524f09c107SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
153bdad233fSMatthew Knepley   }
1544f09c107SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",&opt);CHKERRQ(ierr);
155ef20d060SBarry Smith   if (opt) {
1560b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1573923b477SBarry Smith     PetscInt       howoften = 1;
158ef20d060SBarry Smith 
1590298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_error","Monitor error graphically","TSMonitorLGError",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,TSMonitorLGError,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
162ef20d060SBarry Smith   }
163201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",&opt);CHKERRQ(ierr);
164201da799SBarry Smith   if (opt) {
165201da799SBarry Smith     TSMonitorLGCtx ctx;
166201da799SBarry Smith     PetscInt       howoften = 1;
167201da799SBarry Smith 
1680298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_lg_snes_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGSNESIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
1697f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
170201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGSNESIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
171201da799SBarry Smith   }
172201da799SBarry Smith   ierr = PetscOptionsName("-ts_monitor_lg_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",&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_ksp_iterations","Monitor number nonlinear iterations for each timestep graphically","TSMonitorLGKSPIterations",howoften,&howoften,NULL);CHKERRQ(ierr);
1787f52daa2SLisandro Dalcin     ierr = TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts),NULL,NULL,PETSC_DECIDE,PETSC_DECIDE,300,300,howoften,&ctx);CHKERRQ(ierr);
179201da799SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorLGKSPIterations,ctx,(PetscErrorCode (*)(void**))TSMonitorLGCtxDestroy);CHKERRQ(ierr);
180201da799SBarry Smith   }
1818189c53fSBarry Smith   ierr = PetscOptionsName("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",&opt);CHKERRQ(ierr);
1828189c53fSBarry Smith   if (opt) {
1838189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
1848189c53fSBarry Smith     PetscInt          howoften = 1;
1858189c53fSBarry Smith 
1860298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_sp_eig","Monitor eigenvalues of linearized operator graphically","TSMonitorSPEig",howoften,&howoften,NULL);CHKERRQ(ierr);
18722d28d08SBarry Smith     ierr = TSMonitorSPEigCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
1888189c53fSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorSPEig,ctx,(PetscErrorCode (*)(void**))TSMonitorSPEigCtxDestroy);CHKERRQ(ierr);
1898189c53fSBarry Smith   }
190ef20d060SBarry Smith   opt  = PETSC_FALSE;
1910dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",&opt);CHKERRQ(ierr);
192a7cc72afSBarry Smith   if (opt) {
19383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
19483a4ac43SBarry Smith     PetscInt         howoften = 1;
195a80ad3e0SBarry Smith 
1960298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_solution","Monitor solution graphically","TSMonitorDrawSolution",howoften,&howoften,NULL);CHKERRQ(ierr);
197ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
19883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolution,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
199bdad233fSMatthew Knepley   }
200fb1732b5SBarry Smith   opt  = PETSC_FALSE;
2019110b2e7SHong Zhang   ierr = PetscOptionsName("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",&opt);CHKERRQ(ierr);
2029110b2e7SHong Zhang   if (opt) {
2039110b2e7SHong Zhang     TSMonitorDrawCtx ctx;
2049110b2e7SHong Zhang     PetscInt         howoften = 1;
2059110b2e7SHong Zhang 
2069110b2e7SHong Zhang     ierr = PetscOptionsInt("-ts_adjoint_monitor_draw_sensi","Monitor adjoint sensitivities (lambda only) graphically","TSAdjointMonitorDrawSensi",howoften,&howoften,NULL);CHKERRQ(ierr);
2079110b2e7SHong Zhang     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
2089110b2e7SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDrawSensi,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2099110b2e7SHong Zhang   }
2109110b2e7SHong Zhang   opt  = PETSC_FALSE;
2112d5ee99bSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",&opt);CHKERRQ(ierr);
2122d5ee99bSBarry Smith   if (opt) {
2132d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2142d5ee99bSBarry Smith     PetscReal        bounds[4];
2152d5ee99bSBarry Smith     PetscInt         n = 4;
2162d5ee99bSBarry Smith     PetscDraw        draw;
2172d5ee99bSBarry Smith 
2182d5ee99bSBarry Smith     ierr = PetscOptionsRealArray("-ts_monitor_draw_solution_phase","Monitor solution graphically","TSMonitorDrawSolutionPhase",bounds,&n,NULL);CHKERRQ(ierr);
2192d5ee99bSBarry Smith     if (n != 4) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Must provide bounding box of phase field");
2202d5ee99bSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,1,&ctx);CHKERRQ(ierr);
2212d5ee99bSBarry Smith     ierr = PetscViewerDrawGetDraw(ctx->viewer,0,&draw);CHKERRQ(ierr);
2222d5ee99bSBarry Smith     ierr = PetscDrawClear(draw);CHKERRQ(ierr);
2234b363babSBarry Smith     ierr = PetscDrawAxisCreate(draw,&ctx->axis);CHKERRQ(ierr);
2244b363babSBarry Smith     ierr = PetscDrawAxisSetLimits(ctx->axis,bounds[0],bounds[2],bounds[1],bounds[3]);CHKERRQ(ierr);
225f54adfc0SBarry Smith     ierr = PetscDrawAxisSetLabels(ctx->axis,"Phase Diagram","Variable 1","Variable 2");CHKERRQ(ierr);
2264b363babSBarry Smith     ierr = PetscDrawAxisDraw(ctx->axis);CHKERRQ(ierr);
22707995780SPeter Brune     /* ierr = PetscDrawSetCoordinates(draw,bounds[0],bounds[1],bounds[2],bounds[3]);CHKERRQ(ierr); */
2282d5ee99bSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawSolutionPhase,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2292d5ee99bSBarry Smith   }
2302d5ee99bSBarry Smith   opt  = PETSC_FALSE;
2310dcf80beSBarry Smith   ierr = PetscOptionsName("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",&opt);CHKERRQ(ierr);
2323a471f94SBarry Smith   if (opt) {
23383a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
23483a4ac43SBarry Smith     PetscInt         howoften = 1;
2353a471f94SBarry Smith 
2360298fd71SBarry Smith     ierr = PetscOptionsInt("-ts_monitor_draw_error","Monitor error graphically","TSMonitorDrawError",howoften,&howoften,NULL);CHKERRQ(ierr);
237ce94432eSBarry Smith     ierr = TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts),0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&ctx);CHKERRQ(ierr);
23883a4ac43SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDrawError,ctx,(PetscErrorCode (*)(void**))TSMonitorDrawCtxDestroy);CHKERRQ(ierr);
2393a471f94SBarry Smith   }
2403a471f94SBarry Smith   opt  = PETSC_FALSE;
24191b97e58SBarry Smith   ierr = PetscOptionsString("-ts_monitor_solution_binary","Save each solution to a binary file","TSMonitorSolutionBinary",0,monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
242fb1732b5SBarry Smith   if (flg) {
243fb1732b5SBarry Smith     PetscViewer ctx;
244fb1732b5SBarry Smith     if (monfilename[0]) {
245ce94432eSBarry Smith       ierr = PetscViewerBinaryOpen(PetscObjectComm((PetscObject)ts),monfilename,FILE_MODE_WRITE,&ctx);CHKERRQ(ierr);
246c2fbc07fSBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
247fb1732b5SBarry Smith     } else {
248ce94432eSBarry Smith       ctx = PETSC_VIEWER_BINARY_(PetscObjectComm((PetscObject)ts));
2490298fd71SBarry Smith       ierr = TSMonitorSet(ts,TSMonitorSolutionBinary,ctx,(PetscErrorCode (*)(void**))NULL);CHKERRQ(ierr);
250fb1732b5SBarry Smith     }
251fb1732b5SBarry Smith   }
252ed81e22dSJed Brown   opt  = PETSC_FALSE;
25391b97e58SBarry 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);
254ed81e22dSJed Brown   if (flg) {
255ed81e22dSJed Brown     const char *ptr,*ptr2;
256ed81e22dSJed Brown     char       *filetemplate;
257ce94432eSBarry Smith     if (!monfilename[0]) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
258ed81e22dSJed Brown     /* Do some cursory validation of the input. */
259ed81e22dSJed Brown     ierr = PetscStrstr(monfilename,"%",(char**)&ptr);CHKERRQ(ierr);
260ce94432eSBarry Smith     if (!ptr) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03D.vts");
261ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
262ed81e22dSJed Brown       ierr = PetscStrchr("DdiouxX",*ptr,(char**)&ptr2);CHKERRQ(ierr);
263ce94432eSBarry 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");
264ed81e22dSJed Brown       if (ptr2) break;
265ed81e22dSJed Brown     }
266ed81e22dSJed Brown     ierr = PetscStrallocpy(monfilename,&filetemplate);CHKERRQ(ierr);
267ed81e22dSJed Brown     ierr = TSMonitorSet(ts,TSMonitorSolutionVTK,filetemplate,(PetscErrorCode (*)(void**))TSMonitorSolutionVTKDestroy);CHKERRQ(ierr);
268ed81e22dSJed Brown   }
269bdad233fSMatthew Knepley 
270d1212d36SBarry Smith   ierr = PetscOptionsString("-ts_monitor_dmda_ray","Display a ray of the solution","None","y=0",dir,16,&flg);CHKERRQ(ierr);
271d1212d36SBarry Smith   if (flg) {
272d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
273d1212d36SBarry Smith     int                  ray = 0;
274d1212d36SBarry Smith     DMDADirection        ddir;
275d1212d36SBarry Smith     DM                   da;
276d1212d36SBarry Smith     PetscMPIInt          rank;
277d1212d36SBarry Smith 
278ce94432eSBarry Smith     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
279d1212d36SBarry Smith     if (dir[0] == 'x') ddir = DMDA_X;
280d1212d36SBarry Smith     else if (dir[0] == 'y') ddir = DMDA_Y;
281ce94432eSBarry Smith     else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Unknown ray %s",dir);
282d1212d36SBarry Smith     sscanf(dir+2,"%d",&ray);
283d1212d36SBarry Smith 
284d1212d36SBarry Smith     ierr = PetscInfo2(((PetscObject)ts),"Displaying DMDA ray %c = %D\n",dir[0],ray);CHKERRQ(ierr);
285b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
286d1212d36SBarry Smith     ierr = TSGetDM(ts,&da);CHKERRQ(ierr);
287d1212d36SBarry Smith     ierr = DMDAGetRay(da,ddir,ray,&rayctx->ray,&rayctx->scatter);CHKERRQ(ierr);
288ce94432eSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)ts),&rank);CHKERRQ(ierr);
289d1212d36SBarry Smith     if (!rank) {
290d1212d36SBarry Smith       ierr = PetscViewerDrawOpen(PETSC_COMM_SELF,0,0,0,0,600,300,&rayctx->viewer);CHKERRQ(ierr);
291d1212d36SBarry Smith     }
29251b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
293d1212d36SBarry Smith     ierr = TSMonitorSet(ts,TSMonitorDMDARay,rayctx,TSMonitorDMDARayDestroy);CHKERRQ(ierr);
294d1212d36SBarry Smith   }
29551b4a12fSMatthew G. Knepley   ierr = PetscOptionsString("-ts_monitor_lg_dmda_ray","Display a ray of the solution","None","x=0",dir,16,&flg);CHKERRQ(ierr);
29651b4a12fSMatthew G. Knepley   if (flg) {
29751b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
29851b4a12fSMatthew G. Knepley     int                 ray = 0;
29951b4a12fSMatthew G. Knepley     DMDADirection       ddir;
30051b4a12fSMatthew G. Knepley     DM                  da;
30151b4a12fSMatthew G. Knepley     PetscInt            howoften = 1;
302d1212d36SBarry Smith 
30351b4a12fSMatthew G. Knepley     if (dir[1] != '=') SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
30451b4a12fSMatthew G. Knepley     if      (dir[0] == 'x') ddir = DMDA_X;
30551b4a12fSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DMDA_Y;
30651b4a12fSMatthew G. Knepley     else SETERRQ1(PetscObjectComm((PetscObject) ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
30751b4a12fSMatthew G. Knepley     sscanf(dir+2, "%d", &ray);
3081c3436cfSJed Brown 
30951b4a12fSMatthew G. Knepley     ierr = PetscInfo2(((PetscObject) ts),"Displaying LG DMDA ray %c = %D\n", dir[0], ray);CHKERRQ(ierr);
310b00a9115SJed Brown     ierr = PetscNew(&rayctx);CHKERRQ(ierr);
31151b4a12fSMatthew G. Knepley     ierr = TSGetDM(ts, &da);CHKERRQ(ierr);
31251b4a12fSMatthew G. Knepley     ierr = DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter);CHKERRQ(ierr);
31351b4a12fSMatthew G. Knepley     ierr = TSMonitorLGCtxCreate(PETSC_COMM_SELF,0,0,PETSC_DECIDE,PETSC_DECIDE,600,400,howoften,&rayctx->lgctx);CHKERRQ(ierr);
31451b4a12fSMatthew G. Knepley     ierr = TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy);CHKERRQ(ierr);
31551b4a12fSMatthew G. Knepley   }
316a7a1495cSBarry Smith 
317b3d3934dSBarry Smith   ierr = PetscOptionsName("-ts_monitor_envelope","Monitor maximum and minimum value of each component of the solution","TSMonitorEnvelope",&opt);CHKERRQ(ierr);
318b3d3934dSBarry Smith   if (opt) {
319b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
320b3d3934dSBarry Smith 
321b3d3934dSBarry Smith     ierr = TSMonitorEnvelopeCtxCreate(ts,&ctx);CHKERRQ(ierr);
322b3d3934dSBarry Smith     ierr = TSMonitorSet(ts,TSMonitorEnvelope,ctx,(PetscErrorCode (*)(void**))TSMonitorEnvelopeCtxDestroy);CHKERRQ(ierr);
323b3d3934dSBarry Smith   }
324b3d3934dSBarry Smith 
325847ff0e1SMatthew G. Knepley   flg  = PETSC_FALSE;
326847ff0e1SMatthew G. Knepley   ierr = PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeJacobianDefaultColor", flg, &flg, NULL);CHKERRQ(ierr);
327847ff0e1SMatthew G. Knepley   if (flg) {
328847ff0e1SMatthew G. Knepley     DM   dm;
329847ff0e1SMatthew G. Knepley     DMTS tdm;
330847ff0e1SMatthew G. Knepley 
331847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
332847ff0e1SMatthew G. Knepley     ierr = DMGetDMTS(dm, &tdm);CHKERRQ(ierr);
333847ff0e1SMatthew G. Knepley     tdm->ijacobianctx = NULL;
334847ff0e1SMatthew G. Knepley     ierr = TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, 0);CHKERRQ(ierr);
335847ff0e1SMatthew G. Knepley     ierr = PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n");CHKERRQ(ierr);
336847ff0e1SMatthew G. Knepley   }
337847ff0e1SMatthew G. Knepley 
338110eb670SHong Zhang   ierr = PetscOptionsString("-ts_adjoint_monitor","Monitor adjoint timestep size","TSAdjointMonitorDefault","stdout",monfilename,PETSC_MAX_PATH_LEN,&flg);CHKERRQ(ierr);
339110eb670SHong Zhang   if (flg) {
340110eb670SHong Zhang     ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)ts),monfilename,&monviewer);CHKERRQ(ierr);
341110eb670SHong Zhang     ierr = TSAdjointMonitorSet(ts,TSAdjointMonitorDefault,monviewer,(PetscErrorCode (*)(void**))PetscViewerDestroy);CHKERRQ(ierr);
342110eb670SHong Zhang   }
343110eb670SHong Zhang 
3447781c08eSBarry Smith   /*
3457781c08eSBarry Smith      This code is all wrong. One is creating objects inside the TSSetFromOptions() so if run with the options gui
3467781c08eSBarry Smith      will bleed memory. Also one is using a PetscOptionsBegin() inside a PetscOptionsBegin()
3477781c08eSBarry Smith   */
348552698daSJed Brown   ierr = TSGetAdapt(ts,&adapt);CHKERRQ(ierr);
349e55864a3SBarry Smith   ierr = TSAdaptSetFromOptions(PetscOptionsObject,adapt);CHKERRQ(ierr);
350d763cef2SBarry Smith 
351d763cef2SBarry Smith     /* Handle specific TS options */
352d763cef2SBarry Smith   if (ts->ops->setfromoptions) {
3536991f827SBarry Smith     ierr = (*ts->ops->setfromoptions)(PetscOptionsObject,ts);CHKERRQ(ierr);
354d763cef2SBarry Smith   }
355*68bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
356*68bece0bSHong Zhang   if (ts->trajectory) tflg = PETSC_TRUE;
357*68bece0bSHong Zhang   else tflg = PETSC_FALSE;
358*68bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_save_trajectory","Save the solution at each timestep","TSSetSaveTrajectory",tflg,&tflg,NULL);CHKERRQ(ierr);
359*68bece0bSHong Zhang   if (tflg) {
360*68bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
361*68bece0bSHong Zhang   }
362*68bece0bSHong Zhang   if (ts->adjoint_solve) tflg = PETSC_TRUE;
363*68bece0bSHong Zhang   else tflg = PETSC_FALSE;
364*68bece0bSHong Zhang   ierr = PetscOptionsBool("-ts_adjoint_solve","Solve the adjoint problem immediately after solving the forward problem","",tflg,&tflg,&flg);CHKERRQ(ierr);
365*68bece0bSHong Zhang   if (flg) {
366*68bece0bSHong Zhang     ierr = TSSetSaveTrajectory(ts);CHKERRQ(ierr);
367*68bece0bSHong Zhang     ts->adjoint_solve = tflg;
368*68bece0bSHong Zhang   }
369*68bece0bSHong Zhang   if (ts->trajectory) {
370*68bece0bSHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
371*68bece0bSHong Zhang   }
3726991f827SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
373d763cef2SBarry Smith 
374d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
375d763cef2SBarry Smith   ierr = PetscObjectProcessOptionsHandlers((PetscObject)ts);CHKERRQ(ierr);
376d763cef2SBarry Smith 
3776991f827SBarry Smith   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3786991f827SBarry Smith   if (snes) {
3796991f827SBarry Smith     if (ts->problem_type == TS_LINEAR) {ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);}
38049c41c37SLisandro Dalcin     ierr = SNESSetFromOptions(snes);CHKERRQ(ierr);
381d763cef2SBarry Smith   }
382*68bece0bSHong Zhang 
383d763cef2SBarry Smith   PetscFunctionReturn(0);
384d763cef2SBarry Smith }
385d763cef2SBarry Smith 
386d763cef2SBarry Smith #undef __FUNCT__
387bc952696SBarry Smith #define __FUNCT__ "TSSetSaveTrajectory"
388d2daff3dSHong Zhang /*@
389bc952696SBarry Smith    TSSetSaveTrajectory - Causes the TS to save its solutions as it iterates forward in time in a TSTrajectory object
390d2daff3dSHong Zhang 
391d2daff3dSHong Zhang    Collective on TS
392d2daff3dSHong Zhang 
393d2daff3dSHong Zhang    Input Parameters:
394bc952696SBarry Smith .  ts - the TS context obtained from TSCreate()
395bc952696SBarry Smith 
396*68bece0bSHong Zhang Note: This routine should be called after all TS options have been set
397d2daff3dSHong Zhang 
398d2daff3dSHong Zhang    Level: intermediate
399d2daff3dSHong Zhang 
400bc952696SBarry Smith .seealso: TSGetTrajectory(), TSAdjointSolve()
401d2daff3dSHong Zhang 
402bc952696SBarry Smith .keywords: TS, set, checkpoint,
403d2daff3dSHong Zhang @*/
404bc952696SBarry Smith PetscErrorCode  TSSetSaveTrajectory(TS ts)
405d2daff3dSHong Zhang {
406bc952696SBarry Smith   PetscErrorCode ierr;
407bc952696SBarry Smith 
408d2daff3dSHong Zhang   PetscFunctionBegin;
409d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
410bc952696SBarry Smith   if (!ts->trajectory) {
411bc952696SBarry Smith     ierr = TSTrajectoryCreate(PetscObjectComm((PetscObject)ts),&ts->trajectory);CHKERRQ(ierr);
412972caf09SHong Zhang     ierr = TSTrajectorySetFromOptions(ts->trajectory,ts);CHKERRQ(ierr);
413bc952696SBarry Smith   }
414d2daff3dSHong Zhang   PetscFunctionReturn(0);
415d2daff3dSHong Zhang }
416d2daff3dSHong Zhang 
417a7a1495cSBarry Smith #undef __FUNCT__
418a7a1495cSBarry Smith #define __FUNCT__ "TSComputeRHSJacobian"
419a7a1495cSBarry Smith /*@
420a7a1495cSBarry Smith    TSComputeRHSJacobian - Computes the Jacobian matrix that has been
421a7a1495cSBarry Smith       set with TSSetRHSJacobian().
422a7a1495cSBarry Smith 
423a7a1495cSBarry Smith    Collective on TS and Vec
424a7a1495cSBarry Smith 
425a7a1495cSBarry Smith    Input Parameters:
426316643e7SJed Brown +  ts - the TS context
427a7a1495cSBarry Smith .  t - current timestep
4280910c330SBarry Smith -  U - input vector
429a7a1495cSBarry Smith 
430a7a1495cSBarry Smith    Output Parameters:
431a7a1495cSBarry Smith +  A - Jacobian matrix
432a7a1495cSBarry Smith .  B - optional preconditioning matrix
433a7a1495cSBarry Smith -  flag - flag indicating matrix structure
434a7a1495cSBarry Smith 
435a7a1495cSBarry Smith    Notes:
436a7a1495cSBarry Smith    Most users should not need to explicitly call this routine, as it
437a7a1495cSBarry Smith    is used internally within the nonlinear solvers.
438a7a1495cSBarry Smith 
43994b7f48cSBarry Smith    See KSPSetOperators() for important information about setting the
440a7a1495cSBarry Smith    flag parameter.
441a7a1495cSBarry Smith 
442a7a1495cSBarry Smith    Level: developer
443a7a1495cSBarry Smith 
444a7a1495cSBarry Smith .keywords: SNES, compute, Jacobian, matrix
445a7a1495cSBarry Smith 
44694b7f48cSBarry Smith .seealso:  TSSetRHSJacobian(), KSPSetOperators()
447a7a1495cSBarry Smith @*/
448d1e9a80fSBarry Smith PetscErrorCode  TSComputeRHSJacobian(TS ts,PetscReal t,Vec U,Mat A,Mat B)
449a7a1495cSBarry Smith {
450dfbe8321SBarry Smith   PetscErrorCode ierr;
451270bf2e7SJed Brown   PetscObjectState Ustate;
45224989b8cSPeter Brune   DM             dm;
453942e3340SBarry Smith   DMTS           tsdm;
45424989b8cSPeter Brune   TSRHSJacobian  rhsjacobianfunc;
45524989b8cSPeter Brune   void           *ctx;
45624989b8cSPeter Brune   TSIJacobian    ijacobianfunc;
457b2df71adSDebojyoti Ghosh   TSRHSFunction  rhsfunction;
458a7a1495cSBarry Smith 
459a7a1495cSBarry Smith   PetscFunctionBegin;
4600700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4610910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
4620910c330SBarry Smith   PetscCheckSameComm(ts,1,U,3);
46324989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
464942e3340SBarry Smith   ierr = DMGetDMTS(dm,&tsdm);CHKERRQ(ierr);
46524989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,&rhsjacobianfunc,&ctx);CHKERRQ(ierr);
4660298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobianfunc,NULL);CHKERRQ(ierr);
467b2df71adSDebojyoti Ghosh   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
46859e4f3c8SBarry Smith   ierr = PetscObjectStateGet((PetscObject)U,&Ustate);CHKERRQ(ierr);
469b2df71adSDebojyoti Ghosh   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.X == U && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) {
4700e4ef248SJed Brown     PetscFunctionReturn(0);
471f8ede8e7SJed Brown   }
472d90be118SSean Farley 
473ce94432eSBarry Smith   if (!rhsjacobianfunc && !ijacobianfunc) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
474d90be118SSean Farley 
475e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
47694ab13aaSBarry Smith     ierr = MatShift(A,-ts->rhsjacobian.shift);CHKERRQ(ierr);
47794ab13aaSBarry Smith     ierr = MatScale(A,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
47894ab13aaSBarry Smith     if (A != B) {
47994ab13aaSBarry Smith       ierr = MatShift(B,-ts->rhsjacobian.shift);CHKERRQ(ierr);
48094ab13aaSBarry Smith       ierr = MatScale(B,1./ts->rhsjacobian.scale);CHKERRQ(ierr);
481e1244c69SJed Brown     }
482e1244c69SJed Brown     ts->rhsjacobian.shift = 0;
483e1244c69SJed Brown     ts->rhsjacobian.scale = 1.;
484e1244c69SJed Brown   }
485e1244c69SJed Brown 
48624989b8cSPeter Brune   if (rhsjacobianfunc) {
48794ab13aaSBarry Smith     ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
488a7a1495cSBarry Smith     PetscStackPush("TS user Jacobian function");
489d1e9a80fSBarry Smith     ierr = (*rhsjacobianfunc)(ts,t,U,A,B,ctx);CHKERRQ(ierr);
490a7a1495cSBarry Smith     PetscStackPop;
49194ab13aaSBarry Smith     ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
492a7a1495cSBarry Smith     /* make sure user returned a correct Jacobian and preconditioner */
49394ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
49494ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
495ef66eb69SBarry Smith   } else {
49694ab13aaSBarry Smith     ierr = MatZeroEntries(A);CHKERRQ(ierr);
49794ab13aaSBarry Smith     if (A != B) {ierr = MatZeroEntries(B);CHKERRQ(ierr);}
498ef66eb69SBarry Smith   }
4990e4ef248SJed Brown   ts->rhsjacobian.time       = t;
5000910c330SBarry Smith   ts->rhsjacobian.X          = U;
50159e4f3c8SBarry Smith   ierr                       = PetscObjectStateGet((PetscObject)U,&ts->rhsjacobian.Xstate);CHKERRQ(ierr);
502a7a1495cSBarry Smith   PetscFunctionReturn(0);
503a7a1495cSBarry Smith }
504a7a1495cSBarry Smith 
5054a2ae208SSatish Balay #undef __FUNCT__
5064a2ae208SSatish Balay #define __FUNCT__ "TSComputeRHSFunction"
507316643e7SJed Brown /*@
508d763cef2SBarry Smith    TSComputeRHSFunction - Evaluates the right-hand-side function.
509d763cef2SBarry Smith 
510316643e7SJed Brown    Collective on TS and Vec
511316643e7SJed Brown 
512316643e7SJed Brown    Input Parameters:
513316643e7SJed Brown +  ts - the TS context
514316643e7SJed Brown .  t - current time
5150910c330SBarry Smith -  U - state vector
516316643e7SJed Brown 
517316643e7SJed Brown    Output Parameter:
518316643e7SJed Brown .  y - right hand side
519316643e7SJed Brown 
520316643e7SJed Brown    Note:
521316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
522316643e7SJed Brown    is used internally within the nonlinear solvers.
523316643e7SJed Brown 
524316643e7SJed Brown    Level: developer
525316643e7SJed Brown 
526316643e7SJed Brown .keywords: TS, compute
527316643e7SJed Brown 
528316643e7SJed Brown .seealso: TSSetRHSFunction(), TSComputeIFunction()
529316643e7SJed Brown @*/
5300910c330SBarry Smith PetscErrorCode TSComputeRHSFunction(TS ts,PetscReal t,Vec U,Vec y)
531d763cef2SBarry Smith {
532dfbe8321SBarry Smith   PetscErrorCode ierr;
53324989b8cSPeter Brune   TSRHSFunction  rhsfunction;
53424989b8cSPeter Brune   TSIFunction    ifunction;
53524989b8cSPeter Brune   void           *ctx;
53624989b8cSPeter Brune   DM             dm;
53724989b8cSPeter Brune 
538d763cef2SBarry Smith   PetscFunctionBegin;
5390700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5400910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
5410700a824SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,4);
54224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
54324989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,&rhsfunction,&ctx);CHKERRQ(ierr);
5440298fd71SBarry Smith   ierr = DMTSGetIFunction(dm,&ifunction,NULL);CHKERRQ(ierr);
545d763cef2SBarry Smith 
546ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
547d763cef2SBarry Smith 
5480910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
54924989b8cSPeter Brune   if (rhsfunction) {
550d763cef2SBarry Smith     PetscStackPush("TS user right-hand-side function");
5510910c330SBarry Smith     ierr = (*rhsfunction)(ts,t,U,y,ctx);CHKERRQ(ierr);
552d763cef2SBarry Smith     PetscStackPop;
553214bc6a2SJed Brown   } else {
554214bc6a2SJed Brown     ierr = VecZeroEntries(y);CHKERRQ(ierr);
555b2cd27e8SJed Brown   }
55644a41b28SSean Farley 
5570910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,y,0);CHKERRQ(ierr);
558d763cef2SBarry Smith   PetscFunctionReturn(0);
559d763cef2SBarry Smith }
560d763cef2SBarry Smith 
5614a2ae208SSatish Balay #undef __FUNCT__
562ef20d060SBarry Smith #define __FUNCT__ "TSComputeSolutionFunction"
563ef20d060SBarry Smith /*@
564ef20d060SBarry Smith    TSComputeSolutionFunction - Evaluates the solution function.
565ef20d060SBarry Smith 
566ef20d060SBarry Smith    Collective on TS and Vec
567ef20d060SBarry Smith 
568ef20d060SBarry Smith    Input Parameters:
569ef20d060SBarry Smith +  ts - the TS context
570ef20d060SBarry Smith -  t - current time
571ef20d060SBarry Smith 
572ef20d060SBarry Smith    Output Parameter:
5730910c330SBarry Smith .  U - the solution
574ef20d060SBarry Smith 
575ef20d060SBarry Smith    Note:
576ef20d060SBarry Smith    Most users should not need to explicitly call this routine, as it
577ef20d060SBarry Smith    is used internally within the nonlinear solvers.
578ef20d060SBarry Smith 
579ef20d060SBarry Smith    Level: developer
580ef20d060SBarry Smith 
581ef20d060SBarry Smith .keywords: TS, compute
582ef20d060SBarry Smith 
583abd5a294SJed Brown .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
584ef20d060SBarry Smith @*/
5850910c330SBarry Smith PetscErrorCode TSComputeSolutionFunction(TS ts,PetscReal t,Vec U)
586ef20d060SBarry Smith {
587ef20d060SBarry Smith   PetscErrorCode     ierr;
588ef20d060SBarry Smith   TSSolutionFunction solutionfunction;
589ef20d060SBarry Smith   void               *ctx;
590ef20d060SBarry Smith   DM                 dm;
591ef20d060SBarry Smith 
592ef20d060SBarry Smith   PetscFunctionBegin;
593ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5940910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
595ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
596ef20d060SBarry Smith   ierr = DMTSGetSolutionFunction(dm,&solutionfunction,&ctx);CHKERRQ(ierr);
597ef20d060SBarry Smith 
598ef20d060SBarry Smith   if (solutionfunction) {
5999b7cd975SBarry Smith     PetscStackPush("TS user solution function");
6000910c330SBarry Smith     ierr = (*solutionfunction)(ts,t,U,ctx);CHKERRQ(ierr);
601ef20d060SBarry Smith     PetscStackPop;
602ef20d060SBarry Smith   }
603ef20d060SBarry Smith   PetscFunctionReturn(0);
604ef20d060SBarry Smith }
6059b7cd975SBarry Smith #undef __FUNCT__
6069b7cd975SBarry Smith #define __FUNCT__ "TSComputeForcingFunction"
6079b7cd975SBarry Smith /*@
6089b7cd975SBarry Smith    TSComputeForcingFunction - Evaluates the forcing function.
6099b7cd975SBarry Smith 
6109b7cd975SBarry Smith    Collective on TS and Vec
6119b7cd975SBarry Smith 
6129b7cd975SBarry Smith    Input Parameters:
6139b7cd975SBarry Smith +  ts - the TS context
6149b7cd975SBarry Smith -  t - current time
6159b7cd975SBarry Smith 
6169b7cd975SBarry Smith    Output Parameter:
6179b7cd975SBarry Smith .  U - the function value
6189b7cd975SBarry Smith 
6199b7cd975SBarry Smith    Note:
6209b7cd975SBarry Smith    Most users should not need to explicitly call this routine, as it
6219b7cd975SBarry Smith    is used internally within the nonlinear solvers.
6229b7cd975SBarry Smith 
6239b7cd975SBarry Smith    Level: developer
6249b7cd975SBarry Smith 
6259b7cd975SBarry Smith .keywords: TS, compute
6269b7cd975SBarry Smith 
6279b7cd975SBarry Smith .seealso: TSSetSolutionFunction(), TSSetRHSFunction(), TSComputeIFunction()
6289b7cd975SBarry Smith @*/
6299b7cd975SBarry Smith PetscErrorCode TSComputeForcingFunction(TS ts,PetscReal t,Vec U)
6309b7cd975SBarry Smith {
6319b7cd975SBarry Smith   PetscErrorCode     ierr, (*forcing)(TS,PetscReal,Vec,void*);
6329b7cd975SBarry Smith   void               *ctx;
6339b7cd975SBarry Smith   DM                 dm;
6349b7cd975SBarry Smith 
6359b7cd975SBarry Smith   PetscFunctionBegin;
6369b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6379b7cd975SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
6389b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
6399b7cd975SBarry Smith   ierr = DMTSGetForcingFunction(dm,&forcing,&ctx);CHKERRQ(ierr);
6409b7cd975SBarry Smith 
6419b7cd975SBarry Smith   if (forcing) {
6429b7cd975SBarry Smith     PetscStackPush("TS user forcing function");
6439b7cd975SBarry Smith     ierr = (*forcing)(ts,t,U,ctx);CHKERRQ(ierr);
6449b7cd975SBarry Smith     PetscStackPop;
6459b7cd975SBarry Smith   }
6469b7cd975SBarry Smith   PetscFunctionReturn(0);
6479b7cd975SBarry Smith }
648ef20d060SBarry Smith 
649ef20d060SBarry Smith #undef __FUNCT__
650214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSVec_Private"
651214bc6a2SJed Brown static PetscErrorCode TSGetRHSVec_Private(TS ts,Vec *Frhs)
652214bc6a2SJed Brown {
6532dd45cf8SJed Brown   Vec            F;
654214bc6a2SJed Brown   PetscErrorCode ierr;
655214bc6a2SJed Brown 
656214bc6a2SJed Brown   PetscFunctionBegin;
6570298fd71SBarry Smith   *Frhs = NULL;
6580298fd71SBarry Smith   ierr  = TSGetIFunction(ts,&F,NULL,NULL);CHKERRQ(ierr);
659214bc6a2SJed Brown   if (!ts->Frhs) {
6602dd45cf8SJed Brown     ierr = VecDuplicate(F,&ts->Frhs);CHKERRQ(ierr);
661214bc6a2SJed Brown   }
662214bc6a2SJed Brown   *Frhs = ts->Frhs;
663214bc6a2SJed Brown   PetscFunctionReturn(0);
664214bc6a2SJed Brown }
665214bc6a2SJed Brown 
666214bc6a2SJed Brown #undef __FUNCT__
667214bc6a2SJed Brown #define __FUNCT__ "TSGetRHSMats_Private"
668214bc6a2SJed Brown static PetscErrorCode TSGetRHSMats_Private(TS ts,Mat *Arhs,Mat *Brhs)
669214bc6a2SJed Brown {
670214bc6a2SJed Brown   Mat            A,B;
6712dd45cf8SJed Brown   PetscErrorCode ierr;
672214bc6a2SJed Brown 
673214bc6a2SJed Brown   PetscFunctionBegin;
674c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
675c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
6760298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
677214bc6a2SJed Brown   if (Arhs) {
678214bc6a2SJed Brown     if (!ts->Arhs) {
679214bc6a2SJed Brown       ierr = MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,&ts->Arhs);CHKERRQ(ierr);
680214bc6a2SJed Brown     }
681214bc6a2SJed Brown     *Arhs = ts->Arhs;
682214bc6a2SJed Brown   }
683214bc6a2SJed Brown   if (Brhs) {
684214bc6a2SJed Brown     if (!ts->Brhs) {
685bdb70873SJed Brown       if (A != B) {
686214bc6a2SJed Brown         ierr = MatDuplicate(B,MAT_DO_NOT_COPY_VALUES,&ts->Brhs);CHKERRQ(ierr);
687bdb70873SJed Brown       } else {
688bdb70873SJed Brown         ts->Brhs = ts->Arhs;
689bdb70873SJed Brown         ierr = PetscObjectReference((PetscObject)ts->Arhs);CHKERRQ(ierr);
690bdb70873SJed Brown       }
691214bc6a2SJed Brown     }
692214bc6a2SJed Brown     *Brhs = ts->Brhs;
693214bc6a2SJed Brown   }
694214bc6a2SJed Brown   PetscFunctionReturn(0);
695214bc6a2SJed Brown }
696214bc6a2SJed Brown 
697214bc6a2SJed Brown #undef __FUNCT__
698316643e7SJed Brown #define __FUNCT__ "TSComputeIFunction"
699316643e7SJed Brown /*@
7000910c330SBarry Smith    TSComputeIFunction - Evaluates the DAE residual written in implicit form F(t,U,Udot)=0
701316643e7SJed Brown 
702316643e7SJed Brown    Collective on TS and Vec
703316643e7SJed Brown 
704316643e7SJed Brown    Input Parameters:
705316643e7SJed Brown +  ts - the TS context
706316643e7SJed Brown .  t - current time
7070910c330SBarry Smith .  U - state vector
7080910c330SBarry Smith .  Udot - time derivative of state vector
709214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSFunction should be kept separate
710316643e7SJed Brown 
711316643e7SJed Brown    Output Parameter:
712316643e7SJed Brown .  Y - right hand side
713316643e7SJed Brown 
714316643e7SJed Brown    Note:
715316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
716316643e7SJed Brown    is used internally within the nonlinear solvers.
717316643e7SJed Brown 
718316643e7SJed Brown    If the user did did not write their equations in implicit form, this
719316643e7SJed Brown    function recasts them in implicit form.
720316643e7SJed Brown 
721316643e7SJed Brown    Level: developer
722316643e7SJed Brown 
723316643e7SJed Brown .keywords: TS, compute
724316643e7SJed Brown 
725316643e7SJed Brown .seealso: TSSetIFunction(), TSComputeRHSFunction()
726316643e7SJed Brown @*/
7270910c330SBarry Smith PetscErrorCode TSComputeIFunction(TS ts,PetscReal t,Vec U,Vec Udot,Vec Y,PetscBool imex)
728316643e7SJed Brown {
729316643e7SJed Brown   PetscErrorCode ierr;
73024989b8cSPeter Brune   TSIFunction    ifunction;
73124989b8cSPeter Brune   TSRHSFunction  rhsfunction;
73224989b8cSPeter Brune   void           *ctx;
73324989b8cSPeter Brune   DM             dm;
734316643e7SJed Brown 
735316643e7SJed Brown   PetscFunctionBegin;
7360700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
7370910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
7380910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
7390700a824SBarry Smith   PetscValidHeaderSpecific(Y,VEC_CLASSID,5);
740316643e7SJed Brown 
74124989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
74224989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,&ifunction,&ctx);CHKERRQ(ierr);
7430298fd71SBarry Smith   ierr = DMTSGetRHSFunction(dm,&rhsfunction,NULL);CHKERRQ(ierr);
74424989b8cSPeter Brune 
745ce94432eSBarry Smith   if (!rhsfunction && !ifunction) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSFunction() and / or TSSetIFunction()");
746d90be118SSean Farley 
7470910c330SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
74824989b8cSPeter Brune   if (ifunction) {
749316643e7SJed Brown     PetscStackPush("TS user implicit function");
7500910c330SBarry Smith     ierr = (*ifunction)(ts,t,U,Udot,Y,ctx);CHKERRQ(ierr);
751316643e7SJed Brown     PetscStackPop;
752214bc6a2SJed Brown   }
753214bc6a2SJed Brown   if (imex) {
75424989b8cSPeter Brune     if (!ifunction) {
7550910c330SBarry Smith       ierr = VecCopy(Udot,Y);CHKERRQ(ierr);
7562dd45cf8SJed Brown     }
75724989b8cSPeter Brune   } else if (rhsfunction) {
75824989b8cSPeter Brune     if (ifunction) {
759214bc6a2SJed Brown       Vec Frhs;
760214bc6a2SJed Brown       ierr = TSGetRHSVec_Private(ts,&Frhs);CHKERRQ(ierr);
7610910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Frhs);CHKERRQ(ierr);
762214bc6a2SJed Brown       ierr = VecAXPY(Y,-1,Frhs);CHKERRQ(ierr);
7632dd45cf8SJed Brown     } else {
7640910c330SBarry Smith       ierr = TSComputeRHSFunction(ts,t,U,Y);CHKERRQ(ierr);
7650910c330SBarry Smith       ierr = VecAYPX(Y,-1,Udot);CHKERRQ(ierr);
766316643e7SJed Brown     }
7674a6899ffSJed Brown   }
7680910c330SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,U,Udot,Y);CHKERRQ(ierr);
769316643e7SJed Brown   PetscFunctionReturn(0);
770316643e7SJed Brown }
771316643e7SJed Brown 
772316643e7SJed Brown #undef __FUNCT__
773316643e7SJed Brown #define __FUNCT__ "TSComputeIJacobian"
774316643e7SJed Brown /*@
775316643e7SJed Brown    TSComputeIJacobian - Evaluates the Jacobian of the DAE
776316643e7SJed Brown 
777316643e7SJed Brown    Collective on TS and Vec
778316643e7SJed Brown 
779316643e7SJed Brown    Input
780316643e7SJed Brown       Input Parameters:
781316643e7SJed Brown +  ts - the TS context
782316643e7SJed Brown .  t - current timestep
7830910c330SBarry Smith .  U - state vector
7840910c330SBarry Smith .  Udot - time derivative of state vector
785214bc6a2SJed Brown .  shift - shift to apply, see note below
786214bc6a2SJed Brown -  imex - flag indicates if the method is IMEX so that the RHSJacobian should be kept separate
787316643e7SJed Brown 
788316643e7SJed Brown    Output Parameters:
789316643e7SJed Brown +  A - Jacobian matrix
790316643e7SJed Brown .  B - optional preconditioning matrix
791316643e7SJed Brown -  flag - flag indicating matrix structure
792316643e7SJed Brown 
793316643e7SJed Brown    Notes:
7940910c330SBarry Smith    If F(t,U,Udot)=0 is the DAE, the required Jacobian is
795316643e7SJed Brown 
7960910c330SBarry Smith    dF/dU + shift*dF/dUdot
797316643e7SJed Brown 
798316643e7SJed Brown    Most users should not need to explicitly call this routine, as it
799316643e7SJed Brown    is used internally within the nonlinear solvers.
800316643e7SJed Brown 
801316643e7SJed Brown    Level: developer
802316643e7SJed Brown 
803316643e7SJed Brown .keywords: TS, compute, Jacobian, matrix
804316643e7SJed Brown 
805316643e7SJed Brown .seealso:  TSSetIJacobian()
80663495f91SJed Brown @*/
807d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobian(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,PetscBool imex)
808316643e7SJed Brown {
809316643e7SJed Brown   PetscErrorCode ierr;
81024989b8cSPeter Brune   TSIJacobian    ijacobian;
81124989b8cSPeter Brune   TSRHSJacobian  rhsjacobian;
81224989b8cSPeter Brune   DM             dm;
81324989b8cSPeter Brune   void           *ctx;
814316643e7SJed Brown 
815316643e7SJed Brown   PetscFunctionBegin;
8160700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
8170910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
8180910c330SBarry Smith   PetscValidHeaderSpecific(Udot,VEC_CLASSID,4);
819316643e7SJed Brown   PetscValidPointer(A,6);
82094ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,6);
821316643e7SJed Brown   PetscValidPointer(B,7);
82294ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,7);
82324989b8cSPeter Brune 
82424989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
82524989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,&ijacobian,&ctx);CHKERRQ(ierr);
8260298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjacobian,NULL);CHKERRQ(ierr);
82724989b8cSPeter Brune 
828ce94432eSBarry Smith   if (!rhsjacobian && !ijacobian) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_USER,"Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
829316643e7SJed Brown 
83094ab13aaSBarry Smith   ierr = PetscLogEventBegin(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
83124989b8cSPeter Brune   if (ijacobian) {
832316643e7SJed Brown     PetscStackPush("TS user implicit Jacobian");
833d1e9a80fSBarry Smith     ierr = (*ijacobian)(ts,t,U,Udot,shift,A,B,ctx);CHKERRQ(ierr);
834316643e7SJed Brown     PetscStackPop;
835214bc6a2SJed Brown     /* make sure user returned a correct Jacobian and preconditioner */
83694ab13aaSBarry Smith     PetscValidHeaderSpecific(A,MAT_CLASSID,4);
83794ab13aaSBarry Smith     PetscValidHeaderSpecific(B,MAT_CLASSID,5);
8384a6899ffSJed Brown   }
839214bc6a2SJed Brown   if (imex) {
840b5abc632SBarry Smith     if (!ijacobian) {  /* system was written as Udot = G(t,U) */
84194ab13aaSBarry Smith       ierr = MatZeroEntries(A);CHKERRQ(ierr);
84294ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
84394ab13aaSBarry Smith       if (A != B) {
84494ab13aaSBarry Smith         ierr = MatZeroEntries(B);CHKERRQ(ierr);
84594ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
846214bc6a2SJed Brown       }
847214bc6a2SJed Brown     }
848214bc6a2SJed Brown   } else {
849e1244c69SJed Brown     Mat Arhs = NULL,Brhs = NULL;
850e1244c69SJed Brown     if (rhsjacobian) {
851bd373395SBarry Smith       if (ijacobian) {
852214bc6a2SJed Brown         ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
853bd373395SBarry Smith       } else {
854bd373395SBarry Smith         ierr = TSGetIJacobian(ts,&Arhs,&Brhs,NULL,NULL);CHKERRQ(ierr);
855214bc6a2SJed Brown       }
856d1e9a80fSBarry Smith       ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
857e1244c69SJed Brown     }
85894ab13aaSBarry Smith     if (Arhs == A) {           /* No IJacobian, so we only have the RHS matrix */
859e1244c69SJed Brown       ts->rhsjacobian.scale = -1;
860e1244c69SJed Brown       ts->rhsjacobian.shift = shift;
86194ab13aaSBarry Smith       ierr = MatScale(A,-1);CHKERRQ(ierr);
86294ab13aaSBarry Smith       ierr = MatShift(A,shift);CHKERRQ(ierr);
86394ab13aaSBarry Smith       if (A != B) {
86494ab13aaSBarry Smith         ierr = MatScale(B,-1);CHKERRQ(ierr);
86594ab13aaSBarry Smith         ierr = MatShift(B,shift);CHKERRQ(ierr);
866316643e7SJed Brown       }
867e1244c69SJed Brown     } else if (Arhs) {          /* Both IJacobian and RHSJacobian */
868e1244c69SJed Brown       MatStructure axpy = DIFFERENT_NONZERO_PATTERN;
869e1244c69SJed Brown       if (!ijacobian) {         /* No IJacobian provided, but we have a separate RHS matrix */
87094ab13aaSBarry Smith         ierr = MatZeroEntries(A);CHKERRQ(ierr);
87194ab13aaSBarry Smith         ierr = MatShift(A,shift);CHKERRQ(ierr);
87294ab13aaSBarry Smith         if (A != B) {
87394ab13aaSBarry Smith           ierr = MatZeroEntries(B);CHKERRQ(ierr);
87494ab13aaSBarry Smith           ierr = MatShift(B,shift);CHKERRQ(ierr);
875214bc6a2SJed Brown         }
876316643e7SJed Brown       }
87794ab13aaSBarry Smith       ierr = MatAXPY(A,-1,Arhs,axpy);CHKERRQ(ierr);
87894ab13aaSBarry Smith       if (A != B) {
87994ab13aaSBarry Smith         ierr = MatAXPY(B,-1,Brhs,axpy);CHKERRQ(ierr);
880316643e7SJed Brown       }
881316643e7SJed Brown     }
882316643e7SJed Brown   }
88394ab13aaSBarry Smith   ierr = PetscLogEventEnd(TS_JacobianEval,ts,U,A,B);CHKERRQ(ierr);
884316643e7SJed Brown   PetscFunctionReturn(0);
885316643e7SJed Brown }
886316643e7SJed Brown 
887316643e7SJed Brown #undef __FUNCT__
8884a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSFunction"
889d763cef2SBarry Smith /*@C
890d763cef2SBarry Smith     TSSetRHSFunction - Sets the routine for evaluating the function,
891b5abc632SBarry Smith     where U_t = G(t,u).
892d763cef2SBarry Smith 
8933f9fe445SBarry Smith     Logically Collective on TS
894d763cef2SBarry Smith 
895d763cef2SBarry Smith     Input Parameters:
896d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
8970298fd71SBarry Smith .   r - vector to put the computed right hand side (or NULL to have it created)
898d763cef2SBarry Smith .   f - routine for evaluating the right-hand-side function
899d763cef2SBarry Smith -   ctx - [optional] user-defined context for private data for the
9000298fd71SBarry Smith           function evaluation routine (may be NULL)
901d763cef2SBarry Smith 
902d763cef2SBarry Smith     Calling sequence of func:
90387828ca2SBarry Smith $     func (TS ts,PetscReal t,Vec u,Vec F,void *ctx);
904d763cef2SBarry Smith 
905d763cef2SBarry Smith +   t - current timestep
906d763cef2SBarry Smith .   u - input vector
907d763cef2SBarry Smith .   F - function vector
908d763cef2SBarry Smith -   ctx - [optional] user-defined function context
909d763cef2SBarry Smith 
910d763cef2SBarry Smith     Level: beginner
911d763cef2SBarry Smith 
9122bbac0d3SBarry Smith     Notes: You must call this function or TSSetIFunction() to define your ODE. You cannot use this function when solving a DAE.
9132bbac0d3SBarry Smith 
914d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
915d763cef2SBarry Smith 
916ae8867d6SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSSetIFunction()
917d763cef2SBarry Smith @*/
918089b2837SJed Brown PetscErrorCode  TSSetRHSFunction(TS ts,Vec r,PetscErrorCode (*f)(TS,PetscReal,Vec,Vec,void*),void *ctx)
919d763cef2SBarry Smith {
920089b2837SJed Brown   PetscErrorCode ierr;
921089b2837SJed Brown   SNES           snes;
9220298fd71SBarry Smith   Vec            ralloc = NULL;
92324989b8cSPeter Brune   DM             dm;
924d763cef2SBarry Smith 
925089b2837SJed Brown   PetscFunctionBegin;
9260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
927ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r,VEC_CLASSID,2);
92824989b8cSPeter Brune 
92924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
93024989b8cSPeter Brune   ierr = DMTSSetRHSFunction(dm,f,ctx);CHKERRQ(ierr);
931089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
932e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
933e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&ralloc);CHKERRQ(ierr);
934e856ceecSJed Brown     r    = ralloc;
935e856ceecSJed Brown   }
936089b2837SJed Brown   ierr = SNESSetFunction(snes,r,SNESTSFormFunction,ts);CHKERRQ(ierr);
937e856ceecSJed Brown   ierr = VecDestroy(&ralloc);CHKERRQ(ierr);
938d763cef2SBarry Smith   PetscFunctionReturn(0);
939d763cef2SBarry Smith }
940d763cef2SBarry Smith 
9414a2ae208SSatish Balay #undef __FUNCT__
942ef20d060SBarry Smith #define __FUNCT__ "TSSetSolutionFunction"
943ef20d060SBarry Smith /*@C
944abd5a294SJed Brown     TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
945ef20d060SBarry Smith 
946ef20d060SBarry Smith     Logically Collective on TS
947ef20d060SBarry Smith 
948ef20d060SBarry Smith     Input Parameters:
949ef20d060SBarry Smith +   ts - the TS context obtained from TSCreate()
950ef20d060SBarry Smith .   f - routine for evaluating the solution
951ef20d060SBarry Smith -   ctx - [optional] user-defined context for private data for the
9520298fd71SBarry Smith           function evaluation routine (may be NULL)
953ef20d060SBarry Smith 
954ef20d060SBarry Smith     Calling sequence of func:
955ef20d060SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
956ef20d060SBarry Smith 
957ef20d060SBarry Smith +   t - current timestep
958ef20d060SBarry Smith .   u - output vector
959ef20d060SBarry Smith -   ctx - [optional] user-defined function context
960ef20d060SBarry Smith 
961abd5a294SJed Brown     Notes:
962abd5a294SJed Brown     This routine is used for testing accuracy of time integration schemes when you already know the solution.
963abd5a294SJed Brown     If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
964abd5a294SJed Brown     create closed-form solutions with non-physical forcing terms.
965abd5a294SJed Brown 
9664f09c107SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
967abd5a294SJed Brown 
968ef20d060SBarry Smith     Level: beginner
969ef20d060SBarry Smith 
970ef20d060SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
971ef20d060SBarry Smith 
9729b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetForcingFunction()
973ef20d060SBarry Smith @*/
974ef20d060SBarry Smith PetscErrorCode  TSSetSolutionFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
975ef20d060SBarry Smith {
976ef20d060SBarry Smith   PetscErrorCode ierr;
977ef20d060SBarry Smith   DM             dm;
978ef20d060SBarry Smith 
979ef20d060SBarry Smith   PetscFunctionBegin;
980ef20d060SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
981ef20d060SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
982ef20d060SBarry Smith   ierr = DMTSSetSolutionFunction(dm,f,ctx);CHKERRQ(ierr);
983ef20d060SBarry Smith   PetscFunctionReturn(0);
984ef20d060SBarry Smith }
985ef20d060SBarry Smith 
986ef20d060SBarry Smith #undef __FUNCT__
9879b7cd975SBarry Smith #define __FUNCT__ "TSSetForcingFunction"
9889b7cd975SBarry Smith /*@C
9899b7cd975SBarry Smith     TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
9909b7cd975SBarry Smith 
9919b7cd975SBarry Smith     Logically Collective on TS
9929b7cd975SBarry Smith 
9939b7cd975SBarry Smith     Input Parameters:
9949b7cd975SBarry Smith +   ts - the TS context obtained from TSCreate()
9959b7cd975SBarry Smith .   f - routine for evaluating the forcing function
9969b7cd975SBarry Smith -   ctx - [optional] user-defined context for private data for the
9970298fd71SBarry Smith           function evaluation routine (may be NULL)
9989b7cd975SBarry Smith 
9999b7cd975SBarry Smith     Calling sequence of func:
10009b7cd975SBarry Smith $     func (TS ts,PetscReal t,Vec u,void *ctx);
10019b7cd975SBarry Smith 
10029b7cd975SBarry Smith +   t - current timestep
10039b7cd975SBarry Smith .   u - output vector
10049b7cd975SBarry Smith -   ctx - [optional] user-defined function context
10059b7cd975SBarry Smith 
10069b7cd975SBarry Smith     Notes:
10079b7cd975SBarry Smith     This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
10089b7cd975SBarry Smith     create closed-form solutions with a non-physical forcing term.
10099b7cd975SBarry Smith 
10109b7cd975SBarry Smith     For low-dimensional problems solved in serial, such as small discrete systems, TSMonitorLGError() can be used to monitor the error history.
10119b7cd975SBarry Smith 
10129b7cd975SBarry Smith     Level: beginner
10139b7cd975SBarry Smith 
10149b7cd975SBarry Smith .keywords: TS, timestep, set, right-hand-side, function
10159b7cd975SBarry Smith 
10169b7cd975SBarry Smith .seealso: TSSetRHSJacobian(), TSSetIJacobian(), TSComputeSolutionFunction(), TSSetSolutionFunction()
10179b7cd975SBarry Smith @*/
10189b7cd975SBarry Smith PetscErrorCode  TSSetForcingFunction(TS ts,PetscErrorCode (*f)(TS,PetscReal,Vec,void*),void *ctx)
10199b7cd975SBarry Smith {
10209b7cd975SBarry Smith   PetscErrorCode ierr;
10219b7cd975SBarry Smith   DM             dm;
10229b7cd975SBarry Smith 
10239b7cd975SBarry Smith   PetscFunctionBegin;
10249b7cd975SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
10259b7cd975SBarry Smith   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
10269b7cd975SBarry Smith   ierr = DMTSSetForcingFunction(dm,f,ctx);CHKERRQ(ierr);
10279b7cd975SBarry Smith   PetscFunctionReturn(0);
10289b7cd975SBarry Smith }
10299b7cd975SBarry Smith 
10309b7cd975SBarry Smith #undef __FUNCT__
10314a2ae208SSatish Balay #define __FUNCT__ "TSSetRHSJacobian"
1032d763cef2SBarry Smith /*@C
1033f7ab8db6SBarry Smith    TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1034b5abc632SBarry Smith    where U_t = G(U,t), as well as the location to store the matrix.
1035d763cef2SBarry Smith 
10363f9fe445SBarry Smith    Logically Collective on TS
1037d763cef2SBarry Smith 
1038d763cef2SBarry Smith    Input Parameters:
1039d763cef2SBarry Smith +  ts  - the TS context obtained from TSCreate()
1040e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1041e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1042d763cef2SBarry Smith .  f   - the Jacobian evaluation routine
1043d763cef2SBarry Smith -  ctx - [optional] user-defined context for private data for the
10440298fd71SBarry Smith          Jacobian evaluation routine (may be NULL)
1045d763cef2SBarry Smith 
1046f7ab8db6SBarry Smith    Calling sequence of f:
1047ae8867d6SBarry Smith $     func (TS ts,PetscReal t,Vec u,Mat A,Mat B,void *ctx);
1048d763cef2SBarry Smith 
1049d763cef2SBarry Smith +  t - current timestep
1050d763cef2SBarry Smith .  u - input vector
1051e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1052e5d3d808SBarry Smith .  Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
1053d763cef2SBarry Smith -  ctx - [optional] user-defined context for matrix evaluation routine
1054d763cef2SBarry Smith 
1055ca5f011dSBarry Smith    Notes: The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1056ca5f011dSBarry Smith           You should not assume the values are the same in the next call to f() as you set them in the previous call.
1057d763cef2SBarry Smith 
1058d763cef2SBarry Smith    Level: beginner
1059d763cef2SBarry Smith 
1060d763cef2SBarry Smith .keywords: TS, timestep, set, right-hand-side, Jacobian
1061d763cef2SBarry Smith 
1062ae8867d6SBarry Smith .seealso: SNESComputeJacobianDefaultColor(), TSSetRHSFunction(), TSRHSJacobianSetReuse(), TSSetIJacobian()
1063d763cef2SBarry Smith 
1064d763cef2SBarry Smith @*/
1065e5d3d808SBarry Smith PetscErrorCode  TSSetRHSJacobian(TS ts,Mat Amat,Mat Pmat,TSRHSJacobian f,void *ctx)
1066d763cef2SBarry Smith {
1067277b19d0SLisandro Dalcin   PetscErrorCode ierr;
1068089b2837SJed Brown   SNES           snes;
106924989b8cSPeter Brune   DM             dm;
107024989b8cSPeter Brune   TSIJacobian    ijacobian;
1071277b19d0SLisandro Dalcin 
1072d763cef2SBarry Smith   PetscFunctionBegin;
10730700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1074e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1075e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1076e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1077e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
1078d763cef2SBarry Smith 
107924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
108024989b8cSPeter Brune   ierr = DMTSSetRHSJacobian(dm,f,ctx);CHKERRQ(ierr);
1081e1244c69SJed Brown   if (f == TSComputeRHSJacobianConstant) {
1082e1244c69SJed Brown     /* Handle this case automatically for the user; otherwise user should call themselves. */
1083e1244c69SJed Brown     ierr = TSRHSJacobianSetReuse(ts,PETSC_TRUE);CHKERRQ(ierr);
1084e1244c69SJed Brown   }
10850298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijacobian,NULL);CHKERRQ(ierr);
1086089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
10875f659677SPeter Brune   if (!ijacobian) {
1088e5d3d808SBarry Smith     ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
10890e4ef248SJed Brown   }
1090e5d3d808SBarry Smith   if (Amat) {
1091e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
10920e4ef248SJed Brown     ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
1093bbd56ea5SKarl Rupp 
1094e5d3d808SBarry Smith     ts->Arhs = Amat;
10950e4ef248SJed Brown   }
1096e5d3d808SBarry Smith   if (Pmat) {
1097e5d3d808SBarry Smith     ierr = PetscObjectReference((PetscObject)Pmat);CHKERRQ(ierr);
10980e4ef248SJed Brown     ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
1099bbd56ea5SKarl Rupp 
1100e5d3d808SBarry Smith     ts->Brhs = Pmat;
11010e4ef248SJed Brown   }
1102d763cef2SBarry Smith   PetscFunctionReturn(0);
1103d763cef2SBarry Smith }
1104d763cef2SBarry Smith 
1105316643e7SJed Brown 
1106316643e7SJed Brown #undef __FUNCT__
1107316643e7SJed Brown #define __FUNCT__ "TSSetIFunction"
1108316643e7SJed Brown /*@C
1109b5abc632SBarry Smith    TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1110316643e7SJed Brown 
11113f9fe445SBarry Smith    Logically Collective on TS
1112316643e7SJed Brown 
1113316643e7SJed Brown    Input Parameters:
1114316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
11150298fd71SBarry Smith .  r   - vector to hold the residual (or NULL to have it created internally)
1116316643e7SJed Brown .  f   - the function evaluation routine
11170298fd71SBarry Smith -  ctx - user-defined context for private data for the function evaluation routine (may be NULL)
1118316643e7SJed Brown 
1119316643e7SJed Brown    Calling sequence of f:
1120316643e7SJed Brown $  f(TS ts,PetscReal t,Vec u,Vec u_t,Vec F,ctx);
1121316643e7SJed Brown 
1122316643e7SJed Brown +  t   - time at step/stage being solved
1123316643e7SJed Brown .  u   - state vector
1124316643e7SJed Brown .  u_t - time derivative of state vector
1125316643e7SJed Brown .  F   - function vector
1126316643e7SJed Brown -  ctx - [optional] user-defined context for matrix evaluation routine
1127316643e7SJed Brown 
1128316643e7SJed Brown    Important:
11292bbac0d3SBarry Smith    The user MUST call either this routine or TSSetRHSFunction() to define the ODE.  When solving DAEs you must use this function.
1130316643e7SJed Brown 
1131316643e7SJed Brown    Level: beginner
1132316643e7SJed Brown 
1133316643e7SJed Brown .keywords: TS, timestep, set, DAE, Jacobian
1134316643e7SJed Brown 
1135d6cbdb99SBarry Smith .seealso: TSSetRHSJacobian(), TSSetRHSFunction(), TSSetIJacobian()
1136316643e7SJed Brown @*/
1137089b2837SJed Brown PetscErrorCode  TSSetIFunction(TS ts,Vec res,TSIFunction f,void *ctx)
1138316643e7SJed Brown {
1139089b2837SJed Brown   PetscErrorCode ierr;
1140089b2837SJed Brown   SNES           snes;
11410298fd71SBarry Smith   Vec            resalloc = NULL;
114224989b8cSPeter Brune   DM             dm;
1143316643e7SJed Brown 
1144316643e7SJed Brown   PetscFunctionBegin;
11450700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1146ca94891dSJed Brown   if (res) PetscValidHeaderSpecific(res,VEC_CLASSID,2);
114724989b8cSPeter Brune 
114824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
114924989b8cSPeter Brune   ierr = DMTSSetIFunction(dm,f,ctx);CHKERRQ(ierr);
115024989b8cSPeter Brune 
1151089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1152e856ceecSJed Brown   if (!res && !ts->dm && ts->vec_sol) {
1153e856ceecSJed Brown     ierr = VecDuplicate(ts->vec_sol,&resalloc);CHKERRQ(ierr);
1154e856ceecSJed Brown     res  = resalloc;
1155e856ceecSJed Brown   }
1156089b2837SJed Brown   ierr = SNESSetFunction(snes,res,SNESTSFormFunction,ts);CHKERRQ(ierr);
1157e856ceecSJed Brown   ierr = VecDestroy(&resalloc);CHKERRQ(ierr);
1158089b2837SJed Brown   PetscFunctionReturn(0);
1159089b2837SJed Brown }
1160089b2837SJed Brown 
1161089b2837SJed Brown #undef __FUNCT__
1162089b2837SJed Brown #define __FUNCT__ "TSGetIFunction"
1163089b2837SJed Brown /*@C
1164089b2837SJed Brown    TSGetIFunction - Returns the vector where the implicit residual is stored and the function/contex to compute it.
1165089b2837SJed Brown 
1166089b2837SJed Brown    Not Collective
1167089b2837SJed Brown 
1168089b2837SJed Brown    Input Parameter:
1169089b2837SJed Brown .  ts - the TS context
1170089b2837SJed Brown 
1171089b2837SJed Brown    Output Parameter:
11720298fd71SBarry Smith +  r - vector to hold residual (or NULL)
11730298fd71SBarry Smith .  func - the function to compute residual (or NULL)
11740298fd71SBarry Smith -  ctx - the function context (or NULL)
1175089b2837SJed Brown 
1176089b2837SJed Brown    Level: advanced
1177089b2837SJed Brown 
1178089b2837SJed Brown .keywords: TS, nonlinear, get, function
1179089b2837SJed Brown 
1180089b2837SJed Brown .seealso: TSSetIFunction(), SNESGetFunction()
1181089b2837SJed Brown @*/
1182089b2837SJed Brown PetscErrorCode TSGetIFunction(TS ts,Vec *r,TSIFunction *func,void **ctx)
1183089b2837SJed Brown {
1184089b2837SJed Brown   PetscErrorCode ierr;
1185089b2837SJed Brown   SNES           snes;
118624989b8cSPeter Brune   DM             dm;
1187089b2837SJed Brown 
1188089b2837SJed Brown   PetscFunctionBegin;
1189089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1190089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
11910298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
119224989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
119324989b8cSPeter Brune   ierr = DMTSGetIFunction(dm,func,ctx);CHKERRQ(ierr);
1194089b2837SJed Brown   PetscFunctionReturn(0);
1195089b2837SJed Brown }
1196089b2837SJed Brown 
1197089b2837SJed Brown #undef __FUNCT__
1198089b2837SJed Brown #define __FUNCT__ "TSGetRHSFunction"
1199089b2837SJed Brown /*@C
1200089b2837SJed Brown    TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1201089b2837SJed Brown 
1202089b2837SJed Brown    Not Collective
1203089b2837SJed Brown 
1204089b2837SJed Brown    Input Parameter:
1205089b2837SJed Brown .  ts - the TS context
1206089b2837SJed Brown 
1207089b2837SJed Brown    Output Parameter:
12080298fd71SBarry Smith +  r - vector to hold computed right hand side (or NULL)
12090298fd71SBarry Smith .  func - the function to compute right hand side (or NULL)
12100298fd71SBarry Smith -  ctx - the function context (or NULL)
1211089b2837SJed Brown 
1212089b2837SJed Brown    Level: advanced
1213089b2837SJed Brown 
1214089b2837SJed Brown .keywords: TS, nonlinear, get, function
1215089b2837SJed Brown 
12162bbac0d3SBarry Smith .seealso: TSSetRHSFunction(), SNESGetFunction()
1217089b2837SJed Brown @*/
1218089b2837SJed Brown PetscErrorCode TSGetRHSFunction(TS ts,Vec *r,TSRHSFunction *func,void **ctx)
1219089b2837SJed Brown {
1220089b2837SJed Brown   PetscErrorCode ierr;
1221089b2837SJed Brown   SNES           snes;
122224989b8cSPeter Brune   DM             dm;
1223089b2837SJed Brown 
1224089b2837SJed Brown   PetscFunctionBegin;
1225089b2837SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1226089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
12270298fd71SBarry Smith   ierr = SNESGetFunction(snes,r,NULL,NULL);CHKERRQ(ierr);
122824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
122924989b8cSPeter Brune   ierr = DMTSGetRHSFunction(dm,func,ctx);CHKERRQ(ierr);
1230316643e7SJed Brown   PetscFunctionReturn(0);
1231316643e7SJed Brown }
1232316643e7SJed Brown 
1233316643e7SJed Brown #undef __FUNCT__
1234316643e7SJed Brown #define __FUNCT__ "TSSetIJacobian"
1235316643e7SJed Brown /*@C
1236a4f0a591SBarry Smith    TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1237ae8867d6SBarry Smith         provided with TSSetIFunction().
1238316643e7SJed Brown 
12393f9fe445SBarry Smith    Logically Collective on TS
1240316643e7SJed Brown 
1241316643e7SJed Brown    Input Parameters:
1242316643e7SJed Brown +  ts  - the TS context obtained from TSCreate()
1243e5d3d808SBarry Smith .  Amat - (approximate) Jacobian matrix
1244e5d3d808SBarry Smith .  Pmat - matrix used to compute preconditioner (usually the same as Amat)
1245316643e7SJed Brown .  f   - the Jacobian evaluation routine
12460298fd71SBarry Smith -  ctx - user-defined context for private data for the Jacobian evaluation routine (may be NULL)
1247316643e7SJed Brown 
1248316643e7SJed Brown    Calling sequence of f:
1249ae8867d6SBarry Smith $  f(TS ts,PetscReal t,Vec U,Vec U_t,PetscReal a,Mat Amat,Mat Pmat,void *ctx);
1250316643e7SJed Brown 
1251316643e7SJed Brown +  t    - time at step/stage being solved
12521b4a444bSJed Brown .  U    - state vector
12531b4a444bSJed Brown .  U_t  - time derivative of state vector
1254316643e7SJed Brown .  a    - shift
1255e5d3d808SBarry Smith .  Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
1256e5d3d808SBarry Smith .  Pmat - matrix used for constructing preconditioner, usually the same as Amat
1257316643e7SJed Brown -  ctx  - [optional] user-defined context for matrix evaluation routine
1258316643e7SJed Brown 
1259316643e7SJed Brown    Notes:
1260e5d3d808SBarry Smith    The matrices Amat and Pmat are exactly the matrices that are used by SNES for the nonlinear solve.
1261316643e7SJed Brown 
1262895c21f2SBarry Smith    If you know the operator Amat has a null space you can use MatSetNullSpace() and MatSetTransposeNullSpace() to supply the null
1263895c21f2SBarry Smith    space to Amat and the KSP solvers will automatically use that null space as needed during the solution process.
1264895c21f2SBarry Smith 
1265a4f0a591SBarry Smith    The matrix dF/dU + a*dF/dU_t you provide turns out to be
1266b5abc632SBarry Smith    the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1267a4f0a591SBarry Smith    The time integrator internally approximates U_t by W+a*U where the positive "shift"
1268a4f0a591SBarry Smith    a and vector W depend on the integration method, step size, and past states. For example with
1269a4f0a591SBarry Smith    the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1270a4f0a591SBarry Smith    W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1271a4f0a591SBarry Smith 
1272ca5f011dSBarry Smith    Notes: The TS solver may modify the nonzero structure and the entries of the matrices Amat and Pmat between the calls to f()
1273ca5f011dSBarry Smith           You should not assume the values are the same in the next call to f() as you set them in the previous call.
1274ca5f011dSBarry Smith 
1275316643e7SJed Brown    Level: beginner
1276316643e7SJed Brown 
1277316643e7SJed Brown .keywords: TS, timestep, DAE, Jacobian
1278316643e7SJed Brown 
1279ae8867d6SBarry Smith .seealso: TSSetIFunction(), TSSetRHSJacobian(), SNESComputeJacobianDefaultColor(), SNESComputeJacobianDefault(), TSSetRHSFunction()
1280316643e7SJed Brown 
1281316643e7SJed Brown @*/
1282e5d3d808SBarry Smith PetscErrorCode  TSSetIJacobian(TS ts,Mat Amat,Mat Pmat,TSIJacobian f,void *ctx)
1283316643e7SJed Brown {
1284316643e7SJed Brown   PetscErrorCode ierr;
1285089b2837SJed Brown   SNES           snes;
128624989b8cSPeter Brune   DM             dm;
1287316643e7SJed Brown 
1288316643e7SJed Brown   PetscFunctionBegin;
12890700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1290e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
1291e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat,MAT_CLASSID,3);
1292e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts,1,Amat,2);
1293e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts,1,Pmat,3);
129424989b8cSPeter Brune 
129524989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
129624989b8cSPeter Brune   ierr = DMTSSetIJacobian(dm,f,ctx);CHKERRQ(ierr);
129724989b8cSPeter Brune 
1298089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1299e5d3d808SBarry Smith   ierr = SNESSetJacobian(snes,Amat,Pmat,SNESTSFormJacobian,ts);CHKERRQ(ierr);
1300316643e7SJed Brown   PetscFunctionReturn(0);
1301316643e7SJed Brown }
1302316643e7SJed Brown 
13034a2ae208SSatish Balay #undef __FUNCT__
1304e1244c69SJed Brown #define __FUNCT__ "TSRHSJacobianSetReuse"
1305e1244c69SJed Brown /*@
1306e1244c69SJed Brown    TSRHSJacobianSetReuse - restore RHS Jacobian before re-evaluating.  Without this flag, TS will change the sign and
1307e1244c69SJed Brown    shift the RHS Jacobian for a finite-time-step implicit solve, in which case the user function will need to recompute
1308e1244c69SJed Brown    the entire Jacobian.  The reuse flag must be set if the evaluation function will assume that the matrix entries have
1309e1244c69SJed Brown    not been changed by the TS.
1310e1244c69SJed Brown 
1311e1244c69SJed Brown    Logically Collective
1312e1244c69SJed Brown 
1313e1244c69SJed Brown    Input Arguments:
1314e1244c69SJed Brown +  ts - TS context obtained from TSCreate()
1315e1244c69SJed Brown -  reuse - PETSC_TRUE if the RHS Jacobian
1316e1244c69SJed Brown 
1317e1244c69SJed Brown    Level: intermediate
1318e1244c69SJed Brown 
1319e1244c69SJed Brown .seealso: TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
1320e1244c69SJed Brown @*/
1321e1244c69SJed Brown PetscErrorCode TSRHSJacobianSetReuse(TS ts,PetscBool reuse)
1322e1244c69SJed Brown {
1323e1244c69SJed Brown   PetscFunctionBegin;
1324e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
1325e1244c69SJed Brown   PetscFunctionReturn(0);
1326e1244c69SJed Brown }
1327e1244c69SJed Brown 
1328e1244c69SJed Brown #undef __FUNCT__
132955849f57SBarry Smith #define __FUNCT__ "TSLoad"
133055849f57SBarry Smith /*@C
133155849f57SBarry Smith   TSLoad - Loads a KSP that has been stored in binary  with KSPView().
133255849f57SBarry Smith 
133355849f57SBarry Smith   Collective on PetscViewer
133455849f57SBarry Smith 
133555849f57SBarry Smith   Input Parameters:
133655849f57SBarry Smith + newdm - the newly loaded TS, this needs to have been created with TSCreate() or
133755849f57SBarry Smith            some related function before a call to TSLoad().
133855849f57SBarry Smith - viewer - binary file viewer, obtained from PetscViewerBinaryOpen()
133955849f57SBarry Smith 
134055849f57SBarry Smith    Level: intermediate
134155849f57SBarry Smith 
134255849f57SBarry Smith   Notes:
134355849f57SBarry Smith    The type is determined by the data in the file, any type set into the TS before this call is ignored.
134455849f57SBarry Smith 
134555849f57SBarry Smith   Notes for advanced users:
134655849f57SBarry Smith   Most users should not need to know the details of the binary storage
134755849f57SBarry Smith   format, since TSLoad() and TSView() completely hide these details.
134855849f57SBarry Smith   But for anyone who's interested, the standard binary matrix storage
134955849f57SBarry Smith   format is
135055849f57SBarry Smith .vb
135155849f57SBarry Smith      has not yet been determined
135255849f57SBarry Smith .ve
135355849f57SBarry Smith 
135455849f57SBarry Smith .seealso: PetscViewerBinaryOpen(), TSView(), MatLoad(), VecLoad()
135555849f57SBarry Smith @*/
1356f2c2a1b9SBarry Smith PetscErrorCode  TSLoad(TS ts, PetscViewer viewer)
135755849f57SBarry Smith {
135855849f57SBarry Smith   PetscErrorCode ierr;
135955849f57SBarry Smith   PetscBool      isbinary;
136055849f57SBarry Smith   PetscInt       classid;
136155849f57SBarry Smith   char           type[256];
13622d53ad75SBarry Smith   DMTS           sdm;
1363ad6bc421SBarry Smith   DM             dm;
136455849f57SBarry Smith 
136555849f57SBarry Smith   PetscFunctionBegin;
1366f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
136755849f57SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
136855849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
136955849f57SBarry Smith   if (!isbinary) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Invalid viewer; open viewer with PetscViewerBinaryOpen()");
137055849f57SBarry Smith 
1371060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,&classid,1,NULL,PETSC_INT);CHKERRQ(ierr);
1372ce94432eSBarry Smith   if (classid != TS_FILE_CLASSID) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_WRONG,"Not TS next in file");
1373060da220SMatthew G. Knepley   ierr = PetscViewerBinaryRead(viewer,type,256,NULL,PETSC_CHAR);CHKERRQ(ierr);
1374f2c2a1b9SBarry Smith   ierr = TSSetType(ts, type);CHKERRQ(ierr);
1375f2c2a1b9SBarry Smith   if (ts->ops->load) {
1376f2c2a1b9SBarry Smith     ierr = (*ts->ops->load)(ts,viewer);CHKERRQ(ierr);
1377f2c2a1b9SBarry Smith   }
1378ce94432eSBarry Smith   ierr = DMCreate(PetscObjectComm((PetscObject)ts),&dm);CHKERRQ(ierr);
1379ad6bc421SBarry Smith   ierr = DMLoad(dm,viewer);CHKERRQ(ierr);
1380ad6bc421SBarry Smith   ierr = TSSetDM(ts,dm);CHKERRQ(ierr);
1381f2c2a1b9SBarry Smith   ierr = DMCreateGlobalVector(ts->dm,&ts->vec_sol);CHKERRQ(ierr);
1382f2c2a1b9SBarry Smith   ierr = VecLoad(ts->vec_sol,viewer);CHKERRQ(ierr);
13832d53ad75SBarry Smith   ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
13842d53ad75SBarry Smith   ierr = DMTSLoad(sdm,viewer);CHKERRQ(ierr);
138555849f57SBarry Smith   PetscFunctionReturn(0);
138655849f57SBarry Smith }
138755849f57SBarry Smith 
13889804daf3SBarry Smith #include <petscdraw.h>
1389e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1390e04113cfSBarry Smith #include <petscviewersaws.h>
1391f05ece33SBarry Smith #endif
139255849f57SBarry Smith #undef __FUNCT__
13934a2ae208SSatish Balay #define __FUNCT__ "TSView"
13947e2c5f70SBarry Smith /*@C
1395d763cef2SBarry Smith     TSView - Prints the TS data structure.
1396d763cef2SBarry Smith 
13974c49b128SBarry Smith     Collective on TS
1398d763cef2SBarry Smith 
1399d763cef2SBarry Smith     Input Parameters:
1400d763cef2SBarry Smith +   ts - the TS context obtained from TSCreate()
1401d763cef2SBarry Smith -   viewer - visualization context
1402d763cef2SBarry Smith 
1403d763cef2SBarry Smith     Options Database Key:
1404d763cef2SBarry Smith .   -ts_view - calls TSView() at end of TSStep()
1405d763cef2SBarry Smith 
1406d763cef2SBarry Smith     Notes:
1407d763cef2SBarry Smith     The available visualization contexts include
1408b0a32e0cSBarry Smith +     PETSC_VIEWER_STDOUT_SELF - standard output (default)
1409b0a32e0cSBarry Smith -     PETSC_VIEWER_STDOUT_WORLD - synchronized standard
1410d763cef2SBarry Smith          output where only the first processor opens
1411d763cef2SBarry Smith          the file.  All other processors send their
1412d763cef2SBarry Smith          data to the first processor to print.
1413d763cef2SBarry Smith 
1414d763cef2SBarry Smith     The user can open an alternative visualization context with
1415b0a32e0cSBarry Smith     PetscViewerASCIIOpen() - output to a specified file.
1416d763cef2SBarry Smith 
1417d763cef2SBarry Smith     Level: beginner
1418d763cef2SBarry Smith 
1419d763cef2SBarry Smith .keywords: TS, timestep, view
1420d763cef2SBarry Smith 
1421b0a32e0cSBarry Smith .seealso: PetscViewerASCIIOpen()
1422d763cef2SBarry Smith @*/
14237087cfbeSBarry Smith PetscErrorCode  TSView(TS ts,PetscViewer viewer)
1424d763cef2SBarry Smith {
1425dfbe8321SBarry Smith   PetscErrorCode ierr;
142619fd82e9SBarry Smith   TSType         type;
14272b0a91c0SBarry Smith   PetscBool      iascii,isstring,isundials,isbinary,isdraw;
14282d53ad75SBarry Smith   DMTS           sdm;
1429e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1430536b137fSBarry Smith   PetscBool      issaws;
1431f05ece33SBarry Smith #endif
1432d763cef2SBarry Smith 
1433d763cef2SBarry Smith   PetscFunctionBegin;
14340700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
14353050cee2SBarry Smith   if (!viewer) {
1436ce94432eSBarry Smith     ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts),&viewer);CHKERRQ(ierr);
14373050cee2SBarry Smith   }
14380700a824SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
1439c9780b6fSBarry Smith   PetscCheckSameComm(ts,1,viewer,2);
1440fd16b177SBarry Smith 
1441251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
1442251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSTRING,&isstring);CHKERRQ(ierr);
144355849f57SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERBINARY,&isbinary);CHKERRQ(ierr);
14442b0a91c0SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERDRAW,&isdraw);CHKERRQ(ierr);
1445e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1446536b137fSBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERSAWS,&issaws);CHKERRQ(ierr);
1447f05ece33SBarry Smith #endif
144832077d6dSBarry Smith   if (iascii) {
1449dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)ts,viewer);CHKERRQ(ierr);
145077431f27SBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum steps=%D\n",ts->max_steps);CHKERRQ(ierr);
14517c8652ddSBarry Smith     ierr = PetscViewerASCIIPrintf(viewer,"  maximum time=%g\n",(double)ts->max_time);CHKERRQ(ierr);
1452d763cef2SBarry Smith     if (ts->problem_type == TS_NONLINEAR) {
14535ef26d82SJed Brown       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solver iterations=%D\n",ts->snes_its);CHKERRQ(ierr);
1454c610991cSLisandro Dalcin       ierr = PetscViewerASCIIPrintf(viewer,"  total number of nonlinear solve failures=%D\n",ts->num_snes_failures);CHKERRQ(ierr);
1455d763cef2SBarry Smith     }
14565ef26d82SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of linear solver iterations=%D\n",ts->ksp_its);CHKERRQ(ierr);
1457193ac0bcSJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  total number of rejected steps=%D\n",ts->reject);CHKERRQ(ierr);
14582d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14592d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
1460d52bd9f3SBarry Smith     if (ts->ops->view) {
1461d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1462d52bd9f3SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
1463d52bd9f3SBarry Smith       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1464d52bd9f3SBarry Smith     }
14650f5bd95cSBarry Smith   } else if (isstring) {
1466a313700dSBarry Smith     ierr = TSGetType(ts,&type);CHKERRQ(ierr);
1467b0a32e0cSBarry Smith     ierr = PetscViewerStringSPrintf(viewer," %-7.7s",type);CHKERRQ(ierr);
146855849f57SBarry Smith   } else if (isbinary) {
146955849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
147055849f57SBarry Smith     MPI_Comm    comm;
147155849f57SBarry Smith     PetscMPIInt rank;
147255849f57SBarry Smith     char        type[256];
147355849f57SBarry Smith 
147455849f57SBarry Smith     ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
147555849f57SBarry Smith     ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
147655849f57SBarry Smith     if (!rank) {
147755849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,&classid,1,PETSC_INT,PETSC_FALSE);CHKERRQ(ierr);
147855849f57SBarry Smith       ierr = PetscStrncpy(type,((PetscObject)ts)->type_name,256);CHKERRQ(ierr);
147955849f57SBarry Smith       ierr = PetscViewerBinaryWrite(viewer,type,256,PETSC_CHAR,PETSC_FALSE);CHKERRQ(ierr);
148055849f57SBarry Smith     }
148155849f57SBarry Smith     if (ts->ops->view) {
148255849f57SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
148355849f57SBarry Smith     }
1484f2c2a1b9SBarry Smith     ierr = DMView(ts->dm,viewer);CHKERRQ(ierr);
1485f2c2a1b9SBarry Smith     ierr = VecView(ts->vec_sol,viewer);CHKERRQ(ierr);
14862d53ad75SBarry Smith     ierr = DMGetDMTS(ts->dm,&sdm);CHKERRQ(ierr);
14872d53ad75SBarry Smith     ierr = DMTSView(sdm,viewer);CHKERRQ(ierr);
14882b0a91c0SBarry Smith   } else if (isdraw) {
14892b0a91c0SBarry Smith     PetscDraw draw;
14902b0a91c0SBarry Smith     char      str[36];
149189fd9fafSBarry Smith     PetscReal x,y,bottom,h;
14922b0a91c0SBarry Smith 
14932b0a91c0SBarry Smith     ierr   = PetscViewerDrawGetDraw(viewer,0,&draw);CHKERRQ(ierr);
14942b0a91c0SBarry Smith     ierr   = PetscDrawGetCurrentPoint(draw,&x,&y);CHKERRQ(ierr);
14952b0a91c0SBarry Smith     ierr   = PetscStrcpy(str,"TS: ");CHKERRQ(ierr);
14962b0a91c0SBarry Smith     ierr   = PetscStrcat(str,((PetscObject)ts)->type_name);CHKERRQ(ierr);
149751fa3d41SBarry Smith     ierr   = PetscDrawStringBoxed(draw,x,y,PETSC_DRAW_BLACK,PETSC_DRAW_BLACK,str,NULL,&h);CHKERRQ(ierr);
149889fd9fafSBarry Smith     bottom = y - h;
14992b0a91c0SBarry Smith     ierr   = PetscDrawPushCurrentPoint(draw,x,bottom);CHKERRQ(ierr);
15002b0a91c0SBarry Smith     if (ts->ops->view) {
15012b0a91c0SBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
15022b0a91c0SBarry Smith     }
15032b0a91c0SBarry Smith     ierr = PetscDrawPopCurrentPoint(draw);CHKERRQ(ierr);
1504e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1505536b137fSBarry Smith   } else if (issaws) {
1506d45a07a7SBarry Smith     PetscMPIInt rank;
15072657e9d9SBarry Smith     const char  *name;
15082657e9d9SBarry Smith 
15092657e9d9SBarry Smith     ierr = PetscObjectGetName((PetscObject)ts,&name);CHKERRQ(ierr);
1510d45a07a7SBarry Smith     ierr = MPI_Comm_rank(PETSC_COMM_WORLD,&rank);CHKERRQ(ierr);
1511d45a07a7SBarry Smith     if (!((PetscObject)ts)->amsmem && !rank) {
1512d45a07a7SBarry Smith       char       dir[1024];
1513d45a07a7SBarry Smith 
1514e04113cfSBarry Smith       ierr = PetscObjectViewSAWs((PetscObject)ts,viewer);CHKERRQ(ierr);
1515a0931e03SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time_step",name);CHKERRQ(ierr);
15162657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->steps,1,SAWs_READ,SAWs_INT));
15172657e9d9SBarry Smith       ierr = PetscSNPrintf(dir,1024,"/PETSc/Objects/%s/time",name);CHKERRQ(ierr);
15182657e9d9SBarry Smith       PetscStackCallSAWs(SAWs_Register,(dir,&ts->ptime,1,SAWs_READ,SAWs_DOUBLE));
1519d763cef2SBarry Smith     }
15200acecf5bSBarry Smith     if (ts->ops->view) {
15210acecf5bSBarry Smith       ierr = (*ts->ops->view)(ts,viewer);CHKERRQ(ierr);
15220acecf5bSBarry Smith     }
1523f05ece33SBarry Smith #endif
1524f05ece33SBarry Smith   }
1525f05ece33SBarry Smith 
1526b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
1527251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)ts,TSSUNDIALS,&isundials);CHKERRQ(ierr);
1528b0a32e0cSBarry Smith   ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
1529d763cef2SBarry Smith   PetscFunctionReturn(0);
1530d763cef2SBarry Smith }
1531d763cef2SBarry Smith 
1532d763cef2SBarry Smith 
15334a2ae208SSatish Balay #undef __FUNCT__
15344a2ae208SSatish Balay #define __FUNCT__ "TSSetApplicationContext"
1535b07ff414SBarry Smith /*@
1536d763cef2SBarry Smith    TSSetApplicationContext - Sets an optional user-defined context for
1537d763cef2SBarry Smith    the timesteppers.
1538d763cef2SBarry Smith 
15393f9fe445SBarry Smith    Logically Collective on TS
1540d763cef2SBarry Smith 
1541d763cef2SBarry Smith    Input Parameters:
1542d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1543d763cef2SBarry Smith -  usrP - optional user context
1544d763cef2SBarry Smith 
1545daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1546daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1547daf670e6SBarry Smith 
1548d763cef2SBarry Smith    Level: intermediate
1549d763cef2SBarry Smith 
1550d763cef2SBarry Smith .keywords: TS, timestep, set, application, context
1551d763cef2SBarry Smith 
1552d763cef2SBarry Smith .seealso: TSGetApplicationContext()
1553d763cef2SBarry Smith @*/
15547087cfbeSBarry Smith PetscErrorCode  TSSetApplicationContext(TS ts,void *usrP)
1555d763cef2SBarry Smith {
1556d763cef2SBarry Smith   PetscFunctionBegin;
15570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1558d763cef2SBarry Smith   ts->user = usrP;
1559d763cef2SBarry Smith   PetscFunctionReturn(0);
1560d763cef2SBarry Smith }
1561d763cef2SBarry Smith 
15624a2ae208SSatish Balay #undef __FUNCT__
15634a2ae208SSatish Balay #define __FUNCT__ "TSGetApplicationContext"
1564b07ff414SBarry Smith /*@
1565d763cef2SBarry Smith     TSGetApplicationContext - Gets the user-defined context for the
1566d763cef2SBarry Smith     timestepper.
1567d763cef2SBarry Smith 
1568d763cef2SBarry Smith     Not Collective
1569d763cef2SBarry Smith 
1570d763cef2SBarry Smith     Input Parameter:
1571d763cef2SBarry Smith .   ts - the TS context obtained from TSCreate()
1572d763cef2SBarry Smith 
1573d763cef2SBarry Smith     Output Parameter:
1574d763cef2SBarry Smith .   usrP - user context
1575d763cef2SBarry Smith 
1576daf670e6SBarry Smith    Fortran Notes: To use this from Fortran you must write a Fortran interface definition for this
1577daf670e6SBarry Smith     function that tells Fortran the Fortran derived data type that you are passing in as the ctx argument.
1578daf670e6SBarry Smith 
1579d763cef2SBarry Smith     Level: intermediate
1580d763cef2SBarry Smith 
1581d763cef2SBarry Smith .keywords: TS, timestep, get, application, context
1582d763cef2SBarry Smith 
1583d763cef2SBarry Smith .seealso: TSSetApplicationContext()
1584d763cef2SBarry Smith @*/
1585e71120c6SJed Brown PetscErrorCode  TSGetApplicationContext(TS ts,void *usrP)
1586d763cef2SBarry Smith {
1587d763cef2SBarry Smith   PetscFunctionBegin;
15880700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1589e71120c6SJed Brown   *(void**)usrP = ts->user;
1590d763cef2SBarry Smith   PetscFunctionReturn(0);
1591d763cef2SBarry Smith }
1592d763cef2SBarry Smith 
15934a2ae208SSatish Balay #undef __FUNCT__
15944a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStepNumber"
1595d763cef2SBarry Smith /*@
1596b8123daeSJed Brown    TSGetTimeStepNumber - Gets the number of time steps completed.
1597d763cef2SBarry Smith 
1598d763cef2SBarry Smith    Not Collective
1599d763cef2SBarry Smith 
1600d763cef2SBarry Smith    Input Parameter:
1601d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1602d763cef2SBarry Smith 
1603d763cef2SBarry Smith    Output Parameter:
1604b8123daeSJed Brown .  iter - number of steps completed so far
1605d763cef2SBarry Smith 
1606d763cef2SBarry Smith    Level: intermediate
1607d763cef2SBarry Smith 
1608d763cef2SBarry Smith .keywords: TS, timestep, get, iteration, number
16099be3e283SDebojyoti Ghosh .seealso: TSGetTime(), TSGetTimeStep(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSSetPostStep()
1610d763cef2SBarry Smith @*/
16117087cfbeSBarry Smith PetscErrorCode  TSGetTimeStepNumber(TS ts,PetscInt *iter)
1612d763cef2SBarry Smith {
1613d763cef2SBarry Smith   PetscFunctionBegin;
16140700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
16154482741eSBarry Smith   PetscValidIntPointer(iter,2);
1616d763cef2SBarry Smith   *iter = ts->steps;
1617d763cef2SBarry Smith   PetscFunctionReturn(0);
1618d763cef2SBarry Smith }
1619d763cef2SBarry Smith 
16204a2ae208SSatish Balay #undef __FUNCT__
16214a2ae208SSatish Balay #define __FUNCT__ "TSSetInitialTimeStep"
1622d763cef2SBarry Smith /*@
1623d763cef2SBarry Smith    TSSetInitialTimeStep - Sets the initial timestep to be used,
1624d763cef2SBarry Smith    as well as the initial time.
1625d763cef2SBarry Smith 
16263f9fe445SBarry Smith    Logically Collective on TS
1627d763cef2SBarry Smith 
1628d763cef2SBarry Smith    Input Parameters:
1629d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1630d763cef2SBarry Smith .  initial_time - the initial time
1631d763cef2SBarry Smith -  time_step - the size of the timestep
1632d763cef2SBarry Smith 
1633d763cef2SBarry Smith    Level: intermediate
1634d763cef2SBarry Smith 
1635d763cef2SBarry Smith .seealso: TSSetTimeStep(), TSGetTimeStep()
1636d763cef2SBarry Smith 
1637d763cef2SBarry Smith .keywords: TS, set, initial, timestep
1638d763cef2SBarry Smith @*/
16397087cfbeSBarry Smith PetscErrorCode  TSSetInitialTimeStep(TS ts,PetscReal initial_time,PetscReal time_step)
1640d763cef2SBarry Smith {
1641e144a568SJed Brown   PetscErrorCode ierr;
1642e144a568SJed Brown 
1643d763cef2SBarry Smith   PetscFunctionBegin;
16440700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1645e144a568SJed Brown   ierr = TSSetTimeStep(ts,time_step);CHKERRQ(ierr);
1646d8cd7023SBarry Smith   ierr = TSSetTime(ts,initial_time);CHKERRQ(ierr);
1647d763cef2SBarry Smith   PetscFunctionReturn(0);
1648d763cef2SBarry Smith }
1649d763cef2SBarry Smith 
16504a2ae208SSatish Balay #undef __FUNCT__
16514a2ae208SSatish Balay #define __FUNCT__ "TSSetTimeStep"
1652d763cef2SBarry Smith /*@
1653d763cef2SBarry Smith    TSSetTimeStep - Allows one to reset the timestep at any time,
1654d763cef2SBarry Smith    useful for simple pseudo-timestepping codes.
1655d763cef2SBarry Smith 
16563f9fe445SBarry Smith    Logically Collective on TS
1657d763cef2SBarry Smith 
1658d763cef2SBarry Smith    Input Parameters:
1659d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
1660d763cef2SBarry Smith -  time_step - the size of the timestep
1661d763cef2SBarry Smith 
1662d763cef2SBarry Smith    Level: intermediate
1663d763cef2SBarry Smith 
1664d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1665d763cef2SBarry Smith 
1666d763cef2SBarry Smith .keywords: TS, set, timestep
1667d763cef2SBarry Smith @*/
16687087cfbeSBarry Smith PetscErrorCode  TSSetTimeStep(TS ts,PetscReal time_step)
1669d763cef2SBarry Smith {
1670d763cef2SBarry Smith   PetscFunctionBegin;
16710700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1672c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,time_step,2);
1673d763cef2SBarry Smith   ts->time_step      = time_step;
167431748224SBarry Smith   ts->time_step_orig = time_step;
1675d763cef2SBarry Smith   PetscFunctionReturn(0);
1676d763cef2SBarry Smith }
1677d763cef2SBarry Smith 
16784a2ae208SSatish Balay #undef __FUNCT__
1679a43b19c4SJed Brown #define __FUNCT__ "TSSetExactFinalTime"
1680a43b19c4SJed Brown /*@
168149354f04SShri Abhyankar    TSSetExactFinalTime - Determines whether to adapt the final time step to
168249354f04SShri Abhyankar      match the exact final time, interpolate solution to the exact final time,
168349354f04SShri Abhyankar      or just return at the final time TS computed.
1684a43b19c4SJed Brown 
1685a43b19c4SJed Brown   Logically Collective on TS
1686a43b19c4SJed Brown 
1687a43b19c4SJed Brown    Input Parameter:
1688a43b19c4SJed Brown +   ts - the time-step context
168949354f04SShri Abhyankar -   eftopt - exact final time option
1690a43b19c4SJed Brown 
1691a43b19c4SJed Brown    Level: beginner
1692a43b19c4SJed Brown 
1693a2ea699eSBarry Smith .seealso: TSExactFinalTimeOption
1694a43b19c4SJed Brown @*/
169549354f04SShri Abhyankar PetscErrorCode  TSSetExactFinalTime(TS ts,TSExactFinalTimeOption eftopt)
1696a43b19c4SJed Brown {
1697a43b19c4SJed Brown   PetscFunctionBegin;
1698a43b19c4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
169949354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts,eftopt,2);
170049354f04SShri Abhyankar   ts->exact_final_time = eftopt;
1701a43b19c4SJed Brown   PetscFunctionReturn(0);
1702a43b19c4SJed Brown }
1703a43b19c4SJed Brown 
1704a43b19c4SJed Brown #undef __FUNCT__
17054a2ae208SSatish Balay #define __FUNCT__ "TSGetTimeStep"
1706d763cef2SBarry Smith /*@
1707d763cef2SBarry Smith    TSGetTimeStep - Gets the current timestep size.
1708d763cef2SBarry Smith 
1709d763cef2SBarry Smith    Not Collective
1710d763cef2SBarry Smith 
1711d763cef2SBarry Smith    Input Parameter:
1712d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1713d763cef2SBarry Smith 
1714d763cef2SBarry Smith    Output Parameter:
1715d763cef2SBarry Smith .  dt - the current timestep size
1716d763cef2SBarry Smith 
1717d763cef2SBarry Smith    Level: intermediate
1718d763cef2SBarry Smith 
1719d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
1720d763cef2SBarry Smith 
1721d763cef2SBarry Smith .keywords: TS, get, timestep
1722d763cef2SBarry Smith @*/
17237087cfbeSBarry Smith PetscErrorCode  TSGetTimeStep(TS ts,PetscReal *dt)
1724d763cef2SBarry Smith {
1725d763cef2SBarry Smith   PetscFunctionBegin;
17260700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1727f7cf8827SBarry Smith   PetscValidRealPointer(dt,2);
1728d763cef2SBarry Smith   *dt = ts->time_step;
1729d763cef2SBarry Smith   PetscFunctionReturn(0);
1730d763cef2SBarry Smith }
1731d763cef2SBarry Smith 
17324a2ae208SSatish Balay #undef __FUNCT__
17334a2ae208SSatish Balay #define __FUNCT__ "TSGetSolution"
1734d8e5e3e6SSatish Balay /*@
1735d763cef2SBarry Smith    TSGetSolution - Returns the solution at the present timestep. It
1736d763cef2SBarry Smith    is valid to call this routine inside the function that you are evaluating
1737d763cef2SBarry Smith    in order to move to the new timestep. This vector not changed until
1738d763cef2SBarry Smith    the solution at the next timestep has been calculated.
1739d763cef2SBarry Smith 
1740d763cef2SBarry Smith    Not Collective, but Vec returned is parallel if TS is parallel
1741d763cef2SBarry Smith 
1742d763cef2SBarry Smith    Input Parameter:
1743d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1744d763cef2SBarry Smith 
1745d763cef2SBarry Smith    Output Parameter:
1746d763cef2SBarry Smith .  v - the vector containing the solution
1747d763cef2SBarry Smith 
1748d763cef2SBarry Smith    Level: intermediate
1749d763cef2SBarry Smith 
1750d763cef2SBarry Smith .seealso: TSGetTimeStep()
1751d763cef2SBarry Smith 
1752d763cef2SBarry Smith .keywords: TS, timestep, get, solution
1753d763cef2SBarry Smith @*/
17547087cfbeSBarry Smith PetscErrorCode  TSGetSolution(TS ts,Vec *v)
1755d763cef2SBarry Smith {
1756d763cef2SBarry Smith   PetscFunctionBegin;
17570700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
17584482741eSBarry Smith   PetscValidPointer(v,2);
17598737fe31SLisandro Dalcin   *v = ts->vec_sol;
1760d763cef2SBarry Smith   PetscFunctionReturn(0);
1761d763cef2SBarry Smith }
1762d763cef2SBarry Smith 
1763c235aa8dSHong Zhang #undef __FUNCT__
1764dfb21088SHong Zhang #define __FUNCT__ "TSGetCostGradients"
1765c235aa8dSHong Zhang /*@
1766dfb21088SHong Zhang    TSGetCostGradients - Returns the gradients from the TSAdjointSolve()
1767c235aa8dSHong Zhang 
1768c235aa8dSHong Zhang    Not Collective, but Vec returned is parallel if TS is parallel
1769c235aa8dSHong Zhang 
1770c235aa8dSHong Zhang    Input Parameter:
1771c235aa8dSHong Zhang .  ts - the TS context obtained from TSCreate()
1772c235aa8dSHong Zhang 
1773c235aa8dSHong Zhang    Output Parameter:
1774abc2977eSBarry Smith +  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
1775abc2977eSBarry Smith -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
1776c235aa8dSHong Zhang 
1777c235aa8dSHong Zhang    Level: intermediate
1778c235aa8dSHong Zhang 
1779c235aa8dSHong Zhang .seealso: TSGetTimeStep()
1780c235aa8dSHong Zhang 
1781c235aa8dSHong Zhang .keywords: TS, timestep, get, sensitivity
1782c235aa8dSHong Zhang @*/
1783dfb21088SHong Zhang PetscErrorCode  TSGetCostGradients(TS ts,PetscInt *numcost,Vec **lambda,Vec **mu)
1784c235aa8dSHong Zhang {
1785c235aa8dSHong Zhang   PetscFunctionBegin;
1786c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1787abc2977eSBarry Smith   if (numcost) *numcost = ts->numcost;
1788abc2977eSBarry Smith   if (lambda)  *lambda  = ts->vecs_sensi;
1789abc2977eSBarry Smith   if (mu)      *mu      = ts->vecs_sensip;
1790c235aa8dSHong Zhang   PetscFunctionReturn(0);
1791c235aa8dSHong Zhang }
1792c235aa8dSHong Zhang 
1793bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
17944a2ae208SSatish Balay #undef __FUNCT__
1795bdad233fSMatthew Knepley #define __FUNCT__ "TSSetProblemType"
1796d8e5e3e6SSatish Balay /*@
1797bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
1798d763cef2SBarry Smith 
1799bdad233fSMatthew Knepley   Not collective
1800d763cef2SBarry Smith 
1801bdad233fSMatthew Knepley   Input Parameters:
1802bdad233fSMatthew Knepley + ts   - The TS
1803bdad233fSMatthew Knepley - type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1804d763cef2SBarry Smith .vb
18050910c330SBarry Smith          U_t - A U = 0      (linear)
18060910c330SBarry Smith          U_t - A(t) U = 0   (linear)
18070910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
1808d763cef2SBarry Smith .ve
1809d763cef2SBarry Smith 
1810d763cef2SBarry Smith    Level: beginner
1811d763cef2SBarry Smith 
1812bdad233fSMatthew Knepley .keywords: TS, problem type
1813bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1814d763cef2SBarry Smith @*/
18157087cfbeSBarry Smith PetscErrorCode  TSSetProblemType(TS ts, TSProblemType type)
1816a7cc72afSBarry Smith {
18179e2a6581SJed Brown   PetscErrorCode ierr;
18189e2a6581SJed Brown 
1819d763cef2SBarry Smith   PetscFunctionBegin;
18200700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
1821bdad233fSMatthew Knepley   ts->problem_type = type;
18229e2a6581SJed Brown   if (type == TS_LINEAR) {
18239e2a6581SJed Brown     SNES snes;
18249e2a6581SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
18259e2a6581SJed Brown     ierr = SNESSetType(snes,SNESKSPONLY);CHKERRQ(ierr);
18269e2a6581SJed Brown   }
1827d763cef2SBarry Smith   PetscFunctionReturn(0);
1828d763cef2SBarry Smith }
1829d763cef2SBarry Smith 
1830bdad233fSMatthew Knepley #undef __FUNCT__
1831bdad233fSMatthew Knepley #define __FUNCT__ "TSGetProblemType"
1832bdad233fSMatthew Knepley /*@C
1833bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
1834bdad233fSMatthew Knepley 
1835bdad233fSMatthew Knepley   Not collective
1836bdad233fSMatthew Knepley 
1837bdad233fSMatthew Knepley   Input Parameter:
1838bdad233fSMatthew Knepley . ts   - The TS
1839bdad233fSMatthew Knepley 
1840bdad233fSMatthew Knepley   Output Parameter:
1841bdad233fSMatthew Knepley . type - One of TS_LINEAR, TS_NONLINEAR where these types refer to problems of the forms
1842bdad233fSMatthew Knepley .vb
1843089b2837SJed Brown          M U_t = A U
1844089b2837SJed Brown          M(t) U_t = A(t) U
1845b5abc632SBarry Smith          F(t,U,U_t)
1846bdad233fSMatthew Knepley .ve
1847bdad233fSMatthew Knepley 
1848bdad233fSMatthew Knepley    Level: beginner
1849bdad233fSMatthew Knepley 
1850bdad233fSMatthew Knepley .keywords: TS, problem type
1851bdad233fSMatthew Knepley .seealso: TSSetUp(), TSProblemType, TS
1852bdad233fSMatthew Knepley @*/
18537087cfbeSBarry Smith PetscErrorCode  TSGetProblemType(TS ts, TSProblemType *type)
1854a7cc72afSBarry Smith {
1855bdad233fSMatthew Knepley   PetscFunctionBegin;
18560700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
18574482741eSBarry Smith   PetscValidIntPointer(type,2);
1858bdad233fSMatthew Knepley   *type = ts->problem_type;
1859bdad233fSMatthew Knepley   PetscFunctionReturn(0);
1860bdad233fSMatthew Knepley }
1861d763cef2SBarry Smith 
18624a2ae208SSatish Balay #undef __FUNCT__
18634a2ae208SSatish Balay #define __FUNCT__ "TSSetUp"
1864d763cef2SBarry Smith /*@
1865d763cef2SBarry Smith    TSSetUp - Sets up the internal data structures for the later use
1866d763cef2SBarry Smith    of a timestepper.
1867d763cef2SBarry Smith 
1868d763cef2SBarry Smith    Collective on TS
1869d763cef2SBarry Smith 
1870d763cef2SBarry Smith    Input Parameter:
1871d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
1872d763cef2SBarry Smith 
1873d763cef2SBarry Smith    Notes:
1874d763cef2SBarry Smith    For basic use of the TS solvers the user need not explicitly call
1875d763cef2SBarry Smith    TSSetUp(), since these actions will automatically occur during
1876d763cef2SBarry Smith    the call to TSStep().  However, if one wishes to control this
1877d763cef2SBarry Smith    phase separately, TSSetUp() should be called after TSCreate()
1878d763cef2SBarry Smith    and optional routines of the form TSSetXXX(), but before TSStep().
1879d763cef2SBarry Smith 
1880d763cef2SBarry Smith    Level: advanced
1881d763cef2SBarry Smith 
1882d763cef2SBarry Smith .keywords: TS, timestep, setup
1883d763cef2SBarry Smith 
1884d763cef2SBarry Smith .seealso: TSCreate(), TSStep(), TSDestroy()
1885d763cef2SBarry Smith @*/
18867087cfbeSBarry Smith PetscErrorCode  TSSetUp(TS ts)
1887d763cef2SBarry Smith {
1888dfbe8321SBarry Smith   PetscErrorCode ierr;
18896c6b9e74SPeter Brune   DM             dm;
18906c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES,Vec,Vec,void*);
1891d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES,Vec,Mat,Mat,void*);
18926c6b9e74SPeter Brune   TSIJacobian    ijac;
18936c6b9e74SPeter Brune   TSRHSJacobian  rhsjac;
1894d763cef2SBarry Smith 
1895d763cef2SBarry Smith   PetscFunctionBegin;
18960700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1897277b19d0SLisandro Dalcin   if (ts->setupcalled) PetscFunctionReturn(0);
1898277b19d0SLisandro Dalcin 
18992c18e0fdSBarry Smith   ts->total_steps = 0;
19007adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
19019596e0b4SJed Brown     ierr = TSSetType(ts,TSEULER);CHKERRQ(ierr);
1902d763cef2SBarry Smith   }
1903277b19d0SLisandro Dalcin 
1904277b19d0SLisandro Dalcin   if (!ts->vec_sol) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetSolution() first");
1905277b19d0SLisandro Dalcin 
19061c3436cfSJed Brown 
1907552698daSJed Brown   ierr = TSGetAdapt(ts,&ts->adapt);CHKERRQ(ierr);
1908277b19d0SLisandro Dalcin 
1909e1244c69SJed Brown   if (ts->rhsjacobian.reuse) {
1910e1244c69SJed Brown     Mat Amat,Pmat;
1911e1244c69SJed Brown     SNES snes;
1912e1244c69SJed Brown     ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
1913e1244c69SJed Brown     ierr = SNESGetJacobian(snes,&Amat,&Pmat,NULL,NULL);CHKERRQ(ierr);
1914e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
1915e1244c69SJed Brown      * have displaced the RHS matrix */
1916e1244c69SJed Brown     if (Amat == ts->Arhs) {
1917e1244c69SJed Brown       ierr = MatDuplicate(ts->Arhs,MAT_DO_NOT_COPY_VALUES,&Amat);CHKERRQ(ierr);
1918e1244c69SJed Brown       ierr = SNESSetJacobian(snes,Amat,NULL,NULL,NULL);CHKERRQ(ierr);
1919e1244c69SJed Brown       ierr = MatDestroy(&Amat);CHKERRQ(ierr);
1920e1244c69SJed Brown     }
1921e1244c69SJed Brown     if (Pmat == ts->Brhs) {
1922e1244c69SJed Brown       ierr = MatDuplicate(ts->Brhs,MAT_DO_NOT_COPY_VALUES,&Pmat);CHKERRQ(ierr);
1923e1244c69SJed Brown       ierr = SNESSetJacobian(snes,NULL,Pmat,NULL,NULL);CHKERRQ(ierr);
1924e1244c69SJed Brown       ierr = MatDestroy(&Pmat);CHKERRQ(ierr);
1925e1244c69SJed Brown     }
1926e1244c69SJed Brown   }
1927277b19d0SLisandro Dalcin   if (ts->ops->setup) {
1928000e7ae3SMatthew Knepley     ierr = (*ts->ops->setup)(ts);CHKERRQ(ierr);
1929277b19d0SLisandro Dalcin   }
1930277b19d0SLisandro Dalcin 
19316c6b9e74SPeter Brune   /* in the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
19326c6b9e74SPeter Brune    to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
19336c6b9e74SPeter Brune    */
19346c6b9e74SPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
19350298fd71SBarry Smith   ierr = DMSNESGetFunction(dm,&func,NULL);CHKERRQ(ierr);
19366c6b9e74SPeter Brune   if (!func) {
19376c6b9e74SPeter Brune     ierr =DMSNESSetFunction(dm,SNESTSFormFunction,ts);CHKERRQ(ierr);
19386c6b9e74SPeter Brune   }
19396c6b9e74SPeter 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.
19406c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
19416c6b9e74SPeter Brune    */
19420298fd71SBarry Smith   ierr = DMSNESGetJacobian(dm,&jac,NULL);CHKERRQ(ierr);
19430298fd71SBarry Smith   ierr = DMTSGetIJacobian(dm,&ijac,NULL);CHKERRQ(ierr);
19440298fd71SBarry Smith   ierr = DMTSGetRHSJacobian(dm,&rhsjac,NULL);CHKERRQ(ierr);
19456c6b9e74SPeter Brune   if (!jac && (ijac || rhsjac)) {
19466c6b9e74SPeter Brune     ierr = DMSNESSetJacobian(dm,SNESTSFormJacobian,ts);CHKERRQ(ierr);
19476c6b9e74SPeter Brune   }
1948277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
1949277b19d0SLisandro Dalcin   PetscFunctionReturn(0);
1950277b19d0SLisandro Dalcin }
1951277b19d0SLisandro Dalcin 
1952277b19d0SLisandro Dalcin #undef __FUNCT__
1953f6a906c0SBarry Smith #define __FUNCT__ "TSAdjointSetUp"
1954f6a906c0SBarry Smith /*@
1955f6a906c0SBarry Smith    TSAdjointSetUp - Sets up the internal data structures for the later use
1956f6a906c0SBarry Smith    of an adjoint solver
1957f6a906c0SBarry Smith 
1958f6a906c0SBarry Smith    Collective on TS
1959f6a906c0SBarry Smith 
1960f6a906c0SBarry Smith    Input Parameter:
1961f6a906c0SBarry Smith .  ts - the TS context obtained from TSCreate()
1962f6a906c0SBarry Smith 
1963f6a906c0SBarry Smith    Level: advanced
1964f6a906c0SBarry Smith 
1965f6a906c0SBarry Smith .keywords: TS, timestep, setup
1966f6a906c0SBarry Smith 
1967947abb85SHong Zhang .seealso: TSCreate(), TSAdjointStep(), TSSetCostGradients()
1968f6a906c0SBarry Smith @*/
1969f6a906c0SBarry Smith PetscErrorCode  TSAdjointSetUp(TS ts)
1970f6a906c0SBarry Smith {
1971f6a906c0SBarry Smith   PetscErrorCode ierr;
1972f6a906c0SBarry Smith 
1973f6a906c0SBarry Smith   PetscFunctionBegin;
1974f6a906c0SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
1975f6a906c0SBarry Smith   if (ts->adjointsetupcalled) PetscFunctionReturn(0);
1976dfb21088SHong Zhang   if (!ts->vecs_sensi) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call TSSetCostGradients() first");
1977d8151eeaSBarry Smith 
1978947abb85SHong Zhang   if (ts->vec_costintegral) { /* if there is integral in the cost function*/
1979d8151eeaSBarry Smith     ierr = VecDuplicateVecs(ts->vecs_sensi[0],ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
1980d8151eeaSBarry Smith     if (ts->vecs_sensip){
1981d8151eeaSBarry Smith       ierr = VecDuplicateVecs(ts->vecs_sensip[0],ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
1982d8151eeaSBarry Smith     }
1983947abb85SHong Zhang   }
1984d8151eeaSBarry Smith 
198542f2b339SBarry Smith   if (ts->ops->adjointsetup) {
198642f2b339SBarry Smith     ierr = (*ts->ops->adjointsetup)(ts);CHKERRQ(ierr);
1987f6a906c0SBarry Smith   }
1988f6a906c0SBarry Smith   ts->adjointsetupcalled = PETSC_TRUE;
1989f6a906c0SBarry Smith   PetscFunctionReturn(0);
1990f6a906c0SBarry Smith }
1991f6a906c0SBarry Smith 
1992f6a906c0SBarry Smith #undef __FUNCT__
1993277b19d0SLisandro Dalcin #define __FUNCT__ "TSReset"
1994277b19d0SLisandro Dalcin /*@
1995277b19d0SLisandro Dalcin    TSReset - Resets a TS context and removes any allocated Vecs and Mats.
1996277b19d0SLisandro Dalcin 
1997277b19d0SLisandro Dalcin    Collective on TS
1998277b19d0SLisandro Dalcin 
1999277b19d0SLisandro Dalcin    Input Parameter:
2000277b19d0SLisandro Dalcin .  ts - the TS context obtained from TSCreate()
2001277b19d0SLisandro Dalcin 
2002277b19d0SLisandro Dalcin    Level: beginner
2003277b19d0SLisandro Dalcin 
2004277b19d0SLisandro Dalcin .keywords: TS, timestep, reset
2005277b19d0SLisandro Dalcin 
2006277b19d0SLisandro Dalcin .seealso: TSCreate(), TSSetup(), TSDestroy()
2007277b19d0SLisandro Dalcin @*/
2008277b19d0SLisandro Dalcin PetscErrorCode  TSReset(TS ts)
2009277b19d0SLisandro Dalcin {
2010277b19d0SLisandro Dalcin   PetscErrorCode ierr;
2011277b19d0SLisandro Dalcin 
2012277b19d0SLisandro Dalcin   PetscFunctionBegin;
2013277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2014b18ea86cSHong Zhang 
2015277b19d0SLisandro Dalcin   if (ts->ops->reset) {
2016277b19d0SLisandro Dalcin     ierr = (*ts->ops->reset)(ts);CHKERRQ(ierr);
2017277b19d0SLisandro Dalcin   }
2018277b19d0SLisandro Dalcin   if (ts->snes) {ierr = SNESReset(ts->snes);CHKERRQ(ierr);}
2019e27a82bcSLisandro Dalcin   if (ts->adapt) {ierr = TSAdaptReset(ts->adapt);CHKERRQ(ierr);}
2020bbd56ea5SKarl Rupp 
20214e684422SJed Brown   ierr = MatDestroy(&ts->Arhs);CHKERRQ(ierr);
20224e684422SJed Brown   ierr = MatDestroy(&ts->Brhs);CHKERRQ(ierr);
2023214bc6a2SJed Brown   ierr = VecDestroy(&ts->Frhs);CHKERRQ(ierr);
20246bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2025e3d84a46SJed Brown   ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
2026e3d84a46SJed Brown   ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
202738637c2eSJed Brown   ierr = VecDestroyVecs(ts->nwork,&ts->work);CHKERRQ(ierr);
2028bbd56ea5SKarl Rupp 
2029947abb85SHong Zhang  if (ts->vec_costintegral) {
2030d8151eeaSBarry Smith     ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdy);CHKERRQ(ierr);
2031d8151eeaSBarry Smith     if (ts->vecs_drdp){
2032d8151eeaSBarry Smith       ierr = VecDestroyVecs(ts->numcost,&ts->vecs_drdp);CHKERRQ(ierr);
2033d8151eeaSBarry Smith     }
2034947abb85SHong Zhang   }
2035d8151eeaSBarry Smith   ts->vecs_sensi  = NULL;
2036d8151eeaSBarry Smith   ts->vecs_sensip = NULL;
2037ad8e2604SHong Zhang   ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
20382c39e106SBarry Smith   ierr = VecDestroy(&ts->vec_costintegral);CHKERRQ(ierr);
203936eaed60SHong Zhang   ierr = VecDestroy(&ts->vec_costintegrand);CHKERRQ(ierr);
2040277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_FALSE;
2041d763cef2SBarry Smith   PetscFunctionReturn(0);
2042d763cef2SBarry Smith }
2043d763cef2SBarry Smith 
20444a2ae208SSatish Balay #undef __FUNCT__
20454a2ae208SSatish Balay #define __FUNCT__ "TSDestroy"
2046d8e5e3e6SSatish Balay /*@
2047d763cef2SBarry Smith    TSDestroy - Destroys the timestepper context that was created
2048d763cef2SBarry Smith    with TSCreate().
2049d763cef2SBarry Smith 
2050d763cef2SBarry Smith    Collective on TS
2051d763cef2SBarry Smith 
2052d763cef2SBarry Smith    Input Parameter:
2053d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2054d763cef2SBarry Smith 
2055d763cef2SBarry Smith    Level: beginner
2056d763cef2SBarry Smith 
2057d763cef2SBarry Smith .keywords: TS, timestepper, destroy
2058d763cef2SBarry Smith 
2059d763cef2SBarry Smith .seealso: TSCreate(), TSSetUp(), TSSolve()
2060d763cef2SBarry Smith @*/
20616bf464f9SBarry Smith PetscErrorCode  TSDestroy(TS *ts)
2062d763cef2SBarry Smith {
20636849ba73SBarry Smith   PetscErrorCode ierr;
2064d763cef2SBarry Smith 
2065d763cef2SBarry Smith   PetscFunctionBegin;
20666bf464f9SBarry Smith   if (!*ts) PetscFunctionReturn(0);
20676bf464f9SBarry Smith   PetscValidHeaderSpecific((*ts),TS_CLASSID,1);
20686bf464f9SBarry Smith   if (--((PetscObject)(*ts))->refct > 0) {*ts = 0; PetscFunctionReturn(0);}
2069d763cef2SBarry Smith 
20706bf464f9SBarry Smith   ierr = TSReset((*ts));CHKERRQ(ierr);
2071277b19d0SLisandro Dalcin 
2072e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
2073e04113cfSBarry Smith   ierr = PetscObjectSAWsViewOff((PetscObject)*ts);CHKERRQ(ierr);
20746bf464f9SBarry Smith   if ((*ts)->ops->destroy) {ierr = (*(*ts)->ops->destroy)((*ts));CHKERRQ(ierr);}
20756d4c513bSLisandro Dalcin 
2076bc952696SBarry Smith   ierr = TSTrajectoryDestroy(&(*ts)->trajectory);CHKERRQ(ierr);
2077bc952696SBarry Smith 
207884df9cb4SJed Brown   ierr = TSAdaptDestroy(&(*ts)->adapt);CHKERRQ(ierr);
2079aeb4809dSShri Abhyankar   if ((*ts)->event) {
2080aeb4809dSShri Abhyankar     ierr = TSEventMonitorDestroy(&(*ts)->event);CHKERRQ(ierr);
2081aeb4809dSShri Abhyankar   }
20826bf464f9SBarry Smith   ierr = SNESDestroy(&(*ts)->snes);CHKERRQ(ierr);
20836bf464f9SBarry Smith   ierr = DMDestroy(&(*ts)->dm);CHKERRQ(ierr);
20846bf464f9SBarry Smith   ierr = TSMonitorCancel((*ts));CHKERRQ(ierr);
20850dd9f2efSHong Zhang   ierr = TSAdjointMonitorCancel((*ts));CHKERRQ(ierr);
20866d4c513bSLisandro Dalcin 
2087a79aaaedSSatish Balay   ierr = PetscHeaderDestroy(ts);CHKERRQ(ierr);
2088d763cef2SBarry Smith   PetscFunctionReturn(0);
2089d763cef2SBarry Smith }
2090d763cef2SBarry Smith 
20914a2ae208SSatish Balay #undef __FUNCT__
20924a2ae208SSatish Balay #define __FUNCT__ "TSGetSNES"
2093d8e5e3e6SSatish Balay /*@
2094d763cef2SBarry Smith    TSGetSNES - Returns the SNES (nonlinear solver) associated with
2095d763cef2SBarry Smith    a TS (timestepper) context. Valid only for nonlinear problems.
2096d763cef2SBarry Smith 
2097d763cef2SBarry Smith    Not Collective, but SNES is parallel if TS is parallel
2098d763cef2SBarry Smith 
2099d763cef2SBarry Smith    Input Parameter:
2100d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2101d763cef2SBarry Smith 
2102d763cef2SBarry Smith    Output Parameter:
2103d763cef2SBarry Smith .  snes - the nonlinear solver context
2104d763cef2SBarry Smith 
2105d763cef2SBarry Smith    Notes:
2106d763cef2SBarry Smith    The user can then directly manipulate the SNES context to set various
2107d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
210894b7f48cSBarry Smith    KSP, KSP, and PC contexts as well.
2109d763cef2SBarry Smith 
2110d763cef2SBarry Smith    TSGetSNES() does not work for integrators that do not use SNES; in
21110298fd71SBarry Smith    this case TSGetSNES() returns NULL in snes.
2112d763cef2SBarry Smith 
2113d763cef2SBarry Smith    Level: beginner
2114d763cef2SBarry Smith 
2115d763cef2SBarry Smith .keywords: timestep, get, SNES
2116d763cef2SBarry Smith @*/
21177087cfbeSBarry Smith PetscErrorCode  TSGetSNES(TS ts,SNES *snes)
2118d763cef2SBarry Smith {
2119d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2120d372ba47SLisandro Dalcin 
2121d763cef2SBarry Smith   PetscFunctionBegin;
21220700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
21234482741eSBarry Smith   PetscValidPointer(snes,2);
2124d372ba47SLisandro Dalcin   if (!ts->snes) {
2125ce94432eSBarry Smith     ierr = SNESCreate(PetscObjectComm((PetscObject)ts),&ts->snes);CHKERRQ(ierr);
21260298fd71SBarry Smith     ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21273bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->snes);CHKERRQ(ierr);
2128d372ba47SLisandro Dalcin     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->snes,(PetscObject)ts,1);CHKERRQ(ierr);
2129496e6a7aSJed Brown     if (ts->dm) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
21309e2a6581SJed Brown     if (ts->problem_type == TS_LINEAR) {
21319e2a6581SJed Brown       ierr = SNESSetType(ts->snes,SNESKSPONLY);CHKERRQ(ierr);
21329e2a6581SJed Brown     }
2133d372ba47SLisandro Dalcin   }
2134d763cef2SBarry Smith   *snes = ts->snes;
2135d763cef2SBarry Smith   PetscFunctionReturn(0);
2136d763cef2SBarry Smith }
2137d763cef2SBarry Smith 
21384a2ae208SSatish Balay #undef __FUNCT__
2139deb2cd25SJed Brown #define __FUNCT__ "TSSetSNES"
2140deb2cd25SJed Brown /*@
2141deb2cd25SJed Brown    TSSetSNES - Set the SNES (nonlinear solver) to be used by the timestepping context
2142deb2cd25SJed Brown 
2143deb2cd25SJed Brown    Collective
2144deb2cd25SJed Brown 
2145deb2cd25SJed Brown    Input Parameter:
2146deb2cd25SJed Brown +  ts - the TS context obtained from TSCreate()
2147deb2cd25SJed Brown -  snes - the nonlinear solver context
2148deb2cd25SJed Brown 
2149deb2cd25SJed Brown    Notes:
2150deb2cd25SJed Brown    Most users should have the TS created by calling TSGetSNES()
2151deb2cd25SJed Brown 
2152deb2cd25SJed Brown    Level: developer
2153deb2cd25SJed Brown 
2154deb2cd25SJed Brown .keywords: timestep, set, SNES
2155deb2cd25SJed Brown @*/
2156deb2cd25SJed Brown PetscErrorCode TSSetSNES(TS ts,SNES snes)
2157deb2cd25SJed Brown {
2158deb2cd25SJed Brown   PetscErrorCode ierr;
2159d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES,Vec,Mat,Mat,void*);
2160deb2cd25SJed Brown 
2161deb2cd25SJed Brown   PetscFunctionBegin;
2162deb2cd25SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2163deb2cd25SJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,2);
2164deb2cd25SJed Brown   ierr = PetscObjectReference((PetscObject)snes);CHKERRQ(ierr);
2165deb2cd25SJed Brown   ierr = SNESDestroy(&ts->snes);CHKERRQ(ierr);
2166bbd56ea5SKarl Rupp 
2167deb2cd25SJed Brown   ts->snes = snes;
2168bbd56ea5SKarl Rupp 
21690298fd71SBarry Smith   ierr = SNESSetFunction(ts->snes,NULL,SNESTSFormFunction,ts);CHKERRQ(ierr);
21700298fd71SBarry Smith   ierr = SNESGetJacobian(ts->snes,NULL,NULL,&func,NULL);CHKERRQ(ierr);
2171740132f1SEmil Constantinescu   if (func == SNESTSFormJacobian) {
21720298fd71SBarry Smith     ierr = SNESSetJacobian(ts->snes,NULL,NULL,SNESTSFormJacobian,ts);CHKERRQ(ierr);
2173740132f1SEmil Constantinescu   }
2174deb2cd25SJed Brown   PetscFunctionReturn(0);
2175deb2cd25SJed Brown }
2176deb2cd25SJed Brown 
2177deb2cd25SJed Brown #undef __FUNCT__
217894b7f48cSBarry Smith #define __FUNCT__ "TSGetKSP"
2179d8e5e3e6SSatish Balay /*@
218094b7f48cSBarry Smith    TSGetKSP - Returns the KSP (linear solver) associated with
2181d763cef2SBarry Smith    a TS (timestepper) context.
2182d763cef2SBarry Smith 
218394b7f48cSBarry Smith    Not Collective, but KSP is parallel if TS is parallel
2184d763cef2SBarry Smith 
2185d763cef2SBarry Smith    Input Parameter:
2186d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2187d763cef2SBarry Smith 
2188d763cef2SBarry Smith    Output Parameter:
218994b7f48cSBarry Smith .  ksp - the nonlinear solver context
2190d763cef2SBarry Smith 
2191d763cef2SBarry Smith    Notes:
219294b7f48cSBarry Smith    The user can then directly manipulate the KSP context to set various
2193d763cef2SBarry Smith    options, etc.  Likewise, the user can then extract and manipulate the
2194d763cef2SBarry Smith    KSP and PC contexts as well.
2195d763cef2SBarry Smith 
219694b7f48cSBarry Smith    TSGetKSP() does not work for integrators that do not use KSP;
21970298fd71SBarry Smith    in this case TSGetKSP() returns NULL in ksp.
2198d763cef2SBarry Smith 
2199d763cef2SBarry Smith    Level: beginner
2200d763cef2SBarry Smith 
220194b7f48cSBarry Smith .keywords: timestep, get, KSP
2202d763cef2SBarry Smith @*/
22037087cfbeSBarry Smith PetscErrorCode  TSGetKSP(TS ts,KSP *ksp)
2204d763cef2SBarry Smith {
2205d372ba47SLisandro Dalcin   PetscErrorCode ierr;
2206089b2837SJed Brown   SNES           snes;
2207d372ba47SLisandro Dalcin 
2208d763cef2SBarry Smith   PetscFunctionBegin;
22090700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
22104482741eSBarry Smith   PetscValidPointer(ksp,2);
221117186662SBarry Smith   if (!((PetscObject)ts)->type_name) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"KSP is not created yet. Call TSSetType() first");
2212e32f2f54SBarry Smith   if (ts->problem_type != TS_LINEAR) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Linear only; use TSGetSNES()");
2213089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
2214089b2837SJed Brown   ierr = SNESGetKSP(snes,ksp);CHKERRQ(ierr);
2215d763cef2SBarry Smith   PetscFunctionReturn(0);
2216d763cef2SBarry Smith }
2217d763cef2SBarry Smith 
2218d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2219d763cef2SBarry Smith 
22204a2ae208SSatish Balay #undef __FUNCT__
2221adb62b0dSMatthew Knepley #define __FUNCT__ "TSGetDuration"
2222adb62b0dSMatthew Knepley /*@
2223adb62b0dSMatthew Knepley    TSGetDuration - Gets the maximum number of timesteps to use and
2224adb62b0dSMatthew Knepley    maximum time for iteration.
2225adb62b0dSMatthew Knepley 
22263f9fe445SBarry Smith    Not Collective
2227adb62b0dSMatthew Knepley 
2228adb62b0dSMatthew Knepley    Input Parameters:
2229adb62b0dSMatthew Knepley +  ts       - the TS context obtained from TSCreate()
22300298fd71SBarry Smith .  maxsteps - maximum number of iterations to use, or NULL
22310298fd71SBarry Smith -  maxtime  - final time to iterate to, or NULL
2232adb62b0dSMatthew Knepley 
2233adb62b0dSMatthew Knepley    Level: intermediate
2234adb62b0dSMatthew Knepley 
2235adb62b0dSMatthew Knepley .keywords: TS, timestep, get, maximum, iterations, time
2236adb62b0dSMatthew Knepley @*/
22377087cfbeSBarry Smith PetscErrorCode  TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2238adb62b0dSMatthew Knepley {
2239adb62b0dSMatthew Knepley   PetscFunctionBegin;
22400700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2241abc0a331SBarry Smith   if (maxsteps) {
22424482741eSBarry Smith     PetscValidIntPointer(maxsteps,2);
2243adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2244adb62b0dSMatthew Knepley   }
2245abc0a331SBarry Smith   if (maxtime) {
22464482741eSBarry Smith     PetscValidScalarPointer(maxtime,3);
2247adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2248adb62b0dSMatthew Knepley   }
2249adb62b0dSMatthew Knepley   PetscFunctionReturn(0);
2250adb62b0dSMatthew Knepley }
2251adb62b0dSMatthew Knepley 
2252adb62b0dSMatthew Knepley #undef __FUNCT__
22534a2ae208SSatish Balay #define __FUNCT__ "TSSetDuration"
2254d763cef2SBarry Smith /*@
2255d763cef2SBarry Smith    TSSetDuration - Sets the maximum number of timesteps to use and
2256d763cef2SBarry Smith    maximum time for iteration.
2257d763cef2SBarry Smith 
22583f9fe445SBarry Smith    Logically Collective on TS
2259d763cef2SBarry Smith 
2260d763cef2SBarry Smith    Input Parameters:
2261d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2262d763cef2SBarry Smith .  maxsteps - maximum number of iterations to use
2263d763cef2SBarry Smith -  maxtime - final time to iterate to
2264d763cef2SBarry Smith 
2265d763cef2SBarry Smith    Options Database Keys:
2266d763cef2SBarry Smith .  -ts_max_steps <maxsteps> - Sets maxsteps
22673bca7d26SBarry Smith .  -ts_final_time <maxtime> - Sets maxtime
2268d763cef2SBarry Smith 
2269d763cef2SBarry Smith    Notes:
2270d763cef2SBarry Smith    The default maximum number of iterations is 5000. Default time is 5.0
2271d763cef2SBarry Smith 
2272d763cef2SBarry Smith    Level: intermediate
2273d763cef2SBarry Smith 
2274d763cef2SBarry Smith .keywords: TS, timestep, set, maximum, iterations
2275a43b19c4SJed Brown 
2276a43b19c4SJed Brown .seealso: TSSetExactFinalTime()
2277d763cef2SBarry Smith @*/
22787087cfbeSBarry Smith PetscErrorCode  TSSetDuration(TS ts,PetscInt maxsteps,PetscReal maxtime)
2279d763cef2SBarry Smith {
2280d763cef2SBarry Smith   PetscFunctionBegin;
22810700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2282c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts,maxsteps,2);
2283c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,maxtime,2);
228439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
228539b7ec4bSSean Farley   if (maxtime != PETSC_DEFAULT) ts->max_time = maxtime;
2286d763cef2SBarry Smith   PetscFunctionReturn(0);
2287d763cef2SBarry Smith }
2288d763cef2SBarry Smith 
22894a2ae208SSatish Balay #undef __FUNCT__
22904a2ae208SSatish Balay #define __FUNCT__ "TSSetSolution"
2291d763cef2SBarry Smith /*@
2292d763cef2SBarry Smith    TSSetSolution - Sets the initial solution vector
2293d763cef2SBarry Smith    for use by the TS routines.
2294d763cef2SBarry Smith 
22953f9fe445SBarry Smith    Logically Collective on TS and Vec
2296d763cef2SBarry Smith 
2297d763cef2SBarry Smith    Input Parameters:
2298d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
22990910c330SBarry Smith -  u - the solution vector
2300d763cef2SBarry Smith 
2301d763cef2SBarry Smith    Level: beginner
2302d763cef2SBarry Smith 
2303d763cef2SBarry Smith .keywords: TS, timestep, set, solution, initial conditions
2304d763cef2SBarry Smith @*/
23050910c330SBarry Smith PetscErrorCode  TSSetSolution(TS ts,Vec u)
2306d763cef2SBarry Smith {
23078737fe31SLisandro Dalcin   PetscErrorCode ierr;
2308496e6a7aSJed Brown   DM             dm;
23098737fe31SLisandro Dalcin 
2310d763cef2SBarry Smith   PetscFunctionBegin;
23110700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
23120910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,2);
23130910c330SBarry Smith   ierr = PetscObjectReference((PetscObject)u);CHKERRQ(ierr);
23146bf464f9SBarry Smith   ierr = VecDestroy(&ts->vec_sol);CHKERRQ(ierr);
2315bbd56ea5SKarl Rupp 
23160910c330SBarry Smith   ts->vec_sol = u;
2317bbd56ea5SKarl Rupp 
2318496e6a7aSJed Brown   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
23190910c330SBarry Smith   ierr = DMShellSetGlobalVector(dm,u);CHKERRQ(ierr);
2320d763cef2SBarry Smith   PetscFunctionReturn(0);
2321d763cef2SBarry Smith }
2322d763cef2SBarry Smith 
2323e74ef692SMatthew Knepley #undef __FUNCT__
232473b18844SBarry Smith #define __FUNCT__ "TSAdjointSetSteps"
232573b18844SBarry Smith /*@
232673b18844SBarry Smith    TSAdjointSetSteps - Sets the number of steps the adjoint solver should take backward in time
232773b18844SBarry Smith 
232873b18844SBarry Smith    Logically Collective on TS
232973b18844SBarry Smith 
233073b18844SBarry Smith    Input Parameters:
233173b18844SBarry Smith +  ts - the TS context obtained from TSCreate()
233273b18844SBarry Smith .  steps - number of steps to use
233373b18844SBarry Smith 
233473b18844SBarry Smith    Level: intermediate
233573b18844SBarry Smith 
233673b18844SBarry Smith    Notes: Normally one does not call this and TSAdjointSolve() integrates back to the original timestep. One can call this
233773b18844SBarry Smith           so as to integrate back to less than the original timestep
233873b18844SBarry Smith 
233973b18844SBarry Smith .keywords: TS, timestep, set, maximum, iterations
234073b18844SBarry Smith 
234173b18844SBarry Smith .seealso: TSSetExactFinalTime()
234273b18844SBarry Smith @*/
234373b18844SBarry Smith PetscErrorCode  TSAdjointSetSteps(TS ts,PetscInt steps)
234473b18844SBarry Smith {
234573b18844SBarry Smith   PetscFunctionBegin;
234673b18844SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
234773b18844SBarry Smith   PetscValidLogicalCollectiveInt(ts,steps,2);
234873b18844SBarry Smith   if (steps < 0) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_ARG_OUTOFRANGE,"Cannot step back a negative number of steps");
234973b18844SBarry 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");
235073b18844SBarry Smith   ts->adjoint_max_steps = steps;
235173b18844SBarry Smith   PetscFunctionReturn(0);
235273b18844SBarry Smith }
235373b18844SBarry Smith 
235473b18844SBarry Smith #undef __FUNCT__
2355dfb21088SHong Zhang #define __FUNCT__ "TSSetCostGradients"
2356c235aa8dSHong Zhang /*@
2357dfb21088SHong 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
23580cf82b59SBarry Smith       for use by the TSAdjoint routines.
2359c235aa8dSHong Zhang 
2360c235aa8dSHong Zhang    Logically Collective on TS and Vec
2361c235aa8dSHong Zhang 
2362c235aa8dSHong Zhang    Input Parameters:
2363c235aa8dSHong Zhang +  ts - the TS context obtained from TSCreate()
2364abc2977eSBarry 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
2365abc2977eSBarry Smith -  mu - gradients with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
2366c235aa8dSHong Zhang 
2367c235aa8dSHong Zhang    Level: beginner
2368c235aa8dSHong Zhang 
2369abc2977eSBarry Smith    Notes: the entries in these vectors must be correctly initialized with the values lamda_i = df/dy|finaltime  mu_i = df/dp|finaltime
23700cf82b59SBarry Smith 
2371c235aa8dSHong Zhang .keywords: TS, timestep, set, sensitivity, initial conditions
2372c235aa8dSHong Zhang @*/
2373dfb21088SHong Zhang PetscErrorCode  TSSetCostGradients(TS ts,PetscInt numcost,Vec *lambda,Vec *mu)
2374c235aa8dSHong Zhang {
2375c235aa8dSHong Zhang   PetscFunctionBegin;
2376c235aa8dSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2377abc2977eSBarry Smith   PetscValidPointer(lambda,2);
2378abc2977eSBarry Smith   ts->vecs_sensi  = lambda;
2379abc2977eSBarry Smith   ts->vecs_sensip = mu;
2380dfb21088SHong 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");
2381abc2977eSBarry Smith   ts->numcost  = numcost;
2382ad8e2604SHong Zhang   PetscFunctionReturn(0);
2383ad8e2604SHong Zhang }
2384ad8e2604SHong Zhang 
2385ad8e2604SHong Zhang #undef __FUNCT__
23865bf8c567SBarry Smith #define __FUNCT__ "TSAdjointSetRHSJacobian"
2387ad8e2604SHong Zhang /*@C
23880cf82b59SBarry 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.
2389ad8e2604SHong Zhang 
2390ad8e2604SHong Zhang   Logically Collective on TS
2391ad8e2604SHong Zhang 
2392ad8e2604SHong Zhang   Input Parameters:
2393ad8e2604SHong Zhang + ts   - The TS context obtained from TSCreate()
2394ad8e2604SHong Zhang - func - The function
2395ad8e2604SHong Zhang 
2396ad8e2604SHong Zhang   Calling sequence of func:
23970cf82b59SBarry Smith $ func (TS ts,PetscReal t,Vec y,Mat A,void *ctx);
239805755b9cSHong Zhang +   t - current timestep
23990cf82b59SBarry Smith .   y - input vector (current ODE solution)
240005755b9cSHong Zhang .   A - output matrix
240105755b9cSHong Zhang -   ctx - [optional] user-defined function context
2402ad8e2604SHong Zhang 
2403ad8e2604SHong Zhang   Level: intermediate
2404ad8e2604SHong Zhang 
24050cf82b59SBarry 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
24060cf82b59SBarry Smith 
2407ad8e2604SHong Zhang .keywords: TS, sensitivity
2408ad8e2604SHong Zhang .seealso:
2409ad8e2604SHong Zhang @*/
24105bf8c567SBarry Smith PetscErrorCode  TSAdjointSetRHSJacobian(TS ts,Mat Amat,PetscErrorCode (*func)(TS,PetscReal,Vec,Mat,void*),void *ctx)
2411ad8e2604SHong Zhang {
2412ad8e2604SHong Zhang   PetscErrorCode ierr;
2413ad8e2604SHong Zhang 
2414ad8e2604SHong Zhang   PetscFunctionBegin;
2415ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2416ad8e2604SHong Zhang   if (Amat) PetscValidHeaderSpecific(Amat,MAT_CLASSID,2);
2417ad8e2604SHong Zhang 
2418ad8e2604SHong Zhang   ts->rhsjacobianp    = func;
2419ad8e2604SHong Zhang   ts->rhsjacobianpctx = ctx;
2420ad8e2604SHong Zhang   if(Amat) {
2421ad8e2604SHong Zhang     ierr = PetscObjectReference((PetscObject)Amat);CHKERRQ(ierr);
2422ad8e2604SHong Zhang     ierr = MatDestroy(&ts->Jacp);CHKERRQ(ierr);
2423ad8e2604SHong Zhang     ts->Jacp = Amat;
2424ad8e2604SHong Zhang   }
2425ad8e2604SHong Zhang   PetscFunctionReturn(0);
2426ad8e2604SHong Zhang }
2427ad8e2604SHong Zhang 
2428ad8e2604SHong Zhang #undef __FUNCT__
24295bf8c567SBarry Smith #define __FUNCT__ "TSAdjointComputeRHSJacobian"
24300cf82b59SBarry Smith /*@C
24315bf8c567SBarry Smith   TSAdjointComputeRHSJacobian - Runs the user-defined Jacobian function.
2432ad8e2604SHong Zhang 
2433ad8e2604SHong Zhang   Collective on TS
2434ad8e2604SHong Zhang 
2435ad8e2604SHong Zhang   Input Parameters:
2436ad8e2604SHong Zhang . ts   - The TS context obtained from TSCreate()
2437ad8e2604SHong Zhang 
2438ad8e2604SHong Zhang   Level: developer
2439ad8e2604SHong Zhang 
2440ad8e2604SHong Zhang .keywords: TS, sensitivity
24415bf8c567SBarry Smith .seealso: TSAdjointSetRHSJacobian()
2442ad8e2604SHong Zhang @*/
24435bf8c567SBarry Smith PetscErrorCode  TSAdjointComputeRHSJacobian(TS ts,PetscReal t,Vec X,Mat Amat)
2444ad8e2604SHong Zhang {
2445ad8e2604SHong Zhang   PetscErrorCode ierr;
2446ad8e2604SHong Zhang 
2447ad8e2604SHong Zhang   PetscFunctionBegin;
2448ad8e2604SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2449ad8e2604SHong Zhang   PetscValidHeaderSpecific(X,VEC_CLASSID,3);
2450ad8e2604SHong Zhang   PetscValidPointer(Amat,4);
2451ad8e2604SHong Zhang 
2452ad8e2604SHong Zhang   PetscStackPush("TS user JacobianP function for sensitivity analysis");
2453ad8e2604SHong Zhang   ierr = (*ts->rhsjacobianp)(ts,t,X,Amat,ts->rhsjacobianpctx); CHKERRQ(ierr);
2454ad8e2604SHong Zhang   PetscStackPop;
2455c235aa8dSHong Zhang   PetscFunctionReturn(0);
2456c235aa8dSHong Zhang }
2457c235aa8dSHong Zhang 
2458c235aa8dSHong Zhang #undef __FUNCT__
2459dfb21088SHong Zhang #define __FUNCT__ "TSSetCostIntegrand"
24606fd0887fSHong Zhang /*@C
2461dfb21088SHong Zhang     TSSetCostIntegrand - Sets the routine for evaluating the integral term in one or more cost functions
24626fd0887fSHong Zhang 
24636fd0887fSHong Zhang     Logically Collective on TS
24646fd0887fSHong Zhang 
24656fd0887fSHong Zhang     Input Parameters:
24666fd0887fSHong Zhang +   ts - the TS context obtained from TSCreate()
2467abc2977eSBarry Smith .   numcost - number of gradients to be computed, this is the number of cost functions
24680cf82b59SBarry Smith .   rf - routine for evaluating the integrand function
2469b612ec54SBarry Smith .   drdyf - function that computes the gradients of the r's with respect to y,NULL if not a function y
2470b612ec54SBarry Smith .   drdpf - function that computes the gradients of the r's with respect to p, NULL if not a function of p
2471b612ec54SBarry Smith -   ctx - [optional] user-defined context for private data for the function evaluation routine (may be NULL)
24726fd0887fSHong Zhang 
24730cf82b59SBarry Smith     Calling sequence of rf:
24740cf82b59SBarry Smith $     rf(TS ts,PetscReal t,Vec y,Vec f[],void *ctx);
24756fd0887fSHong Zhang 
24766fd0887fSHong Zhang +   t - current timestep
24770cf82b59SBarry Smith .   y - input vector
24780cf82b59SBarry Smith .   f - function result; one vector entry for each cost function
24796fd0887fSHong Zhang -   ctx - [optional] user-defined function context
24806fd0887fSHong Zhang 
2481b612ec54SBarry Smith    Calling sequence of drdyf:
24820cf82b59SBarry Smith $    PetscErroCode drdyf(TS ts,PetscReal t,Vec y,Vec *drdy,void *ctx);
2483b612ec54SBarry Smith 
2484b612ec54SBarry Smith    Calling sequence of drdpf:
24850cf82b59SBarry Smith $    PetscErroCode drdpf(TS ts,PetscReal t,Vec y,Vec *drdp,void *ctx);
2486b612ec54SBarry Smith 
2487b612ec54SBarry Smith     Level: intermediate
24886fd0887fSHong Zhang 
2489abc2977eSBarry Smith     Notes: For optimization there is generally a single cost function, numcost = 1. For sensitivities there may be multiple cost functions
24900cf82b59SBarry Smith 
24916fd0887fSHong Zhang .keywords: TS, sensitivity analysis, timestep, set, quadrature, function
24926fd0887fSHong Zhang 
2493dfb21088SHong Zhang .seealso: TSAdjointSetRHSJacobian(),TSGetCostGradients(), TSSetCostGradients()
24946fd0887fSHong Zhang @*/
2495dfb21088SHong Zhang PetscErrorCode  TSSetCostIntegrand(TS ts,PetscInt numcost, PetscErrorCode (*rf)(TS,PetscReal,Vec,Vec,void*),
2496d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdyf)(TS,PetscReal,Vec,Vec*,void*),
2497d8151eeaSBarry Smith                                                                   PetscErrorCode (*drdpf)(TS,PetscReal,Vec,Vec*,void*),void *ctx)
24986fd0887fSHong Zhang {
24996fd0887fSHong Zhang   PetscErrorCode ierr;
25006fd0887fSHong Zhang 
25016fd0887fSHong Zhang   PetscFunctionBegin;
25026fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2503dfb21088SHong 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()");
2504c72ed514SHong Zhang   if (!ts->numcost) ts->numcost=numcost;
25056fd0887fSHong Zhang 
2506abc2977eSBarry Smith   ierr                 = VecCreateSeq(PETSC_COMM_SELF,numcost,&ts->vec_costintegral);CHKERRQ(ierr);
25072c39e106SBarry Smith   ierr                 = VecDuplicate(ts->vec_costintegral,&ts->vec_costintegrand);CHKERRQ(ierr);
25080cf82b59SBarry Smith   ts->costintegrand    = rf;
250905755b9cSHong Zhang   ts->costintegrandctx = ctx;
2510b612ec54SBarry Smith   ts->drdyfunction     = drdyf;
2511b612ec54SBarry Smith   ts->drdpfunction     = drdpf;
25126fd0887fSHong Zhang   PetscFunctionReturn(0);
25136fd0887fSHong Zhang }
25146fd0887fSHong Zhang 
25156fd0887fSHong Zhang #undef __FUNCT__
2516dfb21088SHong Zhang #define __FUNCT__ "TSGetCostIntegral"
251736eaed60SHong Zhang /*@
2518dfb21088SHong Zhang    TSGetCostIntegral - Returns the values of the integral term in the cost functions.
251936eaed60SHong Zhang    It is valid to call the routine after a backward run.
252036eaed60SHong Zhang 
252136eaed60SHong Zhang    Not Collective
252236eaed60SHong Zhang 
252336eaed60SHong Zhang    Input Parameter:
252436eaed60SHong Zhang .  ts - the TS context obtained from TSCreate()
252536eaed60SHong Zhang 
252636eaed60SHong Zhang    Output Parameter:
25272c39e106SBarry Smith .  v - the vector containing the integrals for each cost function
252836eaed60SHong Zhang 
252936eaed60SHong Zhang    Level: intermediate
253036eaed60SHong Zhang 
2531dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
253236eaed60SHong Zhang 
253336eaed60SHong Zhang .keywords: TS, sensitivity analysis
253436eaed60SHong Zhang @*/
2535dfb21088SHong Zhang PetscErrorCode  TSGetCostIntegral(TS ts,Vec *v)
253636eaed60SHong Zhang {
253736eaed60SHong Zhang   PetscFunctionBegin;
253836eaed60SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
253936eaed60SHong Zhang   PetscValidPointer(v,2);
25402c39e106SBarry Smith   *v = ts->vec_costintegral;
254136eaed60SHong Zhang   PetscFunctionReturn(0);
254236eaed60SHong Zhang }
254336eaed60SHong Zhang 
254436eaed60SHong Zhang #undef __FUNCT__
2545d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeCostIntegrand"
25466fd0887fSHong Zhang /*@
25472c39e106SBarry Smith    TSAdjointComputeCostIntegrand - Evaluates the integral function in the cost functions.
25486fd0887fSHong Zhang 
25496fd0887fSHong Zhang    Input Parameters:
25506fd0887fSHong Zhang +  ts - the TS context
25516fd0887fSHong Zhang .  t - current time
25520cf82b59SBarry Smith -  y - state vector, i.e. current solution
25536fd0887fSHong Zhang 
25546fd0887fSHong Zhang    Output Parameter:
2555abc2977eSBarry Smith .  q - vector of size numcost to hold the outputs
25566fd0887fSHong Zhang 
25576fd0887fSHong Zhang    Note:
25586fd0887fSHong Zhang    Most users should not need to explicitly call this routine, as it
25596fd0887fSHong Zhang    is used internally within the sensitivity analysis context.
25606fd0887fSHong Zhang 
25616fd0887fSHong Zhang    Level: developer
25626fd0887fSHong Zhang 
25636fd0887fSHong Zhang .keywords: TS, compute
25646fd0887fSHong Zhang 
2565dfb21088SHong Zhang .seealso: TSSetCostIntegrand()
25666fd0887fSHong Zhang @*/
25670cf82b59SBarry Smith PetscErrorCode TSAdjointComputeCostIntegrand(TS ts,PetscReal t,Vec y,Vec q)
25686fd0887fSHong Zhang {
25696fd0887fSHong Zhang   PetscErrorCode ierr;
25706fd0887fSHong Zhang 
25716fd0887fSHong Zhang   PetscFunctionBegin;
25726fd0887fSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
25730cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
25746fd0887fSHong Zhang   PetscValidHeaderSpecific(q,VEC_CLASSID,4);
25756fd0887fSHong Zhang 
25760cf82b59SBarry Smith   ierr = PetscLogEventBegin(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
2577e4680132SHong Zhang   if (ts->costintegrand) {
2578e4680132SHong Zhang     PetscStackPush("TS user integrand in the cost function");
25790cf82b59SBarry Smith     ierr = (*ts->costintegrand)(ts,t,y,q,ts->costintegrandctx);CHKERRQ(ierr);
25806fd0887fSHong Zhang     PetscStackPop;
25816fd0887fSHong Zhang   } else {
25826fd0887fSHong Zhang     ierr = VecZeroEntries(q);CHKERRQ(ierr);
25836fd0887fSHong Zhang   }
25846fd0887fSHong Zhang 
25850cf82b59SBarry Smith   ierr = PetscLogEventEnd(TS_FunctionEval,ts,y,q,0);CHKERRQ(ierr);
25866fd0887fSHong Zhang   PetscFunctionReturn(0);
25876fd0887fSHong Zhang }
25886fd0887fSHong Zhang 
25896fd0887fSHong Zhang #undef __FUNCT__
2590d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDYFunction"
259105755b9cSHong Zhang /*@
2592d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction - Runs the user-defined DRDY function.
259305755b9cSHong Zhang 
259405755b9cSHong Zhang   Collective on TS
259505755b9cSHong Zhang 
259605755b9cSHong Zhang   Input Parameters:
259705755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
259805755b9cSHong Zhang 
259905755b9cSHong Zhang   Notes:
2600d4aa0a58SBarry Smith   TSAdjointComputeDRDYFunction() is typically used for sensitivity implementation,
260105755b9cSHong Zhang   so most users would not generally call this routine themselves.
260205755b9cSHong Zhang 
260305755b9cSHong Zhang   Level: developer
260405755b9cSHong Zhang 
260505755b9cSHong Zhang .keywords: TS, sensitivity
2606d4aa0a58SBarry Smith .seealso: TSAdjointComputeDRDYFunction()
260705755b9cSHong Zhang @*/
26080cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDYFunction(TS ts,PetscReal t,Vec y,Vec *drdy)
260905755b9cSHong Zhang {
261005755b9cSHong Zhang   PetscErrorCode ierr;
261105755b9cSHong Zhang 
261205755b9cSHong Zhang   PetscFunctionBegin;
261305755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26140cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
261505755b9cSHong Zhang 
261605755b9cSHong Zhang   PetscStackPush("TS user DRDY function for sensitivity analysis");
26170cf82b59SBarry Smith   ierr = (*ts->drdyfunction)(ts,t,y,drdy,ts->costintegrandctx); CHKERRQ(ierr);
261805755b9cSHong Zhang   PetscStackPop;
261905755b9cSHong Zhang   PetscFunctionReturn(0);
262005755b9cSHong Zhang }
262105755b9cSHong Zhang 
262205755b9cSHong Zhang #undef __FUNCT__
2623d4aa0a58SBarry Smith #define __FUNCT__ "TSAdjointComputeDRDPFunction"
262405755b9cSHong Zhang /*@
2625d4aa0a58SBarry Smith   TSAdjointComputeDRDPFunction - Runs the user-defined DRDP function.
262605755b9cSHong Zhang 
262705755b9cSHong Zhang   Collective on TS
262805755b9cSHong Zhang 
262905755b9cSHong Zhang   Input Parameters:
263005755b9cSHong Zhang . ts   - The TS context obtained from TSCreate()
263105755b9cSHong Zhang 
263205755b9cSHong Zhang   Notes:
263305755b9cSHong Zhang   TSDRDPFunction() is typically used for sensitivity implementation,
263405755b9cSHong Zhang   so most users would not generally call this routine themselves.
263505755b9cSHong Zhang 
263605755b9cSHong Zhang   Level: developer
263705755b9cSHong Zhang 
263805755b9cSHong Zhang .keywords: TS, sensitivity
2639d4aa0a58SBarry Smith .seealso: TSAdjointSetDRDPFunction()
264005755b9cSHong Zhang @*/
26410cf82b59SBarry Smith PetscErrorCode  TSAdjointComputeDRDPFunction(TS ts,PetscReal t,Vec y,Vec *drdp)
264205755b9cSHong Zhang {
264305755b9cSHong Zhang   PetscErrorCode ierr;
264405755b9cSHong Zhang 
264505755b9cSHong Zhang   PetscFunctionBegin;
264605755b9cSHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
26470cf82b59SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,3);
264805755b9cSHong Zhang 
264905755b9cSHong Zhang   PetscStackPush("TS user DRDP function for sensitivity analysis");
26500cf82b59SBarry Smith   ierr = (*ts->drdpfunction)(ts,t,y,drdp,ts->costintegrandctx); CHKERRQ(ierr);
265105755b9cSHong Zhang   PetscStackPop;
265205755b9cSHong Zhang   PetscFunctionReturn(0);
265305755b9cSHong Zhang }
265405755b9cSHong Zhang 
265505755b9cSHong Zhang #undef __FUNCT__
2656e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPreStep"
2657ac226902SBarry Smith /*@C
2658000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
26593f2090d5SJed Brown   called once at the beginning of each time step.
2660000e7ae3SMatthew Knepley 
26613f9fe445SBarry Smith   Logically Collective on TS
2662000e7ae3SMatthew Knepley 
2663000e7ae3SMatthew Knepley   Input Parameters:
2664000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2665000e7ae3SMatthew Knepley - func - The function
2666000e7ae3SMatthew Knepley 
2667000e7ae3SMatthew Knepley   Calling sequence of func:
2668000e7ae3SMatthew Knepley . func (TS ts);
2669000e7ae3SMatthew Knepley 
2670000e7ae3SMatthew Knepley   Level: intermediate
2671000e7ae3SMatthew Knepley 
2672b8123daeSJed Brown   Note:
2673b8123daeSJed Brown   If a step is rejected, TSStep() will call this routine again before each attempt.
2674b8123daeSJed Brown   The last completed time step number can be queried using TSGetTimeStepNumber(), the
2675b8123daeSJed Brown   size of the step being attempted can be obtained using TSGetTimeStep().
2676b8123daeSJed Brown 
2677000e7ae3SMatthew Knepley .keywords: TS, timestep
26789be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPostStage(), TSSetPostStep(), TSStep()
2679000e7ae3SMatthew Knepley @*/
26807087cfbeSBarry Smith PetscErrorCode  TSSetPreStep(TS ts, PetscErrorCode (*func)(TS))
2681000e7ae3SMatthew Knepley {
2682000e7ae3SMatthew Knepley   PetscFunctionBegin;
26830700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2684ae60f76fSBarry Smith   ts->prestep = func;
2685000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2686000e7ae3SMatthew Knepley }
2687000e7ae3SMatthew Knepley 
2688e74ef692SMatthew Knepley #undef __FUNCT__
26893f2090d5SJed Brown #define __FUNCT__ "TSPreStep"
269009ee8438SJed Brown /*@
26913f2090d5SJed Brown   TSPreStep - Runs the user-defined pre-step function.
26923f2090d5SJed Brown 
26933f2090d5SJed Brown   Collective on TS
26943f2090d5SJed Brown 
26953f2090d5SJed Brown   Input Parameters:
26963f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
26973f2090d5SJed Brown 
26983f2090d5SJed Brown   Notes:
26993f2090d5SJed Brown   TSPreStep() is typically used within time stepping implementations,
27003f2090d5SJed Brown   so most users would not generally call this routine themselves.
27013f2090d5SJed Brown 
27023f2090d5SJed Brown   Level: developer
27033f2090d5SJed Brown 
27043f2090d5SJed Brown .keywords: TS, timestep
27059be3e283SDebojyoti Ghosh .seealso: TSSetPreStep(), TSPreStage(), TSPostStage(), TSPostStep()
27063f2090d5SJed Brown @*/
27077087cfbeSBarry Smith PetscErrorCode  TSPreStep(TS ts)
27083f2090d5SJed Brown {
27093f2090d5SJed Brown   PetscErrorCode ierr;
27103f2090d5SJed Brown 
27113f2090d5SJed Brown   PetscFunctionBegin;
27120700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2713ae60f76fSBarry Smith   if (ts->prestep) {
2714ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestep),(ts));
2715312ce896SJed Brown   }
27163f2090d5SJed Brown   PetscFunctionReturn(0);
27173f2090d5SJed Brown }
27183f2090d5SJed Brown 
27193f2090d5SJed Brown #undef __FUNCT__
2720b8123daeSJed Brown #define __FUNCT__ "TSSetPreStage"
2721b8123daeSJed Brown /*@C
2722b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
2723b8123daeSJed Brown   called once at the beginning of each stage.
2724b8123daeSJed Brown 
2725b8123daeSJed Brown   Logically Collective on TS
2726b8123daeSJed Brown 
2727b8123daeSJed Brown   Input Parameters:
2728b8123daeSJed Brown + ts   - The TS context obtained from TSCreate()
2729b8123daeSJed Brown - func - The function
2730b8123daeSJed Brown 
2731b8123daeSJed Brown   Calling sequence of func:
2732b8123daeSJed Brown . PetscErrorCode func(TS ts, PetscReal stagetime);
2733b8123daeSJed Brown 
2734b8123daeSJed Brown   Level: intermediate
2735b8123daeSJed Brown 
2736b8123daeSJed Brown   Note:
2737b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
2738b8123daeSJed Brown   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
2739b8123daeSJed Brown   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
2740b8123daeSJed Brown 
2741b8123daeSJed Brown .keywords: TS, timestep
27429be3e283SDebojyoti Ghosh .seealso: TSSetPostStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
2743b8123daeSJed Brown @*/
2744b8123daeSJed Brown PetscErrorCode  TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
2745b8123daeSJed Brown {
2746b8123daeSJed Brown   PetscFunctionBegin;
2747b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2748ae60f76fSBarry Smith   ts->prestage = func;
2749b8123daeSJed Brown   PetscFunctionReturn(0);
2750b8123daeSJed Brown }
2751b8123daeSJed Brown 
2752b8123daeSJed Brown #undef __FUNCT__
27539be3e283SDebojyoti Ghosh #define __FUNCT__ "TSSetPostStage"
27549be3e283SDebojyoti Ghosh /*@C
27559be3e283SDebojyoti Ghosh   TSSetPostStage - Sets the general-purpose function
27569be3e283SDebojyoti Ghosh   called once at the end of each stage.
27579be3e283SDebojyoti Ghosh 
27589be3e283SDebojyoti Ghosh   Logically Collective on TS
27599be3e283SDebojyoti Ghosh 
27609be3e283SDebojyoti Ghosh   Input Parameters:
27619be3e283SDebojyoti Ghosh + ts   - The TS context obtained from TSCreate()
27629be3e283SDebojyoti Ghosh - func - The function
27639be3e283SDebojyoti Ghosh 
27649be3e283SDebojyoti Ghosh   Calling sequence of func:
27659be3e283SDebojyoti Ghosh . PetscErrorCode func(TS ts, PetscReal stagetime, PetscInt stageindex, Vec* Y);
27669be3e283SDebojyoti Ghosh 
27679be3e283SDebojyoti Ghosh   Level: intermediate
27689be3e283SDebojyoti Ghosh 
27699be3e283SDebojyoti Ghosh   Note:
27709be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
27719be3e283SDebojyoti Ghosh   The time step number being computed can be queried using TSGetTimeStepNumber() and the total size of the step being
27729be3e283SDebojyoti Ghosh   attempted can be obtained using TSGetTimeStep(). The time at the start of the step is available via TSGetTime().
27739be3e283SDebojyoti Ghosh 
27749be3e283SDebojyoti Ghosh .keywords: TS, timestep
27759be3e283SDebojyoti Ghosh .seealso: TSSetPreStage(), TSSetPreStep(), TSSetPostStep(), TSGetApplicationContext()
27769be3e283SDebojyoti Ghosh @*/
27779be3e283SDebojyoti Ghosh PetscErrorCode  TSSetPostStage(TS ts, PetscErrorCode (*func)(TS,PetscReal,PetscInt,Vec*))
27789be3e283SDebojyoti Ghosh {
27799be3e283SDebojyoti Ghosh   PetscFunctionBegin;
27809be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
27819be3e283SDebojyoti Ghosh   ts->poststage = func;
27829be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
27839be3e283SDebojyoti Ghosh }
27849be3e283SDebojyoti Ghosh 
27859be3e283SDebojyoti Ghosh #undef __FUNCT__
2786b8123daeSJed Brown #define __FUNCT__ "TSPreStage"
2787b8123daeSJed Brown /*@
2788b8123daeSJed Brown   TSPreStage - Runs the user-defined pre-stage function set using TSSetPreStage()
2789b8123daeSJed Brown 
2790b8123daeSJed Brown   Collective on TS
2791b8123daeSJed Brown 
2792b8123daeSJed Brown   Input Parameters:
2793b8123daeSJed Brown . ts          - The TS context obtained from TSCreate()
27949be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
2795b8123daeSJed Brown 
2796b8123daeSJed Brown   Notes:
2797b8123daeSJed Brown   TSPreStage() is typically used within time stepping implementations,
2798b8123daeSJed Brown   most users would not generally call this routine themselves.
2799b8123daeSJed Brown 
2800b8123daeSJed Brown   Level: developer
2801b8123daeSJed Brown 
2802b8123daeSJed Brown .keywords: TS, timestep
28039be3e283SDebojyoti Ghosh .seealso: TSPostStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
2804b8123daeSJed Brown @*/
2805b8123daeSJed Brown PetscErrorCode  TSPreStage(TS ts, PetscReal stagetime)
2806b8123daeSJed Brown {
2807b8123daeSJed Brown   PetscErrorCode ierr;
2808b8123daeSJed Brown 
2809b8123daeSJed Brown   PetscFunctionBegin;
2810b8123daeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2811ae60f76fSBarry Smith   if (ts->prestage) {
2812ae60f76fSBarry Smith     PetscStackCallStandard((*ts->prestage),(ts,stagetime));
2813b8123daeSJed Brown   }
2814b8123daeSJed Brown   PetscFunctionReturn(0);
2815b8123daeSJed Brown }
2816b8123daeSJed Brown 
2817b8123daeSJed Brown #undef __FUNCT__
28189be3e283SDebojyoti Ghosh #define __FUNCT__ "TSPostStage"
28199be3e283SDebojyoti Ghosh /*@
28209be3e283SDebojyoti Ghosh   TSPostStage - Runs the user-defined post-stage function set using TSSetPostStage()
28219be3e283SDebojyoti Ghosh 
28229be3e283SDebojyoti Ghosh   Collective on TS
28239be3e283SDebojyoti Ghosh 
28249be3e283SDebojyoti Ghosh   Input Parameters:
28259be3e283SDebojyoti Ghosh . ts          - The TS context obtained from TSCreate()
28269be3e283SDebojyoti Ghosh   stagetime   - The absolute time of the current stage
28279be3e283SDebojyoti Ghosh   stageindex  - Stage number
28289be3e283SDebojyoti Ghosh   Y           - Array of vectors (of size = total number
28299be3e283SDebojyoti Ghosh                 of stages) with the stage solutions
28309be3e283SDebojyoti Ghosh 
28319be3e283SDebojyoti Ghosh   Notes:
28329be3e283SDebojyoti Ghosh   TSPostStage() is typically used within time stepping implementations,
28339be3e283SDebojyoti Ghosh   most users would not generally call this routine themselves.
28349be3e283SDebojyoti Ghosh 
28359be3e283SDebojyoti Ghosh   Level: developer
28369be3e283SDebojyoti Ghosh 
28379be3e283SDebojyoti Ghosh .keywords: TS, timestep
28389be3e283SDebojyoti Ghosh .seealso: TSPreStage(), TSSetPreStep(), TSPreStep(), TSPostStep()
28399be3e283SDebojyoti Ghosh @*/
28409be3e283SDebojyoti Ghosh PetscErrorCode  TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
28419be3e283SDebojyoti Ghosh {
28429be3e283SDebojyoti Ghosh   PetscErrorCode ierr;
28439be3e283SDebojyoti Ghosh 
28449be3e283SDebojyoti Ghosh   PetscFunctionBegin;
28459be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
28464beae5d8SLisandro Dalcin   if (ts->poststage) {
28479be3e283SDebojyoti Ghosh     PetscStackCallStandard((*ts->poststage),(ts,stagetime,stageindex,Y));
28489be3e283SDebojyoti Ghosh   }
28499be3e283SDebojyoti Ghosh   PetscFunctionReturn(0);
28509be3e283SDebojyoti Ghosh }
28519be3e283SDebojyoti Ghosh 
28529be3e283SDebojyoti Ghosh #undef __FUNCT__
2853e74ef692SMatthew Knepley #define __FUNCT__ "TSSetPostStep"
2854ac226902SBarry Smith /*@C
2855000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
28563f2090d5SJed Brown   called once at the end of each time step.
2857000e7ae3SMatthew Knepley 
28583f9fe445SBarry Smith   Logically Collective on TS
2859000e7ae3SMatthew Knepley 
2860000e7ae3SMatthew Knepley   Input Parameters:
2861000e7ae3SMatthew Knepley + ts   - The TS context obtained from TSCreate()
2862000e7ae3SMatthew Knepley - func - The function
2863000e7ae3SMatthew Knepley 
2864000e7ae3SMatthew Knepley   Calling sequence of func:
2865b8123daeSJed Brown $ func (TS ts);
2866000e7ae3SMatthew Knepley 
2867000e7ae3SMatthew Knepley   Level: intermediate
2868000e7ae3SMatthew Knepley 
2869000e7ae3SMatthew Knepley .keywords: TS, timestep
2870b8123daeSJed Brown .seealso: TSSetPreStep(), TSSetPreStage(), TSGetTimeStep(), TSGetTimeStepNumber(), TSGetTime()
2871000e7ae3SMatthew Knepley @*/
28727087cfbeSBarry Smith PetscErrorCode  TSSetPostStep(TS ts, PetscErrorCode (*func)(TS))
2873000e7ae3SMatthew Knepley {
2874000e7ae3SMatthew Knepley   PetscFunctionBegin;
28750700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
2876ae60f76fSBarry Smith   ts->poststep = func;
2877000e7ae3SMatthew Knepley   PetscFunctionReturn(0);
2878000e7ae3SMatthew Knepley }
2879000e7ae3SMatthew Knepley 
2880e74ef692SMatthew Knepley #undef __FUNCT__
28813f2090d5SJed Brown #define __FUNCT__ "TSPostStep"
288209ee8438SJed Brown /*@
28833f2090d5SJed Brown   TSPostStep - Runs the user-defined post-step function.
28843f2090d5SJed Brown 
28853f2090d5SJed Brown   Collective on TS
28863f2090d5SJed Brown 
28873f2090d5SJed Brown   Input Parameters:
28883f2090d5SJed Brown . ts   - The TS context obtained from TSCreate()
28893f2090d5SJed Brown 
28903f2090d5SJed Brown   Notes:
28913f2090d5SJed Brown   TSPostStep() is typically used within time stepping implementations,
28923f2090d5SJed Brown   so most users would not generally call this routine themselves.
28933f2090d5SJed Brown 
28943f2090d5SJed Brown   Level: developer
28953f2090d5SJed Brown 
28963f2090d5SJed Brown .keywords: TS, timestep
28973f2090d5SJed Brown @*/
28987087cfbeSBarry Smith PetscErrorCode  TSPostStep(TS ts)
28993f2090d5SJed Brown {
29003f2090d5SJed Brown   PetscErrorCode ierr;
29013f2090d5SJed Brown 
29023f2090d5SJed Brown   PetscFunctionBegin;
29030700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2904ae60f76fSBarry Smith   if (ts->poststep) {
2905ae60f76fSBarry Smith     PetscStackCallStandard((*ts->poststep),(ts));
290672ac3e02SJed Brown   }
29073f2090d5SJed Brown   PetscFunctionReturn(0);
29083f2090d5SJed Brown }
29093f2090d5SJed Brown 
2910d763cef2SBarry Smith /* ------------ Routines to set performance monitoring options ----------- */
2911d763cef2SBarry Smith 
29124a2ae208SSatish Balay #undef __FUNCT__
2913a6570f20SBarry Smith #define __FUNCT__ "TSMonitorSet"
2914d763cef2SBarry Smith /*@C
2915a6570f20SBarry Smith    TSMonitorSet - Sets an ADDITIONAL function that is to be used at every
2916d763cef2SBarry Smith    timestep to display the iteration's  progress.
2917d763cef2SBarry Smith 
29183f9fe445SBarry Smith    Logically Collective on TS
2919d763cef2SBarry Smith 
2920d763cef2SBarry Smith    Input Parameters:
2921d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
2922e213d8f1SJed Brown .  monitor - monitoring routine
2923329f5518SBarry Smith .  mctx - [optional] user-defined context for private data for the
29240298fd71SBarry Smith              monitor routine (use NULL if no context is desired)
2925b3006f0bSLois Curfman McInnes -  monitordestroy - [optional] routine that frees monitor context
29260298fd71SBarry Smith           (may be NULL)
2927d763cef2SBarry Smith 
2928e213d8f1SJed Brown    Calling sequence of monitor:
29290910c330SBarry Smith $    int monitor(TS ts,PetscInt steps,PetscReal time,Vec u,void *mctx)
2930d763cef2SBarry Smith 
2931d763cef2SBarry Smith +    ts - the TS context
293288c05cc5SBarry 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
293388c05cc5SBarry Smith                                been interpolated to)
29341f06c33eSBarry Smith .    time - current time
29350910c330SBarry Smith .    u - current iterate
2936d763cef2SBarry Smith -    mctx - [optional] monitoring context
2937d763cef2SBarry Smith 
2938d763cef2SBarry Smith    Notes:
2939d763cef2SBarry Smith    This routine adds an additional monitor to the list of monitors that
2940d763cef2SBarry Smith    already has been loaded.
2941d763cef2SBarry Smith 
2942025f1a04SBarry Smith    Fortran notes: Only a single monitor function can be set for each TS object
2943025f1a04SBarry Smith 
2944d763cef2SBarry Smith    Level: intermediate
2945d763cef2SBarry Smith 
2946d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2947d763cef2SBarry Smith 
2948a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorCancel()
2949d763cef2SBarry Smith @*/
2950c2efdce3SBarry Smith PetscErrorCode  TSMonitorSet(TS ts,PetscErrorCode (*monitor)(TS,PetscInt,PetscReal,Vec,void*),void *mctx,PetscErrorCode (*mdestroy)(void**))
2951d763cef2SBarry Smith {
2952d763cef2SBarry Smith   PetscFunctionBegin;
29530700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
295417186662SBarry Smith   if (ts->numbermonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many monitors set");
2955d763cef2SBarry Smith   ts->monitor[ts->numbermonitors]          = monitor;
29568704b422SBarry Smith   ts->monitordestroy[ts->numbermonitors]   = mdestroy;
2957d763cef2SBarry Smith   ts->monitorcontext[ts->numbermonitors++] = (void*)mctx;
2958d763cef2SBarry Smith   PetscFunctionReturn(0);
2959d763cef2SBarry Smith }
2960d763cef2SBarry Smith 
29614a2ae208SSatish Balay #undef __FUNCT__
2962a6570f20SBarry Smith #define __FUNCT__ "TSMonitorCancel"
2963d763cef2SBarry Smith /*@C
2964a6570f20SBarry Smith    TSMonitorCancel - Clears all the monitors that have been set on a time-step object.
2965d763cef2SBarry Smith 
29663f9fe445SBarry Smith    Logically Collective on TS
2967d763cef2SBarry Smith 
2968d763cef2SBarry Smith    Input Parameters:
2969d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
2970d763cef2SBarry Smith 
2971d763cef2SBarry Smith    Notes:
2972d763cef2SBarry Smith    There is no way to remove a single, specific monitor.
2973d763cef2SBarry Smith 
2974d763cef2SBarry Smith    Level: intermediate
2975d763cef2SBarry Smith 
2976d763cef2SBarry Smith .keywords: TS, timestep, set, monitor
2977d763cef2SBarry Smith 
2978a6570f20SBarry Smith .seealso: TSMonitorDefault(), TSMonitorSet()
2979d763cef2SBarry Smith @*/
29807087cfbeSBarry Smith PetscErrorCode  TSMonitorCancel(TS ts)
2981d763cef2SBarry Smith {
2982d952e501SBarry Smith   PetscErrorCode ierr;
2983d952e501SBarry Smith   PetscInt       i;
2984d952e501SBarry Smith 
2985d763cef2SBarry Smith   PetscFunctionBegin;
29860700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
2987d952e501SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
29888704b422SBarry Smith     if (ts->monitordestroy[i]) {
29898704b422SBarry Smith       ierr = (*ts->monitordestroy[i])(&ts->monitorcontext[i]);CHKERRQ(ierr);
2990d952e501SBarry Smith     }
2991d952e501SBarry Smith   }
2992d763cef2SBarry Smith   ts->numbermonitors = 0;
2993d763cef2SBarry Smith   PetscFunctionReturn(0);
2994d763cef2SBarry Smith }
2995d763cef2SBarry Smith 
29964a2ae208SSatish Balay #undef __FUNCT__
2997a6570f20SBarry Smith #define __FUNCT__ "TSMonitorDefault"
2998d8e5e3e6SSatish Balay /*@
2999a6570f20SBarry Smith    TSMonitorDefault - Sets the Default monitor
30005516499fSSatish Balay 
30015516499fSSatish Balay    Level: intermediate
300241251cbbSSatish Balay 
30035516499fSSatish Balay .keywords: TS, set, monitor
30045516499fSSatish Balay 
300541251cbbSSatish Balay .seealso: TSMonitorDefault(), TSMonitorSet()
300641251cbbSSatish Balay @*/
3007649052a6SBarry Smith PetscErrorCode TSMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,void *dummy)
3008d763cef2SBarry Smith {
3009dfbe8321SBarry Smith   PetscErrorCode ierr;
30104d4332d5SBarry Smith   PetscViewer    viewer =  (PetscViewer) dummy;
3011d132466eSBarry Smith 
3012d763cef2SBarry Smith   PetscFunctionBegin;
30134d4332d5SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3014649052a6SBarry Smith   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
30158392e04aSShri 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);
3016649052a6SBarry Smith   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3017d763cef2SBarry Smith   PetscFunctionReturn(0);
3018d763cef2SBarry Smith }
3019d763cef2SBarry Smith 
30204a2ae208SSatish Balay #undef __FUNCT__
30219110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorSet"
30229110b2e7SHong Zhang /*@C
30239110b2e7SHong Zhang    TSAdjointMonitorSet - Sets an ADDITIONAL function that is to be used at every
30249110b2e7SHong Zhang    timestep to display the iteration's  progress.
30259110b2e7SHong Zhang 
30269110b2e7SHong Zhang    Logically Collective on TS
30279110b2e7SHong Zhang 
30289110b2e7SHong Zhang    Input Parameters:
30299110b2e7SHong Zhang +  ts - the TS context obtained from TSCreate()
30309110b2e7SHong Zhang .  adjointmonitor - monitoring routine
30319110b2e7SHong Zhang .  adjointmctx - [optional] user-defined context for private data for the
30329110b2e7SHong Zhang              monitor routine (use NULL if no context is desired)
30339110b2e7SHong Zhang -  adjointmonitordestroy - [optional] routine that frees monitor context
30349110b2e7SHong Zhang           (may be NULL)
30359110b2e7SHong Zhang 
30369110b2e7SHong Zhang    Calling sequence of monitor:
30379110b2e7SHong Zhang $    int adjointmonitor(TS ts,PetscInt steps,PetscReal time,Vec u,PetscInt numcost,Vec *lambda, Vec *mu,void *adjointmctx)
30389110b2e7SHong Zhang 
30399110b2e7SHong Zhang +    ts - the TS context
30409110b2e7SHong Zhang .    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
30419110b2e7SHong Zhang                                been interpolated to)
30429110b2e7SHong Zhang .    time - current time
30439110b2e7SHong Zhang .    u - current iterate
30449110b2e7SHong Zhang .    numcost - number of cost functionos
30459110b2e7SHong Zhang .    lambda - sensitivities to initial conditions
30469110b2e7SHong Zhang .    mu - sensitivities to parameters
30479110b2e7SHong Zhang -    adjointmctx - [optional] adjoint monitoring context
30489110b2e7SHong Zhang 
30499110b2e7SHong Zhang    Notes:
30509110b2e7SHong Zhang    This routine adds an additional monitor to the list of monitors that
30519110b2e7SHong Zhang    already has been loaded.
30529110b2e7SHong Zhang 
30539110b2e7SHong Zhang    Fortran notes: Only a single monitor function can be set for each TS object
30549110b2e7SHong Zhang 
30559110b2e7SHong Zhang    Level: intermediate
30569110b2e7SHong Zhang 
30579110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
30589110b2e7SHong Zhang 
30599110b2e7SHong Zhang .seealso: TSAdjointMonitorCancel()
30609110b2e7SHong Zhang @*/
30619110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorSet(TS ts,PetscErrorCode (*adjointmonitor)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *adjointmctx,PetscErrorCode (*adjointmdestroy)(void**))
30629110b2e7SHong Zhang {
30639110b2e7SHong Zhang   PetscFunctionBegin;
30649110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30659110b2e7SHong Zhang   if (ts->numberadjointmonitors >= MAXTSMONITORS) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many adjoint monitors set");
30669110b2e7SHong Zhang   ts->adjointmonitor[ts->numberadjointmonitors]          = adjointmonitor;
30679110b2e7SHong Zhang   ts->adjointmonitordestroy[ts->numberadjointmonitors]   = adjointmdestroy;
30689110b2e7SHong Zhang   ts->adjointmonitorcontext[ts->numberadjointmonitors++] = (void*)adjointmctx;
30699110b2e7SHong Zhang   PetscFunctionReturn(0);
30709110b2e7SHong Zhang }
30719110b2e7SHong Zhang 
30729110b2e7SHong Zhang #undef __FUNCT__
30739110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorCancel"
30749110b2e7SHong Zhang /*@C
30759110b2e7SHong Zhang    TSAdjointMonitorCancel - Clears all the adjoint monitors that have been set on a time-step object.
30769110b2e7SHong Zhang 
30779110b2e7SHong Zhang    Logically Collective on TS
30789110b2e7SHong Zhang 
30799110b2e7SHong Zhang    Input Parameters:
30809110b2e7SHong Zhang .  ts - the TS context obtained from TSCreate()
30819110b2e7SHong Zhang 
30829110b2e7SHong Zhang    Notes:
30839110b2e7SHong Zhang    There is no way to remove a single, specific monitor.
30849110b2e7SHong Zhang 
30859110b2e7SHong Zhang    Level: intermediate
30869110b2e7SHong Zhang 
30879110b2e7SHong Zhang .keywords: TS, timestep, set, adjoint, monitor
30889110b2e7SHong Zhang 
30899110b2e7SHong Zhang .seealso: TSAdjointMonitorSet()
30909110b2e7SHong Zhang @*/
30919110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorCancel(TS ts)
30929110b2e7SHong Zhang {
30939110b2e7SHong Zhang   PetscErrorCode ierr;
30949110b2e7SHong Zhang   PetscInt       i;
30959110b2e7SHong Zhang 
30969110b2e7SHong Zhang   PetscFunctionBegin;
30979110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
30989110b2e7SHong Zhang   for (i=0; i<ts->numberadjointmonitors; i++) {
30999110b2e7SHong Zhang     if (ts->adjointmonitordestroy[i]) {
31009110b2e7SHong Zhang       ierr = (*ts->adjointmonitordestroy[i])(&ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
31019110b2e7SHong Zhang     }
31029110b2e7SHong Zhang   }
31039110b2e7SHong Zhang   ts->numberadjointmonitors = 0;
31049110b2e7SHong Zhang   PetscFunctionReturn(0);
31059110b2e7SHong Zhang }
31069110b2e7SHong Zhang 
31079110b2e7SHong Zhang #undef __FUNCT__
3108110eb670SHong Zhang #define __FUNCT__ "TSAdjointMonitorDefault"
3109110eb670SHong Zhang /*@
3110110eb670SHong Zhang    TSAdjointMonitorDefault - Sets the Default monitor
3111110eb670SHong Zhang 
3112110eb670SHong Zhang    Level: intermediate
3113110eb670SHong Zhang 
3114110eb670SHong Zhang .keywords: TS, set, monitor
3115110eb670SHong Zhang 
3116110eb670SHong Zhang .seealso: TSAdjointMonitorSet()
3117110eb670SHong Zhang @*/
3118110eb670SHong Zhang PetscErrorCode TSAdjointMonitorDefault(TS ts,PetscInt step,PetscReal ptime,Vec v,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
3119110eb670SHong Zhang {
3120110eb670SHong Zhang   PetscErrorCode ierr;
3121110eb670SHong Zhang   PetscViewer    viewer =  (PetscViewer) dummy;
3122110eb670SHong Zhang 
3123110eb670SHong Zhang   PetscFunctionBegin;
3124110eb670SHong Zhang   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,4);
3125110eb670SHong Zhang   ierr = PetscViewerASCIIAddTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3126110eb670SHong Zhang   ierr = PetscViewerASCIIPrintf(viewer,"%D TS dt %g time %g%s",step,(double)ts->time_step,(double)ptime,ts->steprollback ? " (r)\n" : "\n");CHKERRQ(ierr);
3127110eb670SHong Zhang   ierr = PetscViewerASCIISubtractTab(viewer,((PetscObject)ts)->tablevel);CHKERRQ(ierr);
3128110eb670SHong Zhang   PetscFunctionReturn(0);
3129110eb670SHong Zhang }
3130110eb670SHong Zhang 
3131110eb670SHong Zhang #undef __FUNCT__
3132cd652676SJed Brown #define __FUNCT__ "TSSetRetainStages"
3133cd652676SJed Brown /*@
3134cd652676SJed Brown    TSSetRetainStages - Request that all stages in the upcoming step be stored so that interpolation will be available.
3135cd652676SJed Brown 
3136cd652676SJed Brown    Logically Collective on TS
3137cd652676SJed Brown 
3138cd652676SJed Brown    Input Argument:
3139cd652676SJed Brown .  ts - time stepping context
3140cd652676SJed Brown 
3141cd652676SJed Brown    Output Argument:
3142cd652676SJed Brown .  flg - PETSC_TRUE or PETSC_FALSE
3143cd652676SJed Brown 
3144cd652676SJed Brown    Level: intermediate
3145cd652676SJed Brown 
3146cd652676SJed Brown .keywords: TS, set
3147cd652676SJed Brown 
3148cd652676SJed Brown .seealso: TSInterpolate(), TSSetPostStep()
3149cd652676SJed Brown @*/
3150cd652676SJed Brown PetscErrorCode TSSetRetainStages(TS ts,PetscBool flg)
3151cd652676SJed Brown {
3152cd652676SJed Brown   PetscFunctionBegin;
3153cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3154cd652676SJed Brown   ts->retain_stages = flg;
3155cd652676SJed Brown   PetscFunctionReturn(0);
3156cd652676SJed Brown }
3157cd652676SJed Brown 
3158cd652676SJed Brown #undef __FUNCT__
3159cd652676SJed Brown #define __FUNCT__ "TSInterpolate"
3160cd652676SJed Brown /*@
3161cd652676SJed Brown    TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3162cd652676SJed Brown 
3163cd652676SJed Brown    Collective on TS
3164cd652676SJed Brown 
3165cd652676SJed Brown    Input Argument:
3166cd652676SJed Brown +  ts - time stepping context
3167cd652676SJed Brown -  t - time to interpolate to
3168cd652676SJed Brown 
3169cd652676SJed Brown    Output Argument:
31700910c330SBarry Smith .  U - state at given time
3171cd652676SJed Brown 
3172cd652676SJed Brown    Notes:
3173cd652676SJed Brown    The user should call TSSetRetainStages() before taking a step in which interpolation will be requested.
3174cd652676SJed Brown 
3175cd652676SJed Brown    Level: intermediate
3176cd652676SJed Brown 
3177cd652676SJed Brown    Developer Notes:
3178cd652676SJed Brown    TSInterpolate() and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3179cd652676SJed Brown 
3180cd652676SJed Brown .keywords: TS, set
3181cd652676SJed Brown 
3182cd652676SJed Brown .seealso: TSSetRetainStages(), TSSetPostStep()
3183cd652676SJed Brown @*/
31840910c330SBarry Smith PetscErrorCode TSInterpolate(TS ts,PetscReal t,Vec U)
3185cd652676SJed Brown {
3186cd652676SJed Brown   PetscErrorCode ierr;
3187cd652676SJed Brown 
3188cd652676SJed Brown   PetscFunctionBegin;
3189cd652676SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3190b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
31916712e2f1SBarry 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);
3192ce94432eSBarry Smith   if (!ts->ops->interpolate) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"%s does not provide interpolation",((PetscObject)ts)->type_name);
31930910c330SBarry Smith   ierr = (*ts->ops->interpolate)(ts,t,U);CHKERRQ(ierr);
3194cd652676SJed Brown   PetscFunctionReturn(0);
3195cd652676SJed Brown }
3196cd652676SJed Brown 
3197cd652676SJed Brown #undef __FUNCT__
31984a2ae208SSatish Balay #define __FUNCT__ "TSStep"
3199d763cef2SBarry Smith /*@
32006d9e5789SSean Farley    TSStep - Steps one time step
3201d763cef2SBarry Smith 
3202d763cef2SBarry Smith    Collective on TS
3203d763cef2SBarry Smith 
3204d763cef2SBarry Smith    Input Parameter:
3205d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3206d763cef2SBarry Smith 
320727829d71SBarry Smith    Level: developer
3208d763cef2SBarry Smith 
3209b8123daeSJed Brown    Notes:
321027829d71SBarry Smith    The public interface for the ODE/DAE solvers is TSSolve(), you should almost for sure be using that routine and not this routine.
321127829d71SBarry Smith 
3212b8123daeSJed Brown    The hook set using TSSetPreStep() is called before each attempt to take the step. In general, the time step size may
3213b8123daeSJed Brown    be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3214b8123daeSJed Brown 
321525cb2221SBarry Smith    This may over-step the final time provided in TSSetDuration() depending on the time-step used. TSSolve() interpolates to exactly the
321625cb2221SBarry Smith    time provided in TSSetDuration(). One can use TSInterpolate() to determine an interpolated solution within the final timestep.
321725cb2221SBarry Smith 
3218d763cef2SBarry Smith .keywords: TS, timestep, solve
3219d763cef2SBarry Smith 
32209be3e283SDebojyoti Ghosh .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSSetPostStage(), TSInterpolate()
3221d763cef2SBarry Smith @*/
3222193ac0bcSJed Brown PetscErrorCode  TSStep(TS ts)
3223d763cef2SBarry Smith {
32242fb8446cSMatthew G. Knepley   DM               dm;
3225dfbe8321SBarry Smith   PetscErrorCode   ierr;
3226fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3227d763cef2SBarry Smith 
3228d763cef2SBarry Smith   PetscFunctionBegin;
32290700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
3230fffbeea8SBarry Smith   ierr = PetscCitationsRegister("@techreport{tspaper,\n"
3231fffbeea8SBarry Smith                                 "  title       = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3232fffbeea8SBarry Smith                                 "  author      = {Shrirang Abhyankar and Jed Brown and Emil Constantinescu and Debojyoti Ghosh and Barry F. Smith},\n"
3233fffbeea8SBarry Smith                                 "  type        = {Preprint},\n"
3234fffbeea8SBarry Smith                                 "  number      = {ANL/MCS-P5061-0114},\n"
3235fffbeea8SBarry Smith                                 "  institution = {Argonne National Laboratory},\n"
3236302440fdSBarry Smith                                 "  year        = {2014}\n}\n",&cite);CHKERRQ(ierr);
3237fffbeea8SBarry Smith 
32382fb8446cSMatthew G. Knepley   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3239d405a339SMatthew Knepley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3240*68bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3241d405a339SMatthew Knepley 
3242362cd11cSLisandro Dalcin   ts->reason = TS_CONVERGED_ITERATING;
324324655328SShri   ts->ptime_prev = ts->ptime;
3244cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3245bbd56ea5SKarl Rupp 
3246e04979a6SLisandro Dalcin   if (!ts->ops->step) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSStep not implemented for type '%s'",((PetscObject)ts)->type_name);
3247d5ba7fb7SMatthew Knepley   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3248193ac0bcSJed Brown   ierr = (*ts->ops->step)(ts);CHKERRQ(ierr);
3249d5ba7fb7SMatthew Knepley   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3250bbd56ea5SKarl Rupp 
325124655328SShri   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3252cdb7a50dSMatthew G. Knepley   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3253362cd11cSLisandro Dalcin 
3254362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3255cef5090cSJed Brown     if (ts->errorifstepfailed) {
325608c7845fSBarry 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]);
325708c7845fSBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3258d2daff3dSHong Zhang     }
325908c7845fSBarry Smith   } else if (!ts->reason) {
326008c7845fSBarry Smith     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
326108c7845fSBarry Smith     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
326208c7845fSBarry Smith   }
32632c18e0fdSBarry Smith   ts->total_steps++;
32648392e04aSShri Abhyankar   ts->steprollback = PETSC_FALSE;
326508c7845fSBarry Smith   PetscFunctionReturn(0);
326608c7845fSBarry Smith }
326708c7845fSBarry Smith 
326808c7845fSBarry Smith #undef __FUNCT__
326908c7845fSBarry Smith #define __FUNCT__ "TSAdjointStep"
327008c7845fSBarry Smith /*@
3271b957a604SHong Zhang    TSAdjointStep - Steps one time step backward in the adjoint run
327208c7845fSBarry Smith 
327308c7845fSBarry Smith    Collective on TS
327408c7845fSBarry Smith 
327508c7845fSBarry Smith    Input Parameter:
327608c7845fSBarry Smith .  ts - the TS context obtained from TSCreate()
327708c7845fSBarry Smith 
32786a4d4014SLisandro Dalcin    Level: intermediate
32796a4d4014SLisandro Dalcin 
3280b957a604SHong Zhang .keywords: TS, adjoint, step
32816a4d4014SLisandro Dalcin 
3282b957a604SHong Zhang .seealso: TSAdjointSetUp(), TSAdjointSolve()
32836a4d4014SLisandro Dalcin @*/
328408c7845fSBarry Smith PetscErrorCode  TSAdjointStep(TS ts)
32856a4d4014SLisandro Dalcin {
328608c7845fSBarry Smith   DM               dm;
32876a4d4014SLisandro Dalcin   PetscErrorCode   ierr;
32886a4d4014SLisandro Dalcin 
32896a4d4014SLisandro Dalcin   PetscFunctionBegin;
32904a2ae208SSatish Balay   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
329108c7845fSBarry Smith   ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
329208c7845fSBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3293d763cef2SBarry Smith 
3294d763cef2SBarry Smith   ts->reason = TS_CONVERGED_ITERATING;
329508c7845fSBarry Smith   ts->ptime_prev = ts->ptime;
329608c7845fSBarry Smith   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3297685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vec_sol,(PetscObject)ts, "-ts_view_solution");CHKERRQ(ierr);
3298d763cef2SBarry Smith 
32996849ba73SBarry Smith   ierr = PetscLogEventBegin(TS_Step,ts,0,0,0);CHKERRQ(ierr);
330042f2b339SBarry 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);
330142f2b339SBarry Smith   ierr = (*ts->ops->adjointstep)(ts);CHKERRQ(ierr);
3302a6570f20SBarry Smith   ierr = PetscLogEventEnd(TS_Step,ts,0,0,0);CHKERRQ(ierr);
3303d763cef2SBarry Smith 
3304cef5090cSJed Brown   ts->time_step_prev = ts->ptime - ts->ptime_prev;
3305cef5090cSJed Brown   ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3306362cd11cSLisandro Dalcin 
3307362cd11cSLisandro Dalcin   if (ts->reason < 0) {
3308cef5090cSJed Brown     if (ts->errorifstepfailed) {
33096c4ed002SBarry 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]);
33106c4ed002SBarry Smith       else if (ts->reason == TS_DIVERGED_STEP_REJECTED) 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]);
33116c4ed002SBarry Smith       else SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_NOT_CONVERGED,"TSStep has failed due to %s",TSConvergedReasons[ts->reason]);
3312cef5090cSJed Brown     }
3313362cd11cSLisandro Dalcin   } else if (!ts->reason) {
331473b18844SBarry Smith     if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3315db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time)         ts->reason = TS_CONVERGED_TIME;
3316362cd11cSLisandro Dalcin   }
33172c18e0fdSBarry Smith   ts->total_steps--;
3318d763cef2SBarry Smith   PetscFunctionReturn(0);
3319d763cef2SBarry Smith }
3320d763cef2SBarry Smith 
3321d763cef2SBarry Smith #undef __FUNCT__
332205175c85SJed Brown #define __FUNCT__ "TSEvaluateStep"
332305175c85SJed Brown /*@
332405175c85SJed Brown    TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
332505175c85SJed Brown 
33261c3436cfSJed Brown    Collective on TS
332705175c85SJed Brown 
332805175c85SJed Brown    Input Arguments:
33291c3436cfSJed Brown +  ts - time stepping context
33301c3436cfSJed Brown .  order - desired order of accuracy
33310298fd71SBarry Smith -  done - whether the step was evaluated at this order (pass NULL to generate an error if not available)
333205175c85SJed Brown 
333305175c85SJed Brown    Output Arguments:
33340910c330SBarry Smith .  U - state at the end of the current step
333505175c85SJed Brown 
333605175c85SJed Brown    Level: advanced
333705175c85SJed Brown 
3338108c343cSJed Brown    Notes:
3339108c343cSJed Brown    This function cannot be called until all stages have been evaluated.
3340108c343cSJed 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.
3341108c343cSJed Brown 
33421c3436cfSJed Brown .seealso: TSStep(), TSAdapt
334305175c85SJed Brown @*/
33440910c330SBarry Smith PetscErrorCode TSEvaluateStep(TS ts,PetscInt order,Vec U,PetscBool *done)
334505175c85SJed Brown {
334605175c85SJed Brown   PetscErrorCode ierr;
334705175c85SJed Brown 
334805175c85SJed Brown   PetscFunctionBegin;
334905175c85SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
335005175c85SJed Brown   PetscValidType(ts,1);
33510910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,3);
3352ce94432eSBarry Smith   if (!ts->ops->evaluatestep) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSEvaluateStep not implemented for type '%s'",((PetscObject)ts)->type_name);
33530910c330SBarry Smith   ierr = (*ts->ops->evaluatestep)(ts,order,U,done);CHKERRQ(ierr);
335405175c85SJed Brown   PetscFunctionReturn(0);
335505175c85SJed Brown }
335605175c85SJed Brown 
3357d67e68b7SBarry Smith 
335805175c85SJed Brown #undef __FUNCT__
3359d763cef2SBarry Smith #define __FUNCT__ "TSSolve"
3360d763cef2SBarry Smith /*@
3361d763cef2SBarry Smith    TSSolve - Steps the requested number of timesteps.
3362d763cef2SBarry Smith 
3363d763cef2SBarry Smith    Collective on TS
3364d763cef2SBarry Smith 
3365d763cef2SBarry Smith    Input Parameter:
3366d763cef2SBarry Smith +  ts - the TS context obtained from TSCreate()
3367cc708dedSBarry Smith -  u - the solution vector  (can be null if TSSetSolution() was used, otherwise must contain the initial conditions)
33685a3a76d0SJed Brown 
3369d763cef2SBarry Smith    Level: beginner
3370d763cef2SBarry Smith 
33715a3a76d0SJed Brown    Notes:
33725a3a76d0SJed Brown    The final time returned by this function may be different from the time of the internally
33735a3a76d0SJed Brown    held state accessible by TSGetSolution() and TSGetTime() because the method may have
33745a3a76d0SJed Brown    stepped over the final time.
33755a3a76d0SJed Brown 
3376d763cef2SBarry Smith .keywords: TS, timestep, solve
3377d763cef2SBarry Smith 
3378d763cef2SBarry Smith .seealso: TSCreate(), TSSetSolution(), TSStep()
3379d763cef2SBarry Smith @*/
3380cc708dedSBarry Smith PetscErrorCode TSSolve(TS ts,Vec u)
3381d763cef2SBarry Smith {
3382b06615a5SLisandro Dalcin   Vec               solution;
3383d763cef2SBarry Smith   PetscErrorCode    ierr;
3384d763cef2SBarry Smith 
3385d763cef2SBarry Smith   PetscFunctionBegin;
3386d763cef2SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3387f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u,VEC_CLASSID,2);
338849354f04SShri 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 */
3389b06615a5SLisandro Dalcin     PetscValidHeaderSpecific(u,VEC_CLASSID,2);
33900910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
3391b06615a5SLisandro Dalcin       ierr = VecDuplicate(u,&solution);CHKERRQ(ierr);
3392b06615a5SLisandro Dalcin       ierr = TSSetSolution(ts,solution);CHKERRQ(ierr);
3393b06615a5SLisandro Dalcin       ierr = VecDestroy(&solution);CHKERRQ(ierr); /* grant ownership */
33945a3a76d0SJed Brown     }
33950910c330SBarry Smith     ierr = VecCopy(u,ts->vec_sol);CHKERRQ(ierr);
3396bbd56ea5SKarl Rupp   } else if (u) {
33970910c330SBarry Smith     ierr = TSSetSolution(ts,u);CHKERRQ(ierr);
33985a3a76d0SJed Brown   }
3399b5d403baSSean Farley   ierr = TSSetUp(ts);CHKERRQ(ierr);
3400*68bece0bSHong Zhang   ierr = TSTrajectorySetUp(ts->trajectory,ts);CHKERRQ(ierr);
3401d763cef2SBarry Smith   /* reset time step and iteration counters */
3402193ac0bcSJed Brown   ts->steps             = 0;
34035ef26d82SJed Brown   ts->ksp_its           = 0;
34045ef26d82SJed Brown   ts->snes_its          = 0;
3405c610991cSLisandro Dalcin   ts->num_snes_failures = 0;
3406c610991cSLisandro Dalcin   ts->reject            = 0;
3407193ac0bcSJed Brown   ts->reason            = TS_CONVERGED_ITERATING;
3408193ac0bcSJed Brown 
3409ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view_pre");CHKERRQ(ierr);
3410ec8db0baSMatthew G. Knepley   {
3411ec8db0baSMatthew G. Knepley     DM dm;
3412ec8db0baSMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
3413ec8db0baSMatthew G. Knepley     ierr = DMSetOutputSequenceNumber(dm, ts->steps, ts->ptime);CHKERRQ(ierr);
3414ec8db0baSMatthew G. Knepley   }
3415f05ece33SBarry Smith 
3416193ac0bcSJed Brown   if (ts->ops->solve) {         /* This private interface is transitional and should be removed when all implementations are updated. */
3417193ac0bcSJed Brown     ierr = (*ts->ops->solve)(ts);CHKERRQ(ierr);
34180910c330SBarry Smith     ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);
3419cc708dedSBarry Smith     ts->solvetime = ts->ptime;
3420193ac0bcSJed Brown   } else {
3421d763cef2SBarry Smith     /* steps the requested number of timesteps. */
3422db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps)     ts->reason = TS_CONVERGED_ITS;
3423db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
3424cdf0de3dSShri Abhyankar     ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
342511b05f00SHong Zhang     if (ts->vec_costintegral) ts->costintegralfwd=PETSC_TRUE;
34266fea3669SShri Abhyankar     if(ts->event) {
34276fea3669SShri Abhyankar       ierr = TSEventMonitorInitialize(ts);CHKERRQ(ierr);
34286fea3669SShri Abhyankar     }
3429e1a7a14fSJed Brown     while (!ts->reason) {
3430193ac0bcSJed Brown       ierr = TSMonitor(ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
3431193ac0bcSJed Brown       ierr = TSStep(ts);CHKERRQ(ierr);
3432aeb4809dSShri Abhyankar       if (ts->event) {
3433aeb4809dSShri Abhyankar 	ierr = TSEventMonitor(ts);CHKERRQ(ierr);
34341eda64f1SShri Abhyankar       }
34358392e04aSShri Abhyankar       if(!ts->steprollback) {
3436cdf0de3dSShri Abhyankar 	ierr = TSTrajectorySet(ts->trajectory,ts,ts->steps,ts->ptime,ts->vec_sol);CHKERRQ(ierr);
34371eda64f1SShri Abhyankar 	ierr = TSPostStep(ts);CHKERRQ(ierr);
3438aeb4809dSShri Abhyankar       }
3439193ac0bcSJed Brown     }
344049354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
34410910c330SBarry Smith       ierr = TSInterpolate(ts,ts->max_time,u);CHKERRQ(ierr);
3442cc708dedSBarry Smith       ts->solvetime = ts->max_time;
3443b06615a5SLisandro Dalcin       solution = u;
34440574a7fbSJed Brown     } else {
3445ad6bc421SBarry Smith       if (u) {ierr = VecCopy(ts->vec_sol,u);CHKERRQ(ierr);}
3446cc708dedSBarry Smith       ts->solvetime = ts->ptime;
3447b06615a5SLisandro Dalcin       solution = ts->vec_sol;
34480574a7fbSJed Brown     }
3449b06615a5SLisandro Dalcin     ierr = TSMonitor(ts,ts->steps,ts->solvetime,solution);CHKERRQ(ierr);
3450685405a1SBarry Smith     ierr = VecViewFromOptions(solution,(PetscObject) ts,"-ts_view_solution");CHKERRQ(ierr);
3451193ac0bcSJed Brown   }
3452d2daff3dSHong Zhang 
3453ce1779c8SBarry Smith   ierr = TSViewFromOptions(ts,NULL,"-ts_view");CHKERRQ(ierr);
3454dc1cb503SEmil Constantinescu   ierr = VecViewFromOptions(ts->vec_sol,NULL,"-ts_view_solution");CHKERRQ(ierr);
345556f85f32SBarry Smith   ierr = PetscObjectSAWsBlock((PetscObject)ts);CHKERRQ(ierr);
3456ef222394SBarry Smith   if (ts->adjoint_solve) {
3457ef222394SBarry Smith     ierr = TSAdjointSolve(ts);CHKERRQ(ierr);
34582b0a91c0SBarry Smith   }
3459d763cef2SBarry Smith   PetscFunctionReturn(0);
3460d763cef2SBarry Smith }
3461d763cef2SBarry Smith 
3462d763cef2SBarry Smith #undef __FUNCT__
3463c88f2d44SBarry Smith #define __FUNCT__ "TSAdjointSolve"
3464c88f2d44SBarry Smith /*@
3465c88f2d44SBarry Smith    TSAdjointSolve - Solves the discrete ajoint problem for an ODE/DAE
3466c88f2d44SBarry Smith 
3467c88f2d44SBarry Smith    Collective on TS
3468c88f2d44SBarry Smith 
3469c88f2d44SBarry Smith    Input Parameter:
34702c39e106SBarry Smith .  ts - the TS context obtained from TSCreate()
3471c88f2d44SBarry Smith 
3472e87fd094SBarry Smith    Options Database:
3473e87fd094SBarry Smith . -ts_adjoint_view_solution <viewerinfo> - views the first gradient with respect to the initial conditions
3474e87fd094SBarry Smith 
3475c88f2d44SBarry Smith    Level: intermediate
3476c88f2d44SBarry Smith 
3477c88f2d44SBarry Smith    Notes:
3478c88f2d44SBarry Smith    This must be called after a call to TSSolve() that solves the forward problem
3479c88f2d44SBarry Smith 
348073b18844SBarry Smith    By default this will integrate back to the initial time, one can use TSAdjointSetSteps() to step back to a later time
348173b18844SBarry Smith 
3482c88f2d44SBarry Smith .keywords: TS, timestep, solve
3483c88f2d44SBarry Smith 
3484b957a604SHong Zhang .seealso: TSCreate(), TSSetCostGradients(), TSSetSolution(), TSAdjointStep()
3485c88f2d44SBarry Smith @*/
34862c39e106SBarry Smith PetscErrorCode TSAdjointSolve(TS ts)
3487c88f2d44SBarry Smith {
3488c88f2d44SBarry Smith   PetscErrorCode    ierr;
3489c88f2d44SBarry Smith 
3490c88f2d44SBarry Smith   PetscFunctionBegin;
3491c88f2d44SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3492c88f2d44SBarry Smith   ierr = TSAdjointSetUp(ts);CHKERRQ(ierr);
3493*68bece0bSHong Zhang 
3494c88f2d44SBarry Smith   /* reset time step and iteration counters */
3495c88f2d44SBarry Smith   ts->steps             = 0;
3496c88f2d44SBarry Smith   ts->ksp_its           = 0;
3497c88f2d44SBarry Smith   ts->snes_its          = 0;
3498c88f2d44SBarry Smith   ts->num_snes_failures = 0;
3499c88f2d44SBarry Smith   ts->reject            = 0;
3500c88f2d44SBarry Smith   ts->reason            = TS_CONVERGED_ITERATING;
3501c88f2d44SBarry Smith 
350273b18844SBarry Smith   if (!ts->adjoint_max_steps) ts->adjoint_max_steps = ts->total_steps;
3503c88f2d44SBarry Smith 
350473b18844SBarry Smith   if (ts->steps >= ts->adjoint_max_steps)     ts->reason = TS_CONVERGED_ITS;
3505c88f2d44SBarry Smith   while (!ts->reason) {
350655c52731SHong Zhang     ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
35079110b2e7SHong Zhang     ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3508c88f2d44SBarry Smith     if (ts->event) {
3509d0578d90SShri Abhyankar       ierr = TSAdjointEventMonitor(ts);CHKERRQ(ierr);
3510d0578d90SShri Abhyankar     }
3511616946c1SHong Zhang     ierr = TSAdjointStep(ts);CHKERRQ(ierr);
3512c88f2d44SBarry Smith   }
351326656371SHong Zhang   ierr = TSTrajectoryGet(ts->trajectory,ts,ts->total_steps,&ts->ptime);CHKERRQ(ierr);
351426656371SHong Zhang   ierr = TSAdjointMonitor(ts,ts->total_steps,ts->ptime,ts->vec_sol,ts->numcost,ts->vecs_sensi,ts->vecs_sensip);CHKERRQ(ierr);
3515c88f2d44SBarry Smith   ts->solvetime = ts->ptime;
3516685405a1SBarry Smith   ierr = VecViewFromOptions(ts->vecs_sensi[0],(PetscObject) ts, "-ts_adjoint_view_solution");CHKERRQ(ierr);
3517c88f2d44SBarry Smith   PetscFunctionReturn(0);
3518c88f2d44SBarry Smith }
3519c88f2d44SBarry Smith 
3520c88f2d44SBarry Smith #undef __FUNCT__
3521d763cef2SBarry Smith #define __FUNCT__ "TSMonitor"
35227db568b7SBarry Smith /*@C
3523228d79bcSJed Brown    TSMonitor - Runs all user-provided monitor routines set using TSMonitorSet()
3524228d79bcSJed Brown 
3525228d79bcSJed Brown    Collective on TS
3526228d79bcSJed Brown 
3527228d79bcSJed Brown    Input Parameters:
3528228d79bcSJed Brown +  ts - time stepping context obtained from TSCreate()
3529228d79bcSJed Brown .  step - step number that has just completed
3530228d79bcSJed Brown .  ptime - model time of the state
35310910c330SBarry Smith -  u - state at the current model time
3532228d79bcSJed Brown 
3533228d79bcSJed Brown    Notes:
35347db568b7SBarry Smith    TSMonitor() is typically used automatically within the time stepping implementations.
35357db568b7SBarry Smith    Users would almost never call this routine directly.
3536228d79bcSJed Brown 
35377db568b7SBarry Smith    Level: developer
3538228d79bcSJed Brown 
3539228d79bcSJed Brown .keywords: TS, timestep
3540228d79bcSJed Brown @*/
35410910c330SBarry Smith PetscErrorCode TSMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u)
3542d763cef2SBarry Smith {
3543d763cef2SBarry Smith   PetscErrorCode ierr;
3544d763cef2SBarry Smith   PetscInt       i,n = ts->numbermonitors;
3545d763cef2SBarry Smith 
3546d763cef2SBarry Smith   PetscFunctionBegin;
3547b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3548b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
35495edff71fSBarry Smith   ierr = VecLockPush(u);CHKERRQ(ierr);
3550d763cef2SBarry Smith   for (i=0; i<n; i++) {
35510910c330SBarry Smith     ierr = (*ts->monitor[i])(ts,step,ptime,u,ts->monitorcontext[i]);CHKERRQ(ierr);
3552d763cef2SBarry Smith   }
35535edff71fSBarry Smith   ierr = VecLockPop(u);CHKERRQ(ierr);
3554d763cef2SBarry Smith   PetscFunctionReturn(0);
3555d763cef2SBarry Smith }
3556d763cef2SBarry Smith 
35579110b2e7SHong Zhang #undef __FUNCT__
35589110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitor"
35597db568b7SBarry Smith /*@C
35609110b2e7SHong Zhang    TSAdjointMonitor - Runs all user-provided adjoint monitor routines set using TSAdjointMonitorSet()
35619110b2e7SHong Zhang 
35629110b2e7SHong Zhang    Collective on TS
35639110b2e7SHong Zhang 
35649110b2e7SHong Zhang    Input Parameters:
35659110b2e7SHong Zhang +  ts - time stepping context obtained from TSCreate()
35669110b2e7SHong Zhang .  step - step number that has just completed
35679110b2e7SHong Zhang .  ptime - model time of the state
35689110b2e7SHong Zhang .  u - state at the current model time
35699110b2e7SHong Zhang .  numcost - number of cost functions (dimension of lambda  or mu)
35709110b2e7SHong Zhang .  lambda - vectors containing the gradients of the cost functions with respect to the ODE/DAE solution variables
35719110b2e7SHong Zhang -  mu - vectors containing the gradients of the cost functions with respect to the problem parameters
35729110b2e7SHong Zhang 
35739110b2e7SHong Zhang    Notes:
35747db568b7SBarry Smith    TSAdjointMonitor() is typically used automatically within the time stepping implementations.
35757db568b7SBarry Smith    Users would almost never call this routine directly.
35769110b2e7SHong Zhang 
35777db568b7SBarry Smith    Level: developer
35789110b2e7SHong Zhang 
35799110b2e7SHong Zhang .keywords: TS, timestep
35809110b2e7SHong Zhang @*/
35819110b2e7SHong Zhang PetscErrorCode TSAdjointMonitor(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda, Vec *mu)
35829110b2e7SHong Zhang {
35839110b2e7SHong Zhang   PetscErrorCode ierr;
35849110b2e7SHong Zhang   PetscInt       i,n = ts->numberadjointmonitors;
35859110b2e7SHong Zhang 
35869110b2e7SHong Zhang   PetscFunctionBegin;
35879110b2e7SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
35889110b2e7SHong Zhang   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
35899110b2e7SHong Zhang   ierr = VecLockPush(u);CHKERRQ(ierr);
35909110b2e7SHong Zhang   for (i=0; i<n; i++) {
35919110b2e7SHong Zhang     ierr = (*ts->adjointmonitor[i])(ts,step,ptime,u,numcost,lambda,mu,ts->adjointmonitorcontext[i]);CHKERRQ(ierr);
35929110b2e7SHong Zhang   }
35939110b2e7SHong Zhang   ierr = VecLockPop(u);CHKERRQ(ierr);
35949110b2e7SHong Zhang   PetscFunctionReturn(0);
35959110b2e7SHong Zhang }
35969110b2e7SHong Zhang 
3597d763cef2SBarry Smith /* ------------------------------------------------------------------------*/
3598d763cef2SBarry Smith #undef __FUNCT__
3599a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxCreate"
3600d763cef2SBarry Smith /*@C
36017db568b7SBarry Smith    TSMonitorLGCtxCreate - Creates a TSMonitorLGCtx context for use with
3602a9f9c1f6SBarry Smith    TS to monitor the solution process graphically in various ways
3603d763cef2SBarry Smith 
3604d763cef2SBarry Smith    Collective on TS
3605d763cef2SBarry Smith 
3606d763cef2SBarry Smith    Input Parameters:
3607d763cef2SBarry Smith +  host - the X display to open, or null for the local machine
3608d763cef2SBarry Smith .  label - the title to put in the title bar
36097c922b88SBarry Smith .  x, y - the screen coordinates of the upper left coordinate of the window
3610a9f9c1f6SBarry Smith .  m, n - the screen width and height in pixels
3611a9f9c1f6SBarry Smith -  howoften - if positive then determines the frequency of the plotting, if -1 then only at the final time
3612d763cef2SBarry Smith 
3613d763cef2SBarry Smith    Output Parameter:
36140b039ecaSBarry Smith .  ctx - the context
3615d763cef2SBarry Smith 
3616d763cef2SBarry Smith    Options Database Key:
36174f09c107SBarry Smith +  -ts_monitor_lg_timestep - automatically sets line graph monitor
36187db568b7SBarry Smith .  -ts_monitor_lg_solution - monitor the solution (or certain values of the solution by calling TSMonitorLGSetDisplayVariables() or TSMonitorLGCtxSetDisplayVariables())
36197db568b7SBarry Smith .  -ts_monitor_lg_error -  monitor the error
36207db568b7SBarry Smith .  -ts_monitor_lg_ksp_iterations - monitor the number of KSP iterations needed for each timestep
36217db568b7SBarry Smith .  -ts_monitor_lg_snes_iterations - monitor the number of SNES iterations needed for each timestep
3622b6fe0379SLisandro Dalcin -  -lg_use_markers <true,false> - mark the data points (at each time step) on the plot; default is true
3623d763cef2SBarry Smith 
3624d763cef2SBarry Smith    Notes:
3625a9f9c1f6SBarry Smith    Use TSMonitorLGCtxDestroy() to destroy.
3626d763cef2SBarry Smith 
36277db568b7SBarry Smith    One can provide a function that transforms the solution before plotting it with TSMonitorLGCtxSetTransform() or TSMonitorLGSetTransform()
36287db568b7SBarry Smith 
36297db568b7SBarry Smith    Many of the functions that control the monitoring have two forms: TSMonitorLGSet/GetXXXX() and TSMonitorLGCtxSet/GetXXXX() the first take a TS object as the
36307db568b7SBarry Smith    first argument (if that TS object does not have a TSMonitorLGCtx associated with it the function call is ignored) and the second takes a TSMonitorLGCtx object
36317db568b7SBarry Smith    as the first argument.
36327db568b7SBarry Smith 
36337db568b7SBarry Smith    One can control the names displayed for each solution or error variable with TSMonitorLGCtxSetVariableNames() or TSMonitorLGSetVariableNames()
36347db568b7SBarry Smith 
36357db568b7SBarry Smith 
3636d763cef2SBarry Smith    Level: intermediate
3637d763cef2SBarry Smith 
36387db568b7SBarry Smith .keywords: TS, monitor, line graph, residual
3639d763cef2SBarry Smith 
36407db568b7SBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError(), TSMonitorDefault(), VecView(),
36417db568b7SBarry Smith            TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
36427db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
36437db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
36447db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
36457c922b88SBarry Smith 
3646d763cef2SBarry Smith @*/
3647a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorLGCtx *ctx)
3648d763cef2SBarry Smith {
36497f52daa2SLisandro Dalcin   PetscDraw      draw;
3650dfbe8321SBarry Smith   PetscErrorCode ierr;
3651d763cef2SBarry Smith 
3652d763cef2SBarry Smith   PetscFunctionBegin;
3653b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
36547f52daa2SLisandro Dalcin   ierr = PetscDrawCreate(comm,host,label,x,y,m,n,&draw);CHKERRQ(ierr);
36557f52daa2SLisandro Dalcin   ierr = PetscDrawSetFromOptions(draw);CHKERRQ(ierr);
36567f52daa2SLisandro Dalcin   ierr = PetscDrawLGCreate(draw,1,&(*ctx)->lg);CHKERRQ(ierr);
3657b6fe0379SLisandro Dalcin   ierr = PetscDrawLGSetUseMarkers((*ctx)->lg,PETSC_TRUE);CHKERRQ(ierr);
3658287de1a7SBarry Smith   ierr = PetscDrawLGSetFromOptions((*ctx)->lg);CHKERRQ(ierr);
36597f52daa2SLisandro Dalcin   ierr = PetscDrawDestroy(&draw);CHKERRQ(ierr);
3660a9f9c1f6SBarry Smith   (*ctx)->howoften = howoften;
3661d763cef2SBarry Smith   PetscFunctionReturn(0);
3662d763cef2SBarry Smith }
3663d763cef2SBarry Smith 
36644a2ae208SSatish Balay #undef __FUNCT__
36654f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGTimeStep"
3666b06615a5SLisandro Dalcin PetscErrorCode TSMonitorLGTimeStep(TS ts,PetscInt step,PetscReal ptime,Vec v,void *monctx)
3667d763cef2SBarry Smith {
36680b039ecaSBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
3669c32365f1SBarry Smith   PetscReal      x   = ptime,y;
3670dfbe8321SBarry Smith   PetscErrorCode ierr;
3671d763cef2SBarry Smith 
3672d763cef2SBarry Smith   PetscFunctionBegin;
3673b06615a5SLisandro Dalcin   if (!step) {
3674a9f9c1f6SBarry Smith     PetscDrawAxis axis;
3675a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
3676a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Timestep as function of time","Time","Time step");CHKERRQ(ierr);
3677a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
3678a9f9c1f6SBarry Smith   }
3679c32365f1SBarry Smith   ierr = TSGetTimeStep(ts,&y);CHKERRQ(ierr);
36800b039ecaSBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
3681b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
36820b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
36833923b477SBarry Smith   }
3684d763cef2SBarry Smith   PetscFunctionReturn(0);
3685d763cef2SBarry Smith }
3686d763cef2SBarry Smith 
36874a2ae208SSatish Balay #undef __FUNCT__
3688a9f9c1f6SBarry Smith #define __FUNCT__ "TSMonitorLGCtxDestroy"
3689d763cef2SBarry Smith /*@C
3690a9f9c1f6SBarry Smith    TSMonitorLGCtxDestroy - Destroys a line graph context that was created
3691a9f9c1f6SBarry Smith    with TSMonitorLGCtxCreate().
3692d763cef2SBarry Smith 
36930b039ecaSBarry Smith    Collective on TSMonitorLGCtx
3694d763cef2SBarry Smith 
3695d763cef2SBarry Smith    Input Parameter:
36960b039ecaSBarry Smith .  ctx - the monitor context
3697d763cef2SBarry Smith 
3698d763cef2SBarry Smith    Level: intermediate
3699d763cef2SBarry Smith 
3700d763cef2SBarry Smith .keywords: TS, monitor, line graph, destroy
3701d763cef2SBarry Smith 
37024f09c107SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep();
3703d763cef2SBarry Smith @*/
3704a9f9c1f6SBarry Smith PetscErrorCode  TSMonitorLGCtxDestroy(TSMonitorLGCtx *ctx)
3705d763cef2SBarry Smith {
3706dfbe8321SBarry Smith   PetscErrorCode ierr;
3707d763cef2SBarry Smith 
3708d763cef2SBarry Smith   PetscFunctionBegin;
37097684fa3eSBarry Smith   if ((*ctx)->transformdestroy) {
37107684fa3eSBarry Smith     ierr = ((*ctx)->transformdestroy)((*ctx)->transformctx);CHKERRQ(ierr);
37117684fa3eSBarry Smith   }
37120b039ecaSBarry Smith   ierr = PetscDrawLGDestroy(&(*ctx)->lg);CHKERRQ(ierr);
371331152f8aSBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->names);CHKERRQ(ierr);
3714387f4636SBarry Smith   ierr = PetscStrArrayDestroy(&(*ctx)->displaynames);CHKERRQ(ierr);
3715387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvariables);CHKERRQ(ierr);
3716387f4636SBarry Smith   ierr = PetscFree((*ctx)->displayvalues);CHKERRQ(ierr);
37170b039ecaSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
3718d763cef2SBarry Smith   PetscFunctionReturn(0);
3719d763cef2SBarry Smith }
3720d763cef2SBarry Smith 
37214a2ae208SSatish Balay #undef __FUNCT__
37224a2ae208SSatish Balay #define __FUNCT__ "TSGetTime"
3723d763cef2SBarry Smith /*@
3724b8123daeSJed Brown    TSGetTime - Gets the time of the most recently completed step.
3725d763cef2SBarry Smith 
3726d763cef2SBarry Smith    Not Collective
3727d763cef2SBarry Smith 
3728d763cef2SBarry Smith    Input Parameter:
3729d763cef2SBarry Smith .  ts - the TS context obtained from TSCreate()
3730d763cef2SBarry Smith 
3731d763cef2SBarry Smith    Output Parameter:
3732d763cef2SBarry Smith .  t  - the current time
3733d763cef2SBarry Smith 
3734d763cef2SBarry Smith    Level: beginner
3735d763cef2SBarry Smith 
3736b8123daeSJed Brown    Note:
3737b8123daeSJed Brown    When called during time step evaluation (e.g. during residual evaluation or via hooks set using TSSetPreStep(),
37389be3e283SDebojyoti Ghosh    TSSetPreStage(), TSSetPostStage(), or TSSetPostStep()), the time is the time at the start of the step being evaluated.
3739b8123daeSJed Brown 
3740d763cef2SBarry Smith .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3741d763cef2SBarry Smith 
3742d763cef2SBarry Smith .keywords: TS, get, time
3743d763cef2SBarry Smith @*/
37447087cfbeSBarry Smith PetscErrorCode  TSGetTime(TS ts,PetscReal *t)
3745d763cef2SBarry Smith {
3746d763cef2SBarry Smith   PetscFunctionBegin;
37470700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3748f7cf8827SBarry Smith   PetscValidRealPointer(t,2);
3749d763cef2SBarry Smith   *t = ts->ptime;
3750d763cef2SBarry Smith   PetscFunctionReturn(0);
3751d763cef2SBarry Smith }
3752d763cef2SBarry Smith 
37534a2ae208SSatish Balay #undef __FUNCT__
3754e5e524a1SHong Zhang #define __FUNCT__ "TSGetPrevTime"
3755e5e524a1SHong Zhang /*@
3756e5e524a1SHong Zhang    TSGetPrevTime - Gets the starting time of the previously completed step.
3757e5e524a1SHong Zhang 
3758e5e524a1SHong Zhang    Not Collective
3759e5e524a1SHong Zhang 
3760e5e524a1SHong Zhang    Input Parameter:
3761e5e524a1SHong Zhang .  ts - the TS context obtained from TSCreate()
3762e5e524a1SHong Zhang 
3763e5e524a1SHong Zhang    Output Parameter:
3764e5e524a1SHong Zhang .  t  - the previous time
3765e5e524a1SHong Zhang 
3766e5e524a1SHong Zhang    Level: beginner
3767e5e524a1SHong Zhang 
3768e5e524a1SHong Zhang .seealso: TSSetInitialTimeStep(), TSGetTimeStep()
3769e5e524a1SHong Zhang 
3770e5e524a1SHong Zhang .keywords: TS, get, time
3771e5e524a1SHong Zhang @*/
3772e5e524a1SHong Zhang PetscErrorCode  TSGetPrevTime(TS ts,PetscReal *t)
3773e5e524a1SHong Zhang {
3774e5e524a1SHong Zhang   PetscFunctionBegin;
3775e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3776e5e524a1SHong Zhang   PetscValidRealPointer(t,2);
3777e5e524a1SHong Zhang   *t = ts->ptime_prev;
3778e5e524a1SHong Zhang   PetscFunctionReturn(0);
3779e5e524a1SHong Zhang }
3780e5e524a1SHong Zhang 
3781e5e524a1SHong Zhang #undef __FUNCT__
37826a4d4014SLisandro Dalcin #define __FUNCT__ "TSSetTime"
37836a4d4014SLisandro Dalcin /*@
37846a4d4014SLisandro Dalcin    TSSetTime - Allows one to reset the time.
37856a4d4014SLisandro Dalcin 
37863f9fe445SBarry Smith    Logically Collective on TS
37876a4d4014SLisandro Dalcin 
37886a4d4014SLisandro Dalcin    Input Parameters:
37896a4d4014SLisandro Dalcin +  ts - the TS context obtained from TSCreate()
37906a4d4014SLisandro Dalcin -  time - the time
37916a4d4014SLisandro Dalcin 
37926a4d4014SLisandro Dalcin    Level: intermediate
37936a4d4014SLisandro Dalcin 
37946a4d4014SLisandro Dalcin .seealso: TSGetTime(), TSSetDuration()
37956a4d4014SLisandro Dalcin 
37966a4d4014SLisandro Dalcin .keywords: TS, set, time
37976a4d4014SLisandro Dalcin @*/
37987087cfbeSBarry Smith PetscErrorCode  TSSetTime(TS ts, PetscReal t)
37996a4d4014SLisandro Dalcin {
38006a4d4014SLisandro Dalcin   PetscFunctionBegin;
38010700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3802c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts,t,2);
38036a4d4014SLisandro Dalcin   ts->ptime = t;
38046a4d4014SLisandro Dalcin   PetscFunctionReturn(0);
38056a4d4014SLisandro Dalcin }
38066a4d4014SLisandro Dalcin 
38076a4d4014SLisandro Dalcin #undef __FUNCT__
38084a2ae208SSatish Balay #define __FUNCT__ "TSSetOptionsPrefix"
3809d763cef2SBarry Smith /*@C
3810d763cef2SBarry Smith    TSSetOptionsPrefix - Sets the prefix used for searching for all
3811d763cef2SBarry Smith    TS options in the database.
3812d763cef2SBarry Smith 
38133f9fe445SBarry Smith    Logically Collective on TS
3814d763cef2SBarry Smith 
3815d763cef2SBarry Smith    Input Parameter:
3816d763cef2SBarry Smith +  ts     - The TS context
3817d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3818d763cef2SBarry Smith 
3819d763cef2SBarry Smith    Notes:
3820d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3821d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3822d763cef2SBarry Smith    hyphen.
3823d763cef2SBarry Smith 
3824d763cef2SBarry Smith    Level: advanced
3825d763cef2SBarry Smith 
3826d763cef2SBarry Smith .keywords: TS, set, options, prefix, database
3827d763cef2SBarry Smith 
3828d763cef2SBarry Smith .seealso: TSSetFromOptions()
3829d763cef2SBarry Smith 
3830d763cef2SBarry Smith @*/
38317087cfbeSBarry Smith PetscErrorCode  TSSetOptionsPrefix(TS ts,const char prefix[])
3832d763cef2SBarry Smith {
3833dfbe8321SBarry Smith   PetscErrorCode ierr;
3834089b2837SJed Brown   SNES           snes;
3835d763cef2SBarry Smith 
3836d763cef2SBarry Smith   PetscFunctionBegin;
38370700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3838d763cef2SBarry Smith   ierr = PetscObjectSetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3839089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3840089b2837SJed Brown   ierr = SNESSetOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3841d763cef2SBarry Smith   PetscFunctionReturn(0);
3842d763cef2SBarry Smith }
3843d763cef2SBarry Smith 
3844d763cef2SBarry Smith 
38454a2ae208SSatish Balay #undef __FUNCT__
38464a2ae208SSatish Balay #define __FUNCT__ "TSAppendOptionsPrefix"
3847d763cef2SBarry Smith /*@C
3848d763cef2SBarry Smith    TSAppendOptionsPrefix - Appends to the prefix used for searching for all
3849d763cef2SBarry Smith    TS options in the database.
3850d763cef2SBarry Smith 
38513f9fe445SBarry Smith    Logically Collective on TS
3852d763cef2SBarry Smith 
3853d763cef2SBarry Smith    Input Parameter:
3854d763cef2SBarry Smith +  ts     - The TS context
3855d763cef2SBarry Smith -  prefix - The prefix to prepend to all option names
3856d763cef2SBarry Smith 
3857d763cef2SBarry Smith    Notes:
3858d763cef2SBarry Smith    A hyphen (-) must NOT be given at the beginning of the prefix name.
3859d763cef2SBarry Smith    The first character of all runtime options is AUTOMATICALLY the
3860d763cef2SBarry Smith    hyphen.
3861d763cef2SBarry Smith 
3862d763cef2SBarry Smith    Level: advanced
3863d763cef2SBarry Smith 
3864d763cef2SBarry Smith .keywords: TS, append, options, prefix, database
3865d763cef2SBarry Smith 
3866d763cef2SBarry Smith .seealso: TSGetOptionsPrefix()
3867d763cef2SBarry Smith 
3868d763cef2SBarry Smith @*/
38697087cfbeSBarry Smith PetscErrorCode  TSAppendOptionsPrefix(TS ts,const char prefix[])
3870d763cef2SBarry Smith {
3871dfbe8321SBarry Smith   PetscErrorCode ierr;
3872089b2837SJed Brown   SNES           snes;
3873d763cef2SBarry Smith 
3874d763cef2SBarry Smith   PetscFunctionBegin;
38750700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
3876d763cef2SBarry Smith   ierr = PetscObjectAppendOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3877089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3878089b2837SJed Brown   ierr = SNESAppendOptionsPrefix(snes,prefix);CHKERRQ(ierr);
3879d763cef2SBarry Smith   PetscFunctionReturn(0);
3880d763cef2SBarry Smith }
3881d763cef2SBarry Smith 
38824a2ae208SSatish Balay #undef __FUNCT__
38834a2ae208SSatish Balay #define __FUNCT__ "TSGetOptionsPrefix"
3884d763cef2SBarry Smith /*@C
3885d763cef2SBarry Smith    TSGetOptionsPrefix - Sets the prefix used for searching for all
3886d763cef2SBarry Smith    TS options in the database.
3887d763cef2SBarry Smith 
3888d763cef2SBarry Smith    Not Collective
3889d763cef2SBarry Smith 
3890d763cef2SBarry Smith    Input Parameter:
3891d763cef2SBarry Smith .  ts - The TS context
3892d763cef2SBarry Smith 
3893d763cef2SBarry Smith    Output Parameter:
3894d763cef2SBarry Smith .  prefix - A pointer to the prefix string used
3895d763cef2SBarry Smith 
3896d763cef2SBarry Smith    Notes: On the fortran side, the user should pass in a string 'prifix' of
3897d763cef2SBarry Smith    sufficient length to hold the prefix.
3898d763cef2SBarry Smith 
3899d763cef2SBarry Smith    Level: intermediate
3900d763cef2SBarry Smith 
3901d763cef2SBarry Smith .keywords: TS, get, options, prefix, database
3902d763cef2SBarry Smith 
3903d763cef2SBarry Smith .seealso: TSAppendOptionsPrefix()
3904d763cef2SBarry Smith @*/
39057087cfbeSBarry Smith PetscErrorCode  TSGetOptionsPrefix(TS ts,const char *prefix[])
3906d763cef2SBarry Smith {
3907dfbe8321SBarry Smith   PetscErrorCode ierr;
3908d763cef2SBarry Smith 
3909d763cef2SBarry Smith   PetscFunctionBegin;
39100700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
39114482741eSBarry Smith   PetscValidPointer(prefix,2);
3912d763cef2SBarry Smith   ierr = PetscObjectGetOptionsPrefix((PetscObject)ts,prefix);CHKERRQ(ierr);
3913d763cef2SBarry Smith   PetscFunctionReturn(0);
3914d763cef2SBarry Smith }
3915d763cef2SBarry Smith 
39164a2ae208SSatish Balay #undef __FUNCT__
39174a2ae208SSatish Balay #define __FUNCT__ "TSGetRHSJacobian"
3918d763cef2SBarry Smith /*@C
3919d763cef2SBarry Smith    TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
3920d763cef2SBarry Smith 
3921d763cef2SBarry Smith    Not Collective, but parallel objects are returned if TS is parallel
3922d763cef2SBarry Smith 
3923d763cef2SBarry Smith    Input Parameter:
3924d763cef2SBarry Smith .  ts  - The TS context obtained from TSCreate()
3925d763cef2SBarry Smith 
3926d763cef2SBarry Smith    Output Parameters:
3927e4357dc4SBarry Smith +  Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or NULL)
3928e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, usually the same as Amat  (or NULL)
3929e4357dc4SBarry Smith .  func - Function to compute the Jacobian of the RHS  (or NULL)
3930e4357dc4SBarry Smith -  ctx - User-defined context for Jacobian evaluation routine  (or NULL)
3931d763cef2SBarry Smith 
39320298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
3933d763cef2SBarry Smith 
3934d763cef2SBarry Smith    Level: intermediate
3935d763cef2SBarry Smith 
393626d46c62SHong Zhang .seealso: TSGetTimeStep(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
3937d763cef2SBarry Smith 
3938d763cef2SBarry Smith .keywords: TS, timestep, get, matrix, Jacobian
3939d763cef2SBarry Smith @*/
3940e4357dc4SBarry Smith PetscErrorCode  TSGetRHSJacobian(TS ts,Mat *Amat,Mat *Pmat,TSRHSJacobian *func,void **ctx)
3941d763cef2SBarry Smith {
3942089b2837SJed Brown   PetscErrorCode ierr;
3943089b2837SJed Brown   SNES           snes;
394424989b8cSPeter Brune   DM             dm;
3945089b2837SJed Brown 
3946d763cef2SBarry Smith   PetscFunctionBegin;
3947089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3948e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
394924989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
395024989b8cSPeter Brune   ierr = DMTSGetRHSJacobian(dm,func,ctx);CHKERRQ(ierr);
3951d763cef2SBarry Smith   PetscFunctionReturn(0);
3952d763cef2SBarry Smith }
3953d763cef2SBarry Smith 
39541713a123SBarry Smith #undef __FUNCT__
39552eca1d9cSJed Brown #define __FUNCT__ "TSGetIJacobian"
39562eca1d9cSJed Brown /*@C
39572eca1d9cSJed Brown    TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
39582eca1d9cSJed Brown 
39592eca1d9cSJed Brown    Not Collective, but parallel objects are returned if TS is parallel
39602eca1d9cSJed Brown 
39612eca1d9cSJed Brown    Input Parameter:
39622eca1d9cSJed Brown .  ts  - The TS context obtained from TSCreate()
39632eca1d9cSJed Brown 
39642eca1d9cSJed Brown    Output Parameters:
3965e4357dc4SBarry Smith +  Amat  - The (approximate) Jacobian of F(t,U,U_t)
3966e4357dc4SBarry Smith .  Pmat - The matrix from which the preconditioner is constructed, often the same as Amat
39672eca1d9cSJed Brown .  f   - The function to compute the matrices
39682eca1d9cSJed Brown - ctx - User-defined context for Jacobian evaluation routine
39692eca1d9cSJed Brown 
39700298fd71SBarry Smith    Notes: You can pass in NULL for any return argument you do not need.
39712eca1d9cSJed Brown 
39722eca1d9cSJed Brown    Level: advanced
39732eca1d9cSJed Brown 
39742eca1d9cSJed Brown .seealso: TSGetTimeStep(), TSGetRHSJacobian(), TSGetMatrices(), TSGetTime(), TSGetTimeStepNumber()
39752eca1d9cSJed Brown 
39762eca1d9cSJed Brown .keywords: TS, timestep, get, matrix, Jacobian
39772eca1d9cSJed Brown @*/
3978e4357dc4SBarry Smith PetscErrorCode  TSGetIJacobian(TS ts,Mat *Amat,Mat *Pmat,TSIJacobian *f,void **ctx)
39792eca1d9cSJed Brown {
3980089b2837SJed Brown   PetscErrorCode ierr;
3981089b2837SJed Brown   SNES           snes;
398224989b8cSPeter Brune   DM             dm;
39830910c330SBarry Smith 
39842eca1d9cSJed Brown   PetscFunctionBegin;
3985089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
3986f7d39f7aSBarry Smith   ierr = SNESSetUpMatrices(snes);CHKERRQ(ierr);
3987e4357dc4SBarry Smith   ierr = SNESGetJacobian(snes,Amat,Pmat,NULL,NULL);CHKERRQ(ierr);
398824989b8cSPeter Brune   ierr = TSGetDM(ts,&dm);CHKERRQ(ierr);
398924989b8cSPeter Brune   ierr = DMTSGetIJacobian(dm,f,ctx);CHKERRQ(ierr);
39902eca1d9cSJed Brown   PetscFunctionReturn(0);
39912eca1d9cSJed Brown }
39922eca1d9cSJed Brown 
39936083293cSBarry Smith 
39942eca1d9cSJed Brown #undef __FUNCT__
399583a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawSolution"
39961713a123SBarry Smith /*@C
399783a4ac43SBarry Smith    TSMonitorDrawSolution - Monitors progress of the TS solvers by calling
39981713a123SBarry Smith    VecView() for the solution at each timestep
39991713a123SBarry Smith 
40001713a123SBarry Smith    Collective on TS
40011713a123SBarry Smith 
40021713a123SBarry Smith    Input Parameters:
40031713a123SBarry Smith +  ts - the TS context
40041713a123SBarry Smith .  step - current time-step
4005142b95e3SSatish Balay .  ptime - current time
40060298fd71SBarry Smith -  dummy - either a viewer or NULL
40071713a123SBarry Smith 
400899fdda47SBarry Smith    Options Database:
400999fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
401099fdda47SBarry Smith 
4011387f4636SBarry 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
401299fdda47SBarry Smith        will look bad
401399fdda47SBarry Smith 
40141713a123SBarry Smith    Level: intermediate
40151713a123SBarry Smith 
40161713a123SBarry Smith .keywords: TS,  vector, monitor, view
40171713a123SBarry Smith 
4018a6570f20SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
40191713a123SBarry Smith @*/
40200910c330SBarry Smith PetscErrorCode  TSMonitorDrawSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
40211713a123SBarry Smith {
4022dfbe8321SBarry Smith   PetscErrorCode   ierr;
402383a4ac43SBarry Smith   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
4024473a3ab2SBarry Smith   PetscDraw        draw;
40251713a123SBarry Smith 
40261713a123SBarry Smith   PetscFunctionBegin;
40276083293cSBarry Smith   if (!step && ictx->showinitial) {
40286083293cSBarry Smith     if (!ictx->initialsolution) {
40290910c330SBarry Smith       ierr = VecDuplicate(u,&ictx->initialsolution);CHKERRQ(ierr);
40301713a123SBarry Smith     }
40310910c330SBarry Smith     ierr = VecCopy(u,ictx->initialsolution);CHKERRQ(ierr);
40326083293cSBarry Smith   }
4033b06615a5SLisandro Dalcin   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40340dcf80beSBarry Smith 
40356083293cSBarry Smith   if (ictx->showinitial) {
40366083293cSBarry Smith     PetscReal pause;
40376083293cSBarry Smith     ierr = PetscViewerDrawGetPause(ictx->viewer,&pause);CHKERRQ(ierr);
40386083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,0.0);CHKERRQ(ierr);
40396083293cSBarry Smith     ierr = VecView(ictx->initialsolution,ictx->viewer);CHKERRQ(ierr);
40406083293cSBarry Smith     ierr = PetscViewerDrawSetPause(ictx->viewer,pause);CHKERRQ(ierr);
40416083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_TRUE);CHKERRQ(ierr);
40426083293cSBarry Smith   }
40430910c330SBarry Smith   ierr = VecView(u,ictx->viewer);CHKERRQ(ierr);
4044473a3ab2SBarry Smith   if (ictx->showtimestepandtime) {
404551fa3d41SBarry Smith     PetscReal xl,yl,xr,yr,h;
4046473a3ab2SBarry Smith     char      time[32];
4047473a3ab2SBarry Smith 
4048473a3ab2SBarry Smith     ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
404985b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
4050473a3ab2SBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
4051473a3ab2SBarry Smith     h    = yl + .95*(yr - yl);
405251fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
4053473a3ab2SBarry Smith     ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
4054473a3ab2SBarry Smith   }
4055473a3ab2SBarry Smith 
40566083293cSBarry Smith   if (ictx->showinitial) {
40576083293cSBarry Smith     ierr = PetscViewerDrawSetHold(ictx->viewer,PETSC_FALSE);CHKERRQ(ierr);
40586083293cSBarry Smith   }
40591713a123SBarry Smith   PetscFunctionReturn(0);
40601713a123SBarry Smith }
40611713a123SBarry Smith 
40622d5ee99bSBarry Smith #undef __FUNCT__
40639110b2e7SHong Zhang #define __FUNCT__ "TSAdjointMonitorDrawSensi"
40649110b2e7SHong Zhang /*@C
40659110b2e7SHong Zhang    TSAdjointMonitorDrawSensi - Monitors progress of the adjoint TS solvers by calling
40669110b2e7SHong Zhang    VecView() for the sensitivities to initial states at each timestep
40679110b2e7SHong Zhang 
40689110b2e7SHong Zhang    Collective on TS
40699110b2e7SHong Zhang 
40709110b2e7SHong Zhang    Input Parameters:
40719110b2e7SHong Zhang +  ts - the TS context
40729110b2e7SHong Zhang .  step - current time-step
40739110b2e7SHong Zhang .  ptime - current time
40749110b2e7SHong Zhang .  u - current state
40759110b2e7SHong Zhang .  numcost - number of cost functions
40769110b2e7SHong Zhang .  lambda - sensitivities to initial conditions
40779110b2e7SHong Zhang .  mu - sensitivities to parameters
40789110b2e7SHong Zhang -  dummy - either a viewer or NULL
40799110b2e7SHong Zhang 
40809110b2e7SHong Zhang    Level: intermediate
40819110b2e7SHong Zhang 
40829110b2e7SHong Zhang .keywords: TS,  vector, adjoint, monitor, view
40839110b2e7SHong Zhang 
40849110b2e7SHong Zhang .seealso: TSAdjointMonitorSet(), TSAdjointMonitorDefault(), VecView()
40859110b2e7SHong Zhang @*/
40869110b2e7SHong Zhang PetscErrorCode  TSAdjointMonitorDrawSensi(TS ts,PetscInt step,PetscReal ptime,Vec u,PetscInt numcost,Vec *lambda,Vec *mu,void *dummy)
40879110b2e7SHong Zhang {
40889110b2e7SHong Zhang   PetscErrorCode   ierr;
40899110b2e7SHong Zhang   TSMonitorDrawCtx ictx = (TSMonitorDrawCtx)dummy;
40909110b2e7SHong Zhang   PetscDraw        draw;
4091a0046e2cSSatish Balay   PetscReal        xl,yl,xr,yr,h;
4092a0046e2cSSatish Balay   char             time[32];
40939110b2e7SHong Zhang 
40949110b2e7SHong Zhang   PetscFunctionBegin;
40959110b2e7SHong Zhang   if (!(((ictx->howoften > 0) && (!(step % ictx->howoften))) || ((ictx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
40969110b2e7SHong Zhang 
40979110b2e7SHong Zhang   ierr = VecView(lambda[0],ictx->viewer);CHKERRQ(ierr);
40989110b2e7SHong Zhang   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
40999110b2e7SHong Zhang   ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
41009110b2e7SHong Zhang   ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
41019110b2e7SHong Zhang   h    = yl + .95*(yr - yl);
41029110b2e7SHong Zhang   ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
41039110b2e7SHong Zhang   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
41049110b2e7SHong Zhang 
41059110b2e7SHong Zhang   PetscFunctionReturn(0);
41069110b2e7SHong Zhang }
41079110b2e7SHong Zhang 
41089110b2e7SHong Zhang #undef __FUNCT__
41092d5ee99bSBarry Smith #define __FUNCT__ "TSMonitorDrawSolutionPhase"
41102d5ee99bSBarry Smith /*@C
41112d5ee99bSBarry Smith    TSMonitorDrawSolutionPhase - Monitors progress of the TS solvers by plotting the solution as a phase diagram
41122d5ee99bSBarry Smith 
41132d5ee99bSBarry Smith    Collective on TS
41142d5ee99bSBarry Smith 
41152d5ee99bSBarry Smith    Input Parameters:
41162d5ee99bSBarry Smith +  ts - the TS context
41172d5ee99bSBarry Smith .  step - current time-step
41182d5ee99bSBarry Smith .  ptime - current time
41192d5ee99bSBarry Smith -  dummy - either a viewer or NULL
41202d5ee99bSBarry Smith 
41212d5ee99bSBarry Smith    Level: intermediate
41222d5ee99bSBarry Smith 
41232d5ee99bSBarry Smith .keywords: TS,  vector, monitor, view
41242d5ee99bSBarry Smith 
41252d5ee99bSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
41262d5ee99bSBarry Smith @*/
41272d5ee99bSBarry Smith PetscErrorCode  TSMonitorDrawSolutionPhase(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
41282d5ee99bSBarry Smith {
41292d5ee99bSBarry Smith   PetscErrorCode    ierr;
41302d5ee99bSBarry Smith   TSMonitorDrawCtx  ictx = (TSMonitorDrawCtx)dummy;
41312d5ee99bSBarry Smith   PetscDraw         draw;
41322d5ee99bSBarry Smith   MPI_Comm          comm;
41332d5ee99bSBarry Smith   PetscInt          n;
41342d5ee99bSBarry Smith   PetscMPIInt       size;
413551fa3d41SBarry Smith   PetscReal         xl,yl,xr,yr,h;
41362d5ee99bSBarry Smith   char              time[32];
41372d5ee99bSBarry Smith   const PetscScalar *U;
41382d5ee99bSBarry Smith 
41392d5ee99bSBarry Smith   PetscFunctionBegin;
41402d5ee99bSBarry Smith   ierr = PetscObjectGetComm((PetscObject)ts,&comm);CHKERRQ(ierr);
41412d5ee99bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
41422d5ee99bSBarry Smith   if (size != 1) SETERRQ(comm,PETSC_ERR_SUP,"Only allowed for sequential runs");
41432d5ee99bSBarry Smith   ierr = VecGetSize(u,&n);CHKERRQ(ierr);
41442d5ee99bSBarry Smith   if (n != 2) SETERRQ(comm,PETSC_ERR_SUP,"Only for ODEs with two unknowns");
41452d5ee99bSBarry Smith 
41462d5ee99bSBarry Smith   ierr = PetscViewerDrawGetDraw(ictx->viewer,0,&draw);CHKERRQ(ierr);
41472d5ee99bSBarry Smith 
41482d5ee99bSBarry Smith   ierr = VecGetArrayRead(u,&U);CHKERRQ(ierr);
41494b363babSBarry Smith   ierr = PetscDrawAxisGetLimits(ictx->axis,&xl,&xr,&yl,&yr);CHKERRQ(ierr);
4150ba5783adSMatthew G Knepley   if ((PetscRealPart(U[0]) < xl) || (PetscRealPart(U[1]) < yl) || (PetscRealPart(U[0]) > xr) || (PetscRealPart(U[1]) > yr)) {
4151a4494fc1SBarry Smith       ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
4152a4494fc1SBarry Smith       PetscFunctionReturn(0);
4153a4494fc1SBarry Smith   }
41542d5ee99bSBarry Smith   if (!step) ictx->color++;
41552d5ee99bSBarry Smith   ierr = PetscDrawPoint(draw,PetscRealPart(U[0]),PetscRealPart(U[1]),ictx->color);CHKERRQ(ierr);
41562d5ee99bSBarry Smith   ierr = VecRestoreArrayRead(u,&U);CHKERRQ(ierr);
41572d5ee99bSBarry Smith 
41582d5ee99bSBarry Smith   if (ictx->showtimestepandtime) {
41594b363babSBarry Smith     ierr = PetscDrawGetCoordinates(draw,&xl,&yl,&xr,&yr);CHKERRQ(ierr);
416085b1acf9SLisandro Dalcin     ierr = PetscSNPrintf(time,32,"Timestep %d Time %g",(int)step,(double)ptime);CHKERRQ(ierr);
41612d5ee99bSBarry Smith     h    = yl + .95*(yr - yl);
416251fa3d41SBarry Smith     ierr = PetscDrawStringCentered(draw,.5*(xl+xr),h,PETSC_DRAW_BLACK,time);CHKERRQ(ierr);
41632d5ee99bSBarry Smith   }
41642d5ee99bSBarry Smith   ierr = PetscDrawFlush(draw);CHKERRQ(ierr);
41652d5ee99bSBarry Smith   PetscFunctionReturn(0);
41662d5ee99bSBarry Smith }
41672d5ee99bSBarry Smith 
41681713a123SBarry Smith 
41696c699258SBarry Smith #undef __FUNCT__
417083a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxDestroy"
41716083293cSBarry Smith /*@C
417283a4ac43SBarry Smith    TSMonitorDrawCtxDestroy - Destroys the monitor context for TSMonitorDrawSolution()
41736083293cSBarry Smith 
41746083293cSBarry Smith    Collective on TS
41756083293cSBarry Smith 
41766083293cSBarry Smith    Input Parameters:
41776083293cSBarry Smith .    ctx - the monitor context
41786083293cSBarry Smith 
41796083293cSBarry Smith    Level: intermediate
41806083293cSBarry Smith 
41816083293cSBarry Smith .keywords: TS,  vector, monitor, view
41826083293cSBarry Smith 
418383a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawSolution(), TSMonitorDrawError()
41846083293cSBarry Smith @*/
418583a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *ictx)
41866083293cSBarry Smith {
41876083293cSBarry Smith   PetscErrorCode ierr;
41886083293cSBarry Smith 
41896083293cSBarry Smith   PetscFunctionBegin;
41904b363babSBarry Smith   ierr = PetscDrawAxisDestroy(&(*ictx)->axis);CHKERRQ(ierr);
419183a4ac43SBarry Smith   ierr = PetscViewerDestroy(&(*ictx)->viewer);CHKERRQ(ierr);
419283a4ac43SBarry Smith   ierr = VecDestroy(&(*ictx)->initialsolution);CHKERRQ(ierr);
419383a4ac43SBarry Smith   ierr = PetscFree(*ictx);CHKERRQ(ierr);
41946083293cSBarry Smith   PetscFunctionReturn(0);
41956083293cSBarry Smith }
41966083293cSBarry Smith 
41976083293cSBarry Smith #undef __FUNCT__
419883a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawCtxCreate"
41996083293cSBarry Smith /*@C
420083a4ac43SBarry Smith    TSMonitorDrawCtxCreate - Creates the monitor context for TSMonitorDrawCtx
42016083293cSBarry Smith 
42026083293cSBarry Smith    Collective on TS
42036083293cSBarry Smith 
42046083293cSBarry Smith    Input Parameter:
42056083293cSBarry Smith .    ts - time-step context
42066083293cSBarry Smith 
42076083293cSBarry Smith    Output Patameter:
42086083293cSBarry Smith .    ctx - the monitor context
42096083293cSBarry Smith 
421099fdda47SBarry Smith    Options Database:
421199fdda47SBarry Smith .   -ts_monitor_draw_solution_initial - show initial solution as well as current solution
421299fdda47SBarry Smith 
42136083293cSBarry Smith    Level: intermediate
42146083293cSBarry Smith 
42156083293cSBarry Smith .keywords: TS,  vector, monitor, view
42166083293cSBarry Smith 
421783a4ac43SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorDrawCtx()
42186083293cSBarry Smith @*/
421983a4ac43SBarry Smith PetscErrorCode  TSMonitorDrawCtxCreate(MPI_Comm comm,const char host[],const char label[],int x,int y,int m,int n,PetscInt howoften,TSMonitorDrawCtx *ctx)
42206083293cSBarry Smith {
42216083293cSBarry Smith   PetscErrorCode   ierr;
42226083293cSBarry Smith 
42236083293cSBarry Smith   PetscFunctionBegin;
4224b00a9115SJed Brown   ierr = PetscNew(ctx);CHKERRQ(ierr);
422583a4ac43SBarry Smith   ierr = PetscViewerDrawOpen(comm,host,label,x,y,m,n,&(*ctx)->viewer);CHKERRQ(ierr);
4226e9457bf7SBarry Smith   ierr = PetscViewerSetFromOptions((*ctx)->viewer);CHKERRQ(ierr);
4227bbd56ea5SKarl Rupp 
422883a4ac43SBarry Smith   (*ctx)->howoften    = howoften;
4229473a3ab2SBarry Smith   (*ctx)->showinitial = PETSC_FALSE;
42300298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_initial",&(*ctx)->showinitial,NULL);CHKERRQ(ierr);
4231473a3ab2SBarry Smith 
4232473a3ab2SBarry Smith   (*ctx)->showtimestepandtime = PETSC_FALSE;
42330298fd71SBarry Smith   ierr = PetscOptionsGetBool(NULL,"-ts_monitor_draw_solution_show_time",&(*ctx)->showtimestepandtime,NULL);CHKERRQ(ierr);
42342d5ee99bSBarry Smith   (*ctx)->color = PETSC_DRAW_WHITE;
42356083293cSBarry Smith   PetscFunctionReturn(0);
42366083293cSBarry Smith }
42376083293cSBarry Smith 
42386083293cSBarry Smith #undef __FUNCT__
423983a4ac43SBarry Smith #define __FUNCT__ "TSMonitorDrawError"
42403a471f94SBarry Smith /*@C
424183a4ac43SBarry Smith    TSMonitorDrawError - Monitors progress of the TS solvers by calling
42423a471f94SBarry Smith    VecView() for the error at each timestep
42433a471f94SBarry Smith 
42443a471f94SBarry Smith    Collective on TS
42453a471f94SBarry Smith 
42463a471f94SBarry Smith    Input Parameters:
42473a471f94SBarry Smith +  ts - the TS context
42483a471f94SBarry Smith .  step - current time-step
42493a471f94SBarry Smith .  ptime - current time
42500298fd71SBarry Smith -  dummy - either a viewer or NULL
42513a471f94SBarry Smith 
42523a471f94SBarry Smith    Level: intermediate
42533a471f94SBarry Smith 
42543a471f94SBarry Smith .keywords: TS,  vector, monitor, view
42553a471f94SBarry Smith 
42563a471f94SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
42573a471f94SBarry Smith @*/
42580910c330SBarry Smith PetscErrorCode  TSMonitorDrawError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
42593a471f94SBarry Smith {
42603a471f94SBarry Smith   PetscErrorCode   ierr;
426183a4ac43SBarry Smith   TSMonitorDrawCtx ctx    = (TSMonitorDrawCtx)dummy;
426283a4ac43SBarry Smith   PetscViewer      viewer = ctx->viewer;
42633a471f94SBarry Smith   Vec              work;
42643a471f94SBarry Smith 
42653a471f94SBarry Smith   PetscFunctionBegin;
4266b06615a5SLisandro Dalcin   if (!(((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason))) PetscFunctionReturn(0);
42670910c330SBarry Smith   ierr = VecDuplicate(u,&work);CHKERRQ(ierr);
42683a471f94SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,work);CHKERRQ(ierr);
42690910c330SBarry Smith   ierr = VecAXPY(work,-1.0,u);CHKERRQ(ierr);
42703a471f94SBarry Smith   ierr = VecView(work,viewer);CHKERRQ(ierr);
42713a471f94SBarry Smith   ierr = VecDestroy(&work);CHKERRQ(ierr);
42723a471f94SBarry Smith   PetscFunctionReturn(0);
42733a471f94SBarry Smith }
42743a471f94SBarry Smith 
4275af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
42763a471f94SBarry Smith #undef __FUNCT__
42776c699258SBarry Smith #define __FUNCT__ "TSSetDM"
42786c699258SBarry Smith /*@
42796c699258SBarry Smith    TSSetDM - Sets the DM that may be used by some preconditioners
42806c699258SBarry Smith 
42813f9fe445SBarry Smith    Logically Collective on TS and DM
42826c699258SBarry Smith 
42836c699258SBarry Smith    Input Parameters:
42846c699258SBarry Smith +  ts - the preconditioner context
42856c699258SBarry Smith -  dm - the dm
42866c699258SBarry Smith 
42876c699258SBarry Smith    Level: intermediate
42886c699258SBarry Smith 
42896c699258SBarry Smith 
42906c699258SBarry Smith .seealso: TSGetDM(), SNESSetDM(), SNESGetDM()
42916c699258SBarry Smith @*/
42927087cfbeSBarry Smith PetscErrorCode  TSSetDM(TS ts,DM dm)
42936c699258SBarry Smith {
42946c699258SBarry Smith   PetscErrorCode ierr;
4295089b2837SJed Brown   SNES           snes;
4296942e3340SBarry Smith   DMTS           tsdm;
42976c699258SBarry Smith 
42986c699258SBarry Smith   PetscFunctionBegin;
42990700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
430070663e4aSLisandro Dalcin   ierr = PetscObjectReference((PetscObject)dm);CHKERRQ(ierr);
4301942e3340SBarry Smith   if (ts->dm) {               /* Move the DMTS context over to the new DM unless the new DM already has one */
43022a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
4303942e3340SBarry Smith       ierr = DMCopyDMTS(ts->dm,dm);CHKERRQ(ierr);
4304942e3340SBarry Smith       ierr = DMGetDMTS(ts->dm,&tsdm);CHKERRQ(ierr);
430524989b8cSPeter Brune       if (tsdm->originaldm == ts->dm) { /* Grant write privileges to the replacement DM */
430624989b8cSPeter Brune         tsdm->originaldm = dm;
430724989b8cSPeter Brune       }
430824989b8cSPeter Brune     }
43096bf464f9SBarry Smith     ierr = DMDestroy(&ts->dm);CHKERRQ(ierr);
431024989b8cSPeter Brune   }
43116c699258SBarry Smith   ts->dm = dm;
4312bbd56ea5SKarl Rupp 
4313089b2837SJed Brown   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
4314089b2837SJed Brown   ierr = SNESSetDM(snes,dm);CHKERRQ(ierr);
43156c699258SBarry Smith   PetscFunctionReturn(0);
43166c699258SBarry Smith }
43176c699258SBarry Smith 
43186c699258SBarry Smith #undef __FUNCT__
43196c699258SBarry Smith #define __FUNCT__ "TSGetDM"
43206c699258SBarry Smith /*@
43216c699258SBarry Smith    TSGetDM - Gets the DM that may be used by some preconditioners
43226c699258SBarry Smith 
43233f9fe445SBarry Smith    Not Collective
43246c699258SBarry Smith 
43256c699258SBarry Smith    Input Parameter:
43266c699258SBarry Smith . ts - the preconditioner context
43276c699258SBarry Smith 
43286c699258SBarry Smith    Output Parameter:
43296c699258SBarry Smith .  dm - the dm
43306c699258SBarry Smith 
43316c699258SBarry Smith    Level: intermediate
43326c699258SBarry Smith 
43336c699258SBarry Smith 
43346c699258SBarry Smith .seealso: TSSetDM(), SNESSetDM(), SNESGetDM()
43356c699258SBarry Smith @*/
43367087cfbeSBarry Smith PetscErrorCode  TSGetDM(TS ts,DM *dm)
43376c699258SBarry Smith {
4338496e6a7aSJed Brown   PetscErrorCode ierr;
4339496e6a7aSJed Brown 
43406c699258SBarry Smith   PetscFunctionBegin;
43410700a824SBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4342496e6a7aSJed Brown   if (!ts->dm) {
4343ce94432eSBarry Smith     ierr = DMShellCreate(PetscObjectComm((PetscObject)ts),&ts->dm);CHKERRQ(ierr);
4344496e6a7aSJed Brown     if (ts->snes) {ierr = SNESSetDM(ts->snes,ts->dm);CHKERRQ(ierr);}
4345496e6a7aSJed Brown   }
43466c699258SBarry Smith   *dm = ts->dm;
43476c699258SBarry Smith   PetscFunctionReturn(0);
43486c699258SBarry Smith }
43491713a123SBarry Smith 
43500f5c6efeSJed Brown #undef __FUNCT__
43510f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormFunction"
43520f5c6efeSJed Brown /*@
43530f5c6efeSJed Brown    SNESTSFormFunction - Function to evaluate nonlinear residual
43540f5c6efeSJed Brown 
43553f9fe445SBarry Smith    Logically Collective on SNES
43560f5c6efeSJed Brown 
43570f5c6efeSJed Brown    Input Parameter:
4358d42a1c89SJed Brown + snes - nonlinear solver
43590910c330SBarry Smith . U - the current state at which to evaluate the residual
4360d42a1c89SJed Brown - ctx - user context, must be a TS
43610f5c6efeSJed Brown 
43620f5c6efeSJed Brown    Output Parameter:
43630f5c6efeSJed Brown . F - the nonlinear residual
43640f5c6efeSJed Brown 
43650f5c6efeSJed Brown    Notes:
43660f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
43670f5c6efeSJed Brown    It is most frequently passed to MatFDColoringSetFunction().
43680f5c6efeSJed Brown 
43690f5c6efeSJed Brown    Level: advanced
43700f5c6efeSJed Brown 
43710f5c6efeSJed Brown .seealso: SNESSetFunction(), MatFDColoringSetFunction()
43720f5c6efeSJed Brown @*/
43730910c330SBarry Smith PetscErrorCode  SNESTSFormFunction(SNES snes,Vec U,Vec F,void *ctx)
43740f5c6efeSJed Brown {
43750f5c6efeSJed Brown   TS             ts = (TS)ctx;
43760f5c6efeSJed Brown   PetscErrorCode ierr;
43770f5c6efeSJed Brown 
43780f5c6efeSJed Brown   PetscFunctionBegin;
43790f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
43800910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
43810f5c6efeSJed Brown   PetscValidHeaderSpecific(F,VEC_CLASSID,3);
43820f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,4);
43830910c330SBarry Smith   ierr = (ts->ops->snesfunction)(snes,U,F,ts);CHKERRQ(ierr);
43840f5c6efeSJed Brown   PetscFunctionReturn(0);
43850f5c6efeSJed Brown }
43860f5c6efeSJed Brown 
43870f5c6efeSJed Brown #undef __FUNCT__
43880f5c6efeSJed Brown #define __FUNCT__ "SNESTSFormJacobian"
43890f5c6efeSJed Brown /*@
43900f5c6efeSJed Brown    SNESTSFormJacobian - Function to evaluate the Jacobian
43910f5c6efeSJed Brown 
43920f5c6efeSJed Brown    Collective on SNES
43930f5c6efeSJed Brown 
43940f5c6efeSJed Brown    Input Parameter:
43950f5c6efeSJed Brown + snes - nonlinear solver
43960910c330SBarry Smith . U - the current state at which to evaluate the residual
43970f5c6efeSJed Brown - ctx - user context, must be a TS
43980f5c6efeSJed Brown 
43990f5c6efeSJed Brown    Output Parameter:
44000f5c6efeSJed Brown + A - the Jacobian
44010f5c6efeSJed Brown . B - the preconditioning matrix (may be the same as A)
44020f5c6efeSJed Brown - flag - indicates any structure change in the matrix
44030f5c6efeSJed Brown 
44040f5c6efeSJed Brown    Notes:
44050f5c6efeSJed Brown    This function is not normally called by users and is automatically registered with the SNES used by TS.
44060f5c6efeSJed Brown 
44070f5c6efeSJed Brown    Level: developer
44080f5c6efeSJed Brown 
44090f5c6efeSJed Brown .seealso: SNESSetJacobian()
44100f5c6efeSJed Brown @*/
4411d1e9a80fSBarry Smith PetscErrorCode  SNESTSFormJacobian(SNES snes,Vec U,Mat A,Mat B,void *ctx)
44120f5c6efeSJed Brown {
44130f5c6efeSJed Brown   TS             ts = (TS)ctx;
44140f5c6efeSJed Brown   PetscErrorCode ierr;
44150f5c6efeSJed Brown 
44160f5c6efeSJed Brown   PetscFunctionBegin;
44170f5c6efeSJed Brown   PetscValidHeaderSpecific(snes,SNES_CLASSID,1);
44180910c330SBarry Smith   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
44190f5c6efeSJed Brown   PetscValidPointer(A,3);
442094ab13aaSBarry Smith   PetscValidHeaderSpecific(A,MAT_CLASSID,3);
44210f5c6efeSJed Brown   PetscValidPointer(B,4);
442294ab13aaSBarry Smith   PetscValidHeaderSpecific(B,MAT_CLASSID,4);
44230f5c6efeSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,6);
4424d1e9a80fSBarry Smith   ierr = (ts->ops->snesjacobian)(snes,U,A,B,ts);CHKERRQ(ierr);
44250f5c6efeSJed Brown   PetscFunctionReturn(0);
44260f5c6efeSJed Brown }
4427325fc9f4SBarry Smith 
44280e4ef248SJed Brown #undef __FUNCT__
44290e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSFunctionLinear"
44300e4ef248SJed Brown /*@C
44310e4ef248SJed Brown    TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems only
44320e4ef248SJed Brown 
44330e4ef248SJed Brown    Collective on TS
44340e4ef248SJed Brown 
44350e4ef248SJed Brown    Input Arguments:
44360e4ef248SJed Brown +  ts - time stepping context
44370e4ef248SJed Brown .  t - time at which to evaluate
44380910c330SBarry Smith .  U - state at which to evaluate
44390e4ef248SJed Brown -  ctx - context
44400e4ef248SJed Brown 
44410e4ef248SJed Brown    Output Arguments:
44420e4ef248SJed Brown .  F - right hand side
44430e4ef248SJed Brown 
44440e4ef248SJed Brown    Level: intermediate
44450e4ef248SJed Brown 
44460e4ef248SJed Brown    Notes:
44470e4ef248SJed Brown    This function is intended to be passed to TSSetRHSFunction() to evaluate the right hand side for linear problems.
44480e4ef248SJed Brown    The matrix (and optionally the evaluation context) should be passed to TSSetRHSJacobian().
44490e4ef248SJed Brown 
44500e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSJacobianConstant()
44510e4ef248SJed Brown @*/
44520910c330SBarry Smith PetscErrorCode TSComputeRHSFunctionLinear(TS ts,PetscReal t,Vec U,Vec F,void *ctx)
44530e4ef248SJed Brown {
44540e4ef248SJed Brown   PetscErrorCode ierr;
44550e4ef248SJed Brown   Mat            Arhs,Brhs;
44560e4ef248SJed Brown 
44570e4ef248SJed Brown   PetscFunctionBegin;
44580e4ef248SJed Brown   ierr = TSGetRHSMats_Private(ts,&Arhs,&Brhs);CHKERRQ(ierr);
4459d1e9a80fSBarry Smith   ierr = TSComputeRHSJacobian(ts,t,U,Arhs,Brhs);CHKERRQ(ierr);
44600910c330SBarry Smith   ierr = MatMult(Arhs,U,F);CHKERRQ(ierr);
44610e4ef248SJed Brown   PetscFunctionReturn(0);
44620e4ef248SJed Brown }
44630e4ef248SJed Brown 
44640e4ef248SJed Brown #undef __FUNCT__
44650e4ef248SJed Brown #define __FUNCT__ "TSComputeRHSJacobianConstant"
44660e4ef248SJed Brown /*@C
44670e4ef248SJed Brown    TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
44680e4ef248SJed Brown 
44690e4ef248SJed Brown    Collective on TS
44700e4ef248SJed Brown 
44710e4ef248SJed Brown    Input Arguments:
44720e4ef248SJed Brown +  ts - time stepping context
44730e4ef248SJed Brown .  t - time at which to evaluate
44740910c330SBarry Smith .  U - state at which to evaluate
44750e4ef248SJed Brown -  ctx - context
44760e4ef248SJed Brown 
44770e4ef248SJed Brown    Output Arguments:
44780e4ef248SJed Brown +  A - pointer to operator
44790e4ef248SJed Brown .  B - pointer to preconditioning matrix
44800e4ef248SJed Brown -  flg - matrix structure flag
44810e4ef248SJed Brown 
44820e4ef248SJed Brown    Level: intermediate
44830e4ef248SJed Brown 
44840e4ef248SJed Brown    Notes:
44850e4ef248SJed Brown    This function is intended to be passed to TSSetRHSJacobian() to evaluate the Jacobian for linear time-independent problems.
44860e4ef248SJed Brown 
44870e4ef248SJed Brown .seealso: TSSetRHSFunction(), TSSetRHSJacobian(), TSComputeRHSFunctionLinear()
44880e4ef248SJed Brown @*/
4489d1e9a80fSBarry Smith PetscErrorCode TSComputeRHSJacobianConstant(TS ts,PetscReal t,Vec U,Mat A,Mat B,void *ctx)
44900e4ef248SJed Brown {
44910e4ef248SJed Brown   PetscFunctionBegin;
44920e4ef248SJed Brown   PetscFunctionReturn(0);
44930e4ef248SJed Brown }
44940e4ef248SJed Brown 
44950026cea9SSean Farley #undef __FUNCT__
44960026cea9SSean Farley #define __FUNCT__ "TSComputeIFunctionLinear"
44970026cea9SSean Farley /*@C
44980026cea9SSean Farley    TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
44990026cea9SSean Farley 
45000026cea9SSean Farley    Collective on TS
45010026cea9SSean Farley 
45020026cea9SSean Farley    Input Arguments:
45030026cea9SSean Farley +  ts - time stepping context
45040026cea9SSean Farley .  t - time at which to evaluate
45050910c330SBarry Smith .  U - state at which to evaluate
45060910c330SBarry Smith .  Udot - time derivative of state vector
45070026cea9SSean Farley -  ctx - context
45080026cea9SSean Farley 
45090026cea9SSean Farley    Output Arguments:
45100026cea9SSean Farley .  F - left hand side
45110026cea9SSean Farley 
45120026cea9SSean Farley    Level: intermediate
45130026cea9SSean Farley 
45140026cea9SSean Farley    Notes:
45150910c330SBarry 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
45160026cea9SSean Farley    user is required to write their own TSComputeIFunction.
45170026cea9SSean Farley    This function is intended to be passed to TSSetIFunction() to evaluate the left hand side for linear problems.
45180026cea9SSean Farley    The matrix (and optionally the evaluation context) should be passed to TSSetIJacobian().
45190026cea9SSean Farley 
45200026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIJacobianConstant()
45210026cea9SSean Farley @*/
45220910c330SBarry Smith PetscErrorCode TSComputeIFunctionLinear(TS ts,PetscReal t,Vec U,Vec Udot,Vec F,void *ctx)
45230026cea9SSean Farley {
45240026cea9SSean Farley   PetscErrorCode ierr;
45250026cea9SSean Farley   Mat            A,B;
45260026cea9SSean Farley 
45270026cea9SSean Farley   PetscFunctionBegin;
45280298fd71SBarry Smith   ierr = TSGetIJacobian(ts,&A,&B,NULL,NULL);CHKERRQ(ierr);
4529d1e9a80fSBarry Smith   ierr = TSComputeIJacobian(ts,t,U,Udot,1.0,A,B,PETSC_TRUE);CHKERRQ(ierr);
45300910c330SBarry Smith   ierr = MatMult(A,Udot,F);CHKERRQ(ierr);
45310026cea9SSean Farley   PetscFunctionReturn(0);
45320026cea9SSean Farley }
45330026cea9SSean Farley 
45340026cea9SSean Farley #undef __FUNCT__
45350026cea9SSean Farley #define __FUNCT__ "TSComputeIJacobianConstant"
45360026cea9SSean Farley /*@C
4537b41af12eSJed Brown    TSComputeIJacobianConstant - Reuses a time-independent for a semi-implicit DAE or ODE
45380026cea9SSean Farley 
45390026cea9SSean Farley    Collective on TS
45400026cea9SSean Farley 
45410026cea9SSean Farley    Input Arguments:
45420026cea9SSean Farley +  ts - time stepping context
45430026cea9SSean Farley .  t - time at which to evaluate
45440910c330SBarry Smith .  U - state at which to evaluate
45450910c330SBarry Smith .  Udot - time derivative of state vector
45460026cea9SSean Farley .  shift - shift to apply
45470026cea9SSean Farley -  ctx - context
45480026cea9SSean Farley 
45490026cea9SSean Farley    Output Arguments:
45500026cea9SSean Farley +  A - pointer to operator
45510026cea9SSean Farley .  B - pointer to preconditioning matrix
45520026cea9SSean Farley -  flg - matrix structure flag
45530026cea9SSean Farley 
4554b41af12eSJed Brown    Level: advanced
45550026cea9SSean Farley 
45560026cea9SSean Farley    Notes:
45570026cea9SSean Farley    This function is intended to be passed to TSSetIJacobian() to evaluate the Jacobian for linear time-independent problems.
45580026cea9SSean Farley 
4559b41af12eSJed Brown    It is only appropriate for problems of the form
4560b41af12eSJed Brown 
4561b41af12eSJed Brown $     M Udot = F(U,t)
4562b41af12eSJed Brown 
4563b41af12eSJed Brown   where M is constant and F is non-stiff.  The user must pass M to TSSetIJacobian().  The current implementation only
4564b41af12eSJed Brown   works with IMEX time integration methods such as TSROSW and TSARKIMEX, since there is no support for de-constructing
4565b41af12eSJed Brown   an implicit operator of the form
4566b41af12eSJed Brown 
4567b41af12eSJed Brown $    shift*M + J
4568b41af12eSJed Brown 
4569b41af12eSJed 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
4570b41af12eSJed Brown   a copy of M or reassemble it when requested.
4571b41af12eSJed Brown 
45720026cea9SSean Farley .seealso: TSSetIFunction(), TSSetIJacobian(), TSComputeIFunctionLinear()
45730026cea9SSean Farley @*/
4574d1e9a80fSBarry Smith PetscErrorCode TSComputeIJacobianConstant(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat A,Mat B,void *ctx)
45750026cea9SSean Farley {
4576b41af12eSJed Brown   PetscErrorCode ierr;
4577b41af12eSJed Brown 
45780026cea9SSean Farley   PetscFunctionBegin;
457994ab13aaSBarry Smith   ierr = MatScale(A, shift / ts->ijacobian.shift);CHKERRQ(ierr);
4580b41af12eSJed Brown   ts->ijacobian.shift = shift;
45810026cea9SSean Farley   PetscFunctionReturn(0);
45820026cea9SSean Farley }
4583b41af12eSJed Brown 
4584e817cc15SEmil Constantinescu #undef __FUNCT__
4585e817cc15SEmil Constantinescu #define __FUNCT__ "TSGetEquationType"
4586e817cc15SEmil Constantinescu /*@
4587e817cc15SEmil Constantinescu    TSGetEquationType - Gets the type of the equation that TS is solving.
4588e817cc15SEmil Constantinescu 
4589e817cc15SEmil Constantinescu    Not Collective
4590e817cc15SEmil Constantinescu 
4591e817cc15SEmil Constantinescu    Input Parameter:
4592e817cc15SEmil Constantinescu .  ts - the TS context
4593e817cc15SEmil Constantinescu 
4594e817cc15SEmil Constantinescu    Output Parameter:
45954e6b9ce4SEmil Constantinescu .  equation_type - see TSEquationType
4596e817cc15SEmil Constantinescu 
4597e817cc15SEmil Constantinescu    Level: beginner
4598e817cc15SEmil Constantinescu 
4599e817cc15SEmil Constantinescu .keywords: TS, equation type
4600e817cc15SEmil Constantinescu 
4601e817cc15SEmil Constantinescu .seealso: TSSetEquationType(), TSEquationType
4602e817cc15SEmil Constantinescu @*/
4603e817cc15SEmil Constantinescu PetscErrorCode  TSGetEquationType(TS ts,TSEquationType *equation_type)
4604e817cc15SEmil Constantinescu {
4605e817cc15SEmil Constantinescu   PetscFunctionBegin;
4606e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4607e817cc15SEmil Constantinescu   PetscValidPointer(equation_type,2);
4608e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
4609e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4610e817cc15SEmil Constantinescu }
4611e817cc15SEmil Constantinescu 
4612e817cc15SEmil Constantinescu #undef __FUNCT__
4613e817cc15SEmil Constantinescu #define __FUNCT__ "TSSetEquationType"
4614e817cc15SEmil Constantinescu /*@
4615e817cc15SEmil Constantinescu    TSSetEquationType - Sets the type of the equation that TS is solving.
4616e817cc15SEmil Constantinescu 
4617e817cc15SEmil Constantinescu    Not Collective
4618e817cc15SEmil Constantinescu 
4619e817cc15SEmil Constantinescu    Input Parameter:
4620e817cc15SEmil Constantinescu +  ts - the TS context
46211297b224SEmil Constantinescu -  equation_type - see TSEquationType
4622e817cc15SEmil Constantinescu 
4623e817cc15SEmil Constantinescu    Level: advanced
4624e817cc15SEmil Constantinescu 
4625e817cc15SEmil Constantinescu .keywords: TS, equation type
4626e817cc15SEmil Constantinescu 
4627e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSEquationType
4628e817cc15SEmil Constantinescu @*/
4629e817cc15SEmil Constantinescu PetscErrorCode  TSSetEquationType(TS ts,TSEquationType equation_type)
4630e817cc15SEmil Constantinescu {
4631e817cc15SEmil Constantinescu   PetscFunctionBegin;
4632e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4633e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
4634e817cc15SEmil Constantinescu   PetscFunctionReturn(0);
4635e817cc15SEmil Constantinescu }
46360026cea9SSean Farley 
46374af1b03aSJed Brown #undef __FUNCT__
46384af1b03aSJed Brown #define __FUNCT__ "TSGetConvergedReason"
46394af1b03aSJed Brown /*@
46404af1b03aSJed Brown    TSGetConvergedReason - Gets the reason the TS iteration was stopped.
46414af1b03aSJed Brown 
46424af1b03aSJed Brown    Not Collective
46434af1b03aSJed Brown 
46444af1b03aSJed Brown    Input Parameter:
46454af1b03aSJed Brown .  ts - the TS context
46464af1b03aSJed Brown 
46474af1b03aSJed Brown    Output Parameter:
46484af1b03aSJed Brown .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
46494af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
46504af1b03aSJed Brown 
4651487e0bb9SJed Brown    Level: beginner
46524af1b03aSJed Brown 
4653cd652676SJed Brown    Notes:
4654cd652676SJed Brown    Can only be called after the call to TSSolve() is complete.
46554af1b03aSJed Brown 
46564af1b03aSJed Brown .keywords: TS, nonlinear, set, convergence, test
46574af1b03aSJed Brown 
46584af1b03aSJed Brown .seealso: TSSetConvergenceTest(), TSConvergedReason
46594af1b03aSJed Brown @*/
46604af1b03aSJed Brown PetscErrorCode  TSGetConvergedReason(TS ts,TSConvergedReason *reason)
46614af1b03aSJed Brown {
46624af1b03aSJed Brown   PetscFunctionBegin;
46634af1b03aSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
46644af1b03aSJed Brown   PetscValidPointer(reason,2);
46654af1b03aSJed Brown   *reason = ts->reason;
46664af1b03aSJed Brown   PetscFunctionReturn(0);
46674af1b03aSJed Brown }
46684af1b03aSJed Brown 
4669fb1732b5SBarry Smith #undef __FUNCT__
4670d6ad946cSShri Abhyankar #define __FUNCT__ "TSSetConvergedReason"
4671d6ad946cSShri Abhyankar /*@
4672d6ad946cSShri Abhyankar    TSSetConvergedReason - Sets the reason for handling the convergence of TSSolve.
4673d6ad946cSShri Abhyankar 
4674d6ad946cSShri Abhyankar    Not Collective
4675d6ad946cSShri Abhyankar 
4676d6ad946cSShri Abhyankar    Input Parameter:
4677d6ad946cSShri Abhyankar +  ts - the TS context
4678d6ad946cSShri Abhyankar .  reason - negative value indicates diverged, positive value converged, see TSConvergedReason or the
4679d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4680d6ad946cSShri Abhyankar 
4681f5abba47SShri Abhyankar    Level: advanced
4682d6ad946cSShri Abhyankar 
4683d6ad946cSShri Abhyankar    Notes:
4684d6ad946cSShri Abhyankar    Can only be called during TSSolve() is active.
4685d6ad946cSShri Abhyankar 
4686d6ad946cSShri Abhyankar .keywords: TS, nonlinear, set, convergence, test
4687d6ad946cSShri Abhyankar 
4688d6ad946cSShri Abhyankar .seealso: TSConvergedReason
4689d6ad946cSShri Abhyankar @*/
4690d6ad946cSShri Abhyankar PetscErrorCode  TSSetConvergedReason(TS ts,TSConvergedReason reason)
4691d6ad946cSShri Abhyankar {
4692d6ad946cSShri Abhyankar   PetscFunctionBegin;
4693d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4694d6ad946cSShri Abhyankar   ts->reason = reason;
4695d6ad946cSShri Abhyankar   PetscFunctionReturn(0);
4696d6ad946cSShri Abhyankar }
4697d6ad946cSShri Abhyankar 
4698d6ad946cSShri Abhyankar #undef __FUNCT__
4699cc708dedSBarry Smith #define __FUNCT__ "TSGetSolveTime"
4700cc708dedSBarry Smith /*@
4701cc708dedSBarry Smith    TSGetSolveTime - Gets the time after a call to TSSolve()
4702cc708dedSBarry Smith 
4703cc708dedSBarry Smith    Not Collective
4704cc708dedSBarry Smith 
4705cc708dedSBarry Smith    Input Parameter:
4706cc708dedSBarry Smith .  ts - the TS context
4707cc708dedSBarry Smith 
4708cc708dedSBarry Smith    Output Parameter:
4709cc708dedSBarry Smith .  ftime - the final time. This time should correspond to the final time set with TSSetDuration()
4710cc708dedSBarry Smith 
4711487e0bb9SJed Brown    Level: beginner
4712cc708dedSBarry Smith 
4713cc708dedSBarry Smith    Notes:
4714cc708dedSBarry Smith    Can only be called after the call to TSSolve() is complete.
4715cc708dedSBarry Smith 
4716cc708dedSBarry Smith .keywords: TS, nonlinear, set, convergence, test
4717cc708dedSBarry Smith 
4718cc708dedSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
4719cc708dedSBarry Smith @*/
4720cc708dedSBarry Smith PetscErrorCode  TSGetSolveTime(TS ts,PetscReal *ftime)
4721cc708dedSBarry Smith {
4722cc708dedSBarry Smith   PetscFunctionBegin;
4723cc708dedSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4724cc708dedSBarry Smith   PetscValidPointer(ftime,2);
4725cc708dedSBarry Smith   *ftime = ts->solvetime;
4726cc708dedSBarry Smith   PetscFunctionReturn(0);
4727cc708dedSBarry Smith }
4728cc708dedSBarry Smith 
4729cc708dedSBarry Smith #undef __FUNCT__
47302c18e0fdSBarry Smith #define __FUNCT__ "TSGetTotalSteps"
47312c18e0fdSBarry Smith /*@
47322c18e0fdSBarry Smith    TSGetTotalSteps - Gets the total number of steps done since the last call to TSSetUp() or TSCreate()
47332c18e0fdSBarry Smith 
47342c18e0fdSBarry Smith    Not Collective
47352c18e0fdSBarry Smith 
47362c18e0fdSBarry Smith    Input Parameter:
47372c18e0fdSBarry Smith .  ts - the TS context
47382c18e0fdSBarry Smith 
47392c18e0fdSBarry Smith    Output Parameter:
47402c18e0fdSBarry Smith .  steps - the number of steps
47412c18e0fdSBarry Smith 
47422c18e0fdSBarry Smith    Level: beginner
47432c18e0fdSBarry Smith 
47442c18e0fdSBarry Smith    Notes:
47452c18e0fdSBarry Smith    Includes the number of steps for all calls to TSSolve() since TSSetUp() was called
47462c18e0fdSBarry Smith 
47472c18e0fdSBarry Smith .keywords: TS, nonlinear, set, convergence, test
47482c18e0fdSBarry Smith 
47492c18e0fdSBarry Smith .seealso: TSSetConvergenceTest(), TSConvergedReason
47502c18e0fdSBarry Smith @*/
47512c18e0fdSBarry Smith PetscErrorCode  TSGetTotalSteps(TS ts,PetscInt *steps)
47522c18e0fdSBarry Smith {
47532c18e0fdSBarry Smith   PetscFunctionBegin;
47542c18e0fdSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47552c18e0fdSBarry Smith   PetscValidPointer(steps,2);
47562c18e0fdSBarry Smith   *steps = ts->total_steps;
47572c18e0fdSBarry Smith   PetscFunctionReturn(0);
47582c18e0fdSBarry Smith }
47592c18e0fdSBarry Smith 
47602c18e0fdSBarry Smith #undef __FUNCT__
47615ef26d82SJed Brown #define __FUNCT__ "TSGetSNESIterations"
47629f67acb7SJed Brown /*@
47635ef26d82SJed Brown    TSGetSNESIterations - Gets the total number of nonlinear iterations
47649f67acb7SJed Brown    used by the time integrator.
47659f67acb7SJed Brown 
47669f67acb7SJed Brown    Not Collective
47679f67acb7SJed Brown 
47689f67acb7SJed Brown    Input Parameter:
47699f67acb7SJed Brown .  ts - TS context
47709f67acb7SJed Brown 
47719f67acb7SJed Brown    Output Parameter:
47729f67acb7SJed Brown .  nits - number of nonlinear iterations
47739f67acb7SJed Brown 
47749f67acb7SJed Brown    Notes:
47759f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
47769f67acb7SJed Brown 
47779f67acb7SJed Brown    Level: intermediate
47789f67acb7SJed Brown 
47799f67acb7SJed Brown .keywords: TS, get, number, nonlinear, iterations
47809f67acb7SJed Brown 
47815ef26d82SJed Brown .seealso:  TSGetKSPIterations()
47829f67acb7SJed Brown @*/
47835ef26d82SJed Brown PetscErrorCode TSGetSNESIterations(TS ts,PetscInt *nits)
47849f67acb7SJed Brown {
47859f67acb7SJed Brown   PetscFunctionBegin;
47869f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
47879f67acb7SJed Brown   PetscValidIntPointer(nits,2);
47885ef26d82SJed Brown   *nits = ts->snes_its;
47899f67acb7SJed Brown   PetscFunctionReturn(0);
47909f67acb7SJed Brown }
47919f67acb7SJed Brown 
47929f67acb7SJed Brown #undef __FUNCT__
47935ef26d82SJed Brown #define __FUNCT__ "TSGetKSPIterations"
47949f67acb7SJed Brown /*@
47955ef26d82SJed Brown    TSGetKSPIterations - Gets the total number of linear iterations
47969f67acb7SJed Brown    used by the time integrator.
47979f67acb7SJed Brown 
47989f67acb7SJed Brown    Not Collective
47999f67acb7SJed Brown 
48009f67acb7SJed Brown    Input Parameter:
48019f67acb7SJed Brown .  ts - TS context
48029f67acb7SJed Brown 
48039f67acb7SJed Brown    Output Parameter:
48049f67acb7SJed Brown .  lits - number of linear iterations
48059f67acb7SJed Brown 
48069f67acb7SJed Brown    Notes:
48079f67acb7SJed Brown    This counter is reset to zero for each successive call to TSSolve().
48089f67acb7SJed Brown 
48099f67acb7SJed Brown    Level: intermediate
48109f67acb7SJed Brown 
48119f67acb7SJed Brown .keywords: TS, get, number, linear, iterations
48129f67acb7SJed Brown 
48135ef26d82SJed Brown .seealso:  TSGetSNESIterations(), SNESGetKSPIterations()
48149f67acb7SJed Brown @*/
48155ef26d82SJed Brown PetscErrorCode TSGetKSPIterations(TS ts,PetscInt *lits)
48169f67acb7SJed Brown {
48179f67acb7SJed Brown   PetscFunctionBegin;
48189f67acb7SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
48199f67acb7SJed Brown   PetscValidIntPointer(lits,2);
48205ef26d82SJed Brown   *lits = ts->ksp_its;
48219f67acb7SJed Brown   PetscFunctionReturn(0);
48229f67acb7SJed Brown }
48239f67acb7SJed Brown 
48249f67acb7SJed Brown #undef __FUNCT__
4825cef5090cSJed Brown #define __FUNCT__ "TSGetStepRejections"
4826cef5090cSJed Brown /*@
4827cef5090cSJed Brown    TSGetStepRejections - Gets the total number of rejected steps.
4828cef5090cSJed Brown 
4829cef5090cSJed Brown    Not Collective
4830cef5090cSJed Brown 
4831cef5090cSJed Brown    Input Parameter:
4832cef5090cSJed Brown .  ts - TS context
4833cef5090cSJed Brown 
4834cef5090cSJed Brown    Output Parameter:
4835cef5090cSJed Brown .  rejects - number of steps rejected
4836cef5090cSJed Brown 
4837cef5090cSJed Brown    Notes:
4838cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4839cef5090cSJed Brown 
4840cef5090cSJed Brown    Level: intermediate
4841cef5090cSJed Brown 
4842cef5090cSJed Brown .keywords: TS, get, number
4843cef5090cSJed Brown 
48445ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetSNESFailures(), TSSetMaxSNESFailures(), TSSetErrorIfStepFails()
4845cef5090cSJed Brown @*/
4846cef5090cSJed Brown PetscErrorCode TSGetStepRejections(TS ts,PetscInt *rejects)
4847cef5090cSJed Brown {
4848cef5090cSJed Brown   PetscFunctionBegin;
4849cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4850cef5090cSJed Brown   PetscValidIntPointer(rejects,2);
4851cef5090cSJed Brown   *rejects = ts->reject;
4852cef5090cSJed Brown   PetscFunctionReturn(0);
4853cef5090cSJed Brown }
4854cef5090cSJed Brown 
4855cef5090cSJed Brown #undef __FUNCT__
4856cef5090cSJed Brown #define __FUNCT__ "TSGetSNESFailures"
4857cef5090cSJed Brown /*@
4858cef5090cSJed Brown    TSGetSNESFailures - Gets the total number of failed SNES solves
4859cef5090cSJed Brown 
4860cef5090cSJed Brown    Not Collective
4861cef5090cSJed Brown 
4862cef5090cSJed Brown    Input Parameter:
4863cef5090cSJed Brown .  ts - TS context
4864cef5090cSJed Brown 
4865cef5090cSJed Brown    Output Parameter:
4866cef5090cSJed Brown .  fails - number of failed nonlinear solves
4867cef5090cSJed Brown 
4868cef5090cSJed Brown    Notes:
4869cef5090cSJed Brown    This counter is reset to zero for each successive call to TSSolve().
4870cef5090cSJed Brown 
4871cef5090cSJed Brown    Level: intermediate
4872cef5090cSJed Brown 
4873cef5090cSJed Brown .keywords: TS, get, number
4874cef5090cSJed Brown 
48755ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSSetMaxSNESFailures()
4876cef5090cSJed Brown @*/
4877cef5090cSJed Brown PetscErrorCode TSGetSNESFailures(TS ts,PetscInt *fails)
4878cef5090cSJed Brown {
4879cef5090cSJed Brown   PetscFunctionBegin;
4880cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4881cef5090cSJed Brown   PetscValidIntPointer(fails,2);
4882cef5090cSJed Brown   *fails = ts->num_snes_failures;
4883cef5090cSJed Brown   PetscFunctionReturn(0);
4884cef5090cSJed Brown }
4885cef5090cSJed Brown 
4886cef5090cSJed Brown #undef __FUNCT__
4887cef5090cSJed Brown #define __FUNCT__ "TSSetMaxStepRejections"
4888cef5090cSJed Brown /*@
4889cef5090cSJed Brown    TSSetMaxStepRejections - Sets the maximum number of step rejections before a step fails
4890cef5090cSJed Brown 
4891cef5090cSJed Brown    Not Collective
4892cef5090cSJed Brown 
4893cef5090cSJed Brown    Input Parameter:
4894cef5090cSJed Brown +  ts - TS context
4895cef5090cSJed Brown -  rejects - maximum number of rejected steps, pass -1 for unlimited
4896cef5090cSJed Brown 
4897cef5090cSJed Brown    Notes:
4898cef5090cSJed Brown    The counter is reset to zero for each step
4899cef5090cSJed Brown 
4900cef5090cSJed Brown    Options Database Key:
4901cef5090cSJed Brown  .  -ts_max_reject - Maximum number of step rejections before a step fails
4902cef5090cSJed Brown 
4903cef5090cSJed Brown    Level: intermediate
4904cef5090cSJed Brown 
4905cef5090cSJed Brown .keywords: TS, set, maximum, number
4906cef5090cSJed Brown 
49075ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxSNESFailures(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4908cef5090cSJed Brown @*/
4909cef5090cSJed Brown PetscErrorCode TSSetMaxStepRejections(TS ts,PetscInt rejects)
4910cef5090cSJed Brown {
4911cef5090cSJed Brown   PetscFunctionBegin;
4912cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4913cef5090cSJed Brown   ts->max_reject = rejects;
4914cef5090cSJed Brown   PetscFunctionReturn(0);
4915cef5090cSJed Brown }
4916cef5090cSJed Brown 
4917cef5090cSJed Brown #undef __FUNCT__
4918cef5090cSJed Brown #define __FUNCT__ "TSSetMaxSNESFailures"
4919cef5090cSJed Brown /*@
4920cef5090cSJed Brown    TSSetMaxSNESFailures - Sets the maximum number of failed SNES solves
4921cef5090cSJed Brown 
4922cef5090cSJed Brown    Not Collective
4923cef5090cSJed Brown 
4924cef5090cSJed Brown    Input Parameter:
4925cef5090cSJed Brown +  ts - TS context
4926cef5090cSJed Brown -  fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4927cef5090cSJed Brown 
4928cef5090cSJed Brown    Notes:
4929cef5090cSJed Brown    The counter is reset to zero for each successive call to TSSolve().
4930cef5090cSJed Brown 
4931cef5090cSJed Brown    Options Database Key:
4932cef5090cSJed Brown  .  -ts_max_snes_failures - Maximum number of nonlinear solve failures
4933cef5090cSJed Brown 
4934cef5090cSJed Brown    Level: intermediate
4935cef5090cSJed Brown 
4936cef5090cSJed Brown .keywords: TS, set, maximum, number
4937cef5090cSJed Brown 
49385ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), SNESGetConvergedReason(), TSGetConvergedReason()
4939cef5090cSJed Brown @*/
4940cef5090cSJed Brown PetscErrorCode TSSetMaxSNESFailures(TS ts,PetscInt fails)
4941cef5090cSJed Brown {
4942cef5090cSJed Brown   PetscFunctionBegin;
4943cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4944cef5090cSJed Brown   ts->max_snes_failures = fails;
4945cef5090cSJed Brown   PetscFunctionReturn(0);
4946cef5090cSJed Brown }
4947cef5090cSJed Brown 
4948cef5090cSJed Brown #undef __FUNCT__
49494e8de811SJed Brown #define __FUNCT__ "TSSetErrorIfStepFails"
4950cef5090cSJed Brown /*@
4951cef5090cSJed Brown    TSSetErrorIfStepFails - Error if no step succeeds
4952cef5090cSJed Brown 
4953cef5090cSJed Brown    Not Collective
4954cef5090cSJed Brown 
4955cef5090cSJed Brown    Input Parameter:
4956cef5090cSJed Brown +  ts - TS context
4957cef5090cSJed Brown -  err - PETSC_TRUE to error if no step succeeds, PETSC_FALSE to return without failure
4958cef5090cSJed Brown 
4959cef5090cSJed Brown    Options Database Key:
4960cef5090cSJed Brown  .  -ts_error_if_step_fails - Error if no step succeeds
4961cef5090cSJed Brown 
4962cef5090cSJed Brown    Level: intermediate
4963cef5090cSJed Brown 
4964cef5090cSJed Brown .keywords: TS, set, error
4965cef5090cSJed Brown 
49665ef26d82SJed Brown .seealso:  TSGetSNESIterations(), TSGetKSPIterations(), TSSetMaxStepRejections(), TSGetStepRejections(), TSGetSNESFailures(), TSSetErrorIfStepFails(), TSGetConvergedReason()
4967cef5090cSJed Brown @*/
4968cef5090cSJed Brown PetscErrorCode TSSetErrorIfStepFails(TS ts,PetscBool err)
4969cef5090cSJed Brown {
4970cef5090cSJed Brown   PetscFunctionBegin;
4971cef5090cSJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
4972cef5090cSJed Brown   ts->errorifstepfailed = err;
4973cef5090cSJed Brown   PetscFunctionReturn(0);
4974cef5090cSJed Brown }
4975cef5090cSJed Brown 
4976cef5090cSJed Brown #undef __FUNCT__
4977fb1732b5SBarry Smith #define __FUNCT__ "TSMonitorSolutionBinary"
4978fb1732b5SBarry Smith /*@C
4979fb1732b5SBarry Smith    TSMonitorSolutionBinary - Monitors progress of the TS solvers by VecView() for the solution at each timestep. Normally the viewer is a binary file
4980fb1732b5SBarry Smith 
4981fb1732b5SBarry Smith    Collective on TS
4982fb1732b5SBarry Smith 
4983fb1732b5SBarry Smith    Input Parameters:
4984fb1732b5SBarry Smith +  ts - the TS context
4985fb1732b5SBarry Smith .  step - current time-step
4986fb1732b5SBarry Smith .  ptime - current time
49870910c330SBarry Smith .  u - current state
4988fb1732b5SBarry Smith -  viewer - binary viewer
4989fb1732b5SBarry Smith 
4990fb1732b5SBarry Smith    Level: intermediate
4991fb1732b5SBarry Smith 
4992fb1732b5SBarry Smith .keywords: TS,  vector, monitor, view
4993fb1732b5SBarry Smith 
4994fb1732b5SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
4995fb1732b5SBarry Smith @*/
49960910c330SBarry Smith PetscErrorCode  TSMonitorSolutionBinary(TS ts,PetscInt step,PetscReal ptime,Vec u,void *viewer)
4997fb1732b5SBarry Smith {
4998fb1732b5SBarry Smith   PetscErrorCode ierr;
4999ed81e22dSJed Brown   PetscViewer    v = (PetscViewer)viewer;
5000fb1732b5SBarry Smith 
5001fb1732b5SBarry Smith   PetscFunctionBegin;
50020910c330SBarry Smith   ierr = VecView(u,v);CHKERRQ(ierr);
5003ed81e22dSJed Brown   PetscFunctionReturn(0);
5004ed81e22dSJed Brown }
5005ed81e22dSJed Brown 
5006ed81e22dSJed Brown #undef __FUNCT__
5007ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTK"
5008ed81e22dSJed Brown /*@C
5009ed81e22dSJed Brown    TSMonitorSolutionVTK - Monitors progress of the TS solvers by VecView() for the solution at each timestep.
5010ed81e22dSJed Brown 
5011ed81e22dSJed Brown    Collective on TS
5012ed81e22dSJed Brown 
5013ed81e22dSJed Brown    Input Parameters:
5014ed81e22dSJed Brown +  ts - the TS context
5015ed81e22dSJed Brown .  step - current time-step
5016ed81e22dSJed Brown .  ptime - current time
50170910c330SBarry Smith .  u - current state
5018ed81e22dSJed Brown -  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5019ed81e22dSJed Brown 
5020ed81e22dSJed Brown    Level: intermediate
5021ed81e22dSJed Brown 
5022ed81e22dSJed Brown    Notes:
5023ed81e22dSJed 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.
5024ed81e22dSJed Brown    These are named according to the file name template.
5025ed81e22dSJed Brown 
5026ed81e22dSJed Brown    This function is normally passed as an argument to TSMonitorSet() along with TSMonitorSolutionVTKDestroy().
5027ed81e22dSJed Brown 
5028ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5029ed81e22dSJed Brown 
5030ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView()
5031ed81e22dSJed Brown @*/
50320910c330SBarry Smith PetscErrorCode TSMonitorSolutionVTK(TS ts,PetscInt step,PetscReal ptime,Vec u,void *filenametemplate)
5033ed81e22dSJed Brown {
5034ed81e22dSJed Brown   PetscErrorCode ierr;
5035ed81e22dSJed Brown   char           filename[PETSC_MAX_PATH_LEN];
5036ed81e22dSJed Brown   PetscViewer    viewer;
5037ed81e22dSJed Brown 
5038ed81e22dSJed Brown   PetscFunctionBegin;
50398caf3d72SBarry Smith   ierr = PetscSNPrintf(filename,sizeof(filename),(const char*)filenametemplate,step);CHKERRQ(ierr);
5040ce94432eSBarry Smith   ierr = PetscViewerVTKOpen(PetscObjectComm((PetscObject)ts),filename,FILE_MODE_WRITE,&viewer);CHKERRQ(ierr);
50410910c330SBarry Smith   ierr = VecView(u,viewer);CHKERRQ(ierr);
5042ed81e22dSJed Brown   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
5043ed81e22dSJed Brown   PetscFunctionReturn(0);
5044ed81e22dSJed Brown }
5045ed81e22dSJed Brown 
5046ed81e22dSJed Brown #undef __FUNCT__
5047ed81e22dSJed Brown #define __FUNCT__ "TSMonitorSolutionVTKDestroy"
5048ed81e22dSJed Brown /*@C
5049ed81e22dSJed Brown    TSMonitorSolutionVTKDestroy - Destroy context for monitoring
5050ed81e22dSJed Brown 
5051ed81e22dSJed Brown    Collective on TS
5052ed81e22dSJed Brown 
5053ed81e22dSJed Brown    Input Parameters:
5054ed81e22dSJed Brown .  filenametemplate - string containing a format specifier for the integer time step (e.g. %03D)
5055ed81e22dSJed Brown 
5056ed81e22dSJed Brown    Level: intermediate
5057ed81e22dSJed Brown 
5058ed81e22dSJed Brown    Note:
5059ed81e22dSJed Brown    This function is normally passed to TSMonitorSet() along with TSMonitorSolutionVTK().
5060ed81e22dSJed Brown 
5061ed81e22dSJed Brown .keywords: TS,  vector, monitor, view
5062ed81e22dSJed Brown 
5063ed81e22dSJed Brown .seealso: TSMonitorSet(), TSMonitorSolutionVTK()
5064ed81e22dSJed Brown @*/
5065ed81e22dSJed Brown PetscErrorCode TSMonitorSolutionVTKDestroy(void *filenametemplate)
5066ed81e22dSJed Brown {
5067ed81e22dSJed Brown   PetscErrorCode ierr;
5068ed81e22dSJed Brown 
5069ed81e22dSJed Brown   PetscFunctionBegin;
5070ed81e22dSJed Brown   ierr = PetscFree(*(char**)filenametemplate);CHKERRQ(ierr);
5071fb1732b5SBarry Smith   PetscFunctionReturn(0);
5072fb1732b5SBarry Smith }
5073fb1732b5SBarry Smith 
507484df9cb4SJed Brown #undef __FUNCT__
5075552698daSJed Brown #define __FUNCT__ "TSGetAdapt"
507684df9cb4SJed Brown /*@
5077552698daSJed Brown    TSGetAdapt - Get the adaptive controller context for the current method
507884df9cb4SJed Brown 
5079ed81e22dSJed Brown    Collective on TS if controller has not been created yet
508084df9cb4SJed Brown 
508184df9cb4SJed Brown    Input Arguments:
5082ed81e22dSJed Brown .  ts - time stepping context
508384df9cb4SJed Brown 
508484df9cb4SJed Brown    Output Arguments:
5085ed81e22dSJed Brown .  adapt - adaptive controller
508684df9cb4SJed Brown 
508784df9cb4SJed Brown    Level: intermediate
508884df9cb4SJed Brown 
5089ed81e22dSJed Brown .seealso: TSAdapt, TSAdaptSetType(), TSAdaptChoose()
509084df9cb4SJed Brown @*/
5091552698daSJed Brown PetscErrorCode TSGetAdapt(TS ts,TSAdapt *adapt)
509284df9cb4SJed Brown {
509384df9cb4SJed Brown   PetscErrorCode ierr;
509484df9cb4SJed Brown 
509584df9cb4SJed Brown   PetscFunctionBegin;
509684df9cb4SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
509784df9cb4SJed Brown   PetscValidPointer(adapt,2);
509884df9cb4SJed Brown   if (!ts->adapt) {
5099ce94432eSBarry Smith     ierr = TSAdaptCreate(PetscObjectComm((PetscObject)ts),&ts->adapt);CHKERRQ(ierr);
51003bb1ff40SBarry Smith     ierr = PetscLogObjectParent((PetscObject)ts,(PetscObject)ts->adapt);CHKERRQ(ierr);
51011c3436cfSJed Brown     ierr = PetscObjectIncrementTabLevel((PetscObject)ts->adapt,(PetscObject)ts,1);CHKERRQ(ierr);
510284df9cb4SJed Brown   }
510384df9cb4SJed Brown   *adapt = ts->adapt;
510484df9cb4SJed Brown   PetscFunctionReturn(0);
510584df9cb4SJed Brown }
5106d6ebe24aSShri Abhyankar 
5107d6ebe24aSShri Abhyankar #undef __FUNCT__
51081c3436cfSJed Brown #define __FUNCT__ "TSSetTolerances"
51091c3436cfSJed Brown /*@
51101c3436cfSJed Brown    TSSetTolerances - Set tolerances for local truncation error when using adaptive controller
51111c3436cfSJed Brown 
51121c3436cfSJed Brown    Logically Collective
51131c3436cfSJed Brown 
51141c3436cfSJed Brown    Input Arguments:
51151c3436cfSJed Brown +  ts - time integration context
51161c3436cfSJed Brown .  atol - scalar absolute tolerances, PETSC_DECIDE to leave current value
51170298fd71SBarry Smith .  vatol - vector of absolute tolerances or NULL, used in preference to atol if present
51181c3436cfSJed Brown .  rtol - scalar relative tolerances, PETSC_DECIDE to leave current value
51190298fd71SBarry Smith -  vrtol - vector of relative tolerances or NULL, used in preference to atol if present
51201c3436cfSJed Brown 
5121a3cdaa26SBarry Smith    Options Database keys:
5122a3cdaa26SBarry Smith +  -ts_rtol <rtol> - relative tolerance for local truncation error
5123a3cdaa26SBarry Smith -  -ts_atol <atol> Absolute tolerance for local truncation error
5124a3cdaa26SBarry Smith 
51253ff766beSShri Abhyankar    Notes:
51263ff766beSShri Abhyankar    With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
51273ff766beSShri Abhyankar    (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
51283ff766beSShri Abhyankar    computed only for the differential or the algebraic part then this can be done using the vector of
51293ff766beSShri Abhyankar    tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
51303ff766beSShri Abhyankar    differential part and infinity for the algebraic part, the LTE calculation will include only the
51313ff766beSShri Abhyankar    differential variables.
51323ff766beSShri Abhyankar 
51331c3436cfSJed Brown    Level: beginner
51341c3436cfSJed Brown 
5135c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSGetTolerances()
51361c3436cfSJed Brown @*/
51371c3436cfSJed Brown PetscErrorCode TSSetTolerances(TS ts,PetscReal atol,Vec vatol,PetscReal rtol,Vec vrtol)
51381c3436cfSJed Brown {
51391c3436cfSJed Brown   PetscErrorCode ierr;
51401c3436cfSJed Brown 
51411c3436cfSJed Brown   PetscFunctionBegin;
5142c5033834SJed Brown   if (atol != PETSC_DECIDE && atol != PETSC_DEFAULT) ts->atol = atol;
51431c3436cfSJed Brown   if (vatol) {
51441c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vatol);CHKERRQ(ierr);
51451c3436cfSJed Brown     ierr = VecDestroy(&ts->vatol);CHKERRQ(ierr);
5146bbd56ea5SKarl Rupp 
51471c3436cfSJed Brown     ts->vatol = vatol;
51481c3436cfSJed Brown   }
5149c5033834SJed Brown   if (rtol != PETSC_DECIDE && rtol != PETSC_DEFAULT) ts->rtol = rtol;
51501c3436cfSJed Brown   if (vrtol) {
51511c3436cfSJed Brown     ierr = PetscObjectReference((PetscObject)vrtol);CHKERRQ(ierr);
51521c3436cfSJed Brown     ierr = VecDestroy(&ts->vrtol);CHKERRQ(ierr);
5153bbd56ea5SKarl Rupp 
51541c3436cfSJed Brown     ts->vrtol = vrtol;
51551c3436cfSJed Brown   }
51561c3436cfSJed Brown   PetscFunctionReturn(0);
51571c3436cfSJed Brown }
51581c3436cfSJed Brown 
51591c3436cfSJed Brown #undef __FUNCT__
5160c5033834SJed Brown #define __FUNCT__ "TSGetTolerances"
5161c5033834SJed Brown /*@
5162c5033834SJed Brown    TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
5163c5033834SJed Brown 
5164c5033834SJed Brown    Logically Collective
5165c5033834SJed Brown 
5166c5033834SJed Brown    Input Arguments:
5167c5033834SJed Brown .  ts - time integration context
5168c5033834SJed Brown 
5169c5033834SJed Brown    Output Arguments:
51700298fd71SBarry Smith +  atol - scalar absolute tolerances, NULL to ignore
51710298fd71SBarry Smith .  vatol - vector of absolute tolerances, NULL to ignore
51720298fd71SBarry Smith .  rtol - scalar relative tolerances, NULL to ignore
51730298fd71SBarry Smith -  vrtol - vector of relative tolerances, NULL to ignore
5174c5033834SJed Brown 
5175c5033834SJed Brown    Level: beginner
5176c5033834SJed Brown 
5177c5033834SJed Brown .seealso: TS, TSAdapt, TSVecNormWRMS(), TSSetTolerances()
5178c5033834SJed Brown @*/
5179c5033834SJed Brown PetscErrorCode TSGetTolerances(TS ts,PetscReal *atol,Vec *vatol,PetscReal *rtol,Vec *vrtol)
5180c5033834SJed Brown {
5181c5033834SJed Brown   PetscFunctionBegin;
5182c5033834SJed Brown   if (atol)  *atol  = ts->atol;
5183c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5184c5033834SJed Brown   if (rtol)  *rtol  = ts->rtol;
5185c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
5186c5033834SJed Brown   PetscFunctionReturn(0);
5187c5033834SJed Brown }
5188c5033834SJed Brown 
5189c5033834SJed Brown #undef __FUNCT__
51909c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNorm2"
51919c6b16b5SShri Abhyankar /*@
5192a4868fbcSLisandro Dalcin    TSErrorWeightedNorm2 - compute a weighted 2-norm of the difference between two state vectors
51939c6b16b5SShri Abhyankar 
51949c6b16b5SShri Abhyankar    Collective on TS
51959c6b16b5SShri Abhyankar 
51969c6b16b5SShri Abhyankar    Input Arguments:
51979c6b16b5SShri Abhyankar +  ts - time stepping context
5198a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5199a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
52009c6b16b5SShri Abhyankar 
52019c6b16b5SShri Abhyankar    Output Arguments:
52029c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
52039c6b16b5SShri Abhyankar 
52049c6b16b5SShri Abhyankar    Level: developer
52059c6b16b5SShri Abhyankar 
5206deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNormInfinity()
52079c6b16b5SShri Abhyankar @*/
5208a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm2(TS ts,Vec U,Vec Y,PetscReal *norm)
52099c6b16b5SShri Abhyankar {
52109c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
52119c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart;
52129c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
52139c6b16b5SShri Abhyankar   PetscReal         sum,gsum;
52149c6b16b5SShri Abhyankar   PetscReal         tol;
52159c6b16b5SShri Abhyankar 
52169c6b16b5SShri Abhyankar   PetscFunctionBegin;
52179c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5218a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5219a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5220a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5221a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5222a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5223a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5224a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
52259c6b16b5SShri Abhyankar 
52269c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
52279c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
52289c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
52299c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
52309c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
52319c6b16b5SShri Abhyankar   sum  = 0.;
52329c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
52339c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
52349c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52359c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52369c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52379c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52389c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52399c6b16b5SShri Abhyankar     }
52409c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52419c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52429c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
52439c6b16b5SShri Abhyankar     const PetscScalar *atol;
52449c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52459c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52469c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52479c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52489c6b16b5SShri Abhyankar     }
52499c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
52509c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
52519c6b16b5SShri Abhyankar     const PetscScalar *rtol;
52529c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52539c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52549c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52559c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52569c6b16b5SShri Abhyankar     }
52579c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
52589c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
52599c6b16b5SShri Abhyankar     for (i=0; i<n; i++) {
52609c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
52619c6b16b5SShri Abhyankar       sum += PetscSqr(PetscAbsScalar(y[i] - u[i]) / tol);
52629c6b16b5SShri Abhyankar     }
52639c6b16b5SShri Abhyankar   }
52649c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
52659c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
52669c6b16b5SShri Abhyankar 
52679c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&sum,&gsum,1,MPIU_REAL,MPIU_SUM,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
52689c6b16b5SShri Abhyankar   *norm = PetscSqrtReal(gsum / N);
52699c6b16b5SShri Abhyankar 
52709c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
52719c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
52729c6b16b5SShri Abhyankar }
52739c6b16b5SShri Abhyankar 
52749c6b16b5SShri Abhyankar #undef __FUNCT__
52759c6b16b5SShri Abhyankar #define __FUNCT__ "TSErrorWeightedNormInfinity"
52769c6b16b5SShri Abhyankar /*@
5277a4868fbcSLisandro Dalcin    TSErrorWeightedNormInfinity - compute a weighted infinity-norm of the difference between two state vectors
52789c6b16b5SShri Abhyankar 
52799c6b16b5SShri Abhyankar    Collective on TS
52809c6b16b5SShri Abhyankar 
52819c6b16b5SShri Abhyankar    Input Arguments:
52829c6b16b5SShri Abhyankar +  ts - time stepping context
5283a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5284a4868fbcSLisandro Dalcin -  Y - state vector to be compared to U
52859c6b16b5SShri Abhyankar 
52869c6b16b5SShri Abhyankar    Output Arguments:
52879c6b16b5SShri Abhyankar .  norm - weighted norm, a value of 1.0 is considered small
52889c6b16b5SShri Abhyankar 
52899c6b16b5SShri Abhyankar    Level: developer
52909c6b16b5SShri Abhyankar 
5291deea92deSShri .seealso: TSErrorWeightedNorm(), TSErrorWeightedNorm2()
52929c6b16b5SShri Abhyankar @*/
5293a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNormInfinity(TS ts,Vec U,Vec Y,PetscReal *norm)
52949c6b16b5SShri Abhyankar {
52959c6b16b5SShri Abhyankar   PetscErrorCode    ierr;
52969c6b16b5SShri Abhyankar   PetscInt          i,n,N,rstart,k;
52979c6b16b5SShri Abhyankar   const PetscScalar *u,*y;
52989c6b16b5SShri Abhyankar   PetscReal         max,gmax;
52999c6b16b5SShri Abhyankar   PetscReal         tol;
53009c6b16b5SShri Abhyankar 
53019c6b16b5SShri Abhyankar   PetscFunctionBegin;
53029c6b16b5SShri Abhyankar   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
5303a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(U,VEC_CLASSID,2);
5304a4868fbcSLisandro Dalcin   PetscValidHeaderSpecific(Y,VEC_CLASSID,3);
5305a4868fbcSLisandro Dalcin   PetscValidType(U,2);
5306a4868fbcSLisandro Dalcin   PetscValidType(Y,3);
5307a4868fbcSLisandro Dalcin   PetscCheckSameComm(U,2,Y,3);
5308a4868fbcSLisandro Dalcin   PetscValidPointer(norm,4);
5309a4868fbcSLisandro Dalcin   if (U == Y) SETERRQ(PetscObjectComm((PetscObject)U),PETSC_ERR_ARG_IDN,"U and Y cannot be the same vector");
53109c6b16b5SShri Abhyankar 
53119c6b16b5SShri Abhyankar   ierr = VecGetSize(U,&N);CHKERRQ(ierr);
53129c6b16b5SShri Abhyankar   ierr = VecGetLocalSize(U,&n);CHKERRQ(ierr);
53139c6b16b5SShri Abhyankar   ierr = VecGetOwnershipRange(U,&rstart,NULL);CHKERRQ(ierr);
53149c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(U,&u);CHKERRQ(ierr);
53159c6b16b5SShri Abhyankar   ierr = VecGetArrayRead(Y,&y);CHKERRQ(ierr);
53169c6b16b5SShri Abhyankar   if (ts->vatol && ts->vrtol) {
53179c6b16b5SShri Abhyankar     const PetscScalar *atol,*rtol;
53189c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53199c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53209c6b16b5SShri Abhyankar     k = 0;
53219c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53229c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53239c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53249c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53259c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53269c6b16b5SShri Abhyankar     }
53279c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53289c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53299c6b16b5SShri Abhyankar   } else if (ts->vatol) {       /* vector atol, scalar rtol */
53309c6b16b5SShri Abhyankar     const PetscScalar *atol;
53319c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53329c6b16b5SShri Abhyankar     k = 0;
53339c6b16b5SShri Abhyankar     tol = PetscRealPart(atol[k]) + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53349c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53359c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53369c6b16b5SShri Abhyankar       tol = PetscRealPart(atol[i]) + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53379c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53389c6b16b5SShri Abhyankar     }
53399c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vatol,&atol);CHKERRQ(ierr);
53409c6b16b5SShri Abhyankar   } else if (ts->vrtol) {       /* scalar atol, vector rtol */
53419c6b16b5SShri Abhyankar     const PetscScalar *rtol;
53429c6b16b5SShri Abhyankar     ierr = VecGetArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53439c6b16b5SShri Abhyankar     k = 0;
53449c6b16b5SShri Abhyankar     tol = ts->atol + PetscRealPart(rtol[k]) * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53459c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53469c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53479c6b16b5SShri Abhyankar       tol = ts->atol + PetscRealPart(rtol[i]) * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53489c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53499c6b16b5SShri Abhyankar     }
53509c6b16b5SShri Abhyankar     ierr = VecRestoreArrayRead(ts->vrtol,&rtol);CHKERRQ(ierr);
53519c6b16b5SShri Abhyankar   } else {                      /* scalar atol, scalar rtol */
53529c6b16b5SShri Abhyankar     k = 0;
53539c6b16b5SShri Abhyankar     tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[k]),PetscAbsScalar(y[k]));
53549c6b16b5SShri Abhyankar     max = PetscAbsScalar(y[k] - u[k]) / tol;
53559c6b16b5SShri Abhyankar     for (i=1; i<n; i++) {
53569c6b16b5SShri Abhyankar       tol = ts->atol + ts->rtol * PetscMax(PetscAbsScalar(u[i]),PetscAbsScalar(y[i]));
53579c6b16b5SShri Abhyankar       max = PetscMax(max,PetscAbsScalar(y[i] - u[i]) / tol);
53589c6b16b5SShri Abhyankar     }
53599c6b16b5SShri Abhyankar   }
53609c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(U,&u);CHKERRQ(ierr);
53619c6b16b5SShri Abhyankar   ierr = VecRestoreArrayRead(Y,&y);CHKERRQ(ierr);
53629c6b16b5SShri Abhyankar 
53639c6b16b5SShri Abhyankar   ierr  = MPI_Allreduce(&max,&gmax,1,MPIU_REAL,MPIU_MAX,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
53649c6b16b5SShri Abhyankar   *norm = gmax;
53659c6b16b5SShri Abhyankar 
53669c6b16b5SShri Abhyankar   if (PetscIsInfOrNanScalar(*norm)) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_FP,"Infinite or not-a-number generated in norm");
53679c6b16b5SShri Abhyankar   PetscFunctionReturn(0);
53689c6b16b5SShri Abhyankar }
53699c6b16b5SShri Abhyankar 
53709c6b16b5SShri Abhyankar #undef __FUNCT__
53717619abb3SShri #define __FUNCT__ "TSErrorWeightedNorm"
53721c3436cfSJed Brown /*@
5373a4868fbcSLisandro Dalcin    TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors
53741c3436cfSJed Brown 
53751c3436cfSJed Brown    Collective on TS
53761c3436cfSJed Brown 
53771c3436cfSJed Brown    Input Arguments:
53781c3436cfSJed Brown +  ts - time stepping context
5379a4868fbcSLisandro Dalcin .  U - state vector, usually ts->vec_sol
5380a4868fbcSLisandro Dalcin .  Y - state vector to be compared to U
5381a4868fbcSLisandro Dalcin -  wnormtype - norm type, either NORM_2 or NORM_INFINITY
53827619abb3SShri 
53831c3436cfSJed Brown    Output Arguments:
53841c3436cfSJed Brown .  norm - weighted norm, a value of 1.0 is considered small
53851c3436cfSJed Brown 
5386a4868fbcSLisandro Dalcin 
5387a4868fbcSLisandro Dalcin    Options Database Keys:
5388a4868fbcSLisandro Dalcin .  -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5389a4868fbcSLisandro Dalcin 
53901c3436cfSJed Brown    Level: developer
53911c3436cfSJed Brown 
5392deea92deSShri .seealso: TSErrorWeightedNormInfinity(), TSErrorWeightedNorm2()
53931c3436cfSJed Brown @*/
5394a4868fbcSLisandro Dalcin PetscErrorCode TSErrorWeightedNorm(TS ts,Vec U,Vec Y,NormType wnormtype,PetscReal *norm)
53951c3436cfSJed Brown {
53968beabaa1SBarry Smith   PetscErrorCode ierr;
53971c3436cfSJed Brown 
53981c3436cfSJed Brown   PetscFunctionBegin;
5399a4868fbcSLisandro Dalcin   if (wnormtype == NORM_2) {
5400a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNorm2(ts,U,Y,norm);CHKERRQ(ierr);
5401a4868fbcSLisandro Dalcin   } else if(wnormtype == NORM_INFINITY) {
5402a4868fbcSLisandro Dalcin     ierr = TSErrorWeightedNormInfinity(ts,U,Y,norm);CHKERRQ(ierr);
5403a4868fbcSLisandro Dalcin   } else SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for norm type %s",NormTypes[wnormtype]);
54041c3436cfSJed Brown   PetscFunctionReturn(0);
54051c3436cfSJed Brown }
54061c3436cfSJed Brown 
54071c3436cfSJed Brown #undef __FUNCT__
54088d59e960SJed Brown #define __FUNCT__ "TSSetCFLTimeLocal"
54098d59e960SJed Brown /*@
54108d59e960SJed Brown    TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
54118d59e960SJed Brown 
54128d59e960SJed Brown    Logically Collective on TS
54138d59e960SJed Brown 
54148d59e960SJed Brown    Input Arguments:
54158d59e960SJed Brown +  ts - time stepping context
54168d59e960SJed Brown -  cfltime - maximum stable time step if using forward Euler (value can be different on each process)
54178d59e960SJed Brown 
54188d59e960SJed Brown    Note:
54198d59e960SJed Brown    After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
54208d59e960SJed Brown 
54218d59e960SJed Brown    Level: intermediate
54228d59e960SJed Brown 
54238d59e960SJed Brown .seealso: TSGetCFLTime(), TSADAPTCFL
54248d59e960SJed Brown @*/
54258d59e960SJed Brown PetscErrorCode TSSetCFLTimeLocal(TS ts,PetscReal cfltime)
54268d59e960SJed Brown {
54278d59e960SJed Brown   PetscFunctionBegin;
54288d59e960SJed Brown   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
54298d59e960SJed Brown   ts->cfltime_local = cfltime;
54308d59e960SJed Brown   ts->cfltime       = -1.;
54318d59e960SJed Brown   PetscFunctionReturn(0);
54328d59e960SJed Brown }
54338d59e960SJed Brown 
54348d59e960SJed Brown #undef __FUNCT__
54358d59e960SJed Brown #define __FUNCT__ "TSGetCFLTime"
54368d59e960SJed Brown /*@
54378d59e960SJed Brown    TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
54388d59e960SJed Brown 
54398d59e960SJed Brown    Collective on TS
54408d59e960SJed Brown 
54418d59e960SJed Brown    Input Arguments:
54428d59e960SJed Brown .  ts - time stepping context
54438d59e960SJed Brown 
54448d59e960SJed Brown    Output Arguments:
54458d59e960SJed Brown .  cfltime - maximum stable time step for forward Euler
54468d59e960SJed Brown 
54478d59e960SJed Brown    Level: advanced
54488d59e960SJed Brown 
54498d59e960SJed Brown .seealso: TSSetCFLTimeLocal()
54508d59e960SJed Brown @*/
54518d59e960SJed Brown PetscErrorCode TSGetCFLTime(TS ts,PetscReal *cfltime)
54528d59e960SJed Brown {
54538d59e960SJed Brown   PetscErrorCode ierr;
54548d59e960SJed Brown 
54558d59e960SJed Brown   PetscFunctionBegin;
54568d59e960SJed Brown   if (ts->cfltime < 0) {
5457ce94432eSBarry Smith     ierr = MPI_Allreduce(&ts->cfltime_local,&ts->cfltime,1,MPIU_REAL,MPIU_MIN,PetscObjectComm((PetscObject)ts));CHKERRQ(ierr);
54588d59e960SJed Brown   }
54598d59e960SJed Brown   *cfltime = ts->cfltime;
54608d59e960SJed Brown   PetscFunctionReturn(0);
54618d59e960SJed Brown }
54628d59e960SJed Brown 
54638d59e960SJed Brown #undef __FUNCT__
5464d6ebe24aSShri Abhyankar #define __FUNCT__ "TSVISetVariableBounds"
5465d6ebe24aSShri Abhyankar /*@
5466d6ebe24aSShri Abhyankar    TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5467d6ebe24aSShri Abhyankar 
5468d6ebe24aSShri Abhyankar    Input Parameters:
5469d6ebe24aSShri Abhyankar .  ts   - the TS context.
5470d6ebe24aSShri Abhyankar .  xl   - lower bound.
5471d6ebe24aSShri Abhyankar .  xu   - upper bound.
5472d6ebe24aSShri Abhyankar 
5473d6ebe24aSShri Abhyankar    Notes:
5474d6ebe24aSShri Abhyankar    If this routine is not called then the lower and upper bounds are set to
5475e270355aSBarry Smith    PETSC_NINFINITY and PETSC_INFINITY respectively during SNESSetUp().
5476d6ebe24aSShri Abhyankar 
54772bd2b0e6SSatish Balay    Level: advanced
54782bd2b0e6SSatish Balay 
5479d6ebe24aSShri Abhyankar @*/
5480d6ebe24aSShri Abhyankar PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5481d6ebe24aSShri Abhyankar {
5482d6ebe24aSShri Abhyankar   PetscErrorCode ierr;
5483d6ebe24aSShri Abhyankar   SNES           snes;
5484d6ebe24aSShri Abhyankar 
5485d6ebe24aSShri Abhyankar   PetscFunctionBegin;
5486d6ebe24aSShri Abhyankar   ierr = TSGetSNES(ts,&snes);CHKERRQ(ierr);
5487d6ebe24aSShri Abhyankar   ierr = SNESVISetVariableBounds(snes,xl,xu);CHKERRQ(ierr);
5488d6ebe24aSShri Abhyankar   PetscFunctionReturn(0);
5489d6ebe24aSShri Abhyankar }
5490d6ebe24aSShri Abhyankar 
5491325fc9f4SBarry Smith #if defined(PETSC_HAVE_MATLAB_ENGINE)
5492c6db04a5SJed Brown #include <mex.h>
5493325fc9f4SBarry Smith 
5494325fc9f4SBarry Smith typedef struct {char *funcname; mxArray *ctx;} TSMatlabContext;
5495325fc9f4SBarry Smith 
5496325fc9f4SBarry Smith #undef __FUNCT__
5497325fc9f4SBarry Smith #define __FUNCT__ "TSComputeFunction_Matlab"
5498325fc9f4SBarry Smith /*
5499325fc9f4SBarry Smith    TSComputeFunction_Matlab - Calls the function that has been set with
5500325fc9f4SBarry Smith                          TSSetFunctionMatlab().
5501325fc9f4SBarry Smith 
5502325fc9f4SBarry Smith    Collective on TS
5503325fc9f4SBarry Smith 
5504325fc9f4SBarry Smith    Input Parameters:
5505325fc9f4SBarry Smith +  snes - the TS context
55060910c330SBarry Smith -  u - input vector
5507325fc9f4SBarry Smith 
5508325fc9f4SBarry Smith    Output Parameter:
5509325fc9f4SBarry Smith .  y - function vector, as set by TSSetFunction()
5510325fc9f4SBarry Smith 
5511325fc9f4SBarry Smith    Notes:
5512325fc9f4SBarry Smith    TSComputeFunction() is typically used within nonlinear solvers
5513325fc9f4SBarry Smith    implementations, so most users would not generally call this routine
5514325fc9f4SBarry Smith    themselves.
5515325fc9f4SBarry Smith 
5516325fc9f4SBarry Smith    Level: developer
5517325fc9f4SBarry Smith 
5518325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5519325fc9f4SBarry Smith 
5520325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5521325fc9f4SBarry Smith */
55220910c330SBarry Smith PetscErrorCode  TSComputeFunction_Matlab(TS snes,PetscReal time,Vec u,Vec udot,Vec y, void *ctx)
5523325fc9f4SBarry Smith {
5524325fc9f4SBarry Smith   PetscErrorCode  ierr;
5525325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5526325fc9f4SBarry Smith   int             nlhs  = 1,nrhs = 7;
5527325fc9f4SBarry Smith   mxArray         *plhs[1],*prhs[7];
5528325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,ly = 0,ls = 0;
5529325fc9f4SBarry Smith 
5530325fc9f4SBarry Smith   PetscFunctionBegin;
5531325fc9f4SBarry Smith   PetscValidHeaderSpecific(snes,TS_CLASSID,1);
55320910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
55330910c330SBarry Smith   PetscValidHeaderSpecific(udot,VEC_CLASSID,4);
5534325fc9f4SBarry Smith   PetscValidHeaderSpecific(y,VEC_CLASSID,5);
55350910c330SBarry Smith   PetscCheckSameComm(snes,1,u,3);
5536325fc9f4SBarry Smith   PetscCheckSameComm(snes,1,y,5);
5537325fc9f4SBarry Smith 
5538325fc9f4SBarry Smith   ierr = PetscMemcpy(&ls,&snes,sizeof(snes));CHKERRQ(ierr);
55390910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
55400910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(udot));CHKERRQ(ierr);
55410910c330SBarry Smith   ierr = PetscMemcpy(&ly,&y,sizeof(u));CHKERRQ(ierr);
5542bbd56ea5SKarl Rupp 
5543325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5544325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar(time);
5545325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5546325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5547325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)ly);
5548325fc9f4SBarry Smith   prhs[5] =  mxCreateString(sctx->funcname);
5549325fc9f4SBarry Smith   prhs[6] =  sctx->ctx;
5550325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeFunctionInternal");CHKERRQ(ierr);
5551325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5552325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5553325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5554325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5555325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5556325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5557325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5558325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5559325fc9f4SBarry Smith   PetscFunctionReturn(0);
5560325fc9f4SBarry Smith }
5561325fc9f4SBarry Smith 
5562325fc9f4SBarry Smith 
5563325fc9f4SBarry Smith #undef __FUNCT__
5564325fc9f4SBarry Smith #define __FUNCT__ "TSSetFunctionMatlab"
5565325fc9f4SBarry Smith /*
5566325fc9f4SBarry Smith    TSSetFunctionMatlab - Sets the function evaluation routine and function
5567325fc9f4SBarry Smith    vector for use by the TS routines in solving ODEs
5568e3c5b3baSBarry Smith    equations from MATLAB. Here the function is a string containing the name of a MATLAB function
5569325fc9f4SBarry Smith 
5570325fc9f4SBarry Smith    Logically Collective on TS
5571325fc9f4SBarry Smith 
5572325fc9f4SBarry Smith    Input Parameters:
5573325fc9f4SBarry Smith +  ts - the TS context
5574325fc9f4SBarry Smith -  func - function evaluation routine
5575325fc9f4SBarry Smith 
5576325fc9f4SBarry Smith    Calling sequence of func:
55770910c330SBarry Smith $    func (TS ts,PetscReal time,Vec u,Vec udot,Vec f,void *ctx);
5578325fc9f4SBarry Smith 
5579325fc9f4SBarry Smith    Level: beginner
5580325fc9f4SBarry Smith 
5581325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5582325fc9f4SBarry Smith 
5583325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5584325fc9f4SBarry Smith */
5585cdcf91faSSean Farley PetscErrorCode  TSSetFunctionMatlab(TS ts,const char *func,mxArray *ctx)
5586325fc9f4SBarry Smith {
5587325fc9f4SBarry Smith   PetscErrorCode  ierr;
5588325fc9f4SBarry Smith   TSMatlabContext *sctx;
5589325fc9f4SBarry Smith 
5590325fc9f4SBarry Smith   PetscFunctionBegin;
5591325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5592325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5593325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5594325fc9f4SBarry Smith   /*
5595325fc9f4SBarry Smith      This should work, but it doesn't
5596325fc9f4SBarry Smith   sctx->ctx = ctx;
5597325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5598325fc9f4SBarry Smith   */
5599325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5600bbd56ea5SKarl Rupp 
56010298fd71SBarry Smith   ierr = TSSetIFunction(ts,NULL,TSComputeFunction_Matlab,sctx);CHKERRQ(ierr);
5602325fc9f4SBarry Smith   PetscFunctionReturn(0);
5603325fc9f4SBarry Smith }
5604325fc9f4SBarry Smith 
5605325fc9f4SBarry Smith #undef __FUNCT__
5606325fc9f4SBarry Smith #define __FUNCT__ "TSComputeJacobian_Matlab"
5607325fc9f4SBarry Smith /*
5608325fc9f4SBarry Smith    TSComputeJacobian_Matlab - Calls the function that has been set with
5609325fc9f4SBarry Smith                          TSSetJacobianMatlab().
5610325fc9f4SBarry Smith 
5611325fc9f4SBarry Smith    Collective on TS
5612325fc9f4SBarry Smith 
5613325fc9f4SBarry Smith    Input Parameters:
5614cdcf91faSSean Farley +  ts - the TS context
56150910c330SBarry Smith .  u - input vector
5616325fc9f4SBarry Smith .  A, B - the matrices
5617325fc9f4SBarry Smith -  ctx - user context
5618325fc9f4SBarry Smith 
5619325fc9f4SBarry Smith    Level: developer
5620325fc9f4SBarry Smith 
5621325fc9f4SBarry Smith .keywords: TS, nonlinear, compute, function
5622325fc9f4SBarry Smith 
5623325fc9f4SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5624325fc9f4SBarry Smith @*/
5625f3229a78SSatish Balay PetscErrorCode  TSComputeJacobian_Matlab(TS ts,PetscReal time,Vec u,Vec udot,PetscReal shift,Mat A,Mat B,void *ctx)
5626325fc9f4SBarry Smith {
5627325fc9f4SBarry Smith   PetscErrorCode  ierr;
5628325fc9f4SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5629325fc9f4SBarry Smith   int             nlhs  = 2,nrhs = 9;
5630325fc9f4SBarry Smith   mxArray         *plhs[2],*prhs[9];
5631325fc9f4SBarry Smith   long long int   lx = 0,lxdot = 0,lA = 0,ls = 0, lB = 0;
5632325fc9f4SBarry Smith 
5633325fc9f4SBarry Smith   PetscFunctionBegin;
5634cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
56350910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,3);
5636325fc9f4SBarry Smith 
56370910c330SBarry Smith   /* call Matlab function in ctx with arguments u and y */
5638325fc9f4SBarry Smith 
5639cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
56400910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
56410910c330SBarry Smith   ierr = PetscMemcpy(&lxdot,&udot,sizeof(u));CHKERRQ(ierr);
56420910c330SBarry Smith   ierr = PetscMemcpy(&lA,A,sizeof(u));CHKERRQ(ierr);
56430910c330SBarry Smith   ierr = PetscMemcpy(&lB,B,sizeof(u));CHKERRQ(ierr);
5644bbd56ea5SKarl Rupp 
5645325fc9f4SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5646325fc9f4SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)time);
5647325fc9f4SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)lx);
5648325fc9f4SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lxdot);
5649325fc9f4SBarry Smith   prhs[4] =  mxCreateDoubleScalar((double)shift);
5650325fc9f4SBarry Smith   prhs[5] =  mxCreateDoubleScalar((double)lA);
5651325fc9f4SBarry Smith   prhs[6] =  mxCreateDoubleScalar((double)lB);
5652325fc9f4SBarry Smith   prhs[7] =  mxCreateString(sctx->funcname);
5653325fc9f4SBarry Smith   prhs[8] =  sctx->ctx;
5654325fc9f4SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSComputeJacobianInternal");CHKERRQ(ierr);
5655325fc9f4SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5656325fc9f4SBarry Smith   mxDestroyArray(prhs[0]);
5657325fc9f4SBarry Smith   mxDestroyArray(prhs[1]);
5658325fc9f4SBarry Smith   mxDestroyArray(prhs[2]);
5659325fc9f4SBarry Smith   mxDestroyArray(prhs[3]);
5660325fc9f4SBarry Smith   mxDestroyArray(prhs[4]);
5661325fc9f4SBarry Smith   mxDestroyArray(prhs[5]);
5662325fc9f4SBarry Smith   mxDestroyArray(prhs[6]);
5663325fc9f4SBarry Smith   mxDestroyArray(prhs[7]);
5664325fc9f4SBarry Smith   mxDestroyArray(plhs[0]);
5665325fc9f4SBarry Smith   mxDestroyArray(plhs[1]);
5666325fc9f4SBarry Smith   PetscFunctionReturn(0);
5667325fc9f4SBarry Smith }
5668325fc9f4SBarry Smith 
5669325fc9f4SBarry Smith 
5670325fc9f4SBarry Smith #undef __FUNCT__
5671325fc9f4SBarry Smith #define __FUNCT__ "TSSetJacobianMatlab"
5672325fc9f4SBarry Smith /*
5673325fc9f4SBarry Smith    TSSetJacobianMatlab - Sets the Jacobian function evaluation routine and two empty Jacobian matrices
5674e3c5b3baSBarry 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
5675325fc9f4SBarry Smith 
5676325fc9f4SBarry Smith    Logically Collective on TS
5677325fc9f4SBarry Smith 
5678325fc9f4SBarry Smith    Input Parameters:
5679cdcf91faSSean Farley +  ts - the TS context
5680325fc9f4SBarry Smith .  A,B - Jacobian matrices
5681325fc9f4SBarry Smith .  func - function evaluation routine
5682325fc9f4SBarry Smith -  ctx - user context
5683325fc9f4SBarry Smith 
5684325fc9f4SBarry Smith    Calling sequence of func:
56850910c330SBarry Smith $    flag = func (TS ts,PetscReal time,Vec u,Vec udot,Mat A,Mat B,void *ctx);
5686325fc9f4SBarry Smith 
5687325fc9f4SBarry Smith 
5688325fc9f4SBarry Smith    Level: developer
5689325fc9f4SBarry Smith 
5690325fc9f4SBarry Smith .keywords: TS, nonlinear, set, function
5691325fc9f4SBarry Smith 
5692325fc9f4SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5693325fc9f4SBarry Smith */
5694cdcf91faSSean Farley PetscErrorCode  TSSetJacobianMatlab(TS ts,Mat A,Mat B,const char *func,mxArray *ctx)
5695325fc9f4SBarry Smith {
5696325fc9f4SBarry Smith   PetscErrorCode  ierr;
5697325fc9f4SBarry Smith   TSMatlabContext *sctx;
5698325fc9f4SBarry Smith 
5699325fc9f4SBarry Smith   PetscFunctionBegin;
5700325fc9f4SBarry Smith   /* currently sctx is memory bleed */
5701325fc9f4SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5702325fc9f4SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5703325fc9f4SBarry Smith   /*
5704325fc9f4SBarry Smith      This should work, but it doesn't
5705325fc9f4SBarry Smith   sctx->ctx = ctx;
5706325fc9f4SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5707325fc9f4SBarry Smith   */
5708325fc9f4SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5709bbd56ea5SKarl Rupp 
5710cdcf91faSSean Farley   ierr = TSSetIJacobian(ts,A,B,TSComputeJacobian_Matlab,sctx);CHKERRQ(ierr);
5711325fc9f4SBarry Smith   PetscFunctionReturn(0);
5712325fc9f4SBarry Smith }
5713325fc9f4SBarry Smith 
5714b5b1a830SBarry Smith #undef __FUNCT__
5715b5b1a830SBarry Smith #define __FUNCT__ "TSMonitor_Matlab"
5716b5b1a830SBarry Smith /*
5717b5b1a830SBarry Smith    TSMonitor_Matlab - Calls the function that has been set with TSMonitorSetMatlab().
5718b5b1a830SBarry Smith 
5719b5b1a830SBarry Smith    Collective on TS
5720b5b1a830SBarry Smith 
5721b5b1a830SBarry Smith .seealso: TSSetFunction(), TSGetFunction()
5722b5b1a830SBarry Smith @*/
57230910c330SBarry Smith PetscErrorCode  TSMonitor_Matlab(TS ts,PetscInt it, PetscReal time,Vec u, void *ctx)
5724b5b1a830SBarry Smith {
5725b5b1a830SBarry Smith   PetscErrorCode  ierr;
5726b5b1a830SBarry Smith   TSMatlabContext *sctx = (TSMatlabContext*)ctx;
5727a530c242SBarry Smith   int             nlhs  = 1,nrhs = 6;
5728b5b1a830SBarry Smith   mxArray         *plhs[1],*prhs[6];
5729b5b1a830SBarry Smith   long long int   lx = 0,ls = 0;
5730b5b1a830SBarry Smith 
5731b5b1a830SBarry Smith   PetscFunctionBegin;
5732cdcf91faSSean Farley   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
57330910c330SBarry Smith   PetscValidHeaderSpecific(u,VEC_CLASSID,4);
5734b5b1a830SBarry Smith 
5735cdcf91faSSean Farley   ierr = PetscMemcpy(&ls,&ts,sizeof(ts));CHKERRQ(ierr);
57360910c330SBarry Smith   ierr = PetscMemcpy(&lx,&u,sizeof(u));CHKERRQ(ierr);
5737bbd56ea5SKarl Rupp 
5738b5b1a830SBarry Smith   prhs[0] =  mxCreateDoubleScalar((double)ls);
5739b5b1a830SBarry Smith   prhs[1] =  mxCreateDoubleScalar((double)it);
5740b5b1a830SBarry Smith   prhs[2] =  mxCreateDoubleScalar((double)time);
5741b5b1a830SBarry Smith   prhs[3] =  mxCreateDoubleScalar((double)lx);
5742b5b1a830SBarry Smith   prhs[4] =  mxCreateString(sctx->funcname);
5743b5b1a830SBarry Smith   prhs[5] =  sctx->ctx;
5744b5b1a830SBarry Smith   ierr    =  mexCallMATLAB(nlhs,plhs,nrhs,prhs,"PetscTSMonitorInternal");CHKERRQ(ierr);
5745b5b1a830SBarry Smith   ierr    =  mxGetScalar(plhs[0]);CHKERRQ(ierr);
5746b5b1a830SBarry Smith   mxDestroyArray(prhs[0]);
5747b5b1a830SBarry Smith   mxDestroyArray(prhs[1]);
5748b5b1a830SBarry Smith   mxDestroyArray(prhs[2]);
5749b5b1a830SBarry Smith   mxDestroyArray(prhs[3]);
5750b5b1a830SBarry Smith   mxDestroyArray(prhs[4]);
5751b5b1a830SBarry Smith   mxDestroyArray(plhs[0]);
5752b5b1a830SBarry Smith   PetscFunctionReturn(0);
5753b5b1a830SBarry Smith }
5754b5b1a830SBarry Smith 
5755b5b1a830SBarry Smith 
5756b5b1a830SBarry Smith #undef __FUNCT__
5757b5b1a830SBarry Smith #define __FUNCT__ "TSMonitorSetMatlab"
5758b5b1a830SBarry Smith /*
5759b5b1a830SBarry Smith    TSMonitorSetMatlab - Sets the monitor function from Matlab
5760b5b1a830SBarry Smith 
5761b5b1a830SBarry Smith    Level: developer
5762b5b1a830SBarry Smith 
5763b5b1a830SBarry Smith .keywords: TS, nonlinear, set, function
5764b5b1a830SBarry Smith 
5765b5b1a830SBarry Smith .seealso: TSGetFunction(), TSComputeFunction(), TSSetJacobian(), TSSetFunction()
5766b5b1a830SBarry Smith */
5767cdcf91faSSean Farley PetscErrorCode  TSMonitorSetMatlab(TS ts,const char *func,mxArray *ctx)
5768b5b1a830SBarry Smith {
5769b5b1a830SBarry Smith   PetscErrorCode  ierr;
5770b5b1a830SBarry Smith   TSMatlabContext *sctx;
5771b5b1a830SBarry Smith 
5772b5b1a830SBarry Smith   PetscFunctionBegin;
5773b5b1a830SBarry Smith   /* currently sctx is memory bleed */
5774b5b1a830SBarry Smith   ierr = PetscMalloc(sizeof(TSMatlabContext),&sctx);CHKERRQ(ierr);
5775b5b1a830SBarry Smith   ierr = PetscStrallocpy(func,&sctx->funcname);CHKERRQ(ierr);
5776b5b1a830SBarry Smith   /*
5777b5b1a830SBarry Smith      This should work, but it doesn't
5778b5b1a830SBarry Smith   sctx->ctx = ctx;
5779b5b1a830SBarry Smith   mexMakeArrayPersistent(sctx->ctx);
5780b5b1a830SBarry Smith   */
5781b5b1a830SBarry Smith   sctx->ctx = mxDuplicateArray(ctx);
5782bbd56ea5SKarl Rupp 
57830298fd71SBarry Smith   ierr = TSMonitorSet(ts,TSMonitor_Matlab,sctx,NULL);CHKERRQ(ierr);
5784b5b1a830SBarry Smith   PetscFunctionReturn(0);
5785b5b1a830SBarry Smith }
5786325fc9f4SBarry Smith #endif
5787b3603a34SBarry Smith 
5788b3603a34SBarry Smith #undef __FUNCT__
57894f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGSolution"
5790b3603a34SBarry Smith /*@C
57914f09c107SBarry Smith    TSMonitorLGSolution - Monitors progress of the TS solvers by plotting each component of the solution vector
5792b3603a34SBarry Smith        in a time based line graph
5793b3603a34SBarry Smith 
5794b3603a34SBarry Smith    Collective on TS
5795b3603a34SBarry Smith 
5796b3603a34SBarry Smith    Input Parameters:
5797b3603a34SBarry Smith +  ts - the TS context
5798b3603a34SBarry Smith .  step - current time-step
5799b3603a34SBarry Smith .  ptime - current time
58007db568b7SBarry Smith .  u - current solution
58017db568b7SBarry Smith -  dctx - the TSMonitorLGCtx object that contains all the options for the monitoring, this is created with TSMonitorLGCtxCreate()
5802b3603a34SBarry Smith 
5803b3d3934dSBarry Smith    Options Database:
58049ae14b6eSBarry Smith .   -ts_monitor_lg_solution_variables
5805b3d3934dSBarry Smith 
5806b3603a34SBarry Smith    Level: intermediate
5807b3603a34SBarry Smith 
58080b039ecaSBarry Smith     Notes: each process in a parallel run displays its component solutions in a separate window
5809b3603a34SBarry Smith 
5810b3603a34SBarry Smith .keywords: TS,  vector, monitor, view
5811b3603a34SBarry Smith 
58127db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGCtxCreate(), TSMonitorLGCtxSetVariableNames(), TSMonitorLGCtxGetVariableNames(),
58137db568b7SBarry Smith            TSMonitorLGSetVariableNames(), TSMonitorLGGetVariableNames(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetDisplayVariables(),
58147db568b7SBarry Smith            TSMonitorLGCtxSetTransform(), TSMonitorLGSetTransform(), TSMonitorLGError(), TSMonitorLGSNESIterations(), TSMonitorLGKSPIterations(),
58157db568b7SBarry Smith            TSMonitorEnvelopeCtxCreate(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxDestroy(), TSMonitorEnvelop()
5816b3603a34SBarry Smith @*/
58177db568b7SBarry Smith PetscErrorCode  TSMonitorLGSolution(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
5818b3603a34SBarry Smith {
5819b3603a34SBarry Smith   PetscErrorCode    ierr;
58207db568b7SBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dctx;
5821b3603a34SBarry Smith   const PetscScalar *yy;
582258ff32f7SBarry Smith   PetscInt          dim;
582380666b62SBarry Smith   Vec               v;
5824b3603a34SBarry Smith 
5825b3603a34SBarry Smith   PetscFunctionBegin;
582658ff32f7SBarry Smith   if (!step) {
5827a9f9c1f6SBarry Smith     PetscDrawAxis axis;
5828a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
5829a9f9c1f6SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Solution as function of time","Time","Solution");CHKERRQ(ierr);
5830387f4636SBarry Smith     if (ctx->names && !ctx->displaynames) {
5831387f4636SBarry Smith       char      **displaynames;
5832387f4636SBarry Smith       PetscBool flg;
5833387f4636SBarry Smith 
5834387f4636SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
5835387f4636SBarry Smith       ierr = PetscMalloc((dim+1)*sizeof(char*),&displaynames);CHKERRQ(ierr);
5836387f4636SBarry Smith       ierr = PetscMemzero(displaynames,(dim+1)*sizeof(char*));CHKERRQ(ierr);
58379ae14b6eSBarry Smith       ierr = PetscOptionsGetStringArray(((PetscObject)ts)->prefix,"-ts_monitor_lg_solution_variables",displaynames,&dim,&flg);CHKERRQ(ierr);
5838387f4636SBarry Smith       if (flg) {
5839a66092f1SBarry Smith         ierr = TSMonitorLGCtxSetDisplayVariables(ctx,(const char *const *)displaynames);CHKERRQ(ierr);
5840387f4636SBarry Smith       }
5841387f4636SBarry Smith       ierr = PetscStrArrayDestroy(&displaynames);CHKERRQ(ierr);
5842387f4636SBarry Smith     }
5843387f4636SBarry Smith     if (ctx->displaynames) {
5844387f4636SBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,ctx->ndisplayvariables);CHKERRQ(ierr);
5845387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->displaynames);CHKERRQ(ierr);
5846387f4636SBarry Smith     } else if (ctx->names) {
58470910c330SBarry Smith       ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
58480b039ecaSBarry Smith       ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
5849387f4636SBarry Smith       ierr = PetscDrawLGSetLegend(ctx->lg,(const char *const *)ctx->names);CHKERRQ(ierr);
5850387f4636SBarry Smith     }
58510b039ecaSBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
585258ff32f7SBarry Smith   }
585380666b62SBarry Smith   if (ctx->transform) {
5854e673d494SBarry Smith     ierr = (*ctx->transform)(ctx->transformctx,u,&v);CHKERRQ(ierr);
585580666b62SBarry Smith   } else {
585680666b62SBarry Smith     v = u;
585780666b62SBarry Smith   }
585880666b62SBarry Smith   ierr = VecGetArrayRead(v,&yy);CHKERRQ(ierr);
5859e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
5860e3efe391SJed Brown   {
5861e3efe391SJed Brown     PetscReal *yreal;
5862e3efe391SJed Brown     PetscInt  i,n;
586380666b62SBarry Smith     ierr = VecGetLocalSize(v,&n);CHKERRQ(ierr);
5864785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
5865e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
58660b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
5867e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
5868e3efe391SJed Brown   }
5869e3efe391SJed Brown #else
5870387f4636SBarry Smith   if (ctx->displaynames) {
5871387f4636SBarry Smith     PetscInt i;
5872387f4636SBarry Smith     for (i=0; i<ctx->ndisplayvariables; i++) {
5873387f4636SBarry Smith       ctx->displayvalues[i] = yy[ctx->displayvariables[i]];
5874387f4636SBarry Smith     }
5875387f4636SBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,ctx->displayvalues);CHKERRQ(ierr);
5876387f4636SBarry Smith   } else {
58770b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
5878387f4636SBarry Smith   }
5879e3efe391SJed Brown #endif
588080666b62SBarry Smith   ierr = VecRestoreArrayRead(v,&yy);CHKERRQ(ierr);
588180666b62SBarry Smith   if (ctx->transform) {
588280666b62SBarry Smith     ierr = VecDestroy(&v);CHKERRQ(ierr);
588380666b62SBarry Smith   }
5884b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
58850b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
58863923b477SBarry Smith   }
5887b3603a34SBarry Smith   PetscFunctionReturn(0);
5888b3603a34SBarry Smith }
5889b3603a34SBarry Smith 
5890387f4636SBarry Smith 
5891b3603a34SBarry Smith #undef __FUNCT__
589231152f8aSBarry Smith #define __FUNCT__ "TSMonitorLGSetVariableNames"
5893b037adc7SBarry Smith /*@C
589431152f8aSBarry Smith    TSMonitorLGSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5895b037adc7SBarry Smith 
5896b037adc7SBarry Smith    Collective on TS
5897b037adc7SBarry Smith 
5898b037adc7SBarry Smith    Input Parameters:
5899b037adc7SBarry Smith +  ts - the TS context
5900b3d3934dSBarry Smith -  names - the names of the components, final string must be NULL
5901b037adc7SBarry Smith 
5902b037adc7SBarry Smith    Level: intermediate
5903b037adc7SBarry Smith 
59047db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
59057db568b7SBarry Smith 
5906b037adc7SBarry Smith .keywords: TS,  vector, monitor, view
5907b037adc7SBarry Smith 
5908a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGCtxSetVariableNames()
5909b037adc7SBarry Smith @*/
591031152f8aSBarry Smith PetscErrorCode  TSMonitorLGSetVariableNames(TS ts,const char * const *names)
5911b037adc7SBarry Smith {
5912b037adc7SBarry Smith   PetscErrorCode    ierr;
5913b037adc7SBarry Smith   PetscInt          i;
5914b037adc7SBarry Smith 
5915b037adc7SBarry Smith   PetscFunctionBegin;
5916b037adc7SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5917b037adc7SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
59185537e223SBarry Smith       ierr = TSMonitorLGCtxSetVariableNames((TSMonitorLGCtx)ts->monitorcontext[i],names);CHKERRQ(ierr);
5919b3d3934dSBarry Smith       break;
5920b3d3934dSBarry Smith     }
5921b3d3934dSBarry Smith   }
5922b3d3934dSBarry Smith   PetscFunctionReturn(0);
5923b3d3934dSBarry Smith }
5924b3d3934dSBarry Smith 
5925b3d3934dSBarry Smith #undef __FUNCT__
5926e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetVariableNames"
5927e673d494SBarry Smith /*@C
5928e673d494SBarry Smith    TSMonitorLGCtxSetVariableNames - Sets the name of each component in the solution vector so that it may be displayed in the plot
5929e673d494SBarry Smith 
5930e673d494SBarry Smith    Collective on TS
5931e673d494SBarry Smith 
5932e673d494SBarry Smith    Input Parameters:
5933e673d494SBarry Smith +  ts - the TS context
5934e673d494SBarry Smith -  names - the names of the components, final string must be NULL
5935e673d494SBarry Smith 
5936e673d494SBarry Smith    Level: intermediate
5937e673d494SBarry Smith 
5938e673d494SBarry Smith .keywords: TS,  vector, monitor, view
5939e673d494SBarry Smith 
5940a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables(), TSMonitorLGSetVariableNames()
5941e673d494SBarry Smith @*/
5942e673d494SBarry Smith PetscErrorCode  TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx ctx,const char * const *names)
5943e673d494SBarry Smith {
5944e673d494SBarry Smith   PetscErrorCode    ierr;
5945e673d494SBarry Smith 
5946e673d494SBarry Smith   PetscFunctionBegin;
5947e673d494SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->names);CHKERRQ(ierr);
5948e673d494SBarry Smith   ierr = PetscStrArrayallocpy(names,&ctx->names);CHKERRQ(ierr);
5949e673d494SBarry Smith   PetscFunctionReturn(0);
5950e673d494SBarry Smith }
5951e673d494SBarry Smith 
5952e673d494SBarry Smith #undef __FUNCT__
5953b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorLGGetVariableNames"
5954b3d3934dSBarry Smith /*@C
5955b3d3934dSBarry Smith    TSMonitorLGGetVariableNames - Gets the name of each component in the solution vector so that it may be displayed in the plot
5956b3d3934dSBarry Smith 
5957b3d3934dSBarry Smith    Collective on TS
5958b3d3934dSBarry Smith 
5959b3d3934dSBarry Smith    Input Parameter:
5960b3d3934dSBarry Smith .  ts - the TS context
5961b3d3934dSBarry Smith 
5962b3d3934dSBarry Smith    Output Parameter:
5963b3d3934dSBarry Smith .  names - the names of the components, final string must be NULL
5964b3d3934dSBarry Smith 
5965b3d3934dSBarry Smith    Level: intermediate
5966b3d3934dSBarry Smith 
59677db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
59687db568b7SBarry Smith 
5969b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
5970b3d3934dSBarry Smith 
5971b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
5972b3d3934dSBarry Smith @*/
5973b3d3934dSBarry Smith PetscErrorCode  TSMonitorLGGetVariableNames(TS ts,const char *const **names)
5974b3d3934dSBarry Smith {
5975b3d3934dSBarry Smith   PetscInt       i;
5976b3d3934dSBarry Smith 
5977b3d3934dSBarry Smith   PetscFunctionBegin;
5978b3d3934dSBarry Smith   *names = NULL;
5979b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
5980b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
59815537e223SBarry Smith       TSMonitorLGCtx  ctx = (TSMonitorLGCtx) ts->monitorcontext[i];
5982b3d3934dSBarry Smith       *names = (const char *const *)ctx->names;
5983b3d3934dSBarry Smith       break;
5984387f4636SBarry Smith     }
5985387f4636SBarry Smith   }
5986387f4636SBarry Smith   PetscFunctionReturn(0);
5987387f4636SBarry Smith }
5988387f4636SBarry Smith 
5989387f4636SBarry Smith #undef __FUNCT__
5990a66092f1SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetDisplayVariables"
5991a66092f1SBarry Smith /*@C
5992a66092f1SBarry Smith    TSMonitorLGCtxSetDisplayVariables - Sets the variables that are to be display in the monitor
5993a66092f1SBarry Smith 
5994a66092f1SBarry Smith    Collective on TS
5995a66092f1SBarry Smith 
5996a66092f1SBarry Smith    Input Parameters:
5997a66092f1SBarry Smith +  ctx - the TSMonitorLG context
5998a66092f1SBarry Smith .  displaynames - the names of the components, final string must be NULL
5999a66092f1SBarry Smith 
6000a66092f1SBarry Smith    Level: intermediate
6001a66092f1SBarry Smith 
6002a66092f1SBarry Smith .keywords: TS,  vector, monitor, view
6003a66092f1SBarry Smith 
6004a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6005a66092f1SBarry Smith @*/
6006a66092f1SBarry Smith PetscErrorCode  TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx ctx,const char * const *displaynames)
6007a66092f1SBarry Smith {
6008a66092f1SBarry Smith   PetscInt          j = 0,k;
6009a66092f1SBarry Smith   PetscErrorCode    ierr;
6010a66092f1SBarry Smith 
6011a66092f1SBarry Smith   PetscFunctionBegin;
6012a66092f1SBarry Smith   if (!ctx->names) PetscFunctionReturn(0);
6013a66092f1SBarry Smith   ierr = PetscStrArrayDestroy(&ctx->displaynames);CHKERRQ(ierr);
6014a66092f1SBarry Smith   ierr = PetscStrArrayallocpy(displaynames,&ctx->displaynames);CHKERRQ(ierr);
6015a66092f1SBarry Smith   while (displaynames[j]) j++;
6016a66092f1SBarry Smith   ctx->ndisplayvariables = j;
6017a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvariables);CHKERRQ(ierr);
6018a66092f1SBarry Smith   ierr = PetscMalloc1(ctx->ndisplayvariables,&ctx->displayvalues);CHKERRQ(ierr);
6019a66092f1SBarry Smith   j = 0;
6020a66092f1SBarry Smith   while (displaynames[j]) {
6021a66092f1SBarry Smith     k = 0;
6022a66092f1SBarry Smith     while (ctx->names[k]) {
6023a66092f1SBarry Smith       PetscBool flg;
6024a66092f1SBarry Smith       ierr = PetscStrcmp(displaynames[j],ctx->names[k],&flg);CHKERRQ(ierr);
6025a66092f1SBarry Smith       if (flg) {
6026a66092f1SBarry Smith         ctx->displayvariables[j] = k;
6027a66092f1SBarry Smith         break;
6028a66092f1SBarry Smith       }
6029a66092f1SBarry Smith       k++;
6030a66092f1SBarry Smith     }
6031a66092f1SBarry Smith     j++;
6032a66092f1SBarry Smith   }
6033a66092f1SBarry Smith   PetscFunctionReturn(0);
6034a66092f1SBarry Smith }
6035a66092f1SBarry Smith 
6036a66092f1SBarry Smith 
6037a66092f1SBarry Smith #undef __FUNCT__
6038387f4636SBarry Smith #define __FUNCT__ "TSMonitorLGSetDisplayVariables"
6039387f4636SBarry Smith /*@C
6040387f4636SBarry Smith    TSMonitorLGSetDisplayVariables - Sets the variables that are to be display in the monitor
6041387f4636SBarry Smith 
6042387f4636SBarry Smith    Collective on TS
6043387f4636SBarry Smith 
6044387f4636SBarry Smith    Input Parameters:
6045387f4636SBarry Smith +  ts - the TS context
6046387f4636SBarry Smith .  displaynames - the names of the components, final string must be NULL
6047387f4636SBarry Smith 
60487db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60497db568b7SBarry Smith 
6050387f4636SBarry Smith    Level: intermediate
6051387f4636SBarry Smith 
6052387f4636SBarry Smith .keywords: TS,  vector, monitor, view
6053387f4636SBarry Smith 
6054387f4636SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames()
6055387f4636SBarry Smith @*/
6056387f4636SBarry Smith PetscErrorCode  TSMonitorLGSetDisplayVariables(TS ts,const char * const *displaynames)
6057387f4636SBarry Smith {
6058a66092f1SBarry Smith   PetscInt          i;
6059387f4636SBarry Smith   PetscErrorCode    ierr;
6060387f4636SBarry Smith 
6061387f4636SBarry Smith   PetscFunctionBegin;
6062387f4636SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6063387f4636SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
60645537e223SBarry Smith       ierr = TSMonitorLGCtxSetDisplayVariables((TSMonitorLGCtx)ts->monitorcontext[i],displaynames);CHKERRQ(ierr);
6065b3d3934dSBarry Smith       break;
6066b037adc7SBarry Smith     }
6067b037adc7SBarry Smith   }
6068b037adc7SBarry Smith   PetscFunctionReturn(0);
6069b037adc7SBarry Smith }
6070b037adc7SBarry Smith 
6071b037adc7SBarry Smith #undef __FUNCT__
607280666b62SBarry Smith #define __FUNCT__ "TSMonitorLGSetTransform"
607380666b62SBarry Smith /*@C
607480666b62SBarry Smith    TSMonitorLGSetTransform - Solution vector will be transformed by provided function before being displayed
607580666b62SBarry Smith 
607680666b62SBarry Smith    Collective on TS
607780666b62SBarry Smith 
607880666b62SBarry Smith    Input Parameters:
607980666b62SBarry Smith +  ts - the TS context
608080666b62SBarry Smith .  transform - the transform function
60817684fa3eSBarry Smith .  destroy - function to destroy the optional context
608280666b62SBarry Smith -  ctx - optional context used by transform function
608380666b62SBarry Smith 
60847db568b7SBarry Smith    Notes: If the TS object does not have a TSMonitorLGCtx associated with it then this function is ignored
60857db568b7SBarry Smith 
608680666b62SBarry Smith    Level: intermediate
608780666b62SBarry Smith 
608880666b62SBarry Smith .keywords: TS,  vector, monitor, view
608980666b62SBarry Smith 
6090a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGCtxSetTransform()
609180666b62SBarry Smith @*/
60927684fa3eSBarry Smith PetscErrorCode  TSMonitorLGSetTransform(TS ts,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
609380666b62SBarry Smith {
609480666b62SBarry Smith   PetscInt          i;
6095a66092f1SBarry Smith   PetscErrorCode    ierr;
609680666b62SBarry Smith 
609780666b62SBarry Smith   PetscFunctionBegin;
609880666b62SBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
609980666b62SBarry Smith     if (ts->monitor[i] == TSMonitorLGSolution) {
61005537e223SBarry Smith       ierr = TSMonitorLGCtxSetTransform((TSMonitorLGCtx)ts->monitorcontext[i],transform,destroy,tctx);CHKERRQ(ierr);
610180666b62SBarry Smith     }
610280666b62SBarry Smith   }
610380666b62SBarry Smith   PetscFunctionReturn(0);
610480666b62SBarry Smith }
610580666b62SBarry Smith 
610680666b62SBarry Smith #undef __FUNCT__
6107e673d494SBarry Smith #define __FUNCT__ "TSMonitorLGCtxSetTransform"
6108e673d494SBarry Smith /*@C
6109e673d494SBarry Smith    TSMonitorLGCtxSetTransform - Solution vector will be transformed by provided function before being displayed
6110e673d494SBarry Smith 
6111e673d494SBarry Smith    Collective on TSLGCtx
6112e673d494SBarry Smith 
6113e673d494SBarry Smith    Input Parameters:
6114e673d494SBarry Smith +  ts - the TS context
6115e673d494SBarry Smith .  transform - the transform function
61167684fa3eSBarry Smith .  destroy - function to destroy the optional context
6117e673d494SBarry Smith -  ctx - optional context used by transform function
6118e673d494SBarry Smith 
6119e673d494SBarry Smith    Level: intermediate
6120e673d494SBarry Smith 
6121e673d494SBarry Smith .keywords: TS,  vector, monitor, view
6122e673d494SBarry Smith 
6123a66092f1SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetVariableNames(), TSMonitorLGSetTransform()
6124e673d494SBarry Smith @*/
61257684fa3eSBarry Smith PetscErrorCode  TSMonitorLGCtxSetTransform(TSMonitorLGCtx ctx,PetscErrorCode (*transform)(void*,Vec,Vec*),PetscErrorCode (*destroy)(void*),void *tctx)
6126e673d494SBarry Smith {
6127e673d494SBarry Smith   PetscFunctionBegin;
6128e673d494SBarry Smith   ctx->transform    = transform;
61297684fa3eSBarry Smith   ctx->transformdestroy = destroy;
6130e673d494SBarry Smith   ctx->transformctx = tctx;
6131e673d494SBarry Smith   PetscFunctionReturn(0);
6132e673d494SBarry Smith }
6133e673d494SBarry Smith 
6134b3603a34SBarry Smith #undef __FUNCT__
61354f09c107SBarry Smith #define __FUNCT__ "TSMonitorLGError"
6136ef20d060SBarry Smith /*@C
61374f09c107SBarry Smith    TSMonitorLGError - Monitors progress of the TS solvers by plotting each component of the solution vector
6138ef20d060SBarry Smith        in a time based line graph
6139ef20d060SBarry Smith 
6140ef20d060SBarry Smith    Collective on TS
6141ef20d060SBarry Smith 
6142ef20d060SBarry Smith    Input Parameters:
6143ef20d060SBarry Smith +  ts - the TS context
6144ef20d060SBarry Smith .  step - current time-step
6145ef20d060SBarry Smith .  ptime - current time
61467db568b7SBarry Smith .  u - current solution
61477db568b7SBarry Smith -  dctx - TSMonitorLGCtx object created with TSMonitorLGCtxCreate()
6148ef20d060SBarry Smith 
6149ef20d060SBarry Smith    Level: intermediate
6150ef20d060SBarry Smith 
6151abd5a294SJed Brown    Notes:
6152abd5a294SJed Brown    Only for sequential solves.
6153abd5a294SJed Brown 
6154abd5a294SJed Brown    The user must provide the solution using TSSetSolutionFunction() to use this monitor.
6155abd5a294SJed Brown 
6156abd5a294SJed Brown    Options Database Keys:
61574f09c107SBarry Smith .  -ts_monitor_lg_error - create a graphical monitor of error history
6158ef20d060SBarry Smith 
6159ef20d060SBarry Smith .keywords: TS,  vector, monitor, view
6160ef20d060SBarry Smith 
6161abd5a294SJed Brown .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSSetSolutionFunction()
6162ef20d060SBarry Smith @*/
61630910c330SBarry Smith PetscErrorCode  TSMonitorLGError(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dummy)
6164ef20d060SBarry Smith {
6165ef20d060SBarry Smith   PetscErrorCode    ierr;
61660b039ecaSBarry Smith   TSMonitorLGCtx    ctx = (TSMonitorLGCtx)dummy;
6167ef20d060SBarry Smith   const PetscScalar *yy;
6168ef20d060SBarry Smith   Vec               y;
6169a9f9c1f6SBarry Smith   PetscInt          dim;
6170ef20d060SBarry Smith 
6171ef20d060SBarry Smith   PetscFunctionBegin;
6172a9f9c1f6SBarry Smith   if (!step) {
6173a9f9c1f6SBarry Smith     PetscDrawAxis axis;
6174a9f9c1f6SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
61751ae185eaSBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Error in solution as function of time","Time","Solution");CHKERRQ(ierr);
61760910c330SBarry Smith     ierr = VecGetLocalSize(u,&dim);CHKERRQ(ierr);
6177a9f9c1f6SBarry Smith     ierr = PetscDrawLGSetDimension(ctx->lg,dim);CHKERRQ(ierr);
6178a9f9c1f6SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6179a9f9c1f6SBarry Smith   }
61800910c330SBarry Smith   ierr = VecDuplicate(u,&y);CHKERRQ(ierr);
6181ef20d060SBarry Smith   ierr = TSComputeSolutionFunction(ts,ptime,y);CHKERRQ(ierr);
61820910c330SBarry Smith   ierr = VecAXPY(y,-1.0,u);CHKERRQ(ierr);
6183ef20d060SBarry Smith   ierr = VecGetArrayRead(y,&yy);CHKERRQ(ierr);
6184e3efe391SJed Brown #if defined(PETSC_USE_COMPLEX)
6185e3efe391SJed Brown   {
6186e3efe391SJed Brown     PetscReal *yreal;
6187e3efe391SJed Brown     PetscInt  i,n;
6188e3efe391SJed Brown     ierr = VecGetLocalSize(y,&n);CHKERRQ(ierr);
6189785e854fSJed Brown     ierr = PetscMalloc1(n,&yreal);CHKERRQ(ierr);
6190e3efe391SJed Brown     for (i=0; i<n; i++) yreal[i] = PetscRealPart(yy[i]);
61910b039ecaSBarry Smith     ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yreal);CHKERRQ(ierr);
6192e3efe391SJed Brown     ierr = PetscFree(yreal);CHKERRQ(ierr);
6193e3efe391SJed Brown   }
6194e3efe391SJed Brown #else
61950b039ecaSBarry Smith   ierr = PetscDrawLGAddCommonPoint(ctx->lg,ptime,yy);CHKERRQ(ierr);
6196e3efe391SJed Brown #endif
6197ef20d060SBarry Smith   ierr = VecRestoreArrayRead(y,&yy);CHKERRQ(ierr);
6198ef20d060SBarry Smith   ierr = VecDestroy(&y);CHKERRQ(ierr);
6199b06615a5SLisandro Dalcin   if (((ctx->howoften > 0) && (!(step % ctx->howoften))) || ((ctx->howoften == -1) && ts->reason)) {
62000b039ecaSBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
62013923b477SBarry Smith   }
6202ef20d060SBarry Smith   PetscFunctionReturn(0);
6203ef20d060SBarry Smith }
6204ef20d060SBarry Smith 
6205201da799SBarry Smith #undef __FUNCT__
6206201da799SBarry Smith #define __FUNCT__ "TSMonitorLGSNESIterations"
6207201da799SBarry Smith PetscErrorCode TSMonitorLGSNESIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6208201da799SBarry Smith {
6209201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6210201da799SBarry Smith   PetscReal      x   = ptime,y;
6211201da799SBarry Smith   PetscErrorCode ierr;
6212201da799SBarry Smith   PetscInt       its;
6213201da799SBarry Smith 
6214201da799SBarry Smith   PetscFunctionBegin;
6215201da799SBarry Smith   if (!n) {
6216201da799SBarry Smith     PetscDrawAxis axis;
6217bbd56ea5SKarl Rupp 
6218201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6219201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Nonlinear iterations as function of time","Time","SNES Iterations");CHKERRQ(ierr);
6220201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6221bbd56ea5SKarl Rupp 
6222201da799SBarry Smith     ctx->snes_its = 0;
6223201da799SBarry Smith   }
6224201da799SBarry Smith   ierr = TSGetSNESIterations(ts,&its);CHKERRQ(ierr);
6225201da799SBarry Smith   y    = its - ctx->snes_its;
6226201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
62273fbbecb0SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6228201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6229201da799SBarry Smith   }
6230201da799SBarry Smith   ctx->snes_its = its;
6231201da799SBarry Smith   PetscFunctionReturn(0);
6232201da799SBarry Smith }
6233201da799SBarry Smith 
6234201da799SBarry Smith #undef __FUNCT__
6235201da799SBarry Smith #define __FUNCT__ "TSMonitorLGKSPIterations"
6236201da799SBarry Smith PetscErrorCode TSMonitorLGKSPIterations(TS ts,PetscInt n,PetscReal ptime,Vec v,void *monctx)
6237201da799SBarry Smith {
6238201da799SBarry Smith   TSMonitorLGCtx ctx = (TSMonitorLGCtx) monctx;
6239201da799SBarry Smith   PetscReal      x   = ptime,y;
6240201da799SBarry Smith   PetscErrorCode ierr;
6241201da799SBarry Smith   PetscInt       its;
6242201da799SBarry Smith 
6243201da799SBarry Smith   PetscFunctionBegin;
6244201da799SBarry Smith   if (!n) {
6245201da799SBarry Smith     PetscDrawAxis axis;
6246bbd56ea5SKarl Rupp 
6247201da799SBarry Smith     ierr = PetscDrawLGGetAxis(ctx->lg,&axis);CHKERRQ(ierr);
6248201da799SBarry Smith     ierr = PetscDrawAxisSetLabels(axis,"Linear iterations as function of time","Time","KSP Iterations");CHKERRQ(ierr);
6249201da799SBarry Smith     ierr = PetscDrawLGReset(ctx->lg);CHKERRQ(ierr);
6250bbd56ea5SKarl Rupp 
6251201da799SBarry Smith     ctx->ksp_its = 0;
6252201da799SBarry Smith   }
6253201da799SBarry Smith   ierr = TSGetKSPIterations(ts,&its);CHKERRQ(ierr);
6254201da799SBarry Smith   y    = its - ctx->ksp_its;
6255201da799SBarry Smith   ierr = PetscDrawLGAddPoint(ctx->lg,&x,&y);CHKERRQ(ierr);
625699fdda47SBarry Smith   if (((ctx->howoften > 0) && (!(n % ctx->howoften)) && (n > -1)) || ((ctx->howoften == -1) && (n == -1))) {
6257201da799SBarry Smith     ierr = PetscDrawLGDraw(ctx->lg);CHKERRQ(ierr);
6258201da799SBarry Smith   }
6259201da799SBarry Smith   ctx->ksp_its = its;
6260201da799SBarry Smith   PetscFunctionReturn(0);
6261201da799SBarry Smith }
6262f9c1d6abSBarry Smith 
6263f9c1d6abSBarry Smith #undef __FUNCT__
6264f9c1d6abSBarry Smith #define __FUNCT__ "TSComputeLinearStability"
6265f9c1d6abSBarry Smith /*@
6266f9c1d6abSBarry Smith    TSComputeLinearStability - computes the linear stability function at a point
6267f9c1d6abSBarry Smith 
6268f9c1d6abSBarry Smith    Collective on TS and Vec
6269f9c1d6abSBarry Smith 
6270f9c1d6abSBarry Smith    Input Parameters:
6271f9c1d6abSBarry Smith +  ts - the TS context
6272f9c1d6abSBarry Smith -  xr,xi - real and imaginary part of input arguments
6273f9c1d6abSBarry Smith 
6274f9c1d6abSBarry Smith    Output Parameters:
6275f9c1d6abSBarry Smith .  yr,yi - real and imaginary part of function value
6276f9c1d6abSBarry Smith 
6277f9c1d6abSBarry Smith    Level: developer
6278f9c1d6abSBarry Smith 
6279f9c1d6abSBarry Smith .keywords: TS, compute
6280f9c1d6abSBarry Smith 
6281f9c1d6abSBarry Smith .seealso: TSSetRHSFunction(), TSComputeIFunction()
6282f9c1d6abSBarry Smith @*/
6283f9c1d6abSBarry Smith PetscErrorCode TSComputeLinearStability(TS ts,PetscReal xr,PetscReal xi,PetscReal *yr,PetscReal *yi)
6284f9c1d6abSBarry Smith {
6285f9c1d6abSBarry Smith   PetscErrorCode ierr;
6286f9c1d6abSBarry Smith 
6287f9c1d6abSBarry Smith   PetscFunctionBegin;
6288f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts,TS_CLASSID,1);
6289ce94432eSBarry Smith   if (!ts->ops->linearstability) SETERRQ(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"Linearized stability function not provided for this method");
6290f9c1d6abSBarry Smith   ierr = (*ts->ops->linearstability)(ts,xr,xi,yr,yi);CHKERRQ(ierr);
6291f9c1d6abSBarry Smith   PetscFunctionReturn(0);
6292f9c1d6abSBarry Smith }
629324655328SShri 
6294b3d3934dSBarry Smith /* ------------------------------------------------------------------------*/
6295b3d3934dSBarry Smith #undef __FUNCT__
6296b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxCreate"
6297b3d3934dSBarry Smith /*@C
6298b3d3934dSBarry Smith    TSMonitorEnvelopeCtxCreate - Creates a context for use with TSMonitorEnvelope()
6299b3d3934dSBarry Smith 
6300b3d3934dSBarry Smith    Collective on TS
6301b3d3934dSBarry Smith 
6302b3d3934dSBarry Smith    Input Parameters:
6303b3d3934dSBarry Smith .  ts  - the ODE solver object
6304b3d3934dSBarry Smith 
6305b3d3934dSBarry Smith    Output Parameter:
6306b3d3934dSBarry Smith .  ctx - the context
6307b3d3934dSBarry Smith 
6308b3d3934dSBarry Smith    Level: intermediate
6309b3d3934dSBarry Smith 
6310b3d3934dSBarry Smith .keywords: TS, monitor, line graph, residual, seealso
6311b3d3934dSBarry Smith 
6312b3d3934dSBarry Smith .seealso: TSMonitorLGTimeStep(), TSMonitorSet(), TSMonitorLGSolution(), TSMonitorLGError()
6313b3d3934dSBarry Smith 
6314b3d3934dSBarry Smith @*/
6315b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxCreate(TS ts,TSMonitorEnvelopeCtx *ctx)
6316b3d3934dSBarry Smith {
6317b3d3934dSBarry Smith   PetscErrorCode ierr;
6318b3d3934dSBarry Smith 
6319b3d3934dSBarry Smith   PetscFunctionBegin;
6320a74656a8SBarry Smith   ierr = PetscNew(ctx);CHKERRQ(ierr);
6321b3d3934dSBarry Smith   PetscFunctionReturn(0);
6322b3d3934dSBarry Smith }
6323b3d3934dSBarry Smith 
6324b3d3934dSBarry Smith #undef __FUNCT__
6325b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelope"
6326b3d3934dSBarry Smith /*@C
6327b3d3934dSBarry Smith    TSMonitorEnvelope - Monitors the maximum and minimum value of each component of the solution
6328b3d3934dSBarry Smith 
6329b3d3934dSBarry Smith    Collective on TS
6330b3d3934dSBarry Smith 
6331b3d3934dSBarry Smith    Input Parameters:
6332b3d3934dSBarry Smith +  ts - the TS context
6333b3d3934dSBarry Smith .  step - current time-step
6334b3d3934dSBarry Smith .  ptime - current time
63357db568b7SBarry Smith .  u  - current solution
63367db568b7SBarry Smith -  dctx - the envelope context
6337b3d3934dSBarry Smith 
6338b3d3934dSBarry Smith    Options Database:
6339b3d3934dSBarry Smith .  -ts_monitor_envelope
6340b3d3934dSBarry Smith 
6341b3d3934dSBarry Smith    Level: intermediate
6342b3d3934dSBarry Smith 
6343b3d3934dSBarry Smith    Notes: after a solve you can use TSMonitorEnvelopeGetBounds() to access the envelope
6344b3d3934dSBarry Smith 
6345b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6346b3d3934dSBarry Smith 
63477db568b7SBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorEnvelopeGetBounds(), TSMonitorEnvelopeCtxCreate()
6348b3d3934dSBarry Smith @*/
63497db568b7SBarry Smith PetscErrorCode  TSMonitorEnvelope(TS ts,PetscInt step,PetscReal ptime,Vec u,void *dctx)
6350b3d3934dSBarry Smith {
6351b3d3934dSBarry Smith   PetscErrorCode       ierr;
63527db568b7SBarry Smith   TSMonitorEnvelopeCtx ctx = (TSMonitorEnvelopeCtx)dctx;
6353b3d3934dSBarry Smith 
6354b3d3934dSBarry Smith   PetscFunctionBegin;
6355b3d3934dSBarry Smith   if (!ctx->max) {
6356b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->max);CHKERRQ(ierr);
6357b3d3934dSBarry Smith     ierr = VecDuplicate(u,&ctx->min);CHKERRQ(ierr);
6358b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->max);CHKERRQ(ierr);
6359b3d3934dSBarry Smith     ierr = VecCopy(u,ctx->min);CHKERRQ(ierr);
6360b3d3934dSBarry Smith   } else {
6361b3d3934dSBarry Smith     ierr = VecPointwiseMax(ctx->max,u,ctx->max);CHKERRQ(ierr);
6362b3d3934dSBarry Smith     ierr = VecPointwiseMin(ctx->min,u,ctx->min);CHKERRQ(ierr);
6363b3d3934dSBarry Smith   }
6364b3d3934dSBarry Smith   PetscFunctionReturn(0);
6365b3d3934dSBarry Smith }
6366b3d3934dSBarry Smith 
6367b3d3934dSBarry Smith 
6368b3d3934dSBarry Smith #undef __FUNCT__
6369b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeGetBounds"
6370b3d3934dSBarry Smith /*@C
6371b3d3934dSBarry Smith    TSMonitorEnvelopeGetBounds - Gets the bounds for the components of the solution
6372b3d3934dSBarry Smith 
6373b3d3934dSBarry Smith    Collective on TS
6374b3d3934dSBarry Smith 
6375b3d3934dSBarry Smith    Input Parameter:
6376b3d3934dSBarry Smith .  ts - the TS context
6377b3d3934dSBarry Smith 
6378b3d3934dSBarry Smith    Output Parameter:
6379b3d3934dSBarry Smith +  max - the maximum values
6380b3d3934dSBarry Smith -  min - the minimum values
6381b3d3934dSBarry Smith 
63827db568b7SBarry Smith    Notes: If the TS does not have a TSMonitorEnvelopeCtx associated with it then this function is ignored
63837db568b7SBarry Smith 
6384b3d3934dSBarry Smith    Level: intermediate
6385b3d3934dSBarry Smith 
6386b3d3934dSBarry Smith .keywords: TS,  vector, monitor, view
6387b3d3934dSBarry Smith 
6388b3d3934dSBarry Smith .seealso: TSMonitorSet(), TSMonitorDefault(), VecView(), TSMonitorLGSetDisplayVariables()
6389b3d3934dSBarry Smith @*/
6390b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeGetBounds(TS ts,Vec *max,Vec *min)
6391b3d3934dSBarry Smith {
6392b3d3934dSBarry Smith   PetscInt i;
6393b3d3934dSBarry Smith 
6394b3d3934dSBarry Smith   PetscFunctionBegin;
6395b3d3934dSBarry Smith   if (max) *max = NULL;
6396b3d3934dSBarry Smith   if (min) *min = NULL;
6397b3d3934dSBarry Smith   for (i=0; i<ts->numbermonitors; i++) {
6398b3d3934dSBarry Smith     if (ts->monitor[i] == TSMonitorEnvelope) {
63995537e223SBarry Smith       TSMonitorEnvelopeCtx  ctx = (TSMonitorEnvelopeCtx) ts->monitorcontext[i];
6400b3d3934dSBarry Smith       if (max) *max = ctx->max;
6401b3d3934dSBarry Smith       if (min) *min = ctx->min;
6402b3d3934dSBarry Smith       break;
6403b3d3934dSBarry Smith     }
6404b3d3934dSBarry Smith   }
6405b3d3934dSBarry Smith   PetscFunctionReturn(0);
6406b3d3934dSBarry Smith }
6407b3d3934dSBarry Smith 
6408b3d3934dSBarry Smith #undef __FUNCT__
6409b3d3934dSBarry Smith #define __FUNCT__ "TSMonitorEnvelopeCtxDestroy"
6410b3d3934dSBarry Smith /*@C
6411b3d3934dSBarry Smith    TSMonitorEnvelopeCtxDestroy - Destroys a context that was created  with TSMonitorEnvelopeCtxCreate().
6412b3d3934dSBarry Smith 
6413b3d3934dSBarry Smith    Collective on TSMonitorEnvelopeCtx
6414b3d3934dSBarry Smith 
6415b3d3934dSBarry Smith    Input Parameter:
6416b3d3934dSBarry Smith .  ctx - the monitor context
6417b3d3934dSBarry Smith 
6418b3d3934dSBarry Smith    Level: intermediate
6419b3d3934dSBarry Smith 
6420b3d3934dSBarry Smith .keywords: TS, monitor, line graph, destroy
6421b3d3934dSBarry Smith 
64227db568b7SBarry Smith .seealso: TSMonitorLGCtxCreate(),  TSMonitorSet(), TSMonitorLGTimeStep()
6423b3d3934dSBarry Smith @*/
6424b3d3934dSBarry Smith PetscErrorCode  TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *ctx)
6425b3d3934dSBarry Smith {
6426b3d3934dSBarry Smith   PetscErrorCode ierr;
6427b3d3934dSBarry Smith 
6428b3d3934dSBarry Smith   PetscFunctionBegin;
6429b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->min);CHKERRQ(ierr);
6430b3d3934dSBarry Smith   ierr = VecDestroy(&(*ctx)->max);CHKERRQ(ierr);
6431b3d3934dSBarry Smith   ierr = PetscFree(*ctx);CHKERRQ(ierr);
6432b3d3934dSBarry Smith   PetscFunctionReturn(0);
6433b3d3934dSBarry Smith }
6434f2dee214SBarry Smith 
643524655328SShri #undef __FUNCT__
643624655328SShri #define __FUNCT__ "TSRollBack"
643724655328SShri /*@
643824655328SShri    TSRollBack - Rolls back one time step
643924655328SShri 
644024655328SShri    Collective on TS
644124655328SShri 
644224655328SShri    Input Parameter:
644324655328SShri .  ts - the TS context obtained from TSCreate()
644424655328SShri 
644524655328SShri    Level: advanced
644624655328SShri 
644724655328SShri .keywords: TS, timestep, rollback
644824655328SShri 
644924655328SShri .seealso: TSCreate(), TSSetUp(), TSDestroy(), TSSolve(), TSSetPreStep(), TSSetPreStage(), TSInterpolate()
645024655328SShri @*/
645124655328SShri PetscErrorCode  TSRollBack(TS ts)
645224655328SShri {
645324655328SShri   PetscErrorCode ierr;
645424655328SShri 
645524655328SShri   PetscFunctionBegin;
645624655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
645724655328SShri 
645824655328SShri   if (!ts->ops->rollback) SETERRQ1(PetscObjectComm((PetscObject)ts),PETSC_ERR_SUP,"TSRollBack not implemented for type '%s'",((PetscObject)ts)->type_name);
645924655328SShri   ierr = (*ts->ops->rollback)(ts);CHKERRQ(ierr);
646024655328SShri   ts->time_step = ts->ptime - ts->ptime_prev;
646124655328SShri   ts->ptime = ts->ptime_prev;
64628392e04aSShri Abhyankar   ts->steprollback = PETSC_TRUE; /* Flag to indicate that the step is rollbacked */
646324655328SShri   PetscFunctionReturn(0);
646424655328SShri }
6465aeb4809dSShri Abhyankar 
6466ff22ae23SHong Zhang #undef __FUNCT__
6467ff22ae23SHong Zhang #define __FUNCT__ "TSGetStages"
6468ff22ae23SHong Zhang /*@
6469ff22ae23SHong Zhang    TSGetStages - Get the number of stages and stage values
6470ff22ae23SHong Zhang 
6471ff22ae23SHong Zhang    Input Parameter:
6472ff22ae23SHong Zhang .  ts - the TS context obtained from TSCreate()
6473ff22ae23SHong Zhang 
6474ff22ae23SHong Zhang    Level: advanced
6475ff22ae23SHong Zhang 
6476ff22ae23SHong Zhang .keywords: TS, getstages
6477ff22ae23SHong Zhang 
6478ff22ae23SHong Zhang .seealso: TSCreate()
6479ff22ae23SHong Zhang @*/
6480ff22ae23SHong Zhang PetscErrorCode  TSGetStages(TS ts,PetscInt *ns, Vec **Y)
6481ff22ae23SHong Zhang {
6482ff22ae23SHong Zhang   PetscErrorCode ierr;
6483ff22ae23SHong Zhang 
6484ff22ae23SHong Zhang   PetscFunctionBegin;
6485ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID,1);
6486ff22ae23SHong Zhang   PetscValidPointer(ns,2);
6487ff22ae23SHong Zhang 
6488ff22ae23SHong Zhang   if (!ts->ops->getstages) *ns=0;
6489ff22ae23SHong Zhang   else {
6490ff22ae23SHong Zhang     ierr = (*ts->ops->getstages)(ts,ns,Y);CHKERRQ(ierr);
6491ff22ae23SHong Zhang   }
6492ff22ae23SHong Zhang   PetscFunctionReturn(0);
6493ff22ae23SHong Zhang }
6494ff22ae23SHong Zhang 
6495847ff0e1SMatthew G. Knepley #undef __FUNCT__
6496847ff0e1SMatthew G. Knepley #define __FUNCT__ "TSComputeIJacobianDefaultColor"
6497847ff0e1SMatthew G. Knepley /*@C
6498847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
6499847ff0e1SMatthew G. Knepley 
6500847ff0e1SMatthew G. Knepley   Collective on SNES
6501847ff0e1SMatthew G. Knepley 
6502847ff0e1SMatthew G. Knepley   Input Parameters:
6503847ff0e1SMatthew G. Knepley + ts - the TS context
6504847ff0e1SMatthew G. Knepley . t - current timestep
6505847ff0e1SMatthew G. Knepley . U - state vector
6506847ff0e1SMatthew G. Knepley . Udot - time derivative of state vector
6507847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
6508847ff0e1SMatthew G. Knepley - ctx - an optional user context
6509847ff0e1SMatthew G. Knepley 
6510847ff0e1SMatthew G. Knepley   Output Parameters:
6511847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
6512847ff0e1SMatthew G. Knepley - B - newly computed Jacobian matrix to use with preconditioner (generally the same as J)
6513847ff0e1SMatthew G. Knepley 
6514847ff0e1SMatthew G. Knepley   Level: intermediate
6515847ff0e1SMatthew G. Knepley 
6516847ff0e1SMatthew G. Knepley   Notes:
6517847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
6518847ff0e1SMatthew G. Knepley 
6519847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
6520847ff0e1SMatthew G. Knepley 
6521847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
6522847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
6523847ff0e1SMatthew G. Knepley 
6524847ff0e1SMatthew G. Knepley   This will first try to get the coloring from the DM.  If the DM type has no coloring
6525847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
6526847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
6527847ff0e1SMatthew G. Knepley 
6528847ff0e1SMatthew G. Knepley .keywords: TS, finite differences, Jacobian, coloring, sparse
6529847ff0e1SMatthew G. Knepley .seealso: TSSetIJacobian(), MatFDColoringCreate(), MatFDColoringSetFunction()
6530847ff0e1SMatthew G. Knepley @*/
6531847ff0e1SMatthew G. Knepley PetscErrorCode TSComputeIJacobianDefaultColor(TS ts,PetscReal t,Vec U,Vec Udot,PetscReal shift,Mat J,Mat B,void *ctx)
6532847ff0e1SMatthew G. Knepley {
6533847ff0e1SMatthew G. Knepley   SNES           snes;
6534847ff0e1SMatthew G. Knepley   MatFDColoring  color;
6535847ff0e1SMatthew G. Knepley   PetscBool      hascolor, matcolor = PETSC_FALSE;
6536847ff0e1SMatthew G. Knepley   PetscErrorCode ierr;
6537847ff0e1SMatthew G. Knepley 
6538847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
6539847ff0e1SMatthew G. Knepley   ierr = PetscOptionsGetBool(((PetscObject) ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL);CHKERRQ(ierr);
6540847ff0e1SMatthew G. Knepley   ierr = PetscObjectQuery((PetscObject) B, "TSMatFDColoring", (PetscObject *) &color);CHKERRQ(ierr);
6541847ff0e1SMatthew G. Knepley   if (!color) {
6542847ff0e1SMatthew G. Knepley     DM         dm;
6543847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
6544847ff0e1SMatthew G. Knepley 
6545847ff0e1SMatthew G. Knepley     ierr = TSGetDM(ts, &dm);CHKERRQ(ierr);
6546847ff0e1SMatthew G. Knepley     ierr = DMHasColoring(dm, &hascolor);CHKERRQ(ierr);
6547847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
6548847ff0e1SMatthew G. Knepley       ierr = DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring);CHKERRQ(ierr);
6549847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6550847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6551847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6552847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6553847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6554847ff0e1SMatthew G. Knepley     } else {
6555847ff0e1SMatthew G. Knepley       MatColoring mc;
6556847ff0e1SMatthew G. Knepley 
6557847ff0e1SMatthew G. Knepley       ierr = MatColoringCreate(B, &mc);CHKERRQ(ierr);
6558847ff0e1SMatthew G. Knepley       ierr = MatColoringSetDistance(mc, 2);CHKERRQ(ierr);
6559847ff0e1SMatthew G. Knepley       ierr = MatColoringSetType(mc, MATCOLORINGSL);CHKERRQ(ierr);
6560847ff0e1SMatthew G. Knepley       ierr = MatColoringSetFromOptions(mc);CHKERRQ(ierr);
6561847ff0e1SMatthew G. Knepley       ierr = MatColoringApply(mc, &iscoloring);CHKERRQ(ierr);
6562847ff0e1SMatthew G. Knepley       ierr = MatColoringDestroy(&mc);CHKERRQ(ierr);
6563847ff0e1SMatthew G. Knepley       ierr = MatFDColoringCreate(B, iscoloring, &color);CHKERRQ(ierr);
6564847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFunction(color, (PetscErrorCode (*)(void)) SNESTSFormFunction, (void *) ts);CHKERRQ(ierr);
6565847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetFromOptions(color);CHKERRQ(ierr);
6566847ff0e1SMatthew G. Knepley       ierr = MatFDColoringSetUp(B, iscoloring, color);CHKERRQ(ierr);
6567847ff0e1SMatthew G. Knepley       ierr = ISColoringDestroy(&iscoloring);CHKERRQ(ierr);
6568847ff0e1SMatthew G. Knepley     }
6569847ff0e1SMatthew G. Knepley     ierr = PetscObjectCompose((PetscObject) B, "TSMatFDColoring", (PetscObject) color);CHKERRQ(ierr);
6570847ff0e1SMatthew G. Knepley     ierr = PetscObjectDereference((PetscObject) color);CHKERRQ(ierr);
6571847ff0e1SMatthew G. Knepley   }
6572847ff0e1SMatthew G. Knepley   ierr = TSGetSNES(ts, &snes);CHKERRQ(ierr);
6573847ff0e1SMatthew G. Knepley   ierr = MatFDColoringApply(B, color, U, snes);CHKERRQ(ierr);
6574847ff0e1SMatthew G. Knepley   if (J != B) {
6575847ff0e1SMatthew G. Knepley     ierr = MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6576847ff0e1SMatthew G. Knepley     ierr = MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY);CHKERRQ(ierr);
6577847ff0e1SMatthew G. Knepley   }
6578847ff0e1SMatthew G. Knepley   PetscFunctionReturn(0);
6579847ff0e1SMatthew G. Knepley }
658093b34091SDebojyoti Ghosh 
658193b34091SDebojyoti Ghosh #undef  __FUNCT__
6582e5168f73SEmil Constantinescu #define __FUNCT__ "TSClone"
658393b34091SDebojyoti Ghosh /*@C
6584e5168f73SEmil Constantinescu   TSClone - This function clones a time step object.
658593b34091SDebojyoti Ghosh 
658693b34091SDebojyoti Ghosh   Collective on MPI_Comm
658793b34091SDebojyoti Ghosh 
658893b34091SDebojyoti Ghosh   Input Parameter:
658993b34091SDebojyoti Ghosh . tsin    - The input TS
659093b34091SDebojyoti Ghosh 
659193b34091SDebojyoti Ghosh   Output Parameter:
6592e5168f73SEmil Constantinescu . tsout   - The output TS (cloned)
659393b34091SDebojyoti Ghosh 
65945eca1a21SEmil Constantinescu   Notes:
65955eca1a21SEmil Constantinescu   This function is used to create a clone of a TS object. It is used in ARKIMEX for initializing the slope for first stage explicit methods. It will likely be replaced in the future with a mechanism of switching methods on the fly.
65965eca1a21SEmil Constantinescu 
6597baa10174SEmil Constantinescu   When using TSDestroy() on a clone the user has to first reset the correct TS reference in the embedded SNES object: e.g.: by running SNES snes_dup=NULL; TSGetSNES(ts,&snes_dup); ierr = TSSetSNES(ts,snes_dup);
65985eca1a21SEmil Constantinescu 
65995eca1a21SEmil Constantinescu   Level: developer
660093b34091SDebojyoti Ghosh 
6601e5168f73SEmil Constantinescu .keywords: TS, clone
6602e5168f73SEmil Constantinescu .seealso: TSCreate(), TSSetType(), TSSetUp(), TSDestroy(), TSSetProblemType()
660393b34091SDebojyoti Ghosh @*/
6604baa10174SEmil Constantinescu PetscErrorCode  TSClone(TS tsin, TS *tsout)
660593b34091SDebojyoti Ghosh {
660693b34091SDebojyoti Ghosh   TS             t;
660793b34091SDebojyoti Ghosh   PetscErrorCode ierr;
6608dc846ba4SSatish Balay   SNES           snes_start;
6609dc846ba4SSatish Balay   DM             dm;
6610dc846ba4SSatish Balay   TSType         type;
661193b34091SDebojyoti Ghosh 
661293b34091SDebojyoti Ghosh   PetscFunctionBegin;
661393b34091SDebojyoti Ghosh   PetscValidPointer(tsin,1);
661493b34091SDebojyoti Ghosh   *tsout = NULL;
661593b34091SDebojyoti Ghosh 
66167a37829fSSatish Balay   ierr = PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView);CHKERRQ(ierr);
661793b34091SDebojyoti Ghosh 
661893b34091SDebojyoti Ghosh   /* General TS description */
661993b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
662093b34091SDebojyoti Ghosh   t->setupcalled       = 0;
662193b34091SDebojyoti Ghosh   t->ksp_its           = 0;
662293b34091SDebojyoti Ghosh   t->snes_its          = 0;
662393b34091SDebojyoti Ghosh   t->nwork             = 0;
662493b34091SDebojyoti Ghosh   t->rhsjacobian.time  = -1e20;
662593b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
662693b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
662793b34091SDebojyoti Ghosh 
662834561852SEmil Constantinescu   ierr = TSGetSNES(tsin,&snes_start);                   CHKERRQ(ierr);
662934561852SEmil Constantinescu   ierr = TSSetSNES(t,snes_start);                       CHKERRQ(ierr);
6630d15a3a53SEmil Constantinescu 
663193b34091SDebojyoti Ghosh   ierr = TSGetDM(tsin,&dm);                             CHKERRQ(ierr);
663293b34091SDebojyoti Ghosh   ierr = TSSetDM(t,dm);                                 CHKERRQ(ierr);
663393b34091SDebojyoti Ghosh 
663493b34091SDebojyoti Ghosh   t->adapt=tsin->adapt;
663593b34091SDebojyoti Ghosh   PetscObjectReference((PetscObject)t->adapt);
663693b34091SDebojyoti Ghosh 
663793b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
663893b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
663993b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
664093b34091SDebojyoti Ghosh   t->time_step_orig    = tsin->time_step_orig;
664193b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
664293b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
664393b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
664493b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
664593b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
664693b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
664793b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
664893b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
664993b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
665093b34091SDebojyoti Ghosh 
665193b34091SDebojyoti Ghosh   ierr = TSGetType(tsin,&type); CHKERRQ(ierr);
665293b34091SDebojyoti Ghosh   ierr = TSSetType(t,type);     CHKERRQ(ierr);
665393b34091SDebojyoti Ghosh 
665493b34091SDebojyoti Ghosh   t->vec_sol           = NULL;
665593b34091SDebojyoti Ghosh 
665693b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
665793b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
665893b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
665993b34091SDebojyoti Ghosh 
666093b34091SDebojyoti Ghosh   ierr = PetscMemcpy(t->ops,tsin->ops,sizeof(struct _TSOps));CHKERRQ(ierr);
666193b34091SDebojyoti Ghosh 
666293b34091SDebojyoti Ghosh   *tsout = t;
666393b34091SDebojyoti Ghosh   PetscFunctionReturn(0);
666493b34091SDebojyoti Ghosh }
6665