xref: /petsc/include/petscts.h (revision 14d0ab18b70ee075d422f67a0c1395817de67fab)
1818ad0c1SBarry Smith /*
2316643e7SJed Brown    User interface for the timestepping package. This package
3f64a0f93SLois Curfman McInnes    is for use in solving time-dependent PDEs.
4818ad0c1SBarry Smith */
56524c165SJacob Faibussowitsch #ifndef PETSCTS_H
626bd1501SBarry Smith #define PETSCTS_H
7ac09b921SBarry Smith 
82c8e378dSBarry Smith #include <petscsnes.h>
9900f6b5bSMatthew G. Knepley #include <petscconvest.h>
10818ad0c1SBarry Smith 
11*14d0ab18SJacob Faibussowitsch /*I <petscts.h> I*/
12*14d0ab18SJacob Faibussowitsch 
13ac09b921SBarry Smith /* SUBMANSEC = TS */
14ac09b921SBarry Smith 
15435da068SBarry Smith /*S
16435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
17435da068SBarry Smith 
18435da068SBarry Smith    Level: beginner
19435da068SBarry Smith 
201cc06b55SBarry Smith .seealso: [](integrator_table), [](ch_ts), `TSCreate()`, `TSSetType()`, `TSType`, `SNES`, `KSP`, `PC`, `TSDestroy()`
21435da068SBarry Smith S*/
22f09e8eb9SSatish Balay typedef struct _p_TS *TS;
23435da068SBarry Smith 
2476bdecfbSBarry Smith /*J
2587497f52SBarry Smith     TSType - String with the name of a PETSc `TS` method.
26435da068SBarry Smith 
27435da068SBarry Smith    Level: beginner
28435da068SBarry Smith 
291cc06b55SBarry Smith .seealso: [](integrator_table), [](ch_ts), `TSSetType()`, `TS`, `TSRegister()`
3076bdecfbSBarry Smith J*/
3119fd82e9SBarry Smith typedef const char *TSType;
329596e0b4SJed Brown #define TSEULER           "euler"
339596e0b4SJed Brown #define TSBEULER          "beuler"
34e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic"
359596e0b4SJed Brown #define TSPSEUDO          "pseudo"
364d91e141SJed Brown #define TSCN              "cn"
379596e0b4SJed Brown #define TSSUNDIALS        "sundials"
384d91e141SJed Brown #define TSRK              "rk"
399596e0b4SJed Brown #define TSPYTHON          "python"
409596e0b4SJed Brown #define TSTHETA           "theta"
4188df8a41SLisandro Dalcin #define TSALPHA           "alpha"
42818efac9SLisandro Dalcin #define TSALPHA2          "alpha2"
4326d28e4eSEmil Constantinescu #define TSGLLE            "glle"
44b6a60446SDebojyoti Ghosh #define TSGLEE            "glee"
45ef7bb5aaSJed Brown #define TSSSP             "ssp"
468a381b04SJed Brown #define TSARKIMEX         "arkimex"
47e27a552bSJed Brown #define TSROSW            "rosw"
487d5697caSHong Zhang #define TSEIMEX           "eimex"
49abadfa0fSMatthew G. Knepley #define TSMIMEX           "mimex"
50211a84d6SLisandro Dalcin #define TSBDF             "bdf"
51d249a78fSBarry Smith #define TSRADAU5          "radau5"
524b84eec9SHong Zhang #define TSMPRK            "mprk"
5340be0ff1SMatthew G. Knepley #define TSDISCGRAD        "discgrad"
54d2567f34SHong Zhang #define TSIRK             "irk"
5540be0ff1SMatthew G. Knepley 
56435da068SBarry Smith /*E
5787497f52SBarry Smith     TSProblemType - Determines the type of problem this `TS` object is to be used to solve
58435da068SBarry Smith 
59195e9b02SBarry Smith    Values:
60195e9b02SBarry Smith  + `TS_LINEAR` - a linear ODE or DAE
61195e9b02SBarry Smith  - `TS_NONLINEAR` - a nonlinear ODE or DAE
62195e9b02SBarry Smith 
63435da068SBarry Smith    Level: beginner
64435da068SBarry Smith 
651cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSCreate()`
66435da068SBarry Smith E*/
679371c9d4SSatish Balay typedef enum {
689371c9d4SSatish Balay   TS_LINEAR,
699371c9d4SSatish Balay   TS_NONLINEAR
709371c9d4SSatish Balay } TSProblemType;
71818ad0c1SBarry Smith 
72b93fea0eSJed Brown /*E
7387497f52SBarry Smith    TSEquationType - type of `TS` problem that is solved
74e817cc15SEmil Constantinescu 
75e817cc15SEmil Constantinescu    Level: beginner
76e817cc15SEmil Constantinescu 
77195e9b02SBarry Smith    Values:
78195e9b02SBarry Smith +  `TS_EQ_UNSPECIFIED` - (default)
7916a05f60SBarry Smith .  `TS_EQ_EXPLICIT` - {ODE and DAE index 1, 2, 3, HI} F(t,U,U_t) := M(t) U_t - G(U,t) = 0
8016a05f60SBarry Smith -  `TS_EQ_IMPLICIT` - {ODE and DAE index 1, 2, 3, HI} F(t,U,U_t) = 0
81e817cc15SEmil Constantinescu 
821cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetEquationType()`, `TSSetEquationType()`
83e817cc15SEmil Constantinescu E*/
84e817cc15SEmil Constantinescu typedef enum {
85e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
86e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
87e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
88e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
89e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
90e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
91e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
92e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
93e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
94e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
95e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
96e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
9719436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
98e817cc15SEmil Constantinescu } TSEquationType;
99e817cc15SEmil Constantinescu PETSC_EXTERN const char *const *TSEquationTypes;
100e817cc15SEmil Constantinescu 
101e817cc15SEmil Constantinescu /*E
10216a05f60SBarry Smith    TSConvergedReason - reason a `TS` method has converged (integrated to the requested time) or not
103b93fea0eSJed Brown 
104195e9b02SBarry Smith    Values:
105195e9b02SBarry Smith +  `TS_CONVERGED_ITERATING`          - this only occurs if `TSGetConvergedReason()` is called during the `TSSolve()`
106195e9b02SBarry Smith .  `TS_CONVERGED_TIME`               - the final time was reached
107195e9b02SBarry Smith .  `TS_CONVERGED_ITS`                - the maximum number of iterations (time-steps) was reached prior to the final time
108195e9b02SBarry Smith .  `TS_CONVERGED_USER`               - user requested termination
109195e9b02SBarry Smith .  `TS_CONVERGED_EVENT`              - user requested termination on event detection
110195e9b02SBarry Smith .  `TS_CONVERGED_PSEUDO_FATOL`       - stops when function norm decreased by a set amount, used only for `TSPSEUDO`
111195e9b02SBarry Smith .  `TS_CONVERGED_PSEUDO_FRTOL`       - stops when function norm decreases below a set amount, used only for `TSPSEUDO`
112195e9b02SBarry Smith .  `TS_DIVERGED_NONLINEAR_SOLVE`     - too many nonlinear solve failures have occurred
113195e9b02SBarry Smith .  `TS_DIVERGED_STEP_REJECTED`       - too many steps were rejected
114195e9b02SBarry Smith .  `TSFORWARD_DIVERGED_LINEAR_SOLVE` - tangent linear solve failed
115195e9b02SBarry Smith -  `TSADJOINT_DIVERGED_LINEAR_SOLVE` - transposed linear solve failed
116195e9b02SBarry Smith 
117b93fea0eSJed Brown    Level: beginner
118b93fea0eSJed Brown 
1191cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetConvergedReason()`
120b93fea0eSJed Brown E*/
121193ac0bcSJed Brown typedef enum {
122193ac0bcSJed Brown   TS_CONVERGED_ITERATING          = 0,
123193ac0bcSJed Brown   TS_CONVERGED_TIME               = 1,
124193ac0bcSJed Brown   TS_CONVERGED_ITS                = 2,
125d6ad946cSShri Abhyankar   TS_CONVERGED_USER               = 3,
1262b7db910SShri Abhyankar   TS_CONVERGED_EVENT              = 4,
1273118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL       = 5,
1283118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL       = 6,
129193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE     = -1,
130b5b4017aSHong Zhang   TS_DIVERGED_STEP_REJECTED       = -2,
13105c9950eSHong Zhang   TSFORWARD_DIVERGED_LINEAR_SOLVE = -3,
13205c9950eSHong Zhang   TSADJOINT_DIVERGED_LINEAR_SOLVE = -4
133193ac0bcSJed Brown } TSConvergedReason;
134014dd563SJed Brown PETSC_EXTERN const char *const *TSConvergedReasons;
1351957e957SBarry Smith 
136b93fea0eSJed Brown /*MC
13787497f52SBarry Smith    TS_CONVERGED_ITERATING - this only occurs if `TSGetConvergedReason()` is called during the `TSSolve()`
138b93fea0eSJed Brown 
139b93fea0eSJed Brown    Level: beginner
140b93fea0eSJed Brown 
1411cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`
142b93fea0eSJed Brown M*/
143b93fea0eSJed Brown 
144b93fea0eSJed Brown /*MC
145b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
146b93fea0eSJed Brown 
147b93fea0eSJed Brown    Level: beginner
148b93fea0eSJed Brown 
1491cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxTime()`, `TSGetMaxTime()`, `TSGetSolveTime()`
150b93fea0eSJed Brown M*/
151b93fea0eSJed Brown 
152b93fea0eSJed Brown /*MC
1531957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
154b93fea0eSJed Brown 
155b93fea0eSJed Brown    Level: beginner
156b93fea0eSJed Brown 
1571cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxSteps()`, `TSGetMaxSteps()`
158b93fea0eSJed Brown M*/
1591957e957SBarry Smith 
160d6ad946cSShri Abhyankar /*MC
161d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
162d6ad946cSShri Abhyankar 
163d6ad946cSShri Abhyankar    Level: beginner
164d6ad946cSShri Abhyankar 
1651cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`
166b93fea0eSJed Brown M*/
167b93fea0eSJed Brown 
168b93fea0eSJed Brown /*MC
169d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
170d76fc68cSShri Abhyankar 
171d76fc68cSShri Abhyankar    Level: beginner
172d76fc68cSShri Abhyankar 
1731cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`
174d76fc68cSShri Abhyankar M*/
175d76fc68cSShri Abhyankar 
176d76fc68cSShri Abhyankar /*MC
17787497f52SBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for `TSPSEUDO`
1783118ae5eSBarry Smith 
1793c7db156SBarry Smith    Options Database Key:
180d5b43468SJose E. Roman .   -ts_pseudo_frtol <rtol> - use specified rtol
1813118ae5eSBarry Smith 
182195e9b02SBarry Smith    Level: beginner
183195e9b02SBarry Smith 
1841cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FATOL`
1853118ae5eSBarry Smith M*/
1863118ae5eSBarry Smith 
1873118ae5eSBarry Smith /*MC
18887497f52SBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for `TSPSEUDO`
1893118ae5eSBarry Smith 
1903c7db156SBarry Smith    Options Database Key:
19167b8a455SSatish Balay .   -ts_pseudo_fatol <atol> - use specified atol
1923118ae5eSBarry Smith 
193195e9b02SBarry Smith    Level: beginner
194195e9b02SBarry Smith 
1951cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FRTOL`
1963118ae5eSBarry Smith M*/
1973118ae5eSBarry Smith 
1983118ae5eSBarry Smith /*MC
199b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
200b93fea0eSJed Brown 
201b93fea0eSJed Brown    Level: beginner
202b93fea0eSJed Brown 
203195e9b02SBarry Smith    Note:
204195e9b02SBarry Smith     See `TSSetMaxSNESFailures()` for how to allow more nonlinear solver failures.
2051957e957SBarry Smith 
2061cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSGetSNES()`, `SNESGetConvergedReason()`, `TSSetMaxSNESFailures()`
207b93fea0eSJed Brown M*/
208b93fea0eSJed Brown 
209b93fea0eSJed Brown /*MC
210b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
211b93fea0eSJed Brown 
212b93fea0eSJed Brown    Level: beginner
213b93fea0eSJed Brown 
21495452b02SPatrick Sanan    Notes:
215195e9b02SBarry Smith     See `TSSetMaxStepRejections()` for how to allow more step rejections.
2161957e957SBarry Smith 
2171cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxStepRejections()`
218b93fea0eSJed Brown M*/
219b93fea0eSJed Brown 
220d6ad946cSShri Abhyankar /*E
221d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
222d6ad946cSShri Abhyankar 
223195e9b02SBarry Smith    Values:
22416a05f60SBarry Smith +  `TS_EXACTFINALTIME_STEPOVER`    - Don't do anything if requested final time is exceeded
225195e9b02SBarry Smith .  `TS_EXACTFINALTIME_INTERPOLATE` - Interpolate back to final time
22616a05f60SBarry Smith -  `TS_EXACTFINALTIME_MATCHSTEP` - Adapt final time step to match the final time requested
227195e9b02SBarry Smith 
228d6ad946cSShri Abhyankar    Level: beginner
229d6ad946cSShri Abhyankar 
2301cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGetConvergedReason()`, `TSSetExactFinalTime()`, `TSGetExactFinalTime()`
231d6ad946cSShri Abhyankar E*/
2329371c9d4SSatish Balay typedef enum {
2339371c9d4SSatish Balay   TS_EXACTFINALTIME_UNSPECIFIED = 0,
2349371c9d4SSatish Balay   TS_EXACTFINALTIME_STEPOVER    = 1,
2359371c9d4SSatish Balay   TS_EXACTFINALTIME_INTERPOLATE = 2,
2369371c9d4SSatish Balay   TS_EXACTFINALTIME_MATCHSTEP   = 3
2379371c9d4SSatish Balay } TSExactFinalTimeOption;
238d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
239d6ad946cSShri Abhyankar 
240000e7ae3SMatthew Knepley /* Logging support */
241014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
242d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2431b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
244000e7ae3SMatthew Knepley 
245607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
246560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2478ba1e511SMatthew Knepley 
248014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm, TS *);
249baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS, TS *);
250014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS *);
251818ad0c1SBarry Smith 
252014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS, TSProblemType);
253014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS, TSProblemType *);
254014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS, PetscInt, PetscReal, Vec);
255014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, void *), void *, PetscErrorCode (*)(void **));
256721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS, const char[], const char[], const char[], PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *), PetscErrorCode (*)(TS, PetscViewerAndFormat *));
257014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
258818ad0c1SBarry Smith 
259014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS, const char[]);
260014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS, const char[]);
261014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS, const char *[]);
262014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
263014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
264014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
265818ad0c1SBarry Smith 
266014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS, Vec);
267014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS, Vec *);
268818ad0c1SBarry Smith 
269efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS, Vec, Vec);
270efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS, Vec *, Vec *);
27157df6a1bSDebojyoti Ghosh 
272642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS, PetscInt *, Vec *);
273642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS, Vec *);
2740a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS, PetscInt, Vec *);
27557df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS, Vec);
2766e2e232bSDebojyoti Ghosh 
277a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), void *);
278cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS, Mat *, PetscErrorCode (**)(TS, PetscReal, Vec, Mat, void *), void **);
279a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS, PetscReal, Vec, Mat);
28033f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Vec, PetscReal, Mat, void *), void *);
28133f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS, PetscReal, Vec, Vec, PetscReal, Mat, PetscBool);
282edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS() then TSComputeRHSJacobianP()", ) PetscErrorCode TSComputeDRDPFunction(TS, PetscReal, Vec, Vec *);
283edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS() then TSComputeRHSJacobian()", ) PetscErrorCode TSComputeDRDUFunction(TS, PetscReal, Vec, Vec *);
2849371c9d4SSatish Balay PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS, Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), void *);
285b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS, PetscReal, Vec, Vec *, Vec, Vec *);
286b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS, PetscReal, Vec, Vec *, Vec, Vec *);
287b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS, PetscReal, Vec, Vec *, Vec, Vec *);
288b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS, PetscReal, Vec, Vec *, Vec, Vec *);
2899371c9d4SSatish Balay PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS, Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), void *);
290b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS, PetscReal, Vec, Vec *, Vec, Vec *);
291b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS, PetscReal, Vec, Vec *, Vec, Vec *);
292b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS, PetscReal, Vec, Vec *, Vec, Vec *);
293b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS, PetscReal, Vec, Vec *, Vec, Vec *);
294b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS, PetscInt, Vec *, Vec *, Vec);
295b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS, PetscInt *, Vec **, Vec **, Vec *);
296ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS, Vec, Mat, Mat);
297a05bf03eSHong Zhang 
298bc952696SBarry Smith /*S
299e91eccc2SStefano Zampini      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)
300bc952696SBarry Smith 
301bc952696SBarry Smith    Level: advanced
302bc952696SBarry Smith 
3031cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectorySetType()`, `TSTrajectoryDestroy()`, `TSTrajectoryReset()`
304bc952696SBarry Smith S*/
305bc952696SBarry Smith typedef struct _p_TSTrajectory *TSTrajectory;
306bc952696SBarry Smith 
307bc952696SBarry Smith /*J
308195e9b02SBarry Smith     TSTrajectoryType - String with the name of a PETSc `TS` trajectory storage method
309bc952696SBarry Smith 
310bc952696SBarry Smith    Level: intermediate
311bc952696SBarry Smith 
3121cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`
313bc952696SBarry Smith J*/
314bc952696SBarry Smith typedef const char *TSTrajectoryType;
315bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
3161c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
3179a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
3182b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
319bc952696SBarry Smith 
320bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
321bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
322bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
323bc952696SBarry Smith 
324bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
3252d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS);
32667a3cfb0SHong Zhang PETSC_EXTERN PetscErrorCode TSRemoveTrajectory(TS);
327bc952696SBarry Smith 
328bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm, TSTrajectory *);
3299a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
330bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory *);
331560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory, PetscViewer);
332fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory, TS, TSTrajectoryType);
333881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory, TS, TSTrajectoryType *);
334bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory, TS, PetscInt, PetscReal, Vec);
335c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory, TS, PetscInt, PetscReal *);
336fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory, TS, PetscInt, PetscReal *, Vec, Vec);
337fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory, TS, PetscReal, Vec *, Vec *);
338fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory, PetscInt *);
339fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory, Vec *, Vec *);
340972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory, TS);
341560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[], PetscErrorCode (*)(TSTrajectory, TS));
342bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
34368bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory, TS);
3449ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory, PetscBool);
3452bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory, PetscBool);
34678fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory, const char *const *);
34708347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory, PetscErrorCode (*)(void *, Vec, Vec *), PetscErrorCode (*)(void *), void *);
348fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory, PetscBool);
349fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory, PetscBool *);
35064fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory, PetscBool);
35164e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory, const char[]);
35264e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory, const char[]);
35378fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS, TSTrajectory *);
354bc952696SBarry Smith 
355dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS, PetscInt, Vec *, Vec *);
356dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS, PetscInt *, Vec **, Vec **);
357edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 12, 0, "TSCreateQuadratureTS() and TSForwardSetSensitivities()", ) PetscErrorCode TSSetCostIntegrand(TS, PetscInt, Vec, PetscErrorCode (*)(TS, PetscReal, Vec, Vec, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, void *), PetscBool, void *);
358dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS, Vec *);
359022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS, PetscReal, Vec, Vec);
360cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS, PetscBool, TS *);
361cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS, PetscBool *, TS *);
362d4aa0a58SBarry Smith 
363dbbe0bcdSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(TS, PetscOptionItems *);
364a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *);
365a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, void *), void *, PetscErrorCode (*)(void **));
366a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
367a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS, const char[], const char[], const char[], PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, PetscViewerAndFormat *), PetscErrorCode (*)(TS, PetscViewerAndFormat *));
368a05bf03eSHong Zhang 
369edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSSetRHSJacobianP()", ) PetscErrorCode TSAdjointSetRHSJacobian(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), void *);
370edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSComputeRHSJacobianP()", ) PetscErrorCode TSAdjointComputeRHSJacobian(TS, PetscReal, Vec, Mat);
371edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS()", ) PetscErrorCode TSAdjointComputeDRDPFunction(TS, PetscReal, Vec, Vec *);
372edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS()", ) PetscErrorCode TSAdjointComputeDRDYFunction(TS, PetscReal, Vec, Vec *);
3732c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
37473b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS, PetscInt);
375d4aa0a58SBarry Smith 
37673b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
377f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
378ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS);
379999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
380ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS, Mat);
381ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS);
382715f1b00SHong Zhang 
38313b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS, PetscInt, Mat);
38413b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS, PetscInt *, Mat *);
385edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 12, 0, "TSCreateQuadratureTS()", ) PetscErrorCode TSForwardSetIntegralGradients(TS, PetscInt, Vec *);
386edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 12, 0, "TSForwardGetSensitivities()", ) PetscErrorCode TSForwardGetIntegralGradients(TS, PetscInt *, Vec **);
387715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
3887adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS);
389999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
390715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
391b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS, Mat);
392cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS, PetscInt *, Mat *[]);
393c235aa8dSHong Zhang 
394618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS, PetscInt);
395618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS, PetscInt *);
396618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS, PetscReal);
397618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS, PetscReal *);
39849354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS, TSExactFinalTimeOption);
399f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS, TSExactFinalTimeOption *);
4004a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSSetTimeSpan(TS, PetscInt, PetscReal *);
4014a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSGetTimeSpan(TS, PetscInt *, const PetscReal **);
4024a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSGetTimeSpanSolutions(TS, PetscInt *, Vec **);
403818ad0c1SBarry Smith 
404edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSSetTime()", ) PetscErrorCode TSSetInitialTimeStep(TS, PetscReal, PetscReal);
405edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSSetMax()", ) PetscErrorCode TSSetDuration(TS, PetscInt, PetscReal);
406edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSGetMax()", ) PetscErrorCode TSGetDuration(TS, PetscInt *, PetscReal *);
407edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSGetStepNumber()", ) PetscErrorCode TSGetTimeStepNumber(TS, PetscInt *);
408edd03b47SJacob Faibussowitsch PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSGetStepNumber()", ) PetscErrorCode TSGetTotalSteps(TS, PetscInt *);
40919eac22cSLisandro Dalcin 
410721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *);
411cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *);
41283a4ac43SBarry Smith 
41383a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx *TSMonitorDrawCtx;
41483a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode         TSMonitorDrawCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorDrawCtx *);
41583a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode         TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *);
41683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode         TSMonitorDrawSolution(TS, PetscInt, PetscReal, Vec, void *);
4172d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode         TSMonitorDrawSolutionPhase(TS, PetscInt, PetscReal, Vec, void *);
41883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode         TSMonitorDrawError(TS, PetscInt, PetscReal, Vec, void *);
4190ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode         TSMonitorDrawSolutionFunction(TS, PetscInt, PetscReal, Vec, void *);
42083a4ac43SBarry Smith 
421721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, PetscViewerAndFormat *);
4229110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, void *);
4239110b2e7SHong Zhang 
424721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *);
425014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS, PetscInt, PetscReal, Vec, void *);
426014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void *);
427fb1732b5SBarry Smith 
428014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
4297cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS, NormType, PetscInt *, PetscReal *);
430014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS, PetscInt, Vec, PetscBool *);
431cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS, Vec);
432e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS, TSEquationType *);
433e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS, TSEquationType);
434014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS, TSConvergedReason *);
435d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS, TSConvergedReason);
436487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS, PetscReal *);
4375ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS, PetscInt *);
4385ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS, PetscInt *);
439cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS, PetscInt *);
440cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS, PetscInt);
441cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS, PetscInt *);
442cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS, PetscInt);
443cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS, PetscBool);
444dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
44524655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
446d2daff3dSHong Zhang 
447cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS, PetscInt *, Vec *[]);
448818ad0c1SBarry Smith 
449014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS, PetscReal *);
450014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS, PetscReal);
451e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS, PetscReal *);
45280275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS, PetscReal *);
45380275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS, PetscReal);
45480275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS, PetscInt *);
45580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS, PetscInt);
456818ad0c1SBarry Smith 
457*14d0ab18SJacob Faibussowitsch /*S
458*14d0ab18SJacob Faibussowitsch   TSRHSFunction - An `TS` right-hand-side evaluation function
459*14d0ab18SJacob Faibussowitsch 
460*14d0ab18SJacob Faibussowitsch   Calling Sequence:
461*14d0ab18SJacob Faibussowitsch + ts  - timestep context
462*14d0ab18SJacob Faibussowitsch . t   - current time
463*14d0ab18SJacob Faibussowitsch . u   - input vector
464*14d0ab18SJacob Faibussowitsch . F   - function vector
465*14d0ab18SJacob Faibussowitsch - ctx - [optional] user-defined function context
466*14d0ab18SJacob Faibussowitsch 
467*14d0ab18SJacob Faibussowitsch   Level: beginner
468*14d0ab18SJacob Faibussowitsch 
469*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `DMTSSetRHSFunction()`, `TSIFunction()`,
470*14d0ab18SJacob Faibussowitsch `TSIJacobian()`, `TSRHSJacobian()`
471*14d0ab18SJacob Faibussowitsch S*/
472*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS ts, PetscReal t, Vec u, Vec F, void *ctx);
473*14d0ab18SJacob Faibussowitsch 
474*14d0ab18SJacob Faibussowitsch /*S
475*14d0ab18SJacob Faibussowitsch   TSRHSJacobian - A `TS` right-hand-side Jacobian evaluation function
476*14d0ab18SJacob Faibussowitsch 
477*14d0ab18SJacob Faibussowitsch   Calling Sequence:
478*14d0ab18SJacob Faibussowitsch + ts   - the `TS` context obtained from `TSCreate()`
479*14d0ab18SJacob Faibussowitsch . t    - current time
480*14d0ab18SJacob Faibussowitsch . u    - input vector
481*14d0ab18SJacob Faibussowitsch . Amat - (approximate) Jacobian matrix
482*14d0ab18SJacob Faibussowitsch . Pmat - matrix from which preconditioner is to be constructed (usually the same as Amat)
483*14d0ab18SJacob Faibussowitsch - ctx  - [optional] user-defined context for matrix evaluation routine
484*14d0ab18SJacob Faibussowitsch 
485*14d0ab18SJacob Faibussowitsch   Level: beginner
486*14d0ab18SJacob Faibussowitsch 
487*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetRHSJacobian()`, `DMTSSetRHSJacobian()`, `TSRHSFunction()`,
488*14d0ab18SJacob Faibussowitsch `TSIFunction()`, `TSIJacobian()`
489*14d0ab18SJacob Faibussowitsch S*/
490*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS ts, PetscReal t, Vec u, Mat Amat, Mat Pmat, void *ctx);
491*14d0ab18SJacob Faibussowitsch 
492*14d0ab18SJacob Faibussowitsch /*S
493*14d0ab18SJacob Faibussowitsch   TSRHSJacobianP - A function that computes the Jacobian of G w.r.t. the parameters P where U_t
494*14d0ab18SJacob Faibussowitsch   = G(U,P,t), as well as the location to store the matrix.
495*14d0ab18SJacob Faibussowitsch 
496*14d0ab18SJacob Faibussowitsch   Calling Sequence:
497*14d0ab18SJacob Faibussowitsch + ts  - the `TS` context
498*14d0ab18SJacob Faibussowitsch . t   - current timestep
499*14d0ab18SJacob Faibussowitsch . U   - input vector (current ODE solution)
500*14d0ab18SJacob Faibussowitsch . A   - output matrix
501*14d0ab18SJacob Faibussowitsch - ctx - [optional] user-defined function context
502*14d0ab18SJacob Faibussowitsch 
503*14d0ab18SJacob Faibussowitsch   Level: beginner
504*14d0ab18SJacob Faibussowitsch 
505*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetRHSJacobianP()`, `TSGetRHSJacobianP()`
506*14d0ab18SJacob Faibussowitsch S*/
507*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS ts, PetscReal t, Vec U, Mat A, void *ctx);
508*14d0ab18SJacob Faibussowitsch 
509014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS, Vec, TSRHSFunction, void *);
510014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS, Vec *, TSRHSFunction *, void **);
511014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS, Mat, Mat, TSRHSJacobian, void *);
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS, Mat *, Mat *, TSRHSJacobian *, void **);
513e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS, PetscBool);
514818ad0c1SBarry Smith 
515*14d0ab18SJacob Faibussowitsch /*S
516*14d0ab18SJacob Faibussowitsch   TSSolutionFunction - A `TS` solution evaluation function
517*14d0ab18SJacob Faibussowitsch 
518*14d0ab18SJacob Faibussowitsch   Calling Sequence:
519*14d0ab18SJacob Faibussowitsch + ts  - timestep context
520*14d0ab18SJacob Faibussowitsch . t   - current time
521*14d0ab18SJacob Faibussowitsch . u   - output vector
522*14d0ab18SJacob Faibussowitsch - ctx - [optional] user-defined function context
523*14d0ab18SJacob Faibussowitsch 
524*14d0ab18SJacob Faibussowitsch   Level: advanced
525*14d0ab18SJacob Faibussowitsch 
526*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `DMTSSetSolutionFunction()`
527*14d0ab18SJacob Faibussowitsch S*/
528*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS ts, PetscReal t, Vec u, void *ctx);
529*14d0ab18SJacob Faibussowitsch 
530ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS, TSSolutionFunction, void *);
531*14d0ab18SJacob Faibussowitsch 
532*14d0ab18SJacob Faibussowitsch /*S
533*14d0ab18SJacob Faibussowitsch   TSForcingFunction - A `TS` forcing function evaluation function
534*14d0ab18SJacob Faibussowitsch 
535*14d0ab18SJacob Faibussowitsch   Calling Sequence:
536*14d0ab18SJacob Faibussowitsch + ts  - timestep context
537*14d0ab18SJacob Faibussowitsch . t   - current time
538*14d0ab18SJacob Faibussowitsch . f   - output vector
539*14d0ab18SJacob Faibussowitsch - ctx - [optional] user-defined function context
540*14d0ab18SJacob Faibussowitsch 
541*14d0ab18SJacob Faibussowitsch   Level: advanced
542*14d0ab18SJacob Faibussowitsch 
543*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetForcingFunction()`, `DMTSSetForcingFunction()`
544*14d0ab18SJacob Faibussowitsch S*/
545*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS ts, PetscReal t, Vec f, void *ctx);
546*14d0ab18SJacob Faibussowitsch 
547d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS, TSForcingFunction, void *);
548ef20d060SBarry Smith 
549*14d0ab18SJacob Faibussowitsch /*S
550*14d0ab18SJacob Faibussowitsch   TSIFunction - A `TS` implicit function evaluation function
551*14d0ab18SJacob Faibussowitsch 
552*14d0ab18SJacob Faibussowitsch   Calling Sequence:
553*14d0ab18SJacob Faibussowitsch + ts  - the `TS` context obtained from `TSCreate()`
554*14d0ab18SJacob Faibussowitsch . t   - time at step/stage being solved
555*14d0ab18SJacob Faibussowitsch . U   - state vector
556*14d0ab18SJacob Faibussowitsch . U_t - time derivative of state vector
557*14d0ab18SJacob Faibussowitsch . F   - function vector
558*14d0ab18SJacob Faibussowitsch - ctx - [optional] user-defined context for function
559*14d0ab18SJacob Faibussowitsch 
560*14d0ab18SJacob Faibussowitsch   Level: beginner
561*14d0ab18SJacob Faibussowitsch 
562*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `DMTSSetIFunction()`, `TSIJacobian()`, `TSRHSFunction()`, `TSRHSJacobian()`
563*14d0ab18SJacob Faibussowitsch S*/
564*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS ts, PetscReal t, Vec U, Vec U_tt, Vec F, void *ctx);
565*14d0ab18SJacob Faibussowitsch 
566*14d0ab18SJacob Faibussowitsch /*S
567*14d0ab18SJacob Faibussowitsch   TSIJacobian - A `TS` Jacobian evaluation function
568*14d0ab18SJacob Faibussowitsch 
569*14d0ab18SJacob Faibussowitsch   Calling Sequence:
570*14d0ab18SJacob Faibussowitsch + ts   - the `TS` context obtained from `TSCreate()`
571*14d0ab18SJacob Faibussowitsch . t    - time at step/stage being solved
572*14d0ab18SJacob Faibussowitsch . U    - state vector
573*14d0ab18SJacob Faibussowitsch . U_t  - time derivative of state vector
574*14d0ab18SJacob Faibussowitsch . a    - shift
575*14d0ab18SJacob Faibussowitsch . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t
576*14d0ab18SJacob Faibussowitsch . Pmat - matrix used for constructing preconditioner, usually the same as `Amat`
577*14d0ab18SJacob Faibussowitsch - ctx  - [optional] user-defined context for Jacobian evaluation routine
578*14d0ab18SJacob Faibussowitsch 
579*14d0ab18SJacob Faibussowitsch   Level: beginner
580*14d0ab18SJacob Faibussowitsch 
581*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TSSetIJacobian()`, `DMTSSetIJacobian()`, `TSIFunction()`, `TSRHSFunction()`, `TSRHSJacobian()`
582*14d0ab18SJacob Faibussowitsch S*/
583*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS ts, PetscReal t, Vec U, Vec U_t, PetscReal a, Mat Amat, Mat Pmat, void *ctx);
584*14d0ab18SJacob Faibussowitsch 
585014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS, Vec, TSIFunction, void *);
586014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS, Vec *, TSIFunction *, void **);
587014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS, Mat, Mat, TSIJacobian, void *);
588014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS, Mat *, Mat *, TSIJacobian *, void **);
589316643e7SJed Brown 
590*14d0ab18SJacob Faibussowitsch /*S
591*14d0ab18SJacob Faibussowitsch   TSI2Function - A `TS` implicit function evaluation function for 2nd order systems
592*14d0ab18SJacob Faibussowitsch 
593*14d0ab18SJacob Faibussowitsch   Calling Sequence:
594*14d0ab18SJacob Faibussowitsch + ts   - the `TS` context obtained from `TSCreate()`
595*14d0ab18SJacob Faibussowitsch . t    - time at step/stage being solved
596*14d0ab18SJacob Faibussowitsch . U    - state vector
597*14d0ab18SJacob Faibussowitsch . U_t  - time derivative of state vector
598*14d0ab18SJacob Faibussowitsch . U_tt - second time derivative of state vector
599*14d0ab18SJacob Faibussowitsch . F    - function vector
600*14d0ab18SJacob Faibussowitsch - ctx  - [optional] user-defined context for matrix evaluation routine (may be `NULL`)
601*14d0ab18SJacob Faibussowitsch 
602*14d0ab18SJacob Faibussowitsch   Level: advanced
603*14d0ab18SJacob Faibussowitsch 
604*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetI2Function()`, `DMTSSetI2Function()`
605*14d0ab18SJacob Faibussowitsch S*/
606*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS ts, PetscReal t, Vec U, Vec U_t, Vec U_tt, Vec F, void *ctx);
607*14d0ab18SJacob Faibussowitsch 
608*14d0ab18SJacob Faibussowitsch /*S
609*14d0ab18SJacob Faibussowitsch   TSI2Jacobian - A `TS` implicit Jacobian evaluation function for 2nd order systems
610*14d0ab18SJacob Faibussowitsch 
611*14d0ab18SJacob Faibussowitsch   Calling Sequence:
612*14d0ab18SJacob Faibussowitsch + ts   - the `TS` context obtained from `TSCreate()`
613*14d0ab18SJacob Faibussowitsch . t    - time at step/stage being solved
614*14d0ab18SJacob Faibussowitsch . U    - state vector
615*14d0ab18SJacob Faibussowitsch . U_t  - time derivative of state vector
616*14d0ab18SJacob Faibussowitsch . U_tt - second time derivative of state vector
617*14d0ab18SJacob Faibussowitsch . v    - shift for U_t
618*14d0ab18SJacob Faibussowitsch . a    - shift for U_tt
619*14d0ab18SJacob Faibussowitsch . J    - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t  + a*dF/dU_tt
620*14d0ab18SJacob Faibussowitsch . jac  - matrix from which to construct the preconditioner, may be same as `J`
621*14d0ab18SJacob Faibussowitsch - ctx  - [optional] user-defined context for matrix evaluation routine
622*14d0ab18SJacob Faibussowitsch 
623*14d0ab18SJacob Faibussowitsch   Level: advanced
624*14d0ab18SJacob Faibussowitsch 
625*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetI2Jacobian()`, `DMTSSetI2Jacobian()`, `TSIFunction()`, `TSIJacobian()`, `TSRHSFunction()`, `TSRHSJacobian()`
626*14d0ab18SJacob Faibussowitsch S*/
627*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS ts, PetscReal t, Vec U, Vec U_t, Vec U_tt, PetscReal v, PetscReal a, Mat J, Mat Jac, void *ctx);
628*14d0ab18SJacob Faibussowitsch 
629efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS, Vec, TSI2Function, void *);
630efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS, Vec *, TSI2Function *, void **);
631efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS, Mat, Mat, TSI2Jacobian, void *);
632efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS, Mat *, Mat *, TSI2Jacobian *, void **);
633efe9872eSLisandro Dalcin 
634545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS, const char[], IS);
635545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS, const char[], IS *);
636545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS, const char[], Vec, TSRHSFunction, void *);
6371d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS, const char[], TS *);
6381d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS, PetscInt *, TS *[]);
6390fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
6400fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool *);
641d9194312SHong Zhang 
642014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS, PetscReal, Vec, Vec, void *);
643d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS, PetscReal, Vec, Mat, Mat, void *);
644014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS, PetscReal, Vec, Vec, Vec, void *);
645d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *);
6461c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS, PetscReal, Vec);
6479b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS, PetscReal, Vec);
648847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *);
649d7cfae9bSHong Zhang PETSC_EXTERN PetscErrorCode TSPruneIJacobianColor(TS, Mat, Mat);
650e34be4c2SBarry Smith 
651014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
652b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS, PetscReal));
6539be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS, PetscReal, PetscInt, Vec *));
654c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode (*)(TS));
655014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
6566bd3a4fdSStefano Zampini PETSC_EXTERN PetscErrorCode TSSetResize(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscBool *, void *), PetscErrorCode (*)(TS, PetscInt, Vec[], Vec[], void *), void *);
657014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
658b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS, PetscReal);
6599be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS, PetscReal, PetscInt, Vec *);
660c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
661014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
6626bd3a4fdSStefano Zampini PETSC_EXTERN PetscErrorCode TSResize(TS);
6636bd3a4fdSStefano Zampini PETSC_EXTERN PetscErrorCode TSResizeRetrieveVec(TS, const char *, Vec *);
6646bd3a4fdSStefano Zampini PETSC_EXTERN PetscErrorCode TSResizeRegisterVec(TS, const char *, Vec);
6656bd3a4fdSStefano Zampini 
666014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS, PetscReal, Vec);
667014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS, PetscReal, Vec, PetscReal, Vec);
668c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS, PetscReal *, Vec *, PetscReal *, Vec *);
6697453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS, Vec, Vec, NormType, PetscReal *, PetscReal *, PetscReal *);
6708a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS, Vec, Vec, Vec, NormType, PetscReal *, PetscReal *, PetscReal *);
671014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS, PetscReal);
672014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS, PetscReal *);
673d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS, PetscReal, Vec, PetscBool *));
674d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS, PetscReal, Vec, PetscBool *);
675000e7ae3SMatthew Knepley 
676014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS, PetscErrorCode (*)(TS, PetscReal *, void *), void *);
6778d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS, PetscReal *, void *);
678014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS, PetscReal *);
679014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS, PetscReal);
680014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS, PetscErrorCode (*)(TS, Vec, void *, PetscReal *, PetscBool *), void *);
6818d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS, Vec, void *, PetscReal *, PetscBool *);
682014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS, Vec, PetscReal *, PetscBool *);
683014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS, PetscReal);
684014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
68521c89e3eSBarry Smith 
686014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS, const char[]);
687ebead697SStefano Zampini PETSC_EXTERN PetscErrorCode TSPythonGetType(TS, const char *[]);
6881d6018f0SLisandro Dalcin 
689014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS, PetscReal, Vec, Vec);
690d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS, PetscReal, Vec, Mat, Mat);
691014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS, PetscReal, Vec, Vec, Vec, PetscBool);
692d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, PetscBool);
693efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS, PetscReal, Vec, Vec, Vec, Vec);
694efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS, PetscReal, Vec, Vec, Vec, PetscReal, PetscReal, Mat, Mat);
695f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS, PetscReal, PetscReal, PetscReal *, PetscReal *);
696818ad0c1SBarry Smith 
697014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS, Vec, Vec);
698d6ebe24aSShri Abhyankar 
699967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
70024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM, TSRHSFunction, void *);
70124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM, TSRHSFunction *, void **);
702800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionContextDestroy(DM, PetscErrorCode (*)(void *));
70324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM, TSRHSJacobian, void *);
70424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM, TSRHSJacobian *, void **);
705800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobianContextDestroy(DM, PetscErrorCode (*)(void *));
70624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM, TSIFunction, void *);
70724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM, TSIFunction *, void **);
708800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetIFunctionContextDestroy(DM, PetscErrorCode (*)(void *));
70924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM, TSIJacobian, void *);
71024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM, TSIJacobian *, void **);
711800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetIJacobianContextDestroy(DM, PetscErrorCode (*)(void *));
712efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM, TSI2Function, void *);
713efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM, TSI2Function *, void **);
714800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetI2FunctionContextDestroy(DM, PetscErrorCode (*)(void *));
715efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM, TSI2Jacobian, void *);
716efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM, TSI2Jacobian *, void **);
717800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetI2JacobianContextDestroy(DM, PetscErrorCode (*)(void *));
718efe9872eSLisandro Dalcin 
719*14d0ab18SJacob Faibussowitsch /*S
720*14d0ab18SJacob Faibussowitsch   TSTransientVariable - A function to transform from state to transient variables
721*14d0ab18SJacob Faibussowitsch 
722*14d0ab18SJacob Faibussowitsch   Calling Sequence:
723*14d0ab18SJacob Faibussowitsch + ts  - timestep context
724*14d0ab18SJacob Faibussowitsch . p   - input vector (primitive form)
725*14d0ab18SJacob Faibussowitsch . c   - output vector, transient variables (conservative form)
726*14d0ab18SJacob Faibussowitsch - ctx - [optional] user-defined function context
727*14d0ab18SJacob Faibussowitsch 
728*14d0ab18SJacob Faibussowitsch   Level: advanced
729*14d0ab18SJacob Faibussowitsch 
730*14d0ab18SJacob Faibussowitsch .seealso: [](ch_ts), `TS`, `TSSetTransientVariable()`, `DMTSSetTransientVariable()`
731*14d0ab18SJacob Faibussowitsch S*/
732*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSTransientVariable)(TS ts, Vec p, Vec c, void *ctx);
733*14d0ab18SJacob Faibussowitsch 
734438f35afSJed Brown PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS, TSTransientVariable, void *);
735e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM, TSTransientVariable, void *);
736e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM, TSTransientVariable *, void *);
737e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS, Vec, Vec);
738e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS, PetscBool *);
739e3c11fc1SJed Brown 
740ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM, TSSolutionFunction, void *);
741ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM, TSSolutionFunction *, void **);
742d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM, TSForcingFunction, void *);
743d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM, TSForcingFunction *, void **);
744e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckResidual(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscReal *);
745e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckJacobian(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscBool *, PetscReal *);
7467f96f943SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec);
7479b7cd975SBarry Smith 
7480c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetIFunctionLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, Vec, void *), void **);
749d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, Vec, void *), void *);
7500c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetIJacobianLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *), void **);
751d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *), void *);
7520c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetRHSFunctionLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, void *), void **);
753d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
754b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrix(DM);
755b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrixLumped(DM);
756b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSDestroyRHSMassMatrix(DM);
7576c6b9e74SPeter Brune 
7586c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM, PetscErrorCode (*)(void *, PetscViewer), PetscErrorCode (*)(void **, PetscViewer));
7596c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM, PetscErrorCode (*)(void *, PetscViewer), PetscErrorCode (*)(void **, PetscViewer));
7606c6b9e74SPeter Brune 
761*14d0ab18SJacob Faibussowitsch /*S
762*14d0ab18SJacob Faibussowitsch   DMDATSRHSFunctionLocal - A local `TS` right hand side residual evaluation function for use with `DMDA`
7636c6b9e74SPeter Brune 
764*14d0ab18SJacob Faibussowitsch   Calling Sequence:
765*14d0ab18SJacob Faibussowitsch + info - defines the subdomain to evaluate the residual on
766*14d0ab18SJacob Faibussowitsch . t    - time at which to evaluate residual
767*14d0ab18SJacob Faibussowitsch . x    - array of local state information
768*14d0ab18SJacob Faibussowitsch . f    - output array of local residual information
769*14d0ab18SJacob Faibussowitsch - ctx  - optional user context
770*14d0ab18SJacob Faibussowitsch 
771*14d0ab18SJacob Faibussowitsch   Level: beginner
772*14d0ab18SJacob Faibussowitsch 
773*14d0ab18SJacob Faibussowitsch .seealso: `DMDA`, `DMDATSSetRHSFunctionLocal()`, `TSRHSFunction()`, `DMDATSRHSJacobianLocal()`, `DMDATSIJacobianLocal()`, `DMDATSIFunctionLocal()`
774*14d0ab18SJacob Faibussowitsch S*/
775*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo *info, PetscReal t, void *x, void *f, void *ctx);
776*14d0ab18SJacob Faibussowitsch 
777*14d0ab18SJacob Faibussowitsch /*S
778*14d0ab18SJacob Faibussowitsch   DMDATSRHSJacobianLocal - A local residual evaluation function for use with `DMDA`
779*14d0ab18SJacob Faibussowitsch 
780*14d0ab18SJacob Faibussowitsch   Calling Sequence:
781*14d0ab18SJacob Faibussowitsch + info - defines the subdomain to evaluate the residual on
782*14d0ab18SJacob Faibussowitsch . t    - time at which to evaluate residual
783*14d0ab18SJacob Faibussowitsch . x    - array of local state information
784*14d0ab18SJacob Faibussowitsch . J    - Jacobian matrix
785*14d0ab18SJacob Faibussowitsch . B    - matrix from which to construct the preconditioner; often same as `J`
786*14d0ab18SJacob Faibussowitsch - ctx  - optional context
787*14d0ab18SJacob Faibussowitsch 
788*14d0ab18SJacob Faibussowitsch   Level: beginner
789*14d0ab18SJacob Faibussowitsch 
790*14d0ab18SJacob Faibussowitsch .seealso: `DMDA`, `DMDATSSetRHSJacobianLocal()`, `TSRHSJacobian()`, `DMDATSRHSFunctionLocal()`, `DMDATSIJacobianLocal()`, `DMDATSIFunctionLocal()`
791*14d0ab18SJacob Faibussowitsch S*/
792*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo *info, PetscReal t, void *x, Mat J, Mat B, void *ctx);
793*14d0ab18SJacob Faibussowitsch 
794*14d0ab18SJacob Faibussowitsch /*S
795*14d0ab18SJacob Faibussowitsch   DMDATSIFunctionLocal - A local residual evaluation function for use with `DMDA`
796*14d0ab18SJacob Faibussowitsch 
797*14d0ab18SJacob Faibussowitsch   Calling Sequence:
798*14d0ab18SJacob Faibussowitsch + info  - defines the subdomain to evaluate the residual on
799*14d0ab18SJacob Faibussowitsch . t     - time at which to evaluate residual
800*14d0ab18SJacob Faibussowitsch . x     - array of local state information
801*14d0ab18SJacob Faibussowitsch . xdot  - array of local time derivative information
802*14d0ab18SJacob Faibussowitsch . imode - output array of local function evaluation information
803*14d0ab18SJacob Faibussowitsch - ctx   - optional context
804*14d0ab18SJacob Faibussowitsch 
805*14d0ab18SJacob Faibussowitsch   Level: beginner
806*14d0ab18SJacob Faibussowitsch 
807*14d0ab18SJacob Faibussowitsch .seealso: `DMDA`, `DMDATSSetIFunctionLocal()`, `DMDATSIJacobianLocal()`, `TSIFunction()`
808*14d0ab18SJacob Faibussowitsch S*/
809*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo *info, PetscReal t, void *x, void *xdot, void *imode, void *ctx);
810*14d0ab18SJacob Faibussowitsch 
811*14d0ab18SJacob Faibussowitsch /*S
812*14d0ab18SJacob Faibussowitsch   DMDATSIJacobianLocal - A local residual evaluation function for use with `DMDA`
813*14d0ab18SJacob Faibussowitsch 
814*14d0ab18SJacob Faibussowitsch   Calling Sequence:
815*14d0ab18SJacob Faibussowitsch + info  - defines the subdomain to evaluate the residual on
816*14d0ab18SJacob Faibussowitsch . t     - time at which to evaluate the jacobian
817*14d0ab18SJacob Faibussowitsch . x     - array of local state information
818*14d0ab18SJacob Faibussowitsch . xdot  - time derivative at this state
819*14d0ab18SJacob Faibussowitsch . shift - see `TSSetIJacobian()` for the meaning of this parameter
820*14d0ab18SJacob Faibussowitsch . J     - Jacobian matrix
821*14d0ab18SJacob Faibussowitsch . B     - matrix from which to construct the preconditioner; often same as `J`
822*14d0ab18SJacob Faibussowitsch - ctx   - optional context
823*14d0ab18SJacob Faibussowitsch 
824*14d0ab18SJacob Faibussowitsch   Level: beginner
825*14d0ab18SJacob Faibussowitsch 
826*14d0ab18SJacob Faibussowitsch .seealso: `DMDA` `DMDATSSetIJacobianLocal()`, `TSIJacobian()`, `DMDATSIFunctionLocal()`, `DMDATSRHSFunctionLocal()`,  `DMDATSRHSJacob ianlocal()`
827*14d0ab18SJacob Faibussowitsch S*/
828*14d0ab18SJacob Faibussowitsch PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo *info, PetscReal t, void *x, void *xdot, PetscReal shift, Mat J, Mat B, void *ctx);
829*14d0ab18SJacob Faibussowitsch 
830*14d0ab18SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM, InsertMode, DMDATSRHSFunctionLocal, void *);
831*14d0ab18SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM, DMDATSRHSJacobianLocal, void *);
832*14d0ab18SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM, InsertMode, DMDATSIFunctionLocal, void *);
833*14d0ab18SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM, DMDATSIJacobianLocal, void *);
8346c6b9e74SPeter Brune 
835be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx *TSMonitorLGCtx;
836d1212d36SBarry Smith typedef struct {
837d1212d36SBarry Smith   Vec            ray;
838d1212d36SBarry Smith   VecScatter     scatter;
839d1212d36SBarry Smith   PetscViewer    viewer;
84051b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
841d1212d36SBarry Smith } TSMonitorDMDARayCtx;
842d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void **);
843d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS, PetscInt, PetscReal, Vec, void *);
84451b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS, PetscInt, PetscReal, Vec, void *);
845d1212d36SBarry Smith 
846bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
847140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
84819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode    TSGetType(TS, TSType *);
84919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode    TSSetType(TS, TSType);
850bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode    TSRegister(const char[], PetscErrorCode (*)(TS));
85130de9b25SBarry Smith 
852014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS, SNES *);
853deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS, SNES);
854014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS, KSP *);
855818ad0c1SBarry Smith 
856014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS, PetscViewer);
85755849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS, PetscViewer);
858fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS, PetscObject, const char[]);
859fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory, PetscObject, const char[]);
86055849f57SBarry Smith 
86155849f57SBarry Smith #define TS_FILE_CLASSID 1211225
86221c89e3eSBarry Smith 
863014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS, void *);
864014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS, void *);
86521c89e3eSBarry Smith 
866a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorLGCtx *);
867a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *);
8684f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS, PetscInt, PetscReal, Vec, void *);
8694f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS, PetscInt, PetscReal, Vec, void *);
87031152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS, const char *const *);
871b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS, const char *const **);
872e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx, const char *const *);
873a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS, const char *const *);
874a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx, const char *const *);
8757684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS, PetscErrorCode (*)(void *, Vec, Vec *), PetscErrorCode (*)(void *), void *);
8767684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx, PetscErrorCode (*)(void *, Vec, Vec *), PetscErrorCode (*)(void *), void *);
8774f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS, PetscInt, PetscReal, Vec, void *);
878201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS, PetscInt, PetscReal, Vec, void *);
879201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS, PetscInt, PetscReal, Vec, void *);
880edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *);
881d0c080abSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSDMSwarmMonitorMoments(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *);
882ef20d060SBarry Smith 
883e669de00SBarry Smith struct _n_TSMonitorLGCtxNetwork {
884e669de00SBarry Smith   PetscInt     nlg;
885e669de00SBarry Smith   PetscDrawLG *lg;
886e669de00SBarry Smith   PetscBool    semilogy;
887e669de00SBarry Smith   PetscInt     howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */
888e669de00SBarry Smith };
889e669de00SBarry Smith typedef struct _n_TSMonitorLGCtxNetwork *TSMonitorLGCtxNetwork;
890e669de00SBarry Smith PETSC_EXTERN PetscErrorCode              TSMonitorLGCtxNetworkDestroy(TSMonitorLGCtxNetwork *);
891e669de00SBarry Smith PETSC_EXTERN PetscErrorCode              TSMonitorLGCtxNetworkCreate(TS, const char[], const char[], int, int, int, int, PetscInt, TSMonitorLGCtxNetwork *);
892e669de00SBarry Smith PETSC_EXTERN PetscErrorCode              TSMonitorLGCtxNetworkSolution(TS, PetscInt, PetscReal, Vec, void *);
893e669de00SBarry Smith 
894b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx *TSMonitorEnvelopeCtx;
895b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode             TSMonitorEnvelopeCtxCreate(TS, TSMonitorEnvelopeCtx *);
896b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode             TSMonitorEnvelope(TS, PetscInt, PetscReal, Vec, void *);
897b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode             TSMonitorEnvelopeGetBounds(TS, Vec *, Vec *);
898b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode             TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *);
899b3d3934dSBarry Smith 
9008189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx *TSMonitorSPEigCtx;
9018189c53fSBarry Smith PETSC_EXTERN PetscErrorCode          TSMonitorSPEigCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorSPEigCtx *);
9028189c53fSBarry Smith PETSC_EXTERN PetscErrorCode          TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx *);
9038189c53fSBarry Smith PETSC_EXTERN PetscErrorCode          TSMonitorSPEig(TS, PetscInt, PetscReal, Vec, void *);
9043914022bSBarry Smith 
9051b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx *TSMonitorSPCtx;
90660e16b1bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode       TSMonitorSPCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, PetscInt, PetscBool, PetscBool, TSMonitorSPCtx *);
9071b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode       TSMonitorSPCtxDestroy(TSMonitorSPCtx *);
9080ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode       TSMonitorSPSwarmSolution(TS, PetscInt, PetscReal, Vec, void *);
9091b575b74SJoseph Pusztay 
91060e16b1bSMatthew G. Knepley typedef struct _n_TSMonitorHGCtx *TSMonitorHGCtx;
91160e16b1bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode       TSMonitorHGCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, PetscInt, PetscInt, PetscBool, TSMonitorHGCtx *);
91260e16b1bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode       TSMonitorHGSwarmSolution(TS, PetscInt, PetscReal, Vec, void *);
91360e16b1bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode       TSMonitorHGCtxDestroy(TSMonitorHGCtx *);
91460e16b1bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode       TSMonitorHGSwarmSolution(TS, PetscInt, PetscReal, Vec, void *);
91560e16b1bSMatthew G. Knepley 
9162589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS, PetscInt, PetscInt[], PetscBool[], PetscErrorCode (*)(TS, PetscReal, Vec, PetscScalar[], void *), PetscErrorCode (*)(TS, PetscInt, PetscInt[], PetscReal, Vec, PetscBool, void *), void *);
9170e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS, PetscReal);
9186427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS, PetscReal, PetscReal[]);
9191ea83e56SMiguel PETSC_EXTERN PetscErrorCode TSGetNumEvents(TS, PetscInt *);
9201ea83e56SMiguel 
92176bdecfbSBarry Smith /*J
922195e9b02SBarry Smith    TSSSPType - string with the name of a `TSSSP` scheme.
923815f1ad5SJed Brown 
924815f1ad5SJed Brown    Level: beginner
925815f1ad5SJed Brown 
9261cc06b55SBarry Smith .seealso: [](ch_ts), `TSSSPSetType()`, `TS`, `TSSSP`
92776bdecfbSBarry Smith J*/
92819fd82e9SBarry Smith typedef const char *TSSSPType;
929815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
930815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
931815f1ad5SJed Brown #define TSSSPRK104 "rk104"
932815f1ad5SJed Brown 
93319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode    TSSSPSetType(TS, TSSSPType);
93419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode    TSSSPGetType(TS, TSSSPType *);
935014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSSPSetNumStages(TS, PetscInt);
936014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSSPGetNumStages(TS, PetscInt *);
937787849ffSJed Brown PETSC_EXTERN PetscErrorCode    TSSSPInitializePackage(void);
938560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode    TSSSPFinalizePackage(void);
939013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
940815f1ad5SJed Brown 
941ed657a08SJed Brown /*S
94284df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
94384df9cb4SJed Brown 
94484df9cb4SJed Brown    Level: beginner
94584df9cb4SJed Brown 
9461cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSAdaptCreate()`, `TSAdaptType`
94784df9cb4SJed Brown S*/
94884df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
94984df9cb4SJed Brown 
950f0fc11ceSJed Brown /*J
95187497f52SBarry Smith     TSAdaptType - String with the name of `TSAdapt` scheme.
95284df9cb4SJed Brown 
95384df9cb4SJed Brown    Level: beginner
95484df9cb4SJed Brown 
9551cc06b55SBarry Smith .seealso: [](ch_ts), `TSAdaptSetType()`, `TS`, `TSAdapt`
956f0fc11ceSJed Brown J*/
957f8963224SJed Brown typedef const char *TSAdaptType;
958b0f836d7SJed Brown #define TSADAPTNONE    "none"
9591917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
960cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
9618d59e960SJed Brown #define TSADAPTCFL     "cfl"
9621917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
963d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
96484df9cb4SJed Brown 
965552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS, TSAdapt *);
966bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[], PetscErrorCode (*)(TSAdapt));
967607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
968014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
969014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm, TSAdapt *);
97019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt, TSAdaptType);
971d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt, TSAdaptType *);
972014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt, const char[]);
973014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
974014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt, const char[], PetscInt, PetscInt, PetscReal, PetscReal, PetscBool);
975014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt, PetscInt *, const PetscInt **, const PetscInt **, const PetscReal **, const PetscReal **);
976014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt, TS, PetscReal, PetscInt *, PetscReal *, PetscBool *);
977b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt, TS, PetscReal, Vec, PetscBool *);
978014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt, PetscViewer);
979ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt, PetscViewer);
980dbbe0bcdSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(TSAdapt, PetscOptionItems *);
981099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
982014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt *);
983014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt, PetscBool);
984bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt, PetscBool);
9851917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt, PetscReal, PetscReal);
9861917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt, PetscReal *, PetscReal *);
98776cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt, PetscReal);
98876cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt, PetscReal *);
9891917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt, PetscReal, PetscReal);
9901917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt, PetscReal *, PetscReal *);
99162c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt, PetscReal);
99262c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt, PetscReal *);
993014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt, PetscReal, PetscReal);
9941917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt, PetscReal *, PetscReal *);
995b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt, PetscErrorCode (*)(TSAdapt, TS, PetscReal, Vec, PetscBool *));
996d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt, PetscInt n, PetscReal hist[], PetscBool);
99775017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt, TSTrajectory, PetscBool);
99875017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt, PetscInt, PetscReal *, PetscReal *);
999de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt, PetscInt);
1000cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt, const char *);
1001cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt, PetscReal, PetscReal, PetscReal);
100284df9cb4SJed Brown 
100384df9cb4SJed Brown /*S
100487497f52SBarry Smith    TSGLLEAdapt - Abstract object that manages time-step adaptivity for `TSGLLE`
1005ed657a08SJed Brown 
1006ed657a08SJed Brown    Level: beginner
1007ed657a08SJed Brown 
1008195e9b02SBarry Smith    Developer Note:
100987497f52SBarry Smith    This functionality should be replaced by the `TSAdapt`.
101084df9cb4SJed Brown 
10111cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGLLE`, `TSGLLEAdaptCreate()`, `TSGLLEAdaptType`
1012ed657a08SJed Brown S*/
101326d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
1014ed657a08SJed Brown 
101576bdecfbSBarry Smith /*J
101687497f52SBarry Smith     TSGLLEAdaptType - String with the name of `TSGLLEAdapt` scheme
1017ed657a08SJed Brown 
1018ed657a08SJed Brown    Level: beginner
1019ed657a08SJed Brown 
1020195e9b02SBarry Smith    Developer Note:
1021195e9b02SBarry Smith    This functionality should be replaced by the `TSAdaptType`.
1022195e9b02SBarry Smith 
10231cc06b55SBarry Smith .seealso: [](ch_ts), `TSGLLEAdaptSetType()`, `TS`
102476bdecfbSBarry Smith J*/
102526d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
102626d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
102726d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
102826d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
1029ed657a08SJed Brown 
103026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[], PetscErrorCode (*)(TSGLLEAdapt));
103126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
103226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
103326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm, TSGLLEAdapt *);
103426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt, TSGLLEAdaptType);
103526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt, const char[]);
103626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt, PetscInt, const PetscInt[], const PetscReal[], const PetscReal[], PetscInt, PetscReal, PetscReal, PetscInt *, PetscReal *, PetscBool *);
103726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt, PetscViewer);
1038dbbe0bcdSBarry Smith PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(TSGLLEAdapt, PetscOptionItems *);
103926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt *);
1040ed657a08SJed Brown 
104176bdecfbSBarry Smith /*J
104287497f52SBarry Smith     TSGLLEAcceptType - String with the name of `TSGLLEAccept` scheme
1043ed657a08SJed Brown 
1044ed657a08SJed Brown    Level: beginner
1045ed657a08SJed Brown 
10461cc06b55SBarry Smith .seealso: [](ch_ts), `TSGLLESetAcceptType()`, `TS`, `TSGLLEAccept`
104776bdecfbSBarry Smith J*/
104826d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
104926d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
1050ed657a08SJed Brown 
105126d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS, PetscReal, PetscReal, const PetscReal[], PetscBool *);
105226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[], TSGLLEAcceptFunction);
1053ed657a08SJed Brown 
105476bdecfbSBarry Smith /*J
1055195e9b02SBarry Smith   TSGLLEType - string with the name of a General Linear `TSGLLE` type
105618b56cb9SJed Brown 
105718b56cb9SJed Brown   Level: beginner
105818b56cb9SJed Brown 
10591cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSGLLE`, `TSGLLESetType()`, `TSGLLERegister()`, `TSGLLEAccept`
106076bdecfbSBarry Smith J*/
106126d28e4eSEmil Constantinescu typedef const char *TSGLLEType;
106226d28e4eSEmil Constantinescu #define TSGLLE_IRKS "irks"
106318b56cb9SJed Brown 
106426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[], PetscErrorCode (*)(TS));
106526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
106626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
106726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS, TSGLLEType);
106826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS, TSGLLEAdapt *);
106926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS, TSGLLEAcceptType);
107018b56cb9SJed Brown 
1071020d8f30SJed Brown /*J
1072195e9b02SBarry Smith     TSEIMEXType - String with the name of an Extrapolated IMEX `TSEIMEX` type
10737d5697caSHong Zhang 
10747d5697caSHong Zhang    Level: beginner
10757d5697caSHong Zhang 
10761cc06b55SBarry Smith .seealso: [](ch_ts), `TSEIMEXSetType()`, `TS`, `TSEIMEX`, `TSEIMEXRegister()`
10777d5697caSHong Zhang J*/
10787d5697caSHong Zhang #define TSEIMEXType char *
10797d5697caSHong Zhang 
10807d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts, PetscInt);
10817d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts, PetscInt, PetscInt);
10827d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS, PetscBool);
10837d5697caSHong Zhang 
10847d5697caSHong Zhang /*J
1085195e9b02SBarry Smith     TSRKType - String with the name of a Runge-Kutta `TSRK` type
1086f68a32c8SEmil Constantinescu 
1087f68a32c8SEmil Constantinescu    Level: beginner
1088f68a32c8SEmil Constantinescu 
10891cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, `TSRKSetType()`, `TS`, `TSRK`, `TSRKRegister()`
1090f68a32c8SEmil Constantinescu J*/
1091f68a32c8SEmil Constantinescu typedef const char *TSRKType;
1092f68a32c8SEmil Constantinescu #define TSRK1FE "1fe"
1093fdefd5e5SDebojyoti Ghosh #define TSRK2A  "2a"
1094e7685601SHong Zhang #define TSRK2B  "2b"
1095f68a32c8SEmil Constantinescu #define TSRK3   "3"
1096fdefd5e5SDebojyoti Ghosh #define TSRK3BS "3bs"
1097f68a32c8SEmil Constantinescu #define TSRK4   "4"
1098fdefd5e5SDebojyoti Ghosh #define TSRK5F  "5f"
1099fdefd5e5SDebojyoti Ghosh #define TSRK5DP "5dp"
110005e23783SLisandro Dalcin #define TSRK5BS "5bs"
110137acaa02SHendrik Ranocha #define TSRK6VR "6vr"
110237acaa02SHendrik Ranocha #define TSRK7VR "7vr"
110337acaa02SHendrik Ranocha #define TSRK8VR "8vr"
110405e23783SLisandro Dalcin 
11052ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS, PetscInt *);
11060f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS, TSRKType *);
11070f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS, TSRKType);
11080f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS, PetscInt *, const PetscReal **, const PetscReal **, const PetscReal **, const PetscReal **, PetscInt *, const PetscReal **, PetscBool *);
11090fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS, PetscBool);
11100fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS, PetscBool *);
1111f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]);
1112f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
1113560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
1114f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
1115f68a32c8SEmil Constantinescu 
1116f68a32c8SEmil Constantinescu /*J
1117195e9b02SBarry Smith    TSMPRKType - String with the name of a Partitioned Runge-Kutta `TSMPRK` type
11189f537349Sluzhanghpp 
11199f537349Sluzhanghpp    Level: beginner
11209f537349Sluzhanghpp 
11211cc06b55SBarry Smith .seealso: [](ch_ts), `TSMPRKSetType()`, `TS`, `TSMPRK`, `TSMPRKRegister()`
11229f537349Sluzhanghpp J*/
11234b84eec9SHong Zhang typedef const char *TSMPRKType;
112419c2959aSHong Zhang #define TSMPRK2A22 "2a22"
112519c2959aSHong Zhang #define TSMPRK2A23 "2a23"
112619c2959aSHong Zhang #define TSMPRK2A32 "2a32"
112719c2959aSHong Zhang #define TSMPRK2A33 "2a33"
11284b84eec9SHong Zhang #define TSMPRKP2   "p2"
11294b84eec9SHong Zhang #define TSMPRKP3   "p3"
11309f537349Sluzhanghpp 
11314b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts, TSMPRKType *);
11324b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts, TSMPRKType);
113379bc8a77SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegister(TSMPRKType, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscInt[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscInt[], const PetscReal[], const PetscReal[], const PetscReal[]);
11344b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
11354b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
11364b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);
11379f537349Sluzhanghpp 
11389f537349Sluzhanghpp /*J
1139195e9b02SBarry Smith     TSIRKType - String with the name of an implicit Runge-Kutta `TSIRK` type
1140d2567f34SHong Zhang 
1141d2567f34SHong Zhang    Level: beginner
1142d2567f34SHong Zhang 
11431cc06b55SBarry Smith .seealso: [](ch_ts), `TSIRKSetType()`, `TS`, `TSIRK`, `TSIRKRegister()`
1144d2567f34SHong Zhang J*/
1145d2567f34SHong Zhang typedef const char *TSIRKType;
1146d2567f34SHong Zhang #define TSIRKGAUSS "gauss"
1147d2567f34SHong Zhang 
1148d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetType(TS, TSIRKType *);
1149d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetType(TS, TSIRKType);
1150d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetNumStages(TS, PetscInt *);
1151d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetNumStages(TS, PetscInt);
1152d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegister(const char[], PetscErrorCode (*function)(TS));
1153d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKTableauCreate(TS, PetscInt, const PetscReal *, const PetscReal *, const PetscReal *, const PetscReal *, const PetscScalar *, const PetscScalar *, const PetscScalar *);
1154d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKInitializePackage(void);
1155d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKFinalizePackage(void);
1156d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegisterDestroy(void);
1157d2567f34SHong Zhang 
1158d2567f34SHong Zhang /*J
1159195e9b02SBarry Smith     TSGLEEType - String with the name of a General Linear with Error Estimation `TSGLEE` type
1160b6a60446SDebojyoti Ghosh 
1161b6a60446SDebojyoti Ghosh    Level: beginner
1162b6a60446SDebojyoti Ghosh 
11631cc06b55SBarry Smith .seealso: [](ch_ts), `TSGLEESetType()`, `TS`, `TSGLEE`, `TSGLEERegister()`
1164b6a60446SDebojyoti Ghosh J*/
1165b6a60446SDebojyoti Ghosh typedef const char *TSGLEEType;
1166ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
1167b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
1168b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
1169b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
1170b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
1171b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
1172b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
1173b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
117416a05f60SBarry Smith 
1175b6a60446SDebojyoti Ghosh /*J
1176195e9b02SBarry Smith     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation `TSGLEE` type
1177b6a60446SDebojyoti Ghosh 
1178b6a60446SDebojyoti Ghosh    Level: beginner
1179b6a60446SDebojyoti Ghosh 
11801cc06b55SBarry Smith .seealso: [](ch_ts), `TSGLEESetMode()`, `TS`, `TSGLEE`, `TSGLEERegister()`
1181b6a60446SDebojyoti Ghosh J*/
1182b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts, TSGLEEType *);
1183b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts, TSGLEEType);
118457df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegister(TSGLEEType, PetscInt, PetscInt, PetscInt, PetscReal, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]);
1185b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
1186b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
1187b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
1188b6a60446SDebojyoti Ghosh 
1189b6a60446SDebojyoti Ghosh /*J
1190195e9b02SBarry Smith     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX `TSARKIMEX` type
1191020d8f30SJed Brown 
1192020d8f30SJed Brown    Level: beginner
1193020d8f30SJed Brown 
11941cc06b55SBarry Smith .seealso: [](ch_ts), `TSARKIMEXSetType()`, `TS`, `TSARKIMEX`, `TSARKIMEXRegister()`
1195020d8f30SJed Brown J*/
119619fd82e9SBarry Smith typedef const char *TSARKIMEXType;
1197e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
11981f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
11991f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
12001f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
12011f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
12028a381b04SJed Brown #define TSARKIMEX2D     "2d"
1203a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
12046cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
12058a381b04SJed Brown #define TSARKIMEX3      "3"
12066cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
12076cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
12088a381b04SJed Brown #define TSARKIMEX4      "4"
12098a381b04SJed Brown #define TSARKIMEX5      "5"
121019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts, TSARKIMEXType *);
121119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts, TSARKIMEXType);
1212014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS, PetscBool);
12133a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS, PetscBool *);
121419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXRegister(TSARKIMEXType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[], const PetscReal[]);
1215607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
1216560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
1217014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
12188a381b04SJed Brown 
1219020d8f30SJed Brown /*J
1220195e9b02SBarry Smith     TSRosWType - String with the name of a Rosenbrock-W `TSROSW` type
1221020d8f30SJed Brown 
1222020d8f30SJed Brown    Level: beginner
1223020d8f30SJed Brown 
12241cc06b55SBarry Smith .seealso: [](ch_ts), `TSRosWSetType()`, `TS`, `TSROSW`, `TSRosWRegister()`
1225020d8f30SJed Brown J*/
122619fd82e9SBarry Smith typedef const char *TSRosWType;
122761692a83SJed Brown #define TSROSW2M          "2m"
122861692a83SJed Brown #define TSROSW2P          "2p"
1229fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
1230fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
1231ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
1232ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
1233961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
1234961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
123543b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
1236753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
12373606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
12383606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
123942faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
124042faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
124142faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
124242faf41dSJed Brown #define TSROSW4L          "4l"
1243b1c69cc3SEmil Constantinescu 
12446bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS, TSRosWType *);
12456bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS, TSRosWType);
1246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS, PetscBool);
124719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]);
124819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal);
1249607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
1250560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
1251014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
1252e27a552bSJed Brown 
1253211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS, PetscInt);
1254211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS, PetscInt *);
1255211a84d6SLisandro Dalcin 
12566bd7aeb5SHong Zhang /*J
1257195e9b02SBarry Smith   TSBasicSymplecticType - String with the name of a basic symplectic integration `TSBASICSYMPLECTIC` type
12586bd7aeb5SHong Zhang 
12596bd7aeb5SHong Zhang   Level: beginner
12606bd7aeb5SHong Zhang 
12611cc06b55SBarry Smith .seealso: [](ch_ts), `TSBasicSymplecticSetType()`, `TS`, `TSBASICSYMPLECTIC`, `TSBasicSymplecticRegister()`
12626bd7aeb5SHong Zhang J*/
1263e49d4f37SHong Zhang typedef const char *TSBasicSymplecticType;
1264e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
1265e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
1266e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
1267e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
1268e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS, TSBasicSymplecticType);
1269e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS, TSBasicSymplecticType *);
1270e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType, PetscInt, PetscInt, PetscReal[], PetscReal[]);
1271e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
1272e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
1273e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
12746bd7aeb5SHong Zhang 
1275db4653c2SDaniel Finn /*J
1276195e9b02SBarry Smith   TSDISCGRAD - The Discrete Gradient integrator is a timestepper for Hamiltonian systems designed to conserve the first integral (energy),
127787497f52SBarry Smith   but also has the property for some systems of monotonicity in a functional.
1278db4653c2SDaniel Finn 
1279db4653c2SDaniel Finn   Level: beginner
1280db4653c2SDaniel Finn 
12811cc06b55SBarry Smith .seealso: [](ch_ts), `TS`, TSDiscGradSetFormulation()`, `TSDiscGradGetFormulation()`
1282db4653c2SDaniel Finn J*/
128340be0ff1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSDiscGradSetFormulation(TS, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), PetscErrorCode (*)(TS, PetscReal, Vec, PetscScalar *, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec, void *), void *);
1284db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradIsGonzalez(TS, PetscBool *);
1285db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradUseGonzalez(TS, PetscBool);
128640be0ff1SMatthew G. Knepley 
128783e2fdc7SBarry Smith /*
12880f3b3ca1SHong Zhang        PETSc interface to Sundials
128983e2fdc7SBarry Smith */
1290e808b789SPatrick Sanan #ifdef PETSC_HAVE_SUNDIALS2
12919371c9d4SSatish Balay typedef enum {
12929371c9d4SSatish Balay   SUNDIALS_ADAMS = 1,
12939371c9d4SSatish Balay   SUNDIALS_BDF   = 2
12949371c9d4SSatish Balay } TSSundialsLmmType;
12956a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
12969371c9d4SSatish Balay typedef enum {
12979371c9d4SSatish Balay   SUNDIALS_MODIFIED_GS  = 1,
12989371c9d4SSatish Balay   SUNDIALS_CLASSICAL_GS = 2
12999371c9d4SSatish Balay } TSSundialsGramSchmidtType;
13006a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
1301014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetType(TS, TSSundialsLmmType);
1302014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsGetPC(TS, PC *);
1303014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetTolerance(TS, PetscReal, PetscReal);
1304014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetMinTimeStep(TS, PetscReal);
1305014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetMaxTimeStep(TS, PetscReal);
1306014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsGetIterations(TS, PetscInt *, PetscInt *);
1307014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetGramSchmidtType(TS, TSSundialsGramSchmidtType);
1308014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetGMRESRestart(TS, PetscInt);
1309014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetLinearTolerance(TS, PetscReal);
1310014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsMonitorInternalSteps(TS, PetscBool);
1311014dd563SJed Brown PETSC_EXTERN PetscErrorCode    TSSundialsSetMaxl(TS, PetscInt);
1312c4e80e11SFlorian PETSC_EXTERN PetscErrorCode    TSSundialsSetMaxord(TS, PetscInt);
1313918687b8SPatrick Sanan PETSC_EXTERN PetscErrorCode    TSSundialsSetUseDense(TS, PetscBool);
13146dc17ff5SMatthew Knepley #endif
131583e2fdc7SBarry Smith 
1316014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS, PetscReal);
1317014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS, PetscReal *);
1318014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS, PetscBool *);
1319014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS, PetscBool);
13200de4c49aSJed Brown 
1321014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS, PetscReal);
1322014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS, PetscReal, PetscReal, PetscReal);
1323014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS, PetscReal *, PetscReal *, PetscReal *);
132488df8a41SLisandro Dalcin 
1325818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS, PetscReal);
1326818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS, PetscReal, PetscReal, PetscReal, PetscReal);
1327818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS, PetscReal *, PetscReal *, PetscReal *, PetscReal *);
1328818efac9SLisandro Dalcin 
1329014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS, DM);
1330014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS, DM *);
13316c699258SBarry Smith 
1332014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES, Vec, Vec, void *);
1333d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES, Vec, Mat, Mat, void *);
13340f5c6efeSJed Brown 
1335f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS, PetscBool *);
1336f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS, PetscBool *);
1337aad739acSMatthew G. Knepley 
13382e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec));
13392e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec));
13402e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec);
13412e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec));
1342aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec));
1343aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec);
1344f2ed2dc7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool);
1345d60b7d5cSBarry Smith 
1346d60b7d5cSBarry Smith PETSC_EXTERN PetscErrorCode TSSetMatStructure(TS, MatStructure);
1347818ad0c1SBarry Smith #endif
1348