xref: /petsc/include/petscts.h (revision ebead697dbf761eb322f829370bbe90b3bd93fa3)
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 */
526bd1501SBarry Smith #if !defined(PETSCTS_H)
626bd1501SBarry Smith #define PETSCTS_H
7ac09b921SBarry Smith 
82c8e378dSBarry Smith #include <petscsnes.h>
9900f6b5bSMatthew G. Knepley #include <petscconvest.h>
10818ad0c1SBarry Smith 
11ac09b921SBarry Smith /* SUBMANSEC = TS */
12ac09b921SBarry Smith 
13435da068SBarry Smith /*S
14435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
15435da068SBarry Smith 
16435da068SBarry Smith    Level: beginner
17435da068SBarry Smith 
18db781477SPatrick Sanan .seealso: `TSCreate()`, `TSSetType()`, `TSType`, `SNES`, `KSP`, `PC`, `TSDestroy()`
19435da068SBarry Smith S*/
20f09e8eb9SSatish Balay typedef struct _p_TS* TS;
21435da068SBarry Smith 
2276bdecfbSBarry Smith /*J
238f6c3df8SBarry Smith     TSType - String with the name of a PETSc TS method.
24435da068SBarry Smith 
25435da068SBarry Smith    Level: beginner
26435da068SBarry Smith 
27db781477SPatrick Sanan .seealso: `TSSetType()`, `TS`, `TSRegister()`
2876bdecfbSBarry Smith J*/
2919fd82e9SBarry Smith typedef const char* TSType;
309596e0b4SJed Brown #define TSEULER           "euler"
319596e0b4SJed Brown #define TSBEULER          "beuler"
32e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic"
339596e0b4SJed Brown #define TSPSEUDO          "pseudo"
344d91e141SJed Brown #define TSCN              "cn"
359596e0b4SJed Brown #define TSSUNDIALS        "sundials"
364d91e141SJed Brown #define TSRK              "rk"
379596e0b4SJed Brown #define TSPYTHON          "python"
389596e0b4SJed Brown #define TSTHETA           "theta"
3988df8a41SLisandro Dalcin #define TSALPHA           "alpha"
40818efac9SLisandro Dalcin #define TSALPHA2          "alpha2"
4126d28e4eSEmil Constantinescu #define TSGLLE            "glle"
42b6a60446SDebojyoti Ghosh #define TSGLEE            "glee"
43ef7bb5aaSJed Brown #define TSSSP             "ssp"
448a381b04SJed Brown #define TSARKIMEX         "arkimex"
45e27a552bSJed Brown #define TSROSW            "rosw"
467d5697caSHong Zhang #define TSEIMEX           "eimex"
47abadfa0fSMatthew G. Knepley #define TSMIMEX           "mimex"
48211a84d6SLisandro Dalcin #define TSBDF             "bdf"
49d249a78fSBarry Smith #define TSRADAU5          "radau5"
504b84eec9SHong Zhang #define TSMPRK            "mprk"
5140be0ff1SMatthew G. Knepley #define TSDISCGRAD        "discgrad"
52d2567f34SHong Zhang #define TSIRK             "irk"
5340be0ff1SMatthew G. Knepley 
54435da068SBarry Smith /*E
55435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
56435da068SBarry Smith 
57435da068SBarry Smith    Level: beginner
58435da068SBarry Smith 
59db781477SPatrick Sanan .seealso: `TSCreate()`
60435da068SBarry Smith E*/
6119bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
62818ad0c1SBarry Smith 
63b93fea0eSJed Brown /*E
64e817cc15SEmil Constantinescu    TSEquationType - type of TS problem that is solved
65e817cc15SEmil Constantinescu 
66e817cc15SEmil Constantinescu    Level: beginner
67e817cc15SEmil Constantinescu 
6895452b02SPatrick Sanan    Developer Notes:
6995452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
70e817cc15SEmil Constantinescu 
71e817cc15SEmil Constantinescu    Supported types are:
72e817cc15SEmil Constantinescu      TS_EQ_UNSPECIFIED (default)
73e817cc15SEmil Constantinescu      TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0
74e817cc15SEmil Constantinescu      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
75e817cc15SEmil Constantinescu 
76db781477SPatrick Sanan .seealso: `TSGetEquationType()`, `TSSetEquationType()`
77e817cc15SEmil Constantinescu E*/
78e817cc15SEmil Constantinescu typedef enum {
79e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
80e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
81e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
82e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
83e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
84e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
85e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
86e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
87e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
88e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
89e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
90e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
9119436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
92e817cc15SEmil Constantinescu } TSEquationType;
93e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes;
94e817cc15SEmil Constantinescu 
95e817cc15SEmil Constantinescu /*E
96b93fea0eSJed Brown    TSConvergedReason - reason a TS method has converged or not
97b93fea0eSJed Brown 
98b93fea0eSJed Brown    Level: beginner
99b93fea0eSJed Brown 
10095452b02SPatrick Sanan    Developer Notes:
10195452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
102b93fea0eSJed Brown 
103b93fea0eSJed Brown    Each reason has its own manual page.
104b93fea0eSJed Brown 
105db781477SPatrick Sanan .seealso: `TSGetConvergedReason()`
106b93fea0eSJed Brown E*/
107193ac0bcSJed Brown typedef enum {
108193ac0bcSJed Brown   TS_CONVERGED_ITERATING          = 0,
109193ac0bcSJed Brown   TS_CONVERGED_TIME               = 1,
110193ac0bcSJed Brown   TS_CONVERGED_ITS                = 2,
111d6ad946cSShri Abhyankar   TS_CONVERGED_USER               = 3,
1122b7db910SShri Abhyankar   TS_CONVERGED_EVENT              = 4,
1133118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL       = 5,
1143118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL       = 6,
115193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE     = -1,
116b5b4017aSHong Zhang   TS_DIVERGED_STEP_REJECTED       = -2,
11705c9950eSHong Zhang   TSFORWARD_DIVERGED_LINEAR_SOLVE = -3,
11805c9950eSHong Zhang   TSADJOINT_DIVERGED_LINEAR_SOLVE = -4
119193ac0bcSJed Brown } TSConvergedReason;
120014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons;
1211957e957SBarry Smith 
122b93fea0eSJed Brown /*MC
123b93fea0eSJed Brown    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
124b93fea0eSJed Brown 
125b93fea0eSJed Brown    Level: beginner
126b93fea0eSJed Brown 
127db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`
128b93fea0eSJed Brown M*/
129b93fea0eSJed Brown 
130b93fea0eSJed Brown /*MC
131b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
132b93fea0eSJed Brown 
133b93fea0eSJed Brown    Level: beginner
134b93fea0eSJed Brown 
135db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxTime()`, `TSGetMaxTime()`, `TSGetSolveTime()`
136b93fea0eSJed Brown M*/
137b93fea0eSJed Brown 
138b93fea0eSJed Brown /*MC
1391957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
140b93fea0eSJed Brown 
141b93fea0eSJed Brown    Level: beginner
142b93fea0eSJed Brown 
143db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxSteps()`, `TSGetMaxSteps()`
144b93fea0eSJed Brown M*/
1451957e957SBarry Smith 
146d6ad946cSShri Abhyankar /*MC
147d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
148d6ad946cSShri Abhyankar 
149d6ad946cSShri Abhyankar    Level: beginner
150d6ad946cSShri Abhyankar 
151db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`
152b93fea0eSJed Brown M*/
153b93fea0eSJed Brown 
154b93fea0eSJed Brown /*MC
155d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
156d76fc68cSShri Abhyankar 
157d76fc68cSShri Abhyankar    Level: beginner
158d76fc68cSShri Abhyankar 
159db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`
160d76fc68cSShri Abhyankar M*/
161d76fc68cSShri Abhyankar 
162d76fc68cSShri Abhyankar /*MC
1633118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
1643118ae5eSBarry Smith 
1653118ae5eSBarry Smith    Level: beginner
1663118ae5eSBarry Smith 
1673118ae5eSBarry Smith    Options Database:
16867b8a455SSatish Balay .   -ts_pseudo_frtol <rtol> - use sepcified rtol
1693118ae5eSBarry Smith 
170db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FATOL`
1713118ae5eSBarry Smith M*/
1723118ae5eSBarry Smith 
1733118ae5eSBarry Smith /*MC
1743118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
1753118ae5eSBarry Smith 
1763118ae5eSBarry Smith    Level: beginner
1773118ae5eSBarry Smith 
1783118ae5eSBarry Smith    Options Database:
17967b8a455SSatish Balay .   -ts_pseudo_fatol <atol> - use specified atol
1803118ae5eSBarry Smith 
181db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FRTOL`
1823118ae5eSBarry Smith M*/
1833118ae5eSBarry Smith 
1843118ae5eSBarry Smith /*MC
185b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
186b93fea0eSJed Brown 
187b93fea0eSJed Brown    Level: beginner
188b93fea0eSJed Brown 
18995452b02SPatrick Sanan    Notes:
19095452b02SPatrick Sanan     See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
1911957e957SBarry Smith 
192db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSGetSNES()`, `SNESGetConvergedReason()`, `TSSetMaxSNESFailures()`
193b93fea0eSJed Brown M*/
194b93fea0eSJed Brown 
195b93fea0eSJed Brown /*MC
196b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
197b93fea0eSJed Brown 
198b93fea0eSJed Brown    Level: beginner
199b93fea0eSJed Brown 
20095452b02SPatrick Sanan    Notes:
20195452b02SPatrick Sanan     See TSSetMaxStepRejections() for how to allow more step rejections.
2021957e957SBarry Smith 
203db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxStepRejections()`
204b93fea0eSJed Brown M*/
205b93fea0eSJed Brown 
206d6ad946cSShri Abhyankar /*E
207d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
208d6ad946cSShri Abhyankar 
209d6ad946cSShri Abhyankar    Level: beginner
210d6ad946cSShri Abhyankar 
21195452b02SPatrick Sanan    Developer Notes:
21295452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
213d6ad946cSShri Abhyankar 
214d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
215d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
216d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
217feed9e9dSBarry Smith 
218db781477SPatrick Sanan .seealso: `TSGetConvergedReason()`, `TSSetExactFinalTime()`, `TSGetExactFinalTime()`
2194ceb6c04SBarry Smith 
220d6ad946cSShri Abhyankar E*/
221feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
222d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
223d6ad946cSShri Abhyankar 
224000e7ae3SMatthew Knepley /* Logging support */
225014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
226d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2271b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
228000e7ae3SMatthew Knepley 
229607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
230560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2318ba1e511SMatthew Knepley 
232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
233baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
235818ad0c1SBarry Smith 
236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
237014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
240721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
242818ad0c1SBarry Smith 
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
245014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
247014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
248014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
249818ad0c1SBarry Smith 
250014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
251014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
252818ad0c1SBarry Smith 
253efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
254efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
25557df6a1bSDebojyoti Ghosh 
256642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
257642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
2580a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
25957df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);
2606e2e232bSDebojyoti Ghosh 
261a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
262cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS,Mat*,PetscErrorCode(**)(TS,PetscReal,Vec,Mat,void*),void**);
263a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat);
26433f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal,Mat,void*),void*);
26533f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS,PetscReal,Vec,Vec,PetscReal,Mat,PetscBool);
26625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
26725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSComputeDRDUFunction(TS,PetscReal,Vec,Vec*);
268b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
269b5b4017aSHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
270b5b4017aSHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
271b5b4017aSHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
272b5b4017aSHong Zhang                                                     void*);
273b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
274b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
275b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
276b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
27713af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27813af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27913af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
28013af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
28113af1a74SHong Zhang                                                     void*);
282b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
283b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
284b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
285b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
286b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS,PetscInt,Vec*,Vec*,Vec);
287b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS,PetscInt*,Vec**,Vec**,Vec*);
288ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS,Vec,Mat,Mat);
289a05bf03eSHong Zhang 
290bc952696SBarry Smith /*S
291e91eccc2SStefano Zampini      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)
292bc952696SBarry Smith 
293bc952696SBarry Smith    Level: advanced
294bc952696SBarry Smith 
295db781477SPatrick Sanan .seealso: `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectorySetType()`, `TSTrajectoryDestroy()`, `TSTrajectoryReset()`
296bc952696SBarry Smith S*/
297bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory;
298bc952696SBarry Smith 
299bc952696SBarry Smith /*J
3003c0fce88SHong Zhang     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method
301bc952696SBarry Smith 
302bc952696SBarry Smith    Level: intermediate
303bc952696SBarry Smith 
304db781477SPatrick Sanan .seealso: `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()`
305bc952696SBarry Smith J*/
306bc952696SBarry Smith typedef const char* TSTrajectoryType;
307bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
3081c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
3099a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
3102b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
311bc952696SBarry Smith 
312bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
313bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
314bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
315bc952696SBarry Smith 
316bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
3172d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS);
31867a3cfb0SHong Zhang PETSC_EXTERN PetscErrorCode TSRemoveTrajectory(TS);
319bc952696SBarry Smith 
320bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
3219a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
322bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
323560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
324fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType);
325881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory,TS,TSTrajectoryType*);
326bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
327c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
328fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec);
329fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*);
330fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*);
331fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*);
332972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
333560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
334bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
33568bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
3369ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory,PetscBool);
3372bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
33878fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
33908347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
340fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool);
341fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*);
34264fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool);
34364e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]);
34464e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]);
34578fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);
346bc952696SBarry Smith 
347dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
348dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
34925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() then set up the sub-TS (since version 3.12)") 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*);
350dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
351022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);
352cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS,PetscBool,TS*);
353cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS,PetscBool*,TS*);
354d4aa0a58SBarry Smith 
355a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
356a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
357a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
358a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
359a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
360a05bf03eSHong Zhang 
36125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetRHSJacobianP()")     PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
36225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSComputeRHSJacobianP()") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
36325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
36425ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
3652c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
36673b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
367d4aa0a58SBarry Smith 
36873b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
369f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
370ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS);
371999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
372ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS,Mat);
373ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS);
374715f1b00SHong Zhang 
37513b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
37613b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
37725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() and TSForwardSetSensitivities() (since version 3.12)") PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
37825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSForwardGetSensitivities()")                          PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
379715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
3807adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS);
381999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
382715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
383b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat);
384cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat*[]);
385c235aa8dSHong Zhang 
386618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
387618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
388618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
389618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
39049354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
391f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);
3924a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSSetTimeSpan(TS,PetscInt,PetscReal*);
3934a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSGetTimeSpan(TS,PetscInt*,const PetscReal**);
3944a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSGetTimeSpanSolutions(TS,PetscInt*,Vec**);
395818ad0c1SBarry Smith 
39625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetTime[Step]() (since version 3.8)")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
39725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
39825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
39925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
40025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
40119eac22cSLisandro Dalcin 
402721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
403cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
40483a4ac43SBarry Smith 
40583a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
40683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
40783a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
40883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
4092d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
41083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
4110ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);
41283a4ac43SBarry Smith 
413721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
4149110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
4159110b2e7SHong Zhang 
416721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
417014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
418014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
419fb1732b5SBarry Smith 
420014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
4217cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
422014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
423cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
424e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
425e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
426014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
427d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
428487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
4295ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
4305ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
431cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
432cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
433cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
434cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
435cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
436dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
43724655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
438d2daff3dSHong Zhang 
439cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec*[]);
440818ad0c1SBarry Smith 
441014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
442014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
443e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
44480275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
44580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
44680275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
44780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);
448818ad0c1SBarry Smith 
449638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
450d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
451cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS,PetscReal,Vec,Mat,void*);
452014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
453014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
454014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
455014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
456e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
457818ad0c1SBarry Smith 
458ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
459ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
460d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
461d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
462ef20d060SBarry Smith 
463638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
464d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
465014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
466014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
467014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
468014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
469316643e7SJed Brown 
470efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
471efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
472efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
473efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
474efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
475efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
476efe9872eSLisandro Dalcin 
477545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
478545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
479545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
4801d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
4811d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
4820fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
4830fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*);
484d9194312SHong Zhang 
485014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
486d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
487014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
488d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
4891c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
4909b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
491847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
492e34be4c2SBarry Smith 
493014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
494b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
4959be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
496c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
497014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
498014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
499b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
5009be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
501c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
502014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
503014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
504014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
505c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
5067453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5077453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5087453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
5098a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5108a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5118a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
514d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
515d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
516000e7ae3SMatthew Knepley 
517014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
5188d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
519014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
521014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
5228d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
523014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
524014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
525014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
52621c89e3eSBarry Smith 
527014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
528*ebead697SStefano Zampini PETSC_EXTERN PetscErrorCode TSPythonGetType(TS,const char*[]);
5291d6018f0SLisandro Dalcin 
530014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
531d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
532014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
533d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
534efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
535efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
536f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
537818ad0c1SBarry Smith 
538014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
539d6ebe24aSShri Abhyankar 
540967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
54124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
54224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
54324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
54424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
54524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
54624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
54724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
54824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
549efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
550efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
551efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
552efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
553efe9872eSLisandro Dalcin 
554e3c11fc1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSTransientVariable)(TS,Vec,Vec,void*);
555438f35afSJed Brown PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS,TSTransientVariable,void*);
556e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM,TSTransientVariable,void*);
557e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM,TSTransientVariable*,void*);
558e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS,Vec,Vec);
559e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS,PetscBool*);
560e3c11fc1SJed Brown 
561ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
562ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
563d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
564d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
565e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckResidual(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscReal *);
566e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckJacobian(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscBool *, PetscReal *);
5677f96f943SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec);
5689b7cd975SBarry Smith 
5690c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetIFunctionLocal(DM,PetscErrorCode (**)(DM,PetscReal,Vec,Vec,Vec,void*),void**);
570d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
5710c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetIJacobianLocal(DM,PetscErrorCode (**)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void**);
572d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
5730c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetRHSFunctionLocal(DM,PetscErrorCode (**)(DM,PetscReal,Vec,Vec,void*),void**);
574d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
575b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrix(DM);
576b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrixLumped(DM);
577b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSDestroyRHSMassMatrix(DM);
5786c6b9e74SPeter Brune 
5796c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5806c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5816c6b9e74SPeter Brune 
5826c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
583d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
5846c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
585d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
5866c6b9e74SPeter Brune 
5876c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
588d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
5896c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
590d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
5916c6b9e74SPeter Brune 
592b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
5936dbbd306SMatthew G. Knepley 
594be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
595d1212d36SBarry Smith typedef struct {
596d1212d36SBarry Smith   Vec            ray;
597d1212d36SBarry Smith   VecScatter     scatter;
598d1212d36SBarry Smith   PetscViewer    viewer;
59951b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
600d1212d36SBarry Smith } TSMonitorDMDARayCtx;
601d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
602d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
60351b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
604d1212d36SBarry Smith 
605bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
606140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
60719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
60819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
609bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
61030de9b25SBarry Smith 
611014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
612deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
613014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
614818ad0c1SBarry Smith 
615014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
61655849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
617fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS,PetscObject,const char[]);
618fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory,PetscObject,const char[]);
61955849f57SBarry Smith 
62055849f57SBarry Smith #define TS_FILE_CLASSID 1211225
62121c89e3eSBarry Smith 
622014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
623014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
62421c89e3eSBarry Smith 
625a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
626a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
6274f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
6284f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
62931152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
630b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
631e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
632a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
633a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
6347684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
6357684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
6364f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
637201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
638201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
639edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
640d0c080abSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSDMSwarmMonitorMoments(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
641ef20d060SBarry Smith 
642e669de00SBarry Smith struct _n_TSMonitorLGCtxNetwork {
643e669de00SBarry Smith   PetscInt       nlg;
644e669de00SBarry Smith   PetscDrawLG    *lg;
645e669de00SBarry Smith   PetscBool      semilogy;
646e669de00SBarry Smith   PetscInt       howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
647e669de00SBarry Smith };
648e669de00SBarry Smith typedef struct _n_TSMonitorLGCtxNetwork*  TSMonitorLGCtxNetwork;
649e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkDestroy(TSMonitorLGCtxNetwork*);
650e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkCreate(TS,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtxNetwork*);
651e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkSolution(TS,PetscInt,PetscReal,Vec,void*);
652e669de00SBarry Smith 
653b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
654b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
655b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
656b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
657b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
658b3d3934dSBarry Smith 
6598189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
6608189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
6618189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
6628189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
6633914022bSBarry Smith 
6641b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx;
665d7462660SMatthew Knepley PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,PetscInt,PetscBool,TSMonitorSPCtx*);
6661b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*);
6670ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*);
6681b575b74SJoseph Pusztay 
6692589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
6700e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal);
6716427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
6721ea83e56SMiguel PETSC_EXTERN PetscErrorCode TSGetNumEvents(TS,PetscInt*);
6731ea83e56SMiguel 
67476bdecfbSBarry Smith /*J
675815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
676815f1ad5SJed Brown 
677815f1ad5SJed Brown    Level: beginner
678815f1ad5SJed Brown 
679db781477SPatrick Sanan .seealso: `TSSSPSetType()`, `TS`
68076bdecfbSBarry Smith J*/
68119fd82e9SBarry Smith typedef const char* TSSSPType;
682815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
683815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
684815f1ad5SJed Brown #define TSSSPRK104 "rk104"
685815f1ad5SJed Brown 
68619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
68719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
688014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
689014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
690787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
691560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
692013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
693815f1ad5SJed Brown 
694ed657a08SJed Brown /*S
69584df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
69684df9cb4SJed Brown 
69784df9cb4SJed Brown    Level: beginner
69884df9cb4SJed Brown 
699db781477SPatrick Sanan .seealso: `TS`, `TSAdaptCreate()`, `TSAdaptType`
70084df9cb4SJed Brown S*/
70184df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
70284df9cb4SJed Brown 
703f0fc11ceSJed Brown /*J
7048f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
70584df9cb4SJed Brown 
70684df9cb4SJed Brown    Level: beginner
70784df9cb4SJed Brown 
708db781477SPatrick Sanan .seealso: `TSAdaptSetType()`, `TS`
709f0fc11ceSJed Brown J*/
710f8963224SJed Brown typedef const char *TSAdaptType;
711b0f836d7SJed Brown #define TSADAPTNONE    "none"
7121917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
713cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
7148d59e960SJed Brown #define TSADAPTCFL     "cfl"
7151917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
716d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
71784df9cb4SJed Brown 
718552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
719bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
720607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
721014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
722014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
72319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
724d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
725014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
726014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
727014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
728014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
729014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
730b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
731014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
732ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
7334416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
734099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
735014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
736014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
737bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
7381917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
7391917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
74076cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt,PetscReal);
74176cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt,PetscReal*);
7421917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
7431917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
74462c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt,PetscReal);
74562c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt,PetscReal*);
746014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
7471917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
748b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
749d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
75075017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool);
75175017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*);
752de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt);
753cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
754cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);
75584df9cb4SJed Brown 
75684df9cb4SJed Brown /*S
75726d28e4eSEmil Constantinescu    TSGLLEAdapt - Abstract object that manages time-step adaptivity
758ed657a08SJed Brown 
759ed657a08SJed Brown    Level: beginner
760ed657a08SJed Brown 
76184df9cb4SJed Brown    Developer Notes:
76284df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
76384df9cb4SJed Brown 
764db781477SPatrick Sanan .seealso: `TSGLLE`, `TSGLLEAdaptCreate()`, `TSGLLEAdaptType`
765ed657a08SJed Brown S*/
76626d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
767ed657a08SJed Brown 
76876bdecfbSBarry Smith /*J
76926d28e4eSEmil Constantinescu     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
770ed657a08SJed Brown 
771ed657a08SJed Brown    Level: beginner
772ed657a08SJed Brown 
773db781477SPatrick Sanan .seealso: `TSGLLEAdaptSetType()`, `TS`
77476bdecfbSBarry Smith J*/
77526d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
77626d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
77726d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
77826d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
779ed657a08SJed Brown 
78026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
78126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
78226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
78326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
78426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
78526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
78626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
78726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
78826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
78926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
790ed657a08SJed Brown 
79176bdecfbSBarry Smith /*J
79226d28e4eSEmil Constantinescu     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
793ed657a08SJed Brown 
794ed657a08SJed Brown    Level: beginner
795ed657a08SJed Brown 
796db781477SPatrick Sanan .seealso: `TSGLLESetAcceptType()`, `TS`
79776bdecfbSBarry Smith J*/
79826d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
79926d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
800ed657a08SJed Brown 
80126d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
80226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
803ed657a08SJed Brown 
80476bdecfbSBarry Smith /*J
80526d28e4eSEmil Constantinescu   TSGLLEType - family of time integration method within the General Linear class
80618b56cb9SJed Brown 
80718b56cb9SJed Brown   Level: beginner
80818b56cb9SJed Brown 
809db781477SPatrick Sanan .seealso: `TSGLLESetType()`, `TSGLLERegister()`
81076bdecfbSBarry Smith J*/
81126d28e4eSEmil Constantinescu typedef const char* TSGLLEType;
81226d28e4eSEmil Constantinescu #define TSGLLE_IRKS   "irks"
81318b56cb9SJed Brown 
81426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
81526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
81626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
81726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
81826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
81926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
82018b56cb9SJed Brown 
821020d8f30SJed Brown /*J
8227d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
8237d5697caSHong Zhang 
8247d5697caSHong Zhang    Level: beginner
8257d5697caSHong Zhang 
826db781477SPatrick Sanan .seealso: `TSEIMEXSetType()`, `TS`, `TSEIMEX`, `TSEIMEXRegister()`
8277d5697caSHong Zhang J*/
8287d5697caSHong Zhang #define TSEIMEXType   char*
8297d5697caSHong Zhang 
8307d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
8317d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
8327d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
8337d5697caSHong Zhang 
8347d5697caSHong Zhang /*J
835f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
836f68a32c8SEmil Constantinescu 
837f68a32c8SEmil Constantinescu    Level: beginner
838f68a32c8SEmil Constantinescu 
839db781477SPatrick Sanan .seealso: `TSRKSetType()`, `TS`, `TSRK`, `TSRKRegister()`
840f68a32c8SEmil Constantinescu J*/
841f68a32c8SEmil Constantinescu typedef const char* TSRKType;
842f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
843fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
844e7685601SHong Zhang #define TSRK2B    "2b"
845f68a32c8SEmil Constantinescu #define TSRK3     "3"
846fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
847f68a32c8SEmil Constantinescu #define TSRK4     "4"
848fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
849fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
85005e23783SLisandro Dalcin #define TSRK5BS   "5bs"
85137acaa02SHendrik Ranocha #define TSRK6VR   "6vr"
85237acaa02SHendrik Ranocha #define TSRK7VR   "7vr"
85337acaa02SHendrik Ranocha #define TSRK8VR   "8vr"
85405e23783SLisandro Dalcin 
8552ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS,PetscInt*);
8560f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS,TSRKType*);
8570f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS,TSRKType);
8580f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS,PetscInt*,const PetscReal**,const PetscReal**,const PetscReal**,const PetscReal**,PetscInt*,const PetscReal**,PetscBool*);
8590fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool);
8600fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*);
861f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
862f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
863560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
864f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
865f68a32c8SEmil Constantinescu 
866f68a32c8SEmil Constantinescu /*J
8674b84eec9SHong Zhang    TSMPRKType - String with the name of a Partitioned Runge-Kutta method
8689f537349Sluzhanghpp 
8699f537349Sluzhanghpp    Level: beginner
8709f537349Sluzhanghpp 
871db781477SPatrick Sanan .seealso: `TSMPRKSetType()`, `TS`, `TSMPRK`, `TSMPRKRegister()`
8729f537349Sluzhanghpp J*/
8734b84eec9SHong Zhang typedef const char* TSMPRKType;
87419c2959aSHong Zhang #define TSMPRK2A22  "2a22"
87519c2959aSHong Zhang #define TSMPRK2A23  "2a23"
87619c2959aSHong Zhang #define TSMPRK2A32  "2a32"
87719c2959aSHong Zhang #define TSMPRK2A33  "2a33"
8784b84eec9SHong Zhang #define TSMPRKP2    "p2"
8794b84eec9SHong Zhang #define TSMPRKP3    "p3"
8809f537349Sluzhanghpp 
8814b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*);
8824b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType);
88379bc8a77SHong 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[]);
8844b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
8854b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
8864b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);
8879f537349Sluzhanghpp 
8889f537349Sluzhanghpp /*J
889d2567f34SHong Zhang     TSIRKType - String with the name of an implicit Runge-Kutta method.
890d2567f34SHong Zhang 
891d2567f34SHong Zhang    Level: beginner
892d2567f34SHong Zhang 
893db781477SPatrick Sanan .seealso: `TSIRKSetType()`, `TS`, `TSIRK`, `TSIRKRegister()`
894d2567f34SHong Zhang J*/
895d2567f34SHong Zhang typedef const char* TSIRKType;
896d2567f34SHong Zhang #define TSIRKGAUSS   "gauss"
897d2567f34SHong Zhang 
898d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetOrder(TS,PetscInt*);
899d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetType(TS,TSIRKType*);
900d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetType(TS,TSIRKType);
901d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetNumStages(TS,PetscInt*);
902d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetNumStages(TS,PetscInt);
903d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegister(const char[],PetscErrorCode (*function)(TS));
904d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKTableauCreate(TS,PetscInt,const PetscReal*,const PetscReal*,const PetscReal*,const PetscReal*,const PetscScalar*,const PetscScalar*,const PetscScalar*);
905d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKInitializePackage(void);
906d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKFinalizePackage(void);
907d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegisterDestroy(void);
908d2567f34SHong Zhang 
909d2567f34SHong Zhang /*J
910b6a60446SDebojyoti Ghosh     TSGLEEType - String with the name of a General Linear with Error Estimation method.
911b6a60446SDebojyoti Ghosh 
912b6a60446SDebojyoti Ghosh    Level: beginner
913b6a60446SDebojyoti Ghosh 
914db781477SPatrick Sanan .seealso: `TSGLEESetType()`, `TS`, `TSGLEE`, `TSGLEERegister()`
915b6a60446SDebojyoti Ghosh J*/
916b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType;
917ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
918b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
919b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
920b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
921b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
922b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
923b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
924b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
925b6a60446SDebojyoti Ghosh /*J
926b6a60446SDebojyoti Ghosh     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
927b6a60446SDebojyoti Ghosh 
928b6a60446SDebojyoti Ghosh    Level: beginner
929b6a60446SDebojyoti Ghosh 
930db781477SPatrick Sanan .seealso: `TSGLEESetMode()`, `TS`, `TSGLEE`, `TSGLEERegister()`
931b6a60446SDebojyoti Ghosh J*/
932b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
933b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
93457df6a1bSDebojyoti 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[]);
935b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
936b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
937b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
938b6a60446SDebojyoti Ghosh 
939b6a60446SDebojyoti Ghosh /*J
940020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
941020d8f30SJed Brown 
942020d8f30SJed Brown    Level: beginner
943020d8f30SJed Brown 
944db781477SPatrick Sanan .seealso: `TSARKIMEXSetType()`, `TS`, `TSARKIMEX`, `TSARKIMEXRegister()`
945020d8f30SJed Brown J*/
94619fd82e9SBarry Smith typedef const char* TSARKIMEXType;
947e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
9481f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
9491f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
9501f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
9511f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
9528a381b04SJed Brown #define TSARKIMEX2D     "2d"
953a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
9546cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
9558a381b04SJed Brown #define TSARKIMEX3      "3"
9566cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
9576cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
9588a381b04SJed Brown #define TSARKIMEX4      "4"
9598a381b04SJed Brown #define TSARKIMEX5      "5"
96019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
96119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
962014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
9633a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS,PetscBool*);
96419fd82e9SBarry 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[]);
965607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
966560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
967014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
9688a381b04SJed Brown 
969020d8f30SJed Brown /*J
970020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
971020d8f30SJed Brown 
972020d8f30SJed Brown    Level: beginner
973020d8f30SJed Brown 
974db781477SPatrick Sanan .seealso: `TSRosWSetType()`, `TS`, `TSROSW`, `TSRosWRegister()`
975020d8f30SJed Brown J*/
97619fd82e9SBarry Smith typedef const char* TSRosWType;
97761692a83SJed Brown #define TSROSW2M          "2m"
97861692a83SJed Brown #define TSROSW2P          "2p"
979fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
980fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
981ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
982ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
983961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
984961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
98543b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
986753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
9873606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
9883606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
98942faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
99042faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
99142faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
99242faf41dSJed Brown #define TSROSW4L          "4l"
993b1c69cc3SEmil Constantinescu 
9946bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
9956bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
996014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
99719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
99819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
999607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
1000560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
1001014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
1002e27a552bSJed Brown 
1003211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
1004211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
1005211a84d6SLisandro Dalcin 
10066bd7aeb5SHong Zhang /*J
1007e49d4f37SHong Zhang   TSBasicSymplecticType - String with the name of a basic symplectic integration method.
10086bd7aeb5SHong Zhang 
10096bd7aeb5SHong Zhang   Level: beginner
10106bd7aeb5SHong Zhang 
1011db781477SPatrick Sanan   .seealso: `TSBasicSymplecticSetType()`, `TS`, `TSBASICSYMPLECTIC`, `TSBasicSymplecticRegister()`
10126bd7aeb5SHong Zhang J*/
1013e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType;
1014e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
1015e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
1016e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
1017e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
1018e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
1019e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
1020e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
1021e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
1022e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
1023e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
10246bd7aeb5SHong Zhang 
1025db4653c2SDaniel Finn /*J
1026db4653c2SDaniel Finn   TSDiscreteGradient - The Discrete Gradient integrator is a timestepper for hamiltonian systems designed to conserve the first integral (energy), but also has the property for some systems of monotonicity in a functional.
1027db4653c2SDaniel Finn 
1028db4653c2SDaniel Finn   Level: beginner
1029db4653c2SDaniel Finn 
1030db781477SPatrick Sanan   .seealso: `TS`, `TSDISCGRAD`, `TSDiscGradSetFormulation()`, `TSDiscGradGetFormulation`
1031db4653c2SDaniel Finn J*/
103240be0ff1SMatthew 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 *);
1033db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradIsGonzalez(TS,PetscBool*);
1034db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradUseGonzalez(TS,PetscBool);
103540be0ff1SMatthew G. Knepley 
103683e2fdc7SBarry Smith /*
10370f3b3ca1SHong Zhang        PETSc interface to Sundials
103883e2fdc7SBarry Smith */
1039e808b789SPatrick Sanan #ifdef PETSC_HAVE_SUNDIALS2
10406fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
10416a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
10426fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
10436a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
1044014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
1045014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
1046014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
1047014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
1048014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
1049014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
1050014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
1051014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
1052014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
1053014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool);
1054014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
1055014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
1056c4e80e11SFlorian PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS,PetscInt);
1057918687b8SPatrick Sanan PETSC_EXTERN PetscErrorCode TSSundialsSetUseDense(TS,PetscBool);
10586dc17ff5SMatthew Knepley #endif
105983e2fdc7SBarry Smith 
1060014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
1061014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
1062014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
1063014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
10640de4c49aSJed Brown 
1065014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
1066014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
1067014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
106888df8a41SLisandro Dalcin 
1069818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
1070818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
1071818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
1072818efac9SLisandro Dalcin 
1073014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
1074014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
10756c699258SBarry Smith 
1076014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
1077d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
10780f5c6efeSJed Brown 
1079f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
1080f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
1081aad739acSMatthew G. Knepley 
10822e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec));
10832e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec));
10842e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec);
10852e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec));
1086aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec));
1087aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec);
1088f2ed2dc7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool);
1089d60b7d5cSBarry Smith 
1090d60b7d5cSBarry Smith PETSC_EXTERN PetscErrorCode TSSetMatStructure(TS,MatStructure);
1091818ad0c1SBarry Smith #endif
1092