xref: /petsc/include/petscts.h (revision 3a28c0e5af47c299e43f5d8910566cd764d76c8d)
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
72c8e378dSBarry Smith #include <petscsnes.h>
8900f6b5bSMatthew G. Knepley #include <petscconvest.h>
9818ad0c1SBarry Smith 
10435da068SBarry Smith /*S
11435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
12435da068SBarry Smith 
13435da068SBarry Smith    Level: beginner
14435da068SBarry Smith 
158f6c3df8SBarry Smith .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
16435da068SBarry Smith S*/
17f09e8eb9SSatish Balay typedef struct _p_TS* TS;
18435da068SBarry Smith 
1976bdecfbSBarry Smith /*J
208f6c3df8SBarry Smith     TSType - String with the name of a PETSc TS method.
21435da068SBarry Smith 
22435da068SBarry Smith    Level: beginner
23435da068SBarry Smith 
248f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister()
2576bdecfbSBarry Smith J*/
2619fd82e9SBarry Smith typedef const char* TSType;
279596e0b4SJed Brown #define TSEULER           "euler"
289596e0b4SJed Brown #define TSBEULER          "beuler"
29e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic"
309596e0b4SJed Brown #define TSPSEUDO          "pseudo"
314d91e141SJed Brown #define TSCN              "cn"
329596e0b4SJed Brown #define TSSUNDIALS        "sundials"
334d91e141SJed Brown #define TSRK              "rk"
349596e0b4SJed Brown #define TSPYTHON          "python"
359596e0b4SJed Brown #define TSTHETA           "theta"
3688df8a41SLisandro Dalcin #define TSALPHA           "alpha"
37818efac9SLisandro Dalcin #define TSALPHA2          "alpha2"
3826d28e4eSEmil Constantinescu #define TSGLLE            "glle"
39b6a60446SDebojyoti Ghosh #define TSGLEE            "glee"
40ef7bb5aaSJed Brown #define TSSSP             "ssp"
418a381b04SJed Brown #define TSARKIMEX         "arkimex"
42e27a552bSJed Brown #define TSROSW            "rosw"
437d5697caSHong Zhang #define TSEIMEX           "eimex"
44abadfa0fSMatthew G. Knepley #define TSMIMEX           "mimex"
45211a84d6SLisandro Dalcin #define TSBDF             "bdf"
46d249a78fSBarry Smith #define TSRADAU5          "radau5"
474b84eec9SHong Zhang #define TSMPRK            "mprk"
48211a84d6SLisandro Dalcin 
49435da068SBarry Smith /*E
50435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
51435da068SBarry Smith 
52435da068SBarry Smith    Level: beginner
53435da068SBarry Smith 
54435da068SBarry Smith .seealso: TSCreate()
55435da068SBarry Smith E*/
5619bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
57818ad0c1SBarry Smith 
58b93fea0eSJed Brown /*E
59e817cc15SEmil Constantinescu    TSEquationType - type of TS problem that is solved
60e817cc15SEmil Constantinescu 
61e817cc15SEmil Constantinescu    Level: beginner
62e817cc15SEmil Constantinescu 
6395452b02SPatrick Sanan    Developer Notes:
6495452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
65e817cc15SEmil Constantinescu 
66e817cc15SEmil Constantinescu    Supported types are:
67e817cc15SEmil Constantinescu      TS_EQ_UNSPECIFIED (default)
68e817cc15SEmil 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
69e817cc15SEmil Constantinescu      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
70e817cc15SEmil Constantinescu 
71e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType()
72e817cc15SEmil Constantinescu E*/
73e817cc15SEmil Constantinescu typedef enum {
74e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
75e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
76e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
77e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
78e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
79e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
80e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
81e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
82e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
83e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
84e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
85e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
8619436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
87e817cc15SEmil Constantinescu } TSEquationType;
88e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes;
89e817cc15SEmil Constantinescu 
90e817cc15SEmil Constantinescu /*E
91b93fea0eSJed Brown    TSConvergedReason - reason a TS method has converged or not
92b93fea0eSJed Brown 
93b93fea0eSJed Brown    Level: beginner
94b93fea0eSJed Brown 
9595452b02SPatrick Sanan    Developer Notes:
9695452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
97b93fea0eSJed Brown 
98b93fea0eSJed Brown    Each reason has its own manual page.
99b93fea0eSJed Brown 
100b93fea0eSJed Brown .seealso: TSGetConvergedReason()
101b93fea0eSJed Brown E*/
102193ac0bcSJed Brown typedef enum {
103193ac0bcSJed Brown   TS_CONVERGED_ITERATING          = 0,
104193ac0bcSJed Brown   TS_CONVERGED_TIME               = 1,
105193ac0bcSJed Brown   TS_CONVERGED_ITS                = 2,
106d6ad946cSShri Abhyankar   TS_CONVERGED_USER               = 3,
1072b7db910SShri Abhyankar   TS_CONVERGED_EVENT              = 4,
1083118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL       = 5,
1093118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL       = 6,
110193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE     = -1,
111b5b4017aSHong Zhang   TS_DIVERGED_STEP_REJECTED       = -2,
11205c9950eSHong Zhang   TSFORWARD_DIVERGED_LINEAR_SOLVE = -3,
11305c9950eSHong Zhang   TSADJOINT_DIVERGED_LINEAR_SOLVE = -4
114193ac0bcSJed Brown } TSConvergedReason;
115014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons;
1161957e957SBarry Smith 
117b93fea0eSJed Brown /*MC
118b93fea0eSJed Brown    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
119b93fea0eSJed Brown 
120b93fea0eSJed Brown    Level: beginner
121b93fea0eSJed Brown 
122552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
123b93fea0eSJed Brown M*/
124b93fea0eSJed Brown 
125b93fea0eSJed Brown /*MC
126b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
127b93fea0eSJed Brown 
128b93fea0eSJed Brown    Level: beginner
129b93fea0eSJed Brown 
13019eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime()
131b93fea0eSJed Brown M*/
132b93fea0eSJed Brown 
133b93fea0eSJed Brown /*MC
1341957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
135b93fea0eSJed Brown 
136b93fea0eSJed Brown    Level: beginner
137b93fea0eSJed Brown 
13819eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps()
139b93fea0eSJed Brown M*/
1401957e957SBarry Smith 
141d6ad946cSShri Abhyankar /*MC
142d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
143d6ad946cSShri Abhyankar 
144d6ad946cSShri Abhyankar    Level: beginner
145d6ad946cSShri Abhyankar 
14619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
147b93fea0eSJed Brown M*/
148b93fea0eSJed Brown 
149b93fea0eSJed Brown /*MC
150d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
151d76fc68cSShri Abhyankar 
152d76fc68cSShri Abhyankar    Level: beginner
153d76fc68cSShri Abhyankar 
15419eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
155d76fc68cSShri Abhyankar M*/
156d76fc68cSShri Abhyankar 
157d76fc68cSShri Abhyankar /*MC
1583118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
1593118ae5eSBarry Smith 
1603118ae5eSBarry Smith    Level: beginner
1613118ae5eSBarry Smith 
1623118ae5eSBarry Smith    Options Database:
1633118ae5eSBarry Smith .   -ts_pseudo_frtol <rtol>
1643118ae5eSBarry Smith 
16519eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL
1663118ae5eSBarry Smith M*/
1673118ae5eSBarry Smith 
1683118ae5eSBarry Smith /*MC
1693118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
1703118ae5eSBarry Smith 
1713118ae5eSBarry Smith    Level: beginner
1723118ae5eSBarry Smith 
1733118ae5eSBarry Smith    Options Database:
1743118ae5eSBarry Smith .   -ts_pseudo_fatol <atol>
1753118ae5eSBarry Smith 
17619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL
1773118ae5eSBarry Smith M*/
1783118ae5eSBarry Smith 
1793118ae5eSBarry Smith /*MC
180b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
181b93fea0eSJed Brown 
182b93fea0eSJed Brown    Level: beginner
183b93fea0eSJed Brown 
18495452b02SPatrick Sanan    Notes:
18595452b02SPatrick Sanan     See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
1861957e957SBarry Smith 
1871957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
188b93fea0eSJed Brown M*/
189b93fea0eSJed Brown 
190b93fea0eSJed Brown /*MC
191b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
192b93fea0eSJed Brown 
193b93fea0eSJed Brown    Level: beginner
194b93fea0eSJed Brown 
19595452b02SPatrick Sanan    Notes:
19695452b02SPatrick Sanan     See TSSetMaxStepRejections() for how to allow more step rejections.
1971957e957SBarry Smith 
1981957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
199b93fea0eSJed Brown M*/
200b93fea0eSJed Brown 
201d6ad946cSShri Abhyankar /*E
202d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
203d6ad946cSShri Abhyankar 
204d6ad946cSShri Abhyankar    Level: beginner
205d6ad946cSShri Abhyankar 
20695452b02SPatrick Sanan    Developer Notes:
20795452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
208d6ad946cSShri Abhyankar 
209d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
210d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
211d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
212feed9e9dSBarry Smith 
213f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime()
2144ceb6c04SBarry Smith 
215d6ad946cSShri Abhyankar E*/
216feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
217d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
218d6ad946cSShri Abhyankar 
219000e7ae3SMatthew Knepley /* Logging support */
220014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
221d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2221b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
223000e7ae3SMatthew Knepley 
224607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
225560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2268ba1e511SMatthew Knepley 
227014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
228baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
229014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
230818ad0c1SBarry Smith 
231014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
233014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
235721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
237818ad0c1SBarry Smith 
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
244818ad0c1SBarry Smith 
245014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
247818ad0c1SBarry Smith 
248efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
249efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
25057df6a1bSDebojyoti Ghosh 
251642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
252642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
2530a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
25457df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);
2556e2e232bSDebojyoti Ghosh 
256a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
257cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS,Mat*,PetscErrorCode(**)(TS,PetscReal,Vec,Mat,void*),void**);
258a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat);
25933f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal,Mat,void*),void*);
26033f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS,PetscReal,Vec,Vec,PetscReal,Mat,PetscBool);
26125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
26225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSComputeDRDUFunction(TS,PetscReal,Vec,Vec*);
263b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
264b5b4017aSHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
265b5b4017aSHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
266b5b4017aSHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
267b5b4017aSHong Zhang                                                     void*);
268b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
269b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
270b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
271b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
27213af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27313af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27413af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27513af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27613af1a74SHong Zhang                                                     void*);
277b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
278b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
279b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
280b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
281b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS,PetscInt,Vec*,Vec*,Vec);
282b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS,PetscInt*,Vec**,Vec**,Vec*);
283ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS,Vec,Mat,Mat);
284a05bf03eSHong Zhang 
285bc952696SBarry Smith /*S
286e91eccc2SStefano Zampini      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)
287bc952696SBarry Smith 
288bc952696SBarry Smith    Level: advanced
289bc952696SBarry Smith 
2901550c9b9SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset()
291bc952696SBarry Smith S*/
292bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory;
293bc952696SBarry Smith 
294bc952696SBarry Smith /*J
2953c0fce88SHong Zhang     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method
296bc952696SBarry Smith 
297bc952696SBarry Smith    Level: intermediate
298bc952696SBarry Smith 
2993c0fce88SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy()
300bc952696SBarry Smith J*/
301bc952696SBarry Smith typedef const char* TSTrajectoryType;
302bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
3031c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
3049a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
3052b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
306bc952696SBarry Smith 
307bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
308bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
309bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
310bc952696SBarry Smith 
311bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
3122d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS);
313bc952696SBarry Smith 
314bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
3159a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
316bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
317560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
318fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType);
319881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory,TS,TSTrajectoryType*);
320bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
321c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
322fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec);
323fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*);
324fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*);
325fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*);
326972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
327560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
328bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
32968bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
3309ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory,PetscBool);
3312bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
33278fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
33308347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
334fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool);
335fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*);
33664fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool);
33764e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]);
33864e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]);
33978fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);
340bc952696SBarry Smith 
341dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
342dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
34325ef9dfeSBarry 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*);
344dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
345022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);
346cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS,PetscBool,TS*);
347cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS,PetscBool*,TS*);
348d4aa0a58SBarry Smith 
349a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
350a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
351a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
352a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
353a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
354a05bf03eSHong Zhang 
35525ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetRHSJacobianP()")     PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
35625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSComputeRHSJacobianP()") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
35725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
35825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
3592c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
36073b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
361d4aa0a58SBarry Smith 
36273b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
363f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
364ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS);
365999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
366ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS,Mat);
367ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS);
368715f1b00SHong Zhang 
36913b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
37013b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
37125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() and TSForwardSetSensitivities() (since version 3.12)") PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
37225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSForwardGetSensitivities()")                          PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
373715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*);
374715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*);
375715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
3767adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS);
377999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
378715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
379b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat);
3806affb6f8SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat**);
381c235aa8dSHong Zhang 
382618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
383618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
384618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
385618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
38649354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
387f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);
388818ad0c1SBarry Smith 
38925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetTime[Step]() (since version 3.8)")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
39025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
39125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
39225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
39325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
39419eac22cSLisandro Dalcin 
395721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
396cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
39783a4ac43SBarry Smith 
39883a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
39983a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
40083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
40183a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
4022d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
40383a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
4040ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);
40583a4ac43SBarry Smith 
406721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
4079110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
4089110b2e7SHong Zhang 
409721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
412fb1732b5SBarry Smith 
413014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
4147cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
415014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
416cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
417e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
418e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
419014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
420d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
421487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
4225ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
4235ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
424cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
425cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
426cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
427cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
428cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
429dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
43024655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
431d2daff3dSHong Zhang 
432ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);
433818ad0c1SBarry Smith 
434014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
435014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
436e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
43780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
43880275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
43980275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
44080275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);
441818ad0c1SBarry Smith 
442638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
443d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
444cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS,PetscReal,Vec,Mat,void*);
445014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
446014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
447014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
448014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
449e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
450818ad0c1SBarry Smith 
451ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
452ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
453d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
454d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
455ef20d060SBarry Smith 
456638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
457d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
460014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
461014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
462316643e7SJed Brown 
463efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
464efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
465efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
466efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
467efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
468efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
469efe9872eSLisandro Dalcin 
470545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
471545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
472545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
4731d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
4741d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
4750fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
4760fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*);
477d9194312SHong Zhang 
478014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
479d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
480014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
481d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
4821c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
4839b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
484847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
485e34be4c2SBarry Smith 
486014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
487b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
4889be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
489c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
490014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
491014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
492b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
4939be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
494c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
495014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
496014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
497014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
498c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
4997453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5007453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5017453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
5028a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5038a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5048a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
505014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
506014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
507d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
508d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
509000e7ae3SMatthew Knepley 
510014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
5118d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
514014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
5158d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
516014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
517014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
518014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
51921c89e3eSBarry Smith 
520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
5211d6018f0SLisandro Dalcin 
522014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
523d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
524014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
525d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
526efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
527efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
528f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
529818ad0c1SBarry Smith 
530014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
531d6ebe24aSShri Abhyankar 
532967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
53324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
53424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
53524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
53624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
53724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
53824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
53924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
54024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
541efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
542efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
543efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
544efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
545efe9872eSLisandro Dalcin 
546ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
547ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
548d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
549d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
550924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
551924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
5520163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **);
5539b7cd975SBarry Smith 
554d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
555d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
556d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
5576c6b9e74SPeter Brune 
5586c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5596c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5606c6b9e74SPeter Brune 
5616c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
562d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
5636c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
564d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
5656c6b9e74SPeter Brune 
5666c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
567d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
5686c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
569d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
5706c6b9e74SPeter Brune 
571b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
572560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*);
5736dbbd306SMatthew G. Knepley 
574be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
575d1212d36SBarry Smith typedef struct {
576d1212d36SBarry Smith   Vec            ray;
577d1212d36SBarry Smith   VecScatter     scatter;
578d1212d36SBarry Smith   PetscViewer    viewer;
57951b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
580d1212d36SBarry Smith } TSMonitorDMDARayCtx;
581d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
582d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
58351b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
584d1212d36SBarry Smith 
585bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
586140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
58719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
58819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
589bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
59030de9b25SBarry Smith 
591014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
592deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
593014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
594818ad0c1SBarry Smith 
595014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
59655849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
597fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS,PetscObject,const char[]);
598fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory,PetscObject,const char[]);
59955849f57SBarry Smith 
60055849f57SBarry Smith #define TS_FILE_CLASSID 1211225
60121c89e3eSBarry Smith 
602014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
603014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
60421c89e3eSBarry Smith 
605a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
606a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
6074f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
6084f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
60931152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
610b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
611e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
612a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
613a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
6147684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
6157684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
6164f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
617201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
618201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
619edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
620ef20d060SBarry Smith 
621b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
622b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
623b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
624b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
625b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
626b3d3934dSBarry Smith 
6278189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
6288189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
6298189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
6308189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
6313914022bSBarry Smith 
6321b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx;
6331b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*);
6341b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*);
6350ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*);
6361b575b74SJoseph Pusztay 
6372589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
6380e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal);
6396427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
64076bdecfbSBarry Smith /*J
641815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
642815f1ad5SJed Brown 
643815f1ad5SJed Brown    Level: beginner
644815f1ad5SJed Brown 
645815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
64676bdecfbSBarry Smith J*/
64719fd82e9SBarry Smith typedef const char* TSSSPType;
648815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
649815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
650815f1ad5SJed Brown #define TSSSPRK104 "rk104"
651815f1ad5SJed Brown 
65219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
65319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
654014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
655014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
656787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
657560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
658013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
659815f1ad5SJed Brown 
660ed657a08SJed Brown /*S
66184df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
66284df9cb4SJed Brown 
66384df9cb4SJed Brown    Level: beginner
66484df9cb4SJed Brown 
66584df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType
66684df9cb4SJed Brown S*/
66784df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
66884df9cb4SJed Brown 
66984df9cb4SJed Brown /*E
6708f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
67184df9cb4SJed Brown 
67284df9cb4SJed Brown    Level: beginner
67384df9cb4SJed Brown 
67484df9cb4SJed Brown .seealso: TSAdaptSetType(), TS
67584df9cb4SJed Brown E*/
676f8963224SJed Brown typedef const char *TSAdaptType;
677b0f836d7SJed Brown #define TSADAPTNONE    "none"
6781917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
679cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
6808d59e960SJed Brown #define TSADAPTCFL     "cfl"
6811917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
682d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
68384df9cb4SJed Brown 
684552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
685bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
686607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
687014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
688014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
68919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
690d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
691014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
692014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
693014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
694014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
695014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
696b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
697014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
698ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
6994416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
700099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
701014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
702014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
703bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
7041917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
7051917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
70676cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt,PetscReal);
70776cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt,PetscReal*);
7081917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
7091917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
710014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
7111917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
712b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
713d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
71475017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool);
71575017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*);
716de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt);
717cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
718cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);
71984df9cb4SJed Brown 
72084df9cb4SJed Brown /*S
72126d28e4eSEmil Constantinescu    TSGLLEAdapt - Abstract object that manages time-step adaptivity
722ed657a08SJed Brown 
723ed657a08SJed Brown    Level: beginner
724ed657a08SJed Brown 
72584df9cb4SJed Brown    Developer Notes:
72684df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
72784df9cb4SJed Brown 
72826d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
729ed657a08SJed Brown S*/
73026d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
731ed657a08SJed Brown 
73276bdecfbSBarry Smith /*J
73326d28e4eSEmil Constantinescu     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
734ed657a08SJed Brown 
735ed657a08SJed Brown    Level: beginner
736ed657a08SJed Brown 
73726d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS
73876bdecfbSBarry Smith J*/
73926d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
74026d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
74126d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
74226d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
743ed657a08SJed Brown 
74426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
74526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
74626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
74726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
74826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
74926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
75026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
75126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
75226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
75326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
754ed657a08SJed Brown 
75576bdecfbSBarry Smith /*J
75626d28e4eSEmil Constantinescu     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
757ed657a08SJed Brown 
758ed657a08SJed Brown    Level: beginner
759ed657a08SJed Brown 
76026d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS
76176bdecfbSBarry Smith J*/
76226d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
76326d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
764ed657a08SJed Brown 
76526d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
76626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
767ed657a08SJed Brown 
76876bdecfbSBarry Smith /*J
76926d28e4eSEmil Constantinescu   TSGLLEType - family of time integration method within the General Linear class
77018b56cb9SJed Brown 
77118b56cb9SJed Brown   Level: beginner
77218b56cb9SJed Brown 
77326d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister()
77476bdecfbSBarry Smith J*/
77526d28e4eSEmil Constantinescu typedef const char* TSGLLEType;
77626d28e4eSEmil Constantinescu #define TSGLLE_IRKS   "irks"
77718b56cb9SJed Brown 
77826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
77926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
78026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
78126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
78226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
78326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
78418b56cb9SJed Brown 
785020d8f30SJed Brown /*J
7867d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
7877d5697caSHong Zhang 
7887d5697caSHong Zhang    Level: beginner
7897d5697caSHong Zhang 
7907d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
7917d5697caSHong Zhang J*/
7927d5697caSHong Zhang #define TSEIMEXType   char*
7937d5697caSHong Zhang 
7947d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
7957d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
7967d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
7977d5697caSHong Zhang 
7987d5697caSHong Zhang /*J
799f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
800f68a32c8SEmil Constantinescu 
801f68a32c8SEmil Constantinescu    Level: beginner
802f68a32c8SEmil Constantinescu 
803f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
804f68a32c8SEmil Constantinescu J*/
805f68a32c8SEmil Constantinescu typedef const char* TSRKType;
806f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
807fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
808f68a32c8SEmil Constantinescu #define TSRK3     "3"
809fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
810f68a32c8SEmil Constantinescu #define TSRK4     "4"
811fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
812fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
81305e23783SLisandro Dalcin #define TSRK5BS   "5bs"
81437acaa02SHendrik Ranocha #define TSRK6VR   "6vr"
81537acaa02SHendrik Ranocha #define TSRK7VR   "7vr"
81637acaa02SHendrik Ranocha #define TSRK8VR   "8vr"
81705e23783SLisandro Dalcin 
818f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
819f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
8200fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool);
8210fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*);
822f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
823f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
824f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
825560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
826f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
827f68a32c8SEmil Constantinescu 
828f68a32c8SEmil Constantinescu /*J
8294b84eec9SHong Zhang    TSMPRKType - String with the name of a Partitioned Runge-Kutta method
8309f537349Sluzhanghpp 
8319f537349Sluzhanghpp    Level: beginner
8329f537349Sluzhanghpp 
8334b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister()
8349f537349Sluzhanghpp J*/
8354b84eec9SHong Zhang typedef const char* TSMPRKType;
83619c2959aSHong Zhang #define TSMPRK2A22   "2a22"
83719c2959aSHong Zhang #define TSMPRK2A23   "2a23"
83819c2959aSHong Zhang #define TSMPRK2A32   "2a32"
83919c2959aSHong Zhang #define TSMPRK2A33   "2a33"
8404b84eec9SHong Zhang #define TSMPRKP2    "p2"
8414b84eec9SHong Zhang #define TSMPRKP3    "p3"
8429f537349Sluzhanghpp 
8434b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*);
8444b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType);
84579bc8a77SHong 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[]);
8464b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
8474b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
8484b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);
8499f537349Sluzhanghpp 
8509f537349Sluzhanghpp /*J
851b6a60446SDebojyoti Ghosh     TSGLEEType - String with the name of a General Linear with Error Estimation method.
852b6a60446SDebojyoti Ghosh 
853b6a60446SDebojyoti Ghosh    Level: beginner
854b6a60446SDebojyoti Ghosh 
855b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
856b6a60446SDebojyoti Ghosh J*/
857b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType;
858ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
859b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
860b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
861b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
862b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
863b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
864b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
865b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
866b6a60446SDebojyoti Ghosh /*J
867b6a60446SDebojyoti Ghosh     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
868b6a60446SDebojyoti Ghosh 
869b6a60446SDebojyoti Ghosh    Level: beginner
870b6a60446SDebojyoti Ghosh 
871b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
872b6a60446SDebojyoti Ghosh J*/
873b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
874b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
87557df6a1bSDebojyoti 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[]);
876b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
877b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
878b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
879b6a60446SDebojyoti Ghosh 
880b6a60446SDebojyoti Ghosh /*J
881020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
882020d8f30SJed Brown 
883020d8f30SJed Brown    Level: beginner
884020d8f30SJed Brown 
885020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
886020d8f30SJed Brown J*/
88719fd82e9SBarry Smith typedef const char* TSARKIMEXType;
888e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
8891f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
8901f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
8911f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
8921f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
8938a381b04SJed Brown #define TSARKIMEX2D     "2d"
894a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
8956cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
8968a381b04SJed Brown #define TSARKIMEX3      "3"
8976cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
8986cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
8998a381b04SJed Brown #define TSARKIMEX4      "4"
9008a381b04SJed Brown #define TSARKIMEX5      "5"
90119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
90219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
903014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
904*3a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS,PetscBool*);
90519fd82e9SBarry 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[]);
906607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
907560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
908014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
9098a381b04SJed Brown 
910020d8f30SJed Brown /*J
911020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
912020d8f30SJed Brown 
913020d8f30SJed Brown    Level: beginner
914020d8f30SJed Brown 
915020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
916020d8f30SJed Brown J*/
91719fd82e9SBarry Smith typedef const char* TSRosWType;
91861692a83SJed Brown #define TSROSW2M          "2m"
91961692a83SJed Brown #define TSROSW2P          "2p"
920fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
921fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
922ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
923ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
924961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
925961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
92643b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
927753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
9283606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
9293606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
93042faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
93142faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
93242faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
93342faf41dSJed Brown #define TSROSW4L          "4l"
934b1c69cc3SEmil Constantinescu 
9356bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
9366bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
937014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
93819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
93919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
940607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
941560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
942014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
943e27a552bSJed Brown 
944211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
945211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
946211a84d6SLisandro Dalcin 
9476bd7aeb5SHong Zhang /*J
948e49d4f37SHong Zhang   TSBasicSymplecticType - String with the name of a basic symplectic integration method.
9496bd7aeb5SHong Zhang 
9506bd7aeb5SHong Zhang   Level: beginner
9516bd7aeb5SHong Zhang 
952e49d4f37SHong Zhang   .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister()
9536bd7aeb5SHong Zhang J*/
954e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType;
955e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
956e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
957e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
958e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
959e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
960e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
961e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
962e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
963e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
964e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
9656bd7aeb5SHong Zhang 
96683e2fdc7SBarry Smith /*
9670f3b3ca1SHong Zhang        PETSc interface to Sundials
96883e2fdc7SBarry Smith */
9696dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS
9706fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
9716a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
9726fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
9736a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
974014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
975014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
976014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
977014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
978014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
979014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
980014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
981014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
982014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
983014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
984014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
985014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
9866dc17ff5SMatthew Knepley #endif
98783e2fdc7SBarry Smith 
988014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
989014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
990014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
991014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
9920de4c49aSJed Brown 
993014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
994014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
995014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
99688df8a41SLisandro Dalcin 
997818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
998818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
999818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
1000818efac9SLisandro Dalcin 
1001014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
1002014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
10036c699258SBarry Smith 
1004014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
1005d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
10060f5c6efeSJed Brown 
1007f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
1008f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
1009aad739acSMatthew G. Knepley 
10102e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec));
10112e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec));
10122e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec);
10132e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec));
1014aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec));
1015aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec);
1016900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst);
1017818ad0c1SBarry Smith #endif
1018