xref: /petsc/include/petscts.h (revision 13af1a74d217ab121f5f45cf6cdd8dc51f8ba927)
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 */
50a835dfdSSatish Balay #if !defined(__PETSCTS_H)
60a835dfdSSatish Balay #define __PETSCTS_H
72c8e378dSBarry Smith #include <petscsnes.h>
8818ad0c1SBarry Smith 
9435da068SBarry Smith /*S
10435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
11435da068SBarry Smith 
12435da068SBarry Smith    Level: beginner
13435da068SBarry Smith 
14435da068SBarry Smith   Concepts: ODE solvers
15435da068SBarry Smith 
168f6c3df8SBarry Smith .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
17435da068SBarry Smith S*/
18f09e8eb9SSatish Balay typedef struct _p_TS* TS;
19435da068SBarry Smith 
2076bdecfbSBarry Smith /*J
218f6c3df8SBarry Smith     TSType - String with the name of a PETSc TS method.
22435da068SBarry Smith 
23435da068SBarry Smith    Level: beginner
24435da068SBarry Smith 
258f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister()
2676bdecfbSBarry Smith J*/
2719fd82e9SBarry Smith typedef const char* TSType;
289596e0b4SJed Brown #define TSEULER           "euler"
299596e0b4SJed Brown #define TSBEULER          "beuler"
30e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic"
319596e0b4SJed Brown #define TSPSEUDO          "pseudo"
324d91e141SJed Brown #define TSCN              "cn"
339596e0b4SJed Brown #define TSSUNDIALS        "sundials"
344d91e141SJed Brown #define TSRK              "rk"
359596e0b4SJed Brown #define TSPYTHON          "python"
369596e0b4SJed Brown #define TSTHETA           "theta"
3788df8a41SLisandro Dalcin #define TSALPHA           "alpha"
38818efac9SLisandro Dalcin #define TSALPHA2          "alpha2"
3926d28e4eSEmil Constantinescu #define TSGLLE            "glle"
40b6a60446SDebojyoti Ghosh #define TSGLEE            "glee"
41ef7bb5aaSJed Brown #define TSSSP             "ssp"
428a381b04SJed Brown #define TSARKIMEX         "arkimex"
43e27a552bSJed Brown #define TSROSW            "rosw"
447d5697caSHong Zhang #define TSEIMEX           "eimex"
45abadfa0fSMatthew G. Knepley #define TSMIMEX           "mimex"
46211a84d6SLisandro Dalcin #define TSBDF             "bdf"
47d249a78fSBarry Smith #define TSRADAU5          "radau5"
484b84eec9SHong Zhang #define TSMPRK            "mprk"
49211a84d6SLisandro Dalcin 
50435da068SBarry Smith /*E
51435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
52435da068SBarry Smith 
53435da068SBarry Smith    Level: beginner
54435da068SBarry Smith 
55435da068SBarry Smith .seealso: TSCreate()
56435da068SBarry Smith E*/
5719bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
58818ad0c1SBarry Smith 
59b93fea0eSJed Brown /*E
60e817cc15SEmil Constantinescu    TSEquationType - type of TS problem that is solved
61e817cc15SEmil Constantinescu 
62e817cc15SEmil Constantinescu    Level: beginner
63e817cc15SEmil Constantinescu 
6495452b02SPatrick Sanan    Developer Notes:
6595452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
66e817cc15SEmil Constantinescu 
67e817cc15SEmil Constantinescu    Supported types are:
68e817cc15SEmil Constantinescu      TS_EQ_UNSPECIFIED (default)
69e817cc15SEmil 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
70e817cc15SEmil Constantinescu      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
71e817cc15SEmil Constantinescu 
72e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType()
73e817cc15SEmil Constantinescu E*/
74e817cc15SEmil Constantinescu typedef enum {
75e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
76e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
77e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
78e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
79e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
80e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
81e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
82e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
83e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
84e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
85e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
86e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
8719436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
88e817cc15SEmil Constantinescu } TSEquationType;
89e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes;
90e817cc15SEmil Constantinescu 
91e817cc15SEmil Constantinescu /*E
92b93fea0eSJed Brown    TSConvergedReason - reason a TS method has converged or not
93b93fea0eSJed Brown 
94b93fea0eSJed Brown    Level: beginner
95b93fea0eSJed Brown 
9695452b02SPatrick Sanan    Developer Notes:
9795452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
98b93fea0eSJed Brown 
99b93fea0eSJed Brown    Each reason has its own manual page.
100b93fea0eSJed Brown 
101b93fea0eSJed Brown .seealso: TSGetConvergedReason()
102b93fea0eSJed Brown E*/
103193ac0bcSJed Brown typedef enum {
104193ac0bcSJed Brown   TS_CONVERGED_ITERATING      = 0,
105193ac0bcSJed Brown   TS_CONVERGED_TIME           = 1,
106193ac0bcSJed Brown   TS_CONVERGED_ITS            = 2,
107d6ad946cSShri Abhyankar   TS_CONVERGED_USER           = 3,
1082b7db910SShri Abhyankar   TS_CONVERGED_EVENT          = 4,
1093118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL   = 5,
1103118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL   = 6,
111193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE = -1,
112b5b4017aSHong Zhang   TS_DIVERGED_STEP_REJECTED   = -2,
11305c9950eSHong Zhang   TSFORWARD_DIVERGED_LINEAR_SOLVE = -3,
11405c9950eSHong Zhang   TSADJOINT_DIVERGED_LINEAR_SOLVE = -4
115193ac0bcSJed Brown } TSConvergedReason;
116014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons;
1171957e957SBarry Smith 
118b93fea0eSJed Brown /*MC
119b93fea0eSJed Brown    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
120b93fea0eSJed Brown 
121b93fea0eSJed Brown    Level: beginner
122b93fea0eSJed Brown 
123552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
124b93fea0eSJed Brown M*/
125b93fea0eSJed Brown 
126b93fea0eSJed Brown /*MC
127b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
128b93fea0eSJed Brown 
129b93fea0eSJed Brown    Level: beginner
130b93fea0eSJed Brown 
13119eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime()
132b93fea0eSJed Brown M*/
133b93fea0eSJed Brown 
134b93fea0eSJed Brown /*MC
1351957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
136b93fea0eSJed Brown 
137b93fea0eSJed Brown    Level: beginner
138b93fea0eSJed Brown 
13919eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps()
140b93fea0eSJed Brown M*/
1411957e957SBarry Smith 
142d6ad946cSShri Abhyankar /*MC
143d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
144d6ad946cSShri Abhyankar 
145d6ad946cSShri Abhyankar    Level: beginner
146d6ad946cSShri Abhyankar 
14719eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
148b93fea0eSJed Brown M*/
149b93fea0eSJed Brown 
150b93fea0eSJed Brown /*MC
151d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
152d76fc68cSShri Abhyankar 
153d76fc68cSShri Abhyankar    Level: beginner
154d76fc68cSShri Abhyankar 
15519eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
156d76fc68cSShri Abhyankar M*/
157d76fc68cSShri Abhyankar 
158d76fc68cSShri Abhyankar /*MC
1593118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
1603118ae5eSBarry Smith 
1613118ae5eSBarry Smith    Level: beginner
1623118ae5eSBarry Smith 
1633118ae5eSBarry Smith    Options Database:
1643118ae5eSBarry Smith .   -ts_pseudo_frtol <rtol>
1653118ae5eSBarry Smith 
16619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL
1673118ae5eSBarry Smith M*/
1683118ae5eSBarry Smith 
1693118ae5eSBarry Smith /*MC
1703118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
1713118ae5eSBarry Smith 
1723118ae5eSBarry Smith    Level: beginner
1733118ae5eSBarry Smith 
1743118ae5eSBarry Smith    Options Database:
1753118ae5eSBarry Smith .   -ts_pseudo_fatol <atol>
1763118ae5eSBarry Smith 
17719eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL
1783118ae5eSBarry Smith M*/
1793118ae5eSBarry Smith 
1803118ae5eSBarry Smith /*MC
181b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
182b93fea0eSJed Brown 
183b93fea0eSJed Brown    Level: beginner
184b93fea0eSJed Brown 
18595452b02SPatrick Sanan    Notes:
18695452b02SPatrick Sanan     See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
1871957e957SBarry Smith 
1881957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
189b93fea0eSJed Brown M*/
190b93fea0eSJed Brown 
191b93fea0eSJed Brown /*MC
192b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
193b93fea0eSJed Brown 
194b93fea0eSJed Brown    Level: beginner
195b93fea0eSJed Brown 
19695452b02SPatrick Sanan    Notes:
19795452b02SPatrick Sanan     See TSSetMaxStepRejections() for how to allow more step rejections.
1981957e957SBarry Smith 
1991957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
200b93fea0eSJed Brown M*/
201b93fea0eSJed Brown 
202d6ad946cSShri Abhyankar /*E
203d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
204d6ad946cSShri Abhyankar 
205d6ad946cSShri Abhyankar    Level: beginner
206d6ad946cSShri Abhyankar 
20795452b02SPatrick Sanan    Developer Notes:
20895452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
209d6ad946cSShri Abhyankar 
210d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
211d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
212d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
213feed9e9dSBarry Smith 
214f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime()
2154ceb6c04SBarry Smith 
216d6ad946cSShri Abhyankar E*/
217feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
218d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
219d6ad946cSShri Abhyankar 
220000e7ae3SMatthew Knepley /* Logging support */
221014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
222d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2231b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
224000e7ae3SMatthew Knepley 
225607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
226560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2278ba1e511SMatthew Knepley 
228014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
229baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
230014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
231818ad0c1SBarry Smith 
232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
233014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
235014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
236721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
237014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
238818ad0c1SBarry Smith 
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
245818ad0c1SBarry Smith 
246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
247014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
248818ad0c1SBarry Smith 
249efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
250efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
25157df6a1bSDebojyoti Ghosh 
252642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
253642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
2540a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
25557df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);
2566e2e232bSDebojyoti Ghosh 
257a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(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);
261a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
262c9ad9de0SHong Zhang PETSC_EXTERN 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*);
268b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction1(TS,PetscReal,Vec,Vec*,Vec,Vec*);
269b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction2(TS,PetscReal,Vec,Vec*,Vec,Vec*);
270b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction3(TS,PetscReal,Vec,Vec*,Vec,Vec*);
271b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction4(TS,PetscReal,Vec,Vec*,Vec,Vec*);
272*13af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
273*13af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
274*13af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
275*13af1a74SHong Zhang                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
276*13af1a74SHong Zhang                                                     void*);
277*13af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction1(TS,PetscReal,Vec,Vec*,Vec,Vec*);
278*13af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction2(TS,PetscReal,Vec,Vec*,Vec,Vec*);
279*13af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction3(TS,PetscReal,Vec,Vec*,Vec,Vec*);
280*13af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction4(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*);
283b5b4017aSHong Zhang 
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 
2903c0fce88SHong Zhang   Concepts: ODE solvers, trajectory
291bc952696SBarry Smith 
2921550c9b9SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset()
293bc952696SBarry Smith S*/
294bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory;
295bc952696SBarry Smith 
296bc952696SBarry Smith /*J
2973c0fce88SHong Zhang     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method
298bc952696SBarry Smith 
299bc952696SBarry Smith    Level: intermediate
300bc952696SBarry Smith 
3013c0fce88SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy()
302bc952696SBarry Smith J*/
303bc952696SBarry Smith typedef const char* TSTrajectoryType;
304bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
3051c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
3069a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
3072b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
308bc952696SBarry Smith 
309bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
310bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
311bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
312bc952696SBarry Smith 
313bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
3142d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS);
315bc952696SBarry Smith 
316bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
3179a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
318bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
319560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
320fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType);
321bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
322c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
323fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec);
324fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*);
325fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*);
326fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*);
327972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
328560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
329bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
33068bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
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**);
3433d1d12c6SHong Zhang PETSC_EXTERN 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);
346d4aa0a58SBarry Smith 
347a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
348a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
349a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
350a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
351a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
352a05bf03eSHong Zhang 
35309830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSSetRHSJacobianP")     PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
35409830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
35509830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSComputeDRDPFunction") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
35609830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSComputeDRDUFunction") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
3572c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
35873b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
359d4aa0a58SBarry Smith 
36073b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
361f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
362ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS);
363999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
364b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointInitializeForward(TS,Mat);
365715f1b00SHong Zhang 
36613b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
36713b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
36813b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
36913b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
370715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*);
371715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*);
372715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
3737adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS);
374999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
375715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
376b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat);
3776affb6f8SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat**);
378c235aa8dSHong Zhang 
379618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
380618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
381618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
382618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
38349354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
384f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);
385818ad0c1SBarry Smith 
386aaa6c58dSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetTime[Step]")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
38719eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetMax{Steps|Time}") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
38819eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetMax{Steps|Time}") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
3895c5f5948SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
3904f4e0956SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
39119eac22cSLisandro Dalcin 
392721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
393cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
39483a4ac43SBarry Smith 
39583a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
39683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
39783a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
39883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
3992d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
40083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
4010ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);
40283a4ac43SBarry Smith 
403721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
4049110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
4059110b2e7SHong Zhang 
406721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
407014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
408014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
409fb1732b5SBarry Smith 
410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
4117cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
412014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
413cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
414e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
415e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
416014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
417d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
418487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
4195ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
4205ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
421cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
422cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
423cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
424cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
425cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
426dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
42724655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
428d2daff3dSHong Zhang 
429ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);
430818ad0c1SBarry Smith 
431014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
432014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
433e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
43480275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
43580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
43680275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
43780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);
438818ad0c1SBarry Smith 
439638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
440d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
441014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
442014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
443014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
444014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
445e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
446818ad0c1SBarry Smith 
447ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
448ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
449d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
450d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
451ef20d060SBarry Smith 
452638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
453d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
454014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
455014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
456014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
457014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
458316643e7SJed Brown 
459efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
460efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
461efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
462efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
463efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
464efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
465efe9872eSLisandro Dalcin 
466545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
467545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
468545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
4691d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
4701d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
4710fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
4720fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*);
473d9194312SHong Zhang 
474014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
475d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
476014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
477d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
4781c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
4799b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
480847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
481e34be4c2SBarry Smith 
482014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
483b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
4849be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
485c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
486014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
487014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
488b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
4899be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
490c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
491014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
492014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
493014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
494c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
4957453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4967453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4977453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
4988a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4998a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5008a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
501014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
502014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
503d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
504d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
505000e7ae3SMatthew Knepley 
506014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
5078d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
508014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
509014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
510014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
5118d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
514014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
51521c89e3eSBarry Smith 
516014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
5171d6018f0SLisandro Dalcin 
518014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
519d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
521d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
522efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
523efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
524f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
525818ad0c1SBarry Smith 
526014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
527d6ebe24aSShri Abhyankar 
528967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
52924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
53024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
53124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
53224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
53324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
53424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
53524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
53624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
537efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
538efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
539efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
540efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
541efe9872eSLisandro Dalcin 
542ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
543ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
544d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
545d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
546924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
547924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
5480163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **);
5499b7cd975SBarry Smith 
550d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
551d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
552d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
5536c6b9e74SPeter Brune 
5546c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5556c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5566c6b9e74SPeter Brune 
5576c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
558d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
5596c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
560d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
5616c6b9e74SPeter Brune 
5626c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
563d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
5646c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
565d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
5666c6b9e74SPeter Brune 
567b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
568560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*);
5696dbbd306SMatthew G. Knepley 
570be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
571d1212d36SBarry Smith typedef struct {
572d1212d36SBarry Smith   Vec            ray;
573d1212d36SBarry Smith   VecScatter     scatter;
574d1212d36SBarry Smith   PetscViewer    viewer;
57551b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
576d1212d36SBarry Smith } TSMonitorDMDARayCtx;
577d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
578d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
57951b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
580d1212d36SBarry Smith 
581bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
582140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
58319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
58419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
585bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
58630de9b25SBarry Smith 
587014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
588deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
589014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
590818ad0c1SBarry Smith 
591014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
59255849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
593685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
59439c6b90dSHong Zhang PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
59555849f57SBarry Smith 
59655849f57SBarry Smith #define TS_FILE_CLASSID 1211225
59721c89e3eSBarry Smith 
598014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
599014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
60021c89e3eSBarry Smith 
601a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
602a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
6034f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
6044f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
60531152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
606b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
607e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
608a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
609a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
6107684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
6117684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
6124f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
613201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
614201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
615edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
616ef20d060SBarry Smith 
617b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
618b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
619b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
620b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
621b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
622b3d3934dSBarry Smith 
6238189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
6248189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
6258189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
6268189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
6273914022bSBarry Smith 
6281b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx;
6291b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*);
6301b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*);
6310ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*);
6321b575b74SJoseph Pusztay 
6332589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
6340e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal);
6356427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
63676bdecfbSBarry Smith /*J
637815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
638815f1ad5SJed Brown 
639815f1ad5SJed Brown    Level: beginner
640815f1ad5SJed Brown 
641815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
64276bdecfbSBarry Smith J*/
64319fd82e9SBarry Smith typedef const char* TSSSPType;
644815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
645815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
646815f1ad5SJed Brown #define TSSSPRK104 "rk104"
647815f1ad5SJed Brown 
64819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
64919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
650014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
651014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
652787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
653560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
654013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
655815f1ad5SJed Brown 
656ed657a08SJed Brown /*S
65784df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
65884df9cb4SJed Brown 
65984df9cb4SJed Brown    Level: beginner
66084df9cb4SJed Brown 
66184df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType
66284df9cb4SJed Brown S*/
66384df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
66484df9cb4SJed Brown 
66584df9cb4SJed Brown /*E
6668f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
66784df9cb4SJed Brown 
66884df9cb4SJed Brown    Level: beginner
66984df9cb4SJed Brown 
67084df9cb4SJed Brown .seealso: TSAdaptSetType(), TS
67184df9cb4SJed Brown E*/
672f8963224SJed Brown typedef const char *TSAdaptType;
673b0f836d7SJed Brown #define TSADAPTNONE    "none"
6741917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
675cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
6768d59e960SJed Brown #define TSADAPTCFL     "cfl"
6771917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
678d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
67984df9cb4SJed Brown 
680552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
681bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
682607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
683014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
684014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
68519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
686d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
687014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
688014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
689014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
690014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
691014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
692b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
693014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
694ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
6954416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
696099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
697014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
698014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
699bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
7001917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
7011917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
7021917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
7031917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
704014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
7051917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
706b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
707d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
70875017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool);
70975017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*);
710de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt);
711cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
712cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);
71384df9cb4SJed Brown 
71484df9cb4SJed Brown /*S
71526d28e4eSEmil Constantinescu    TSGLLEAdapt - Abstract object that manages time-step adaptivity
716ed657a08SJed Brown 
717ed657a08SJed Brown    Level: beginner
718ed657a08SJed Brown 
71984df9cb4SJed Brown    Developer Notes:
72084df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
72184df9cb4SJed Brown 
72226d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
723ed657a08SJed Brown S*/
72426d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
725ed657a08SJed Brown 
72676bdecfbSBarry Smith /*J
72726d28e4eSEmil Constantinescu     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
728ed657a08SJed Brown 
729ed657a08SJed Brown    Level: beginner
730ed657a08SJed Brown 
73126d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS
73276bdecfbSBarry Smith J*/
73326d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
73426d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
73526d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
73626d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
737ed657a08SJed Brown 
73826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
73926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
74026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
74126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
74226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
74326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
74426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
74526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
74626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
74726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
748ed657a08SJed Brown 
74976bdecfbSBarry Smith /*J
75026d28e4eSEmil Constantinescu     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
751ed657a08SJed Brown 
752ed657a08SJed Brown    Level: beginner
753ed657a08SJed Brown 
75426d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS
75576bdecfbSBarry Smith J*/
75626d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
75726d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
758ed657a08SJed Brown 
75926d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
76026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
761ed657a08SJed Brown 
76276bdecfbSBarry Smith /*J
76326d28e4eSEmil Constantinescu   TSGLLEType - family of time integration method within the General Linear class
76418b56cb9SJed Brown 
76518b56cb9SJed Brown   Level: beginner
76618b56cb9SJed Brown 
76726d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister()
76876bdecfbSBarry Smith J*/
76926d28e4eSEmil Constantinescu typedef const char* TSGLLEType;
77026d28e4eSEmil Constantinescu #define TSGLLE_IRKS   "irks"
77118b56cb9SJed Brown 
77226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
77326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
77426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
77526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
77626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
77726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
77818b56cb9SJed Brown 
779020d8f30SJed Brown /*J
7807d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
7817d5697caSHong Zhang 
7827d5697caSHong Zhang    Level: beginner
7837d5697caSHong Zhang 
7847d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
7857d5697caSHong Zhang J*/
7867d5697caSHong Zhang #define TSEIMEXType   char*
7877d5697caSHong Zhang 
7887d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
7897d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
7907d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
7917d5697caSHong Zhang 
7927d5697caSHong Zhang /*J
793f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
794f68a32c8SEmil Constantinescu 
795f68a32c8SEmil Constantinescu    Level: beginner
796f68a32c8SEmil Constantinescu 
797f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
798f68a32c8SEmil Constantinescu J*/
799f68a32c8SEmil Constantinescu typedef const char* TSRKType;
800f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
801fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
802f68a32c8SEmil Constantinescu #define TSRK3     "3"
803fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
804f68a32c8SEmil Constantinescu #define TSRK4     "4"
805fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
806fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
80705e23783SLisandro Dalcin #define TSRK5BS   "5bs"
80805e23783SLisandro Dalcin 
809f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
810f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
8110fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool);
8120fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*);
813f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
814f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
815f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
816560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
817f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
818f68a32c8SEmil Constantinescu 
819f68a32c8SEmil Constantinescu /*J
8204b84eec9SHong Zhang    TSMPRKType - String with the name of a Partitioned Runge-Kutta method
8219f537349Sluzhanghpp 
8229f537349Sluzhanghpp    Level: beginner
8239f537349Sluzhanghpp 
8244b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister()
8259f537349Sluzhanghpp J*/
8264b84eec9SHong Zhang typedef const char* TSMPRKType;
82719c2959aSHong Zhang #define TSMPRK2A22   "2a22"
82819c2959aSHong Zhang #define TSMPRK2A23   "2a23"
82919c2959aSHong Zhang #define TSMPRK2A32   "2a32"
83019c2959aSHong Zhang #define TSMPRK2A33   "2a33"
8314b84eec9SHong Zhang #define TSMPRKP2    "p2"
8324b84eec9SHong Zhang #define TSMPRKP3    "p3"
8339f537349Sluzhanghpp 
8344b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*);
8354b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType);
83679bc8a77SHong 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[]);
8374b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
8384b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
8394b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);
8409f537349Sluzhanghpp 
8419f537349Sluzhanghpp /*J
842b6a60446SDebojyoti Ghosh     TSGLEEType - String with the name of a General Linear with Error Estimation method.
843b6a60446SDebojyoti Ghosh 
844b6a60446SDebojyoti Ghosh    Level: beginner
845b6a60446SDebojyoti Ghosh 
846b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
847b6a60446SDebojyoti Ghosh J*/
848b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType;
849ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
850b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
851b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
852b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
853b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
854b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
855b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
856b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
857b6a60446SDebojyoti Ghosh /*J
858b6a60446SDebojyoti Ghosh     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
859b6a60446SDebojyoti Ghosh 
860b6a60446SDebojyoti Ghosh    Level: beginner
861b6a60446SDebojyoti Ghosh 
862b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
863b6a60446SDebojyoti Ghosh J*/
864b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
865b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
86657df6a1bSDebojyoti 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[]);
867b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
868b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
869b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
870b6a60446SDebojyoti Ghosh 
871b6a60446SDebojyoti Ghosh /*J
872020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
873020d8f30SJed Brown 
874020d8f30SJed Brown    Level: beginner
875020d8f30SJed Brown 
876020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
877020d8f30SJed Brown J*/
87819fd82e9SBarry Smith typedef const char* TSARKIMEXType;
879e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
8801f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
8811f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
8821f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
8831f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
8848a381b04SJed Brown #define TSARKIMEX2D     "2d"
885a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
8866cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
8878a381b04SJed Brown #define TSARKIMEX3      "3"
8886cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
8896cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
8908a381b04SJed Brown #define TSARKIMEX4      "4"
8918a381b04SJed Brown #define TSARKIMEX5      "5"
89219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
89319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
894014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
89519fd82e9SBarry 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[]);
896607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
897560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
898014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
8998a381b04SJed Brown 
900020d8f30SJed Brown /*J
901020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
902020d8f30SJed Brown 
903020d8f30SJed Brown    Level: beginner
904020d8f30SJed Brown 
905020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
906020d8f30SJed Brown J*/
90719fd82e9SBarry Smith typedef const char* TSRosWType;
90861692a83SJed Brown #define TSROSW2M          "2m"
90961692a83SJed Brown #define TSROSW2P          "2p"
910fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
911fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
912ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
913ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
914961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
915961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
91643b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
917753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
9183606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
9193606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
92042faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
92142faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
92242faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
92342faf41dSJed Brown #define TSROSW4L          "4l"
924b1c69cc3SEmil Constantinescu 
9256bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
9266bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
927014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
92819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
92919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
930607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
931560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
932014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
933e27a552bSJed Brown 
934211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
935211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
936211a84d6SLisandro Dalcin 
9376bd7aeb5SHong Zhang /*J
938e49d4f37SHong Zhang   TSBasicSymplecticType - String with the name of a basic symplectic integration method.
9396bd7aeb5SHong Zhang 
9406bd7aeb5SHong Zhang   Level: beginner
9416bd7aeb5SHong Zhang 
942e49d4f37SHong Zhang   .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister()
9436bd7aeb5SHong Zhang J*/
944e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType;
945e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
946e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
947e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
948e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
949e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
950e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
951e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
952e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
953e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
954e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
9556bd7aeb5SHong Zhang 
95683e2fdc7SBarry Smith /*
9570f3b3ca1SHong Zhang        PETSc interface to Sundials
95883e2fdc7SBarry Smith */
9596dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS
9606fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
9616a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
9626fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
9636a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
964014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
965014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
966014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
967014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
968014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
969014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
970014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
971014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
972014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
973014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
974014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
975014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
9766dc17ff5SMatthew Knepley #endif
97783e2fdc7SBarry Smith 
978014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
979014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
980014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
981014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
9820de4c49aSJed Brown 
983014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
984014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
985014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
98688df8a41SLisandro Dalcin 
987818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
988818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
989818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
990818efac9SLisandro Dalcin 
991014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
992014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
9936c699258SBarry Smith 
994014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
995d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
9960f5c6efeSJed Brown 
997f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
998f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
999818ad0c1SBarry Smith #endif
1000