xref: /petsc/src/ts/interface/ts.c (revision 9dc50cb58a67b42abbba6aecdb4cbe9393c4ef0e)
1af0996ceSBarry Smith #include <petsc/private/tsimpl.h> /*I "petscts.h"  I*/
21e25c274SJed Brown #include <petscdmda.h>
360e16b1bSMatthew G. Knepley #include <petscdmshell.h>
460e16b1bSMatthew G. Knepley #include <petscdmplex.h>  // For TSSetFromOptions()
560e16b1bSMatthew G. Knepley #include <petscdmswarm.h> // For TSSetFromOptions()
62d5ee99bSBarry Smith #include <petscviewer.h>
72d5ee99bSBarry Smith #include <petscdraw.h>
8900f6b5bSMatthew G. Knepley #include <petscconvest.h>
9d763cef2SBarry Smith 
10d5ba7fb7SMatthew Knepley /* Logging support */
11d74926cbSBarry Smith PetscClassId  TS_CLASSID, DMTS_CLASSID;
12a05bf03eSHong Zhang PetscLogEvent TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval;
13d405a339SMatthew Knepley 
14c793f718SLisandro Dalcin const char *const TSExactFinalTimeOptions[] = {"UNSPECIFIED", "STEPOVER", "INTERPOLATE", "MATCHSTEP", "TSExactFinalTimeOption", "TS_EXACTFINALTIME_", NULL};
1549354f04SShri Abhyankar 
16d71ae5a4SJacob Faibussowitsch static PetscErrorCode TSAdaptSetDefaultType(TSAdapt adapt, TSAdaptType default_type)
17d71ae5a4SJacob Faibussowitsch {
182ffb9264SLisandro Dalcin   PetscFunctionBegin;
19b92453a8SLisandro Dalcin   PetscValidHeaderSpecific(adapt, TSADAPT_CLASSID, 1);
204f572ea9SToby Isaac   PetscAssertPointer(default_type, 2);
211e66621cSBarry Smith   if (!((PetscObject)adapt)->type_name) PetscCall(TSAdaptSetType(adapt, default_type));
223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
232ffb9264SLisandro Dalcin }
242ffb9264SLisandro Dalcin 
25bdad233fSMatthew Knepley /*@
26195e9b02SBarry Smith   TSSetFromOptions - Sets various `TS` parameters from the options database
27bdad233fSMatthew Knepley 
28c3339decSBarry Smith   Collective
29bdad233fSMatthew Knepley 
30bdad233fSMatthew Knepley   Input Parameter:
31bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
32bdad233fSMatthew Knepley 
33bdad233fSMatthew Knepley   Options Database Keys:
34195e9b02SBarry Smith + -ts_type <type>                                                    - EULER, BEULER, SUNDIALS, PSEUDO, CN, RK, THETA, ALPHA, GLLE,  SSP, GLEE, BSYMP, IRK, see `TSType`
35ef222394SBarry Smith . -ts_save_trajectory                                                - checkpoint the solution at each time-step
36ef85077eSLisandro Dalcin . -ts_max_time <time>                                                - maximum time to compute to
374a658b32SHong Zhang . -ts_time_span <t0,...tf>                                           - sets the time span, solutions are computed and stored for each indicated time
38ef85077eSLisandro Dalcin . -ts_max_steps <steps>                                              - maximum number of time-steps to take
39ef85077eSLisandro Dalcin . -ts_init_time <time>                                               - initial time to start computation
40195e9b02SBarry Smith . -ts_final_time <time>                                              - final time to compute to (deprecated: use `-ts_max_time`)
413e4cdcaaSBarry Smith . -ts_dt <dt>                                                        - initial time step
421628793fSSatish Balay . -ts_exact_final_time <stepover,interpolate,matchstep>              - whether to stop at the exact given final time and how to compute the solution at that time
43a3cdaa26SBarry Smith . -ts_max_snes_failures <maxfailures>                                - Maximum number of nonlinear solve failures allowed
44a3cdaa26SBarry Smith . -ts_max_reject <maxrejects>                                        - Maximum number of step rejections before step fails
45a3cdaa26SBarry Smith . -ts_error_if_step_fails <true,false>                               - Error if no step succeeds
46a3cdaa26SBarry Smith . -ts_rtol <rtol>                                                    - relative tolerance for local truncation error
4767b8a455SSatish Balay . -ts_atol <atol>                                                    - Absolute tolerance for local truncation error
48f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view               - test the Jacobian at each iteration against finite difference with RHS function
49b43aa488SJacob Faibussowitsch . -ts_rhs_jacobian_test_mult_transpose                               - test the Jacobian at each iteration against finite difference with RHS function
50195e9b02SBarry Smith . -ts_adjoint_solve <yes,no>                                         - After solving the ODE/DAE solve the adjoint problem (requires `-ts_save_trajectory`)
51847ff0e1SMatthew G. Knepley . -ts_fd_color                                                       - Use finite differences with coloring to compute IJacobian
52bdad233fSMatthew Knepley . -ts_monitor                                                        - print information at each timestep
53aee7a9fbSMatthew G. Knepley . -ts_monitor_cancel                                                 - Cancel all monitors
54de06c3feSJed Brown . -ts_monitor_lg_solution                                            - Monitor solution graphically
55de06c3feSJed Brown . -ts_monitor_lg_error                                               - Monitor error graphically
567cf37e64SBarry Smith . -ts_monitor_error                                                  - Monitors norm of error
576934998bSLisandro Dalcin . -ts_monitor_lg_timestep                                            - Monitor timestep size graphically
588b668821SLisandro Dalcin . -ts_monitor_lg_timestep_log                                        - Monitor log timestep size graphically
59de06c3feSJed Brown . -ts_monitor_lg_snes_iterations                                     - Monitor number nonlinear iterations for each timestep graphically
60de06c3feSJed Brown . -ts_monitor_lg_ksp_iterations                                      - Monitor number nonlinear iterations for each timestep graphically
61de06c3feSJed Brown . -ts_monitor_sp_eig                                                 - Monitor eigenvalues of linearized operator graphically
62de06c3feSJed Brown . -ts_monitor_draw_solution                                          - Monitor solution graphically
633e4cdcaaSBarry Smith . -ts_monitor_draw_solution_phase  <xleft,yleft,xright,yright>       - Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
643e4cdcaaSBarry Smith . -ts_monitor_draw_error                                             - Monitor error graphically, requires use to have provided TSSetSolutionFunction()
65fde5950dSBarry Smith . -ts_monitor_solution [ascii binary draw][:filename][:viewerformat] - monitors the solution at each timestep
66b43aa488SJacob Faibussowitsch . -ts_monitor_solution_interval <interval>                           - output once every interval (default=1) time steps
6763a3b9bcSJacob Faibussowitsch . -ts_monitor_solution_vtk <filename.vts,filename.vtu>               - Save each time step to a binary file, use filename-%%03" PetscInt_FMT ".vts (filename-%%03" PetscInt_FMT ".vtu)
689e336e28SPatrick Sanan - -ts_monitor_envelope                                               - determine maximum and minimum value of each component of the solution over the solution time
6953ea634cSHong Zhang 
70bcf0153eSBarry Smith   Level: beginner
713d5a8a6aSBarry Smith 
72bcf0153eSBarry Smith   Notes:
73bcf0153eSBarry Smith   See `SNESSetFromOptions()` and `KSPSetFromOptions()` for how to control the nonlinear and linear solves used by the time-stepper.
74bcf0153eSBarry Smith 
75195e9b02SBarry Smith   Certain `SNES` options get reset for each new nonlinear solver, for example `-snes_lag_jacobian its` and `-snes_lag_preconditioner its`, in order
76195e9b02SBarry Smith   to retain them over the multiple nonlinear solves that `TS` uses you mush also provide `-snes_lag_jacobian_persists true` and
77195e9b02SBarry Smith   `-snes_lag_preconditioner_persists true`
783d5a8a6aSBarry Smith 
79b43aa488SJacob Faibussowitsch   Developer Notes:
809e336e28SPatrick Sanan   We should unify all the -ts_monitor options in the way that -xxx_view has been unified
81bdad233fSMatthew Knepley 
821cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetType()`
83bdad233fSMatthew Knepley @*/
84d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetFromOptions(TS ts)
85d71ae5a4SJacob Faibussowitsch {
86bc952696SBarry Smith   PetscBool              opt, flg, tflg;
87eabae89aSBarry Smith   char                   monfilename[PETSC_MAX_PATH_LEN];
884a658b32SHong Zhang   PetscReal              time_step, tspan[100];
894a658b32SHong Zhang   PetscInt               nt = PETSC_STATIC_ARRAY_LENGTH(tspan);
9049354f04SShri Abhyankar   TSExactFinalTimeOption eftopt;
91d1212d36SBarry Smith   char                   dir[16];
928434afd1SBarry Smith   TSIFunctionFn         *ifun;
936991f827SBarry Smith   const char            *defaultType;
946991f827SBarry Smith   char                   typeName[256];
95bdad233fSMatthew Knepley 
96bdad233fSMatthew Knepley   PetscFunctionBegin;
970700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
986991f827SBarry Smith 
999566063dSJacob Faibussowitsch   PetscCall(TSRegisterAll());
1009566063dSJacob Faibussowitsch   PetscCall(TSGetIFunction(ts, NULL, &ifun, NULL));
101cd11d68dSLisandro Dalcin 
102d0609cedSBarry Smith   PetscObjectOptionsBegin((PetscObject)ts);
1031ef27442SStefano Zampini   if (((PetscObject)ts)->type_name) defaultType = ((PetscObject)ts)->type_name;
1041ef27442SStefano Zampini   else defaultType = ifun ? TSBEULER : TSEULER;
1059566063dSJacob Faibussowitsch   PetscCall(PetscOptionsFList("-ts_type", "TS method", "TSSetType", TSList, defaultType, typeName, 256, &opt));
1061e66621cSBarry Smith   if (opt) PetscCall(TSSetType(ts, typeName));
1071e66621cSBarry Smith   else PetscCall(TSSetType(ts, defaultType));
108bdad233fSMatthew Knepley 
109bdad233fSMatthew Knepley   /* Handle generic TS options */
1109566063dSJacob Faibussowitsch   PetscCall(PetscOptionsDeprecated("-ts_final_time", "-ts_max_time", "3.10", NULL));
1119566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_max_time", "Maximum time to run to", "TSSetMaxTime", ts->max_time, &ts->max_time, NULL));
1124a658b32SHong Zhang   PetscCall(PetscOptionsRealArray("-ts_time_span", "Time span", "TSSetTimeSpan", tspan, &nt, &flg));
1134a658b32SHong Zhang   if (flg) PetscCall(TSSetTimeSpan(ts, nt, tspan));
1149566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-ts_max_steps", "Maximum number of time steps", "TSSetMaxSteps", ts->max_steps, &ts->max_steps, NULL));
1159566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_init_time", "Initial time", "TSSetTime", ts->ptime, &ts->ptime, NULL));
1169566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_dt", "Initial time step", "TSSetTimeStep", ts->time_step, &time_step, &flg));
1179566063dSJacob Faibussowitsch   if (flg) PetscCall(TSSetTimeStep(ts, time_step));
1189566063dSJacob Faibussowitsch   PetscCall(PetscOptionsEnum("-ts_exact_final_time", "Option for handling of final time step", "TSSetExactFinalTime", TSExactFinalTimeOptions, (PetscEnum)ts->exact_final_time, (PetscEnum *)&eftopt, &flg));
1199566063dSJacob Faibussowitsch   if (flg) PetscCall(TSSetExactFinalTime(ts, eftopt));
1209566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-ts_max_snes_failures", "Maximum number of nonlinear solve failures", "TSSetMaxSNESFailures", ts->max_snes_failures, &ts->max_snes_failures, NULL));
1219566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-ts_max_reject", "Maximum number of step rejections before step fails", "TSSetMaxStepRejections", ts->max_reject, &ts->max_reject, NULL));
1229566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_error_if_step_fails", "Error if no step succeeds", "TSSetErrorIfStepFails", ts->errorifstepfailed, &ts->errorifstepfailed, NULL));
1239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_rtol", "Relative tolerance for local truncation error", "TSSetTolerances", ts->rtol, &ts->rtol, NULL));
1249566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-ts_atol", "Absolute tolerance for local truncation error", "TSSetTolerances", ts->atol, &ts->atol, NULL));
125bdad233fSMatthew Knepley 
1269566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_rhs_jacobian_test_mult", "Test the RHS Jacobian for consistency with RHS at each solve ", "None", ts->testjacobian, &ts->testjacobian, NULL));
1279566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_rhs_jacobian_test_mult_transpose", "Test the RHS Jacobian transpose for consistency with RHS at each solve ", "None", ts->testjacobiantranspose, &ts->testjacobiantranspose, NULL));
1289566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_use_splitrhsfunction", "Use the split RHS function for multirate solvers ", "TSSetUseSplitRHSFunction", ts->use_splitrhsfunction, &ts->use_splitrhsfunction, NULL));
12956f85f32SBarry Smith #if defined(PETSC_HAVE_SAWS)
13056f85f32SBarry Smith   {
13156f85f32SBarry Smith     PetscBool set;
13256f85f32SBarry Smith     flg = PETSC_FALSE;
1339566063dSJacob Faibussowitsch     PetscCall(PetscOptionsBool("-ts_saws_block", "Block for SAWs memory snooper at end of TSSolve", "PetscObjectSAWsBlock", ((PetscObject)ts)->amspublishblock, &flg, &set));
1341baa6e33SBarry Smith     if (set) PetscCall(PetscObjectSAWsSetBlock((PetscObject)ts, flg));
13556f85f32SBarry Smith   }
13656f85f32SBarry Smith #endif
13756f85f32SBarry Smith 
138bdad233fSMatthew Knepley   /* Monitor options */
1399566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt("-ts_monitor_frequency", "Number of time steps between monitor output", "TSMonitorSetFrequency", ts->monitorFrequency, &ts->monitorFrequency, NULL));
1409566063dSJacob Faibussowitsch   PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor", "Monitor time and timestep size", "TSMonitorDefault", TSMonitorDefault, NULL));
1419566063dSJacob Faibussowitsch   PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor_extreme", "Monitor extreme values of the solution", "TSMonitorExtreme", TSMonitorExtreme, NULL));
1429566063dSJacob Faibussowitsch   PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor_solution", "View the solution at each timestep", "TSMonitorSolution", TSMonitorSolution, NULL));
1439566063dSJacob Faibussowitsch   PetscCall(TSMonitorSetFromOptions(ts, "-ts_dmswarm_monitor_moments", "Monitor moments of particle distribution", "TSDMSwarmMonitorMoments", TSDMSwarmMonitorMoments, NULL));
144fde5950dSBarry Smith 
1459566063dSJacob Faibussowitsch   PetscCall(PetscOptionsString("-ts_monitor_python", "Use Python function", "TSMonitorSet", NULL, monfilename, sizeof(monfilename), &flg));
1469566063dSJacob Faibussowitsch   if (flg) PetscCall(PetscPythonMonitorSet((PetscObject)ts, monfilename));
1475180491cSLisandro Dalcin 
1489566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_lg_solution", "Monitor solution graphically", "TSMonitorLGSolution", &opt));
149b3603a34SBarry Smith   if (opt) {
1503923b477SBarry Smith     PetscInt  howoften = 1;
151e669de00SBarry Smith     DM        dm;
152e669de00SBarry Smith     PetscBool net;
153b3603a34SBarry Smith 
1549566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_lg_solution", "Monitor solution graphically", "TSMonitorLGSolution", howoften, &howoften, NULL));
1559566063dSJacob Faibussowitsch     PetscCall(TSGetDM(ts, &dm));
1569566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)dm, DMNETWORK, &net));
157e669de00SBarry Smith     if (net) {
158e669de00SBarry Smith       TSMonitorLGCtxNetwork ctx;
1599566063dSJacob Faibussowitsch       PetscCall(TSMonitorLGCtxNetworkCreate(ts, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 600, 400, howoften, &ctx));
1609566063dSJacob Faibussowitsch       PetscCall(TSMonitorSet(ts, TSMonitorLGCtxNetworkSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxNetworkDestroy));
1619566063dSJacob Faibussowitsch       PetscCall(PetscOptionsBool("-ts_monitor_lg_solution_semilogy", "Plot the solution with a semi-log axis", "", ctx->semilogy, &ctx->semilogy, NULL));
162e669de00SBarry Smith     } else {
163e669de00SBarry Smith       TSMonitorLGCtx ctx;
1649566063dSJacob Faibussowitsch       PetscCall(TSMonitorLGCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx));
1659566063dSJacob Faibussowitsch       PetscCall(TSMonitorSet(ts, TSMonitorLGSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy));
166bdad233fSMatthew Knepley     }
167e669de00SBarry Smith   }
1686ba87a44SLisandro Dalcin 
1699566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_lg_error", "Monitor error graphically", "TSMonitorLGError", &opt));
170ef20d060SBarry Smith   if (opt) {
1710b039ecaSBarry Smith     TSMonitorLGCtx ctx;
1723923b477SBarry Smith     PetscInt       howoften = 1;
173ef20d060SBarry Smith 
1749566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_lg_error", "Monitor error graphically", "TSMonitorLGError", howoften, &howoften, NULL));
1759566063dSJacob Faibussowitsch     PetscCall(TSMonitorLGCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx));
1769566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorLGError, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy));
177ef20d060SBarry Smith   }
1789566063dSJacob Faibussowitsch   PetscCall(TSMonitorSetFromOptions(ts, "-ts_monitor_error", "View the error at each timestep", "TSMonitorError", TSMonitorError, NULL));
1797cf37e64SBarry Smith 
1809566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_lg_timestep", "Monitor timestep size graphically", "TSMonitorLGTimeStep", &opt));
1816934998bSLisandro Dalcin   if (opt) {
1826934998bSLisandro Dalcin     TSMonitorLGCtx ctx;
1836934998bSLisandro Dalcin     PetscInt       howoften = 1;
1846934998bSLisandro Dalcin 
1859566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_lg_timestep", "Monitor timestep size graphically", "TSMonitorLGTimeStep", howoften, &howoften, NULL));
1869566063dSJacob Faibussowitsch     PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx));
1879566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorLGTimeStep, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy));
1886934998bSLisandro Dalcin   }
1899566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_lg_timestep_log", "Monitor log timestep size graphically", "TSMonitorLGTimeStep", &opt));
1908b668821SLisandro Dalcin   if (opt) {
1918b668821SLisandro Dalcin     TSMonitorLGCtx ctx;
1928b668821SLisandro Dalcin     PetscInt       howoften = 1;
1938b668821SLisandro Dalcin 
1949566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_lg_timestep_log", "Monitor log timestep size graphically", "TSMonitorLGTimeStep", howoften, &howoften, NULL));
1959566063dSJacob Faibussowitsch     PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx));
1969566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorLGTimeStep, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy));
1978b668821SLisandro Dalcin     ctx->semilogy = PETSC_TRUE;
1988b668821SLisandro Dalcin   }
1998b668821SLisandro Dalcin 
2009566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_lg_snes_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGSNESIterations", &opt));
201201da799SBarry Smith   if (opt) {
202201da799SBarry Smith     TSMonitorLGCtx ctx;
203201da799SBarry Smith     PetscInt       howoften = 1;
204201da799SBarry Smith 
2059566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_lg_snes_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGSNESIterations", howoften, &howoften, NULL));
2069566063dSJacob Faibussowitsch     PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx));
2079566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorLGSNESIterations, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy));
208201da799SBarry Smith   }
2099566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_lg_ksp_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGKSPIterations", &opt));
210201da799SBarry Smith   if (opt) {
211201da799SBarry Smith     TSMonitorLGCtx ctx;
212201da799SBarry Smith     PetscInt       howoften = 1;
213201da799SBarry Smith 
2149566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_lg_ksp_iterations", "Monitor number nonlinear iterations for each timestep graphically", "TSMonitorLGKSPIterations", howoften, &howoften, NULL));
2159566063dSJacob Faibussowitsch     PetscCall(TSMonitorLGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 400, 300, howoften, &ctx));
2169566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorLGKSPIterations, ctx, (PetscErrorCode(*)(void **))TSMonitorLGCtxDestroy));
217201da799SBarry Smith   }
2189566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_sp_eig", "Monitor eigenvalues of linearized operator graphically", "TSMonitorSPEig", &opt));
2198189c53fSBarry Smith   if (opt) {
2208189c53fSBarry Smith     TSMonitorSPEigCtx ctx;
2218189c53fSBarry Smith     PetscInt          howoften = 1;
2228189c53fSBarry Smith 
2239566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_sp_eig", "Monitor eigenvalues of linearized operator graphically", "TSMonitorSPEig", howoften, &howoften, NULL));
2249566063dSJacob Faibussowitsch     PetscCall(TSMonitorSPEigCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx));
2259566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorSPEig, ctx, (PetscErrorCode(*)(void **))TSMonitorSPEigCtxDestroy));
2268189c53fSBarry Smith   }
22760e16b1bSMatthew G. Knepley   PetscCall(PetscOptionsName("-ts_monitor_sp_swarm", "Display particle phase space from the DMSwarm", "TSMonitorSPSwarm", &opt));
2281b575b74SJoseph Pusztay   if (opt) {
2291b575b74SJoseph Pusztay     TSMonitorSPCtx ctx;
230d7462660SMatthew Knepley     PetscInt       howoften = 1, retain = 0;
23160e16b1bSMatthew G. Knepley     PetscBool      phase = PETSC_TRUE, create = PETSC_TRUE, multispecies = PETSC_FALSE;
232d7462660SMatthew Knepley 
2339371c9d4SSatish Balay     for (PetscInt i = 0; i < ts->numbermonitors; ++i)
2349371c9d4SSatish Balay       if (ts->monitor[i] == TSMonitorSPSwarmSolution) {
2359371c9d4SSatish Balay         create = PETSC_FALSE;
2369371c9d4SSatish Balay         break;
2379371c9d4SSatish Balay       }
2386a5217c0SMatthew G. Knepley     if (create) {
23960e16b1bSMatthew G. Knepley       PetscCall(PetscOptionsInt("-ts_monitor_sp_swarm", "Display particles phase space from the DMSwarm", "TSMonitorSPSwarm", howoften, &howoften, NULL));
2409566063dSJacob Faibussowitsch       PetscCall(PetscOptionsInt("-ts_monitor_sp_swarm_retain", "Retain n points plotted to show trajectory, -1 for all points", "TSMonitorSPSwarm", retain, &retain, NULL));
2419566063dSJacob Faibussowitsch       PetscCall(PetscOptionsBool("-ts_monitor_sp_swarm_phase", "Plot in phase space rather than coordinate space", "TSMonitorSPSwarm", phase, &phase, NULL));
24260e16b1bSMatthew G. Knepley       PetscCall(PetscOptionsBool("-ts_monitor_sp_swarm_multi_species", "Color particles by particle species", "TSMonitorSPSwarm", multispecies, &multispecies, NULL));
24360e16b1bSMatthew G. Knepley       PetscCall(TSMonitorSPCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, retain, phase, multispecies, &ctx));
2449566063dSJacob Faibussowitsch       PetscCall(TSMonitorSet(ts, TSMonitorSPSwarmSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorSPCtxDestroy));
2451b575b74SJoseph Pusztay     }
2466a5217c0SMatthew G. Knepley   }
24760e16b1bSMatthew G. Knepley   PetscCall(PetscOptionsName("-ts_monitor_hg_swarm", "Display particle histogram from the DMSwarm", "TSMonitorHGSwarm", &opt));
24860e16b1bSMatthew G. Knepley   if (opt) {
24960e16b1bSMatthew G. Knepley     TSMonitorHGCtx ctx;
25060e16b1bSMatthew G. Knepley     PetscInt       howoften = 1, Ns = 1;
25160e16b1bSMatthew G. Knepley     PetscBool      velocity = PETSC_FALSE, create = PETSC_TRUE;
25260e16b1bSMatthew G. Knepley 
25360e16b1bSMatthew G. Knepley     for (PetscInt i = 0; i < ts->numbermonitors; ++i)
25460e16b1bSMatthew G. Knepley       if (ts->monitor[i] == TSMonitorHGSwarmSolution) {
25560e16b1bSMatthew G. Knepley         create = PETSC_FALSE;
25660e16b1bSMatthew G. Knepley         break;
25760e16b1bSMatthew G. Knepley       }
25860e16b1bSMatthew G. Knepley     if (create) {
25960e16b1bSMatthew G. Knepley       DM       sw, dm;
26060e16b1bSMatthew G. Knepley       PetscInt Nc, Nb;
26160e16b1bSMatthew G. Knepley 
26260e16b1bSMatthew G. Knepley       PetscCall(TSGetDM(ts, &sw));
26360e16b1bSMatthew G. Knepley       PetscCall(DMSwarmGetCellDM(sw, &dm));
26460e16b1bSMatthew G. Knepley       PetscCall(DMPlexGetHeightStratum(dm, 0, NULL, &Nc));
26560e16b1bSMatthew G. Knepley       Nb = PetscMin(20, PetscMax(10, Nc));
26660e16b1bSMatthew G. Knepley       PetscCall(PetscOptionsInt("-ts_monitor_hg_swarm", "Display particles histogram from the DMSwarm", "TSMonitorHGSwarm", howoften, &howoften, NULL));
26760e16b1bSMatthew G. Knepley       PetscCall(PetscOptionsBool("-ts_monitor_hg_swarm_velocity", "Plot in velocity space rather than coordinate space", "TSMonitorHGSwarm", velocity, &velocity, NULL));
26860e16b1bSMatthew G. Knepley       PetscCall(PetscOptionsInt("-ts_monitor_hg_swarm_species", "Number of species to histogram", "TSMonitorHGSwarm", Ns, &Ns, NULL));
26960e16b1bSMatthew G. Knepley       PetscCall(PetscOptionsInt("-ts_monitor_hg_swarm_bins", "Number of histogram bins", "TSMonitorHGSwarm", Nb, &Nb, NULL));
27060e16b1bSMatthew G. Knepley       PetscCall(TSMonitorHGCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, Ns, Nb, velocity, &ctx));
27160e16b1bSMatthew G. Knepley       PetscCall(TSMonitorSet(ts, TSMonitorHGSwarmSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorHGCtxDestroy));
27260e16b1bSMatthew G. Knepley     }
27360e16b1bSMatthew G. Knepley   }
274ef20d060SBarry Smith   opt = PETSC_FALSE;
2759566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_draw_solution", "Monitor solution graphically", "TSMonitorDrawSolution", &opt));
276a7cc72afSBarry Smith   if (opt) {
27783a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
27883a4ac43SBarry Smith     PetscInt         howoften = 1;
279a80ad3e0SBarry Smith 
2809566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_draw_solution", "Monitor solution graphically", "TSMonitorDrawSolution", howoften, &howoften, NULL));
2819566063dSJacob Faibussowitsch     PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, "Computed Solution", PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx));
2829566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorDrawSolution, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy));
283bdad233fSMatthew Knepley   }
284fb1732b5SBarry Smith   opt = PETSC_FALSE;
2859566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_draw_solution_phase", "Monitor solution graphically", "TSMonitorDrawSolutionPhase", &opt));
2862d5ee99bSBarry Smith   if (opt) {
2872d5ee99bSBarry Smith     TSMonitorDrawCtx ctx;
2882d5ee99bSBarry Smith     PetscReal        bounds[4];
2892d5ee99bSBarry Smith     PetscInt         n = 4;
2902d5ee99bSBarry Smith     PetscDraw        draw;
2916934998bSLisandro Dalcin     PetscDrawAxis    axis;
2922d5ee99bSBarry Smith 
2939566063dSJacob Faibussowitsch     PetscCall(PetscOptionsRealArray("-ts_monitor_draw_solution_phase", "Monitor solution graphically", "TSMonitorDrawSolutionPhase", bounds, &n, NULL));
2943c633725SBarry Smith     PetscCheck(n == 4, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Must provide bounding box of phase field");
2959566063dSJacob Faibussowitsch     PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 300, 300, 1, &ctx));
2969566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(ctx->viewer, 0, &draw));
2979566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDrawAxis(ctx->viewer, 0, &axis));
2989566063dSJacob Faibussowitsch     PetscCall(PetscDrawAxisSetLimits(axis, bounds[0], bounds[2], bounds[1], bounds[3]));
2999566063dSJacob Faibussowitsch     PetscCall(PetscDrawAxisSetLabels(axis, "Phase Diagram", "Variable 1", "Variable 2"));
3009566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorDrawSolutionPhase, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy));
3012d5ee99bSBarry Smith   }
3022d5ee99bSBarry Smith   opt = PETSC_FALSE;
3039566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_draw_error", "Monitor error graphically", "TSMonitorDrawError", &opt));
3043a471f94SBarry Smith   if (opt) {
30583a4ac43SBarry Smith     TSMonitorDrawCtx ctx;
30683a4ac43SBarry Smith     PetscInt         howoften = 1;
3073a471f94SBarry Smith 
3089566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_draw_error", "Monitor error graphically", "TSMonitorDrawError", howoften, &howoften, NULL));
3099566063dSJacob Faibussowitsch     PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, "Error", PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx));
3109566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorDrawError, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy));
3113a471f94SBarry Smith   }
3120ed3bfb6SBarry Smith   opt = PETSC_FALSE;
3139566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_draw_solution_function", "Monitor solution provided by TSMonitorSetSolutionFunction() graphically", "TSMonitorDrawSolutionFunction", &opt));
3140ed3bfb6SBarry Smith   if (opt) {
3150ed3bfb6SBarry Smith     TSMonitorDrawCtx ctx;
3160ed3bfb6SBarry Smith     PetscInt         howoften = 1;
3170ed3bfb6SBarry Smith 
3189566063dSJacob Faibussowitsch     PetscCall(PetscOptionsInt("-ts_monitor_draw_solution_function", "Monitor solution provided by TSMonitorSetSolutionFunction() graphically", "TSMonitorDrawSolutionFunction", howoften, &howoften, NULL));
3199566063dSJacob Faibussowitsch     PetscCall(TSMonitorDrawCtxCreate(PetscObjectComm((PetscObject)ts), NULL, "Solution provided by user function", PETSC_DECIDE, PETSC_DECIDE, 300, 300, howoften, &ctx));
3209566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorDrawSolutionFunction, ctx, (PetscErrorCode(*)(void **))TSMonitorDrawCtxDestroy));
3210ed3bfb6SBarry Smith   }
322fde5950dSBarry Smith 
323ed81e22dSJed Brown   opt = PETSC_FALSE;
32463a3b9bcSJacob Faibussowitsch   PetscCall(PetscOptionsString("-ts_monitor_solution_vtk", "Save each time step to a binary file, use filename-%%03" PetscInt_FMT ".vts", "TSMonitorSolutionVTK", NULL, monfilename, sizeof(monfilename), &flg));
325ed81e22dSJed Brown   if (flg) {
326bbcf679cSJacob Faibussowitsch     const char *ptr = NULL, *ptr2 = NULL;
327ed81e22dSJed Brown     char       *filetemplate;
32863a3b9bcSJacob Faibussowitsch     PetscCheck(monfilename[0], PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03" PetscInt_FMT ".vts");
329ed81e22dSJed Brown     /* Do some cursory validation of the input. */
3309566063dSJacob Faibussowitsch     PetscCall(PetscStrstr(monfilename, "%", (char **)&ptr));
33163a3b9bcSJacob Faibussowitsch     PetscCheck(ptr, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "-ts_monitor_solution_vtk requires a file template, e.g. filename-%%03" PetscInt_FMT ".vts");
332ed81e22dSJed Brown     for (ptr++; ptr && *ptr; ptr++) {
3339566063dSJacob Faibussowitsch       PetscCall(PetscStrchr("DdiouxX", *ptr, (char **)&ptr2));
33463a3b9bcSJacob Faibussowitsch       PetscCheck(ptr2 || (*ptr >= '0' && *ptr <= '9'), PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Invalid file template argument to -ts_monitor_solution_vtk, should look like filename-%%03" PetscInt_FMT ".vts");
335ed81e22dSJed Brown       if (ptr2) break;
336ed81e22dSJed Brown     }
3379566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(monfilename, &filetemplate));
3389566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorSolutionVTK, filetemplate, (PetscErrorCode(*)(void **))TSMonitorSolutionVTKDestroy));
339ed81e22dSJed Brown   }
340bdad233fSMatthew Knepley 
3419566063dSJacob Faibussowitsch   PetscCall(PetscOptionsString("-ts_monitor_dmda_ray", "Display a ray of the solution", "None", "y=0", dir, sizeof(dir), &flg));
342d1212d36SBarry Smith   if (flg) {
343d1212d36SBarry Smith     TSMonitorDMDARayCtx *rayctx;
344d1212d36SBarry Smith     int                  ray = 0;
3453ee9839eSMatthew G. Knepley     DMDirection          ddir;
346d1212d36SBarry Smith     DM                   da;
347d1212d36SBarry Smith     PetscMPIInt          rank;
348d1212d36SBarry Smith 
3493c633725SBarry Smith     PetscCheck(dir[1] == '=', PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Unknown ray %s", dir);
3503ee9839eSMatthew G. Knepley     if (dir[0] == 'x') ddir = DM_X;
3513ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
35298921bdaSJacob Faibussowitsch     else SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Unknown ray %s", dir);
353d1212d36SBarry Smith     sscanf(dir + 2, "%d", &ray);
354d1212d36SBarry Smith 
3559566063dSJacob Faibussowitsch     PetscCall(PetscInfo(((PetscObject)ts), "Displaying DMDA ray %c = %d\n", dir[0], ray));
3569566063dSJacob Faibussowitsch     PetscCall(PetscNew(&rayctx));
3579566063dSJacob Faibussowitsch     PetscCall(TSGetDM(ts, &da));
3589566063dSJacob Faibussowitsch     PetscCall(DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter));
3599566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)ts), &rank));
3601e66621cSBarry Smith     if (rank == 0) PetscCall(PetscViewerDrawOpen(PETSC_COMM_SELF, NULL, NULL, 0, 0, 600, 300, &rayctx->viewer));
36151b4a12fSMatthew G. Knepley     rayctx->lgctx = NULL;
3629566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorDMDARay, rayctx, TSMonitorDMDARayDestroy));
363d1212d36SBarry Smith   }
3649566063dSJacob Faibussowitsch   PetscCall(PetscOptionsString("-ts_monitor_lg_dmda_ray", "Display a ray of the solution", "None", "x=0", dir, sizeof(dir), &flg));
36551b4a12fSMatthew G. Knepley   if (flg) {
36651b4a12fSMatthew G. Knepley     TSMonitorDMDARayCtx *rayctx;
36751b4a12fSMatthew G. Knepley     int                  ray = 0;
3683ee9839eSMatthew G. Knepley     DMDirection          ddir;
36951b4a12fSMatthew G. Knepley     DM                   da;
37051b4a12fSMatthew G. Knepley     PetscInt             howoften = 1;
371d1212d36SBarry Smith 
3723c633725SBarry Smith     PetscCheck(dir[1] == '=', PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Malformed ray %s", dir);
3733ee9839eSMatthew G. Knepley     if (dir[0] == 'x') ddir = DM_X;
3743ee9839eSMatthew G. Knepley     else if (dir[0] == 'y') ddir = DM_Y;
37598921bdaSJacob Faibussowitsch     else SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Unknown ray direction %s", dir);
37651b4a12fSMatthew G. Knepley     sscanf(dir + 2, "%d", &ray);
3771c3436cfSJed Brown 
3789566063dSJacob Faibussowitsch     PetscCall(PetscInfo(((PetscObject)ts), "Displaying LG DMDA ray %c = %d\n", dir[0], ray));
3799566063dSJacob Faibussowitsch     PetscCall(PetscNew(&rayctx));
3809566063dSJacob Faibussowitsch     PetscCall(TSGetDM(ts, &da));
3819566063dSJacob Faibussowitsch     PetscCall(DMDAGetRay(da, ddir, ray, &rayctx->ray, &rayctx->scatter));
3829566063dSJacob Faibussowitsch     PetscCall(TSMonitorLGCtxCreate(PETSC_COMM_SELF, NULL, NULL, PETSC_DECIDE, PETSC_DECIDE, 600, 400, howoften, &rayctx->lgctx));
3839566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorLGDMDARay, rayctx, TSMonitorDMDARayDestroy));
38451b4a12fSMatthew G. Knepley   }
385a7a1495cSBarry Smith 
3869566063dSJacob Faibussowitsch   PetscCall(PetscOptionsName("-ts_monitor_envelope", "Monitor maximum and minimum value of each component of the solution", "TSMonitorEnvelope", &opt));
387b3d3934dSBarry Smith   if (opt) {
388b3d3934dSBarry Smith     TSMonitorEnvelopeCtx ctx;
389b3d3934dSBarry Smith 
3909566063dSJacob Faibussowitsch     PetscCall(TSMonitorEnvelopeCtxCreate(ts, &ctx));
3919566063dSJacob Faibussowitsch     PetscCall(TSMonitorSet(ts, TSMonitorEnvelope, ctx, (PetscErrorCode(*)(void **))TSMonitorEnvelopeCtxDestroy));
392b3d3934dSBarry Smith   }
393aee7a9fbSMatthew G. Knepley   flg = PETSC_FALSE;
3949566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_monitor_cancel", "Remove all monitors", "TSMonitorCancel", flg, &flg, &opt));
3959566063dSJacob Faibussowitsch   if (opt && flg) PetscCall(TSMonitorCancel(ts));
396b3d3934dSBarry Smith 
397847ff0e1SMatthew G. Knepley   flg = PETSC_FALSE;
398d7cfae9bSHong Zhang   PetscCall(PetscOptionsBool("-ts_fd_color", "Use finite differences with coloring to compute IJacobian", "TSComputeIJacobianDefaultColor", flg, &flg, NULL));
399847ff0e1SMatthew G. Knepley   if (flg) {
400847ff0e1SMatthew G. Knepley     DM dm;
401847ff0e1SMatthew G. Knepley 
4029371c9d4SSatish Balay     PetscCall(TSGetDM(ts, &dm));
4039371c9d4SSatish Balay     PetscCall(DMTSUnsetIJacobianContext_Internal(dm));
4049566063dSJacob Faibussowitsch     PetscCall(TSSetIJacobian(ts, NULL, NULL, TSComputeIJacobianDefaultColor, NULL));
4059566063dSJacob Faibussowitsch     PetscCall(PetscInfo(ts, "Setting default finite difference coloring Jacobian matrix\n"));
406847ff0e1SMatthew G. Knepley   }
407847ff0e1SMatthew G. Knepley 
408d763cef2SBarry Smith   /* Handle specific TS options */
409dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, setfromoptions, PetscOptionsObject);
410fbc52257SHong Zhang 
411a7bdc993SLisandro Dalcin   /* Handle TSAdapt options */
4129566063dSJacob Faibussowitsch   PetscCall(TSGetAdapt(ts, &ts->adapt));
4139566063dSJacob Faibussowitsch   PetscCall(TSAdaptSetDefaultType(ts->adapt, ts->default_adapt_type));
414dbbe0bcdSBarry Smith   PetscCall(TSAdaptSetFromOptions(ts->adapt, PetscOptionsObject));
415a7bdc993SLisandro Dalcin 
41668bece0bSHong Zhang   /* TS trajectory must be set after TS, since it may use some TS options above */
4174f122a70SLisandro Dalcin   tflg = ts->trajectory ? PETSC_TRUE : PETSC_FALSE;
4189566063dSJacob Faibussowitsch   PetscCall(PetscOptionsBool("-ts_save_trajectory", "Save the solution at each timestep", "TSSetSaveTrajectory", tflg, &tflg, NULL));
4191baa6e33SBarry Smith   if (tflg) PetscCall(TSSetSaveTrajectory(ts));
420a05bf03eSHong Zhang 
421dbbe0bcdSBarry Smith   PetscCall(TSAdjointSetFromOptions(ts, PetscOptionsObject));
422d763cef2SBarry Smith 
423d763cef2SBarry Smith   /* process any options handlers added with PetscObjectAddOptionsHandler() */
424dbbe0bcdSBarry Smith   PetscCall(PetscObjectProcessOptionsHandlers((PetscObject)ts, PetscOptionsObject));
425d0609cedSBarry Smith   PetscOptionsEnd();
426d763cef2SBarry Smith 
4271baa6e33SBarry Smith   if (ts->trajectory) PetscCall(TSTrajectorySetFromOptions(ts->trajectory, ts));
42868bece0bSHong Zhang 
4291ef27442SStefano Zampini   /* why do we have to do this here and not during TSSetUp? */
4309566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &ts->snes));
4311ef27442SStefano Zampini   if (ts->problem_type == TS_LINEAR) {
4329566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompareAny((PetscObject)ts->snes, &flg, SNESKSPONLY, SNESKSPTRANSPOSEONLY, ""));
4339566063dSJacob Faibussowitsch     if (!flg) PetscCall(SNESSetType(ts->snes, SNESKSPONLY));
4341ef27442SStefano Zampini   }
4359566063dSJacob Faibussowitsch   PetscCall(SNESSetFromOptions(ts->snes));
4363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
437d763cef2SBarry Smith }
438d763cef2SBarry Smith 
439d2daff3dSHong Zhang /*@
440bcf0153eSBarry Smith   TSGetTrajectory - Gets the trajectory from a `TS` if it exists
44178fbdcc8SBarry Smith 
442c3339decSBarry Smith   Collective
44378fbdcc8SBarry Smith 
4442fe279fdSBarry Smith   Input Parameter:
445bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
44678fbdcc8SBarry Smith 
4472fe279fdSBarry Smith   Output Parameter:
448bcf0153eSBarry Smith . tr - the `TSTrajectory` object, if it exists
44978fbdcc8SBarry Smith 
45078fbdcc8SBarry Smith   Level: advanced
45178fbdcc8SBarry Smith 
452bcf0153eSBarry Smith   Note:
453bcf0153eSBarry Smith   This routine should be called after all `TS` options have been set
45478fbdcc8SBarry Smith 
455b43aa488SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSAdjointSolve()`, `TSTrajectoryCreate()`
45678fbdcc8SBarry Smith @*/
457d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTrajectory(TS ts, TSTrajectory *tr)
458d71ae5a4SJacob Faibussowitsch {
45978fbdcc8SBarry Smith   PetscFunctionBegin;
46078fbdcc8SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
46178fbdcc8SBarry Smith   *tr = ts->trajectory;
4623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46378fbdcc8SBarry Smith }
46478fbdcc8SBarry Smith 
46578fbdcc8SBarry Smith /*@
466bcf0153eSBarry Smith   TSSetSaveTrajectory - Causes the `TS` to save its solutions as it iterates forward in time in a `TSTrajectory` object
467d2daff3dSHong Zhang 
468c3339decSBarry Smith   Collective
469d2daff3dSHong Zhang 
470f899ff85SJose E. Roman   Input Parameter:
471bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
472bc952696SBarry Smith 
473bcf0153eSBarry Smith   Options Database Keys:
47478fbdcc8SBarry Smith + -ts_save_trajectory      - saves the trajectory to a file
47567b8a455SSatish Balay - -ts_trajectory_type type - set trajectory type
47678fbdcc8SBarry Smith 
477d2daff3dSHong Zhang   Level: intermediate
478d2daff3dSHong Zhang 
479bcf0153eSBarry Smith   Notes:
480bcf0153eSBarry Smith   This routine should be called after all `TS` options have been set
481d2daff3dSHong Zhang 
482bcf0153eSBarry Smith   The `TSTRAJECTORYVISUALIZATION` files can be loaded into Python with $PETSC_DIR/lib/petsc/bin/PetscBinaryIOTrajectory.py and
483bcf0153eSBarry Smith   MATLAB with $PETSC_DIR/share/petsc/matlab/PetscReadBinaryTrajectory.m
484bcf0153eSBarry Smith 
4851cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSTrajectory`, `TSGetTrajectory()`, `TSAdjointSolve()`
486d2daff3dSHong Zhang @*/
487d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetSaveTrajectory(TS ts)
488d71ae5a4SJacob Faibussowitsch {
489d2daff3dSHong Zhang   PetscFunctionBegin;
490d2daff3dSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
49163a3b9bcSJacob Faibussowitsch   if (!ts->trajectory) PetscCall(TSTrajectoryCreate(PetscObjectComm((PetscObject)ts), &ts->trajectory));
4923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
493d2daff3dSHong Zhang }
494d2daff3dSHong Zhang 
495a7a1495cSBarry Smith /*@
496bcf0153eSBarry Smith   TSResetTrajectory - Destroys and recreates the internal `TSTrajectory` object
4972d29f1f2SStefano Zampini 
498c3339decSBarry Smith   Collective
4992d29f1f2SStefano Zampini 
5002fe279fdSBarry Smith   Input Parameter:
501bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
5022d29f1f2SStefano Zampini 
5032d29f1f2SStefano Zampini   Level: intermediate
5042d29f1f2SStefano Zampini 
5051cc06b55SBarry Smith .seealso: [](ch_ts), `TSTrajectory`, `TSGetTrajectory()`, `TSAdjointSolve()`, `TSRemoveTrajectory()`
5062d29f1f2SStefano Zampini @*/
507d71ae5a4SJacob Faibussowitsch PetscErrorCode TSResetTrajectory(TS ts)
508d71ae5a4SJacob Faibussowitsch {
5092d29f1f2SStefano Zampini   PetscFunctionBegin;
5102d29f1f2SStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5112d29f1f2SStefano Zampini   if (ts->trajectory) {
5129566063dSJacob Faibussowitsch     PetscCall(TSTrajectoryDestroy(&ts->trajectory));
5139566063dSJacob Faibussowitsch     PetscCall(TSTrajectoryCreate(PetscObjectComm((PetscObject)ts), &ts->trajectory));
5142d29f1f2SStefano Zampini   }
5153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5162d29f1f2SStefano Zampini }
5172d29f1f2SStefano Zampini 
5182d29f1f2SStefano Zampini /*@
519195e9b02SBarry Smith   TSRemoveTrajectory - Destroys and removes the internal `TSTrajectory` object from a `TS`
52067a3cfb0SHong Zhang 
521c3339decSBarry Smith   Collective
52267a3cfb0SHong Zhang 
5232fe279fdSBarry Smith   Input Parameter:
524bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
52567a3cfb0SHong Zhang 
52667a3cfb0SHong Zhang   Level: intermediate
52767a3cfb0SHong Zhang 
5281cc06b55SBarry Smith .seealso: [](ch_ts), `TSTrajectory`, `TSResetTrajectory()`, `TSAdjointSolve()`
52967a3cfb0SHong Zhang @*/
530d71ae5a4SJacob Faibussowitsch PetscErrorCode TSRemoveTrajectory(TS ts)
531d71ae5a4SJacob Faibussowitsch {
53267a3cfb0SHong Zhang   PetscFunctionBegin;
53367a3cfb0SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5341e66621cSBarry Smith   if (ts->trajectory) PetscCall(TSTrajectoryDestroy(&ts->trajectory));
5353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
53667a3cfb0SHong Zhang }
53767a3cfb0SHong Zhang 
53867a3cfb0SHong Zhang /*@
539a7a1495cSBarry Smith   TSComputeRHSJacobian - Computes the Jacobian matrix that has been
540bcf0153eSBarry Smith   set with `TSSetRHSJacobian()`.
541a7a1495cSBarry Smith 
542c3339decSBarry Smith   Collective
543a7a1495cSBarry Smith 
544a7a1495cSBarry Smith   Input Parameters:
545bcf0153eSBarry Smith + ts - the `TS` context
546a7a1495cSBarry Smith . t  - current timestep
5470910c330SBarry Smith - U  - input vector
548a7a1495cSBarry Smith 
549a7a1495cSBarry Smith   Output Parameters:
550a7a1495cSBarry Smith + A - Jacobian matrix
5516b867d5aSJose E. Roman - B - optional preconditioning matrix
552a7a1495cSBarry Smith 
553bcf0153eSBarry Smith   Level: developer
554bcf0153eSBarry Smith 
555bcf0153eSBarry Smith   Note:
556a7a1495cSBarry Smith   Most users should not need to explicitly call this routine, as it
557a7a1495cSBarry Smith   is used internally within the nonlinear solvers.
558a7a1495cSBarry Smith 
5591cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSJacobian()`, `KSPSetOperators()`
560a7a1495cSBarry Smith @*/
561d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeRHSJacobian(TS ts, PetscReal t, Vec U, Mat A, Mat B)
562d71ae5a4SJacob Faibussowitsch {
563270bf2e7SJed Brown   PetscObjectState Ustate;
5646c1e1eecSBarry Smith   PetscObjectId    Uid;
56524989b8cSPeter Brune   DM               dm;
566942e3340SBarry Smith   DMTS             tsdm;
5678434afd1SBarry Smith   TSRHSJacobianFn *rhsjacobianfunc;
56824989b8cSPeter Brune   void            *ctx;
5698434afd1SBarry Smith   TSRHSFunctionFn *rhsfunction;
570a7a1495cSBarry Smith 
571a7a1495cSBarry Smith   PetscFunctionBegin;
5720700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5730910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
5740910c330SBarry Smith   PetscCheckSameComm(ts, 1, U, 3);
5759566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
5769566063dSJacob Faibussowitsch   PetscCall(DMGetDMTS(dm, &tsdm));
5779566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL));
5789566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSJacobian(dm, &rhsjacobianfunc, &ctx));
5799566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateGet((PetscObject)U, &Ustate));
5809566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetId((PetscObject)U, &Uid));
581971015bcSStefano Zampini 
5823ba16761SJacob Faibussowitsch   if (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && (rhsfunction != TSComputeRHSFunctionLinear)) PetscFunctionReturn(PETSC_SUCCESS);
583d90be118SSean Farley 
58463a3b9bcSJacob Faibussowitsch   PetscCheck(ts->rhsjacobian.shift == 0.0 || !ts->rhsjacobian.reuse, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Should not call TSComputeRHSJacobian() on a shifted matrix (shift=%lf) when RHSJacobian is reusable.", (double)ts->rhsjacobian.shift);
58524989b8cSPeter Brune   if (rhsjacobianfunc) {
586da023ba9SStefano Zampini     PetscCall(PetscLogEventBegin(TS_JacobianEval, U, ts, A, B));
587792fecdfSBarry Smith     PetscCallBack("TS callback Jacobian", (*rhsjacobianfunc)(ts, t, U, A, B, ctx));
588a6ab3590SBarry Smith     ts->rhsjacs++;
589da023ba9SStefano Zampini     PetscCall(PetscLogEventEnd(TS_JacobianEval, U, ts, A, B));
590ef66eb69SBarry Smith   } else {
5919566063dSJacob Faibussowitsch     PetscCall(MatZeroEntries(A));
5929566063dSJacob Faibussowitsch     if (B && A != B) PetscCall(MatZeroEntries(B));
593ef66eb69SBarry Smith   }
5940e4ef248SJed Brown   ts->rhsjacobian.time  = t;
595971015bcSStefano Zampini   ts->rhsjacobian.shift = 0;
596971015bcSStefano Zampini   ts->rhsjacobian.scale = 1.;
5979566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetId((PetscObject)U, &ts->rhsjacobian.Xid));
5989566063dSJacob Faibussowitsch   PetscCall(PetscObjectStateGet((PetscObject)U, &ts->rhsjacobian.Xstate));
5993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
600a7a1495cSBarry Smith }
601a7a1495cSBarry Smith 
602316643e7SJed Brown /*@
603bcf0153eSBarry Smith   TSComputeRHSFunction - Evaluates the right-hand-side function for a `TS`
604d763cef2SBarry Smith 
605c3339decSBarry Smith   Collective
606316643e7SJed Brown 
607316643e7SJed Brown   Input Parameters:
608bcf0153eSBarry Smith + ts - the `TS` context
609316643e7SJed Brown . t  - current time
6100910c330SBarry Smith - U  - state vector
611316643e7SJed Brown 
612316643e7SJed Brown   Output Parameter:
613316643e7SJed Brown . y - right hand side
614316643e7SJed Brown 
615bcf0153eSBarry Smith   Level: developer
616bcf0153eSBarry Smith 
617316643e7SJed Brown   Note:
618316643e7SJed Brown   Most users should not need to explicitly call this routine, as it
619316643e7SJed Brown   is used internally within the nonlinear solvers.
620316643e7SJed Brown 
6211cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSComputeIFunction()`
622316643e7SJed Brown @*/
623d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeRHSFunction(TS ts, PetscReal t, Vec U, Vec y)
624d71ae5a4SJacob Faibussowitsch {
6258434afd1SBarry Smith   TSRHSFunctionFn *rhsfunction;
6268434afd1SBarry Smith   TSIFunctionFn   *ifunction;
62724989b8cSPeter Brune   void            *ctx;
62824989b8cSPeter Brune   DM               dm;
62924989b8cSPeter Brune 
630d763cef2SBarry Smith   PetscFunctionBegin;
6310700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
6320910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
6330700a824SBarry Smith   PetscValidHeaderSpecific(y, VEC_CLASSID, 4);
6349566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
6359566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, &ctx));
6369566063dSJacob Faibussowitsch   PetscCall(DMTSGetIFunction(dm, &ifunction, NULL));
637d763cef2SBarry Smith 
6383c633725SBarry Smith   PetscCheck(rhsfunction || ifunction, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Must call TSSetRHSFunction() and / or TSSetIFunction()");
639d763cef2SBarry Smith 
64024989b8cSPeter Brune   if (rhsfunction) {
641da023ba9SStefano Zampini     PetscCall(PetscLogEventBegin(TS_FunctionEval, U, ts, y, 0));
6429566063dSJacob Faibussowitsch     PetscCall(VecLockReadPush(U));
643792fecdfSBarry Smith     PetscCallBack("TS callback right-hand-side", (*rhsfunction)(ts, t, U, y, ctx));
6449566063dSJacob Faibussowitsch     PetscCall(VecLockReadPop(U));
645a6ab3590SBarry Smith     ts->rhsfuncs++;
646da023ba9SStefano Zampini     PetscCall(PetscLogEventEnd(TS_FunctionEval, U, ts, y, 0));
6471e66621cSBarry Smith   } else PetscCall(VecZeroEntries(y));
6483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
649d763cef2SBarry Smith }
650d763cef2SBarry Smith 
651ef20d060SBarry Smith /*@
652ef20d060SBarry Smith   TSComputeSolutionFunction - Evaluates the solution function.
653ef20d060SBarry Smith 
654c3339decSBarry Smith   Collective
655ef20d060SBarry Smith 
656ef20d060SBarry Smith   Input Parameters:
657bcf0153eSBarry Smith + ts - the `TS` context
658ef20d060SBarry Smith - t  - current time
659ef20d060SBarry Smith 
660ef20d060SBarry Smith   Output Parameter:
6610910c330SBarry Smith . U - the solution
662ef20d060SBarry Smith 
663ef20d060SBarry Smith   Level: developer
664ef20d060SBarry Smith 
6651cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `TSSetRHSFunction()`, `TSComputeIFunction()`
666ef20d060SBarry Smith @*/
667d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeSolutionFunction(TS ts, PetscReal t, Vec U)
668d71ae5a4SJacob Faibussowitsch {
6698434afd1SBarry Smith   TSSolutionFn *solutionfunction;
670ef20d060SBarry Smith   void         *ctx;
671ef20d060SBarry Smith   DM            dm;
672ef20d060SBarry Smith 
673ef20d060SBarry Smith   PetscFunctionBegin;
674ef20d060SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
6750910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
6769566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
6779566063dSJacob Faibussowitsch   PetscCall(DMTSGetSolutionFunction(dm, &solutionfunction, &ctx));
678792fecdfSBarry Smith   if (solutionfunction) PetscCallBack("TS callback solution", (*solutionfunction)(ts, t, U, ctx));
6793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
680ef20d060SBarry Smith }
6819b7cd975SBarry Smith /*@
6829b7cd975SBarry Smith   TSComputeForcingFunction - Evaluates the forcing function.
6839b7cd975SBarry Smith 
684c3339decSBarry Smith   Collective
6859b7cd975SBarry Smith 
6869b7cd975SBarry Smith   Input Parameters:
687bcf0153eSBarry Smith + ts - the `TS` context
6889b7cd975SBarry Smith - t  - current time
6899b7cd975SBarry Smith 
6909b7cd975SBarry Smith   Output Parameter:
6919b7cd975SBarry Smith . U - the function value
6929b7cd975SBarry Smith 
6939b7cd975SBarry Smith   Level: developer
6949b7cd975SBarry Smith 
6951cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `TSSetRHSFunction()`, `TSComputeIFunction()`
6969b7cd975SBarry Smith @*/
697d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeForcingFunction(TS ts, PetscReal t, Vec U)
698d71ae5a4SJacob Faibussowitsch {
6999b7cd975SBarry Smith   void        *ctx;
7009b7cd975SBarry Smith   DM           dm;
7018434afd1SBarry Smith   TSForcingFn *forcing;
7029b7cd975SBarry Smith 
7039b7cd975SBarry Smith   PetscFunctionBegin;
7049b7cd975SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
7059b7cd975SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
7069566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
7079566063dSJacob Faibussowitsch   PetscCall(DMTSGetForcingFunction(dm, &forcing, &ctx));
7089b7cd975SBarry Smith 
709792fecdfSBarry Smith   if (forcing) PetscCallBack("TS callback forcing function", (*forcing)(ts, t, U, ctx));
7103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
7119b7cd975SBarry Smith }
712ef20d060SBarry Smith 
713d71ae5a4SJacob Faibussowitsch static PetscErrorCode TSGetRHSVec_Private(TS ts, Vec *Frhs)
714d71ae5a4SJacob Faibussowitsch {
7152dd45cf8SJed Brown   Vec F;
716214bc6a2SJed Brown 
717214bc6a2SJed Brown   PetscFunctionBegin;
7180298fd71SBarry Smith   *Frhs = NULL;
7199566063dSJacob Faibussowitsch   PetscCall(TSGetIFunction(ts, &F, NULL, NULL));
7201e66621cSBarry Smith   if (!ts->Frhs) PetscCall(VecDuplicate(F, &ts->Frhs));
721214bc6a2SJed Brown   *Frhs = ts->Frhs;
7223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
723214bc6a2SJed Brown }
724214bc6a2SJed Brown 
725d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetRHSMats_Private(TS ts, Mat *Arhs, Mat *Brhs)
726d71ae5a4SJacob Faibussowitsch {
727214bc6a2SJed Brown   Mat            A, B;
7288434afd1SBarry Smith   TSIJacobianFn *ijacobian;
729214bc6a2SJed Brown 
730214bc6a2SJed Brown   PetscFunctionBegin;
731c0cd0301SJed Brown   if (Arhs) *Arhs = NULL;
732c0cd0301SJed Brown   if (Brhs) *Brhs = NULL;
7339566063dSJacob Faibussowitsch   PetscCall(TSGetIJacobian(ts, &A, &B, &ijacobian, NULL));
734214bc6a2SJed Brown   if (Arhs) {
735214bc6a2SJed Brown     if (!ts->Arhs) {
73641a1d4d2SBarry Smith       if (ijacobian) {
7379566063dSJacob Faibussowitsch         PetscCall(MatDuplicate(A, MAT_DO_NOT_COPY_VALUES, &ts->Arhs));
7389566063dSJacob Faibussowitsch         PetscCall(TSSetMatStructure(ts, SAME_NONZERO_PATTERN));
73941a1d4d2SBarry Smith       } else {
74041a1d4d2SBarry Smith         ts->Arhs = A;
7419566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)A));
74241a1d4d2SBarry Smith       }
7433565c898SBarry Smith     } else {
7443565c898SBarry Smith       PetscBool flg;
7459566063dSJacob Faibussowitsch       PetscCall(SNESGetUseMatrixFree(ts->snes, NULL, &flg));
7463565c898SBarry Smith       /* Handle case where user provided only RHSJacobian and used -snes_mf_operator */
7473565c898SBarry Smith       if (flg && !ijacobian && ts->Arhs == ts->Brhs) {
7489566063dSJacob Faibussowitsch         PetscCall(PetscObjectDereference((PetscObject)ts->Arhs));
7493565c898SBarry Smith         ts->Arhs = A;
7509566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)A));
7513565c898SBarry Smith       }
752214bc6a2SJed Brown     }
753214bc6a2SJed Brown     *Arhs = ts->Arhs;
754214bc6a2SJed Brown   }
755214bc6a2SJed Brown   if (Brhs) {
756214bc6a2SJed Brown     if (!ts->Brhs) {
757bdb70873SJed Brown       if (A != B) {
75841a1d4d2SBarry Smith         if (ijacobian) {
7599566063dSJacob Faibussowitsch           PetscCall(MatDuplicate(B, MAT_DO_NOT_COPY_VALUES, &ts->Brhs));
760bdb70873SJed Brown         } else {
76141a1d4d2SBarry Smith           ts->Brhs = B;
7629566063dSJacob Faibussowitsch           PetscCall(PetscObjectReference((PetscObject)B));
76341a1d4d2SBarry Smith         }
76441a1d4d2SBarry Smith       } else {
7659566063dSJacob Faibussowitsch         PetscCall(PetscObjectReference((PetscObject)ts->Arhs));
76651699248SLisandro Dalcin         ts->Brhs = ts->Arhs;
767bdb70873SJed Brown       }
768214bc6a2SJed Brown     }
769214bc6a2SJed Brown     *Brhs = ts->Brhs;
770214bc6a2SJed Brown   }
7713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
772214bc6a2SJed Brown }
773214bc6a2SJed Brown 
774316643e7SJed Brown /*@
775195e9b02SBarry Smith   TSComputeIFunction - Evaluates the DAE residual written in the implicit form F(t,U,Udot)=0
776316643e7SJed Brown 
777c3339decSBarry Smith   Collective
778316643e7SJed Brown 
779316643e7SJed Brown   Input Parameters:
780bcf0153eSBarry Smith + ts   - the `TS` context
781316643e7SJed Brown . t    - current time
7820910c330SBarry Smith . U    - state vector
7830910c330SBarry Smith . Udot - time derivative of state vector
784bcf0153eSBarry Smith - imex - flag indicates if the method is `TSIMEX` so that the RHSFunction should be kept separate
785316643e7SJed Brown 
786316643e7SJed Brown   Output Parameter:
787316643e7SJed Brown . Y - right hand side
788316643e7SJed Brown 
789bcf0153eSBarry Smith   Level: developer
790bcf0153eSBarry Smith 
791316643e7SJed Brown   Note:
792316643e7SJed Brown   Most users should not need to explicitly call this routine, as it
793316643e7SJed Brown   is used internally within the nonlinear solvers.
794316643e7SJed Brown 
79515229ffcSPierre Jolivet   If the user did not write their equations in implicit form, this
796316643e7SJed Brown   function recasts them in implicit form.
797316643e7SJed Brown 
7981cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `TSComputeRHSFunction()`
799316643e7SJed Brown @*/
800d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeIFunction(TS ts, PetscReal t, Vec U, Vec Udot, Vec Y, PetscBool imex)
801d71ae5a4SJacob Faibussowitsch {
8028434afd1SBarry Smith   TSIFunctionFn   *ifunction;
8038434afd1SBarry Smith   TSRHSFunctionFn *rhsfunction;
80424989b8cSPeter Brune   void            *ctx;
80524989b8cSPeter Brune   DM               dm;
806316643e7SJed Brown 
807316643e7SJed Brown   PetscFunctionBegin;
8080700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
8090910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
8100910c330SBarry Smith   PetscValidHeaderSpecific(Udot, VEC_CLASSID, 4);
8110700a824SBarry Smith   PetscValidHeaderSpecific(Y, VEC_CLASSID, 5);
812316643e7SJed Brown 
8139566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
8149566063dSJacob Faibussowitsch   PetscCall(DMTSGetIFunction(dm, &ifunction, &ctx));
8159566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL));
81624989b8cSPeter Brune 
8173c633725SBarry Smith   PetscCheck(rhsfunction || ifunction, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Must call TSSetRHSFunction() and / or TSSetIFunction()");
818d90be118SSean Farley 
819da023ba9SStefano Zampini   PetscCall(PetscLogEventBegin(TS_FunctionEval, U, ts, Udot, Y));
82024989b8cSPeter Brune   if (ifunction) {
821792fecdfSBarry Smith     PetscCallBack("TS callback implicit function", (*ifunction)(ts, t, U, Udot, Y, ctx));
822a6ab3590SBarry Smith     ts->ifuncs++;
823214bc6a2SJed Brown   }
824214bc6a2SJed Brown   if (imex) {
8251e66621cSBarry Smith     if (!ifunction) PetscCall(VecCopy(Udot, Y));
82624989b8cSPeter Brune   } else if (rhsfunction) {
82724989b8cSPeter Brune     if (ifunction) {
828214bc6a2SJed Brown       Vec Frhs;
8299566063dSJacob Faibussowitsch       PetscCall(TSGetRHSVec_Private(ts, &Frhs));
8309566063dSJacob Faibussowitsch       PetscCall(TSComputeRHSFunction(ts, t, U, Frhs));
8319566063dSJacob Faibussowitsch       PetscCall(VecAXPY(Y, -1, Frhs));
8322dd45cf8SJed Brown     } else {
8339566063dSJacob Faibussowitsch       PetscCall(TSComputeRHSFunction(ts, t, U, Y));
8349566063dSJacob Faibussowitsch       PetscCall(VecAYPX(Y, -1, Udot));
835316643e7SJed Brown     }
8364a6899ffSJed Brown   }
837da023ba9SStefano Zampini   PetscCall(PetscLogEventEnd(TS_FunctionEval, U, ts, Udot, Y));
8383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
839316643e7SJed Brown }
840316643e7SJed Brown 
841cfa8a9a2SHong Zhang /*
842195e9b02SBarry Smith    TSRecoverRHSJacobian - Recover the Jacobian matrix so that one can call `TSComputeRHSJacobian()` on it.
843cfa8a9a2SHong Zhang 
844cfa8a9a2SHong Zhang    Note:
845195e9b02SBarry Smith    This routine is needed when one switches from `TSComputeIJacobian()` to `TSComputeRHSJacobian()` because the Jacobian matrix may be shifted or scaled in `TSComputeIJacobian()`.
846cfa8a9a2SHong Zhang 
847cfa8a9a2SHong Zhang */
848d71ae5a4SJacob Faibussowitsch static PetscErrorCode TSRecoverRHSJacobian(TS ts, Mat A, Mat B)
849d71ae5a4SJacob Faibussowitsch {
850cfa8a9a2SHong Zhang   PetscFunctionBegin;
851cfa8a9a2SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
8523c633725SBarry Smith   PetscCheck(A == ts->Arhs, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Invalid Amat");
8533c633725SBarry Smith   PetscCheck(B == ts->Brhs, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Invalid Bmat");
854cfa8a9a2SHong Zhang 
8551baa6e33SBarry Smith   if (ts->rhsjacobian.shift) PetscCall(MatShift(A, -ts->rhsjacobian.shift));
85648a46eb9SPierre Jolivet   if (ts->rhsjacobian.scale == -1.) PetscCall(MatScale(A, -1));
857cfa8a9a2SHong Zhang   if (B && B == ts->Brhs && A != B) {
8581baa6e33SBarry Smith     if (ts->rhsjacobian.shift) PetscCall(MatShift(B, -ts->rhsjacobian.shift));
8591e66621cSBarry Smith     if (ts->rhsjacobian.scale == -1.) PetscCall(MatScale(B, -1));
860cfa8a9a2SHong Zhang   }
861cfa8a9a2SHong Zhang   ts->rhsjacobian.shift = 0;
862cfa8a9a2SHong Zhang   ts->rhsjacobian.scale = 1.;
8633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
864cfa8a9a2SHong Zhang }
865cfa8a9a2SHong Zhang 
866316643e7SJed Brown /*@
867316643e7SJed Brown   TSComputeIJacobian - Evaluates the Jacobian of the DAE
868316643e7SJed Brown 
869c3339decSBarry Smith   Collective
870316643e7SJed Brown 
871316643e7SJed Brown   Input Parameters:
872bcf0153eSBarry Smith + ts    - the `TS` context
873316643e7SJed Brown . t     - current timestep
8740910c330SBarry Smith . U     - state vector
8750910c330SBarry Smith . Udot  - time derivative of state vector
876214bc6a2SJed Brown . shift - shift to apply, see note below
877bcf0153eSBarry Smith - imex  - flag indicates if the method is `TSIMEX` so that the RHSJacobian should be kept separate
878316643e7SJed Brown 
879316643e7SJed Brown   Output Parameters:
880316643e7SJed Brown + A - Jacobian matrix
881195e9b02SBarry Smith - B - matrix from which the preconditioner is constructed; often the same as `A`
882316643e7SJed Brown 
883bcf0153eSBarry Smith   Level: developer
884bcf0153eSBarry Smith 
885316643e7SJed Brown   Notes:
8860910c330SBarry Smith   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
887195e9b02SBarry Smith .vb
8880910c330SBarry Smith    dF/dU + shift*dF/dUdot
889195e9b02SBarry Smith .ve
890316643e7SJed Brown   Most users should not need to explicitly call this routine, as it
891316643e7SJed Brown   is used internally within the nonlinear solvers.
892316643e7SJed Brown 
8931cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetIJacobian()`
89463495f91SJed Brown @*/
895d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeIJacobian(TS ts, PetscReal t, Vec U, Vec Udot, PetscReal shift, Mat A, Mat B, PetscBool imex)
896d71ae5a4SJacob Faibussowitsch {
8978434afd1SBarry Smith   TSIJacobianFn   *ijacobian;
8988434afd1SBarry Smith   TSRHSJacobianFn *rhsjacobian;
89924989b8cSPeter Brune   DM               dm;
90024989b8cSPeter Brune   void            *ctx;
901316643e7SJed Brown 
902316643e7SJed Brown   PetscFunctionBegin;
9030700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
9040910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
9050910c330SBarry Smith   PetscValidHeaderSpecific(Udot, VEC_CLASSID, 4);
90694ab13aaSBarry Smith   PetscValidHeaderSpecific(A, MAT_CLASSID, 6);
90794ab13aaSBarry Smith   PetscValidHeaderSpecific(B, MAT_CLASSID, 7);
90824989b8cSPeter Brune 
9099566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
9109566063dSJacob Faibussowitsch   PetscCall(DMTSGetIJacobian(dm, &ijacobian, &ctx));
9119566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSJacobian(dm, &rhsjacobian, NULL));
91224989b8cSPeter Brune 
9133c633725SBarry Smith   PetscCheck(rhsjacobian || ijacobian, PetscObjectComm((PetscObject)ts), PETSC_ERR_USER, "Must call TSSetRHSJacobian() and / or TSSetIJacobian()");
914316643e7SJed Brown 
915da023ba9SStefano Zampini   PetscCall(PetscLogEventBegin(TS_JacobianEval, U, ts, A, B));
91624989b8cSPeter Brune   if (ijacobian) {
917792fecdfSBarry Smith     PetscCallBack("TS callback implicit Jacobian", (*ijacobian)(ts, t, U, Udot, shift, A, B, ctx));
918a6ab3590SBarry Smith     ts->ijacs++;
9194a6899ffSJed Brown   }
920214bc6a2SJed Brown   if (imex) {
921b5abc632SBarry Smith     if (!ijacobian) { /* system was written as Udot = G(t,U) */
9224c26be97Sstefano_zampini       PetscBool assembled;
923971015bcSStefano Zampini       if (rhsjacobian) {
924971015bcSStefano Zampini         Mat Arhs = NULL;
9259566063dSJacob Faibussowitsch         PetscCall(TSGetRHSMats_Private(ts, &Arhs, NULL));
926971015bcSStefano Zampini         if (A == Arhs) {
9273c633725SBarry Smith           PetscCheck(rhsjacobian != TSComputeRHSJacobianConstant, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Unsupported operation! cannot use TSComputeRHSJacobianConstant"); /* there is no way to reconstruct shift*M-J since J cannot be reevaluated */
928971015bcSStefano Zampini           ts->rhsjacobian.time = PETSC_MIN_REAL;
929971015bcSStefano Zampini         }
930971015bcSStefano Zampini       }
9319566063dSJacob Faibussowitsch       PetscCall(MatZeroEntries(A));
9329566063dSJacob Faibussowitsch       PetscCall(MatAssembled(A, &assembled));
9334c26be97Sstefano_zampini       if (!assembled) {
9349566063dSJacob Faibussowitsch         PetscCall(MatAssemblyBegin(A, MAT_FINAL_ASSEMBLY));
9359566063dSJacob Faibussowitsch         PetscCall(MatAssemblyEnd(A, MAT_FINAL_ASSEMBLY));
9364c26be97Sstefano_zampini       }
9379566063dSJacob Faibussowitsch       PetscCall(MatShift(A, shift));
93894ab13aaSBarry Smith       if (A != B) {
9399566063dSJacob Faibussowitsch         PetscCall(MatZeroEntries(B));
9409566063dSJacob Faibussowitsch         PetscCall(MatAssembled(B, &assembled));
9414c26be97Sstefano_zampini         if (!assembled) {
9429566063dSJacob Faibussowitsch           PetscCall(MatAssemblyBegin(B, MAT_FINAL_ASSEMBLY));
9439566063dSJacob Faibussowitsch           PetscCall(MatAssemblyEnd(B, MAT_FINAL_ASSEMBLY));
9444c26be97Sstefano_zampini         }
9459566063dSJacob Faibussowitsch         PetscCall(MatShift(B, shift));
946214bc6a2SJed Brown       }
947214bc6a2SJed Brown     }
948214bc6a2SJed Brown   } else {
949e1244c69SJed Brown     Mat Arhs = NULL, Brhs = NULL;
9501e66621cSBarry Smith 
9511e66621cSBarry Smith     /* RHSJacobian needs to be converted to part of IJacobian if exists */
9521e66621cSBarry Smith     if (rhsjacobian) PetscCall(TSGetRHSMats_Private(ts, &Arhs, &Brhs));
953e8b1e424SHong Zhang     if (Arhs == A) { /* No IJacobian matrix, so we only have the RHS matrix */
954e8b1e424SHong Zhang       PetscObjectState Ustate;
955e8b1e424SHong Zhang       PetscObjectId    Uid;
9568434afd1SBarry Smith       TSRHSFunctionFn *rhsfunction;
957e8b1e424SHong Zhang 
9589566063dSJacob Faibussowitsch       PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL));
9599566063dSJacob Faibussowitsch       PetscCall(PetscObjectStateGet((PetscObject)U, &Ustate));
9609566063dSJacob Faibussowitsch       PetscCall(PetscObjectGetId((PetscObject)U, &Uid));
9619371c9d4SSatish Balay       if ((rhsjacobian == TSComputeRHSJacobianConstant || (ts->rhsjacobian.time == t && (ts->problem_type == TS_LINEAR || (ts->rhsjacobian.Xid == Uid && ts->rhsjacobian.Xstate == Ustate)) && rhsfunction != TSComputeRHSFunctionLinear)) &&
9629371c9d4SSatish Balay           ts->rhsjacobian.scale == -1.) {                      /* No need to recompute RHSJacobian */
9639566063dSJacob Faibussowitsch         PetscCall(MatShift(A, shift - ts->rhsjacobian.shift)); /* revert the old shift and add the new shift with a single call to MatShift */
9641e66621cSBarry Smith         if (A != B) PetscCall(MatShift(B, shift - ts->rhsjacobian.shift));
965e8b1e424SHong Zhang       } else {
9663565c898SBarry Smith         PetscBool flg;
967e8b1e424SHong Zhang 
968e8b1e424SHong Zhang         if (ts->rhsjacobian.reuse) { /* Undo the damage */
969e8b1e424SHong Zhang           /* MatScale has a short path for this case.
970e8b1e424SHong Zhang              However, this code path is taken the first time TSComputeRHSJacobian is called
971e8b1e424SHong Zhang              and the matrices have not been assembled yet */
9729566063dSJacob Faibussowitsch           PetscCall(TSRecoverRHSJacobian(ts, A, B));
973e8b1e424SHong Zhang         }
9749566063dSJacob Faibussowitsch         PetscCall(TSComputeRHSJacobian(ts, t, U, A, B));
9759566063dSJacob Faibussowitsch         PetscCall(SNESGetUseMatrixFree(ts->snes, NULL, &flg));
9763565c898SBarry Smith         /* since -snes_mf_operator uses the full SNES function it does not need to be shifted or scaled here */
9773565c898SBarry Smith         if (!flg) {
9789566063dSJacob Faibussowitsch           PetscCall(MatScale(A, -1));
9799566063dSJacob Faibussowitsch           PetscCall(MatShift(A, shift));
9803565c898SBarry Smith         }
98194ab13aaSBarry Smith         if (A != B) {
9829566063dSJacob Faibussowitsch           PetscCall(MatScale(B, -1));
9839566063dSJacob Faibussowitsch           PetscCall(MatShift(B, shift));
984316643e7SJed Brown         }
985e8b1e424SHong Zhang       }
986e8b1e424SHong Zhang       ts->rhsjacobian.scale = -1;
987e8b1e424SHong Zhang       ts->rhsjacobian.shift = shift;
988d60b7d5cSBarry Smith     } else if (Arhs) {  /* Both IJacobian and RHSJacobian */
989e1244c69SJed Brown       if (!ijacobian) { /* No IJacobian provided, but we have a separate RHS matrix */
9909566063dSJacob Faibussowitsch         PetscCall(MatZeroEntries(A));
9919566063dSJacob Faibussowitsch         PetscCall(MatShift(A, shift));
99294ab13aaSBarry Smith         if (A != B) {
9939566063dSJacob Faibussowitsch           PetscCall(MatZeroEntries(B));
9949566063dSJacob Faibussowitsch           PetscCall(MatShift(B, shift));
995214bc6a2SJed Brown         }
996316643e7SJed Brown       }
9979566063dSJacob Faibussowitsch       PetscCall(TSComputeRHSJacobian(ts, t, U, Arhs, Brhs));
9989566063dSJacob Faibussowitsch       PetscCall(MatAXPY(A, -1, Arhs, ts->axpy_pattern));
9991e66621cSBarry Smith       if (A != B) PetscCall(MatAXPY(B, -1, Brhs, ts->axpy_pattern));
1000316643e7SJed Brown     }
1001316643e7SJed Brown   }
1002da023ba9SStefano Zampini   PetscCall(PetscLogEventEnd(TS_JacobianEval, U, ts, A, B));
10033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1004316643e7SJed Brown }
1005316643e7SJed Brown 
1006d763cef2SBarry Smith /*@C
1007d763cef2SBarry Smith   TSSetRHSFunction - Sets the routine for evaluating the function,
1008b5abc632SBarry Smith   where U_t = G(t,u).
1009d763cef2SBarry Smith 
1010c3339decSBarry Smith   Logically Collective
1011d763cef2SBarry Smith 
1012d763cef2SBarry Smith   Input Parameters:
1013bcf0153eSBarry Smith + ts  - the `TS` context obtained from `TSCreate()`
1014195e9b02SBarry Smith . r   - vector to put the computed right hand side (or `NULL` to have it created)
1015d763cef2SBarry Smith . f   - routine for evaluating the right-hand-side function
1016195e9b02SBarry Smith - ctx - [optional] user-defined context for private data for the function evaluation routine (may be `NULL`)
1017d763cef2SBarry Smith 
1018d763cef2SBarry Smith   Level: beginner
1019d763cef2SBarry Smith 
1020bcf0153eSBarry Smith   Note:
1021bcf0153eSBarry Smith   You must call this function or `TSSetIFunction()` to define your ODE. You cannot use this function when solving a DAE.
10222bbac0d3SBarry Smith 
10238434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSRHSFunctionFn`, `TSSetRHSJacobian()`, `TSSetIJacobian()`, `TSSetIFunction()`
1024d763cef2SBarry Smith @*/
10258434afd1SBarry Smith PetscErrorCode TSSetRHSFunction(TS ts, Vec r, TSRHSFunctionFn *f, void *ctx)
1026d71ae5a4SJacob Faibussowitsch {
1027089b2837SJed Brown   SNES snes;
10280298fd71SBarry Smith   Vec  ralloc = NULL;
102924989b8cSPeter Brune   DM   dm;
1030d763cef2SBarry Smith 
1031089b2837SJed Brown   PetscFunctionBegin;
10320700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1033ca94891dSJed Brown   if (r) PetscValidHeaderSpecific(r, VEC_CLASSID, 2);
103424989b8cSPeter Brune 
10359566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
10369566063dSJacob Faibussowitsch   PetscCall(DMTSSetRHSFunction(dm, f, ctx));
10379566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
1038e856ceecSJed Brown   if (!r && !ts->dm && ts->vec_sol) {
10399566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ts->vec_sol, &ralloc));
1040e856ceecSJed Brown     r = ralloc;
1041e856ceecSJed Brown   }
10429566063dSJacob Faibussowitsch   PetscCall(SNESSetFunction(snes, r, SNESTSFormFunction, ts));
10439566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ralloc));
10443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1045d763cef2SBarry Smith }
1046d763cef2SBarry Smith 
1047ef20d060SBarry Smith /*@C
1048abd5a294SJed Brown   TSSetSolutionFunction - Provide a function that computes the solution of the ODE or DAE
1049ef20d060SBarry Smith 
1050c3339decSBarry Smith   Logically Collective
1051ef20d060SBarry Smith 
1052ef20d060SBarry Smith   Input Parameters:
1053bcf0153eSBarry Smith + ts  - the `TS` context obtained from `TSCreate()`
1054ef20d060SBarry Smith . f   - routine for evaluating the solution
1055ef20d060SBarry Smith - ctx - [optional] user-defined context for private data for the
1056195e9b02SBarry Smith           function evaluation routine (may be `NULL`)
1057ef20d060SBarry Smith 
1058bcf0153eSBarry Smith   Options Database Keys:
1059bcf0153eSBarry Smith + -ts_monitor_lg_error   - create a graphical monitor of error history, requires user to have provided `TSSetSolutionFunction()`
1060bcf0153eSBarry Smith - -ts_monitor_draw_error - Monitor error graphically, requires user to have provided `TSSetSolutionFunction()`
1061bcf0153eSBarry Smith 
1062bcf0153eSBarry Smith   Level: intermediate
10630ed3bfb6SBarry Smith 
1064abd5a294SJed Brown   Notes:
1065abd5a294SJed Brown   This routine is used for testing accuracy of time integration schemes when you already know the solution.
1066abd5a294SJed Brown   If analytic solutions are not known for your system, consider using the Method of Manufactured Solutions to
1067abd5a294SJed Brown   create closed-form solutions with non-physical forcing terms.
1068abd5a294SJed Brown 
1069bcf0153eSBarry Smith   For low-dimensional problems solved in serial, such as small discrete systems, `TSMonitorLGError()` can be used to monitor the error history.
1070abd5a294SJed Brown 
10718434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolutionFn`, `TSSetRHSJacobian()`, `TSSetIJacobian()`, `TSComputeSolutionFunction()`, `TSSetForcingFunction()`, `TSSetSolution()`, `TSGetSolution()`, `TSMonitorLGError()`, `TSMonitorDrawError()`
1072ef20d060SBarry Smith @*/
10738434afd1SBarry Smith PetscErrorCode TSSetSolutionFunction(TS ts, TSSolutionFn *f, void *ctx)
1074d71ae5a4SJacob Faibussowitsch {
1075ef20d060SBarry Smith   DM dm;
1076ef20d060SBarry Smith 
1077ef20d060SBarry Smith   PetscFunctionBegin;
1078ef20d060SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
10799566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
10809566063dSJacob Faibussowitsch   PetscCall(DMTSSetSolutionFunction(dm, f, ctx));
10813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1082ef20d060SBarry Smith }
1083ef20d060SBarry Smith 
10849b7cd975SBarry Smith /*@C
10859b7cd975SBarry Smith   TSSetForcingFunction - Provide a function that computes a forcing term for a ODE or PDE
10869b7cd975SBarry Smith 
1087c3339decSBarry Smith   Logically Collective
10889b7cd975SBarry Smith 
10899b7cd975SBarry Smith   Input Parameters:
1090bcf0153eSBarry Smith + ts   - the `TS` context obtained from `TSCreate()`
1091e162b725SBarry Smith . func - routine for evaluating the forcing function
109214d0ab18SJacob Faibussowitsch - ctx  - [optional] user-defined context for private data for the function evaluation routine
109314d0ab18SJacob Faibussowitsch          (may be `NULL`)
10949b7cd975SBarry Smith 
1095bcf0153eSBarry Smith   Level: intermediate
1096bcf0153eSBarry Smith 
10979b7cd975SBarry Smith   Notes:
10989b7cd975SBarry Smith   This routine is useful for testing accuracy of time integration schemes when using the Method of Manufactured Solutions to
1099e162b725SBarry Smith   create closed-form solutions with a non-physical forcing term. It allows you to use the Method of Manufactored Solution without directly editing the
1100e162b725SBarry Smith   definition of the problem you are solving and hence possibly introducing bugs.
1101e162b725SBarry Smith 
11028847d985SBarry Smith   This replaces the ODE F(u,u_t,t) = 0 the `TS` is solving with F(u,u_t,t) - func(t) = 0
1103e162b725SBarry Smith 
1104e162b725SBarry Smith   This forcing function does not depend on the solution to the equations, it can only depend on spatial location, time, and possibly parameters, the
1105e162b725SBarry Smith   parameters can be passed in the ctx variable.
11069b7cd975SBarry Smith 
1107bcf0153eSBarry Smith   For low-dimensional problems solved in serial, such as small discrete systems, `TSMonitorLGError()` can be used to monitor the error history.
11089b7cd975SBarry Smith 
11098434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSForcingFn`, `TSSetRHSJacobian()`, `TSSetIJacobian()`,
111014d0ab18SJacob Faibussowitsch `TSComputeSolutionFunction()`, `TSSetSolutionFunction()`
11119b7cd975SBarry Smith @*/
11128434afd1SBarry Smith PetscErrorCode TSSetForcingFunction(TS ts, TSForcingFn *func, void *ctx)
1113d71ae5a4SJacob Faibussowitsch {
11149b7cd975SBarry Smith   DM dm;
11159b7cd975SBarry Smith 
11169b7cd975SBarry Smith   PetscFunctionBegin;
11179b7cd975SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
11189566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
11199566063dSJacob Faibussowitsch   PetscCall(DMTSSetForcingFunction(dm, func, ctx));
11203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
11219b7cd975SBarry Smith }
11229b7cd975SBarry Smith 
1123d763cef2SBarry Smith /*@C
1124f7ab8db6SBarry Smith   TSSetRHSJacobian - Sets the function to compute the Jacobian of G,
1125b5abc632SBarry Smith   where U_t = G(U,t), as well as the location to store the matrix.
1126d763cef2SBarry Smith 
1127c3339decSBarry Smith   Logically Collective
1128d763cef2SBarry Smith 
1129d763cef2SBarry Smith   Input Parameters:
1130bcf0153eSBarry Smith + ts   - the `TS` context obtained from `TSCreate()`
1131195e9b02SBarry Smith . Amat - (approximate) location to store Jacobian matrix entries computed by `f`
1132195e9b02SBarry Smith . Pmat - matrix from which preconditioner is to be constructed (usually the same as `Amat`)
1133d763cef2SBarry Smith . f    - the Jacobian evaluation routine
1134195e9b02SBarry Smith - ctx  - [optional] user-defined context for private data for the Jacobian evaluation routine (may be `NULL`)
1135d763cef2SBarry Smith 
1136bcf0153eSBarry Smith   Level: beginner
1137bcf0153eSBarry Smith 
11386cd88445SBarry Smith   Notes:
11396cd88445SBarry Smith   You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
11406cd88445SBarry Smith 
114114d0ab18SJacob Faibussowitsch   The `TS` solver may modify the nonzero structure and the entries of the matrices `Amat` and `Pmat` between the calls to `f()`
1142ca5f011dSBarry Smith   You should not assume the values are the same in the next call to f() as you set them in the previous call.
1143d763cef2SBarry Smith 
11448434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSRHSJacobianFn`, `SNESComputeJacobianDefaultColor()`,
11458434afd1SBarry Smith `TSSetRHSFunction()`, `TSRHSJacobianSetReuse()`, `TSSetIJacobian()`, `TSRHSFunctionFn`, `TSIFunctionFn`
1146d763cef2SBarry Smith @*/
11478434afd1SBarry Smith PetscErrorCode TSSetRHSJacobian(TS ts, Mat Amat, Mat Pmat, TSRHSJacobianFn *f, void *ctx)
1148d71ae5a4SJacob Faibussowitsch {
1149089b2837SJed Brown   SNES           snes;
115024989b8cSPeter Brune   DM             dm;
11518434afd1SBarry Smith   TSIJacobianFn *ijacobian;
1152277b19d0SLisandro Dalcin 
1153d763cef2SBarry Smith   PetscFunctionBegin;
11540700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1155e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat, MAT_CLASSID, 2);
1156e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat, MAT_CLASSID, 3);
1157e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts, 1, Amat, 2);
1158e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts, 1, Pmat, 3);
1159d763cef2SBarry Smith 
11609566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
11619566063dSJacob Faibussowitsch   PetscCall(DMTSSetRHSJacobian(dm, f, ctx));
11629566063dSJacob Faibussowitsch   PetscCall(DMTSGetIJacobian(dm, &ijacobian, NULL));
11639566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
11641e66621cSBarry Smith   if (!ijacobian) PetscCall(SNESSetJacobian(snes, Amat, Pmat, SNESTSFormJacobian, ts));
1165e5d3d808SBarry Smith   if (Amat) {
11669566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)Amat));
11679566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&ts->Arhs));
1168e5d3d808SBarry Smith     ts->Arhs = Amat;
11690e4ef248SJed Brown   }
1170e5d3d808SBarry Smith   if (Pmat) {
11719566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)Pmat));
11729566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&ts->Brhs));
1173e5d3d808SBarry Smith     ts->Brhs = Pmat;
11740e4ef248SJed Brown   }
11753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1176d763cef2SBarry Smith }
1177d763cef2SBarry Smith 
1178316643e7SJed Brown /*@C
1179b5abc632SBarry Smith   TSSetIFunction - Set the function to compute F(t,U,U_t) where F() = 0 is the DAE to be solved.
1180316643e7SJed Brown 
1181c3339decSBarry Smith   Logically Collective
1182316643e7SJed Brown 
1183316643e7SJed Brown   Input Parameters:
1184bcf0153eSBarry Smith + ts  - the `TS` context obtained from `TSCreate()`
1185195e9b02SBarry Smith . r   - vector to hold the residual (or `NULL` to have it created internally)
1186316643e7SJed Brown . f   - the function evaluation routine
1187195e9b02SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be `NULL`)
1188316643e7SJed Brown 
1189316643e7SJed Brown   Level: beginner
1190316643e7SJed Brown 
1191bcf0153eSBarry Smith   Note:
1192bcf0153eSBarry Smith   The user MUST call either this routine or `TSSetRHSFunction()` to define the ODE.  When solving DAEs you must use this function.
1193bcf0153eSBarry Smith 
11948434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSIFunctionFn`, `TSSetRHSJacobian()`, `TSSetRHSFunction()`,
119514d0ab18SJacob Faibussowitsch `TSSetIJacobian()`
1196316643e7SJed Brown @*/
11978434afd1SBarry Smith PetscErrorCode TSSetIFunction(TS ts, Vec r, TSIFunctionFn *f, void *ctx)
1198d71ae5a4SJacob Faibussowitsch {
1199089b2837SJed Brown   SNES snes;
120051699248SLisandro Dalcin   Vec  ralloc = NULL;
120124989b8cSPeter Brune   DM   dm;
1202316643e7SJed Brown 
1203316643e7SJed Brown   PetscFunctionBegin;
12040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
120551699248SLisandro Dalcin   if (r) PetscValidHeaderSpecific(r, VEC_CLASSID, 2);
120624989b8cSPeter Brune 
12079566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
12089566063dSJacob Faibussowitsch   PetscCall(DMTSSetIFunction(dm, f, ctx));
120924989b8cSPeter Brune 
12109566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
121151699248SLisandro Dalcin   if (!r && !ts->dm && ts->vec_sol) {
12129566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ts->vec_sol, &ralloc));
121351699248SLisandro Dalcin     r = ralloc;
1214e856ceecSJed Brown   }
12159566063dSJacob Faibussowitsch   PetscCall(SNESSetFunction(snes, r, SNESTSFormFunction, ts));
12169566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ralloc));
12173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1218089b2837SJed Brown }
1219089b2837SJed Brown 
1220089b2837SJed Brown /*@C
1221a5b23f4aSJose E. Roman   TSGetIFunction - Returns the vector where the implicit residual is stored and the function/context to compute it.
1222089b2837SJed Brown 
1223089b2837SJed Brown   Not Collective
1224089b2837SJed Brown 
1225089b2837SJed Brown   Input Parameter:
1226bcf0153eSBarry Smith . ts - the `TS` context
1227089b2837SJed Brown 
1228d8d19677SJose E. Roman   Output Parameters:
1229195e9b02SBarry Smith + r    - vector to hold residual (or `NULL`)
1230195e9b02SBarry Smith . func - the function to compute residual (or `NULL`)
1231195e9b02SBarry Smith - ctx  - the function context (or `NULL`)
1232089b2837SJed Brown 
1233089b2837SJed Brown   Level: advanced
1234089b2837SJed Brown 
12351cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `SNESGetFunction()`
1236089b2837SJed Brown @*/
12378434afd1SBarry Smith PetscErrorCode TSGetIFunction(TS ts, Vec *r, TSIFunctionFn **func, void **ctx)
1238d71ae5a4SJacob Faibussowitsch {
1239089b2837SJed Brown   SNES snes;
124024989b8cSPeter Brune   DM   dm;
1241089b2837SJed Brown 
1242089b2837SJed Brown   PetscFunctionBegin;
1243089b2837SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
12449566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
12459566063dSJacob Faibussowitsch   PetscCall(SNESGetFunction(snes, r, NULL, NULL));
12469566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
12479566063dSJacob Faibussowitsch   PetscCall(DMTSGetIFunction(dm, func, ctx));
12483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1249089b2837SJed Brown }
1250089b2837SJed Brown 
1251089b2837SJed Brown /*@C
1252089b2837SJed Brown   TSGetRHSFunction - Returns the vector where the right hand side is stored and the function/context to compute it.
1253089b2837SJed Brown 
1254089b2837SJed Brown   Not Collective
1255089b2837SJed Brown 
1256089b2837SJed Brown   Input Parameter:
1257bcf0153eSBarry Smith . ts - the `TS` context
1258089b2837SJed Brown 
1259d8d19677SJose E. Roman   Output Parameters:
1260195e9b02SBarry Smith + r    - vector to hold computed right hand side (or `NULL`)
1261195e9b02SBarry Smith . func - the function to compute right hand side (or `NULL`)
1262195e9b02SBarry Smith - ctx  - the function context (or `NULL`)
1263089b2837SJed Brown 
1264089b2837SJed Brown   Level: advanced
1265089b2837SJed Brown 
12661cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `SNESGetFunction()`
1267089b2837SJed Brown @*/
12688434afd1SBarry Smith PetscErrorCode TSGetRHSFunction(TS ts, Vec *r, TSRHSFunctionFn **func, void **ctx)
1269d71ae5a4SJacob Faibussowitsch {
1270089b2837SJed Brown   SNES snes;
127124989b8cSPeter Brune   DM   dm;
1272089b2837SJed Brown 
1273089b2837SJed Brown   PetscFunctionBegin;
1274089b2837SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
12759566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
12769566063dSJacob Faibussowitsch   PetscCall(SNESGetFunction(snes, r, NULL, NULL));
12779566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
12789566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSFunction(dm, func, ctx));
12793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1280316643e7SJed Brown }
1281316643e7SJed Brown 
1282316643e7SJed Brown /*@C
1283a4f0a591SBarry Smith   TSSetIJacobian - Set the function to compute the matrix dF/dU + a*dF/dU_t where F(t,U,U_t) is the function
1284bcf0153eSBarry Smith   provided with `TSSetIFunction()`.
1285316643e7SJed Brown 
1286c3339decSBarry Smith   Logically Collective
1287316643e7SJed Brown 
1288316643e7SJed Brown   Input Parameters:
1289bcf0153eSBarry Smith + ts   - the `TS` context obtained from `TSCreate()`
1290aaa8cc7dSPierre Jolivet . Amat - (approximate) matrix to store Jacobian entries computed by `f`
1291195e9b02SBarry Smith . Pmat - matrix used to compute preconditioner (usually the same as `Amat`)
1292316643e7SJed Brown . f    - the Jacobian evaluation routine
1293195e9b02SBarry Smith - ctx  - user-defined context for private data for the Jacobian evaluation routine (may be `NULL`)
1294316643e7SJed Brown 
1295bcf0153eSBarry Smith   Level: beginner
1296316643e7SJed Brown 
1297bcf0153eSBarry Smith   Notes:
1298195e9b02SBarry Smith   The matrices `Amat` and `Pmat` are exactly the matrices that are used by `SNES` for the nonlinear solve.
1299bcf0153eSBarry Smith 
1300bcf0153eSBarry Smith   If you know the operator Amat has a null space you can use `MatSetNullSpace()` and `MatSetTransposeNullSpace()` to supply the null
1301195e9b02SBarry Smith   space to `Amat` and the `KSP` solvers will automatically use that null space as needed during the solution process.
1302895c21f2SBarry Smith 
1303a4f0a591SBarry Smith   The matrix dF/dU + a*dF/dU_t you provide turns out to be
1304b5abc632SBarry Smith   the Jacobian of F(t,U,W+a*U) where F(t,U,U_t) = 0 is the DAE to be solved.
1305a4f0a591SBarry Smith   The time integrator internally approximates U_t by W+a*U where the positive "shift"
1306a4f0a591SBarry Smith   a and vector W depend on the integration method, step size, and past states. For example with
1307a4f0a591SBarry Smith   the backward Euler method a = 1/dt and W = -a*U(previous timestep) so
1308a4f0a591SBarry Smith   W + a*U = a*(U - U(previous timestep)) = (U - U(previous timestep))/dt
1309a4f0a591SBarry Smith 
13106cd88445SBarry Smith   You must set all the diagonal entries of the matrices, if they are zero you must still set them with a zero value
13116cd88445SBarry Smith 
1312195e9b02SBarry Smith   The TS solver may modify the nonzero structure and the entries of the matrices `Amat` and `Pmat` between the calls to `f`
1313195e9b02SBarry Smith   You should not assume the values are the same in the next call to `f` as you set them in the previous call.
1314ca5f011dSBarry Smith 
13158434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSIJacobianFn`, `TSSetIFunction()`, `TSSetRHSJacobian()`,
131614d0ab18SJacob Faibussowitsch `SNESComputeJacobianDefaultColor()`, `SNESComputeJacobianDefault()`, `TSSetRHSFunction()`
1317316643e7SJed Brown @*/
13188434afd1SBarry Smith PetscErrorCode TSSetIJacobian(TS ts, Mat Amat, Mat Pmat, TSIJacobianFn *f, void *ctx)
1319d71ae5a4SJacob Faibussowitsch {
1320089b2837SJed Brown   SNES snes;
132124989b8cSPeter Brune   DM   dm;
1322316643e7SJed Brown 
1323316643e7SJed Brown   PetscFunctionBegin;
13240700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1325e5d3d808SBarry Smith   if (Amat) PetscValidHeaderSpecific(Amat, MAT_CLASSID, 2);
1326e5d3d808SBarry Smith   if (Pmat) PetscValidHeaderSpecific(Pmat, MAT_CLASSID, 3);
1327e5d3d808SBarry Smith   if (Amat) PetscCheckSameComm(ts, 1, Amat, 2);
1328e5d3d808SBarry Smith   if (Pmat) PetscCheckSameComm(ts, 1, Pmat, 3);
132924989b8cSPeter Brune 
13309566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
13319566063dSJacob Faibussowitsch   PetscCall(DMTSSetIJacobian(dm, f, ctx));
133224989b8cSPeter Brune 
13339566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
13349566063dSJacob Faibussowitsch   PetscCall(SNESSetJacobian(snes, Amat, Pmat, SNESTSFormJacobian, ts));
13353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1336316643e7SJed Brown }
1337316643e7SJed Brown 
1338e1244c69SJed Brown /*@
13398434afd1SBarry Smith   TSRHSJacobianSetReuse - restore the RHS Jacobian before calling the user-provided `TSRHSJacobianFn` function again
1340e1244c69SJed Brown 
1341e1244c69SJed Brown   Logically Collective
1342e1244c69SJed Brown 
13434165533cSJose E. Roman   Input Parameters:
1344bcf0153eSBarry Smith + ts    - `TS` context obtained from `TSCreate()`
1345bcf0153eSBarry Smith - reuse - `PETSC_TRUE` if the RHS Jacobian
1346e1244c69SJed Brown 
1347e1244c69SJed Brown   Level: intermediate
1348e1244c69SJed Brown 
134914d0ab18SJacob Faibussowitsch   Notes:
135014d0ab18SJacob Faibussowitsch   Without this flag, `TS` will change the sign and shift the RHS Jacobian for a
135114d0ab18SJacob Faibussowitsch   finite-time-step implicit solve, in which case the user function will need to recompute the
135214d0ab18SJacob Faibussowitsch   entire Jacobian.  The `reuse `flag must be set if the evaluation function assumes that the
135314d0ab18SJacob Faibussowitsch   matrix entries have not been changed by the `TS`.
135414d0ab18SJacob Faibussowitsch 
13551cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSJacobian()`, `TSComputeRHSJacobianConstant()`
1356e1244c69SJed Brown @*/
1357d71ae5a4SJacob Faibussowitsch PetscErrorCode TSRHSJacobianSetReuse(TS ts, PetscBool reuse)
1358d71ae5a4SJacob Faibussowitsch {
1359e1244c69SJed Brown   PetscFunctionBegin;
1360e1244c69SJed Brown   ts->rhsjacobian.reuse = reuse;
13613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1362e1244c69SJed Brown }
1363e1244c69SJed Brown 
1364efe9872eSLisandro Dalcin /*@C
1365efe9872eSLisandro Dalcin   TSSetI2Function - Set the function to compute F(t,U,U_t,U_tt) where F = 0 is the DAE to be solved.
1366efe9872eSLisandro Dalcin 
1367c3339decSBarry Smith   Logically Collective
1368efe9872eSLisandro Dalcin 
1369efe9872eSLisandro Dalcin   Input Parameters:
1370bcf0153eSBarry Smith + ts  - the `TS` context obtained from `TSCreate()`
1371195e9b02SBarry Smith . F   - vector to hold the residual (or `NULL` to have it created internally)
1372efe9872eSLisandro Dalcin . fun - the function evaluation routine
1373195e9b02SBarry Smith - ctx - user-defined context for private data for the function evaluation routine (may be `NULL`)
1374efe9872eSLisandro Dalcin 
1375efe9872eSLisandro Dalcin   Level: beginner
1376efe9872eSLisandro Dalcin 
13778434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSI2FunctionFn`, `TSSetI2Jacobian()`, `TSSetIFunction()`,
137814d0ab18SJacob Faibussowitsch `TSCreate()`, `TSSetRHSFunction()`
1379efe9872eSLisandro Dalcin @*/
13808434afd1SBarry Smith PetscErrorCode TSSetI2Function(TS ts, Vec F, TSI2FunctionFn *fun, void *ctx)
1381d71ae5a4SJacob Faibussowitsch {
1382efe9872eSLisandro Dalcin   DM dm;
1383efe9872eSLisandro Dalcin 
1384efe9872eSLisandro Dalcin   PetscFunctionBegin;
1385efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1386efe9872eSLisandro Dalcin   if (F) PetscValidHeaderSpecific(F, VEC_CLASSID, 2);
13879566063dSJacob Faibussowitsch   PetscCall(TSSetIFunction(ts, F, NULL, NULL));
13889566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
13899566063dSJacob Faibussowitsch   PetscCall(DMTSSetI2Function(dm, fun, ctx));
13903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1391efe9872eSLisandro Dalcin }
1392efe9872eSLisandro Dalcin 
1393efe9872eSLisandro Dalcin /*@C
1394a5b23f4aSJose E. Roman   TSGetI2Function - Returns the vector where the implicit residual is stored and the function/context to compute it.
1395efe9872eSLisandro Dalcin 
1396efe9872eSLisandro Dalcin   Not Collective
1397efe9872eSLisandro Dalcin 
1398efe9872eSLisandro Dalcin   Input Parameter:
1399bcf0153eSBarry Smith . ts - the `TS` context
1400efe9872eSLisandro Dalcin 
1401d8d19677SJose E. Roman   Output Parameters:
1402195e9b02SBarry Smith + r   - vector to hold residual (or `NULL`)
1403195e9b02SBarry Smith . fun - the function to compute residual (or `NULL`)
1404195e9b02SBarry Smith - ctx - the function context (or `NULL`)
1405efe9872eSLisandro Dalcin 
1406efe9872eSLisandro Dalcin   Level: advanced
1407efe9872eSLisandro Dalcin 
14081cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `SNESGetFunction()`, `TSCreate()`
1409efe9872eSLisandro Dalcin @*/
14108434afd1SBarry Smith PetscErrorCode TSGetI2Function(TS ts, Vec *r, TSI2FunctionFn **fun, void **ctx)
1411d71ae5a4SJacob Faibussowitsch {
1412efe9872eSLisandro Dalcin   SNES snes;
1413efe9872eSLisandro Dalcin   DM   dm;
1414efe9872eSLisandro Dalcin 
1415efe9872eSLisandro Dalcin   PetscFunctionBegin;
1416efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
14179566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
14189566063dSJacob Faibussowitsch   PetscCall(SNESGetFunction(snes, r, NULL, NULL));
14199566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
14209566063dSJacob Faibussowitsch   PetscCall(DMTSGetI2Function(dm, fun, ctx));
14213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1422efe9872eSLisandro Dalcin }
1423efe9872eSLisandro Dalcin 
1424efe9872eSLisandro Dalcin /*@C
1425bc77d74cSLisandro Dalcin   TSSetI2Jacobian - Set the function to compute the matrix dF/dU + v*dF/dU_t  + a*dF/dU_tt
1426bcf0153eSBarry Smith   where F(t,U,U_t,U_tt) is the function you provided with `TSSetI2Function()`.
1427efe9872eSLisandro Dalcin 
1428c3339decSBarry Smith   Logically Collective
1429efe9872eSLisandro Dalcin 
1430efe9872eSLisandro Dalcin   Input Parameters:
1431bcf0153eSBarry Smith + ts  - the `TS` context obtained from `TSCreate()`
1432195e9b02SBarry Smith . J   - matrix to hold the Jacobian values
1433195e9b02SBarry Smith . P   - matrix for constructing the preconditioner (may be same as `J`)
14348434afd1SBarry Smith . jac - the Jacobian evaluation routine, see `TSI2JacobianFn` for the calling sequence
1435195e9b02SBarry Smith - ctx - user-defined context for private data for the Jacobian evaluation routine (may be `NULL`)
1436efe9872eSLisandro Dalcin 
1437bcf0153eSBarry Smith   Level: beginner
1438bcf0153eSBarry Smith 
1439efe9872eSLisandro Dalcin   Notes:
1440195e9b02SBarry Smith   The matrices `J` and `P` are exactly the matrices that are used by `SNES` for the nonlinear solve.
1441efe9872eSLisandro Dalcin 
1442efe9872eSLisandro Dalcin   The matrix dF/dU + v*dF/dU_t + a*dF/dU_tt you provide turns out to be
1443efe9872eSLisandro Dalcin   the Jacobian of G(U) = F(t,U,W+v*U,W'+a*U) where F(t,U,U_t,U_tt) = 0 is the DAE to be solved.
1444efe9872eSLisandro Dalcin   The time integrator internally approximates U_t by W+v*U and U_tt by W'+a*U  where the positive "shift"
1445bc77d74cSLisandro Dalcin   parameters 'v' and 'a' and vectors W, W' depend on the integration method, step size, and past states.
1446efe9872eSLisandro Dalcin 
14478434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSI2JacobianFn`, `TSSetI2Function()`, `TSGetI2Jacobian()`
1448efe9872eSLisandro Dalcin @*/
14498434afd1SBarry Smith PetscErrorCode TSSetI2Jacobian(TS ts, Mat J, Mat P, TSI2JacobianFn *jac, void *ctx)
1450d71ae5a4SJacob Faibussowitsch {
1451efe9872eSLisandro Dalcin   DM dm;
1452efe9872eSLisandro Dalcin 
1453efe9872eSLisandro Dalcin   PetscFunctionBegin;
1454efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1455efe9872eSLisandro Dalcin   if (J) PetscValidHeaderSpecific(J, MAT_CLASSID, 2);
1456efe9872eSLisandro Dalcin   if (P) PetscValidHeaderSpecific(P, MAT_CLASSID, 3);
14579566063dSJacob Faibussowitsch   PetscCall(TSSetIJacobian(ts, J, P, NULL, NULL));
14589566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
14599566063dSJacob Faibussowitsch   PetscCall(DMTSSetI2Jacobian(dm, jac, ctx));
14603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1461efe9872eSLisandro Dalcin }
1462efe9872eSLisandro Dalcin 
1463efe9872eSLisandro Dalcin /*@C
1464efe9872eSLisandro Dalcin   TSGetI2Jacobian - Returns the implicit Jacobian at the present timestep.
1465efe9872eSLisandro Dalcin 
1466bcf0153eSBarry Smith   Not Collective, but parallel objects are returned if `TS` is parallel
1467efe9872eSLisandro Dalcin 
1468efe9872eSLisandro Dalcin   Input Parameter:
1469bcf0153eSBarry Smith . ts - The `TS` context obtained from `TSCreate()`
1470efe9872eSLisandro Dalcin 
1471efe9872eSLisandro Dalcin   Output Parameters:
1472efe9872eSLisandro Dalcin + J   - The (approximate) Jacobian of F(t,U,U_t,U_tt)
1473195e9b02SBarry Smith . P   - The matrix from which the preconditioner is constructed, often the same as `J`
1474efe9872eSLisandro Dalcin . jac - The function to compute the Jacobian matrices
1475efe9872eSLisandro Dalcin - ctx - User-defined context for Jacobian evaluation routine
1476efe9872eSLisandro Dalcin 
1477bcf0153eSBarry Smith   Level: advanced
1478bcf0153eSBarry Smith 
1479195e9b02SBarry Smith   Note:
1480195e9b02SBarry Smith   You can pass in `NULL` for any return argument you do not need.
1481efe9872eSLisandro Dalcin 
14821cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetMatrices()`, `TSGetTime()`, `TSGetStepNumber()`, `TSSetI2Jacobian()`, `TSGetI2Function()`, `TSCreate()`
1483efe9872eSLisandro Dalcin @*/
14848434afd1SBarry Smith PetscErrorCode TSGetI2Jacobian(TS ts, Mat *J, Mat *P, TSI2JacobianFn **jac, void **ctx)
1485d71ae5a4SJacob Faibussowitsch {
1486efe9872eSLisandro Dalcin   SNES snes;
1487efe9872eSLisandro Dalcin   DM   dm;
1488efe9872eSLisandro Dalcin 
1489efe9872eSLisandro Dalcin   PetscFunctionBegin;
14909566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
14919566063dSJacob Faibussowitsch   PetscCall(SNESSetUpMatrices(snes));
14929566063dSJacob Faibussowitsch   PetscCall(SNESGetJacobian(snes, J, P, NULL, NULL));
14939566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
14949566063dSJacob Faibussowitsch   PetscCall(DMTSGetI2Jacobian(dm, jac, ctx));
14953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1496efe9872eSLisandro Dalcin }
1497efe9872eSLisandro Dalcin 
1498efe9872eSLisandro Dalcin /*@
1499efe9872eSLisandro Dalcin   TSComputeI2Function - Evaluates the DAE residual written in implicit form F(t,U,U_t,U_tt) = 0
1500efe9872eSLisandro Dalcin 
1501c3339decSBarry Smith   Collective
1502efe9872eSLisandro Dalcin 
1503efe9872eSLisandro Dalcin   Input Parameters:
1504bcf0153eSBarry Smith + ts - the `TS` context
1505efe9872eSLisandro Dalcin . t  - current time
1506efe9872eSLisandro Dalcin . U  - state vector
1507efe9872eSLisandro Dalcin . V  - time derivative of state vector (U_t)
1508efe9872eSLisandro Dalcin - A  - second time derivative of state vector (U_tt)
1509efe9872eSLisandro Dalcin 
1510efe9872eSLisandro Dalcin   Output Parameter:
1511efe9872eSLisandro Dalcin . F - the residual vector
1512efe9872eSLisandro Dalcin 
1513bcf0153eSBarry Smith   Level: developer
1514bcf0153eSBarry Smith 
1515efe9872eSLisandro Dalcin   Note:
1516efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1517efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1518efe9872eSLisandro Dalcin 
15191cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetI2Function()`, `TSGetI2Function()`
1520efe9872eSLisandro Dalcin @*/
1521d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeI2Function(TS ts, PetscReal t, Vec U, Vec V, Vec A, Vec F)
1522d71ae5a4SJacob Faibussowitsch {
1523efe9872eSLisandro Dalcin   DM               dm;
15248434afd1SBarry Smith   TSI2FunctionFn  *I2Function;
1525efe9872eSLisandro Dalcin   void            *ctx;
15268434afd1SBarry Smith   TSRHSFunctionFn *rhsfunction;
1527efe9872eSLisandro Dalcin 
1528efe9872eSLisandro Dalcin   PetscFunctionBegin;
1529efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1530efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
1531efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V, VEC_CLASSID, 4);
1532efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A, VEC_CLASSID, 5);
1533efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(F, VEC_CLASSID, 6);
1534efe9872eSLisandro Dalcin 
15359566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
15369566063dSJacob Faibussowitsch   PetscCall(DMTSGetI2Function(dm, &I2Function, &ctx));
15379566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSFunction(dm, &rhsfunction, NULL));
1538efe9872eSLisandro Dalcin 
1539efe9872eSLisandro Dalcin   if (!I2Function) {
15409566063dSJacob Faibussowitsch     PetscCall(TSComputeIFunction(ts, t, U, A, F, PETSC_FALSE));
15413ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1542efe9872eSLisandro Dalcin   }
1543efe9872eSLisandro Dalcin 
1544da023ba9SStefano Zampini   PetscCall(PetscLogEventBegin(TS_FunctionEval, U, ts, V, F));
1545efe9872eSLisandro Dalcin 
1546792fecdfSBarry Smith   PetscCallBack("TS callback implicit function", I2Function(ts, t, U, V, A, F, ctx));
1547efe9872eSLisandro Dalcin 
1548efe9872eSLisandro Dalcin   if (rhsfunction) {
1549efe9872eSLisandro Dalcin     Vec Frhs;
15509566063dSJacob Faibussowitsch     PetscCall(TSGetRHSVec_Private(ts, &Frhs));
15519566063dSJacob Faibussowitsch     PetscCall(TSComputeRHSFunction(ts, t, U, Frhs));
15529566063dSJacob Faibussowitsch     PetscCall(VecAXPY(F, -1, Frhs));
1553efe9872eSLisandro Dalcin   }
1554efe9872eSLisandro Dalcin 
1555da023ba9SStefano Zampini   PetscCall(PetscLogEventEnd(TS_FunctionEval, U, ts, V, F));
15563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1557efe9872eSLisandro Dalcin }
1558efe9872eSLisandro Dalcin 
1559efe9872eSLisandro Dalcin /*@
1560efe9872eSLisandro Dalcin   TSComputeI2Jacobian - Evaluates the Jacobian of the DAE
1561efe9872eSLisandro Dalcin 
1562c3339decSBarry Smith   Collective
1563efe9872eSLisandro Dalcin 
1564efe9872eSLisandro Dalcin   Input Parameters:
1565bcf0153eSBarry Smith + ts     - the `TS` context
1566efe9872eSLisandro Dalcin . t      - current timestep
1567efe9872eSLisandro Dalcin . U      - state vector
1568efe9872eSLisandro Dalcin . V      - time derivative of state vector
1569efe9872eSLisandro Dalcin . A      - second time derivative of state vector
1570efe9872eSLisandro Dalcin . shiftV - shift to apply, see note below
1571efe9872eSLisandro Dalcin - shiftA - shift to apply, see note below
1572efe9872eSLisandro Dalcin 
1573efe9872eSLisandro Dalcin   Output Parameters:
1574efe9872eSLisandro Dalcin + J - Jacobian matrix
1575efe9872eSLisandro Dalcin - P - optional preconditioning matrix
1576efe9872eSLisandro Dalcin 
1577bcf0153eSBarry Smith   Level: developer
1578bcf0153eSBarry Smith 
1579efe9872eSLisandro Dalcin   Notes:
1580efe9872eSLisandro Dalcin   If F(t,U,V,A)=0 is the DAE, the required Jacobian is
1581efe9872eSLisandro Dalcin 
1582efe9872eSLisandro Dalcin   dF/dU + shiftV*dF/dV + shiftA*dF/dA
1583efe9872eSLisandro Dalcin 
1584efe9872eSLisandro Dalcin   Most users should not need to explicitly call this routine, as it
1585efe9872eSLisandro Dalcin   is used internally within the nonlinear solvers.
1586efe9872eSLisandro Dalcin 
15871cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetI2Jacobian()`
1588efe9872eSLisandro Dalcin @*/
1589d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeI2Jacobian(TS ts, PetscReal t, Vec U, Vec V, Vec A, PetscReal shiftV, PetscReal shiftA, Mat J, Mat P)
1590d71ae5a4SJacob Faibussowitsch {
1591efe9872eSLisandro Dalcin   DM               dm;
15928434afd1SBarry Smith   TSI2JacobianFn  *I2Jacobian;
1593efe9872eSLisandro Dalcin   void            *ctx;
15948434afd1SBarry Smith   TSRHSJacobianFn *rhsjacobian;
1595efe9872eSLisandro Dalcin 
1596efe9872eSLisandro Dalcin   PetscFunctionBegin;
1597efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1598efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
1599efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(V, VEC_CLASSID, 4);
1600efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(A, VEC_CLASSID, 5);
1601efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(J, MAT_CLASSID, 8);
1602efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(P, MAT_CLASSID, 9);
1603efe9872eSLisandro Dalcin 
16049566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
16059566063dSJacob Faibussowitsch   PetscCall(DMTSGetI2Jacobian(dm, &I2Jacobian, &ctx));
16069566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSJacobian(dm, &rhsjacobian, NULL));
1607efe9872eSLisandro Dalcin 
1608efe9872eSLisandro Dalcin   if (!I2Jacobian) {
16099566063dSJacob Faibussowitsch     PetscCall(TSComputeIJacobian(ts, t, U, A, shiftA, J, P, PETSC_FALSE));
16103ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1611efe9872eSLisandro Dalcin   }
1612efe9872eSLisandro Dalcin 
1613da023ba9SStefano Zampini   PetscCall(PetscLogEventBegin(TS_JacobianEval, U, ts, J, P));
1614792fecdfSBarry Smith   PetscCallBack("TS callback implicit Jacobian", I2Jacobian(ts, t, U, V, A, shiftV, shiftA, J, P, ctx));
1615efe9872eSLisandro Dalcin   if (rhsjacobian) {
1616d60b7d5cSBarry Smith     Mat Jrhs, Prhs;
16179566063dSJacob Faibussowitsch     PetscCall(TSGetRHSMats_Private(ts, &Jrhs, &Prhs));
16189566063dSJacob Faibussowitsch     PetscCall(TSComputeRHSJacobian(ts, t, U, Jrhs, Prhs));
16199566063dSJacob Faibussowitsch     PetscCall(MatAXPY(J, -1, Jrhs, ts->axpy_pattern));
16209566063dSJacob Faibussowitsch     if (P != J) PetscCall(MatAXPY(P, -1, Prhs, ts->axpy_pattern));
1621efe9872eSLisandro Dalcin   }
1622efe9872eSLisandro Dalcin 
1623da023ba9SStefano Zampini   PetscCall(PetscLogEventEnd(TS_JacobianEval, U, ts, J, P));
16243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1625efe9872eSLisandro Dalcin }
1626efe9872eSLisandro Dalcin 
1627438f35afSJed Brown /*@C
1628438f35afSJed Brown   TSSetTransientVariable - sets function to transform from state to transient variables
1629438f35afSJed Brown 
1630438f35afSJed Brown   Logically Collective
1631438f35afSJed Brown 
16324165533cSJose E. Roman   Input Parameters:
1633438f35afSJed Brown + ts   - time stepping context on which to change the transient variable
16348434afd1SBarry Smith . tvar - a function that transforms to transient variables, see `TSTransientVariableFn` for the calling sequence
1635438f35afSJed Brown - ctx  - a context for tvar
1636438f35afSJed Brown 
1637438f35afSJed Brown   Level: advanced
1638438f35afSJed Brown 
1639438f35afSJed Brown   Notes:
1640bcf0153eSBarry Smith   This is typically used to transform from primitive to conservative variables so that a time integrator (e.g., `TSBDF`)
1641438f35afSJed Brown   can be conservative.  In this context, primitive variables P are used to model the state (e.g., because they lead to
1642438f35afSJed Brown   well-conditioned formulations even in limiting cases such as low-Mach or zero porosity).  The transient variable is
1643438f35afSJed Brown   C(P), specified by calling this function.  An IFunction thus receives arguments (P, Cdot) and the IJacobian must be
1644438f35afSJed Brown   evaluated via the chain rule, as in
1645195e9b02SBarry Smith .vb
1646438f35afSJed Brown      dF/dP + shift * dF/dCdot dC/dP.
1647195e9b02SBarry Smith .ve
1648438f35afSJed Brown 
16498434afd1SBarry Smith .seealso: [](ch_ts), `TS`, `TSBDF`, `TSTransientVariableFn`, `DMTSSetTransientVariable()`, `DMTSGetTransientVariable()`, `TSSetIFunction()`, `TSSetIJacobian()`
1650438f35afSJed Brown @*/
16518434afd1SBarry Smith PetscErrorCode TSSetTransientVariable(TS ts, TSTransientVariableFn *tvar, void *ctx)
1652d71ae5a4SJacob Faibussowitsch {
1653438f35afSJed Brown   DM dm;
1654438f35afSJed Brown 
1655438f35afSJed Brown   PetscFunctionBegin;
1656438f35afSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
16579566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
16589566063dSJacob Faibussowitsch   PetscCall(DMTSSetTransientVariable(dm, tvar, ctx));
16593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1660438f35afSJed Brown }
1661438f35afSJed Brown 
1662efe9872eSLisandro Dalcin /*@
1663e3c11fc1SJed Brown   TSComputeTransientVariable - transforms state (primitive) variables to transient (conservative) variables
1664e3c11fc1SJed Brown 
1665e3c11fc1SJed Brown   Logically Collective
1666e3c11fc1SJed Brown 
1667e3c11fc1SJed Brown   Input Parameters:
1668e3c11fc1SJed Brown + ts - TS on which to compute
1669e3c11fc1SJed Brown - U  - state vector to be transformed to transient variables
1670e3c11fc1SJed Brown 
16712fe279fdSBarry Smith   Output Parameter:
1672e3c11fc1SJed Brown . C - transient (conservative) variable
1673e3c11fc1SJed Brown 
1674e3c11fc1SJed Brown   Level: developer
1675e3c11fc1SJed Brown 
1676b43aa488SJacob Faibussowitsch   Developer Notes:
1677195e9b02SBarry Smith   If `DMTSSetTransientVariable()` has not been called, then C is not modified in this routine and C = `NULL` is allowed.
1678bcf0153eSBarry Smith   This makes it safe to call without a guard.  One can use `TSHasTransientVariable()` to check if transient variables are
1679bcf0153eSBarry Smith   being used.
1680bcf0153eSBarry Smith 
16811cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSBDF`, `DMTSSetTransientVariable()`, `TSComputeIFunction()`, `TSComputeIJacobian()`
1682e3c11fc1SJed Brown @*/
1683d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeTransientVariable(TS ts, Vec U, Vec C)
1684d71ae5a4SJacob Faibussowitsch {
1685e3c11fc1SJed Brown   DM   dm;
1686e3c11fc1SJed Brown   DMTS dmts;
1687e3c11fc1SJed Brown 
1688e3c11fc1SJed Brown   PetscFunctionBegin;
1689e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1690e3c11fc1SJed Brown   PetscValidHeaderSpecific(U, VEC_CLASSID, 2);
16919566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
16929566063dSJacob Faibussowitsch   PetscCall(DMGetDMTS(dm, &dmts));
1693e3c11fc1SJed Brown   if (dmts->ops->transientvar) {
1694e3c11fc1SJed Brown     PetscValidHeaderSpecific(C, VEC_CLASSID, 3);
16959566063dSJacob Faibussowitsch     PetscCall((*dmts->ops->transientvar)(ts, U, C, dmts->transientvarctx));
1696e3c11fc1SJed Brown   }
16973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1698e3c11fc1SJed Brown }
1699e3c11fc1SJed Brown 
1700e3c11fc1SJed Brown /*@
1701e3c11fc1SJed Brown   TSHasTransientVariable - determine whether transient variables have been set
1702e3c11fc1SJed Brown 
1703e3c11fc1SJed Brown   Logically Collective
1704e3c11fc1SJed Brown 
17052fe279fdSBarry Smith   Input Parameter:
1706195e9b02SBarry Smith . ts - `TS` on which to compute
1707e3c11fc1SJed Brown 
17082fe279fdSBarry Smith   Output Parameter:
1709bcf0153eSBarry Smith . has - `PETSC_TRUE` if transient variables have been set
1710e3c11fc1SJed Brown 
1711e3c11fc1SJed Brown   Level: developer
1712e3c11fc1SJed Brown 
17131cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSBDF`, `DMTSSetTransientVariable()`, `TSComputeTransientVariable()`
1714e3c11fc1SJed Brown @*/
1715d71ae5a4SJacob Faibussowitsch PetscErrorCode TSHasTransientVariable(TS ts, PetscBool *has)
1716d71ae5a4SJacob Faibussowitsch {
1717e3c11fc1SJed Brown   DM   dm;
1718e3c11fc1SJed Brown   DMTS dmts;
1719e3c11fc1SJed Brown 
1720e3c11fc1SJed Brown   PetscFunctionBegin;
1721e3c11fc1SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
17229566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
17239566063dSJacob Faibussowitsch   PetscCall(DMGetDMTS(dm, &dmts));
1724e3c11fc1SJed Brown   *has = dmts->ops->transientvar ? PETSC_TRUE : PETSC_FALSE;
17253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1726e3c11fc1SJed Brown }
1727e3c11fc1SJed Brown 
1728e3c11fc1SJed Brown /*@
1729efe9872eSLisandro Dalcin   TS2SetSolution - Sets the initial solution and time derivative vectors
1730bcf0153eSBarry Smith   for use by the `TS` routines handling second order equations.
1731efe9872eSLisandro Dalcin 
1732c3339decSBarry Smith   Logically Collective
1733efe9872eSLisandro Dalcin 
1734efe9872eSLisandro Dalcin   Input Parameters:
1735bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()`
1736efe9872eSLisandro Dalcin . u  - the solution vector
1737efe9872eSLisandro Dalcin - v  - the time derivative vector
1738efe9872eSLisandro Dalcin 
1739efe9872eSLisandro Dalcin   Level: beginner
1740efe9872eSLisandro Dalcin 
17411cc06b55SBarry Smith .seealso: [](ch_ts), `TS`
1742efe9872eSLisandro Dalcin @*/
1743d71ae5a4SJacob Faibussowitsch PetscErrorCode TS2SetSolution(TS ts, Vec u, Vec v)
1744d71ae5a4SJacob Faibussowitsch {
1745efe9872eSLisandro Dalcin   PetscFunctionBegin;
1746efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1747efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
1748efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(v, VEC_CLASSID, 3);
17499566063dSJacob Faibussowitsch   PetscCall(TSSetSolution(ts, u));
17509566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)v));
17519566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->vec_dot));
1752efe9872eSLisandro Dalcin   ts->vec_dot = v;
17533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1754efe9872eSLisandro Dalcin }
1755efe9872eSLisandro Dalcin 
1756efe9872eSLisandro Dalcin /*@
1757efe9872eSLisandro Dalcin   TS2GetSolution - Returns the solution and time derivative at the present timestep
175814d0ab18SJacob Faibussowitsch   for second order equations.
1759efe9872eSLisandro Dalcin 
176014d0ab18SJacob Faibussowitsch   Not Collective
1761efe9872eSLisandro Dalcin 
1762efe9872eSLisandro Dalcin   Input Parameter:
1763bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
1764efe9872eSLisandro Dalcin 
1765d8d19677SJose E. Roman   Output Parameters:
1766efe9872eSLisandro Dalcin + u - the vector containing the solution
1767efe9872eSLisandro Dalcin - v - the vector containing the time derivative
1768efe9872eSLisandro Dalcin 
1769efe9872eSLisandro Dalcin   Level: intermediate
1770efe9872eSLisandro Dalcin 
177114d0ab18SJacob Faibussowitsch   Notes:
177214d0ab18SJacob Faibussowitsch   It is valid to call this routine inside the function
177314d0ab18SJacob Faibussowitsch   that you are evaluating in order to move to the new timestep. This vector not
177414d0ab18SJacob Faibussowitsch   changed until the solution at the next timestep has been calculated.
177514d0ab18SJacob Faibussowitsch 
17761cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TS2SetSolution()`, `TSGetTimeStep()`, `TSGetTime()`
1777efe9872eSLisandro Dalcin @*/
1778d71ae5a4SJacob Faibussowitsch PetscErrorCode TS2GetSolution(TS ts, Vec *u, Vec *v)
1779d71ae5a4SJacob Faibussowitsch {
1780efe9872eSLisandro Dalcin   PetscFunctionBegin;
1781efe9872eSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
17824f572ea9SToby Isaac   if (u) PetscAssertPointer(u, 2);
17834f572ea9SToby Isaac   if (v) PetscAssertPointer(v, 3);
1784efe9872eSLisandro Dalcin   if (u) *u = ts->vec_sol;
1785efe9872eSLisandro Dalcin   if (v) *v = ts->vec_dot;
17863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1787efe9872eSLisandro Dalcin }
1788efe9872eSLisandro Dalcin 
178955849f57SBarry Smith /*@C
1790bcf0153eSBarry Smith   TSLoad - Loads a `TS` that has been stored in binary  with `TSView()`.
179155849f57SBarry Smith 
1792c3339decSBarry Smith   Collective
179355849f57SBarry Smith 
179455849f57SBarry Smith   Input Parameters:
1795b43aa488SJacob Faibussowitsch + ts     - the newly loaded `TS`, this needs to have been created with `TSCreate()` or
1796bcf0153eSBarry Smith            some related function before a call to `TSLoad()`.
1797bcf0153eSBarry Smith - viewer - binary file viewer, obtained from `PetscViewerBinaryOpen()`
179855849f57SBarry Smith 
179955849f57SBarry Smith   Level: intermediate
180055849f57SBarry Smith 
1801bcf0153eSBarry Smith   Note:
1802bcf0153eSBarry Smith   The type is determined by the data in the file, any type set into the `TS` before this call is ignored.
180355849f57SBarry Smith 
18041cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `PetscViewer`, `PetscViewerBinaryOpen()`, `TSView()`, `MatLoad()`, `VecLoad()`
180555849f57SBarry Smith @*/
1806d71ae5a4SJacob Faibussowitsch PetscErrorCode TSLoad(TS ts, PetscViewer viewer)
1807d71ae5a4SJacob Faibussowitsch {
180855849f57SBarry Smith   PetscBool isbinary;
180955849f57SBarry Smith   PetscInt  classid;
181055849f57SBarry Smith   char      type[256];
18112d53ad75SBarry Smith   DMTS      sdm;
1812ad6bc421SBarry Smith   DM        dm;
181355849f57SBarry Smith 
181455849f57SBarry Smith   PetscFunctionBegin;
1815f2c2a1b9SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
181655849f57SBarry Smith   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
18179566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary));
18183c633725SBarry Smith   PetscCheck(isbinary, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Invalid viewer; open viewer with PetscViewerBinaryOpen()");
181955849f57SBarry Smith 
18209566063dSJacob Faibussowitsch   PetscCall(PetscViewerBinaryRead(viewer, &classid, 1, NULL, PETSC_INT));
18213c633725SBarry Smith   PetscCheck(classid == TS_FILE_CLASSID, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Not TS next in file");
18229566063dSJacob Faibussowitsch   PetscCall(PetscViewerBinaryRead(viewer, type, 256, NULL, PETSC_CHAR));
18239566063dSJacob Faibussowitsch   PetscCall(TSSetType(ts, type));
1824dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, load, viewer);
18259566063dSJacob Faibussowitsch   PetscCall(DMCreate(PetscObjectComm((PetscObject)ts), &dm));
18269566063dSJacob Faibussowitsch   PetscCall(DMLoad(dm, viewer));
18279566063dSJacob Faibussowitsch   PetscCall(TSSetDM(ts, dm));
18289566063dSJacob Faibussowitsch   PetscCall(DMCreateGlobalVector(ts->dm, &ts->vec_sol));
18299566063dSJacob Faibussowitsch   PetscCall(VecLoad(ts->vec_sol, viewer));
18309566063dSJacob Faibussowitsch   PetscCall(DMGetDMTS(ts->dm, &sdm));
18319566063dSJacob Faibussowitsch   PetscCall(DMTSLoad(sdm, viewer));
18323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
183355849f57SBarry Smith }
183455849f57SBarry Smith 
18359804daf3SBarry Smith #include <petscdraw.h>
1836e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1837e04113cfSBarry Smith   #include <petscviewersaws.h>
1838f05ece33SBarry Smith #endif
1839fe2efc57SMark 
1840fe2efc57SMark /*@C
1841bcf0153eSBarry Smith   TSViewFromOptions - View a `TS` based on values in the options database
1842fe2efc57SMark 
1843c3339decSBarry Smith   Collective
1844fe2efc57SMark 
1845fe2efc57SMark   Input Parameters:
1846bcf0153eSBarry Smith + ts   - the `TS` context
1847bcf0153eSBarry Smith . obj  - Optional object that provides the prefix for the options database keys
1848bcf0153eSBarry Smith - name - command line option string to be passed by user
1849fe2efc57SMark 
1850fe2efc57SMark   Level: intermediate
1851bcf0153eSBarry Smith 
18521cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSView`, `PetscObjectViewFromOptions()`, `TSCreate()`
1853fe2efc57SMark @*/
1854bcf0153eSBarry Smith PetscErrorCode TSViewFromOptions(TS ts, PetscObject obj, const char name[])
1855d71ae5a4SJacob Faibussowitsch {
1856fe2efc57SMark   PetscFunctionBegin;
1857bcf0153eSBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
1858bcf0153eSBarry Smith   PetscCall(PetscObjectViewFromOptions((PetscObject)ts, obj, name));
18593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1860fe2efc57SMark }
1861fe2efc57SMark 
18627e2c5f70SBarry Smith /*@C
1863bcf0153eSBarry Smith   TSView - Prints the `TS` data structure.
1864d763cef2SBarry Smith 
1865c3339decSBarry Smith   Collective
1866d763cef2SBarry Smith 
1867d763cef2SBarry Smith   Input Parameters:
1868bcf0153eSBarry Smith + ts     - the `TS` context obtained from `TSCreate()`
1869d763cef2SBarry Smith - viewer - visualization context
1870d763cef2SBarry Smith 
1871d763cef2SBarry Smith   Options Database Key:
1872bcf0153eSBarry Smith . -ts_view - calls `TSView()` at end of `TSStep()`
1873bcf0153eSBarry Smith 
1874bcf0153eSBarry Smith   Level: beginner
1875d763cef2SBarry Smith 
1876d763cef2SBarry Smith   Notes:
1877d763cef2SBarry Smith   The available visualization contexts include
1878bcf0153eSBarry Smith +     `PETSC_VIEWER_STDOUT_SELF` - standard output (default)
1879bcf0153eSBarry Smith -     `PETSC_VIEWER_STDOUT_WORLD` - synchronized standard
1880d763cef2SBarry Smith   output where only the first processor opens
1881d763cef2SBarry Smith   the file.  All other processors send their
1882d763cef2SBarry Smith   data to the first processor to print.
1883d763cef2SBarry Smith 
1884d763cef2SBarry Smith   The user can open an alternative visualization context with
1885bcf0153eSBarry Smith   `PetscViewerASCIIOpen()` - output to a specified file.
1886d763cef2SBarry Smith 
1887bcf0153eSBarry Smith   In the debugger you can do call `TSView`(ts,0) to display the `TS` solver. (The same holds for any PETSc object viewer).
1888595c91d4SBarry Smith 
18891cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `PetscViewer`, `PetscViewerASCIIOpen()`
1890d763cef2SBarry Smith @*/
1891d71ae5a4SJacob Faibussowitsch PetscErrorCode TSView(TS ts, PetscViewer viewer)
1892d71ae5a4SJacob Faibussowitsch {
189319fd82e9SBarry Smith   TSType    type;
18942b0a91c0SBarry Smith   PetscBool iascii, isstring, isundials, isbinary, isdraw;
18952d53ad75SBarry Smith   DMTS      sdm;
1896e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1897536b137fSBarry Smith   PetscBool issaws;
1898f05ece33SBarry Smith #endif
1899d763cef2SBarry Smith 
1900d763cef2SBarry Smith   PetscFunctionBegin;
19010700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
19021e66621cSBarry Smith   if (!viewer) PetscCall(PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)ts), &viewer));
19030700a824SBarry Smith   PetscValidHeaderSpecific(viewer, PETSC_VIEWER_CLASSID, 2);
1904c9780b6fSBarry Smith   PetscCheckSameComm(ts, 1, viewer, 2);
1905fd16b177SBarry Smith 
19069566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
19079566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERSTRING, &isstring));
19089566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY, &isbinary));
19099566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERDRAW, &isdraw));
1910e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
19119566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERSAWS, &issaws));
1912f05ece33SBarry Smith #endif
191332077d6dSBarry Smith   if (iascii) {
19149566063dSJacob Faibussowitsch     PetscCall(PetscObjectPrintClassNamePrefixType((PetscObject)ts, viewer));
1915efd4aadfSBarry Smith     if (ts->ops->view) {
19169566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushTab(viewer));
1917dbbe0bcdSBarry Smith       PetscUseTypeMethod(ts, view, viewer);
19189566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopTab(viewer));
1919efd4aadfSBarry Smith     }
19201e66621cSBarry Smith     if (ts->max_steps < PETSC_MAX_INT) PetscCall(PetscViewerASCIIPrintf(viewer, "  maximum steps=%" PetscInt_FMT "\n", ts->max_steps));
19211e66621cSBarry Smith     if (ts->max_time < PETSC_MAX_REAL) PetscCall(PetscViewerASCIIPrintf(viewer, "  maximum time=%g\n", (double)ts->max_time));
19221e66621cSBarry Smith     if (ts->ifuncs) PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of I function evaluations=%" PetscInt_FMT "\n", ts->ifuncs));
19231e66621cSBarry Smith     if (ts->ijacs) PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of I Jacobian evaluations=%" PetscInt_FMT "\n", ts->ijacs));
19241e66621cSBarry Smith     if (ts->rhsfuncs) PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of RHS function evaluations=%" PetscInt_FMT "\n", ts->rhsfuncs));
19251e66621cSBarry Smith     if (ts->rhsjacs) PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of RHS Jacobian evaluations=%" PetscInt_FMT "\n", ts->rhsjacs));
1926efd4aadfSBarry Smith     if (ts->usessnes) {
1927efd4aadfSBarry Smith       PetscBool lin;
19281e66621cSBarry Smith       if (ts->problem_type == TS_NONLINEAR) PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of nonlinear solver iterations=%" PetscInt_FMT "\n", ts->snes_its));
192963a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of linear solver iterations=%" PetscInt_FMT "\n", ts->ksp_its));
19309566063dSJacob Faibussowitsch       PetscCall(PetscObjectTypeCompareAny((PetscObject)ts->snes, &lin, SNESKSPONLY, SNESKSPTRANSPOSEONLY, ""));
193163a3b9bcSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of %slinear solve failures=%" PetscInt_FMT "\n", lin ? "" : "non", ts->num_snes_failures));
1932efd4aadfSBarry Smith     }
193363a3b9bcSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPrintf(viewer, "  total number of rejected steps=%" PetscInt_FMT "\n", ts->reject));
19341e66621cSBarry Smith     if (ts->vrtol) PetscCall(PetscViewerASCIIPrintf(viewer, "  using vector of relative error tolerances, "));
19351e66621cSBarry Smith     else PetscCall(PetscViewerASCIIPrintf(viewer, "  using relative error tolerance of %g, ", (double)ts->rtol));
19361e66621cSBarry Smith     if (ts->vatol) PetscCall(PetscViewerASCIIPrintf(viewer, "  using vector of absolute error tolerances\n"));
19371e66621cSBarry Smith     else PetscCall(PetscViewerASCIIPrintf(viewer, "  using absolute error tolerance of %g\n", (double)ts->atol));
19389566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
19399566063dSJacob Faibussowitsch     PetscCall(TSAdaptView(ts->adapt, viewer));
19409566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
19410f5bd95cSBarry Smith   } else if (isstring) {
19429566063dSJacob Faibussowitsch     PetscCall(TSGetType(ts, &type));
19439566063dSJacob Faibussowitsch     PetscCall(PetscViewerStringSPrintf(viewer, " TSType: %-7.7s", type));
1944dbbe0bcdSBarry Smith     PetscTryTypeMethod(ts, view, viewer);
194555849f57SBarry Smith   } else if (isbinary) {
194655849f57SBarry Smith     PetscInt    classid = TS_FILE_CLASSID;
194755849f57SBarry Smith     MPI_Comm    comm;
194855849f57SBarry Smith     PetscMPIInt rank;
194955849f57SBarry Smith     char        type[256];
195055849f57SBarry Smith 
19519566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetComm((PetscObject)ts, &comm));
19529566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_rank(comm, &rank));
1953dd400576SPatrick Sanan     if (rank == 0) {
19549566063dSJacob Faibussowitsch       PetscCall(PetscViewerBinaryWrite(viewer, &classid, 1, PETSC_INT));
19559566063dSJacob Faibussowitsch       PetscCall(PetscStrncpy(type, ((PetscObject)ts)->type_name, 256));
19569566063dSJacob Faibussowitsch       PetscCall(PetscViewerBinaryWrite(viewer, type, 256, PETSC_CHAR));
195755849f57SBarry Smith     }
1958dbbe0bcdSBarry Smith     PetscTryTypeMethod(ts, view, viewer);
19599566063dSJacob Faibussowitsch     if (ts->adapt) PetscCall(TSAdaptView(ts->adapt, viewer));
19609566063dSJacob Faibussowitsch     PetscCall(DMView(ts->dm, viewer));
19619566063dSJacob Faibussowitsch     PetscCall(VecView(ts->vec_sol, viewer));
19629566063dSJacob Faibussowitsch     PetscCall(DMGetDMTS(ts->dm, &sdm));
19639566063dSJacob Faibussowitsch     PetscCall(DMTSView(sdm, viewer));
19642b0a91c0SBarry Smith   } else if (isdraw) {
19652b0a91c0SBarry Smith     PetscDraw draw;
19662b0a91c0SBarry Smith     char      str[36];
196789fd9fafSBarry Smith     PetscReal x, y, bottom, h;
19682b0a91c0SBarry Smith 
19699566063dSJacob Faibussowitsch     PetscCall(PetscViewerDrawGetDraw(viewer, 0, &draw));
19709566063dSJacob Faibussowitsch     PetscCall(PetscDrawGetCurrentPoint(draw, &x, &y));
1971c6a7a370SJeremy L Thompson     PetscCall(PetscStrncpy(str, "TS: ", sizeof(str)));
1972c6a7a370SJeremy L Thompson     PetscCall(PetscStrlcat(str, ((PetscObject)ts)->type_name, sizeof(str)));
19739566063dSJacob Faibussowitsch     PetscCall(PetscDrawStringBoxed(draw, x, y, PETSC_DRAW_BLACK, PETSC_DRAW_BLACK, str, NULL, &h));
197489fd9fafSBarry Smith     bottom = y - h;
19759566063dSJacob Faibussowitsch     PetscCall(PetscDrawPushCurrentPoint(draw, x, bottom));
1976dbbe0bcdSBarry Smith     PetscTryTypeMethod(ts, view, viewer);
19779566063dSJacob Faibussowitsch     if (ts->adapt) PetscCall(TSAdaptView(ts->adapt, viewer));
19789566063dSJacob Faibussowitsch     if (ts->snes) PetscCall(SNESView(ts->snes, viewer));
19799566063dSJacob Faibussowitsch     PetscCall(PetscDrawPopCurrentPoint(draw));
1980e04113cfSBarry Smith #if defined(PETSC_HAVE_SAWS)
1981536b137fSBarry Smith   } else if (issaws) {
1982d45a07a7SBarry Smith     PetscMPIInt rank;
19832657e9d9SBarry Smith     const char *name;
19842657e9d9SBarry Smith 
19859566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetName((PetscObject)ts, &name));
19869566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Comm_rank(PETSC_COMM_WORLD, &rank));
1987dd400576SPatrick Sanan     if (!((PetscObject)ts)->amsmem && rank == 0) {
1988d45a07a7SBarry Smith       char dir[1024];
1989d45a07a7SBarry Smith 
19909566063dSJacob Faibussowitsch       PetscCall(PetscObjectViewSAWs((PetscObject)ts, viewer));
19919566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(dir, 1024, "/PETSc/Objects/%s/time_step", name));
1992792fecdfSBarry Smith       PetscCallSAWs(SAWs_Register, (dir, &ts->steps, 1, SAWs_READ, SAWs_INT));
19939566063dSJacob Faibussowitsch       PetscCall(PetscSNPrintf(dir, 1024, "/PETSc/Objects/%s/time", name));
1994792fecdfSBarry Smith       PetscCallSAWs(SAWs_Register, (dir, &ts->ptime, 1, SAWs_READ, SAWs_DOUBLE));
1995d763cef2SBarry Smith     }
1996dbbe0bcdSBarry Smith     PetscTryTypeMethod(ts, view, viewer);
1997f05ece33SBarry Smith #endif
1998f05ece33SBarry Smith   }
199936a9e3b9SBarry Smith   if (ts->snes && ts->usessnes) {
20009566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPushTab(viewer));
20019566063dSJacob Faibussowitsch     PetscCall(SNESView(ts->snes, viewer));
20029566063dSJacob Faibussowitsch     PetscCall(PetscViewerASCIIPopTab(viewer));
200336a9e3b9SBarry Smith   }
20049566063dSJacob Faibussowitsch   PetscCall(DMGetDMTS(ts->dm, &sdm));
20059566063dSJacob Faibussowitsch   PetscCall(DMTSView(sdm, viewer));
2006f05ece33SBarry Smith 
20079566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPushTab(viewer));
20089566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)ts, TSSUNDIALS, &isundials));
20099566063dSJacob Faibussowitsch   PetscCall(PetscViewerASCIIPopTab(viewer));
20103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2011d763cef2SBarry Smith }
2012d763cef2SBarry Smith 
2013b07ff414SBarry Smith /*@
2014d763cef2SBarry Smith   TSSetApplicationContext - Sets an optional user-defined context for
2015d763cef2SBarry Smith   the timesteppers.
2016d763cef2SBarry Smith 
2017c3339decSBarry Smith   Logically Collective
2018d763cef2SBarry Smith 
2019d763cef2SBarry Smith   Input Parameters:
2020bcf0153eSBarry Smith + ts   - the `TS` context obtained from `TSCreate()`
2021bcf0153eSBarry Smith - usrP - user context
2022daf670e6SBarry Smith 
2023d763cef2SBarry Smith   Level: intermediate
2024d763cef2SBarry Smith 
2025b43aa488SJacob Faibussowitsch   Fortran Notes:
2026195e9b02SBarry Smith   You must write a Fortran interface definition for this
2027195e9b02SBarry Smith   function that tells Fortran the Fortran derived data type that you are passing in as the `ctx` argument.
2028bcf0153eSBarry Smith 
20291cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetApplicationContext()`
2030d763cef2SBarry Smith @*/
2031d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetApplicationContext(TS ts, void *usrP)
2032d71ae5a4SJacob Faibussowitsch {
2033d763cef2SBarry Smith   PetscFunctionBegin;
20340700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2035d763cef2SBarry Smith   ts->user = usrP;
20363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2037d763cef2SBarry Smith }
2038d763cef2SBarry Smith 
2039b07ff414SBarry Smith /*@
2040d763cef2SBarry Smith   TSGetApplicationContext - Gets the user-defined context for the
2041bcf0153eSBarry Smith   timestepper that was set with `TSSetApplicationContext()`
2042d763cef2SBarry Smith 
2043d763cef2SBarry Smith   Not Collective
2044d763cef2SBarry Smith 
2045d763cef2SBarry Smith   Input Parameter:
2046bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2047d763cef2SBarry Smith 
2048d763cef2SBarry Smith   Output Parameter:
2049d763cef2SBarry Smith . usrP - user context
2050d763cef2SBarry Smith 
2051bcf0153eSBarry Smith   Level: intermediate
2052bcf0153eSBarry Smith 
2053b43aa488SJacob Faibussowitsch   Fortran Notes:
2054195e9b02SBarry Smith   You must write a Fortran interface definition for this
2055195e9b02SBarry Smith   function that tells Fortran the Fortran derived data type that you are passing in as the `ctx` argument.
2056daf670e6SBarry Smith 
20571cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetApplicationContext()`
2058d763cef2SBarry Smith @*/
2059d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetApplicationContext(TS ts, void *usrP)
2060d71ae5a4SJacob Faibussowitsch {
2061d763cef2SBarry Smith   PetscFunctionBegin;
20620700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2063e71120c6SJed Brown   *(void **)usrP = ts->user;
20643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2065d763cef2SBarry Smith }
2066d763cef2SBarry Smith 
2067d763cef2SBarry Smith /*@
2068bcf0153eSBarry Smith   TSGetStepNumber - Gets the number of time steps completed.
2069d763cef2SBarry Smith 
2070d763cef2SBarry Smith   Not Collective
2071d763cef2SBarry Smith 
2072d763cef2SBarry Smith   Input Parameter:
2073bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2074d763cef2SBarry Smith 
2075d763cef2SBarry Smith   Output Parameter:
207680275a0aSLisandro Dalcin . steps - number of steps completed so far
2077d763cef2SBarry Smith 
2078d763cef2SBarry Smith   Level: intermediate
2079d763cef2SBarry Smith 
20801cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTime()`, `TSGetTimeStep()`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostStage()`, `TSSetPostStep()`
2081d763cef2SBarry Smith @*/
2082d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetStepNumber(TS ts, PetscInt *steps)
2083d71ae5a4SJacob Faibussowitsch {
2084d763cef2SBarry Smith   PetscFunctionBegin;
20850700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
20864f572ea9SToby Isaac   PetscAssertPointer(steps, 2);
208780275a0aSLisandro Dalcin   *steps = ts->steps;
20883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
208980275a0aSLisandro Dalcin }
209080275a0aSLisandro Dalcin 
209180275a0aSLisandro Dalcin /*@
209280275a0aSLisandro Dalcin   TSSetStepNumber - Sets the number of steps completed.
209380275a0aSLisandro Dalcin 
2094c3339decSBarry Smith   Logically Collective
209580275a0aSLisandro Dalcin 
209680275a0aSLisandro Dalcin   Input Parameters:
2097bcf0153eSBarry Smith + ts    - the `TS` context
209880275a0aSLisandro Dalcin - steps - number of steps completed so far
209980275a0aSLisandro Dalcin 
2100bcf0153eSBarry Smith   Level: developer
2101bcf0153eSBarry Smith 
2102bcf0153eSBarry Smith   Note:
2103bcf0153eSBarry Smith   For most uses of the `TS` solvers the user need not explicitly call
2104bcf0153eSBarry Smith   `TSSetStepNumber()`, as the step counter is appropriately updated in
2105bcf0153eSBarry Smith   `TSSolve()`/`TSStep()`/`TSRollBack()`. Power users may call this routine to
210680275a0aSLisandro Dalcin   reinitialize timestepping by setting the step counter to zero (and time
210780275a0aSLisandro Dalcin   to the initial time) to solve a similar problem with different initial
210880275a0aSLisandro Dalcin   conditions or parameters. Other possible use case is to continue
2109195e9b02SBarry Smith   timestepping from a previously interrupted run in such a way that `TS`
211080275a0aSLisandro Dalcin   monitors will be called with a initial nonzero step counter.
211180275a0aSLisandro Dalcin 
21121cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetStepNumber()`, `TSSetTime()`, `TSSetTimeStep()`, `TSSetSolution()`
211380275a0aSLisandro Dalcin @*/
2114d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetStepNumber(TS ts, PetscInt steps)
2115d71ae5a4SJacob Faibussowitsch {
211680275a0aSLisandro Dalcin   PetscFunctionBegin;
211780275a0aSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
211880275a0aSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts, steps, 2);
21193c633725SBarry Smith   PetscCheck(steps >= 0, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_OUTOFRANGE, "Step number must be non-negative");
212080275a0aSLisandro Dalcin   ts->steps = steps;
21213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2122d763cef2SBarry Smith }
2123d763cef2SBarry Smith 
2124d763cef2SBarry Smith /*@
2125d763cef2SBarry Smith   TSSetTimeStep - Allows one to reset the timestep at any time,
2126d763cef2SBarry Smith   useful for simple pseudo-timestepping codes.
2127d763cef2SBarry Smith 
2128c3339decSBarry Smith   Logically Collective
2129d763cef2SBarry Smith 
2130d763cef2SBarry Smith   Input Parameters:
2131bcf0153eSBarry Smith + ts        - the `TS` context obtained from `TSCreate()`
2132d763cef2SBarry Smith - time_step - the size of the timestep
2133d763cef2SBarry Smith 
2134d763cef2SBarry Smith   Level: intermediate
2135d763cef2SBarry Smith 
21361cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSPSEUDO`, `TSGetTimeStep()`, `TSSetTime()`
2137d763cef2SBarry Smith @*/
2138d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetTimeStep(TS ts, PetscReal time_step)
2139d71ae5a4SJacob Faibussowitsch {
2140d763cef2SBarry Smith   PetscFunctionBegin;
21410700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2142c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts, time_step, 2);
2143d763cef2SBarry Smith   ts->time_step = time_step;
21443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2145d763cef2SBarry Smith }
2146d763cef2SBarry Smith 
2147a43b19c4SJed Brown /*@
214849354f04SShri Abhyankar   TSSetExactFinalTime - Determines whether to adapt the final time step to
214949354f04SShri Abhyankar   match the exact final time, interpolate solution to the exact final time,
2150bcf0153eSBarry Smith   or just return at the final time `TS` computed.
2151a43b19c4SJed Brown 
2152c3339decSBarry Smith   Logically Collective
2153a43b19c4SJed Brown 
2154d8d19677SJose E. Roman   Input Parameters:
2155a43b19c4SJed Brown + ts     - the time-step context
215649354f04SShri Abhyankar - eftopt - exact final time option
2157bcf0153eSBarry Smith .vb
2158bcf0153eSBarry Smith   TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
2159bcf0153eSBarry Smith   TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
2160bcf0153eSBarry Smith   TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
2161bcf0153eSBarry Smith .ve
2162a43b19c4SJed Brown 
2163bcf0153eSBarry Smith   Options Database Key:
2164feed9e9dSBarry Smith . -ts_exact_final_time <stepover,interpolate,matchstep> - select the final step at runtime
2165feed9e9dSBarry Smith 
2166a43b19c4SJed Brown   Level: beginner
2167a43b19c4SJed Brown 
2168bcf0153eSBarry Smith   Note:
2169bcf0153eSBarry Smith   If you use the option `TS_EXACTFINALTIME_STEPOVER` the solution may be at a very different time
2170bcf0153eSBarry Smith   then the final time you selected.
2171bcf0153eSBarry Smith 
21721cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSExactFinalTimeOption`, `TSGetExactFinalTime()`
2173a43b19c4SJed Brown @*/
2174d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetExactFinalTime(TS ts, TSExactFinalTimeOption eftopt)
2175d71ae5a4SJacob Faibussowitsch {
2176a43b19c4SJed Brown   PetscFunctionBegin;
2177a43b19c4SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
217849354f04SShri Abhyankar   PetscValidLogicalCollectiveEnum(ts, eftopt, 2);
217949354f04SShri Abhyankar   ts->exact_final_time = eftopt;
21803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2181a43b19c4SJed Brown }
2182a43b19c4SJed Brown 
2183d763cef2SBarry Smith /*@
2184bcf0153eSBarry Smith   TSGetExactFinalTime - Gets the exact final time option set with `TSSetExactFinalTime()`
2185f6953c82SLisandro Dalcin 
2186f6953c82SLisandro Dalcin   Not Collective
2187f6953c82SLisandro Dalcin 
2188f6953c82SLisandro Dalcin   Input Parameter:
2189bcf0153eSBarry Smith . ts - the `TS` context
2190f6953c82SLisandro Dalcin 
2191f6953c82SLisandro Dalcin   Output Parameter:
2192f6953c82SLisandro Dalcin . eftopt - exact final time option
2193f6953c82SLisandro Dalcin 
2194f6953c82SLisandro Dalcin   Level: beginner
2195f6953c82SLisandro Dalcin 
21961cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSExactFinalTimeOption`, `TSSetExactFinalTime()`
2197f6953c82SLisandro Dalcin @*/
2198d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetExactFinalTime(TS ts, TSExactFinalTimeOption *eftopt)
2199d71ae5a4SJacob Faibussowitsch {
2200f6953c82SLisandro Dalcin   PetscFunctionBegin;
2201f6953c82SLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
22024f572ea9SToby Isaac   PetscAssertPointer(eftopt, 2);
2203f6953c82SLisandro Dalcin   *eftopt = ts->exact_final_time;
22043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2205f6953c82SLisandro Dalcin }
2206f6953c82SLisandro Dalcin 
2207f6953c82SLisandro Dalcin /*@
2208d763cef2SBarry Smith   TSGetTimeStep - Gets the current timestep size.
2209d763cef2SBarry Smith 
2210d763cef2SBarry Smith   Not Collective
2211d763cef2SBarry Smith 
2212d763cef2SBarry Smith   Input Parameter:
2213bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2214d763cef2SBarry Smith 
2215d763cef2SBarry Smith   Output Parameter:
2216d763cef2SBarry Smith . dt - the current timestep size
2217d763cef2SBarry Smith 
2218d763cef2SBarry Smith   Level: intermediate
2219d763cef2SBarry Smith 
22201cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetTimeStep()`, `TSGetTime()`
2221d763cef2SBarry Smith @*/
2222d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTimeStep(TS ts, PetscReal *dt)
2223d71ae5a4SJacob Faibussowitsch {
2224d763cef2SBarry Smith   PetscFunctionBegin;
22250700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
22264f572ea9SToby Isaac   PetscAssertPointer(dt, 2);
2227d763cef2SBarry Smith   *dt = ts->time_step;
22283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2229d763cef2SBarry Smith }
2230d763cef2SBarry Smith 
2231d8e5e3e6SSatish Balay /*@
2232d763cef2SBarry Smith   TSGetSolution - Returns the solution at the present timestep. It
2233d763cef2SBarry Smith   is valid to call this routine inside the function that you are evaluating
2234d763cef2SBarry Smith   in order to move to the new timestep. This vector not changed until
2235d763cef2SBarry Smith   the solution at the next timestep has been calculated.
2236d763cef2SBarry Smith 
2237bcf0153eSBarry Smith   Not Collective, but v returned is parallel if ts is parallel
2238d763cef2SBarry Smith 
2239d763cef2SBarry Smith   Input Parameter:
2240bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2241d763cef2SBarry Smith 
2242d763cef2SBarry Smith   Output Parameter:
2243d763cef2SBarry Smith . v - the vector containing the solution
2244d763cef2SBarry Smith 
2245d763cef2SBarry Smith   Level: intermediate
2246d763cef2SBarry Smith 
2247bcf0153eSBarry Smith   Note:
2248bcf0153eSBarry Smith   If you used `TSSetExactFinalTime`(ts,`TS_EXACTFINALTIME_MATCHSTEP`); this does not return the solution at the requested
2249bcf0153eSBarry Smith   final time. It returns the solution at the next timestep.
2250d763cef2SBarry Smith 
22511cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetTime()`, `TSGetSolveTime()`, `TSGetSolutionComponents()`, `TSSetSolutionFunction()`
2252d763cef2SBarry Smith @*/
2253d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetSolution(TS ts, Vec *v)
2254d71ae5a4SJacob Faibussowitsch {
2255d763cef2SBarry Smith   PetscFunctionBegin;
22560700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
22574f572ea9SToby Isaac   PetscAssertPointer(v, 2);
22588737fe31SLisandro Dalcin   *v = ts->vec_sol;
22593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2260d763cef2SBarry Smith }
2261d763cef2SBarry Smith 
226203fe5f5eSDebojyoti Ghosh /*@
2263b2bf4f3aSDebojyoti Ghosh   TSGetSolutionComponents - Returns any solution components at the present
226403fe5f5eSDebojyoti Ghosh   timestep, if available for the time integration method being used.
2265b2bf4f3aSDebojyoti Ghosh   Solution components are quantities that share the same size and
226603fe5f5eSDebojyoti Ghosh   structure as the solution vector.
226703fe5f5eSDebojyoti Ghosh 
2268bcf0153eSBarry Smith   Not Collective, but v returned is parallel if ts is parallel
226903fe5f5eSDebojyoti Ghosh 
2270b43aa488SJacob Faibussowitsch   Input Parameters:
2271bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()` (input parameter).
2272195e9b02SBarry Smith . n  - If v is `NULL`, then the number of solution components is
2273b2bf4f3aSDebojyoti Ghosh        returned through n, else the n-th solution component is
227403fe5f5eSDebojyoti Ghosh        returned in v.
2275a2b725a8SWilliam Gropp - v  - the vector containing the n-th solution component
2276195e9b02SBarry Smith        (may be `NULL` to use this function to find out
2277b2bf4f3aSDebojyoti Ghosh         the number of solutions components).
227803fe5f5eSDebojyoti Ghosh 
22794cdd57e5SDebojyoti Ghosh   Level: advanced
228003fe5f5eSDebojyoti Ghosh 
22811cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetSolution()`
228203fe5f5eSDebojyoti Ghosh @*/
2283d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetSolutionComponents(TS ts, PetscInt *n, Vec *v)
2284d71ae5a4SJacob Faibussowitsch {
228503fe5f5eSDebojyoti Ghosh   PetscFunctionBegin;
228603fe5f5eSDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2287b2bf4f3aSDebojyoti Ghosh   if (!ts->ops->getsolutioncomponents) *n = 0;
2288dbbe0bcdSBarry Smith   else PetscUseTypeMethod(ts, getsolutioncomponents, n, v);
22893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
229003fe5f5eSDebojyoti Ghosh }
229103fe5f5eSDebojyoti Ghosh 
22924cdd57e5SDebojyoti Ghosh /*@
22934cdd57e5SDebojyoti Ghosh   TSGetAuxSolution - Returns an auxiliary solution at the present
22944cdd57e5SDebojyoti Ghosh   timestep, if available for the time integration method being used.
22954cdd57e5SDebojyoti Ghosh 
2296bcf0153eSBarry Smith   Not Collective, but v returned is parallel if ts is parallel
22974cdd57e5SDebojyoti Ghosh 
2298b43aa488SJacob Faibussowitsch   Input Parameters:
2299bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()` (input parameter).
2300a2b725a8SWilliam Gropp - v  - the vector containing the auxiliary solution
23014cdd57e5SDebojyoti Ghosh 
23024cdd57e5SDebojyoti Ghosh   Level: intermediate
23034cdd57e5SDebojyoti Ghosh 
23041cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetSolution()`
23054cdd57e5SDebojyoti Ghosh @*/
2306d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetAuxSolution(TS ts, Vec *v)
2307d71ae5a4SJacob Faibussowitsch {
23084cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23094cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2310dbbe0bcdSBarry Smith   if (ts->ops->getauxsolution) PetscUseTypeMethod(ts, getauxsolution, v);
23111e66621cSBarry Smith   else PetscCall(VecZeroEntries(*v));
23123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23134cdd57e5SDebojyoti Ghosh }
23144cdd57e5SDebojyoti Ghosh 
23154cdd57e5SDebojyoti Ghosh /*@
23164cdd57e5SDebojyoti Ghosh   TSGetTimeError - Returns the estimated error vector, if the chosen
2317bcf0153eSBarry Smith   `TSType` has an error estimation functionality and `TSSetTimeError()` was called
23184cdd57e5SDebojyoti Ghosh 
2319bcf0153eSBarry Smith   Not Collective, but v returned is parallel if ts is parallel
23209657682dSDebojyoti Ghosh 
2321b43aa488SJacob Faibussowitsch   Input Parameters:
2322bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()` (input parameter).
2323657c1e31SEmil Constantinescu . n  - current estimate (n=0) or previous one (n=-1)
2324a2b725a8SWilliam Gropp - v  - the vector containing the error (same size as the solution).
23254cdd57e5SDebojyoti Ghosh 
23264cdd57e5SDebojyoti Ghosh   Level: intermediate
23274cdd57e5SDebojyoti Ghosh 
2328bcf0153eSBarry Smith   Note:
2329bcf0153eSBarry Smith   MUST call after `TSSetUp()`
23304cdd57e5SDebojyoti Ghosh 
23311cc06b55SBarry Smith .seealso: [](ch_ts), `TSGetSolution()`, `TSSetTimeError()`
23324cdd57e5SDebojyoti Ghosh @*/
2333d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTimeError(TS ts, PetscInt n, Vec *v)
2334d71ae5a4SJacob Faibussowitsch {
23354cdd57e5SDebojyoti Ghosh   PetscFunctionBegin;
23364cdd57e5SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2337dbbe0bcdSBarry Smith   if (ts->ops->gettimeerror) PetscUseTypeMethod(ts, gettimeerror, n, v);
23381e66621cSBarry Smith   else PetscCall(VecZeroEntries(*v));
23393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23404cdd57e5SDebojyoti Ghosh }
23414cdd57e5SDebojyoti Ghosh 
234257df6a1bSDebojyoti Ghosh /*@
234357df6a1bSDebojyoti Ghosh   TSSetTimeError - Sets the estimated error vector, if the chosen
2344bcf0153eSBarry Smith   `TSType` has an error estimation functionality. This can be used
234557df6a1bSDebojyoti Ghosh   to restart such a time integrator with a given error vector.
234657df6a1bSDebojyoti Ghosh 
2347bcf0153eSBarry Smith   Not Collective, but v returned is parallel if ts is parallel
234857df6a1bSDebojyoti Ghosh 
2349b43aa488SJacob Faibussowitsch   Input Parameters:
2350bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()` (input parameter).
2351a2b725a8SWilliam Gropp - v  - the vector containing the error (same size as the solution).
235257df6a1bSDebojyoti Ghosh 
235357df6a1bSDebojyoti Ghosh   Level: intermediate
235457df6a1bSDebojyoti Ghosh 
2355b43aa488SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetSolution()`, `TSGetTimeError()`
235657df6a1bSDebojyoti Ghosh @*/
2357d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetTimeError(TS ts, Vec v)
2358d71ae5a4SJacob Faibussowitsch {
235957df6a1bSDebojyoti Ghosh   PetscFunctionBegin;
236057df6a1bSDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
23613c633725SBarry Smith   PetscCheck(ts->setupcalled, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call TSSetUp() first");
2362dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, settimeerror, v);
23633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
236457df6a1bSDebojyoti Ghosh }
236557df6a1bSDebojyoti Ghosh 
2366bdad233fSMatthew Knepley /* ----- Routines to initialize and destroy a timestepper ---- */
2367d8e5e3e6SSatish Balay /*@
2368bdad233fSMatthew Knepley   TSSetProblemType - Sets the type of problem to be solved.
2369d763cef2SBarry Smith 
2370bdad233fSMatthew Knepley   Not collective
2371d763cef2SBarry Smith 
2372bdad233fSMatthew Knepley   Input Parameters:
2373bcf0153eSBarry Smith + ts   - The `TS`
2374bcf0153eSBarry Smith - type - One of `TS_LINEAR`, `TS_NONLINEAR` where these types refer to problems of the forms
2375d763cef2SBarry Smith .vb
23760910c330SBarry Smith          U_t - A U = 0      (linear)
23770910c330SBarry Smith          U_t - A(t) U = 0   (linear)
23780910c330SBarry Smith          F(t,U,U_t) = 0     (nonlinear)
2379d763cef2SBarry Smith .ve
2380d763cef2SBarry Smith 
2381d763cef2SBarry Smith   Level: beginner
2382d763cef2SBarry Smith 
23831cc06b55SBarry Smith .seealso: [](ch_ts), `TSSetUp()`, `TSProblemType`, `TS`
2384d763cef2SBarry Smith @*/
2385d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetProblemType(TS ts, TSProblemType type)
2386d71ae5a4SJacob Faibussowitsch {
2387d763cef2SBarry Smith   PetscFunctionBegin;
23880700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2389bdad233fSMatthew Knepley   ts->problem_type = type;
23909e2a6581SJed Brown   if (type == TS_LINEAR) {
23919e2a6581SJed Brown     SNES snes;
23929566063dSJacob Faibussowitsch     PetscCall(TSGetSNES(ts, &snes));
23939566063dSJacob Faibussowitsch     PetscCall(SNESSetType(snes, SNESKSPONLY));
23949e2a6581SJed Brown   }
23953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2396d763cef2SBarry Smith }
2397d763cef2SBarry Smith 
2398bdad233fSMatthew Knepley /*@C
2399bdad233fSMatthew Knepley   TSGetProblemType - Gets the type of problem to be solved.
2400bdad233fSMatthew Knepley 
2401bdad233fSMatthew Knepley   Not collective
2402bdad233fSMatthew Knepley 
2403bdad233fSMatthew Knepley   Input Parameter:
2404bcf0153eSBarry Smith . ts - The `TS`
2405bdad233fSMatthew Knepley 
2406bdad233fSMatthew Knepley   Output Parameter:
2407bcf0153eSBarry Smith . type - One of `TS_LINEAR`, `TS_NONLINEAR` where these types refer to problems of the forms
2408bdad233fSMatthew Knepley .vb
2409089b2837SJed Brown          M U_t = A U
2410089b2837SJed Brown          M(t) U_t = A(t) U
2411b5abc632SBarry Smith          F(t,U,U_t)
2412bdad233fSMatthew Knepley .ve
2413bdad233fSMatthew Knepley 
2414bdad233fSMatthew Knepley   Level: beginner
2415bdad233fSMatthew Knepley 
24161cc06b55SBarry Smith .seealso: [](ch_ts), `TSSetUp()`, `TSProblemType`, `TS`
2417bdad233fSMatthew Knepley @*/
2418d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetProblemType(TS ts, TSProblemType *type)
2419d71ae5a4SJacob Faibussowitsch {
2420bdad233fSMatthew Knepley   PetscFunctionBegin;
24210700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
24224f572ea9SToby Isaac   PetscAssertPointer(type, 2);
2423bdad233fSMatthew Knepley   *type = ts->problem_type;
24243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2425bdad233fSMatthew Knepley }
2426d763cef2SBarry Smith 
2427303a5415SBarry Smith /*
2428303a5415SBarry Smith     Attempt to check/preset a default value for the exact final time option. This is needed at the beginning of TSSolve() and in TSSetUp()
2429303a5415SBarry Smith */
2430d71ae5a4SJacob Faibussowitsch static PetscErrorCode TSSetExactFinalTimeDefault(TS ts)
2431d71ae5a4SJacob Faibussowitsch {
2432303a5415SBarry Smith   PetscBool isnone;
2433303a5415SBarry Smith 
2434303a5415SBarry Smith   PetscFunctionBegin;
24359566063dSJacob Faibussowitsch   PetscCall(TSGetAdapt(ts, &ts->adapt));
24369566063dSJacob Faibussowitsch   PetscCall(TSAdaptSetDefaultType(ts->adapt, ts->default_adapt_type));
2437303a5415SBarry Smith 
24389566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)ts->adapt, TSADAPTNONE, &isnone));
24391e66621cSBarry Smith   if (!isnone && ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) ts->exact_final_time = TS_EXACTFINALTIME_MATCHSTEP;
24401e66621cSBarry Smith   else if (ts->exact_final_time == TS_EXACTFINALTIME_UNSPECIFIED) ts->exact_final_time = TS_EXACTFINALTIME_INTERPOLATE;
24413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2442303a5415SBarry Smith }
2443303a5415SBarry Smith 
2444d763cef2SBarry Smith /*@
2445303a5415SBarry Smith   TSSetUp - Sets up the internal data structures for the later use of a timestepper.
2446d763cef2SBarry Smith 
2447c3339decSBarry Smith   Collective
2448d763cef2SBarry Smith 
2449d763cef2SBarry Smith   Input Parameter:
2450bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2451d763cef2SBarry Smith 
2452d763cef2SBarry Smith   Level: advanced
2453d763cef2SBarry Smith 
2454bcf0153eSBarry Smith   Note:
2455bcf0153eSBarry Smith   For basic use of the `TS` solvers the user need not explicitly call
2456bcf0153eSBarry Smith   `TSSetUp()`, since these actions will automatically occur during
2457bcf0153eSBarry Smith   the call to `TSStep()` or `TSSolve()`.  However, if one wishes to control this
2458bcf0153eSBarry Smith   phase separately, `TSSetUp()` should be called after `TSCreate()`
2459bcf0153eSBarry Smith   and optional routines of the form TSSetXXX(), but before `TSStep()` and `TSSolve()`.
2460bcf0153eSBarry Smith 
24611cc06b55SBarry Smith .seealso: [](ch_ts), `TSCreate()`, `TS`, `TSStep()`, `TSDestroy()`, `TSSolve()`
2462d763cef2SBarry Smith @*/
2463d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetUp(TS ts)
2464d71ae5a4SJacob Faibussowitsch {
24656c6b9e74SPeter Brune   DM dm;
24666c6b9e74SPeter Brune   PetscErrorCode (*func)(SNES, Vec, Vec, void *);
2467d1e9a80fSBarry Smith   PetscErrorCode (*jac)(SNES, Vec, Mat, Mat, void *);
24688434afd1SBarry Smith   TSIFunctionFn   *ifun;
24698434afd1SBarry Smith   TSIJacobianFn   *ijac;
24708434afd1SBarry Smith   TSI2JacobianFn  *i2jac;
24718434afd1SBarry Smith   TSRHSJacobianFn *rhsjac;
2472d763cef2SBarry Smith 
2473d763cef2SBarry Smith   PetscFunctionBegin;
24740700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
24753ba16761SJacob Faibussowitsch   if (ts->setupcalled) PetscFunctionReturn(PETSC_SUCCESS);
2476277b19d0SLisandro Dalcin 
24777adad957SLisandro Dalcin   if (!((PetscObject)ts)->type_name) {
24789566063dSJacob Faibussowitsch     PetscCall(TSGetIFunction(ts, NULL, &ifun, NULL));
24799566063dSJacob Faibussowitsch     PetscCall(TSSetType(ts, ifun ? TSBEULER : TSEULER));
2480d763cef2SBarry Smith   }
2481277b19d0SLisandro Dalcin 
24821a638600SStefano Zampini   if (!ts->vec_sol) {
24831e66621cSBarry Smith     PetscCheck(ts->dm, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call TSSetSolution() first");
24849566063dSJacob Faibussowitsch     PetscCall(DMCreateGlobalVector(ts->dm, &ts->vec_sol));
24851a638600SStefano Zampini   }
2486277b19d0SLisandro Dalcin 
24874a658b32SHong Zhang   if (ts->tspan) {
24881e66621cSBarry Smith     if (!ts->tspan->vecs_sol) PetscCall(VecDuplicateVecs(ts->vec_sol, ts->tspan->num_span_times, &ts->tspan->vecs_sol));
24894a658b32SHong Zhang   }
2490298bade4SHong Zhang   if (!ts->Jacp && ts->Jacprhs) { /* IJacobianP shares the same matrix with RHSJacobianP if only RHSJacobianP is provided */
24919566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)ts->Jacprhs));
2492298bade4SHong Zhang     ts->Jacp = ts->Jacprhs;
2493298bade4SHong Zhang   }
2494298bade4SHong Zhang 
2495cd4cee2dSHong Zhang   if (ts->quadraturets) {
24969566063dSJacob Faibussowitsch     PetscCall(TSSetUp(ts->quadraturets));
24979566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ts->vec_costintegrand));
24989566063dSJacob Faibussowitsch     PetscCall(VecDuplicate(ts->quadraturets->vec_sol, &ts->vec_costintegrand));
2499cd4cee2dSHong Zhang   }
2500cd4cee2dSHong Zhang 
25019566063dSJacob Faibussowitsch   PetscCall(TSGetRHSJacobian(ts, NULL, NULL, &rhsjac, NULL));
2502f23ba4b3SHong Zhang   if (rhsjac == TSComputeRHSJacobianConstant) {
2503e1244c69SJed Brown     Mat  Amat, Pmat;
2504e1244c69SJed Brown     SNES snes;
25059566063dSJacob Faibussowitsch     PetscCall(TSGetSNES(ts, &snes));
25069566063dSJacob Faibussowitsch     PetscCall(SNESGetJacobian(snes, &Amat, &Pmat, NULL, NULL));
2507e1244c69SJed Brown     /* Matching matrices implies that an IJacobian is NOT set, because if it had been set, the IJacobian's matrix would
2508e1244c69SJed Brown      * have displaced the RHS matrix */
2509971015bcSStefano Zampini     if (Amat && Amat == ts->Arhs) {
2510abc0d4abSBarry Smith       /* we need to copy the values of the matrix because for the constant Jacobian case the user will never set the numerical values in this new location */
25119566063dSJacob Faibussowitsch       PetscCall(MatDuplicate(ts->Arhs, MAT_COPY_VALUES, &Amat));
25129566063dSJacob Faibussowitsch       PetscCall(SNESSetJacobian(snes, Amat, NULL, NULL, NULL));
25139566063dSJacob Faibussowitsch       PetscCall(MatDestroy(&Amat));
2514e1244c69SJed Brown     }
2515971015bcSStefano Zampini     if (Pmat && Pmat == ts->Brhs) {
25169566063dSJacob Faibussowitsch       PetscCall(MatDuplicate(ts->Brhs, MAT_COPY_VALUES, &Pmat));
25179566063dSJacob Faibussowitsch       PetscCall(SNESSetJacobian(snes, NULL, Pmat, NULL, NULL));
25189566063dSJacob Faibussowitsch       PetscCall(MatDestroy(&Pmat));
2519e1244c69SJed Brown     }
2520e1244c69SJed Brown   }
25212ffb9264SLisandro Dalcin 
25229566063dSJacob Faibussowitsch   PetscCall(TSGetAdapt(ts, &ts->adapt));
25239566063dSJacob Faibussowitsch   PetscCall(TSAdaptSetDefaultType(ts->adapt, ts->default_adapt_type));
25242ffb9264SLisandro Dalcin 
2525dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, setup);
2526277b19d0SLisandro Dalcin 
25279566063dSJacob Faibussowitsch   PetscCall(TSSetExactFinalTimeDefault(ts));
25282ffb9264SLisandro Dalcin 
2529a6772fa2SLisandro Dalcin   /* In the case where we've set a DMTSFunction or what have you, we need the default SNESFunction
25306c6b9e74SPeter Brune      to be set right but can't do it elsewhere due to the overreliance on ctx=ts.
25316c6b9e74SPeter Brune    */
25329566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
25339566063dSJacob Faibussowitsch   PetscCall(DMSNESGetFunction(dm, &func, NULL));
25341e66621cSBarry Smith   if (!func) PetscCall(DMSNESSetFunction(dm, SNESTSFormFunction, ts));
25351e66621cSBarry Smith 
2536a6772fa2SLisandro Dalcin   /* If the SNES doesn't have a jacobian set and the TS has an ijacobian or rhsjacobian set, set the SNES to use it.
25376c6b9e74SPeter Brune      Otherwise, the SNES will use coloring internally to form the Jacobian.
25386c6b9e74SPeter Brune    */
25399566063dSJacob Faibussowitsch   PetscCall(DMSNESGetJacobian(dm, &jac, NULL));
25409566063dSJacob Faibussowitsch   PetscCall(DMTSGetIJacobian(dm, &ijac, NULL));
25419566063dSJacob Faibussowitsch   PetscCall(DMTSGetI2Jacobian(dm, &i2jac, NULL));
25429566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSJacobian(dm, &rhsjac, NULL));
25431e66621cSBarry Smith   if (!jac && (ijac || i2jac || rhsjac)) PetscCall(DMSNESSetJacobian(dm, SNESTSFormJacobian, ts));
2544c0517034SDebojyoti Ghosh 
2545c0517034SDebojyoti Ghosh   /* if time integration scheme has a starting method, call it */
2546dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, startingmethod);
2547c0517034SDebojyoti Ghosh 
2548277b19d0SLisandro Dalcin   ts->setupcalled = PETSC_TRUE;
25493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2550277b19d0SLisandro Dalcin }
2551277b19d0SLisandro Dalcin 
2552f6a906c0SBarry Smith /*@
2553bcf0153eSBarry Smith   TSReset - Resets a `TS` context and removes any allocated `Vec`s and `Mat`s.
2554277b19d0SLisandro Dalcin 
2555c3339decSBarry Smith   Collective
2556277b19d0SLisandro Dalcin 
2557277b19d0SLisandro Dalcin   Input Parameter:
2558bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2559277b19d0SLisandro Dalcin 
2560277b19d0SLisandro Dalcin   Level: beginner
2561277b19d0SLisandro Dalcin 
25621cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetup()`, `TSDestroy()`
2563277b19d0SLisandro Dalcin @*/
2564d71ae5a4SJacob Faibussowitsch PetscErrorCode TSReset(TS ts)
2565d71ae5a4SJacob Faibussowitsch {
25661d06f6b3SHong Zhang   TS_RHSSplitLink ilink = ts->tsrhssplit, next;
2567277b19d0SLisandro Dalcin 
2568277b19d0SLisandro Dalcin   PetscFunctionBegin;
2569277b19d0SLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2570b18ea86cSHong Zhang 
2571dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, reset);
25729566063dSJacob Faibussowitsch   if (ts->snes) PetscCall(SNESReset(ts->snes));
25739566063dSJacob Faibussowitsch   if (ts->adapt) PetscCall(TSAdaptReset(ts->adapt));
2574bbd56ea5SKarl Rupp 
25759566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&ts->Arhs));
25769566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&ts->Brhs));
25779566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->Frhs));
25789566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->vec_sol));
2579c61711c8SStefano Zampini   PetscCall(VecDestroy(&ts->vec_sol0));
25809566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->vec_dot));
25819566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->vatol));
25829566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->vrtol));
25839566063dSJacob Faibussowitsch   PetscCall(VecDestroyVecs(ts->nwork, &ts->work));
2584bbd56ea5SKarl Rupp 
25859566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&ts->Jacprhs));
25869566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&ts->Jacp));
25871baa6e33SBarry Smith   if (ts->forward_solve) PetscCall(TSForwardReset(ts));
2588cd4cee2dSHong Zhang   if (ts->quadraturets) {
25899566063dSJacob Faibussowitsch     PetscCall(TSReset(ts->quadraturets));
25909566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ts->vec_costintegrand));
2591cd4cee2dSHong Zhang   }
25921d06f6b3SHong Zhang   while (ilink) {
25931d06f6b3SHong Zhang     next = ilink->next;
25949566063dSJacob Faibussowitsch     PetscCall(TSDestroy(&ilink->ts));
25959566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink->splitname));
25969566063dSJacob Faibussowitsch     PetscCall(ISDestroy(&ilink->is));
25979566063dSJacob Faibussowitsch     PetscCall(PetscFree(ilink));
25981d06f6b3SHong Zhang     ilink = next;
259987f4e208SHong Zhang   }
26006bf673ebSJoe Pusztay   ts->tsrhssplit     = NULL;
2601545aaa6fSHong Zhang   ts->num_rhs_splits = 0;
26024a658b32SHong Zhang   if (ts->tspan) {
26034a658b32SHong Zhang     PetscCall(PetscFree(ts->tspan->span_times));
26044a658b32SHong Zhang     PetscCall(VecDestroyVecs(ts->tspan->num_span_times, &ts->tspan->vecs_sol));
26054a658b32SHong Zhang     PetscCall(PetscFree(ts->tspan));
26064a658b32SHong Zhang   }
2607b3a72457SStefano Zampini   ts->rhsjacobian.time  = PETSC_MIN_REAL;
2608b3a72457SStefano Zampini   ts->rhsjacobian.scale = 1.0;
2609b3a72457SStefano Zampini   ts->ijacobian.shift   = 1.0;
2610277b19d0SLisandro Dalcin   ts->setupcalled       = PETSC_FALSE;
26113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2612d763cef2SBarry Smith }
2613d763cef2SBarry Smith 
261414d0ab18SJacob Faibussowitsch static PetscErrorCode TSResizeReset(TS);
261514d0ab18SJacob Faibussowitsch 
26161fb7b255SJunchao Zhang /*@C
2617d763cef2SBarry Smith   TSDestroy - Destroys the timestepper context that was created
2618bcf0153eSBarry Smith   with `TSCreate()`.
2619d763cef2SBarry Smith 
2620c3339decSBarry Smith   Collective
2621d763cef2SBarry Smith 
2622d763cef2SBarry Smith   Input Parameter:
2623bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2624d763cef2SBarry Smith 
2625d763cef2SBarry Smith   Level: beginner
2626d763cef2SBarry Smith 
26271cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetUp()`, `TSSolve()`
2628d763cef2SBarry Smith @*/
2629d71ae5a4SJacob Faibussowitsch PetscErrorCode TSDestroy(TS *ts)
2630d71ae5a4SJacob Faibussowitsch {
2631d763cef2SBarry Smith   PetscFunctionBegin;
26323ba16761SJacob Faibussowitsch   if (!*ts) PetscFunctionReturn(PETSC_SUCCESS);
2633ecf68647SHong Zhang   PetscValidHeaderSpecific(*ts, TS_CLASSID, 1);
2634f4f49eeaSPierre Jolivet   if (--((PetscObject)*ts)->refct > 0) {
26359371c9d4SSatish Balay     *ts = NULL;
26363ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
26379371c9d4SSatish Balay   }
2638d763cef2SBarry Smith 
26399566063dSJacob Faibussowitsch   PetscCall(TSReset(*ts));
26409566063dSJacob Faibussowitsch   PetscCall(TSAdjointReset(*ts));
26411e66621cSBarry Smith   if ((*ts)->forward_solve) PetscCall(TSForwardReset(*ts));
26426bd3a4fdSStefano Zampini   PetscCall(TSResizeReset(*ts));
26431e66621cSBarry Smith 
2644e04113cfSBarry Smith   /* if memory was published with SAWs then destroy it */
26459566063dSJacob Faibussowitsch   PetscCall(PetscObjectSAWsViewOff((PetscObject)*ts));
2646f4f49eeaSPierre Jolivet   PetscTryTypeMethod(*ts, destroy);
26476d4c513bSLisandro Dalcin 
26489566063dSJacob Faibussowitsch   PetscCall(TSTrajectoryDestroy(&(*ts)->trajectory));
2649bc952696SBarry Smith 
26509566063dSJacob Faibussowitsch   PetscCall(TSAdaptDestroy(&(*ts)->adapt));
26519566063dSJacob Faibussowitsch   PetscCall(TSEventDestroy(&(*ts)->event));
26526427ac75SLisandro Dalcin 
26539566063dSJacob Faibussowitsch   PetscCall(SNESDestroy(&(*ts)->snes));
26549566063dSJacob Faibussowitsch   PetscCall(DMDestroy(&(*ts)->dm));
2655f4f49eeaSPierre Jolivet   PetscCall(TSMonitorCancel(*ts));
2656f4f49eeaSPierre Jolivet   PetscCall(TSAdjointMonitorCancel(*ts));
26576d4c513bSLisandro Dalcin 
26589566063dSJacob Faibussowitsch   PetscCall(TSDestroy(&(*ts)->quadraturets));
26599566063dSJacob Faibussowitsch   PetscCall(PetscHeaderDestroy(ts));
26603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2661d763cef2SBarry Smith }
2662d763cef2SBarry Smith 
2663d8e5e3e6SSatish Balay /*@
2664bcf0153eSBarry Smith   TSGetSNES - Returns the `SNES` (nonlinear solver) associated with
2665bcf0153eSBarry Smith   a `TS` (timestepper) context. Valid only for nonlinear problems.
2666d763cef2SBarry Smith 
2667bcf0153eSBarry Smith   Not Collective, but snes is parallel if ts is parallel
2668d763cef2SBarry Smith 
2669d763cef2SBarry Smith   Input Parameter:
2670bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2671d763cef2SBarry Smith 
2672d763cef2SBarry Smith   Output Parameter:
2673d763cef2SBarry Smith . snes - the nonlinear solver context
2674d763cef2SBarry Smith 
2675d763cef2SBarry Smith   Level: beginner
2676d763cef2SBarry Smith 
2677bcf0153eSBarry Smith   Notes:
2678bcf0153eSBarry Smith   The user can then directly manipulate the `SNES` context to set various
2679bcf0153eSBarry Smith   options, etc.  Likewise, the user can then extract and manipulate the
2680bcf0153eSBarry Smith   `KSP`, and `PC` contexts as well.
2681bcf0153eSBarry Smith 
2682bcf0153eSBarry Smith   `TSGetSNES()` does not work for integrators that do not use `SNES`; in
2683195e9b02SBarry Smith   this case `TSGetSNES()` returns `NULL` in `snes`.
2684bcf0153eSBarry Smith 
26851cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `SNES`, `TSCreate()`, `TSSetUp()`, `TSSolve()`
2686d763cef2SBarry Smith @*/
2687d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetSNES(TS ts, SNES *snes)
2688d71ae5a4SJacob Faibussowitsch {
2689d763cef2SBarry Smith   PetscFunctionBegin;
26900700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
26914f572ea9SToby Isaac   PetscAssertPointer(snes, 2);
2692d372ba47SLisandro Dalcin   if (!ts->snes) {
26939566063dSJacob Faibussowitsch     PetscCall(SNESCreate(PetscObjectComm((PetscObject)ts), &ts->snes));
26949566063dSJacob Faibussowitsch     PetscCall(PetscObjectSetOptions((PetscObject)ts->snes, ((PetscObject)ts)->options));
26959566063dSJacob Faibussowitsch     PetscCall(SNESSetFunction(ts->snes, NULL, SNESTSFormFunction, ts));
26969566063dSJacob Faibussowitsch     PetscCall(PetscObjectIncrementTabLevel((PetscObject)ts->snes, (PetscObject)ts, 1));
26979566063dSJacob Faibussowitsch     if (ts->dm) PetscCall(SNESSetDM(ts->snes, ts->dm));
26981e66621cSBarry Smith     if (ts->problem_type == TS_LINEAR) PetscCall(SNESSetType(ts->snes, SNESKSPONLY));
2699d372ba47SLisandro Dalcin   }
2700d763cef2SBarry Smith   *snes = ts->snes;
27013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2702d763cef2SBarry Smith }
2703d763cef2SBarry Smith 
2704deb2cd25SJed Brown /*@
2705bcf0153eSBarry Smith   TSSetSNES - Set the `SNES` (nonlinear solver) to be used by the timestepping context
2706deb2cd25SJed Brown 
2707deb2cd25SJed Brown   Collective
2708deb2cd25SJed Brown 
2709d8d19677SJose E. Roman   Input Parameters:
2710bcf0153eSBarry Smith + ts   - the `TS` context obtained from `TSCreate()`
2711deb2cd25SJed Brown - snes - the nonlinear solver context
2712deb2cd25SJed Brown 
2713deb2cd25SJed Brown   Level: developer
2714deb2cd25SJed Brown 
2715bcf0153eSBarry Smith   Note:
2716bcf0153eSBarry Smith   Most users should have the `TS` created by calling `TSGetSNES()`
2717bcf0153eSBarry Smith 
27181cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `SNES`, `TSCreate()`, `TSSetUp()`, `TSSolve()`, `TSGetSNES()`
2719deb2cd25SJed Brown @*/
2720d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetSNES(TS ts, SNES snes)
2721d71ae5a4SJacob Faibussowitsch {
2722d1e9a80fSBarry Smith   PetscErrorCode (*func)(SNES, Vec, Mat, Mat, void *);
2723deb2cd25SJed Brown 
2724deb2cd25SJed Brown   PetscFunctionBegin;
2725deb2cd25SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2726deb2cd25SJed Brown   PetscValidHeaderSpecific(snes, SNES_CLASSID, 2);
27279566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)snes));
27289566063dSJacob Faibussowitsch   PetscCall(SNESDestroy(&ts->snes));
2729bbd56ea5SKarl Rupp 
2730deb2cd25SJed Brown   ts->snes = snes;
2731bbd56ea5SKarl Rupp 
27329566063dSJacob Faibussowitsch   PetscCall(SNESSetFunction(ts->snes, NULL, SNESTSFormFunction, ts));
27339566063dSJacob Faibussowitsch   PetscCall(SNESGetJacobian(ts->snes, NULL, NULL, &func, NULL));
27341e66621cSBarry Smith   if (func == SNESTSFormJacobian) PetscCall(SNESSetJacobian(ts->snes, NULL, NULL, SNESTSFormJacobian, ts));
27353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2736deb2cd25SJed Brown }
2737deb2cd25SJed Brown 
2738d8e5e3e6SSatish Balay /*@
2739bcf0153eSBarry Smith   TSGetKSP - Returns the `KSP` (linear solver) associated with
2740bcf0153eSBarry Smith   a `TS` (timestepper) context.
2741d763cef2SBarry Smith 
2742195e9b02SBarry Smith   Not Collective, but `ksp` is parallel if `ts` is parallel
2743d763cef2SBarry Smith 
2744d763cef2SBarry Smith   Input Parameter:
2745bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2746d763cef2SBarry Smith 
2747d763cef2SBarry Smith   Output Parameter:
274894b7f48cSBarry Smith . ksp - the nonlinear solver context
2749d763cef2SBarry Smith 
2750d763cef2SBarry Smith   Level: beginner
2751d763cef2SBarry Smith 
2752bcf0153eSBarry Smith   Notes:
2753bcf0153eSBarry Smith   The user can then directly manipulate the `KSP` context to set various
2754bcf0153eSBarry Smith   options, etc.  Likewise, the user can then extract and manipulate the
2755bcf0153eSBarry Smith   `PC` context as well.
2756bcf0153eSBarry Smith 
2757bcf0153eSBarry Smith   `TSGetKSP()` does not work for integrators that do not use `KSP`;
2758195e9b02SBarry Smith   in this case `TSGetKSP()` returns `NULL` in `ksp`.
2759bcf0153eSBarry Smith 
27601cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `SNES`, `KSP`, `TSCreate()`, `TSSetUp()`, `TSSolve()`, `TSGetSNES()`
2761d763cef2SBarry Smith @*/
2762d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetKSP(TS ts, KSP *ksp)
2763d71ae5a4SJacob Faibussowitsch {
2764089b2837SJed Brown   SNES snes;
2765d372ba47SLisandro Dalcin 
2766d763cef2SBarry Smith   PetscFunctionBegin;
27670700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
27684f572ea9SToby Isaac   PetscAssertPointer(ksp, 2);
27693c633725SBarry Smith   PetscCheck(((PetscObject)ts)->type_name, PETSC_COMM_SELF, PETSC_ERR_ARG_NULL, "KSP is not created yet. Call TSSetType() first");
27703c633725SBarry Smith   PetscCheck(ts->problem_type == TS_LINEAR, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Linear only; use TSGetSNES()");
27719566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
27729566063dSJacob Faibussowitsch   PetscCall(SNESGetKSP(snes, ksp));
27733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2774d763cef2SBarry Smith }
2775d763cef2SBarry Smith 
2776d763cef2SBarry Smith /* ----------- Routines to set solver parameters ---------- */
2777d763cef2SBarry Smith 
2778adb62b0dSMatthew Knepley /*@
2779618ce8baSLisandro Dalcin   TSSetMaxSteps - Sets the maximum number of steps to use.
2780618ce8baSLisandro Dalcin 
2781c3339decSBarry Smith   Logically Collective
2782618ce8baSLisandro Dalcin 
2783618ce8baSLisandro Dalcin   Input Parameters:
2784bcf0153eSBarry Smith + ts       - the `TS` context obtained from `TSCreate()`
2785618ce8baSLisandro Dalcin - maxsteps - maximum number of steps to use
2786618ce8baSLisandro Dalcin 
2787bcf0153eSBarry Smith   Options Database Key:
2788618ce8baSLisandro Dalcin . -ts_max_steps <maxsteps> - Sets maxsteps
2789618ce8baSLisandro Dalcin 
2790618ce8baSLisandro Dalcin   Level: intermediate
2791618ce8baSLisandro Dalcin 
2792bcf0153eSBarry Smith   Note:
2793bcf0153eSBarry Smith   The default maximum number of steps is 5000
2794bcf0153eSBarry Smith 
27951cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetMaxSteps()`, `TSSetMaxTime()`, `TSSetExactFinalTime()`
2796618ce8baSLisandro Dalcin @*/
2797d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetMaxSteps(TS ts, PetscInt maxsteps)
2798d71ae5a4SJacob Faibussowitsch {
2799618ce8baSLisandro Dalcin   PetscFunctionBegin;
2800618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2801618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveInt(ts, maxsteps, 2);
28023c633725SBarry Smith   PetscCheck(maxsteps >= 0, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_OUTOFRANGE, "Maximum number of steps must be non-negative");
2803618ce8baSLisandro Dalcin   ts->max_steps = maxsteps;
28043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2805618ce8baSLisandro Dalcin }
2806618ce8baSLisandro Dalcin 
2807618ce8baSLisandro Dalcin /*@
2808618ce8baSLisandro Dalcin   TSGetMaxSteps - Gets the maximum number of steps to use.
2809618ce8baSLisandro Dalcin 
2810618ce8baSLisandro Dalcin   Not Collective
2811618ce8baSLisandro Dalcin 
28122fe279fdSBarry Smith   Input Parameter:
2813bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2814618ce8baSLisandro Dalcin 
2815618ce8baSLisandro Dalcin   Output Parameter:
2816618ce8baSLisandro Dalcin . maxsteps - maximum number of steps to use
2817618ce8baSLisandro Dalcin 
2818618ce8baSLisandro Dalcin   Level: advanced
2819618ce8baSLisandro Dalcin 
28201cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetMaxSteps()`, `TSGetMaxTime()`, `TSSetMaxTime()`
2821618ce8baSLisandro Dalcin @*/
2822d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetMaxSteps(TS ts, PetscInt *maxsteps)
2823d71ae5a4SJacob Faibussowitsch {
2824618ce8baSLisandro Dalcin   PetscFunctionBegin;
2825618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
28264f572ea9SToby Isaac   PetscAssertPointer(maxsteps, 2);
2827618ce8baSLisandro Dalcin   *maxsteps = ts->max_steps;
28283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2829618ce8baSLisandro Dalcin }
2830618ce8baSLisandro Dalcin 
2831618ce8baSLisandro Dalcin /*@
2832618ce8baSLisandro Dalcin   TSSetMaxTime - Sets the maximum (or final) time for timestepping.
2833618ce8baSLisandro Dalcin 
2834c3339decSBarry Smith   Logically Collective
2835618ce8baSLisandro Dalcin 
2836618ce8baSLisandro Dalcin   Input Parameters:
2837bcf0153eSBarry Smith + ts      - the `TS` context obtained from `TSCreate()`
2838618ce8baSLisandro Dalcin - maxtime - final time to step to
2839618ce8baSLisandro Dalcin 
2840bcf0153eSBarry Smith   Options Database Key:
2841ef85077eSLisandro Dalcin . -ts_max_time <maxtime> - Sets maxtime
2842618ce8baSLisandro Dalcin 
2843bcf0153eSBarry Smith   Level: intermediate
2844bcf0153eSBarry Smith 
2845618ce8baSLisandro Dalcin   Notes:
2846618ce8baSLisandro Dalcin   The default maximum time is 5.0
2847618ce8baSLisandro Dalcin 
28481cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetMaxTime()`, `TSSetMaxSteps()`, `TSSetExactFinalTime()`
2849618ce8baSLisandro Dalcin @*/
2850d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetMaxTime(TS ts, PetscReal maxtime)
2851d71ae5a4SJacob Faibussowitsch {
2852618ce8baSLisandro Dalcin   PetscFunctionBegin;
2853618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2854618ce8baSLisandro Dalcin   PetscValidLogicalCollectiveReal(ts, maxtime, 2);
2855618ce8baSLisandro Dalcin   ts->max_time = maxtime;
28563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2857618ce8baSLisandro Dalcin }
2858618ce8baSLisandro Dalcin 
2859618ce8baSLisandro Dalcin /*@
2860618ce8baSLisandro Dalcin   TSGetMaxTime - Gets the maximum (or final) time for timestepping.
2861618ce8baSLisandro Dalcin 
2862618ce8baSLisandro Dalcin   Not Collective
2863618ce8baSLisandro Dalcin 
28642fe279fdSBarry Smith   Input Parameter:
2865bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
2866618ce8baSLisandro Dalcin 
2867618ce8baSLisandro Dalcin   Output Parameter:
2868618ce8baSLisandro Dalcin . maxtime - final time to step to
2869618ce8baSLisandro Dalcin 
2870618ce8baSLisandro Dalcin   Level: advanced
2871618ce8baSLisandro Dalcin 
28721cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetMaxTime()`, `TSGetMaxSteps()`, `TSSetMaxSteps()`
2873618ce8baSLisandro Dalcin @*/
2874d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetMaxTime(TS ts, PetscReal *maxtime)
2875d71ae5a4SJacob Faibussowitsch {
2876618ce8baSLisandro Dalcin   PetscFunctionBegin;
2877618ce8baSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
28784f572ea9SToby Isaac   PetscAssertPointer(maxtime, 2);
2879618ce8baSLisandro Dalcin   *maxtime = ts->max_time;
28803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2881618ce8baSLisandro Dalcin }
2882618ce8baSLisandro Dalcin 
288314d0ab18SJacob Faibussowitsch // PetscClangLinter pragma disable: -fdoc-*
2884618ce8baSLisandro Dalcin /*@
2885bcf0153eSBarry Smith   TSSetInitialTimeStep - Deprecated, use `TSSetTime()` and `TSSetTimeStep()`.
2886edc382c3SSatish Balay 
2887edc382c3SSatish Balay   Level: deprecated
2888edc382c3SSatish Balay 
2889aaa6c58dSLisandro Dalcin @*/
2890d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetInitialTimeStep(TS ts, PetscReal initial_time, PetscReal time_step)
2891d71ae5a4SJacob Faibussowitsch {
2892aaa6c58dSLisandro Dalcin   PetscFunctionBegin;
2893aaa6c58dSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
28949566063dSJacob Faibussowitsch   PetscCall(TSSetTime(ts, initial_time));
28959566063dSJacob Faibussowitsch   PetscCall(TSSetTimeStep(ts, time_step));
28963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2897aaa6c58dSLisandro Dalcin }
2898aaa6c58dSLisandro Dalcin 
289914d0ab18SJacob Faibussowitsch // PetscClangLinter pragma disable: -fdoc-*
2900aaa6c58dSLisandro Dalcin /*@
2901bcf0153eSBarry Smith   TSGetDuration - Deprecated, use `TSGetMaxSteps()` and `TSGetMaxTime()`.
2902edc382c3SSatish Balay 
2903edc382c3SSatish Balay   Level: deprecated
2904edc382c3SSatish Balay 
2905adb62b0dSMatthew Knepley @*/
2906d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetDuration(TS ts, PetscInt *maxsteps, PetscReal *maxtime)
2907d71ae5a4SJacob Faibussowitsch {
2908adb62b0dSMatthew Knepley   PetscFunctionBegin;
29090700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2910abc0a331SBarry Smith   if (maxsteps) {
29114f572ea9SToby Isaac     PetscAssertPointer(maxsteps, 2);
2912adb62b0dSMatthew Knepley     *maxsteps = ts->max_steps;
2913adb62b0dSMatthew Knepley   }
2914abc0a331SBarry Smith   if (maxtime) {
29154f572ea9SToby Isaac     PetscAssertPointer(maxtime, 3);
2916adb62b0dSMatthew Knepley     *maxtime = ts->max_time;
2917adb62b0dSMatthew Knepley   }
29183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2919adb62b0dSMatthew Knepley }
2920adb62b0dSMatthew Knepley 
292114d0ab18SJacob Faibussowitsch // PetscClangLinter pragma disable: -fdoc-*
2922d763cef2SBarry Smith /*@
2923bcf0153eSBarry Smith   TSSetDuration - Deprecated, use `TSSetMaxSteps()` and `TSSetMaxTime()`.
2924edc382c3SSatish Balay 
2925edc382c3SSatish Balay   Level: deprecated
2926edc382c3SSatish Balay 
2927d763cef2SBarry Smith @*/
2928d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetDuration(TS ts, PetscInt maxsteps, PetscReal maxtime)
2929d71ae5a4SJacob Faibussowitsch {
2930d763cef2SBarry Smith   PetscFunctionBegin;
29310700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
2932c5eb9154SBarry Smith   PetscValidLogicalCollectiveInt(ts, maxsteps, 2);
2933064a246eSJacob Faibussowitsch   PetscValidLogicalCollectiveReal(ts, maxtime, 3);
293439b7ec4bSSean Farley   if (maxsteps >= 0) ts->max_steps = maxsteps;
293513bcc0bdSJacob Faibussowitsch   if (maxtime != (PetscReal)PETSC_DEFAULT) ts->max_time = maxtime;
29363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2937d763cef2SBarry Smith }
2938d763cef2SBarry Smith 
293914d0ab18SJacob Faibussowitsch // PetscClangLinter pragma disable: -fdoc-*
2940d763cef2SBarry Smith /*@
2941bcf0153eSBarry Smith   TSGetTimeStepNumber - Deprecated, use `TSGetStepNumber()`.
2942edc382c3SSatish Balay 
2943edc382c3SSatish Balay   Level: deprecated
2944edc382c3SSatish Balay 
29455c5f5948SLisandro Dalcin @*/
2946d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTimeStepNumber(TS ts, PetscInt *steps)
2947d71ae5a4SJacob Faibussowitsch {
29489371c9d4SSatish Balay   return TSGetStepNumber(ts, steps);
29499371c9d4SSatish Balay }
29505c5f5948SLisandro Dalcin 
295114d0ab18SJacob Faibussowitsch // PetscClangLinter pragma disable: -fdoc-*
295219eac22cSLisandro Dalcin /*@
2953bcf0153eSBarry Smith   TSGetTotalSteps - Deprecated, use `TSGetStepNumber()`.
2954edc382c3SSatish Balay 
2955edc382c3SSatish Balay   Level: deprecated
2956edc382c3SSatish Balay 
29574f4e0956SLisandro Dalcin @*/
2958d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTotalSteps(TS ts, PetscInt *steps)
2959d71ae5a4SJacob Faibussowitsch {
29609371c9d4SSatish Balay   return TSGetStepNumber(ts, steps);
29619371c9d4SSatish Balay }
29624f4e0956SLisandro Dalcin 
29634f4e0956SLisandro Dalcin /*@
2964d763cef2SBarry Smith   TSSetSolution - Sets the initial solution vector
2965bcf0153eSBarry Smith   for use by the `TS` routines.
2966d763cef2SBarry Smith 
2967c3339decSBarry Smith   Logically Collective
2968d763cef2SBarry Smith 
2969d763cef2SBarry Smith   Input Parameters:
2970bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()`
29710910c330SBarry Smith - u  - the solution vector
2972d763cef2SBarry Smith 
2973d763cef2SBarry Smith   Level: beginner
2974d763cef2SBarry Smith 
29751cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `TSGetSolution()`, `TSCreate()`
2976d763cef2SBarry Smith @*/
2977d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetSolution(TS ts, Vec u)
2978d71ae5a4SJacob Faibussowitsch {
2979496e6a7aSJed Brown   DM dm;
29808737fe31SLisandro Dalcin 
2981d763cef2SBarry Smith   PetscFunctionBegin;
29820700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
29830910c330SBarry Smith   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
29849566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)u));
29859566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&ts->vec_sol));
29860910c330SBarry Smith   ts->vec_sol = u;
2987bbd56ea5SKarl Rupp 
29889566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
29899566063dSJacob Faibussowitsch   PetscCall(DMShellSetGlobalVector(dm, u));
29903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2991d763cef2SBarry Smith }
2992d763cef2SBarry Smith 
2993ac226902SBarry Smith /*@C
2994000e7ae3SMatthew Knepley   TSSetPreStep - Sets the general-purpose function
29953f2090d5SJed Brown   called once at the beginning of each time step.
2996000e7ae3SMatthew Knepley 
2997c3339decSBarry Smith   Logically Collective
2998000e7ae3SMatthew Knepley 
2999000e7ae3SMatthew Knepley   Input Parameters:
3000bcf0153eSBarry Smith + ts   - The `TS` context obtained from `TSCreate()`
3001000e7ae3SMatthew Knepley - func - The function
3002000e7ae3SMatthew Knepley 
300320f4b53cSBarry Smith   Calling sequence of `func`:
300414d0ab18SJacob Faibussowitsch . ts - the `TS` context
3005000e7ae3SMatthew Knepley 
3006000e7ae3SMatthew Knepley   Level: intermediate
3007000e7ae3SMatthew Knepley 
30081cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPreStage()`, `TSSetPostStage()`, `TSSetPostStep()`, `TSStep()`, `TSRestartStep()`
3009000e7ae3SMatthew Knepley @*/
301014d0ab18SJacob Faibussowitsch PetscErrorCode TSSetPreStep(TS ts, PetscErrorCode (*func)(TS ts))
3011d71ae5a4SJacob Faibussowitsch {
3012000e7ae3SMatthew Knepley   PetscFunctionBegin;
30130700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3014ae60f76fSBarry Smith   ts->prestep = func;
30153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3016000e7ae3SMatthew Knepley }
3017000e7ae3SMatthew Knepley 
301809ee8438SJed Brown /*@
3019bcf0153eSBarry Smith   TSPreStep - Runs the user-defined pre-step function provided with `TSSetPreStep()`
30203f2090d5SJed Brown 
3021c3339decSBarry Smith   Collective
30223f2090d5SJed Brown 
30232fe279fdSBarry Smith   Input Parameter:
3024bcf0153eSBarry Smith . ts - The `TS` context obtained from `TSCreate()`
30253f2090d5SJed Brown 
30263f2090d5SJed Brown   Level: developer
30273f2090d5SJed Brown 
3028bcf0153eSBarry Smith   Note:
3029bcf0153eSBarry Smith   `TSPreStep()` is typically used within time stepping implementations,
3030bcf0153eSBarry Smith   so most users would not generally call this routine themselves.
3031bcf0153eSBarry Smith 
30321cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPreStep()`, `TSPreStage()`, `TSPostStage()`, `TSPostStep()`
30333f2090d5SJed Brown @*/
3034d71ae5a4SJacob Faibussowitsch PetscErrorCode TSPreStep(TS ts)
3035d71ae5a4SJacob Faibussowitsch {
30363f2090d5SJed Brown   PetscFunctionBegin;
30370700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3038ae60f76fSBarry Smith   if (ts->prestep) {
30395efd42a4SStefano Zampini     Vec              U;
3040ef8d1ce0SJohann Rudi     PetscObjectId    idprev;
3041ef8d1ce0SJohann Rudi     PetscBool        sameObject;
30425efd42a4SStefano Zampini     PetscObjectState sprev, spost;
30435efd42a4SStefano Zampini 
30449566063dSJacob Faibussowitsch     PetscCall(TSGetSolution(ts, &U));
30459566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetId((PetscObject)U, &idprev));
30469566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateGet((PetscObject)U, &sprev));
304725e27a38SBarry Smith     PetscCallBack("TS callback preset", (*ts->prestep)(ts));
30489566063dSJacob Faibussowitsch     PetscCall(TSGetSolution(ts, &U));
30499566063dSJacob Faibussowitsch     PetscCall(PetscObjectCompareId((PetscObject)U, idprev, &sameObject));
30509566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateGet((PetscObject)U, &spost));
30519566063dSJacob Faibussowitsch     if (!sameObject || sprev != spost) PetscCall(TSRestartStep(ts));
3052312ce896SJed Brown   }
30533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30543f2090d5SJed Brown }
30553f2090d5SJed Brown 
3056b8123daeSJed Brown /*@C
3057b8123daeSJed Brown   TSSetPreStage - Sets the general-purpose function
3058b8123daeSJed Brown   called once at the beginning of each stage.
3059b8123daeSJed Brown 
3060c3339decSBarry Smith   Logically Collective
3061b8123daeSJed Brown 
3062b8123daeSJed Brown   Input Parameters:
3063bcf0153eSBarry Smith + ts   - The `TS` context obtained from `TSCreate()`
3064b8123daeSJed Brown - func - The function
3065b8123daeSJed Brown 
306620f4b53cSBarry Smith   Calling sequence of `func`:
306714d0ab18SJacob Faibussowitsch + ts        - the `TS` context
306814d0ab18SJacob Faibussowitsch - stagetime - the stage time
3069b8123daeSJed Brown 
3070b8123daeSJed Brown   Level: intermediate
3071b8123daeSJed Brown 
3072b8123daeSJed Brown   Note:
3073b8123daeSJed Brown   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3074bcf0153eSBarry Smith   The time step number being computed can be queried using `TSGetStepNumber()` and the total size of the step being
3075bcf0153eSBarry Smith   attempted can be obtained using `TSGetTimeStep()`. The time at the start of the step is available via `TSGetTime()`.
3076b8123daeSJed Brown 
30771cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPostStage()`, `TSSetPreStep()`, `TSSetPostStep()`, `TSGetApplicationContext()`
3078b8123daeSJed Brown @*/
307914d0ab18SJacob Faibussowitsch PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS ts, PetscReal stagetime))
3080d71ae5a4SJacob Faibussowitsch {
3081b8123daeSJed Brown   PetscFunctionBegin;
3082b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3083ae60f76fSBarry Smith   ts->prestage = func;
30843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3085b8123daeSJed Brown }
3086b8123daeSJed Brown 
30879be3e283SDebojyoti Ghosh /*@C
3088bcf0153eSBarry Smith   TSSetPostStage - Sets the general-purpose function, provided with `TSSetPostStep()`,
30899be3e283SDebojyoti Ghosh   called once at the end of each stage.
30909be3e283SDebojyoti Ghosh 
3091c3339decSBarry Smith   Logically Collective
30929be3e283SDebojyoti Ghosh 
30939be3e283SDebojyoti Ghosh   Input Parameters:
3094bcf0153eSBarry Smith + ts   - The `TS` context obtained from `TSCreate()`
30959be3e283SDebojyoti Ghosh - func - The function
30969be3e283SDebojyoti Ghosh 
309720f4b53cSBarry Smith   Calling sequence of `func`:
309814d0ab18SJacob Faibussowitsch + ts         - the `TS` context
309914d0ab18SJacob Faibussowitsch . stagetime  - the stage time
310014d0ab18SJacob Faibussowitsch . stageindex - the stage index
310114d0ab18SJacob Faibussowitsch - Y          - Array of vectors (of size = total number of stages) with the stage solutions
31029be3e283SDebojyoti Ghosh 
31039be3e283SDebojyoti Ghosh   Level: intermediate
31049be3e283SDebojyoti Ghosh 
31059be3e283SDebojyoti Ghosh   Note:
31069be3e283SDebojyoti Ghosh   There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
3107bcf0153eSBarry Smith   The time step number being computed can be queried using `TSGetStepNumber()` and the total size of the step being
3108bcf0153eSBarry Smith   attempted can be obtained using `TSGetTimeStep()`. The time at the start of the step is available via `TSGetTime()`.
31099be3e283SDebojyoti Ghosh 
31101cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPreStage()`, `TSSetPreStep()`, `TSSetPostStep()`, `TSGetApplicationContext()`
31119be3e283SDebojyoti Ghosh @*/
311214d0ab18SJacob Faibussowitsch PetscErrorCode TSSetPostStage(TS ts, PetscErrorCode (*func)(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y))
3113d71ae5a4SJacob Faibussowitsch {
31149be3e283SDebojyoti Ghosh   PetscFunctionBegin;
31159be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
31169be3e283SDebojyoti Ghosh   ts->poststage = func;
31173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31189be3e283SDebojyoti Ghosh }
31199be3e283SDebojyoti Ghosh 
3120c688d042SShri Abhyankar /*@C
3121c688d042SShri Abhyankar   TSSetPostEvaluate - Sets the general-purpose function
3122c688d042SShri Abhyankar   called once at the end of each step evaluation.
3123c688d042SShri Abhyankar 
3124c3339decSBarry Smith   Logically Collective
3125c688d042SShri Abhyankar 
3126c688d042SShri Abhyankar   Input Parameters:
3127bcf0153eSBarry Smith + ts   - The `TS` context obtained from `TSCreate()`
3128c688d042SShri Abhyankar - func - The function
3129c688d042SShri Abhyankar 
313020f4b53cSBarry Smith   Calling sequence of `func`:
313114d0ab18SJacob Faibussowitsch . ts - the `TS` context
3132c688d042SShri Abhyankar 
3133c688d042SShri Abhyankar   Level: intermediate
3134c688d042SShri Abhyankar 
3135c688d042SShri Abhyankar   Note:
3136bcf0153eSBarry Smith   Semantically, `TSSetPostEvaluate()` differs from `TSSetPostStep()` since the function it sets is called before event-handling
3137bcf0153eSBarry Smith   thus guaranteeing the same solution (computed by the time-stepper) will be passed to it. On the other hand, `TSPostStep()`
3138bcf0153eSBarry Smith   may be passed a different solution, possibly changed by the event handler. `TSPostEvaluate()` is called after the next step
3139bcf0153eSBarry Smith   solution is evaluated allowing to modify it, if need be. The solution can be obtained with `TSGetSolution()`, the time step
3140bcf0153eSBarry Smith   with `TSGetTimeStep()`, and the time at the start of the step is available via `TSGetTime()`
3141c688d042SShri Abhyankar 
31421cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPreStage()`, `TSSetPreStep()`, `TSSetPostStep()`, `TSGetApplicationContext()`
3143c688d042SShri Abhyankar @*/
314414d0ab18SJacob Faibussowitsch PetscErrorCode TSSetPostEvaluate(TS ts, PetscErrorCode (*func)(TS ts))
3145d71ae5a4SJacob Faibussowitsch {
3146c688d042SShri Abhyankar   PetscFunctionBegin;
3147c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3148c688d042SShri Abhyankar   ts->postevaluate = func;
31493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3150c688d042SShri Abhyankar }
3151c688d042SShri Abhyankar 
3152b8123daeSJed Brown /*@
3153bcf0153eSBarry Smith   TSPreStage - Runs the user-defined pre-stage function set using `TSSetPreStage()`
3154b8123daeSJed Brown 
3155c3339decSBarry Smith   Collective
3156b8123daeSJed Brown 
3157b8123daeSJed Brown   Input Parameters:
315814d0ab18SJacob Faibussowitsch + ts        - The `TS` context obtained from `TSCreate()`
315914d0ab18SJacob Faibussowitsch - stagetime - The absolute time of the current stage
3160b8123daeSJed Brown 
3161b8123daeSJed Brown   Level: developer
3162b8123daeSJed Brown 
3163bcf0153eSBarry Smith   Note:
3164bcf0153eSBarry Smith   `TSPreStage()` is typically used within time stepping implementations,
3165bcf0153eSBarry Smith   most users would not generally call this routine themselves.
3166bcf0153eSBarry Smith 
31671cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSPostStage()`, `TSSetPreStep()`, `TSPreStep()`, `TSPostStep()`
3168b8123daeSJed Brown @*/
3169d71ae5a4SJacob Faibussowitsch PetscErrorCode TSPreStage(TS ts, PetscReal stagetime)
3170d71ae5a4SJacob Faibussowitsch {
3171b8123daeSJed Brown   PetscFunctionBegin;
3172b8123daeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
31731e66621cSBarry Smith   if (ts->prestage) PetscCallBack("TS callback prestage", (*ts->prestage)(ts, stagetime));
31743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3175b8123daeSJed Brown }
3176b8123daeSJed Brown 
31779be3e283SDebojyoti Ghosh /*@
3178bcf0153eSBarry Smith   TSPostStage - Runs the user-defined post-stage function set using `TSSetPostStage()`
31799be3e283SDebojyoti Ghosh 
3180c3339decSBarry Smith   Collective
31819be3e283SDebojyoti Ghosh 
31829be3e283SDebojyoti Ghosh   Input Parameters:
318314d0ab18SJacob Faibussowitsch + ts         - The `TS` context obtained from `TSCreate()`
318414d0ab18SJacob Faibussowitsch . stagetime  - The absolute time of the current stage
318514d0ab18SJacob Faibussowitsch . stageindex - Stage number
318614d0ab18SJacob Faibussowitsch - Y          - Array of vectors (of size = total number of stages) with the stage solutions
31879be3e283SDebojyoti Ghosh 
31889be3e283SDebojyoti Ghosh   Level: developer
31899be3e283SDebojyoti Ghosh 
3190bcf0153eSBarry Smith   Note:
3191bcf0153eSBarry Smith   `TSPostStage()` is typically used within time stepping implementations,
3192bcf0153eSBarry Smith   most users would not generally call this routine themselves.
3193bcf0153eSBarry Smith 
31941cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSPreStage()`, `TSSetPreStep()`, `TSPreStep()`, `TSPostStep()`
31959be3e283SDebojyoti Ghosh @*/
3196d71ae5a4SJacob Faibussowitsch PetscErrorCode TSPostStage(TS ts, PetscReal stagetime, PetscInt stageindex, Vec *Y)
3197d71ae5a4SJacob Faibussowitsch {
31989be3e283SDebojyoti Ghosh   PetscFunctionBegin;
31999be3e283SDebojyoti Ghosh   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
32001e66621cSBarry Smith   if (ts->poststage) PetscCallBack("TS callback poststage", (*ts->poststage)(ts, stagetime, stageindex, Y));
32013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32029be3e283SDebojyoti Ghosh }
32039be3e283SDebojyoti Ghosh 
3204c688d042SShri Abhyankar /*@
3205bcf0153eSBarry Smith   TSPostEvaluate - Runs the user-defined post-evaluate function set using `TSSetPostEvaluate()`
3206c688d042SShri Abhyankar 
3207c3339decSBarry Smith   Collective
3208c688d042SShri Abhyankar 
32092fe279fdSBarry Smith   Input Parameter:
3210bcf0153eSBarry Smith . ts - The `TS` context obtained from `TSCreate()`
3211c688d042SShri Abhyankar 
3212c688d042SShri Abhyankar   Level: developer
3213c688d042SShri Abhyankar 
3214bcf0153eSBarry Smith   Note:
3215bcf0153eSBarry Smith   `TSPostEvaluate()` is typically used within time stepping implementations,
3216bcf0153eSBarry Smith   most users would not generally call this routine themselves.
3217bcf0153eSBarry Smith 
32181cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPostEvaluate()`, `TSSetPreStep()`, `TSPreStep()`, `TSPostStep()`
3219c688d042SShri Abhyankar @*/
3220d71ae5a4SJacob Faibussowitsch PetscErrorCode TSPostEvaluate(TS ts)
3221d71ae5a4SJacob Faibussowitsch {
3222c688d042SShri Abhyankar   PetscFunctionBegin;
3223c688d042SShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3224c688d042SShri Abhyankar   if (ts->postevaluate) {
3225dcb233daSLisandro Dalcin     Vec              U;
3226dcb233daSLisandro Dalcin     PetscObjectState sprev, spost;
3227dcb233daSLisandro Dalcin 
32289566063dSJacob Faibussowitsch     PetscCall(TSGetSolution(ts, &U));
32299566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateGet((PetscObject)U, &sprev));
323025e27a38SBarry Smith     PetscCallBack("TS callback postevaluate", (*ts->postevaluate)(ts));
32319566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateGet((PetscObject)U, &spost));
32329566063dSJacob Faibussowitsch     if (sprev != spost) PetscCall(TSRestartStep(ts));
3233c688d042SShri Abhyankar   }
32343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3235c688d042SShri Abhyankar }
3236c688d042SShri Abhyankar 
3237ac226902SBarry Smith /*@C
3238000e7ae3SMatthew Knepley   TSSetPostStep - Sets the general-purpose function
32393f2090d5SJed Brown   called once at the end of each time step.
3240000e7ae3SMatthew Knepley 
3241c3339decSBarry Smith   Logically Collective
3242000e7ae3SMatthew Knepley 
3243000e7ae3SMatthew Knepley   Input Parameters:
3244bcf0153eSBarry Smith + ts   - The `TS` context obtained from `TSCreate()`
3245000e7ae3SMatthew Knepley - func - The function
3246000e7ae3SMatthew Knepley 
324720f4b53cSBarry Smith   Calling sequence of `func`:
324814d0ab18SJacob Faibussowitsch . ts - the `TS` context
3249000e7ae3SMatthew Knepley 
3250000e7ae3SMatthew Knepley   Level: intermediate
3251000e7ae3SMatthew Knepley 
3252bcf0153eSBarry Smith   Note:
3253195e9b02SBarry Smith   The function set by `TSSetPostStep()` is called after each successful step. The solution vector
3254bcf0153eSBarry Smith   obtained by `TSGetSolution()` may be different than that computed at the step end if the event handler
3255bcf0153eSBarry Smith   locates an event and `TSPostEvent()` modifies it. Use `TSSetPostEvaluate()` if an unmodified solution is needed instead.
3256bcf0153eSBarry Smith 
32571cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostEvaluate()`, `TSGetTimeStep()`, `TSGetStepNumber()`, `TSGetTime()`, `TSRestartStep()`
3258000e7ae3SMatthew Knepley @*/
325914d0ab18SJacob Faibussowitsch PetscErrorCode TSSetPostStep(TS ts, PetscErrorCode (*func)(TS ts))
3260d71ae5a4SJacob Faibussowitsch {
3261000e7ae3SMatthew Knepley   PetscFunctionBegin;
32620700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3263ae60f76fSBarry Smith   ts->poststep = func;
32643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3265000e7ae3SMatthew Knepley }
3266000e7ae3SMatthew Knepley 
326709ee8438SJed Brown /*@
3268195e9b02SBarry Smith   TSPostStep - Runs the user-defined post-step function that was set with `TSSetPostStep()`
32693f2090d5SJed Brown 
3270c3339decSBarry Smith   Collective
32713f2090d5SJed Brown 
32722fe279fdSBarry Smith   Input Parameter:
3273bcf0153eSBarry Smith . ts - The `TS` context obtained from `TSCreate()`
32743f2090d5SJed Brown 
3275bcf0153eSBarry Smith   Note:
3276bcf0153eSBarry Smith   `TSPostStep()` is typically used within time stepping implementations,
32773f2090d5SJed Brown   so most users would not generally call this routine themselves.
32783f2090d5SJed Brown 
32793f2090d5SJed Brown   Level: developer
32803f2090d5SJed Brown 
32811cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostEvaluate()`, `TSGetTimeStep()`, `TSGetStepNumber()`, `TSGetTime()`, `TSSetPotsStep()`
32823f2090d5SJed Brown @*/
3283d71ae5a4SJacob Faibussowitsch PetscErrorCode TSPostStep(TS ts)
3284d71ae5a4SJacob Faibussowitsch {
32853f2090d5SJed Brown   PetscFunctionBegin;
32860700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3287ae60f76fSBarry Smith   if (ts->poststep) {
32885efd42a4SStefano Zampini     Vec              U;
3289ef8d1ce0SJohann Rudi     PetscObjectId    idprev;
3290ef8d1ce0SJohann Rudi     PetscBool        sameObject;
32915efd42a4SStefano Zampini     PetscObjectState sprev, spost;
32925efd42a4SStefano Zampini 
32939566063dSJacob Faibussowitsch     PetscCall(TSGetSolution(ts, &U));
32949566063dSJacob Faibussowitsch     PetscCall(PetscObjectGetId((PetscObject)U, &idprev));
32959566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateGet((PetscObject)U, &sprev));
329625e27a38SBarry Smith     PetscCallBack("TS callback poststep", (*ts->poststep)(ts));
32979566063dSJacob Faibussowitsch     PetscCall(TSGetSolution(ts, &U));
32989566063dSJacob Faibussowitsch     PetscCall(PetscObjectCompareId((PetscObject)U, idprev, &sameObject));
32999566063dSJacob Faibussowitsch     PetscCall(PetscObjectStateGet((PetscObject)U, &spost));
33009566063dSJacob Faibussowitsch     if (!sameObject || sprev != spost) PetscCall(TSRestartStep(ts));
330172ac3e02SJed Brown   }
33023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
33033f2090d5SJed Brown }
33043f2090d5SJed Brown 
3305cd652676SJed Brown /*@
3306cd652676SJed Brown   TSInterpolate - Interpolate the solution computed during the previous step to an arbitrary location in the interval
3307cd652676SJed Brown 
3308c3339decSBarry Smith   Collective
3309cd652676SJed Brown 
33104165533cSJose E. Roman   Input Parameters:
3311cd652676SJed Brown + ts - time stepping context
3312cd652676SJed Brown - t  - time to interpolate to
3313cd652676SJed Brown 
33144165533cSJose E. Roman   Output Parameter:
33150910c330SBarry Smith . U - state at given time
3316cd652676SJed Brown 
3317cd652676SJed Brown   Level: intermediate
3318cd652676SJed Brown 
3319b43aa488SJacob Faibussowitsch   Developer Notes:
3320bcf0153eSBarry Smith   `TSInterpolate()` and the storing of previous steps/stages should be generalized to support delay differential equations and continuous adjoints.
3321cd652676SJed Brown 
33221cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetExactFinalTime()`, `TSSolve()`
3323cd652676SJed Brown @*/
3324d71ae5a4SJacob Faibussowitsch PetscErrorCode TSInterpolate(TS ts, PetscReal t, Vec U)
3325d71ae5a4SJacob Faibussowitsch {
3326cd652676SJed Brown   PetscFunctionBegin;
3327cd652676SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3328b06615a5SLisandro Dalcin   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
332963a3b9bcSJacob Faibussowitsch   PetscCheck(t >= ts->ptime_prev && t <= ts->ptime, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_OUTOFRANGE, "Requested time %g not in last time steps [%g,%g]", (double)t, (double)ts->ptime_prev, (double)ts->ptime);
3330dbbe0bcdSBarry Smith   PetscUseTypeMethod(ts, interpolate, t, U);
33313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3332cd652676SJed Brown }
3333cd652676SJed Brown 
3334d763cef2SBarry Smith /*@
33356d9e5789SSean Farley   TSStep - Steps one time step
3336d763cef2SBarry Smith 
3337c3339decSBarry Smith   Collective
3338d763cef2SBarry Smith 
3339d763cef2SBarry Smith   Input Parameter:
3340bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
3341d763cef2SBarry Smith 
334227829d71SBarry Smith   Level: developer
3343d763cef2SBarry Smith 
3344b8123daeSJed Brown   Notes:
3345bcf0153eSBarry Smith   The public interface for the ODE/DAE solvers is `TSSolve()`, you should almost for sure be using that routine and not this routine.
334627829d71SBarry Smith 
3347bcf0153eSBarry Smith   The hook set using `TSSetPreStep()` is called before each attempt to take the step. In general, the time step size may
3348b8123daeSJed Brown   be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
3349b8123daeSJed Brown 
3350bcf0153eSBarry Smith   This may over-step the final time provided in `TSSetMaxTime()` depending on the time-step used. `TSSolve()` interpolates to exactly the
3351bcf0153eSBarry Smith   time provided in `TSSetMaxTime()`. One can use `TSInterpolate()` to determine an interpolated solution within the final timestep.
335225cb2221SBarry Smith 
33531cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetUp()`, `TSDestroy()`, `TSSolve()`, `TSSetPreStep()`, `TSSetPreStage()`, `TSSetPostStage()`, `TSInterpolate()`
3354d763cef2SBarry Smith @*/
3355d71ae5a4SJacob Faibussowitsch PetscErrorCode TSStep(TS ts)
3356d71ae5a4SJacob Faibussowitsch {
3357fffbeea8SBarry Smith   static PetscBool cite = PETSC_FALSE;
3358be5899b3SLisandro Dalcin   PetscReal        ptime;
3359d763cef2SBarry Smith 
3360d763cef2SBarry Smith   PetscFunctionBegin;
33610700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3362d0609cedSBarry Smith   PetscCall(PetscCitationsRegister("@article{tspaper,\n"
3363fffbeea8SBarry Smith                                    "  title         = {{PETSc/TS}: A Modern Scalable {DAE/ODE} Solver Library},\n"
3364f1d62c27SHong Zhang                                    "  author        = {Abhyankar, Shrirang and Brown, Jed and Constantinescu, Emil and Ghosh, Debojyoti and Smith, Barry F. and Zhang, Hong},\n"
3365f1d62c27SHong Zhang                                    "  journal       = {arXiv e-preprints},\n"
3366f1d62c27SHong Zhang                                    "  eprint        = {1806.01437},\n"
3367f1d62c27SHong Zhang                                    "  archivePrefix = {arXiv},\n"
33689371c9d4SSatish Balay                                    "  year          = {2018}\n}\n",
33699371c9d4SSatish Balay                                    &cite));
33709566063dSJacob Faibussowitsch   PetscCall(TSSetUp(ts));
33719566063dSJacob Faibussowitsch   PetscCall(TSTrajectorySetUp(ts->trajectory, ts));
3372ca4445c7SIlya Fursov   if (ts->tspan)
3373ca4445c7SIlya Fursov     ts->tspan->worktol = 0; /* In each step of TSSolve() 'tspan->worktol' will be meaningfully defined (later) only once:
3374ca4445c7SIlya Fursov                                                    in TSAdaptChoose() or TSEvent_dt_cap(), and then reused till the end of the step */
3375d405a339SMatthew Knepley 
33763c633725SBarry Smith   PetscCheck(ts->max_time < PETSC_MAX_REAL || ts->max_steps != PETSC_MAX_INT, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
33773c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_UNSPECIFIED, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSStep()");
33783c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP || ts->adapt, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
3379a6772fa2SLisandro Dalcin 
3380c61711c8SStefano Zampini   if (!ts->vec_sol0) PetscCall(VecDuplicate(ts->vec_sol, &ts->vec_sol0));
3381c61711c8SStefano Zampini   PetscCall(VecCopy(ts->vec_sol, ts->vec_sol0));
3382c61711c8SStefano Zampini   ts->time_step0 = ts->time_step;
3383c61711c8SStefano Zampini 
3384be5899b3SLisandro Dalcin   if (!ts->steps) ts->ptime_prev = ts->ptime;
33859371c9d4SSatish Balay   ptime = ts->ptime;
3386c61711c8SStefano Zampini 
33879371c9d4SSatish Balay   ts->ptime_prev_rollback = ts->ptime_prev;
33882808aa04SLisandro Dalcin   ts->reason              = TS_CONVERGED_ITERATING;
3389fc8dbba5SLisandro Dalcin 
33909566063dSJacob Faibussowitsch   PetscCall(PetscLogEventBegin(TS_Step, ts, 0, 0, 0));
3391dbbe0bcdSBarry Smith   PetscUseTypeMethod(ts, step);
33929566063dSJacob Faibussowitsch   PetscCall(PetscLogEventEnd(TS_Step, ts, 0, 0, 0));
3393fc8dbba5SLisandro Dalcin 
3394fc8dbba5SLisandro Dalcin   if (ts->reason >= 0) {
3395be5899b3SLisandro Dalcin     ts->ptime_prev = ptime;
33962808aa04SLisandro Dalcin     ts->steps++;
3397be5899b3SLisandro Dalcin     ts->steprollback = PETSC_FALSE;
339828d5b5d6SLisandro Dalcin     ts->steprestart  = PETSC_FALSE;
3399d2daff3dSHong Zhang   }
3400fc8dbba5SLisandro Dalcin 
34015c9bbc89SJed Brown   if (ts->reason < 0 && ts->errorifstepfailed) {
34025c9bbc89SJed Brown     PetscCall(TSMonitorCancel(ts));
34035c9bbc89SJed Brown     PetscCheck(ts->reason != TS_DIVERGED_NONLINEAR_SOLVE, 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]);
34045c9bbc89SJed Brown     SETERRQ(PetscObjectComm((PetscObject)ts), PETSC_ERR_NOT_CONVERGED, "TSStep has failed due to %s", TSConvergedReasons[ts->reason]);
34055c9bbc89SJed Brown   }
34063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
340708c7845fSBarry Smith }
340808c7845fSBarry Smith 
340908c7845fSBarry Smith /*@
34107cbde773SLisandro Dalcin   TSEvaluateWLTE - Evaluate the weighted local truncation error norm
34117cbde773SLisandro Dalcin   at the end of a time step with a given order of accuracy.
34127cbde773SLisandro Dalcin 
3413c3339decSBarry Smith   Collective
34147cbde773SLisandro Dalcin 
34154165533cSJose E. Roman   Input Parameters:
34167cbde773SLisandro Dalcin + ts        - time stepping context
3417bcf0153eSBarry Smith - wnormtype - norm type, either `NORM_2` or `NORM_INFINITY`
34187cbde773SLisandro Dalcin 
341997bb3fdcSJose E. Roman   Input/Output Parameter:
3420bcf0153eSBarry Smith . order - optional, desired order for the error evaluation or `PETSC_DECIDE`;
342197bb3fdcSJose E. Roman            on output, the actual order of the error evaluation
342297bb3fdcSJose E. Roman 
342397bb3fdcSJose E. Roman   Output Parameter:
342497bb3fdcSJose E. Roman . wlte - the weighted local truncation error norm
34257cbde773SLisandro Dalcin 
34267cbde773SLisandro Dalcin   Level: advanced
34277cbde773SLisandro Dalcin 
3428bcf0153eSBarry Smith   Note:
34297cbde773SLisandro Dalcin   If the timestepper cannot evaluate the error in a particular step
34307cbde773SLisandro Dalcin   (eg. in the first step or restart steps after event handling),
34317cbde773SLisandro Dalcin   this routine returns wlte=-1.0 .
34327cbde773SLisandro Dalcin 
34331cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSStep()`, `TSAdapt`, `TSErrorWeightedNorm()`
34347cbde773SLisandro Dalcin @*/
3435d71ae5a4SJacob Faibussowitsch PetscErrorCode TSEvaluateWLTE(TS ts, NormType wnormtype, PetscInt *order, PetscReal *wlte)
3436d71ae5a4SJacob Faibussowitsch {
34377cbde773SLisandro Dalcin   PetscFunctionBegin;
34387cbde773SLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
34397cbde773SLisandro Dalcin   PetscValidType(ts, 1);
3440064a246eSJacob Faibussowitsch   PetscValidLogicalCollectiveEnum(ts, wnormtype, 2);
34414f572ea9SToby Isaac   if (order) PetscAssertPointer(order, 3);
34427cbde773SLisandro Dalcin   if (order) PetscValidLogicalCollectiveInt(ts, *order, 3);
34434f572ea9SToby Isaac   PetscAssertPointer(wlte, 4);
34443c633725SBarry Smith   PetscCheck(wnormtype == NORM_2 || wnormtype == NORM_INFINITY, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "No support for norm type %s", NormTypes[wnormtype]);
3445dbbe0bcdSBarry Smith   PetscUseTypeMethod(ts, evaluatewlte, wnormtype, order, wlte);
34463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34477cbde773SLisandro Dalcin }
34487cbde773SLisandro Dalcin 
344905175c85SJed Brown /*@
345005175c85SJed Brown   TSEvaluateStep - Evaluate the solution at the end of a time step with a given order of accuracy.
345105175c85SJed Brown 
3452c3339decSBarry Smith   Collective
345305175c85SJed Brown 
34544165533cSJose E. Roman   Input Parameters:
34551c3436cfSJed Brown + ts    - time stepping context
34561c3436cfSJed Brown . order - desired order of accuracy
3457195e9b02SBarry Smith - done  - whether the step was evaluated at this order (pass `NULL` to generate an error if not available)
345805175c85SJed Brown 
34594165533cSJose E. Roman   Output Parameter:
34600910c330SBarry Smith . U - state at the end of the current step
346105175c85SJed Brown 
346205175c85SJed Brown   Level: advanced
346305175c85SJed Brown 
3464108c343cSJed Brown   Notes:
3465108c343cSJed Brown   This function cannot be called until all stages have been evaluated.
3466108c343cSJed Brown 
3467bcf0153eSBarry Smith   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.
3468bcf0153eSBarry Smith 
34691cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSStep()`, `TSAdapt`
347005175c85SJed Brown @*/
3471d71ae5a4SJacob Faibussowitsch PetscErrorCode TSEvaluateStep(TS ts, PetscInt order, Vec U, PetscBool *done)
3472d71ae5a4SJacob Faibussowitsch {
347305175c85SJed Brown   PetscFunctionBegin;
347405175c85SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
347505175c85SJed Brown   PetscValidType(ts, 1);
34760910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 3);
3477dbbe0bcdSBarry Smith   PetscUseTypeMethod(ts, evaluatestep, order, U, done);
34783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
347905175c85SJed Brown }
348005175c85SJed Brown 
3481aad739acSMatthew G. Knepley /*@C
34822e61be88SMatthew G. Knepley   TSGetComputeInitialCondition - Get the function used to automatically compute an initial condition for the timestepping.
3483aad739acSMatthew G. Knepley 
3484aad739acSMatthew G. Knepley   Not collective
3485aad739acSMatthew G. Knepley 
34864165533cSJose E. Roman   Input Parameter:
3487aad739acSMatthew G. Knepley . ts - time stepping context
3488aad739acSMatthew G. Knepley 
34894165533cSJose E. Roman   Output Parameter:
3490b43aa488SJacob Faibussowitsch . initCondition - The function which computes an initial condition
3491aad739acSMatthew G. Knepley 
349220f4b53cSBarry Smith   Calling sequence of `initCondition`:
349320f4b53cSBarry Smith + ts - The timestepping context
349420f4b53cSBarry Smith - u  - The input vector in which the initial condition is stored
3495bcf0153eSBarry Smith 
3496aad739acSMatthew G. Knepley   Level: advanced
3497aad739acSMatthew G. Knepley 
34981cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetComputeInitialCondition()`, `TSComputeInitialCondition()`
3499aad739acSMatthew G. Knepley @*/
350014d0ab18SJacob Faibussowitsch PetscErrorCode TSGetComputeInitialCondition(TS ts, PetscErrorCode (**initCondition)(TS ts, Vec u))
3501d71ae5a4SJacob Faibussowitsch {
3502aad739acSMatthew G. Knepley   PetscFunctionBegin;
3503aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
35044f572ea9SToby Isaac   PetscAssertPointer(initCondition, 2);
35052e61be88SMatthew G. Knepley   *initCondition = ts->ops->initcondition;
35063ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3507aad739acSMatthew G. Knepley }
3508aad739acSMatthew G. Knepley 
3509aad739acSMatthew G. Knepley /*@C
35102e61be88SMatthew G. Knepley   TSSetComputeInitialCondition - Set the function used to automatically compute an initial condition for the timestepping.
3511aad739acSMatthew G. Knepley 
3512c3339decSBarry Smith   Logically collective
3513aad739acSMatthew G. Knepley 
35144165533cSJose E. Roman   Input Parameters:
3515aad739acSMatthew G. Knepley + ts            - time stepping context
35162e61be88SMatthew G. Knepley - initCondition - The function which computes an initial condition
3517aad739acSMatthew G. Knepley 
351820f4b53cSBarry Smith   Calling sequence of `initCondition`:
3519a96d6ef6SBarry Smith + ts - The timestepping context
352014d0ab18SJacob Faibussowitsch - e  - The input vector in which the initial condition is to be stored
3521aad739acSMatthew G. Knepley 
3522bcf0153eSBarry Smith   Level: advanced
3523bcf0153eSBarry Smith 
35241cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetComputeInitialCondition()`, `TSComputeInitialCondition()`
3525aad739acSMatthew G. Knepley @*/
352614d0ab18SJacob Faibussowitsch PetscErrorCode TSSetComputeInitialCondition(TS ts, PetscErrorCode (*initCondition)(TS ts, Vec e))
3527d71ae5a4SJacob Faibussowitsch {
3528aad739acSMatthew G. Knepley   PetscFunctionBegin;
3529aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
35302e61be88SMatthew G. Knepley   PetscValidFunction(initCondition, 2);
35312e61be88SMatthew G. Knepley   ts->ops->initcondition = initCondition;
35323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3533aad739acSMatthew G. Knepley }
3534aad739acSMatthew G. Knepley 
3535aad739acSMatthew G. Knepley /*@
3536bcf0153eSBarry Smith   TSComputeInitialCondition - Compute an initial condition for the timestepping using the function previously set with `TSSetComputeInitialCondition()`
3537aad739acSMatthew G. Knepley 
3538c3339decSBarry Smith   Collective
3539aad739acSMatthew G. Knepley 
35404165533cSJose E. Roman   Input Parameters:
3541aad739acSMatthew G. Knepley + ts - time stepping context
3542bcf0153eSBarry Smith - u  - The `Vec` to store the condition in which will be used in `TSSolve()`
3543aad739acSMatthew G. Knepley 
3544aad739acSMatthew G. Knepley   Level: advanced
3545aad739acSMatthew G. Knepley 
35461cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetComputeInitialCondition()`, `TSSetComputeInitialCondition()`, `TSSolve()`
3547aad739acSMatthew G. Knepley @*/
3548d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeInitialCondition(TS ts, Vec u)
3549d71ae5a4SJacob Faibussowitsch {
3550aad739acSMatthew G. Knepley   PetscFunctionBegin;
3551aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3552aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3553dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, initcondition, u);
35543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3555aad739acSMatthew G. Knepley }
3556aad739acSMatthew G. Knepley 
3557aad739acSMatthew G. Knepley /*@C
3558aad739acSMatthew G. Knepley   TSGetComputeExactError - Get the function used to automatically compute the exact error for the timestepping.
3559aad739acSMatthew G. Knepley 
3560aad739acSMatthew G. Knepley   Not collective
3561aad739acSMatthew G. Knepley 
35624165533cSJose E. Roman   Input Parameter:
3563aad739acSMatthew G. Knepley . ts - time stepping context
3564aad739acSMatthew G. Knepley 
35654165533cSJose E. Roman   Output Parameter:
3566aad739acSMatthew G. Knepley . exactError - The function which computes the solution error
3567aad739acSMatthew G. Knepley 
356820f4b53cSBarry Smith   Calling sequence of `exactError`:
3569a96d6ef6SBarry Smith + ts - The timestepping context
3570a96d6ef6SBarry Smith . u  - The approximate solution vector
357120f4b53cSBarry Smith - e  - The vector in which the error is stored
3572aad739acSMatthew G. Knepley 
3573bcf0153eSBarry Smith   Level: advanced
3574bcf0153eSBarry Smith 
357542747ad1SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSComputeExactError()`
3576aad739acSMatthew G. Knepley @*/
357714d0ab18SJacob Faibussowitsch PetscErrorCode TSGetComputeExactError(TS ts, PetscErrorCode (**exactError)(TS ts, Vec u, Vec e))
3578d71ae5a4SJacob Faibussowitsch {
3579aad739acSMatthew G. Knepley   PetscFunctionBegin;
3580aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
35814f572ea9SToby Isaac   PetscAssertPointer(exactError, 2);
3582aad739acSMatthew G. Knepley   *exactError = ts->ops->exacterror;
35833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3584aad739acSMatthew G. Knepley }
3585aad739acSMatthew G. Knepley 
3586aad739acSMatthew G. Knepley /*@C
3587aad739acSMatthew G. Knepley   TSSetComputeExactError - Set the function used to automatically compute the exact error for the timestepping.
3588aad739acSMatthew G. Knepley 
3589c3339decSBarry Smith   Logically collective
3590aad739acSMatthew G. Knepley 
35914165533cSJose E. Roman   Input Parameters:
3592aad739acSMatthew G. Knepley + ts         - time stepping context
3593aad739acSMatthew G. Knepley - exactError - The function which computes the solution error
3594aad739acSMatthew G. Knepley 
359520f4b53cSBarry Smith   Calling sequence of `exactError`:
3596a96d6ef6SBarry Smith + ts - The timestepping context
3597a96d6ef6SBarry Smith . u  - The approximate solution vector
359820f4b53cSBarry Smith - e  - The  vector in which the error is stored
3599aad739acSMatthew G. Knepley 
3600bcf0153eSBarry Smith   Level: advanced
3601bcf0153eSBarry Smith 
36021cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetComputeExactError()`, `TSComputeExactError()`
3603aad739acSMatthew G. Knepley @*/
360414d0ab18SJacob Faibussowitsch PetscErrorCode TSSetComputeExactError(TS ts, PetscErrorCode (*exactError)(TS ts, Vec u, Vec e))
3605d71ae5a4SJacob Faibussowitsch {
3606aad739acSMatthew G. Knepley   PetscFunctionBegin;
3607aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3608f907fdbfSMatthew G. Knepley   PetscValidFunction(exactError, 2);
3609aad739acSMatthew G. Knepley   ts->ops->exacterror = exactError;
36103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3611aad739acSMatthew G. Knepley }
3612aad739acSMatthew G. Knepley 
3613aad739acSMatthew G. Knepley /*@
3614bcf0153eSBarry Smith   TSComputeExactError - Compute the solution error for the timestepping using the function previously set with `TSSetComputeExactError()`
3615aad739acSMatthew G. Knepley 
3616c3339decSBarry Smith   Collective
3617aad739acSMatthew G. Knepley 
36184165533cSJose E. Roman   Input Parameters:
3619aad739acSMatthew G. Knepley + ts - time stepping context
3620aad739acSMatthew G. Knepley . u  - The approximate solution
3621bcf0153eSBarry Smith - e  - The `Vec` used to store the error
3622aad739acSMatthew G. Knepley 
3623aad739acSMatthew G. Knepley   Level: advanced
3624aad739acSMatthew G. Knepley 
36251cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetComputeInitialCondition()`, `TSSetComputeInitialCondition()`, `TSSolve()`
3626aad739acSMatthew G. Knepley @*/
3627d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeExactError(TS ts, Vec u, Vec e)
3628d71ae5a4SJacob Faibussowitsch {
3629aad739acSMatthew G. Knepley   PetscFunctionBegin;
3630aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3631aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3632aad739acSMatthew G. Knepley   PetscValidHeaderSpecific(e, VEC_CLASSID, 3);
3633dbbe0bcdSBarry Smith   PetscTryTypeMethod(ts, exacterror, u, e);
36343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3635aad739acSMatthew G. Knepley }
3636aad739acSMatthew G. Knepley 
36376bd3a4fdSStefano Zampini /*@C
36386bd3a4fdSStefano Zampini   TSSetResize - Sets the resize callbacks.
36396bd3a4fdSStefano Zampini 
36406bd3a4fdSStefano Zampini   Logically Collective
36416bd3a4fdSStefano Zampini 
36426bd3a4fdSStefano Zampini   Input Parameters:
36436bd3a4fdSStefano Zampini + ts       - The `TS` context obtained from `TSCreate()`
36446bd3a4fdSStefano Zampini . setup    - The setup function
364514d0ab18SJacob Faibussowitsch . transfer - The transfer function
364614d0ab18SJacob Faibussowitsch - ctx      - [optional] The user-defined context
36476bd3a4fdSStefano Zampini 
36486bd3a4fdSStefano Zampini   Calling sequence of `setup`:
36498847d985SBarry Smith + ts     - the `TS` context
36506bd3a4fdSStefano Zampini . step   - the current step
36516bd3a4fdSStefano Zampini . time   - the current time
36526bd3a4fdSStefano Zampini . state  - the current vector of state
36536bd3a4fdSStefano Zampini . resize - (output parameter) `PETSC_TRUE` if need resizing, `PETSC_FALSE` otherwise
36546bd3a4fdSStefano Zampini - ctx    - user defined context
36556bd3a4fdSStefano Zampini 
36566bd3a4fdSStefano Zampini   Calling sequence of `transfer`:
36578847d985SBarry Smith + ts      - the `TS` context
36586bd3a4fdSStefano Zampini . nv      - the number of vectors to be transferred
36596bd3a4fdSStefano Zampini . vecsin  - array of vectors to be transferred
36606bd3a4fdSStefano Zampini . vecsout - array of transferred vectors
36616bd3a4fdSStefano Zampini - ctx     - user defined context
36626bd3a4fdSStefano Zampini 
36636bd3a4fdSStefano Zampini   Notes:
36646bd3a4fdSStefano Zampini   The `setup` function is called inside `TSSolve()` after `TSPostStep()` at the end of each time step
36656bd3a4fdSStefano Zampini   to determine if the problem size has changed.
36666bd3a4fdSStefano Zampini   If it is the case, the solver will collect the needed vectors that need to be
36676bd3a4fdSStefano Zampini   transferred from the old to the new sizes using `transfer`. These vectors will include the current
36686bd3a4fdSStefano Zampini   solution vector, and other vectors needed by the specific solver used.
36696bd3a4fdSStefano Zampini   For example, `TSBDF` uses previous solutions vectors to solve for the next time step.
36706bd3a4fdSStefano Zampini   Other application specific objects associated with the solver, i.e. Jacobian matrices and `DM`,
36716bd3a4fdSStefano Zampini   will be automatically reset if the sizes are changed and they must be specified again by the user
36726bd3a4fdSStefano Zampini   inside the `transfer` function.
36736bd3a4fdSStefano Zampini   The input and output arrays passed to `transfer` are allocated by PETSc.
36746bd3a4fdSStefano Zampini   Vectors in `vecsout` must be created by the user.
36756bd3a4fdSStefano Zampini   Ownership of vectors in `vecsout` is transferred to PETSc.
36766bd3a4fdSStefano Zampini 
36776bd3a4fdSStefano Zampini   Level: advanced
36786bd3a4fdSStefano Zampini 
36796bd3a4fdSStefano Zampini .seealso: [](ch_ts), `TS`, `TSSetDM()`, `TSSetIJacobian()`, `TSSetRHSJacobian()`
36806bd3a4fdSStefano Zampini @*/
368114d0ab18SJacob Faibussowitsch PetscErrorCode TSSetResize(TS ts, PetscErrorCode (*setup)(TS ts, PetscInt step, PetscReal time, Vec state, PetscBool *resize, void *ctx), PetscErrorCode (*transfer)(TS ts, PetscInt nv, Vec vecsin[], Vec vecsout[], void *ctx), void *ctx)
36826bd3a4fdSStefano Zampini {
36836bd3a4fdSStefano Zampini   PetscFunctionBegin;
36846bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
36856bd3a4fdSStefano Zampini   ts->resizesetup    = setup;
36866bd3a4fdSStefano Zampini   ts->resizetransfer = transfer;
36876bd3a4fdSStefano Zampini   ts->resizectx      = ctx;
36886bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
36896bd3a4fdSStefano Zampini }
36906bd3a4fdSStefano Zampini 
369114d0ab18SJacob Faibussowitsch /*
36926bd3a4fdSStefano Zampini   TSResizeRegisterOrRetrieve - Register or import vectors transferred with `TSResize()`.
36936bd3a4fdSStefano Zampini 
36946bd3a4fdSStefano Zampini   Collective
36956bd3a4fdSStefano Zampini 
36966bd3a4fdSStefano Zampini   Input Parameters:
36976bd3a4fdSStefano Zampini + ts   - The `TS` context obtained from `TSCreate()`
36986bd3a4fdSStefano Zampini - flg - If `PETSC_TRUE` each TS implementation (e.g. `TSBDF`) will register vectors to be transferred, if `PETSC_FALSE` vectors will be imported from transferred vectors.
36996bd3a4fdSStefano Zampini 
37006bd3a4fdSStefano Zampini   Level: developer
37016bd3a4fdSStefano Zampini 
37026bd3a4fdSStefano Zampini   Note:
37036bd3a4fdSStefano Zampini   `TSResizeRegisterOrRetrieve()` is declared PETSC_INTERN since it is
37046bd3a4fdSStefano Zampini    used within time stepping implementations,
37056bd3a4fdSStefano Zampini    so most users would not generally call this routine themselves.
37066bd3a4fdSStefano Zampini 
37076bd3a4fdSStefano Zampini .seealso: [](ch_ts), `TS`, `TSSetResize()`
37086bd3a4fdSStefano Zampini @*/
370914d0ab18SJacob Faibussowitsch static PetscErrorCode TSResizeRegisterOrRetrieve(TS ts, PetscBool flg)
37106bd3a4fdSStefano Zampini {
37116bd3a4fdSStefano Zampini   PetscFunctionBegin;
37126bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37136bd3a4fdSStefano Zampini   PetscTryTypeMethod(ts, resizeregister, flg);
37146bd3a4fdSStefano Zampini   /* PetscTryTypeMethod(adapt, resizeregister, flg); */
37156bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37166bd3a4fdSStefano Zampini }
37176bd3a4fdSStefano Zampini 
371814d0ab18SJacob Faibussowitsch static PetscErrorCode TSResizeReset(TS ts)
37196bd3a4fdSStefano Zampini {
37206bd3a4fdSStefano Zampini   PetscFunctionBegin;
37216bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37226bd3a4fdSStefano Zampini   PetscCall(PetscObjectListDestroy(&ts->resizetransferobjs));
37236bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37246bd3a4fdSStefano Zampini }
37256bd3a4fdSStefano Zampini 
37266bd3a4fdSStefano Zampini static PetscErrorCode TSResizeTransferVecs(TS ts, PetscInt cnt, Vec vecsin[], Vec vecsout[])
37276bd3a4fdSStefano Zampini {
37286bd3a4fdSStefano Zampini   PetscFunctionBegin;
37296bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37306bd3a4fdSStefano Zampini   PetscValidLogicalCollectiveInt(ts, cnt, 2);
37316bd3a4fdSStefano Zampini   for (PetscInt i = 0; i < cnt; i++) PetscCall(VecLockReadPush(vecsin[i]));
37326bd3a4fdSStefano Zampini   if (ts->resizetransfer) {
37336bd3a4fdSStefano Zampini     PetscCall(PetscInfo(ts, "Transferring %" PetscInt_FMT " vectors\n", cnt));
37346bd3a4fdSStefano Zampini     PetscCallBack("TS callback resize transfer", (*ts->resizetransfer)(ts, cnt, vecsin, vecsout, ts->resizectx));
37356bd3a4fdSStefano Zampini   }
37366bd3a4fdSStefano Zampini   for (PetscInt i = 0; i < cnt; i++) PetscCall(VecLockReadPop(vecsin[i]));
37376bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37386bd3a4fdSStefano Zampini }
37396bd3a4fdSStefano Zampini 
37406bd3a4fdSStefano Zampini /*@C
37416bd3a4fdSStefano Zampini   TSResizeRegisterVec - Register a vector to be transferred with `TSResize()`.
37426bd3a4fdSStefano Zampini 
37436bd3a4fdSStefano Zampini   Collective
37446bd3a4fdSStefano Zampini 
37456bd3a4fdSStefano Zampini   Input Parameters:
37466bd3a4fdSStefano Zampini + ts   - The `TS` context obtained from `TSCreate()`
3747baca6076SPierre Jolivet . name - A string identifying the vector
37486bd3a4fdSStefano Zampini - vec  - The vector
37496bd3a4fdSStefano Zampini 
37506bd3a4fdSStefano Zampini   Level: developer
37516bd3a4fdSStefano Zampini 
37526bd3a4fdSStefano Zampini   Note:
37536bd3a4fdSStefano Zampini   `TSResizeRegisterVec()` is typically used within time stepping implementations,
37546bd3a4fdSStefano Zampini   so most users would not generally call this routine themselves.
37556bd3a4fdSStefano Zampini 
37566bd3a4fdSStefano Zampini .seealso: [](ch_ts), `TS`, `TSSetResize()`, `TSResize()`, `TSResizeRetrieveVec()`
37576bd3a4fdSStefano Zampini @*/
37586bd3a4fdSStefano Zampini PetscErrorCode TSResizeRegisterVec(TS ts, const char *name, Vec vec)
37596bd3a4fdSStefano Zampini {
37606bd3a4fdSStefano Zampini   PetscFunctionBegin;
37616bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37624f572ea9SToby Isaac   PetscAssertPointer(name, 2);
37636bd3a4fdSStefano Zampini   if (vec) PetscValidHeaderSpecific(vec, VEC_CLASSID, 3);
37646bd3a4fdSStefano Zampini   PetscCall(PetscObjectListAdd(&ts->resizetransferobjs, name, (PetscObject)vec));
37656bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37666bd3a4fdSStefano Zampini }
37676bd3a4fdSStefano Zampini 
37686bd3a4fdSStefano Zampini /*@C
37696bd3a4fdSStefano Zampini   TSResizeRetrieveVec - Retrieve a vector registered with `TSResizeRegisterVec()`.
37706bd3a4fdSStefano Zampini 
37716bd3a4fdSStefano Zampini   Collective
37726bd3a4fdSStefano Zampini 
37736bd3a4fdSStefano Zampini   Input Parameters:
37746bd3a4fdSStefano Zampini + ts   - The `TS` context obtained from `TSCreate()`
3775baca6076SPierre Jolivet . name - A string identifying the vector
37766bd3a4fdSStefano Zampini - vec  - The vector
37776bd3a4fdSStefano Zampini 
37786bd3a4fdSStefano Zampini   Level: developer
37796bd3a4fdSStefano Zampini 
37806bd3a4fdSStefano Zampini   Note:
37816bd3a4fdSStefano Zampini   `TSResizeRetrieveVec()` is typically used within time stepping implementations,
37826bd3a4fdSStefano Zampini   so most users would not generally call this routine themselves.
37836bd3a4fdSStefano Zampini 
37846bd3a4fdSStefano Zampini .seealso: [](ch_ts), `TS`, `TSSetResize()`, `TSResize()`, `TSResizeRegisterVec()`
37856bd3a4fdSStefano Zampini @*/
37866bd3a4fdSStefano Zampini PetscErrorCode TSResizeRetrieveVec(TS ts, const char *name, Vec *vec)
37876bd3a4fdSStefano Zampini {
37886bd3a4fdSStefano Zampini   PetscFunctionBegin;
37896bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
37904f572ea9SToby Isaac   PetscAssertPointer(name, 2);
37914f572ea9SToby Isaac   PetscAssertPointer(vec, 3);
37926bd3a4fdSStefano Zampini   PetscCall(PetscObjectListFind(ts->resizetransferobjs, name, (PetscObject *)vec));
37936bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37946bd3a4fdSStefano Zampini }
37956bd3a4fdSStefano Zampini 
37966bd3a4fdSStefano Zampini static PetscErrorCode TSResizeGetVecArray(TS ts, PetscInt *nv, const char **names[], Vec *vecs[])
37976bd3a4fdSStefano Zampini {
37986bd3a4fdSStefano Zampini   PetscInt        cnt;
37996bd3a4fdSStefano Zampini   PetscObjectList tmp;
38006bd3a4fdSStefano Zampini   Vec            *vecsin  = NULL;
38016bd3a4fdSStefano Zampini   const char    **namesin = NULL;
38026bd3a4fdSStefano Zampini 
38036bd3a4fdSStefano Zampini   PetscFunctionBegin;
38046bd3a4fdSStefano Zampini   for (tmp = ts->resizetransferobjs, cnt = 0; tmp; tmp = tmp->next)
38056bd3a4fdSStefano Zampini     if (tmp->obj && tmp->obj->classid == VEC_CLASSID) cnt++;
380603ba6ac9SBarry Smith   if (names) PetscCall(PetscMalloc1(cnt, &namesin));
380703ba6ac9SBarry Smith   if (vecs) PetscCall(PetscMalloc1(cnt, &vecsin));
38086bd3a4fdSStefano Zampini   for (tmp = ts->resizetransferobjs, cnt = 0; tmp; tmp = tmp->next) {
38096bd3a4fdSStefano Zampini     if (tmp->obj && tmp->obj->classid == VEC_CLASSID) {
38106bd3a4fdSStefano Zampini       if (vecs) vecsin[cnt] = (Vec)tmp->obj;
38116bd3a4fdSStefano Zampini       if (names) namesin[cnt] = tmp->name;
38126bd3a4fdSStefano Zampini       cnt++;
38136bd3a4fdSStefano Zampini     }
38146bd3a4fdSStefano Zampini   }
38156bd3a4fdSStefano Zampini   if (nv) *nv = cnt;
38166bd3a4fdSStefano Zampini   if (names) *names = namesin;
38176bd3a4fdSStefano Zampini   if (vecs) *vecs = vecsin;
38186bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
38196bd3a4fdSStefano Zampini }
38206bd3a4fdSStefano Zampini 
38216bd3a4fdSStefano Zampini /*@
38226bd3a4fdSStefano Zampini   TSResize - Runs the user-defined transfer functions provided with `TSSetResize()`
38236bd3a4fdSStefano Zampini 
38246bd3a4fdSStefano Zampini   Collective
38256bd3a4fdSStefano Zampini 
38266bd3a4fdSStefano Zampini   Input Parameter:
38276bd3a4fdSStefano Zampini . ts - The `TS` context obtained from `TSCreate()`
38286bd3a4fdSStefano Zampini 
38296bd3a4fdSStefano Zampini   Level: developer
38306bd3a4fdSStefano Zampini 
38316bd3a4fdSStefano Zampini   Note:
38326bd3a4fdSStefano Zampini   `TSResize()` is typically used within time stepping implementations,
38336bd3a4fdSStefano Zampini   so most users would not generally call this routine themselves.
38346bd3a4fdSStefano Zampini 
38356bd3a4fdSStefano Zampini .seealso: [](ch_ts), `TS`, `TSSetResize()`
38366bd3a4fdSStefano Zampini @*/
38376bd3a4fdSStefano Zampini PetscErrorCode TSResize(TS ts)
38386bd3a4fdSStefano Zampini {
38396bd3a4fdSStefano Zampini   PetscInt     nv      = 0;
38406bd3a4fdSStefano Zampini   const char **names   = NULL;
38416bd3a4fdSStefano Zampini   Vec         *vecsin  = NULL;
38426bd3a4fdSStefano Zampini   const char  *solname = "ts:vec_sol";
38436bd3a4fdSStefano Zampini 
38446bd3a4fdSStefano Zampini   PetscFunctionBegin;
38456bd3a4fdSStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
38466bd3a4fdSStefano Zampini   if (ts->resizesetup) {
38476bd3a4fdSStefano Zampini     PetscBool flg = PETSC_FALSE;
38486bd3a4fdSStefano Zampini 
38496bd3a4fdSStefano Zampini     PetscCall(VecLockReadPush(ts->vec_sol));
38506bd3a4fdSStefano Zampini     PetscCallBack("TS callback resize setup", (*ts->resizesetup)(ts, ts->steps, ts->ptime, ts->vec_sol, &flg, ts->resizectx));
38516bd3a4fdSStefano Zampini     PetscCall(VecLockReadPop(ts->vec_sol));
38526bd3a4fdSStefano Zampini     if (flg) {
38536bd3a4fdSStefano Zampini       PetscCall(TSResizeRegisterVec(ts, solname, ts->vec_sol));
38546bd3a4fdSStefano Zampini       PetscCall(TSResizeRegisterOrRetrieve(ts, PETSC_TRUE)); /* specific impls register their own objects */
38556bd3a4fdSStefano Zampini     }
38566bd3a4fdSStefano Zampini   }
38576bd3a4fdSStefano Zampini 
38586bd3a4fdSStefano Zampini   PetscCall(TSResizeGetVecArray(ts, &nv, &names, &vecsin));
38596bd3a4fdSStefano Zampini   if (nv) {
38606bd3a4fdSStefano Zampini     Vec *vecsout, vecsol;
38616bd3a4fdSStefano Zampini 
38626bd3a4fdSStefano Zampini     /* Reset internal objects */
38636bd3a4fdSStefano Zampini     PetscCall(TSReset(ts));
38646bd3a4fdSStefano Zampini 
38656bd3a4fdSStefano Zampini     /* Transfer needed vectors (users can call SetJacobian, SetDM here) */
38666bd3a4fdSStefano Zampini     PetscCall(PetscCalloc1(nv, &vecsout));
38676bd3a4fdSStefano Zampini     PetscCall(TSResizeTransferVecs(ts, nv, vecsin, vecsout));
38686bd3a4fdSStefano Zampini     for (PetscInt i = 0; i < nv; i++) {
38696bd3a4fdSStefano Zampini       PetscCall(TSResizeRegisterVec(ts, names[i], vecsout[i]));
38706bd3a4fdSStefano Zampini       PetscCall(VecDestroy(&vecsout[i]));
38716bd3a4fdSStefano Zampini     }
38726bd3a4fdSStefano Zampini     PetscCall(PetscFree(vecsout));
38736bd3a4fdSStefano Zampini     PetscCall(TSResizeRegisterOrRetrieve(ts, PETSC_FALSE)); /* specific impls import the transferred objects */
38746bd3a4fdSStefano Zampini 
38756bd3a4fdSStefano Zampini     PetscCall(TSResizeRetrieveVec(ts, solname, &vecsol));
38766bd3a4fdSStefano Zampini     if (vecsol) PetscCall(TSSetSolution(ts, vecsol));
38776bd3a4fdSStefano Zampini     PetscAssert(ts->vec_sol, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_NULL, "Missing TS solution");
38786bd3a4fdSStefano Zampini   }
38796bd3a4fdSStefano Zampini 
38806bd3a4fdSStefano Zampini   PetscCall(PetscFree(names));
38816bd3a4fdSStefano Zampini   PetscCall(PetscFree(vecsin));
38826bd3a4fdSStefano Zampini   PetscCall(TSResizeReset(ts));
38836bd3a4fdSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
38846bd3a4fdSStefano Zampini }
38856bd3a4fdSStefano Zampini 
3886b1cb36f3SHong Zhang /*@
38876a4d4014SLisandro Dalcin   TSSolve - Steps the requested number of timesteps.
38886a4d4014SLisandro Dalcin 
3889c3339decSBarry Smith   Collective
38906a4d4014SLisandro Dalcin 
3891d8d19677SJose E. Roman   Input Parameters:
3892bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()`
3893bcf0153eSBarry Smith - u  - the solution vector  (can be null if `TSSetSolution()` was used and `TSSetExactFinalTime`(ts,`TS_EXACTFINALTIME_MATCHSTEP`) was not used,
389463e21af5SBarry Smith                              otherwise must contain the initial conditions and will contain the solution at the final requested time
38955a3a76d0SJed Brown 
38966a4d4014SLisandro Dalcin   Level: beginner
38976a4d4014SLisandro Dalcin 
38985a3a76d0SJed Brown   Notes:
38995a3a76d0SJed Brown   The final time returned by this function may be different from the time of the internally
3900bcf0153eSBarry Smith   held state accessible by `TSGetSolution()` and `TSGetTime()` because the method may have
39015a3a76d0SJed Brown   stepped over the final time.
39025a3a76d0SJed Brown 
39031cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSSetSolution()`, `TSStep()`, `TSGetTime()`, `TSGetSolveTime()`
39046a4d4014SLisandro Dalcin @*/
3905d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSolve(TS ts, Vec u)
3906d71ae5a4SJacob Faibussowitsch {
3907b06615a5SLisandro Dalcin   Vec solution;
3908f22f69f0SBarry Smith 
39096a4d4014SLisandro Dalcin   PetscFunctionBegin;
39100700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
3911f2c2a1b9SBarry Smith   if (u) PetscValidHeaderSpecific(u, VEC_CLASSID, 2);
3912303a5415SBarry Smith 
39139566063dSJacob Faibussowitsch   PetscCall(TSSetExactFinalTimeDefault(ts));
3914ee41a567SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && u) { /* Need ts->vec_sol to be distinct so it is not overwritten when we interpolate at the end */
39150910c330SBarry Smith     if (!ts->vec_sol || u == ts->vec_sol) {
39169566063dSJacob Faibussowitsch       PetscCall(VecDuplicate(u, &solution));
39179566063dSJacob Faibussowitsch       PetscCall(TSSetSolution(ts, solution));
39189566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&solution)); /* grant ownership */
39195a3a76d0SJed Brown     }
39209566063dSJacob Faibussowitsch     PetscCall(VecCopy(u, ts->vec_sol));
39213c633725SBarry Smith     PetscCheck(!ts->forward_solve, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Sensitivity analysis does not support the mode TS_EXACTFINALTIME_INTERPOLATE");
39221baa6e33SBarry Smith   } else if (u) PetscCall(TSSetSolution(ts, u));
39239566063dSJacob Faibussowitsch   PetscCall(TSSetUp(ts));
39249566063dSJacob Faibussowitsch   PetscCall(TSTrajectorySetUp(ts->trajectory, ts));
3925a6772fa2SLisandro Dalcin 
39263c633725SBarry Smith   PetscCheck(ts->max_time < PETSC_MAX_REAL || ts->max_steps != PETSC_MAX_INT, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetMaxTime() or TSSetMaxSteps(), or use -ts_max_time <time> or -ts_max_steps <steps>");
39273c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_UNSPECIFIED, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "You must call TSSetExactFinalTime() or use -ts_exact_final_time <stepover,interpolate,matchstep> before calling TSSolve()");
39283c633725SBarry Smith   PetscCheck(ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP || ts->adapt, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "Since TS is not adaptive you cannot use TS_EXACTFINALTIME_MATCHSTEP, suggest TS_EXACTFINALTIME_INTERPOLATE");
39294a658b32SHong Zhang   PetscCheck(!(ts->tspan && ts->exact_final_time != TS_EXACTFINALTIME_MATCHSTEP), PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "You must use TS_EXACTFINALTIME_MATCHSTEP when using time span");
39304a658b32SHong Zhang 
3931e1db57b0SHong Zhang   if (ts->tspan && PetscIsCloseAtTol(ts->ptime, ts->tspan->span_times[0], ts->tspan->reltol * ts->time_step + ts->tspan->abstol, 0)) { /* starting point in time span */
39324a658b32SHong Zhang     PetscCall(VecCopy(ts->vec_sol, ts->tspan->vecs_sol[0]));
39334a658b32SHong Zhang     ts->tspan->spanctr = 1;
39344a658b32SHong Zhang   }
3935a6772fa2SLisandro Dalcin 
39361baa6e33SBarry Smith   if (ts->forward_solve) PetscCall(TSForwardSetUp(ts));
3937715f1b00SHong Zhang 
3938e7069c78SShri   /* reset number of steps only when the step is not restarted. ARKIMEX
3939715f1b00SHong Zhang      restarts the step after an event. Resetting these counters in such case causes
3940e7069c78SShri      TSTrajectory to incorrectly save the output files
3941e7069c78SShri   */
3942715f1b00SHong Zhang   /* reset time step and iteration counters */
39432808aa04SLisandro Dalcin   if (!ts->steps) {
39445ef26d82SJed Brown     ts->ksp_its           = 0;
39455ef26d82SJed Brown     ts->snes_its          = 0;
3946c610991cSLisandro Dalcin     ts->num_snes_failures = 0;
3947c610991cSLisandro Dalcin     ts->reject            = 0;
39482808aa04SLisandro Dalcin     ts->steprestart       = PETSC_TRUE;
39492808aa04SLisandro Dalcin     ts->steprollback      = PETSC_FALSE;
39507d51462cSStefano Zampini     ts->rhsjacobian.time  = PETSC_MIN_REAL;
39512808aa04SLisandro Dalcin   }
3952e97c63d7SStefano Zampini 
39534a658b32SHong Zhang   /* make sure initial time step does not overshoot final time or the next point in tspan */
3954e97c63d7SStefano Zampini   if (ts->exact_final_time == TS_EXACTFINALTIME_MATCHSTEP) {
39554a658b32SHong Zhang     PetscReal maxdt;
3956e97c63d7SStefano Zampini     PetscReal dt = ts->time_step;
3957e97c63d7SStefano Zampini 
39584a658b32SHong Zhang     if (ts->tspan) maxdt = ts->tspan->span_times[ts->tspan->spanctr] - ts->ptime;
39594a658b32SHong Zhang     else maxdt = ts->max_time - ts->ptime;
3960e97c63d7SStefano Zampini     ts->time_step = dt >= maxdt ? maxdt : (PetscIsCloseAtTol(dt, maxdt, 10 * PETSC_MACHINE_EPSILON, 0) ? maxdt : dt);
3961e97c63d7SStefano Zampini   }
3962193ac0bcSJed Brown   ts->reason = TS_CONVERGED_ITERATING;
3963193ac0bcSJed Brown 
3964900f6b5bSMatthew G. Knepley   {
3965900f6b5bSMatthew G. Knepley     PetscViewer       viewer;
3966900f6b5bSMatthew G. Knepley     PetscViewerFormat format;
3967900f6b5bSMatthew G. Knepley     PetscBool         flg;
3968900f6b5bSMatthew G. Knepley     static PetscBool  incall = PETSC_FALSE;
3969900f6b5bSMatthew G. Knepley 
3970900f6b5bSMatthew G. Knepley     if (!incall) {
3971900f6b5bSMatthew G. Knepley       /* Estimate the convergence rate of the time discretization */
39729566063dSJacob Faibussowitsch       PetscCall(PetscOptionsGetViewer(PetscObjectComm((PetscObject)ts), ((PetscObject)ts)->options, ((PetscObject)ts)->prefix, "-ts_convergence_estimate", &viewer, &format, &flg));
3973900f6b5bSMatthew G. Knepley       if (flg) {
3974900f6b5bSMatthew G. Knepley         PetscConvEst conv;
3975900f6b5bSMatthew G. Knepley         DM           dm;
3976900f6b5bSMatthew G. Knepley         PetscReal   *alpha; /* Convergence rate of the solution error for each field in the L_2 norm */
3977900f6b5bSMatthew G. Knepley         PetscInt     Nf;
3978f2ed2dc7SMatthew G. Knepley         PetscBool    checkTemporal = PETSC_TRUE;
3979900f6b5bSMatthew G. Knepley 
3980900f6b5bSMatthew G. Knepley         incall = PETSC_TRUE;
39819566063dSJacob Faibussowitsch         PetscCall(PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject)ts)->prefix, "-ts_convergence_temporal", &checkTemporal, &flg));
39829566063dSJacob Faibussowitsch         PetscCall(TSGetDM(ts, &dm));
39839566063dSJacob Faibussowitsch         PetscCall(DMGetNumFields(dm, &Nf));
39849566063dSJacob Faibussowitsch         PetscCall(PetscCalloc1(PetscMax(Nf, 1), &alpha));
39859566063dSJacob Faibussowitsch         PetscCall(PetscConvEstCreate(PetscObjectComm((PetscObject)ts), &conv));
39869566063dSJacob Faibussowitsch         PetscCall(PetscConvEstUseTS(conv, checkTemporal));
39879566063dSJacob Faibussowitsch         PetscCall(PetscConvEstSetSolver(conv, (PetscObject)ts));
39889566063dSJacob Faibussowitsch         PetscCall(PetscConvEstSetFromOptions(conv));
39899566063dSJacob Faibussowitsch         PetscCall(PetscConvEstSetUp(conv));
39909566063dSJacob Faibussowitsch         PetscCall(PetscConvEstGetConvRate(conv, alpha));
39919566063dSJacob Faibussowitsch         PetscCall(PetscViewerPushFormat(viewer, format));
39929566063dSJacob Faibussowitsch         PetscCall(PetscConvEstRateView(conv, alpha, viewer));
39939566063dSJacob Faibussowitsch         PetscCall(PetscViewerPopFormat(viewer));
3994cd791dc2SBarry Smith         PetscCall(PetscOptionsRestoreViewer(&viewer));
39959566063dSJacob Faibussowitsch         PetscCall(PetscConvEstDestroy(&conv));
39969566063dSJacob Faibussowitsch         PetscCall(PetscFree(alpha));
3997900f6b5bSMatthew G. Knepley         incall = PETSC_FALSE;
3998900f6b5bSMatthew G. Knepley       }
3999900f6b5bSMatthew G. Knepley     }
4000900f6b5bSMatthew G. Knepley   }
4001900f6b5bSMatthew G. Knepley 
40029566063dSJacob Faibussowitsch   PetscCall(TSViewFromOptions(ts, NULL, "-ts_view_pre"));
4003f05ece33SBarry Smith 
4004193ac0bcSJed Brown   if (ts->ops->solve) { /* This private interface is transitional and should be removed when all implementations are updated. */
4005dbbe0bcdSBarry Smith     PetscUseTypeMethod(ts, solve);
40069566063dSJacob Faibussowitsch     if (u) PetscCall(VecCopy(ts->vec_sol, u));
4007cc708dedSBarry Smith     ts->solvetime = ts->ptime;
4008a6772fa2SLisandro Dalcin     solution      = ts->vec_sol;
4009be5899b3SLisandro Dalcin   } else { /* Step the requested number of timesteps. */
4010db4deed7SKarl Rupp     if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
4011db4deed7SKarl Rupp     else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
4012e7069c78SShri 
40132808aa04SLisandro Dalcin     if (!ts->steps) {
40149566063dSJacob Faibussowitsch       PetscCall(TSTrajectorySet(ts->trajectory, ts, ts->steps, ts->ptime, ts->vec_sol));
40159566063dSJacob Faibussowitsch       PetscCall(TSEventInitialize(ts->event, ts, ts->ptime, ts->vec_sol));
40162808aa04SLisandro Dalcin     }
40176427ac75SLisandro Dalcin 
4018e1a7a14fSJed Brown     while (!ts->reason) {
40199566063dSJacob Faibussowitsch       PetscCall(TSMonitor(ts, ts->steps, ts->ptime, ts->vec_sol));
40201e66621cSBarry Smith       if (!ts->steprollback) PetscCall(TSPreStep(ts));
40219566063dSJacob Faibussowitsch       PetscCall(TSStep(ts));
40221baa6e33SBarry Smith       if (ts->testjacobian) PetscCall(TSRHSJacobianTest(ts, NULL));
40231baa6e33SBarry Smith       if (ts->testjacobiantranspose) PetscCall(TSRHSJacobianTestTranspose(ts, NULL));
4024cd4cee2dSHong Zhang       if (ts->quadraturets && ts->costintegralfwd) { /* Must evaluate the cost integral before event is handled. The cost integral value can also be rolled back. */
40257b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--;            /* Revert the step number changed by TSStep() */
40269566063dSJacob Faibussowitsch         PetscCall(TSForwardCostIntegral(ts));
40277b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4028b1cb36f3SHong Zhang       }
402958818c2dSLisandro Dalcin       if (ts->forward_solve) {            /* compute forward sensitivities before event handling because postevent() may change RHS and jump conditions may have to be applied */
40307b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps--; /* Revert the step number changed by TSStep() */
40319566063dSJacob Faibussowitsch         PetscCall(TSForwardStep(ts));
40327b0e2f17SHong Zhang         if (ts->reason >= 0) ts->steps++;
4033715f1b00SHong Zhang       }
40349566063dSJacob Faibussowitsch       PetscCall(TSPostEvaluate(ts));
40359566063dSJacob Faibussowitsch       PetscCall(TSEventHandler(ts)); /* The right-hand side may be changed due to event. Be careful with Any computation using the RHS information after this point. */
40361baa6e33SBarry Smith       if (ts->steprollback) PetscCall(TSPostEvaluate(ts));
403790d719a4SStefano Zampini       /* check convergence */
403890d719a4SStefano Zampini       if (!ts->reason) {
403990d719a4SStefano Zampini         if (ts->steps >= ts->max_steps) ts->reason = TS_CONVERGED_ITS;
404090d719a4SStefano Zampini         else if (ts->ptime >= ts->max_time) ts->reason = TS_CONVERGED_TIME;
404190d719a4SStefano Zampini       }
4042e783b05fSHong Zhang       if (!ts->steprollback) {
40439566063dSJacob Faibussowitsch         PetscCall(TSTrajectorySet(ts->trajectory, ts, ts->steps, ts->ptime, ts->vec_sol));
40449566063dSJacob Faibussowitsch         PetscCall(TSPostStep(ts));
40456bd3a4fdSStefano Zampini         PetscCall(TSResize(ts));
4046ca4445c7SIlya Fursov 
4047ca4445c7SIlya Fursov         if (ts->tspan && ts->tspan->spanctr < ts->tspan->num_span_times) {
4048ca4445c7SIlya Fursov           PetscCheck(ts->tspan->worktol > 0, PetscObjectComm((PetscObject)ts), PETSC_ERR_PLIB, "Unexpected state !(tspan->worktol > 0) in TSSolve()");
4049ca4445c7SIlya Fursov           if (PetscIsCloseAtTol(ts->ptime, ts->tspan->span_times[ts->tspan->spanctr], ts->tspan->worktol, 0)) PetscCall(VecCopy(ts->vec_sol, ts->tspan->vecs_sol[ts->tspan->spanctr++]));
4050ca4445c7SIlya Fursov         }
4051aeb4809dSShri Abhyankar       }
4052193ac0bcSJed Brown     }
40539566063dSJacob Faibussowitsch     PetscCall(TSMonitor(ts, ts->steps, ts->ptime, ts->vec_sol));
40546427ac75SLisandro Dalcin 
405549354f04SShri Abhyankar     if (ts->exact_final_time == TS_EXACTFINALTIME_INTERPOLATE && ts->ptime > ts->max_time) {
40565dbbf88eSStefano Zampini       if (!u) u = ts->vec_sol;
40579566063dSJacob Faibussowitsch       PetscCall(TSInterpolate(ts, ts->max_time, u));
4058cc708dedSBarry Smith       ts->solvetime = ts->max_time;
4059b06615a5SLisandro Dalcin       solution      = u;
40609566063dSJacob Faibussowitsch       PetscCall(TSMonitor(ts, -1, ts->solvetime, solution));
40610574a7fbSJed Brown     } else {
40629566063dSJacob Faibussowitsch       if (u) PetscCall(VecCopy(ts->vec_sol, u));
4063cc708dedSBarry Smith       ts->solvetime = ts->ptime;
4064b06615a5SLisandro Dalcin       solution      = ts->vec_sol;
40650574a7fbSJed Brown     }
4066193ac0bcSJed Brown   }
4067d2daff3dSHong Zhang 
40689566063dSJacob Faibussowitsch   PetscCall(TSViewFromOptions(ts, NULL, "-ts_view"));
40699566063dSJacob Faibussowitsch   PetscCall(VecViewFromOptions(solution, (PetscObject)ts, "-ts_view_solution"));
40709566063dSJacob Faibussowitsch   PetscCall(PetscObjectSAWsBlock((PetscObject)ts));
40711baa6e33SBarry Smith   if (ts->adjoint_solve) PetscCall(TSAdjointSolve(ts));
40723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
40736a4d4014SLisandro Dalcin }
40746a4d4014SLisandro Dalcin 
4075d763cef2SBarry Smith /*@
4076b8123daeSJed Brown   TSGetTime - Gets the time of the most recently completed step.
4077d763cef2SBarry Smith 
4078d763cef2SBarry Smith   Not Collective
4079d763cef2SBarry Smith 
4080d763cef2SBarry Smith   Input Parameter:
4081bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
4082d763cef2SBarry Smith 
4083d763cef2SBarry Smith   Output Parameter:
4084bcf0153eSBarry Smith . t - the current time. This time may not corresponds to the final time set with `TSSetMaxTime()`, use `TSGetSolveTime()`.
4085d763cef2SBarry Smith 
4086d763cef2SBarry Smith   Level: beginner
4087d763cef2SBarry Smith 
4088b8123daeSJed Brown   Note:
4089bcf0153eSBarry Smith   When called during time step evaluation (e.g. during residual evaluation or via hooks set using `TSSetPreStep()`,
4090bcf0153eSBarry Smith   `TSSetPreStage()`, `TSSetPostStage()`, or `TSSetPostStep()`), the time is the time at the start of the step being evaluated.
4091b8123daeSJed Brown 
4092b43aa488SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, ``TSGetSolveTime()`, `TSSetTime()`, `TSGetTimeStep()`, `TSGetStepNumber()`
4093d763cef2SBarry Smith @*/
4094d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTime(TS ts, PetscReal *t)
4095d71ae5a4SJacob Faibussowitsch {
4096d763cef2SBarry Smith   PetscFunctionBegin;
40970700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
40984f572ea9SToby Isaac   PetscAssertPointer(t, 2);
4099d763cef2SBarry Smith   *t = ts->ptime;
41003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4101d763cef2SBarry Smith }
4102d763cef2SBarry Smith 
4103e5e524a1SHong Zhang /*@
4104e5e524a1SHong Zhang   TSGetPrevTime - Gets the starting time of the previously completed step.
4105e5e524a1SHong Zhang 
4106e5e524a1SHong Zhang   Not Collective
4107e5e524a1SHong Zhang 
4108e5e524a1SHong Zhang   Input Parameter:
4109bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
4110e5e524a1SHong Zhang 
4111e5e524a1SHong Zhang   Output Parameter:
4112e5e524a1SHong Zhang . t - the previous time
4113e5e524a1SHong Zhang 
4114e5e524a1SHong Zhang   Level: beginner
4115e5e524a1SHong Zhang 
4116b43aa488SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, ``TSGetTime()`, `TSGetSolveTime()`, `TSGetTimeStep()`
4117e5e524a1SHong Zhang @*/
4118d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetPrevTime(TS ts, PetscReal *t)
4119d71ae5a4SJacob Faibussowitsch {
4120e5e524a1SHong Zhang   PetscFunctionBegin;
4121e5e524a1SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
41224f572ea9SToby Isaac   PetscAssertPointer(t, 2);
4123e5e524a1SHong Zhang   *t = ts->ptime_prev;
41243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4125e5e524a1SHong Zhang }
4126e5e524a1SHong Zhang 
41276a4d4014SLisandro Dalcin /*@
41286a4d4014SLisandro Dalcin   TSSetTime - Allows one to reset the time.
41296a4d4014SLisandro Dalcin 
4130c3339decSBarry Smith   Logically Collective
41316a4d4014SLisandro Dalcin 
41326a4d4014SLisandro Dalcin   Input Parameters:
4133bcf0153eSBarry Smith + ts - the `TS` context obtained from `TSCreate()`
4134b43aa488SJacob Faibussowitsch - t  - the time
41356a4d4014SLisandro Dalcin 
41366a4d4014SLisandro Dalcin   Level: intermediate
41376a4d4014SLisandro Dalcin 
41381cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTime()`, `TSSetMaxSteps()`
41396a4d4014SLisandro Dalcin @*/
4140d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetTime(TS ts, PetscReal t)
4141d71ae5a4SJacob Faibussowitsch {
41426a4d4014SLisandro Dalcin   PetscFunctionBegin;
41430700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4144c5eb9154SBarry Smith   PetscValidLogicalCollectiveReal(ts, t, 2);
41456a4d4014SLisandro Dalcin   ts->ptime = t;
41463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
41476a4d4014SLisandro Dalcin }
41486a4d4014SLisandro Dalcin 
4149d763cef2SBarry Smith /*@C
4150d763cef2SBarry Smith   TSSetOptionsPrefix - Sets the prefix used for searching for all
4151d763cef2SBarry Smith   TS options in the database.
4152d763cef2SBarry Smith 
4153c3339decSBarry Smith   Logically Collective
4154d763cef2SBarry Smith 
4155d8d19677SJose E. Roman   Input Parameters:
4156bcf0153eSBarry Smith + ts     - The `TS` context
4157d763cef2SBarry Smith - prefix - The prefix to prepend to all option names
4158d763cef2SBarry Smith 
4159bcf0153eSBarry Smith   Level: advanced
4160bcf0153eSBarry Smith 
4161bcf0153eSBarry Smith   Note:
4162d763cef2SBarry Smith   A hyphen (-) must NOT be given at the beginning of the prefix name.
4163d763cef2SBarry Smith   The first character of all runtime options is AUTOMATICALLY the
4164d763cef2SBarry Smith   hyphen.
4165d763cef2SBarry Smith 
41661cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetFromOptions()`, `TSAppendOptionsPrefix()`
4167d763cef2SBarry Smith @*/
4168d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetOptionsPrefix(TS ts, const char prefix[])
4169d71ae5a4SJacob Faibussowitsch {
4170089b2837SJed Brown   SNES snes;
4171d763cef2SBarry Smith 
4172d763cef2SBarry Smith   PetscFunctionBegin;
41730700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
41749566063dSJacob Faibussowitsch   PetscCall(PetscObjectSetOptionsPrefix((PetscObject)ts, prefix));
41759566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
41769566063dSJacob Faibussowitsch   PetscCall(SNESSetOptionsPrefix(snes, prefix));
41773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4178d763cef2SBarry Smith }
4179d763cef2SBarry Smith 
4180d763cef2SBarry Smith /*@C
4181d763cef2SBarry Smith   TSAppendOptionsPrefix - Appends to the prefix used for searching for all
4182d763cef2SBarry Smith   TS options in the database.
4183d763cef2SBarry Smith 
4184c3339decSBarry Smith   Logically Collective
4185d763cef2SBarry Smith 
4186d8d19677SJose E. Roman   Input Parameters:
4187bcf0153eSBarry Smith + ts     - The `TS` context
4188d763cef2SBarry Smith - prefix - The prefix to prepend to all option names
4189d763cef2SBarry Smith 
4190bcf0153eSBarry Smith   Level: advanced
4191bcf0153eSBarry Smith 
4192bcf0153eSBarry Smith   Note:
4193d763cef2SBarry Smith   A hyphen (-) must NOT be given at the beginning of the prefix name.
4194d763cef2SBarry Smith   The first character of all runtime options is AUTOMATICALLY the
4195d763cef2SBarry Smith   hyphen.
4196d763cef2SBarry Smith 
41971cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetOptionsPrefix()`, `TSSetOptionsPrefix()`, `TSSetFromOptions()`
4198d763cef2SBarry Smith @*/
4199d71ae5a4SJacob Faibussowitsch PetscErrorCode TSAppendOptionsPrefix(TS ts, const char prefix[])
4200d71ae5a4SJacob Faibussowitsch {
4201089b2837SJed Brown   SNES snes;
4202d763cef2SBarry Smith 
4203d763cef2SBarry Smith   PetscFunctionBegin;
42040700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
42059566063dSJacob Faibussowitsch   PetscCall(PetscObjectAppendOptionsPrefix((PetscObject)ts, prefix));
42069566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
42079566063dSJacob Faibussowitsch   PetscCall(SNESAppendOptionsPrefix(snes, prefix));
42083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4209d763cef2SBarry Smith }
4210d763cef2SBarry Smith 
4211d763cef2SBarry Smith /*@C
4212d763cef2SBarry Smith   TSGetOptionsPrefix - Sets the prefix used for searching for all
4213bcf0153eSBarry Smith   `TS` options in the database.
4214d763cef2SBarry Smith 
4215d763cef2SBarry Smith   Not Collective
4216d763cef2SBarry Smith 
4217d763cef2SBarry Smith   Input Parameter:
4218bcf0153eSBarry Smith . ts - The `TS` context
4219d763cef2SBarry Smith 
4220d763cef2SBarry Smith   Output Parameter:
4221d763cef2SBarry Smith . prefix - A pointer to the prefix string used
4222d763cef2SBarry Smith 
4223d763cef2SBarry Smith   Level: intermediate
4224d763cef2SBarry Smith 
4225b43aa488SJacob Faibussowitsch   Fortran Notes:
4226195e9b02SBarry Smith   The user should pass in a string 'prefix' of
4227bcf0153eSBarry Smith   sufficient length to hold the prefix.
4228bcf0153eSBarry Smith 
42291cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSAppendOptionsPrefix()`, `TSSetFromOptions()`
4230d763cef2SBarry Smith @*/
4231d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetOptionsPrefix(TS ts, const char *prefix[])
4232d71ae5a4SJacob Faibussowitsch {
4233d763cef2SBarry Smith   PetscFunctionBegin;
42340700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
42354f572ea9SToby Isaac   PetscAssertPointer(prefix, 2);
42369566063dSJacob Faibussowitsch   PetscCall(PetscObjectGetOptionsPrefix((PetscObject)ts, prefix));
42373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4238d763cef2SBarry Smith }
4239d763cef2SBarry Smith 
4240d763cef2SBarry Smith /*@C
4241d763cef2SBarry Smith   TSGetRHSJacobian - Returns the Jacobian J at the present timestep.
4242d763cef2SBarry Smith 
4243bcf0153eSBarry Smith   Not Collective, but parallel objects are returned if ts is parallel
4244d763cef2SBarry Smith 
4245d763cef2SBarry Smith   Input Parameter:
4246bcf0153eSBarry Smith . ts - The `TS` context obtained from `TSCreate()`
4247d763cef2SBarry Smith 
4248d763cef2SBarry Smith   Output Parameters:
4249195e9b02SBarry Smith + Amat - The (approximate) Jacobian J of G, where U_t = G(U,t)  (or `NULL`)
4250195e9b02SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, usually the same as `Amat`  (or `NULL`)
4251195e9b02SBarry Smith . func - Function to compute the Jacobian of the RHS  (or `NULL`)
4252195e9b02SBarry Smith - ctx  - User-defined context for Jacobian evaluation routine  (or `NULL`)
4253d763cef2SBarry Smith 
4254d763cef2SBarry Smith   Level: intermediate
4255d763cef2SBarry Smith 
4256bcf0153eSBarry Smith   Note:
4257195e9b02SBarry Smith   You can pass in `NULL` for any return argument you do not need.
4258bcf0153eSBarry Smith 
42591cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetMatrices()`, `TSGetTime()`, `TSGetStepNumber()`
4260d763cef2SBarry Smith 
4261d763cef2SBarry Smith @*/
42628434afd1SBarry Smith PetscErrorCode TSGetRHSJacobian(TS ts, Mat *Amat, Mat *Pmat, TSRHSJacobianFn **func, void **ctx)
4263d71ae5a4SJacob Faibussowitsch {
426424989b8cSPeter Brune   DM dm;
4265089b2837SJed Brown 
4266d763cef2SBarry Smith   PetscFunctionBegin;
426723a57915SBarry Smith   if (Amat || Pmat) {
426823a57915SBarry Smith     SNES snes;
42699566063dSJacob Faibussowitsch     PetscCall(TSGetSNES(ts, &snes));
42709566063dSJacob Faibussowitsch     PetscCall(SNESSetUpMatrices(snes));
42719566063dSJacob Faibussowitsch     PetscCall(SNESGetJacobian(snes, Amat, Pmat, NULL, NULL));
427223a57915SBarry Smith   }
42739566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
42749566063dSJacob Faibussowitsch   PetscCall(DMTSGetRHSJacobian(dm, func, ctx));
42753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4276d763cef2SBarry Smith }
4277d763cef2SBarry Smith 
42782eca1d9cSJed Brown /*@C
42792eca1d9cSJed Brown   TSGetIJacobian - Returns the implicit Jacobian at the present timestep.
42802eca1d9cSJed Brown 
4281bcf0153eSBarry Smith   Not Collective, but parallel objects are returned if ts is parallel
42822eca1d9cSJed Brown 
42832eca1d9cSJed Brown   Input Parameter:
4284bcf0153eSBarry Smith . ts - The `TS` context obtained from `TSCreate()`
42852eca1d9cSJed Brown 
42862eca1d9cSJed Brown   Output Parameters:
4287e4357dc4SBarry Smith + Amat - The (approximate) Jacobian of F(t,U,U_t)
4288195e9b02SBarry Smith . Pmat - The matrix from which the preconditioner is constructed, often the same as `Amat`
42892eca1d9cSJed Brown . f    - The function to compute the matrices
42902eca1d9cSJed Brown - ctx  - User-defined context for Jacobian evaluation routine
42912eca1d9cSJed Brown 
42922eca1d9cSJed Brown   Level: advanced
42932eca1d9cSJed Brown 
4294bcf0153eSBarry Smith   Note:
4295195e9b02SBarry Smith   You can pass in `NULL` for any return argument you do not need.
4296bcf0153eSBarry Smith 
42971cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTimeStep()`, `TSGetRHSJacobian()`, `TSGetMatrices()`, `TSGetTime()`, `TSGetStepNumber()`
42982eca1d9cSJed Brown @*/
42998434afd1SBarry Smith PetscErrorCode TSGetIJacobian(TS ts, Mat *Amat, Mat *Pmat, TSIJacobianFn **f, void **ctx)
4300d71ae5a4SJacob Faibussowitsch {
430124989b8cSPeter Brune   DM dm;
43020910c330SBarry Smith 
43032eca1d9cSJed Brown   PetscFunctionBegin;
4304c0aab802Sstefano_zampini   if (Amat || Pmat) {
4305c0aab802Sstefano_zampini     SNES snes;
43069566063dSJacob Faibussowitsch     PetscCall(TSGetSNES(ts, &snes));
43079566063dSJacob Faibussowitsch     PetscCall(SNESSetUpMatrices(snes));
43089566063dSJacob Faibussowitsch     PetscCall(SNESGetJacobian(snes, Amat, Pmat, NULL, NULL));
4309c0aab802Sstefano_zampini   }
43109566063dSJacob Faibussowitsch   PetscCall(TSGetDM(ts, &dm));
43119566063dSJacob Faibussowitsch   PetscCall(DMTSGetIJacobian(dm, f, ctx));
43123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
43132eca1d9cSJed Brown }
43142eca1d9cSJed Brown 
4315af0996ceSBarry Smith #include <petsc/private/dmimpl.h>
43166c699258SBarry Smith /*@
4317bcf0153eSBarry Smith   TSSetDM - Sets the `DM` that may be used by some nonlinear solvers or preconditioners under the `TS`
43186c699258SBarry Smith 
4319c3339decSBarry Smith   Logically Collective
43206c699258SBarry Smith 
43216c699258SBarry Smith   Input Parameters:
4322bcf0153eSBarry Smith + ts - the `TS` integrator object
4323195e9b02SBarry Smith - dm - the dm, cannot be `NULL`
43246c699258SBarry Smith 
43256c699258SBarry Smith   Level: intermediate
43266c699258SBarry Smith 
4327bcf0153eSBarry Smith   Notes:
4328bcf0153eSBarry Smith   A `DM` can only be used for solving one problem at a time because information about the problem is stored on the `DM`,
4329bcf0153eSBarry Smith   even when not using interfaces like `DMTSSetIFunction()`.  Use `DMClone()` to get a distinct `DM` when solving
4330bcf0153eSBarry Smith   different problems using the same function space.
4331bcf0153eSBarry Smith 
43321cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `DM`, `TSGetDM()`, `SNESSetDM()`, `SNESGetDM()`
43336c699258SBarry Smith @*/
4334d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetDM(TS ts, DM dm)
4335d71ae5a4SJacob Faibussowitsch {
4336089b2837SJed Brown   SNES snes;
4337942e3340SBarry Smith   DMTS tsdm;
43386c699258SBarry Smith 
43396c699258SBarry Smith   PetscFunctionBegin;
43400700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
43412a808120SBarry Smith   PetscValidHeaderSpecific(dm, DM_CLASSID, 2);
43429566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)dm));
4343942e3340SBarry Smith   if (ts->dm) { /* Move the DMTS context over to the new DM unless the new DM already has one */
43442a34c10cSBarry Smith     if (ts->dm->dmts && !dm->dmts) {
43459566063dSJacob Faibussowitsch       PetscCall(DMCopyDMTS(ts->dm, dm));
43469566063dSJacob Faibussowitsch       PetscCall(DMGetDMTS(ts->dm, &tsdm));
43471e66621cSBarry Smith       /* Grant write privileges to the replacement DM */
43481e66621cSBarry Smith       if (tsdm->originaldm == ts->dm) tsdm->originaldm = dm;
434924989b8cSPeter Brune     }
43509566063dSJacob Faibussowitsch     PetscCall(DMDestroy(&ts->dm));
435124989b8cSPeter Brune   }
43526c699258SBarry Smith   ts->dm = dm;
4353bbd56ea5SKarl Rupp 
43549566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
43559566063dSJacob Faibussowitsch   PetscCall(SNESSetDM(snes, dm));
43563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
43576c699258SBarry Smith }
43586c699258SBarry Smith 
43596c699258SBarry Smith /*@
4360bcf0153eSBarry Smith   TSGetDM - Gets the `DM` that may be used by some preconditioners
43616c699258SBarry Smith 
43623f9fe445SBarry Smith   Not Collective
43636c699258SBarry Smith 
43646c699258SBarry Smith   Input Parameter:
4365bcf0153eSBarry Smith . ts - the `TS`
43666c699258SBarry Smith 
43676c699258SBarry Smith   Output Parameter:
4368195e9b02SBarry Smith . dm - the `DM`
43696c699258SBarry Smith 
43706c699258SBarry Smith   Level: intermediate
43716c699258SBarry Smith 
43721cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `DM`, `TSSetDM()`, `SNESSetDM()`, `SNESGetDM()`
43736c699258SBarry Smith @*/
4374d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetDM(TS ts, DM *dm)
4375d71ae5a4SJacob Faibussowitsch {
43766c699258SBarry Smith   PetscFunctionBegin;
43770700a824SBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4378496e6a7aSJed Brown   if (!ts->dm) {
43799566063dSJacob Faibussowitsch     PetscCall(DMShellCreate(PetscObjectComm((PetscObject)ts), &ts->dm));
43809566063dSJacob Faibussowitsch     if (ts->snes) PetscCall(SNESSetDM(ts->snes, ts->dm));
4381496e6a7aSJed Brown   }
43826c699258SBarry Smith   *dm = ts->dm;
43833ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
43846c699258SBarry Smith }
43851713a123SBarry Smith 
43860f5c6efeSJed Brown /*@
43870f5c6efeSJed Brown   SNESTSFormFunction - Function to evaluate nonlinear residual
43880f5c6efeSJed Brown 
4389c3339decSBarry Smith   Logically Collective
43900f5c6efeSJed Brown 
4391d8d19677SJose E. Roman   Input Parameters:
4392d42a1c89SJed Brown + snes - nonlinear solver
43930910c330SBarry Smith . U    - the current state at which to evaluate the residual
4394d42a1c89SJed Brown - ctx  - user context, must be a TS
43950f5c6efeSJed Brown 
43960f5c6efeSJed Brown   Output Parameter:
43970f5c6efeSJed Brown . F - the nonlinear residual
43980f5c6efeSJed Brown 
43990f5c6efeSJed Brown   Level: advanced
44000f5c6efeSJed Brown 
4401bcf0153eSBarry Smith   Note:
4402bcf0153eSBarry Smith   This function is not normally called by users and is automatically registered with the `SNES` used by `TS`.
4403bcf0153eSBarry Smith   It is most frequently passed to `MatFDColoringSetFunction()`.
4404bcf0153eSBarry Smith 
44051cc06b55SBarry Smith .seealso: [](ch_ts), `SNESSetFunction()`, `MatFDColoringSetFunction()`
44060f5c6efeSJed Brown @*/
4407d71ae5a4SJacob Faibussowitsch PetscErrorCode SNESTSFormFunction(SNES snes, Vec U, Vec F, void *ctx)
4408d71ae5a4SJacob Faibussowitsch {
44090f5c6efeSJed Brown   TS ts = (TS)ctx;
44100f5c6efeSJed Brown 
44110f5c6efeSJed Brown   PetscFunctionBegin;
44120f5c6efeSJed Brown   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
44130910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 2);
44140f5c6efeSJed Brown   PetscValidHeaderSpecific(F, VEC_CLASSID, 3);
44150f5c6efeSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 4);
4416346ce620SStefano Zampini   PetscCheck(ts->ops->snesfunction, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "No method snesfunction for TS of type %s", ((PetscObject)ts)->type_name);
4417346ce620SStefano Zampini   PetscCall((*ts->ops->snesfunction)(snes, U, F, ts));
44183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
44190f5c6efeSJed Brown }
44200f5c6efeSJed Brown 
44210f5c6efeSJed Brown /*@
44220f5c6efeSJed Brown   SNESTSFormJacobian - Function to evaluate the Jacobian
44230f5c6efeSJed Brown 
4424c3339decSBarry Smith   Collective
44250f5c6efeSJed Brown 
4426d8d19677SJose E. Roman   Input Parameters:
44270f5c6efeSJed Brown + snes - nonlinear solver
44280910c330SBarry Smith . U    - the current state at which to evaluate the residual
4429bcf0153eSBarry Smith - ctx  - user context, must be a `TS`
44300f5c6efeSJed Brown 
4431d8d19677SJose E. Roman   Output Parameters:
44320f5c6efeSJed Brown + A - the Jacobian
44336b867d5aSJose E. Roman - B - the preconditioning matrix (may be the same as A)
44340f5c6efeSJed Brown 
44350f5c6efeSJed Brown   Level: developer
44360f5c6efeSJed Brown 
4437bcf0153eSBarry Smith   Note:
4438bcf0153eSBarry Smith   This function is not normally called by users and is automatically registered with the `SNES` used by `TS`.
4439bcf0153eSBarry Smith 
44401cc06b55SBarry Smith .seealso: [](ch_ts), `SNESSetJacobian()`
44410f5c6efeSJed Brown @*/
4442d71ae5a4SJacob Faibussowitsch PetscErrorCode SNESTSFormJacobian(SNES snes, Vec U, Mat A, Mat B, void *ctx)
4443d71ae5a4SJacob Faibussowitsch {
44440f5c6efeSJed Brown   TS ts = (TS)ctx;
44450f5c6efeSJed Brown 
44460f5c6efeSJed Brown   PetscFunctionBegin;
44470f5c6efeSJed Brown   PetscValidHeaderSpecific(snes, SNES_CLASSID, 1);
44480910c330SBarry Smith   PetscValidHeaderSpecific(U, VEC_CLASSID, 2);
444994ab13aaSBarry Smith   PetscValidHeaderSpecific(A, MAT_CLASSID, 3);
445094ab13aaSBarry Smith   PetscValidHeaderSpecific(B, MAT_CLASSID, 4);
4451064a246eSJacob Faibussowitsch   PetscValidHeaderSpecific(ts, TS_CLASSID, 5);
4452346ce620SStefano Zampini   PetscCheck(ts->ops->snesjacobian, PetscObjectComm((PetscObject)ts), PETSC_ERR_SUP, "No method snesjacobian for TS of type %s", ((PetscObject)ts)->type_name);
4453346ce620SStefano Zampini   PetscCall((*ts->ops->snesjacobian)(snes, U, A, B, ts));
44543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
44550f5c6efeSJed Brown }
4456325fc9f4SBarry Smith 
44570e4ef248SJed Brown /*@C
44589ae8fd06SBarry Smith   TSComputeRHSFunctionLinear - Evaluate the right hand side via the user-provided Jacobian, for linear problems Udot = A U only
44590e4ef248SJed Brown 
4460c3339decSBarry Smith   Collective
44610e4ef248SJed Brown 
44624165533cSJose E. Roman   Input Parameters:
44630e4ef248SJed Brown + ts  - time stepping context
44640e4ef248SJed Brown . t   - time at which to evaluate
44650910c330SBarry Smith . U   - state at which to evaluate
44660e4ef248SJed Brown - ctx - context
44670e4ef248SJed Brown 
44684165533cSJose E. Roman   Output Parameter:
44690e4ef248SJed Brown . F - right hand side
44700e4ef248SJed Brown 
44710e4ef248SJed Brown   Level: intermediate
44720e4ef248SJed Brown 
4473bcf0153eSBarry Smith   Note:
4474bcf0153eSBarry Smith   This function is intended to be passed to `TSSetRHSFunction()` to evaluate the right hand side for linear problems.
4475bcf0153eSBarry Smith   The matrix (and optionally the evaluation context) should be passed to `TSSetRHSJacobian()`.
44760e4ef248SJed Brown 
44771cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSSetRHSJacobian()`, `TSComputeRHSJacobianConstant()`
44780e4ef248SJed Brown @*/
4479d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeRHSFunctionLinear(TS ts, PetscReal t, Vec U, Vec F, void *ctx)
4480d71ae5a4SJacob Faibussowitsch {
44810e4ef248SJed Brown   Mat Arhs, Brhs;
44820e4ef248SJed Brown 
44830e4ef248SJed Brown   PetscFunctionBegin;
44849566063dSJacob Faibussowitsch   PetscCall(TSGetRHSMats_Private(ts, &Arhs, &Brhs));
44852663174eSHong Zhang   /* undo the damage caused by shifting */
44869566063dSJacob Faibussowitsch   PetscCall(TSRecoverRHSJacobian(ts, Arhs, Brhs));
44879566063dSJacob Faibussowitsch   PetscCall(TSComputeRHSJacobian(ts, t, U, Arhs, Brhs));
44889566063dSJacob Faibussowitsch   PetscCall(MatMult(Arhs, U, F));
44893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
44900e4ef248SJed Brown }
44910e4ef248SJed Brown 
44920e4ef248SJed Brown /*@C
44930e4ef248SJed Brown   TSComputeRHSJacobianConstant - Reuses a Jacobian that is time-independent.
44940e4ef248SJed Brown 
4495c3339decSBarry Smith   Collective
44960e4ef248SJed Brown 
44974165533cSJose E. Roman   Input Parameters:
44980e4ef248SJed Brown + ts  - time stepping context
44990e4ef248SJed Brown . t   - time at which to evaluate
45000910c330SBarry Smith . U   - state at which to evaluate
45010e4ef248SJed Brown - ctx - context
45020e4ef248SJed Brown 
45034165533cSJose E. Roman   Output Parameters:
45040e4ef248SJed Brown + A - pointer to operator
450597bb3fdcSJose E. Roman - B - pointer to preconditioning matrix
45060e4ef248SJed Brown 
45070e4ef248SJed Brown   Level: intermediate
45080e4ef248SJed Brown 
4509bcf0153eSBarry Smith   Note:
4510bcf0153eSBarry Smith   This function is intended to be passed to `TSSetRHSJacobian()` to evaluate the Jacobian for linear time-independent problems.
45110e4ef248SJed Brown 
45121cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSSetRHSJacobian()`, `TSComputeRHSFunctionLinear()`
45130e4ef248SJed Brown @*/
4514d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeRHSJacobianConstant(TS ts, PetscReal t, Vec U, Mat A, Mat B, void *ctx)
4515d71ae5a4SJacob Faibussowitsch {
45160e4ef248SJed Brown   PetscFunctionBegin;
45173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
45180e4ef248SJed Brown }
45190e4ef248SJed Brown 
45200026cea9SSean Farley /*@C
45210026cea9SSean Farley   TSComputeIFunctionLinear - Evaluate the left hand side via the user-provided Jacobian, for linear problems only
45220026cea9SSean Farley 
4523c3339decSBarry Smith   Collective
45240026cea9SSean Farley 
45254165533cSJose E. Roman   Input Parameters:
45260026cea9SSean Farley + ts   - time stepping context
45270026cea9SSean Farley . t    - time at which to evaluate
45280910c330SBarry Smith . U    - state at which to evaluate
45290910c330SBarry Smith . Udot - time derivative of state vector
45300026cea9SSean Farley - ctx  - context
45310026cea9SSean Farley 
45324165533cSJose E. Roman   Output Parameter:
45330026cea9SSean Farley . F - left hand side
45340026cea9SSean Farley 
45350026cea9SSean Farley   Level: intermediate
45360026cea9SSean Farley 
45370026cea9SSean Farley   Notes:
45380910c330SBarry 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
4539bcf0153eSBarry Smith   user is required to write their own `TSComputeIFunction()`.
4540bcf0153eSBarry Smith   This function is intended to be passed to `TSSetIFunction()` to evaluate the left hand side for linear problems.
4541bcf0153eSBarry Smith   The matrix (and optionally the evaluation context) should be passed to `TSSetIJacobian()`.
45420026cea9SSean Farley 
4543bcf0153eSBarry Smith   Note that using this function is NOT equivalent to using `TSComputeRHSFunctionLinear()` since that solves Udot = A U
45449ae8fd06SBarry Smith 
45451cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `TSSetIJacobian()`, `TSComputeIJacobianConstant()`, `TSComputeRHSFunctionLinear()`
45460026cea9SSean Farley @*/
4547d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeIFunctionLinear(TS ts, PetscReal t, Vec U, Vec Udot, Vec F, void *ctx)
4548d71ae5a4SJacob Faibussowitsch {
45490026cea9SSean Farley   Mat A, B;
45500026cea9SSean Farley 
45510026cea9SSean Farley   PetscFunctionBegin;
45529566063dSJacob Faibussowitsch   PetscCall(TSGetIJacobian(ts, &A, &B, NULL, NULL));
45539566063dSJacob Faibussowitsch   PetscCall(TSComputeIJacobian(ts, t, U, Udot, 1.0, A, B, PETSC_TRUE));
45549566063dSJacob Faibussowitsch   PetscCall(MatMult(A, Udot, F));
45553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
45560026cea9SSean Farley }
45570026cea9SSean Farley 
45580026cea9SSean Farley /*@C
45598434afd1SBarry Smith   TSComputeIJacobianConstant - Reuses the matrix previously computed with the provided `TSIJacobianFn` for a semi-implicit DAE or ODE
45600026cea9SSean Farley 
4561c3339decSBarry Smith   Collective
45620026cea9SSean Farley 
45634165533cSJose E. Roman   Input Parameters:
45640026cea9SSean Farley + ts    - time stepping context
45650026cea9SSean Farley . t     - time at which to evaluate
45660910c330SBarry Smith . U     - state at which to evaluate
45670910c330SBarry Smith . Udot  - time derivative of state vector
45680026cea9SSean Farley . shift - shift to apply
45690026cea9SSean Farley - ctx   - context
45700026cea9SSean Farley 
45714165533cSJose E. Roman   Output Parameters:
45720026cea9SSean Farley + A - pointer to operator
4573d1c5d1fcSBarry Smith - B - pointer to matrix from which the preconditioner is built (often `A`)
45740026cea9SSean Farley 
4575b41af12eSJed Brown   Level: advanced
45760026cea9SSean Farley 
45770026cea9SSean Farley   Notes:
4578bcf0153eSBarry Smith   This function is intended to be passed to `TSSetIJacobian()` to evaluate the Jacobian for linear time-independent problems.
45790026cea9SSean Farley 
4580b41af12eSJed Brown   It is only appropriate for problems of the form
4581b41af12eSJed Brown 
4582d1c5d1fcSBarry Smith   $$
4583d1c5d1fcSBarry Smith   M \dot{U} = F(U,t)
4584d1c5d1fcSBarry Smith   $$
4585b41af12eSJed Brown 
4586bcf0153eSBarry Smith   where M is constant and F is non-stiff.  The user must pass M to `TSSetIJacobian()`.  The current implementation only
4587bcf0153eSBarry Smith   works with IMEX time integration methods such as `TSROSW` and `TSARKIMEX`, since there is no support for de-constructing
4588b41af12eSJed Brown   an implicit operator of the form
4589b41af12eSJed Brown 
4590d1c5d1fcSBarry Smith   $$
4591d1c5d1fcSBarry Smith   shift*M + J
4592d1c5d1fcSBarry Smith   $$
4593b41af12eSJed Brown 
4594b41af12eSJed 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
4595b41af12eSJed Brown   a copy of M or reassemble it when requested.
4596b41af12eSJed Brown 
45971cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSROSW`, `TSARKIMEX`, `TSSetIFunction()`, `TSSetIJacobian()`, `TSComputeIFunctionLinear()`
45980026cea9SSean Farley @*/
4599d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeIJacobianConstant(TS ts, PetscReal t, Vec U, Vec Udot, PetscReal shift, Mat A, Mat B, void *ctx)
4600d71ae5a4SJacob Faibussowitsch {
46010026cea9SSean Farley   PetscFunctionBegin;
46029566063dSJacob Faibussowitsch   PetscCall(MatScale(A, shift / ts->ijacobian.shift));
4603b41af12eSJed Brown   ts->ijacobian.shift = shift;
46043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46050026cea9SSean Farley }
4606b41af12eSJed Brown 
4607e817cc15SEmil Constantinescu /*@
4608bcf0153eSBarry Smith   TSGetEquationType - Gets the type of the equation that `TS` is solving.
4609e817cc15SEmil Constantinescu 
4610e817cc15SEmil Constantinescu   Not Collective
4611e817cc15SEmil Constantinescu 
4612e817cc15SEmil Constantinescu   Input Parameter:
4613bcf0153eSBarry Smith . ts - the `TS` context
4614e817cc15SEmil Constantinescu 
4615e817cc15SEmil Constantinescu   Output Parameter:
4616bcf0153eSBarry Smith . equation_type - see `TSEquationType`
4617e817cc15SEmil Constantinescu 
4618e817cc15SEmil Constantinescu   Level: beginner
4619e817cc15SEmil Constantinescu 
46201cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetEquationType()`, `TSEquationType`
4621e817cc15SEmil Constantinescu @*/
4622d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetEquationType(TS ts, TSEquationType *equation_type)
4623d71ae5a4SJacob Faibussowitsch {
4624e817cc15SEmil Constantinescu   PetscFunctionBegin;
4625e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
46264f572ea9SToby Isaac   PetscAssertPointer(equation_type, 2);
4627e817cc15SEmil Constantinescu   *equation_type = ts->equation_type;
46283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4629e817cc15SEmil Constantinescu }
4630e817cc15SEmil Constantinescu 
4631e817cc15SEmil Constantinescu /*@
4632bcf0153eSBarry Smith   TSSetEquationType - Sets the type of the equation that `TS` is solving.
4633e817cc15SEmil Constantinescu 
4634e817cc15SEmil Constantinescu   Not Collective
4635e817cc15SEmil Constantinescu 
4636d8d19677SJose E. Roman   Input Parameters:
4637bcf0153eSBarry Smith + ts            - the `TS` context
4638bcf0153eSBarry Smith - equation_type - see `TSEquationType`
4639e817cc15SEmil Constantinescu 
4640e817cc15SEmil Constantinescu   Level: advanced
4641e817cc15SEmil Constantinescu 
46421cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetEquationType()`, `TSEquationType`
4643e817cc15SEmil Constantinescu @*/
4644d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetEquationType(TS ts, TSEquationType equation_type)
4645d71ae5a4SJacob Faibussowitsch {
4646e817cc15SEmil Constantinescu   PetscFunctionBegin;
4647e817cc15SEmil Constantinescu   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4648e817cc15SEmil Constantinescu   ts->equation_type = equation_type;
46493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4650e817cc15SEmil Constantinescu }
46510026cea9SSean Farley 
46524af1b03aSJed Brown /*@
4653bcf0153eSBarry Smith   TSGetConvergedReason - Gets the reason the `TS` iteration was stopped.
46544af1b03aSJed Brown 
46554af1b03aSJed Brown   Not Collective
46564af1b03aSJed Brown 
46574af1b03aSJed Brown   Input Parameter:
4658bcf0153eSBarry Smith . ts - the `TS` context
46594af1b03aSJed Brown 
46604af1b03aSJed Brown   Output Parameter:
4661bcf0153eSBarry Smith . reason - negative value indicates diverged, positive value converged, see `TSConvergedReason` or the
46624af1b03aSJed Brown             manual pages for the individual convergence tests for complete lists
46634af1b03aSJed Brown 
4664487e0bb9SJed Brown   Level: beginner
46654af1b03aSJed Brown 
4666bcf0153eSBarry Smith   Note:
4667bcf0153eSBarry Smith   Can only be called after the call to `TSSolve()` is complete.
46684af1b03aSJed Brown 
46691cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSSetConvergenceTest()`, `TSConvergedReason`
46704af1b03aSJed Brown @*/
4671d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetConvergedReason(TS ts, TSConvergedReason *reason)
4672d71ae5a4SJacob Faibussowitsch {
46734af1b03aSJed Brown   PetscFunctionBegin;
46744af1b03aSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
46754f572ea9SToby Isaac   PetscAssertPointer(reason, 2);
46764af1b03aSJed Brown   *reason = ts->reason;
46773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46784af1b03aSJed Brown }
46794af1b03aSJed Brown 
4680d6ad946cSShri Abhyankar /*@
4681bcf0153eSBarry Smith   TSSetConvergedReason - Sets the reason for handling the convergence of `TSSolve()`.
4682d6ad946cSShri Abhyankar 
46836b221cbeSPatrick Sanan   Logically Collective; reason must contain common value
4684d6ad946cSShri Abhyankar 
46856b221cbeSPatrick Sanan   Input Parameters:
4686bcf0153eSBarry Smith + ts     - the `TS` context
4687bcf0153eSBarry Smith - reason - negative value indicates diverged, positive value converged, see `TSConvergedReason` or the
4688d6ad946cSShri Abhyankar             manual pages for the individual convergence tests for complete lists
4689d6ad946cSShri Abhyankar 
4690f5abba47SShri Abhyankar   Level: advanced
4691d6ad946cSShri Abhyankar 
4692bcf0153eSBarry Smith   Note:
4693bcf0153eSBarry Smith   Can only be called while `TSSolve()` is active.
4694d6ad946cSShri Abhyankar 
46951cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSConvergedReason`
4696d6ad946cSShri Abhyankar @*/
4697d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetConvergedReason(TS ts, TSConvergedReason reason)
4698d71ae5a4SJacob Faibussowitsch {
4699d6ad946cSShri Abhyankar   PetscFunctionBegin;
4700d6ad946cSShri Abhyankar   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4701d6ad946cSShri Abhyankar   ts->reason = reason;
47023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4703d6ad946cSShri Abhyankar }
4704d6ad946cSShri Abhyankar 
4705cc708dedSBarry Smith /*@
4706bcf0153eSBarry Smith   TSGetSolveTime - Gets the time after a call to `TSSolve()`
4707cc708dedSBarry Smith 
4708cc708dedSBarry Smith   Not Collective
4709cc708dedSBarry Smith 
4710cc708dedSBarry Smith   Input Parameter:
4711bcf0153eSBarry Smith . ts - the `TS` context
4712cc708dedSBarry Smith 
4713cc708dedSBarry Smith   Output Parameter:
4714bcf0153eSBarry Smith . ftime - the final time. This time corresponds to the final time set with `TSSetMaxTime()`
4715cc708dedSBarry Smith 
4716487e0bb9SJed Brown   Level: beginner
4717cc708dedSBarry Smith 
4718bcf0153eSBarry Smith   Note:
4719bcf0153eSBarry Smith   Can only be called after the call to `TSSolve()` is complete.
4720cc708dedSBarry Smith 
47211cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSSetConvergenceTest()`, `TSConvergedReason`
4722cc708dedSBarry Smith @*/
4723d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetSolveTime(TS ts, PetscReal *ftime)
4724d71ae5a4SJacob Faibussowitsch {
4725cc708dedSBarry Smith   PetscFunctionBegin;
4726cc708dedSBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
47274f572ea9SToby Isaac   PetscAssertPointer(ftime, 2);
4728cc708dedSBarry Smith   *ftime = ts->solvetime;
47293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4730cc708dedSBarry Smith }
4731cc708dedSBarry Smith 
47322c18e0fdSBarry Smith /*@
47335ef26d82SJed Brown   TSGetSNESIterations - Gets the total number of nonlinear iterations
47349f67acb7SJed Brown   used by the time integrator.
47359f67acb7SJed Brown 
47369f67acb7SJed Brown   Not Collective
47379f67acb7SJed Brown 
47389f67acb7SJed Brown   Input Parameter:
4739bcf0153eSBarry Smith . ts - `TS` context
47409f67acb7SJed Brown 
47419f67acb7SJed Brown   Output Parameter:
47429f67acb7SJed Brown . nits - number of nonlinear iterations
47439f67acb7SJed Brown 
47449f67acb7SJed Brown   Level: intermediate
47459f67acb7SJed Brown 
4746195e9b02SBarry Smith   Note:
4747bcf0153eSBarry Smith   This counter is reset to zero for each successive call to `TSSolve()`.
4748bcf0153eSBarry Smith 
47491cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetKSPIterations()`
47509f67acb7SJed Brown @*/
4751d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetSNESIterations(TS ts, PetscInt *nits)
4752d71ae5a4SJacob Faibussowitsch {
47539f67acb7SJed Brown   PetscFunctionBegin;
47549f67acb7SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
47554f572ea9SToby Isaac   PetscAssertPointer(nits, 2);
47565ef26d82SJed Brown   *nits = ts->snes_its;
47573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
47589f67acb7SJed Brown }
47599f67acb7SJed Brown 
47609f67acb7SJed Brown /*@
47615ef26d82SJed Brown   TSGetKSPIterations - Gets the total number of linear iterations
47629f67acb7SJed Brown   used by the time integrator.
47639f67acb7SJed Brown 
47649f67acb7SJed Brown   Not Collective
47659f67acb7SJed Brown 
47669f67acb7SJed Brown   Input Parameter:
4767bcf0153eSBarry Smith . ts - `TS` context
47689f67acb7SJed Brown 
47699f67acb7SJed Brown   Output Parameter:
47709f67acb7SJed Brown . lits - number of linear iterations
47719f67acb7SJed Brown 
47729f67acb7SJed Brown   Level: intermediate
47739f67acb7SJed Brown 
4774bcf0153eSBarry Smith   Note:
4775bcf0153eSBarry Smith   This counter is reset to zero for each successive call to `TSSolve()`.
4776bcf0153eSBarry Smith 
47771cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetSNESIterations()`, `SNESGetKSPIterations()`
47789f67acb7SJed Brown @*/
4779d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetKSPIterations(TS ts, PetscInt *lits)
4780d71ae5a4SJacob Faibussowitsch {
47819f67acb7SJed Brown   PetscFunctionBegin;
47829f67acb7SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
47834f572ea9SToby Isaac   PetscAssertPointer(lits, 2);
47845ef26d82SJed Brown   *lits = ts->ksp_its;
47853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
47869f67acb7SJed Brown }
47879f67acb7SJed Brown 
4788cef5090cSJed Brown /*@
4789cef5090cSJed Brown   TSGetStepRejections - Gets the total number of rejected steps.
4790cef5090cSJed Brown 
4791cef5090cSJed Brown   Not Collective
4792cef5090cSJed Brown 
4793cef5090cSJed Brown   Input Parameter:
4794bcf0153eSBarry Smith . ts - `TS` context
4795cef5090cSJed Brown 
4796cef5090cSJed Brown   Output Parameter:
4797cef5090cSJed Brown . rejects - number of steps rejected
4798cef5090cSJed Brown 
4799cef5090cSJed Brown   Level: intermediate
4800cef5090cSJed Brown 
4801bcf0153eSBarry Smith   Note:
4802bcf0153eSBarry Smith   This counter is reset to zero for each successive call to `TSSolve()`.
4803bcf0153eSBarry Smith 
48041cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetSNESFailures()`, `TSSetMaxSNESFailures()`, `TSSetErrorIfStepFails()`
4805cef5090cSJed Brown @*/
4806d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetStepRejections(TS ts, PetscInt *rejects)
4807d71ae5a4SJacob Faibussowitsch {
4808cef5090cSJed Brown   PetscFunctionBegin;
4809cef5090cSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
48104f572ea9SToby Isaac   PetscAssertPointer(rejects, 2);
4811cef5090cSJed Brown   *rejects = ts->reject;
48123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4813cef5090cSJed Brown }
4814cef5090cSJed Brown 
4815cef5090cSJed Brown /*@
4816bcf0153eSBarry Smith   TSGetSNESFailures - Gets the total number of failed `SNES` solves in a `TS`
4817cef5090cSJed Brown 
4818cef5090cSJed Brown   Not Collective
4819cef5090cSJed Brown 
4820cef5090cSJed Brown   Input Parameter:
4821bcf0153eSBarry Smith . ts - `TS` context
4822cef5090cSJed Brown 
4823cef5090cSJed Brown   Output Parameter:
4824cef5090cSJed Brown . fails - number of failed nonlinear solves
4825cef5090cSJed Brown 
4826cef5090cSJed Brown   Level: intermediate
4827cef5090cSJed Brown 
4828bcf0153eSBarry Smith   Note:
4829bcf0153eSBarry Smith   This counter is reset to zero for each successive call to `TSSolve()`.
4830bcf0153eSBarry Smith 
48311cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetStepRejections()`, `TSSetMaxSNESFailures()`
4832cef5090cSJed Brown @*/
4833d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetSNESFailures(TS ts, PetscInt *fails)
4834d71ae5a4SJacob Faibussowitsch {
4835cef5090cSJed Brown   PetscFunctionBegin;
4836cef5090cSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
48374f572ea9SToby Isaac   PetscAssertPointer(fails, 2);
4838cef5090cSJed Brown   *fails = ts->num_snes_failures;
48393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4840cef5090cSJed Brown }
4841cef5090cSJed Brown 
4842cef5090cSJed Brown /*@
4843bcf0153eSBarry Smith   TSSetMaxStepRejections - Sets the maximum number of step rejections before a time step fails
4844cef5090cSJed Brown 
4845cef5090cSJed Brown   Not Collective
4846cef5090cSJed Brown 
4847d8d19677SJose E. Roman   Input Parameters:
4848bcf0153eSBarry Smith + ts      - `TS` context
4849cef5090cSJed Brown - rejects - maximum number of rejected steps, pass -1 for unlimited
4850cef5090cSJed Brown 
4851cef5090cSJed Brown   Options Database Key:
4852cef5090cSJed Brown . -ts_max_reject - Maximum number of step rejections before a step fails
4853cef5090cSJed Brown 
4854cef5090cSJed Brown   Level: intermediate
4855cef5090cSJed Brown 
48561cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `SNES`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxSNESFailures()`, `TSGetStepRejections()`, `TSGetSNESFailures()`, `TSSetErrorIfStepFails()`, `TSGetConvergedReason()`
4857cef5090cSJed Brown @*/
4858d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetMaxStepRejections(TS ts, PetscInt rejects)
4859d71ae5a4SJacob Faibussowitsch {
4860cef5090cSJed Brown   PetscFunctionBegin;
4861cef5090cSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4862cef5090cSJed Brown   ts->max_reject = rejects;
48633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4864cef5090cSJed Brown }
4865cef5090cSJed Brown 
4866cef5090cSJed Brown /*@
4867bcf0153eSBarry Smith   TSSetMaxSNESFailures - Sets the maximum number of failed `SNES` solves
4868cef5090cSJed Brown 
4869cef5090cSJed Brown   Not Collective
4870cef5090cSJed Brown 
4871d8d19677SJose E. Roman   Input Parameters:
4872bcf0153eSBarry Smith + ts    - `TS` context
4873cef5090cSJed Brown - fails - maximum number of failed nonlinear solves, pass -1 for unlimited
4874cef5090cSJed Brown 
4875cef5090cSJed Brown   Options Database Key:
4876cef5090cSJed Brown . -ts_max_snes_failures - Maximum number of nonlinear solve failures
4877cef5090cSJed Brown 
4878cef5090cSJed Brown   Level: intermediate
4879cef5090cSJed Brown 
48801cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `SNES`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetStepRejections()`, `TSGetSNESFailures()`, `SNESGetConvergedReason()`, `TSGetConvergedReason()`
4881cef5090cSJed Brown @*/
4882d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetMaxSNESFailures(TS ts, PetscInt fails)
4883d71ae5a4SJacob Faibussowitsch {
4884cef5090cSJed Brown   PetscFunctionBegin;
4885cef5090cSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4886cef5090cSJed Brown   ts->max_snes_failures = fails;
48873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4888cef5090cSJed Brown }
4889cef5090cSJed Brown 
4890cef5090cSJed Brown /*@
4891195e9b02SBarry Smith   TSSetErrorIfStepFails - Immediately error if no step succeeds during `TSSolve()`
4892cef5090cSJed Brown 
4893cef5090cSJed Brown   Not Collective
4894cef5090cSJed Brown 
4895d8d19677SJose E. Roman   Input Parameters:
4896bcf0153eSBarry Smith + ts  - `TS` context
4897bcf0153eSBarry Smith - err - `PETSC_TRUE` to error if no step succeeds, `PETSC_FALSE` to return without failure
4898cef5090cSJed Brown 
4899cef5090cSJed Brown   Options Database Key:
4900cef5090cSJed Brown . -ts_error_if_step_fails - Error if no step succeeds
4901cef5090cSJed Brown 
4902cef5090cSJed Brown   Level: intermediate
4903cef5090cSJed Brown 
490442747ad1SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSGetSNESIterations()`, `TSGetKSPIterations()`, `TSSetMaxStepRejections()`, `TSGetStepRejections()`, `TSGetSNESFailures()`, `TSGetConvergedReason()`
4905cef5090cSJed Brown @*/
4906d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetErrorIfStepFails(TS ts, PetscBool err)
4907d71ae5a4SJacob Faibussowitsch {
4908cef5090cSJed Brown   PetscFunctionBegin;
4909cef5090cSJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
4910cef5090cSJed Brown   ts->errorifstepfailed = err;
49113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4912cef5090cSJed Brown }
4913cef5090cSJed Brown 
491484df9cb4SJed Brown /*@
4915552698daSJed Brown   TSGetAdapt - Get the adaptive controller context for the current method
491684df9cb4SJed Brown 
49178f14a041SBarry Smith   Collective if controller has not yet been created
491884df9cb4SJed Brown 
49194165533cSJose E. Roman   Input Parameter:
4920ed81e22dSJed Brown . ts - time stepping context
492184df9cb4SJed Brown 
49224165533cSJose E. Roman   Output Parameter:
4923ed81e22dSJed Brown . adapt - adaptive controller
492484df9cb4SJed Brown 
492584df9cb4SJed Brown   Level: intermediate
492684df9cb4SJed Brown 
49271cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSAdapt`, `TSAdaptSetType()`, `TSAdaptChoose()`
492884df9cb4SJed Brown @*/
4929d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetAdapt(TS ts, TSAdapt *adapt)
4930d71ae5a4SJacob Faibussowitsch {
493184df9cb4SJed Brown   PetscFunctionBegin;
493284df9cb4SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
49334f572ea9SToby Isaac   PetscAssertPointer(adapt, 2);
493484df9cb4SJed Brown   if (!ts->adapt) {
49359566063dSJacob Faibussowitsch     PetscCall(TSAdaptCreate(PetscObjectComm((PetscObject)ts), &ts->adapt));
49369566063dSJacob Faibussowitsch     PetscCall(PetscObjectIncrementTabLevel((PetscObject)ts->adapt, (PetscObject)ts, 1));
493784df9cb4SJed Brown   }
4938bec58848SLisandro Dalcin   *adapt = ts->adapt;
49393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
494084df9cb4SJed Brown }
4941d6ebe24aSShri Abhyankar 
49421c3436cfSJed Brown /*@
4943195e9b02SBarry Smith   TSSetTolerances - Set tolerances for local truncation error when using an adaptive controller
49441c3436cfSJed Brown 
49451c3436cfSJed Brown   Logically Collective
49461c3436cfSJed Brown 
49474165533cSJose E. Roman   Input Parameters:
49481c3436cfSJed Brown + ts    - time integration context
4949bcf0153eSBarry Smith . atol  - scalar absolute tolerances, `PETSC_DECIDE` to leave current value
4950195e9b02SBarry Smith . vatol - vector of absolute tolerances or `NULL`, used in preference to atol if present
4951bcf0153eSBarry Smith . rtol  - scalar relative tolerances, `PETSC_DECIDE` to leave current value
4952195e9b02SBarry Smith - vrtol - vector of relative tolerances or `NULL`, used in preference to atol if present
49531c3436cfSJed Brown 
4954195e9b02SBarry Smith   Options Database Keys:
4955a3cdaa26SBarry Smith + -ts_rtol <rtol> - relative tolerance for local truncation error
495667b8a455SSatish Balay - -ts_atol <atol> - Absolute tolerance for local truncation error
4957a3cdaa26SBarry Smith 
4958bcf0153eSBarry Smith   Level: beginner
4959bcf0153eSBarry Smith 
49603ff766beSShri Abhyankar   Notes:
49613ff766beSShri Abhyankar   With PETSc's implicit schemes for DAE problems, the calculation of the local truncation error
49623ff766beSShri Abhyankar   (LTE) includes both the differential and the algebraic variables. If one wants the LTE to be
49633ff766beSShri Abhyankar   computed only for the differential or the algebraic part then this can be done using the vector of
49643ff766beSShri Abhyankar   tolerances vatol. For example, by setting the tolerance vector with the desired tolerance for the
49653ff766beSShri Abhyankar   differential part and infinity for the algebraic part, the LTE calculation will include only the
49663ff766beSShri Abhyankar   differential variables.
49673ff766beSShri Abhyankar 
49681cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSAdapt`, `TSErrorWeightedNorm()`, `TSGetTolerances()`
49691c3436cfSJed Brown @*/
4970d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetTolerances(TS ts, PetscReal atol, Vec vatol, PetscReal rtol, Vec vrtol)
4971d71ae5a4SJacob Faibussowitsch {
49721c3436cfSJed Brown   PetscFunctionBegin;
497313bcc0bdSJacob Faibussowitsch   if (atol != (PetscReal)PETSC_DECIDE && atol != (PetscReal)PETSC_DEFAULT) ts->atol = atol;
49741c3436cfSJed Brown   if (vatol) {
49759566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)vatol));
49769566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ts->vatol));
49771c3436cfSJed Brown     ts->vatol = vatol;
49781c3436cfSJed Brown   }
497913bcc0bdSJacob Faibussowitsch   if (rtol != (PetscReal)PETSC_DECIDE && rtol != (PetscReal)PETSC_DEFAULT) ts->rtol = rtol;
49801c3436cfSJed Brown   if (vrtol) {
49819566063dSJacob Faibussowitsch     PetscCall(PetscObjectReference((PetscObject)vrtol));
49829566063dSJacob Faibussowitsch     PetscCall(VecDestroy(&ts->vrtol));
49831c3436cfSJed Brown     ts->vrtol = vrtol;
49841c3436cfSJed Brown   }
49853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
49861c3436cfSJed Brown }
49871c3436cfSJed Brown 
4988c5033834SJed Brown /*@
4989c5033834SJed Brown   TSGetTolerances - Get tolerances for local truncation error when using adaptive controller
4990c5033834SJed Brown 
4991c5033834SJed Brown   Logically Collective
4992c5033834SJed Brown 
49934165533cSJose E. Roman   Input Parameter:
4994c5033834SJed Brown . ts - time integration context
4995c5033834SJed Brown 
49964165533cSJose E. Roman   Output Parameters:
4997195e9b02SBarry Smith + atol  - scalar absolute tolerances, `NULL` to ignore
4998195e9b02SBarry Smith . vatol - vector of absolute tolerances, `NULL` to ignore
4999195e9b02SBarry Smith . rtol  - scalar relative tolerances, `NULL` to ignore
5000195e9b02SBarry Smith - vrtol - vector of relative tolerances, `NULL` to ignore
5001c5033834SJed Brown 
5002c5033834SJed Brown   Level: beginner
5003c5033834SJed Brown 
50041cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSAdapt`, `TSErrorWeightedNorm()`, `TSSetTolerances()`
5005c5033834SJed Brown @*/
5006d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTolerances(TS ts, PetscReal *atol, Vec *vatol, PetscReal *rtol, Vec *vrtol)
5007d71ae5a4SJacob Faibussowitsch {
5008c5033834SJed Brown   PetscFunctionBegin;
5009c5033834SJed Brown   if (atol) *atol = ts->atol;
5010c5033834SJed Brown   if (vatol) *vatol = ts->vatol;
5011c5033834SJed Brown   if (rtol) *rtol = ts->rtol;
5012c5033834SJed Brown   if (vrtol) *vrtol = ts->vrtol;
50133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5014c5033834SJed Brown }
5015c5033834SJed Brown 
50169c6b16b5SShri Abhyankar /*@
50178a175baeSEmil Constantinescu   TSErrorWeightedNorm - compute a weighted norm of the difference between two state vectors based on supplied absolute and relative tolerances
50181c3436cfSJed Brown 
5019c3339decSBarry Smith   Collective
50201c3436cfSJed Brown 
50214165533cSJose E. Roman   Input Parameters:
50221c3436cfSJed Brown + ts        - time stepping context
5023a4868fbcSLisandro Dalcin . U         - state vector, usually ts->vec_sol
5024a4868fbcSLisandro Dalcin . Y         - state vector to be compared to U
5025bcf0153eSBarry Smith - wnormtype - norm type, either `NORM_2` or `NORM_INFINITY`
50267619abb3SShri 
50274165533cSJose E. Roman   Output Parameters:
5028a2b725a8SWilliam Gropp + norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
50298a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
5030a2b725a8SWilliam Gropp - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
5031a4868fbcSLisandro Dalcin 
5032bcf0153eSBarry Smith   Options Database Key:
5033a4868fbcSLisandro Dalcin . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
5034a4868fbcSLisandro Dalcin 
50351c3436cfSJed Brown   Level: developer
50361c3436cfSJed Brown 
50378c38e02aSSatish Balay .seealso: [](ch_ts), `TS`, `VecErrorWeightedNorms()`, `TSErrorWeightedENorm()`
50381c3436cfSJed Brown @*/
5039d71ae5a4SJacob Faibussowitsch PetscErrorCode TSErrorWeightedNorm(TS ts, Vec U, Vec Y, NormType wnormtype, PetscReal *norm, PetscReal *norma, PetscReal *normr)
5040d71ae5a4SJacob Faibussowitsch {
5041037d63e4SStefano Zampini   PetscInt norma_loc, norm_loc, normr_loc;
50428a175baeSEmil Constantinescu 
50438a175baeSEmil Constantinescu   PetscFunctionBegin;
50448a175baeSEmil Constantinescu   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5045037d63e4SStefano Zampini   PetscCall(VecErrorWeightedNorms(U, Y, NULL, wnormtype, ts->atol, ts->vatol, ts->rtol, ts->vrtol, ts->adapt->ignore_max, norm, &norm_loc, norma, &norma_loc, normr, &normr_loc));
5046037d63e4SStefano Zampini   if (wnormtype == NORM_2) {
5047037d63e4SStefano Zampini     if (norm_loc) *norm = PetscSqrtReal(PetscSqr(*norm) / norm_loc);
5048037d63e4SStefano Zampini     if (norma_loc) *norma = PetscSqrtReal(PetscSqr(*norma) / norma_loc);
5049037d63e4SStefano Zampini     if (normr_loc) *normr = PetscSqrtReal(PetscSqr(*normr) / normr_loc);
50508a175baeSEmil Constantinescu   }
50513c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norm), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norm");
50523c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*norma), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norma");
50533c633725SBarry Smith   PetscCheck(!PetscIsInfOrNanScalar(*normr), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in normr");
50543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
50558a175baeSEmil Constantinescu }
50568a175baeSEmil Constantinescu 
50578a175baeSEmil Constantinescu /*@
50588a175baeSEmil Constantinescu   TSErrorWeightedENorm - compute a weighted error norm based on supplied absolute and relative tolerances
50598a175baeSEmil Constantinescu 
5060c3339decSBarry Smith   Collective
50618a175baeSEmil Constantinescu 
50624165533cSJose E. Roman   Input Parameters:
50638a175baeSEmil Constantinescu + ts        - time stepping context
50648a175baeSEmil Constantinescu . E         - error vector
50658a175baeSEmil Constantinescu . U         - state vector, usually ts->vec_sol
50668a175baeSEmil Constantinescu . Y         - state vector, previous time step
5067bcf0153eSBarry Smith - wnormtype - norm type, either `NORM_2` or `NORM_INFINITY`
50688a175baeSEmil Constantinescu 
50694165533cSJose E. Roman   Output Parameters:
5070a2b725a8SWilliam Gropp + norm  - weighted norm, a value of 1.0 achieves a balance between absolute and relative tolerances
50718a175baeSEmil Constantinescu . norma - weighted norm, a value of 1.0 means that the error meets the absolute tolerance set by the user
5072a2b725a8SWilliam Gropp - normr - weighted norm, a value of 1.0 means that the error meets the relative tolerance set by the user
50738a175baeSEmil Constantinescu 
5074bcf0153eSBarry Smith   Options Database Key:
50758a175baeSEmil Constantinescu . -ts_adapt_wnormtype <wnormtype> - 2, INFINITY
50768a175baeSEmil Constantinescu 
50778a175baeSEmil Constantinescu   Level: developer
50788a175baeSEmil Constantinescu 
50798c38e02aSSatish Balay .seealso: [](ch_ts), `TS`, `VecErrorWeightedNorms()`, `TSErrorWeightedNorm()`
50808a175baeSEmil Constantinescu @*/
5081d71ae5a4SJacob Faibussowitsch PetscErrorCode TSErrorWeightedENorm(TS ts, Vec E, Vec U, Vec Y, NormType wnormtype, PetscReal *norm, PetscReal *norma, PetscReal *normr)
5082d71ae5a4SJacob Faibussowitsch {
5083037d63e4SStefano Zampini   PetscInt norma_loc, norm_loc, normr_loc;
5084037d63e4SStefano Zampini 
50858a175baeSEmil Constantinescu   PetscFunctionBegin;
5086037d63e4SStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5087037d63e4SStefano Zampini   PetscCall(VecErrorWeightedNorms(U, Y, E, wnormtype, ts->atol, ts->vatol, ts->rtol, ts->vrtol, ts->adapt->ignore_max, norm, &norm_loc, norma, &norma_loc, normr, &normr_loc));
5088037d63e4SStefano Zampini   if (wnormtype == NORM_2) {
5089037d63e4SStefano Zampini     if (norm_loc) *norm = PetscSqrtReal(PetscSqr(*norm) / norm_loc);
5090037d63e4SStefano Zampini     if (norma_loc) *norma = PetscSqrtReal(PetscSqr(*norma) / norma_loc);
5091037d63e4SStefano Zampini     if (normr_loc) *normr = PetscSqrtReal(PetscSqr(*normr) / normr_loc);
5092037d63e4SStefano Zampini   }
5093037d63e4SStefano Zampini   PetscCheck(!PetscIsInfOrNanScalar(*norm), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norm");
5094037d63e4SStefano Zampini   PetscCheck(!PetscIsInfOrNanScalar(*norma), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in norma");
5095037d63e4SStefano Zampini   PetscCheck(!PetscIsInfOrNanScalar(*normr), PetscObjectComm((PetscObject)ts), PETSC_ERR_FP, "Infinite or not-a-number generated in normr");
50963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
50978a175baeSEmil Constantinescu }
50988a175baeSEmil Constantinescu 
50998d59e960SJed Brown /*@
51008d59e960SJed Brown   TSSetCFLTimeLocal - Set the local CFL constraint relative to forward Euler
51018d59e960SJed Brown 
5102c3339decSBarry Smith   Logically Collective
51038d59e960SJed Brown 
51044165533cSJose E. Roman   Input Parameters:
51058d59e960SJed Brown + ts      - time stepping context
51068d59e960SJed Brown - cfltime - maximum stable time step if using forward Euler (value can be different on each process)
51078d59e960SJed Brown 
51088d59e960SJed Brown   Note:
51098d59e960SJed Brown   After calling this function, the global CFL time can be obtained by calling TSGetCFLTime()
51108d59e960SJed Brown 
51118d59e960SJed Brown   Level: intermediate
51128d59e960SJed Brown 
51131cc06b55SBarry Smith .seealso: [](ch_ts), `TSGetCFLTime()`, `TSADAPTCFL`
51148d59e960SJed Brown @*/
5115d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetCFLTimeLocal(TS ts, PetscReal cfltime)
5116d71ae5a4SJacob Faibussowitsch {
51178d59e960SJed Brown   PetscFunctionBegin;
51188d59e960SJed Brown   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
51198d59e960SJed Brown   ts->cfltime_local = cfltime;
51208d59e960SJed Brown   ts->cfltime       = -1.;
51213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
51228d59e960SJed Brown }
51238d59e960SJed Brown 
51248d59e960SJed Brown /*@
51258d59e960SJed Brown   TSGetCFLTime - Get the maximum stable time step according to CFL criteria applied to forward Euler
51268d59e960SJed Brown 
5127c3339decSBarry Smith   Collective
51288d59e960SJed Brown 
51294165533cSJose E. Roman   Input Parameter:
51308d59e960SJed Brown . ts - time stepping context
51318d59e960SJed Brown 
51324165533cSJose E. Roman   Output Parameter:
51338d59e960SJed Brown . cfltime - maximum stable time step for forward Euler
51348d59e960SJed Brown 
51358d59e960SJed Brown   Level: advanced
51368d59e960SJed Brown 
51371cc06b55SBarry Smith .seealso: [](ch_ts), `TSSetCFLTimeLocal()`
51388d59e960SJed Brown @*/
5139d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetCFLTime(TS ts, PetscReal *cfltime)
5140d71ae5a4SJacob Faibussowitsch {
51418d59e960SJed Brown   PetscFunctionBegin;
51421e66621cSBarry Smith   if (ts->cfltime < 0) PetscCall(MPIU_Allreduce(&ts->cfltime_local, &ts->cfltime, 1, MPIU_REAL, MPIU_MIN, PetscObjectComm((PetscObject)ts)));
51438d59e960SJed Brown   *cfltime = ts->cfltime;
51443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
51458d59e960SJed Brown }
51468d59e960SJed Brown 
5147d6ebe24aSShri Abhyankar /*@
5148d6ebe24aSShri Abhyankar   TSVISetVariableBounds - Sets the lower and upper bounds for the solution vector. xl <= x <= xu
5149d6ebe24aSShri Abhyankar 
5150d6ebe24aSShri Abhyankar   Input Parameters:
5151bcf0153eSBarry Smith + ts - the `TS` context.
5152d6ebe24aSShri Abhyankar . xl - lower bound.
5153a2b725a8SWilliam Gropp - xu - upper bound.
5154d6ebe24aSShri Abhyankar 
51552bd2b0e6SSatish Balay   Level: advanced
51562bd2b0e6SSatish Balay 
5157bcf0153eSBarry Smith   Note:
5158bcf0153eSBarry Smith   If this routine is not called then the lower and upper bounds are set to
5159bcf0153eSBarry Smith   `PETSC_NINFINITY` and `PETSC_INFINITY` respectively during `SNESSetUp()`.
5160bcf0153eSBarry Smith 
51611cc06b55SBarry Smith .seealso: [](ch_ts), `TS`
5162d6ebe24aSShri Abhyankar @*/
5163d71ae5a4SJacob Faibussowitsch PetscErrorCode TSVISetVariableBounds(TS ts, Vec xl, Vec xu)
5164d71ae5a4SJacob Faibussowitsch {
5165d6ebe24aSShri Abhyankar   SNES snes;
5166d6ebe24aSShri Abhyankar 
5167d6ebe24aSShri Abhyankar   PetscFunctionBegin;
51689566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
51699566063dSJacob Faibussowitsch   PetscCall(SNESVISetVariableBounds(snes, xl, xu));
51703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5171d6ebe24aSShri Abhyankar }
5172d6ebe24aSShri Abhyankar 
5173f9c1d6abSBarry Smith /*@
5174f9c1d6abSBarry Smith   TSComputeLinearStability - computes the linear stability function at a point
5175f9c1d6abSBarry Smith 
5176c3339decSBarry Smith   Collective
5177f9c1d6abSBarry Smith 
5178f9c1d6abSBarry Smith   Input Parameters:
5179bcf0153eSBarry Smith + ts - the `TS` context
51802fe279fdSBarry Smith . xr - real part of input argument
51812fe279fdSBarry Smith - xi - imaginary part of input argument
5182f9c1d6abSBarry Smith 
5183f9c1d6abSBarry Smith   Output Parameters:
51842fe279fdSBarry Smith + yr - real part of function value
51852fe279fdSBarry Smith - yi - imaginary part of function value
5186f9c1d6abSBarry Smith 
5187f9c1d6abSBarry Smith   Level: developer
5188f9c1d6abSBarry Smith 
51891cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `TSComputeIFunction()`
5190f9c1d6abSBarry Smith @*/
5191d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeLinearStability(TS ts, PetscReal xr, PetscReal xi, PetscReal *yr, PetscReal *yi)
5192d71ae5a4SJacob Faibussowitsch {
5193f9c1d6abSBarry Smith   PetscFunctionBegin;
5194f9c1d6abSBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5195dbbe0bcdSBarry Smith   PetscUseTypeMethod(ts, linearstability, xr, xi, yr, yi);
51963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5197f9c1d6abSBarry Smith }
519824655328SShri 
519924655328SShri /*@
5200dcb233daSLisandro Dalcin   TSRestartStep - Flags the solver to restart the next step
5201dcb233daSLisandro Dalcin 
5202c3339decSBarry Smith   Collective
5203dcb233daSLisandro Dalcin 
5204dcb233daSLisandro Dalcin   Input Parameter:
5205bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
5206dcb233daSLisandro Dalcin 
5207dcb233daSLisandro Dalcin   Level: advanced
5208dcb233daSLisandro Dalcin 
5209dcb233daSLisandro Dalcin   Notes:
5210bcf0153eSBarry Smith   Multistep methods like `TSBDF` or Runge-Kutta methods with FSAL property require restarting the solver in the event of
5211dcb233daSLisandro Dalcin   discontinuities. These discontinuities may be introduced as a consequence of explicitly modifications to the solution
5212dcb233daSLisandro Dalcin   vector (which PETSc attempts to detect and handle) or problem coefficients (which PETSc is not able to detect). For
5213bcf0153eSBarry Smith   the sake of correctness and maximum safety, users are expected to call `TSRestart()` whenever they introduce
5214dcb233daSLisandro Dalcin   discontinuities in callback routines (e.g. prestep and poststep routines, or implicit/rhs function routines with
5215dcb233daSLisandro Dalcin   discontinuous source terms).
5216dcb233daSLisandro Dalcin 
52171cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSBDF`, `TSSolve()`, `TSSetPreStep()`, `TSSetPostStep()`
5218dcb233daSLisandro Dalcin @*/
5219d71ae5a4SJacob Faibussowitsch PetscErrorCode TSRestartStep(TS ts)
5220d71ae5a4SJacob Faibussowitsch {
5221dcb233daSLisandro Dalcin   PetscFunctionBegin;
5222dcb233daSLisandro Dalcin   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5223dcb233daSLisandro Dalcin   ts->steprestart = PETSC_TRUE;
52243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5225dcb233daSLisandro Dalcin }
5226dcb233daSLisandro Dalcin 
5227dcb233daSLisandro Dalcin /*@
522824655328SShri   TSRollBack - Rolls back one time step
522924655328SShri 
5230c3339decSBarry Smith   Collective
523124655328SShri 
523224655328SShri   Input Parameter:
5233bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
523424655328SShri 
523524655328SShri   Level: advanced
523624655328SShri 
5237*9dc50cb5SStefano Zampini .seealso: [](ch_ts), `TS`, `TSGetStepRollBack()`, `TSCreate()`, `TSSetUp()`, `TSDestroy()`, `TSSolve()`, `TSSetPreStep()`, `TSSetPreStage()`, `TSInterpolate()`
523824655328SShri @*/
5239d71ae5a4SJacob Faibussowitsch PetscErrorCode TSRollBack(TS ts)
5240d71ae5a4SJacob Faibussowitsch {
524124655328SShri   PetscFunctionBegin;
524224655328SShri   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
52433c633725SBarry Smith   PetscCheck(!ts->steprollback, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONGSTATE, "TSRollBack already called");
5244c61711c8SStefano Zampini   PetscTryTypeMethod(ts, rollback);
5245c61711c8SStefano Zampini   PetscCall(VecCopy(ts->vec_sol0, ts->vec_sol));
524624655328SShri   ts->time_step  = ts->ptime - ts->ptime_prev;
524724655328SShri   ts->ptime      = ts->ptime_prev;
5248be5899b3SLisandro Dalcin   ts->ptime_prev = ts->ptime_prev_rollback;
52492808aa04SLisandro Dalcin   ts->steps--;
5250b3de5cdeSLisandro Dalcin   ts->steprollback = PETSC_TRUE;
52513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
525224655328SShri }
5253aeb4809dSShri Abhyankar 
5254ff22ae23SHong Zhang /*@
5255*9dc50cb5SStefano Zampini   TSGetStepRollBack - Get the internal flag indicating if you are rolling back a step
5256*9dc50cb5SStefano Zampini 
5257*9dc50cb5SStefano Zampini   Not collective
5258*9dc50cb5SStefano Zampini 
5259*9dc50cb5SStefano Zampini   Input Parameter:
5260*9dc50cb5SStefano Zampini . ts - the `TS` context obtained from `TSCreate()`
5261*9dc50cb5SStefano Zampini 
5262*9dc50cb5SStefano Zampini   Output Parameter:
5263*9dc50cb5SStefano Zampini . flg - the rollback flag
5264*9dc50cb5SStefano Zampini 
5265*9dc50cb5SStefano Zampini   Level: advanced
5266*9dc50cb5SStefano Zampini 
5267*9dc50cb5SStefano Zampini .seealso: [](ch_ts), `TS`, `TSCreate()`, `TSRollBack()`
5268*9dc50cb5SStefano Zampini @*/
5269*9dc50cb5SStefano Zampini PetscErrorCode TSGetStepRollBack(TS ts, PetscBool *flg)
5270*9dc50cb5SStefano Zampini {
5271*9dc50cb5SStefano Zampini   PetscFunctionBegin;
5272*9dc50cb5SStefano Zampini   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5273*9dc50cb5SStefano Zampini   PetscAssertPointer(flg, 2);
5274*9dc50cb5SStefano Zampini   *flg = ts->steprollback;
5275*9dc50cb5SStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
5276*9dc50cb5SStefano Zampini }
5277*9dc50cb5SStefano Zampini 
5278*9dc50cb5SStefano Zampini /*@
5279ff22ae23SHong Zhang   TSGetStages - Get the number of stages and stage values
5280ff22ae23SHong Zhang 
5281ff22ae23SHong Zhang   Input Parameter:
5282bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
5283ff22ae23SHong Zhang 
52840429704eSStefano Zampini   Output Parameters:
52850429704eSStefano Zampini + ns - the number of stages
52860429704eSStefano Zampini - Y  - the current stage vectors
52870429704eSStefano Zampini 
5288ff22ae23SHong Zhang   Level: advanced
5289ff22ae23SHong Zhang 
5290bcf0153eSBarry Smith   Note:
5291195e9b02SBarry Smith   Both `ns` and `Y` can be `NULL`.
52920429704eSStefano Zampini 
52931cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSCreate()`
5294ff22ae23SHong Zhang @*/
5295d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetStages(TS ts, PetscInt *ns, Vec **Y)
5296d71ae5a4SJacob Faibussowitsch {
5297ff22ae23SHong Zhang   PetscFunctionBegin;
5298ff22ae23SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
52994f572ea9SToby Isaac   if (ns) PetscAssertPointer(ns, 2);
53004f572ea9SToby Isaac   if (Y) PetscAssertPointer(Y, 3);
53010429704eSStefano Zampini   if (!ts->ops->getstages) {
53020429704eSStefano Zampini     if (ns) *ns = 0;
53030429704eSStefano Zampini     if (Y) *Y = NULL;
5304dbbe0bcdSBarry Smith   } else PetscUseTypeMethod(ts, getstages, ns, Y);
53053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5306ff22ae23SHong Zhang }
5307ff22ae23SHong Zhang 
5308847ff0e1SMatthew G. Knepley /*@C
5309847ff0e1SMatthew G. Knepley   TSComputeIJacobianDefaultColor - Computes the Jacobian using finite differences and coloring to exploit matrix sparsity.
5310847ff0e1SMatthew G. Knepley 
5311c3339decSBarry Smith   Collective
5312847ff0e1SMatthew G. Knepley 
5313847ff0e1SMatthew G. Knepley   Input Parameters:
5314bcf0153eSBarry Smith + ts    - the `TS` context
5315847ff0e1SMatthew G. Knepley . t     - current timestep
5316847ff0e1SMatthew G. Knepley . U     - state vector
5317847ff0e1SMatthew G. Knepley . Udot  - time derivative of state vector
5318847ff0e1SMatthew G. Knepley . shift - shift to apply, see note below
5319847ff0e1SMatthew G. Knepley - ctx   - an optional user context
5320847ff0e1SMatthew G. Knepley 
5321847ff0e1SMatthew G. Knepley   Output Parameters:
5322847ff0e1SMatthew G. Knepley + J - Jacobian matrix (not altered in this routine)
5323195e9b02SBarry Smith - B - newly computed Jacobian matrix to use with preconditioner (generally the same as `J`)
5324847ff0e1SMatthew G. Knepley 
5325847ff0e1SMatthew G. Knepley   Level: intermediate
5326847ff0e1SMatthew G. Knepley 
5327847ff0e1SMatthew G. Knepley   Notes:
5328847ff0e1SMatthew G. Knepley   If F(t,U,Udot)=0 is the DAE, the required Jacobian is
5329847ff0e1SMatthew G. Knepley 
5330847ff0e1SMatthew G. Knepley   dF/dU + shift*dF/dUdot
5331847ff0e1SMatthew G. Knepley 
5332847ff0e1SMatthew G. Knepley   Most users should not need to explicitly call this routine, as it
5333847ff0e1SMatthew G. Knepley   is used internally within the nonlinear solvers.
5334847ff0e1SMatthew G. Knepley 
5335bcf0153eSBarry Smith   This will first try to get the coloring from the `DM`.  If the `DM` type has no coloring
5336847ff0e1SMatthew G. Knepley   routine, then it will try to get the coloring from the matrix.  This requires that the
5337847ff0e1SMatthew G. Knepley   matrix have nonzero entries precomputed.
5338847ff0e1SMatthew G. Knepley 
53391cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetIJacobian()`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()`
5340847ff0e1SMatthew G. Knepley @*/
5341d71ae5a4SJacob Faibussowitsch PetscErrorCode TSComputeIJacobianDefaultColor(TS ts, PetscReal t, Vec U, Vec Udot, PetscReal shift, Mat J, Mat B, void *ctx)
5342d71ae5a4SJacob Faibussowitsch {
5343847ff0e1SMatthew G. Knepley   SNES          snes;
5344847ff0e1SMatthew G. Knepley   MatFDColoring color;
5345847ff0e1SMatthew G. Knepley   PetscBool     hascolor, matcolor = PETSC_FALSE;
5346847ff0e1SMatthew G. Knepley 
5347847ff0e1SMatthew G. Knepley   PetscFunctionBegin;
53489566063dSJacob Faibussowitsch   PetscCall(PetscOptionsGetBool(((PetscObject)ts)->options, ((PetscObject)ts)->prefix, "-ts_fd_color_use_mat", &matcolor, NULL));
53499566063dSJacob Faibussowitsch   PetscCall(PetscObjectQuery((PetscObject)B, "TSMatFDColoring", (PetscObject *)&color));
5350847ff0e1SMatthew G. Knepley   if (!color) {
5351847ff0e1SMatthew G. Knepley     DM         dm;
5352847ff0e1SMatthew G. Knepley     ISColoring iscoloring;
5353847ff0e1SMatthew G. Knepley 
53549566063dSJacob Faibussowitsch     PetscCall(TSGetDM(ts, &dm));
53559566063dSJacob Faibussowitsch     PetscCall(DMHasColoring(dm, &hascolor));
5356847ff0e1SMatthew G. Knepley     if (hascolor && !matcolor) {
53579566063dSJacob Faibussowitsch       PetscCall(DMCreateColoring(dm, IS_COLORING_GLOBAL, &iscoloring));
53589566063dSJacob Faibussowitsch       PetscCall(MatFDColoringCreate(B, iscoloring, &color));
53599566063dSJacob Faibussowitsch       PetscCall(MatFDColoringSetFunction(color, (PetscErrorCode(*)(void))SNESTSFormFunction, (void *)ts));
53609566063dSJacob Faibussowitsch       PetscCall(MatFDColoringSetFromOptions(color));
53619566063dSJacob Faibussowitsch       PetscCall(MatFDColoringSetUp(B, iscoloring, color));
53629566063dSJacob Faibussowitsch       PetscCall(ISColoringDestroy(&iscoloring));
5363847ff0e1SMatthew G. Knepley     } else {
5364847ff0e1SMatthew G. Knepley       MatColoring mc;
5365847ff0e1SMatthew G. Knepley 
53669566063dSJacob Faibussowitsch       PetscCall(MatColoringCreate(B, &mc));
53679566063dSJacob Faibussowitsch       PetscCall(MatColoringSetDistance(mc, 2));
53689566063dSJacob Faibussowitsch       PetscCall(MatColoringSetType(mc, MATCOLORINGSL));
53699566063dSJacob Faibussowitsch       PetscCall(MatColoringSetFromOptions(mc));
53709566063dSJacob Faibussowitsch       PetscCall(MatColoringApply(mc, &iscoloring));
53719566063dSJacob Faibussowitsch       PetscCall(MatColoringDestroy(&mc));
53729566063dSJacob Faibussowitsch       PetscCall(MatFDColoringCreate(B, iscoloring, &color));
53739566063dSJacob Faibussowitsch       PetscCall(MatFDColoringSetFunction(color, (PetscErrorCode(*)(void))SNESTSFormFunction, (void *)ts));
53749566063dSJacob Faibussowitsch       PetscCall(MatFDColoringSetFromOptions(color));
53759566063dSJacob Faibussowitsch       PetscCall(MatFDColoringSetUp(B, iscoloring, color));
53769566063dSJacob Faibussowitsch       PetscCall(ISColoringDestroy(&iscoloring));
5377847ff0e1SMatthew G. Knepley     }
53789566063dSJacob Faibussowitsch     PetscCall(PetscObjectCompose((PetscObject)B, "TSMatFDColoring", (PetscObject)color));
53799566063dSJacob Faibussowitsch     PetscCall(PetscObjectDereference((PetscObject)color));
5380847ff0e1SMatthew G. Knepley   }
53819566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(ts, &snes));
53829566063dSJacob Faibussowitsch   PetscCall(MatFDColoringApply(B, color, U, snes));
5383847ff0e1SMatthew G. Knepley   if (J != B) {
53849566063dSJacob Faibussowitsch     PetscCall(MatAssemblyBegin(J, MAT_FINAL_ASSEMBLY));
53859566063dSJacob Faibussowitsch     PetscCall(MatAssemblyEnd(J, MAT_FINAL_ASSEMBLY));
5386847ff0e1SMatthew G. Knepley   }
53873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5388847ff0e1SMatthew G. Knepley }
538993b34091SDebojyoti Ghosh 
5390b43aa488SJacob Faibussowitsch /*@C
53916bc98fa9SBarry Smith   TSSetFunctionDomainError - Set a function that tests if the current state vector is valid
5392cb9d8021SPierre Barbier de Reuille 
5393cb9d8021SPierre Barbier de Reuille   Input Parameters:
5394bcf0153eSBarry Smith + ts   - the `TS` context
5395bcf0153eSBarry Smith - func - function called within `TSFunctionDomainError()`
53966bc98fa9SBarry Smith 
539720f4b53cSBarry Smith   Calling sequence of `func`:
53988847d985SBarry Smith + ts     - the `TS` context
53996bc98fa9SBarry Smith . time   - the current time (of the stage)
54006bc98fa9SBarry Smith . state  - the state to check if it is valid
5401a144a63fSStefano Zampini - accept - (output parameter) `PETSC_FALSE` if the state is not acceptable, `PETSC_TRUE` if acceptable
5402cb9d8021SPierre Barbier de Reuille 
5403cb9d8021SPierre Barbier de Reuille   Level: intermediate
5404cb9d8021SPierre Barbier de Reuille 
54056bc98fa9SBarry Smith   Notes:
54066bc98fa9SBarry Smith   If an implicit ODE solver is being used then, in addition to providing this routine, the
5407bcf0153eSBarry Smith   user's code should call `SNESSetFunctionDomainError()` when domain errors occur during
5408bcf0153eSBarry Smith   function evaluations where the functions are provided by `TSSetIFunction()` or `TSSetRHSFunction()`.
5409bcf0153eSBarry Smith   Use `TSGetSNES()` to obtain the `SNES` object
54106bc98fa9SBarry Smith 
5411b43aa488SJacob Faibussowitsch   Developer Notes:
5412bcf0153eSBarry Smith   The naming of this function is inconsistent with the `SNESSetFunctionDomainError()`
54136bc98fa9SBarry Smith   since one takes a function pointer and the other does not.
54146bc98fa9SBarry Smith 
54151cc06b55SBarry Smith .seealso: [](ch_ts), `TSAdaptCheckStage()`, `TSFunctionDomainError()`, `SNESSetFunctionDomainError()`, `TSGetSNES()`
5416cb9d8021SPierre Barbier de Reuille @*/
5417a144a63fSStefano Zampini PetscErrorCode TSSetFunctionDomainError(TS ts, PetscErrorCode (*func)(TS ts, PetscReal time, Vec state, PetscBool *accept))
5418d71ae5a4SJacob Faibussowitsch {
5419cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
5420cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5421cb9d8021SPierre Barbier de Reuille   ts->functiondomainerror = func;
54223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5423cb9d8021SPierre Barbier de Reuille }
5424cb9d8021SPierre Barbier de Reuille 
5425cb9d8021SPierre Barbier de Reuille /*@
54266bc98fa9SBarry Smith   TSFunctionDomainError - Checks if the current state is valid
5427cb9d8021SPierre Barbier de Reuille 
5428cb9d8021SPierre Barbier de Reuille   Input Parameters:
5429bcf0153eSBarry Smith + ts        - the `TS` context
54306bc98fa9SBarry Smith . stagetime - time of the simulation
54316bc98fa9SBarry Smith - Y         - state vector to check.
5432cb9d8021SPierre Barbier de Reuille 
5433cb9d8021SPierre Barbier de Reuille   Output Parameter:
5434bcf0153eSBarry Smith . accept - Set to `PETSC_FALSE` if the current state vector is valid.
543596a0c994SBarry Smith 
54366bc98fa9SBarry Smith   Level: developer
54376bc98fa9SBarry Smith 
5438bcf0153eSBarry Smith   Note:
5439bcf0153eSBarry Smith   This function is called by the `TS` integration routines and calls the user provided function (set with `TSSetFunctionDomainError()`)
5440bcf0153eSBarry Smith   to check if the current state is valid.
5441bcf0153eSBarry Smith 
54421cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetFunctionDomainError()`
5443cb9d8021SPierre Barbier de Reuille @*/
5444d71ae5a4SJacob Faibussowitsch PetscErrorCode TSFunctionDomainError(TS ts, PetscReal stagetime, Vec Y, PetscBool *accept)
5445d71ae5a4SJacob Faibussowitsch {
5446cb9d8021SPierre Barbier de Reuille   PetscFunctionBegin;
5447cb9d8021SPierre Barbier de Reuille   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5448cb9d8021SPierre Barbier de Reuille   *accept = PETSC_TRUE;
54491e66621cSBarry Smith   if (ts->functiondomainerror) PetscCall((*ts->functiondomainerror)(ts, stagetime, Y, accept));
54503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5451cb9d8021SPierre Barbier de Reuille }
54521ceb14c0SBarry Smith 
545393b34091SDebojyoti Ghosh /*@C
5454195e9b02SBarry Smith   TSClone - This function clones a time step `TS` object.
545593b34091SDebojyoti Ghosh 
5456d083f849SBarry Smith   Collective
545793b34091SDebojyoti Ghosh 
545893b34091SDebojyoti Ghosh   Input Parameter:
5459bcf0153eSBarry Smith . tsin - The input `TS`
546093b34091SDebojyoti Ghosh 
546193b34091SDebojyoti Ghosh   Output Parameter:
5462bcf0153eSBarry Smith . tsout - The output `TS` (cloned)
54635eca1a21SEmil Constantinescu 
54645eca1a21SEmil Constantinescu   Level: developer
546593b34091SDebojyoti Ghosh 
5466bcf0153eSBarry Smith   Notes:
5467bcf0153eSBarry Smith   This function is used to create a clone of a `TS` object. It is used in `TSARKIMEX` for initializing the slope for first stage explicit methods.
5468bcf0153eSBarry Smith   It will likely be replaced in the future with a mechanism of switching methods on the fly.
5469bcf0153eSBarry Smith 
5470195e9b02SBarry Smith   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
5471195e9b02SBarry Smith .vb
5472195e9b02SBarry Smith  SNES snes_dup = NULL;
5473195e9b02SBarry Smith  TSGetSNES(ts,&snes_dup);
5474195e9b02SBarry Smith  TSSetSNES(ts,snes_dup);
5475195e9b02SBarry Smith .ve
5476bcf0153eSBarry Smith 
54771cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `SNES`, `TSCreate()`, `TSSetType()`, `TSSetUp()`, `TSDestroy()`, `TSSetProblemType()`
547893b34091SDebojyoti Ghosh @*/
5479d71ae5a4SJacob Faibussowitsch PetscErrorCode TSClone(TS tsin, TS *tsout)
5480d71ae5a4SJacob Faibussowitsch {
548193b34091SDebojyoti Ghosh   TS     t;
5482dc846ba4SSatish Balay   SNES   snes_start;
5483dc846ba4SSatish Balay   DM     dm;
5484dc846ba4SSatish Balay   TSType type;
548593b34091SDebojyoti Ghosh 
548693b34091SDebojyoti Ghosh   PetscFunctionBegin;
54874f572ea9SToby Isaac   PetscAssertPointer(tsin, 1);
548893b34091SDebojyoti Ghosh   *tsout = NULL;
548993b34091SDebojyoti Ghosh 
54909566063dSJacob Faibussowitsch   PetscCall(PetscHeaderCreate(t, TS_CLASSID, "TS", "Time stepping", "TS", PetscObjectComm((PetscObject)tsin), TSDestroy, TSView));
549193b34091SDebojyoti Ghosh 
549293b34091SDebojyoti Ghosh   /* General TS description */
549393b34091SDebojyoti Ghosh   t->numbermonitors    = 0;
5494d0c080abSJoseph Pusztay   t->monitorFrequency  = 1;
549593b34091SDebojyoti Ghosh   t->setupcalled       = 0;
549693b34091SDebojyoti Ghosh   t->ksp_its           = 0;
549793b34091SDebojyoti Ghosh   t->snes_its          = 0;
549893b34091SDebojyoti Ghosh   t->nwork             = 0;
54997d51462cSStefano Zampini   t->rhsjacobian.time  = PETSC_MIN_REAL;
550093b34091SDebojyoti Ghosh   t->rhsjacobian.scale = 1.;
550193b34091SDebojyoti Ghosh   t->ijacobian.shift   = 1.;
550293b34091SDebojyoti Ghosh 
55039566063dSJacob Faibussowitsch   PetscCall(TSGetSNES(tsin, &snes_start));
55049566063dSJacob Faibussowitsch   PetscCall(TSSetSNES(t, snes_start));
5505d15a3a53SEmil Constantinescu 
55069566063dSJacob Faibussowitsch   PetscCall(TSGetDM(tsin, &dm));
55079566063dSJacob Faibussowitsch   PetscCall(TSSetDM(t, dm));
550893b34091SDebojyoti Ghosh 
550993b34091SDebojyoti Ghosh   t->adapt = tsin->adapt;
55109566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)t->adapt));
551193b34091SDebojyoti Ghosh 
5512e7069c78SShri   t->trajectory = tsin->trajectory;
55139566063dSJacob Faibussowitsch   PetscCall(PetscObjectReference((PetscObject)t->trajectory));
5514e7069c78SShri 
5515e7069c78SShri   t->event = tsin->event;
55166b10a48eSSatish Balay   if (t->event) t->event->refct++;
5517e7069c78SShri 
551893b34091SDebojyoti Ghosh   t->problem_type      = tsin->problem_type;
551993b34091SDebojyoti Ghosh   t->ptime             = tsin->ptime;
5520e7069c78SShri   t->ptime_prev        = tsin->ptime_prev;
552193b34091SDebojyoti Ghosh   t->time_step         = tsin->time_step;
552293b34091SDebojyoti Ghosh   t->max_time          = tsin->max_time;
552393b34091SDebojyoti Ghosh   t->steps             = tsin->steps;
552493b34091SDebojyoti Ghosh   t->max_steps         = tsin->max_steps;
552593b34091SDebojyoti Ghosh   t->equation_type     = tsin->equation_type;
552693b34091SDebojyoti Ghosh   t->atol              = tsin->atol;
552793b34091SDebojyoti Ghosh   t->rtol              = tsin->rtol;
552893b34091SDebojyoti Ghosh   t->max_snes_failures = tsin->max_snes_failures;
552993b34091SDebojyoti Ghosh   t->max_reject        = tsin->max_reject;
553093b34091SDebojyoti Ghosh   t->errorifstepfailed = tsin->errorifstepfailed;
553193b34091SDebojyoti Ghosh 
55329566063dSJacob Faibussowitsch   PetscCall(TSGetType(tsin, &type));
55339566063dSJacob Faibussowitsch   PetscCall(TSSetType(t, type));
553493b34091SDebojyoti Ghosh 
553593b34091SDebojyoti Ghosh   t->vec_sol = NULL;
553693b34091SDebojyoti Ghosh 
553793b34091SDebojyoti Ghosh   t->cfltime          = tsin->cfltime;
553893b34091SDebojyoti Ghosh   t->cfltime_local    = tsin->cfltime_local;
553993b34091SDebojyoti Ghosh   t->exact_final_time = tsin->exact_final_time;
554093b34091SDebojyoti Ghosh 
5541aea10558SJacob Faibussowitsch   t->ops[0] = tsin->ops[0];
554293b34091SDebojyoti Ghosh 
55430d4fed19SBarry Smith   if (((PetscObject)tsin)->fortran_func_pointers) {
55440d4fed19SBarry Smith     PetscInt i;
55459566063dSJacob Faibussowitsch     PetscCall(PetscMalloc((10) * sizeof(void (*)(void)), &((PetscObject)t)->fortran_func_pointers));
5546ad540459SPierre Jolivet     for (i = 0; i < 10; i++) ((PetscObject)t)->fortran_func_pointers[i] = ((PetscObject)tsin)->fortran_func_pointers[i];
55470d4fed19SBarry Smith   }
554893b34091SDebojyoti Ghosh   *tsout = t;
55493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
555093b34091SDebojyoti Ghosh }
5551f3b1f45cSBarry Smith 
5552d71ae5a4SJacob Faibussowitsch static PetscErrorCode RHSWrapperFunction_TSRHSJacobianTest(void *ctx, Vec x, Vec y)
5553d71ae5a4SJacob Faibussowitsch {
5554f3b1f45cSBarry Smith   TS ts = (TS)ctx;
5555f3b1f45cSBarry Smith 
5556f3b1f45cSBarry Smith   PetscFunctionBegin;
55579566063dSJacob Faibussowitsch   PetscCall(TSComputeRHSFunction(ts, 0, x, y));
55583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5559f3b1f45cSBarry Smith }
5560f3b1f45cSBarry Smith 
5561f3b1f45cSBarry Smith /*@
5562bcf0153eSBarry Smith   TSRHSJacobianTest - Compares the multiply routine provided to the `MATSHELL` with differencing on the `TS` given RHS function.
5563f3b1f45cSBarry Smith 
5564c3339decSBarry Smith   Logically Collective
5565f3b1f45cSBarry Smith 
55662fe279fdSBarry Smith   Input Parameter:
5567b43aa488SJacob Faibussowitsch . ts - the time stepping routine
5568f3b1f45cSBarry Smith 
5569f3b1f45cSBarry Smith   Output Parameter:
5570bcf0153eSBarry Smith . flg - `PETSC_TRUE` if the multiply is likely correct
5571f3b1f45cSBarry Smith 
5572bcf0153eSBarry Smith   Options Database Key:
5573f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult -mat_shell_test_mult_view - run the test at each timestep of the integrator
5574f3b1f45cSBarry Smith 
5575f3b1f45cSBarry Smith   Level: advanced
5576f3b1f45cSBarry Smith 
5577bcf0153eSBarry Smith   Note:
5578195e9b02SBarry Smith   This only works for problems defined using `TSSetRHSFunction()` and Jacobian NOT `TSSetIFunction()` and Jacobian
5579f3b1f45cSBarry Smith 
55801cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `Mat`, `MATSHELL`, `MatCreateShell()`, `MatShellGetContext()`, `MatShellGetOperation()`, `MatShellTestMultTranspose()`, `TSRHSJacobianTestTranspose()`
5581f3b1f45cSBarry Smith @*/
5582d71ae5a4SJacob Faibussowitsch PetscErrorCode TSRHSJacobianTest(TS ts, PetscBool *flg)
5583d71ae5a4SJacob Faibussowitsch {
5584f3b1f45cSBarry Smith   Mat              J, B;
55858434afd1SBarry Smith   TSRHSJacobianFn *func;
5586f3b1f45cSBarry Smith   void            *ctx;
5587f3b1f45cSBarry Smith 
5588f3b1f45cSBarry Smith   PetscFunctionBegin;
55899566063dSJacob Faibussowitsch   PetscCall(TSGetRHSJacobian(ts, &J, &B, &func, &ctx));
55909566063dSJacob Faibussowitsch   PetscCall((*func)(ts, 0.0, ts->vec_sol, J, B, ctx));
55919566063dSJacob Faibussowitsch   PetscCall(MatShellTestMult(J, RHSWrapperFunction_TSRHSJacobianTest, ts->vec_sol, ts, flg));
55923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5593f3b1f45cSBarry Smith }
5594f3b1f45cSBarry Smith 
5595f3b1f45cSBarry Smith /*@C
5596bcf0153eSBarry Smith   TSRHSJacobianTestTranspose - Compares the multiply transpose routine provided to the `MATSHELL` with differencing on the `TS` given RHS function.
5597f3b1f45cSBarry Smith 
5598c3339decSBarry Smith   Logically Collective
5599f3b1f45cSBarry Smith 
56002fe279fdSBarry Smith   Input Parameter:
5601b43aa488SJacob Faibussowitsch . ts - the time stepping routine
5602f3b1f45cSBarry Smith 
5603f3b1f45cSBarry Smith   Output Parameter:
5604bcf0153eSBarry Smith . flg - `PETSC_TRUE` if the multiply is likely correct
5605f3b1f45cSBarry Smith 
5606bcf0153eSBarry Smith   Options Database Key:
5607f3b1f45cSBarry Smith . -ts_rhs_jacobian_test_mult_transpose -mat_shell_test_mult_transpose_view - run the test at each timestep of the integrator
5608f3b1f45cSBarry Smith 
5609bcf0153eSBarry Smith   Level: advanced
5610bcf0153eSBarry Smith 
561195452b02SPatrick Sanan   Notes:
5612195e9b02SBarry Smith   This only works for problems defined using `TSSetRHSFunction()` and Jacobian NOT `TSSetIFunction()` and Jacobian
5613f3b1f45cSBarry Smith 
56141cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `Mat`, `MatCreateShell()`, `MatShellGetContext()`, `MatShellGetOperation()`, `MatShellTestMultTranspose()`, `TSRHSJacobianTest()`
5615f3b1f45cSBarry Smith @*/
5616d71ae5a4SJacob Faibussowitsch PetscErrorCode TSRHSJacobianTestTranspose(TS ts, PetscBool *flg)
5617d71ae5a4SJacob Faibussowitsch {
5618f3b1f45cSBarry Smith   Mat              J, B;
5619f3b1f45cSBarry Smith   void            *ctx;
56208434afd1SBarry Smith   TSRHSJacobianFn *func;
5621f3b1f45cSBarry Smith 
5622f3b1f45cSBarry Smith   PetscFunctionBegin;
56239566063dSJacob Faibussowitsch   PetscCall(TSGetRHSJacobian(ts, &J, &B, &func, &ctx));
56249566063dSJacob Faibussowitsch   PetscCall((*func)(ts, 0.0, ts->vec_sol, J, B, ctx));
56259566063dSJacob Faibussowitsch   PetscCall(MatShellTestMultTranspose(J, RHSWrapperFunction_TSRHSJacobianTest, ts->vec_sol, ts, flg));
56263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5627f3b1f45cSBarry Smith }
56280fe4d17eSHong Zhang 
56290fe4d17eSHong Zhang /*@
56300fe4d17eSHong Zhang   TSSetUseSplitRHSFunction - Use the split RHSFunction when a multirate method is used.
56310fe4d17eSHong Zhang 
563220f4b53cSBarry Smith   Logically Collective
56330fe4d17eSHong Zhang 
5634d8d19677SJose E. Roman   Input Parameters:
56350fe4d17eSHong Zhang + ts                   - timestepping context
5636bcf0153eSBarry Smith - use_splitrhsfunction - `PETSC_TRUE` indicates that the split RHSFunction will be used
56370fe4d17eSHong Zhang 
5638bcf0153eSBarry Smith   Options Database Key:
56390fe4d17eSHong Zhang . -ts_use_splitrhsfunction - <true,false>
56400fe4d17eSHong Zhang 
56410fe4d17eSHong Zhang   Level: intermediate
56420fe4d17eSHong Zhang 
5643bcf0153eSBarry Smith   Note:
5644195e9b02SBarry Smith   This is only for multirate methods
5645bcf0153eSBarry Smith 
56461cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetUseSplitRHSFunction()`
56470fe4d17eSHong Zhang @*/
5648d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetUseSplitRHSFunction(TS ts, PetscBool use_splitrhsfunction)
5649d71ae5a4SJacob Faibussowitsch {
56500fe4d17eSHong Zhang   PetscFunctionBegin;
56510fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
56520fe4d17eSHong Zhang   ts->use_splitrhsfunction = use_splitrhsfunction;
56533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
56540fe4d17eSHong Zhang }
56550fe4d17eSHong Zhang 
56560fe4d17eSHong Zhang /*@
56570fe4d17eSHong Zhang   TSGetUseSplitRHSFunction - Gets whether to use the split RHSFunction when a multirate method is used.
56580fe4d17eSHong Zhang 
565920f4b53cSBarry Smith   Not Collective
56600fe4d17eSHong Zhang 
56610fe4d17eSHong Zhang   Input Parameter:
56620fe4d17eSHong Zhang . ts - timestepping context
56630fe4d17eSHong Zhang 
56640fe4d17eSHong Zhang   Output Parameter:
5665bcf0153eSBarry Smith . use_splitrhsfunction - `PETSC_TRUE` indicates that the split RHSFunction will be used
56660fe4d17eSHong Zhang 
56670fe4d17eSHong Zhang   Level: intermediate
56680fe4d17eSHong Zhang 
56691cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetUseSplitRHSFunction()`
56700fe4d17eSHong Zhang @*/
5671d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetUseSplitRHSFunction(TS ts, PetscBool *use_splitrhsfunction)
5672d71ae5a4SJacob Faibussowitsch {
56730fe4d17eSHong Zhang   PetscFunctionBegin;
56740fe4d17eSHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
56750fe4d17eSHong Zhang   *use_splitrhsfunction = ts->use_splitrhsfunction;
56763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
56770fe4d17eSHong Zhang }
5678d60b7d5cSBarry Smith 
5679d60b7d5cSBarry Smith /*@
5680d60b7d5cSBarry Smith   TSSetMatStructure - sets the relationship between the nonzero structure of the RHS Jacobian matrix to the IJacobian matrix.
5681d60b7d5cSBarry Smith 
5682c3339decSBarry Smith   Logically  Collective
5683d60b7d5cSBarry Smith 
5684d60b7d5cSBarry Smith   Input Parameters:
5685d60b7d5cSBarry Smith + ts  - the time-stepper
5686bcf0153eSBarry Smith - str - the structure (the default is `UNKNOWN_NONZERO_PATTERN`)
5687d60b7d5cSBarry Smith 
5688d60b7d5cSBarry Smith   Level: intermediate
5689d60b7d5cSBarry Smith 
5690bcf0153eSBarry Smith   Note:
5691d60b7d5cSBarry Smith   When the relationship between the nonzero structures is known and supplied the solution process can be much faster
5692d60b7d5cSBarry Smith 
56931cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `MatAXPY()`, `MatStructure`
5694d60b7d5cSBarry Smith  @*/
5695d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetMatStructure(TS ts, MatStructure str)
5696d71ae5a4SJacob Faibussowitsch {
5697d60b7d5cSBarry Smith   PetscFunctionBegin;
5698d60b7d5cSBarry Smith   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
5699d60b7d5cSBarry Smith   ts->axpy_pattern = str;
57003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5701d60b7d5cSBarry Smith }
57024a658b32SHong Zhang 
57034a658b32SHong Zhang /*@
5704bcf0153eSBarry Smith   TSSetTimeSpan - sets the time span. The solution will be computed and stored for each time requested in the span
57054a658b32SHong Zhang 
5706c3339decSBarry Smith   Collective
57074a658b32SHong Zhang 
57084a658b32SHong Zhang   Input Parameters:
57094a658b32SHong Zhang + ts         - the time-stepper
57104a658b32SHong Zhang . n          - number of the time points (>=2)
57114a658b32SHong Zhang - span_times - array of the time points. The first element and the last element are the initial time and the final time respectively.
57124a658b32SHong Zhang 
5713bcf0153eSBarry Smith   Options Database Key:
57144a658b32SHong Zhang . -ts_time_span <t0,...tf> - Sets the time span
57154a658b32SHong Zhang 
5716bcf0153eSBarry Smith   Level: intermediate
57174a658b32SHong Zhang 
57184a658b32SHong Zhang   Notes:
57194a658b32SHong Zhang   The elements in tspan must be all increasing. They correspond to the intermediate points for time integration.
5720bcf0153eSBarry Smith   `TS_EXACTFINALTIME_MATCHSTEP` must be used to make the last time step in each sub-interval match the intermediate points specified.
5721bcf0153eSBarry Smith   The intermediate solutions are saved in a vector array that can be accessed with `TSGetTimeSpanSolutions()`. Thus using time span may
57224a658b32SHong Zhang   pressure the memory system when using a large number of span points.
57234a658b32SHong Zhang 
57241cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetTimeSpan()`, `TSGetTimeSpanSolutions()`
57254a658b32SHong Zhang  @*/
5726d71ae5a4SJacob Faibussowitsch PetscErrorCode TSSetTimeSpan(TS ts, PetscInt n, PetscReal *span_times)
5727d71ae5a4SJacob Faibussowitsch {
57284a658b32SHong Zhang   PetscFunctionBegin;
57294a658b32SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
573063a3b9bcSJacob Faibussowitsch   PetscCheck(n >= 2, PetscObjectComm((PetscObject)ts), PETSC_ERR_ARG_WRONG, "Minimum time span size is 2 but %" PetscInt_FMT " is provided", n);
57314a658b32SHong Zhang   if (ts->tspan && n != ts->tspan->num_span_times) {
57324a658b32SHong Zhang     PetscCall(PetscFree(ts->tspan->span_times));
57334a658b32SHong Zhang     PetscCall(VecDestroyVecs(ts->tspan->num_span_times, &ts->tspan->vecs_sol));
57344a658b32SHong Zhang     PetscCall(PetscMalloc1(n, &ts->tspan->span_times));
57354a658b32SHong Zhang   }
57364a658b32SHong Zhang   if (!ts->tspan) {
57374a658b32SHong Zhang     TSTimeSpan tspan;
57384a658b32SHong Zhang     PetscCall(PetscNew(&tspan));
57394a658b32SHong Zhang     PetscCall(PetscMalloc1(n, &tspan->span_times));
5740e1db57b0SHong Zhang     tspan->reltol  = 1e-6;
5741e1db57b0SHong Zhang     tspan->abstol  = 10 * PETSC_MACHINE_EPSILON;
5742ca4445c7SIlya Fursov     tspan->worktol = 0;
57434a658b32SHong Zhang     ts->tspan      = tspan;
57444a658b32SHong Zhang   }
57454a658b32SHong Zhang   ts->tspan->num_span_times = n;
57464a658b32SHong Zhang   PetscCall(PetscArraycpy(ts->tspan->span_times, span_times, n));
57474a658b32SHong Zhang   PetscCall(TSSetTime(ts, ts->tspan->span_times[0]));
57484a658b32SHong Zhang   PetscCall(TSSetMaxTime(ts, ts->tspan->span_times[n - 1]));
57493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
57504a658b32SHong Zhang }
57514a658b32SHong Zhang 
57524a658b32SHong Zhang /*@C
5753195e9b02SBarry Smith   TSGetTimeSpan - gets the time span set with `TSSetTimeSpan()`
57544a658b32SHong Zhang 
57554a658b32SHong Zhang   Not Collective
57564a658b32SHong Zhang 
57574a658b32SHong Zhang   Input Parameter:
57584a658b32SHong Zhang . ts - the time-stepper
57594a658b32SHong Zhang 
57604a658b32SHong Zhang   Output Parameters:
57614a658b32SHong Zhang + n          - number of the time points (>=2)
5762bcf0153eSBarry Smith - span_times - array of the time points. The first element and the last element are the initial time and the final time respectively.
57634a658b32SHong Zhang 
57644a658b32SHong Zhang   Level: beginner
57654a658b32SHong Zhang 
5766bcf0153eSBarry Smith   Note:
5767195e9b02SBarry Smith   The values obtained are valid until the `TS` object is destroyed.
5768195e9b02SBarry Smith 
5769195e9b02SBarry Smith   Both `n` and `span_times` can be `NULL`.
5770bcf0153eSBarry Smith 
57711cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetTimeSpan()`, `TSGetTimeSpanSolutions()`
57724a658b32SHong Zhang  @*/
5773d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTimeSpan(TS ts, PetscInt *n, const PetscReal **span_times)
5774d71ae5a4SJacob Faibussowitsch {
57754a658b32SHong Zhang   PetscFunctionBegin;
57764a658b32SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
57774f572ea9SToby Isaac   if (n) PetscAssertPointer(n, 2);
57784f572ea9SToby Isaac   if (span_times) PetscAssertPointer(span_times, 3);
57794a658b32SHong Zhang   if (!ts->tspan) {
57804a658b32SHong Zhang     if (n) *n = 0;
57814a658b32SHong Zhang     if (span_times) *span_times = NULL;
57824a658b32SHong Zhang   } else {
57834a658b32SHong Zhang     if (n) *n = ts->tspan->num_span_times;
57844a658b32SHong Zhang     if (span_times) *span_times = ts->tspan->span_times;
57854a658b32SHong Zhang   }
57863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
57874a658b32SHong Zhang }
57884a658b32SHong Zhang 
57894a658b32SHong Zhang /*@
57904a658b32SHong Zhang   TSGetTimeSpanSolutions - Get the number of solutions and the solutions at the time points specified by the time span.
57914a658b32SHong Zhang 
57924a658b32SHong Zhang   Input Parameter:
5793bcf0153eSBarry Smith . ts - the `TS` context obtained from `TSCreate()`
57944a658b32SHong Zhang 
57954a658b32SHong Zhang   Output Parameters:
57964a658b32SHong Zhang + nsol - the number of solutions
57974a658b32SHong Zhang - Sols - the solution vectors
57984a658b32SHong Zhang 
5799bcf0153eSBarry Smith   Level: intermediate
58004a658b32SHong Zhang 
580140bd4cedSHong Zhang   Notes:
5802195e9b02SBarry Smith   Both `nsol` and `Sols` can be `NULL`.
58034a658b32SHong Zhang 
5804195e9b02SBarry Smith   Some time points in the time span may be skipped by `TS` so that `nsol` is less than the number of points specified by `TSSetTimeSpan()`.
5805bcf0153eSBarry Smith   For example, manipulating the step size, especially with a reduced precision, may cause `TS` to step over certain points in the span.
5806bcf0153eSBarry Smith 
58071cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetTimeSpan()`
58084a658b32SHong Zhang @*/
5809d71ae5a4SJacob Faibussowitsch PetscErrorCode TSGetTimeSpanSolutions(TS ts, PetscInt *nsol, Vec **Sols)
5810d71ae5a4SJacob Faibussowitsch {
58114a658b32SHong Zhang   PetscFunctionBegin;
58124a658b32SHong Zhang   PetscValidHeaderSpecific(ts, TS_CLASSID, 1);
58134f572ea9SToby Isaac   if (nsol) PetscAssertPointer(nsol, 2);
58144f572ea9SToby Isaac   if (Sols) PetscAssertPointer(Sols, 3);
58154a658b32SHong Zhang   if (!ts->tspan) {
58164a658b32SHong Zhang     if (nsol) *nsol = 0;
58174a658b32SHong Zhang     if (Sols) *Sols = NULL;
58184a658b32SHong Zhang   } else {
581940bd4cedSHong Zhang     if (nsol) *nsol = ts->tspan->spanctr;
58204a658b32SHong Zhang     if (Sols) *Sols = ts->tspan->vecs_sol;
58214a658b32SHong Zhang   }
58223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
58234a658b32SHong Zhang }
5824d7cfae9bSHong Zhang 
5825d7cfae9bSHong Zhang /*@C
58267b2dc123SHong Zhang   TSPruneIJacobianColor - Remove nondiagonal zeros in the Jacobian matrix and update the `MatMFFD` coloring information.
5827d7cfae9bSHong Zhang 
5828195e9b02SBarry Smith   Collective
5829d7cfae9bSHong Zhang 
5830d7cfae9bSHong Zhang   Input Parameters:
5831195e9b02SBarry Smith + ts - the `TS` context
5832d7cfae9bSHong Zhang . J  - Jacobian matrix (not altered in this routine)
5833195e9b02SBarry Smith - B  - newly computed Jacobian matrix to use with preconditioner
5834d7cfae9bSHong Zhang 
5835d7cfae9bSHong Zhang   Level: intermediate
5836d7cfae9bSHong Zhang 
5837d7cfae9bSHong Zhang   Notes:
5838195e9b02SBarry Smith   This function improves the `MatFDColoring` performance when the Jacobian matrix was over-allocated or contains
5839195e9b02SBarry Smith   many constant zeros entries, which is typically the case when the matrix is generated by a `DM`
5840d7cfae9bSHong Zhang   and multiple fields are involved.
5841d7cfae9bSHong Zhang 
5842d7cfae9bSHong Zhang   Users need to make sure that the Jacobian matrix is properly filled to reflect the sparsity
5843195e9b02SBarry Smith   structure. For `MatFDColoring`, the values of nonzero entries are not important. So one can
58447b2dc123SHong Zhang   usually call `TSComputeIJacobian()` with randomized input vectors to generate a dummy Jacobian.
58457b2dc123SHong Zhang   `TSComputeIJacobian()` should be called before `TSSolve()` but after `TSSetUp()`.
5846d7cfae9bSHong Zhang 
58471cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `MatFDColoring`, `TSComputeIJacobianDefaultColor()`, `MatEliminateZeros()`, `MatFDColoringCreate()`, `MatFDColoringSetFunction()`
5848d7cfae9bSHong Zhang @*/
5849d7cfae9bSHong Zhang PetscErrorCode TSPruneIJacobianColor(TS ts, Mat J, Mat B)
5850d7cfae9bSHong Zhang {
5851d7cfae9bSHong Zhang   MatColoring   mc            = NULL;
5852d7cfae9bSHong Zhang   ISColoring    iscoloring    = NULL;
5853d7cfae9bSHong Zhang   MatFDColoring matfdcoloring = NULL;
5854d7cfae9bSHong Zhang 
5855d7cfae9bSHong Zhang   PetscFunctionBegin;
5856d7cfae9bSHong Zhang   /* Generate new coloring after eliminating zeros in the matrix */
585758c11ad4SPierre Jolivet   PetscCall(MatEliminateZeros(B, PETSC_TRUE));
5858d7cfae9bSHong Zhang   PetscCall(MatColoringCreate(B, &mc));
5859d7cfae9bSHong Zhang   PetscCall(MatColoringSetDistance(mc, 2));
5860d7cfae9bSHong Zhang   PetscCall(MatColoringSetType(mc, MATCOLORINGSL));
5861d7cfae9bSHong Zhang   PetscCall(MatColoringSetFromOptions(mc));
5862d7cfae9bSHong Zhang   PetscCall(MatColoringApply(mc, &iscoloring));
5863d7cfae9bSHong Zhang   PetscCall(MatColoringDestroy(&mc));
5864d7cfae9bSHong Zhang   /* Replace the old coloring with the new one */
5865d7cfae9bSHong Zhang   PetscCall(MatFDColoringCreate(B, iscoloring, &matfdcoloring));
5866d7cfae9bSHong Zhang   PetscCall(MatFDColoringSetFunction(matfdcoloring, (PetscErrorCode(*)(void))SNESTSFormFunction, (void *)ts));
5867d7cfae9bSHong Zhang   PetscCall(MatFDColoringSetFromOptions(matfdcoloring));
5868d7cfae9bSHong Zhang   PetscCall(MatFDColoringSetUp(B, iscoloring, matfdcoloring));
5869d7cfae9bSHong Zhang   PetscCall(PetscObjectCompose((PetscObject)B, "TSMatFDColoring", (PetscObject)matfdcoloring));
5870d7cfae9bSHong Zhang   PetscCall(PetscObjectDereference((PetscObject)matfdcoloring));
5871d7cfae9bSHong Zhang   PetscCall(ISColoringDestroy(&iscoloring));
58723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
5873d7cfae9bSHong Zhang }
5874