xref: /petsc/include/petscts.h (revision cc4f23bcf64df33b59f5bbb708ade68497d25378)
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"
4840be0ff1SMatthew G. Knepley #define TSDISCGRAD        "discgrad"
4940be0ff1SMatthew G. Knepley 
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*);
258cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS,Mat*,PetscErrorCode(**)(TS,PetscReal,Vec,Mat,void*),void**);
259a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat);
26033f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal,Mat,void*),void*);
26133f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS,PetscReal,Vec,Vec,PetscReal,Mat,PetscBool);
26225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
26325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSComputeDRDUFunction(TS,PetscReal,Vec,Vec*);
264b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS,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                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
268b5b4017aSHong Zhang                                                     void*);
269b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
270b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
271b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
272b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
27313af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,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                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27713af1a74SHong Zhang                                                     void*);
278b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
279b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
280b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
281b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
282b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS,PetscInt,Vec*,Vec*,Vec);
283b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS,PetscInt*,Vec**,Vec**,Vec*);
284ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS,Vec,Mat,Mat);
285a05bf03eSHong Zhang 
286bc952696SBarry Smith /*S
287e91eccc2SStefano Zampini      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)
288bc952696SBarry Smith 
289bc952696SBarry Smith    Level: advanced
290bc952696SBarry Smith 
2911550c9b9SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset()
292bc952696SBarry Smith S*/
293bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory;
294bc952696SBarry Smith 
295bc952696SBarry Smith /*J
2963c0fce88SHong Zhang     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method
297bc952696SBarry Smith 
298bc952696SBarry Smith    Level: intermediate
299bc952696SBarry Smith 
3003c0fce88SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy()
301bc952696SBarry Smith J*/
302bc952696SBarry Smith typedef const char* TSTrajectoryType;
303bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
3041c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
3059a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
3062b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
307bc952696SBarry Smith 
308bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
309bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
310bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
311bc952696SBarry Smith 
312bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
3132d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS);
314bc952696SBarry Smith 
315bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
3169a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
317bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
318560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
319fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType);
320881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(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);
3319ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory,PetscBool);
3322bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
33378fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
33408347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
335fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool);
336fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*);
33764fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool);
33864e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]);
33964e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]);
34078fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);
341bc952696SBarry Smith 
342dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
343dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
34425ef9dfeSBarry 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*);
345dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
346022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);
347cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS,PetscBool,TS*);
348cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS,PetscBool*,TS*);
349d4aa0a58SBarry Smith 
350a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
351a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
352a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
353a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
354a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
355a05bf03eSHong Zhang 
35625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetRHSJacobianP()")     PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
35725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSComputeRHSJacobianP()") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
35825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
35925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
3602c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
36173b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
362d4aa0a58SBarry Smith 
36373b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
364f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
365ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS);
366999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
367ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS,Mat);
368ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS);
369715f1b00SHong Zhang 
37013b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
37113b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
37225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() and TSForwardSetSensitivities() (since version 3.12)") PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
37325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSForwardGetSensitivities()")                          PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
374715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
3757adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS);
376999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
377715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
378b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat);
379*cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat*[]);
380c235aa8dSHong Zhang 
381618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
382618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
383618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
384618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
38549354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
386f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);
387818ad0c1SBarry Smith 
38825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetTime[Step]() (since version 3.8)")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
38925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
39025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
39125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
39225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
39319eac22cSLisandro Dalcin 
394721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
395cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
39683a4ac43SBarry Smith 
39783a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
39883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
39983a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
40083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
4012d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
40283a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
4030ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);
40483a4ac43SBarry Smith 
405721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
4069110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
4079110b2e7SHong Zhang 
408721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
409014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
411fb1732b5SBarry Smith 
412014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
4137cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
414014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
415cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
416e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
417e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
418014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
419d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
420487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
4215ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
4225ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
423cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
424cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
425cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
426cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
427cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
428dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
42924655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
430d2daff3dSHong Zhang 
431*cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec*[]);
432818ad0c1SBarry Smith 
433014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
434014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
435e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
43680275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
43780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
43880275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
43980275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);
440818ad0c1SBarry Smith 
441638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
442d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
443cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS,PetscReal,Vec,Mat,void*);
444014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
445014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
446014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
447014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
448e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
449818ad0c1SBarry Smith 
450ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
451ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
452d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
453d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
454ef20d060SBarry Smith 
455638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
456d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
457014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
460014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
461316643e7SJed Brown 
462efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
463efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
464efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
465efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
466efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
467efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
468efe9872eSLisandro Dalcin 
469545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
470545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
471545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
4721d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
4731d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
4740fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
4750fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*);
476d9194312SHong Zhang 
477014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
478d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
479014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
480d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
4811c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
4829b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
483847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
484e34be4c2SBarry Smith 
485014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
486b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
4879be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
488c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
489014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
490014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
491b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
4929be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
493c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
494014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
495014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
496014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
497c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
4987453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4997453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5007453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
5018a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5028a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5038a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
504014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
505014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
506d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
507d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
508000e7ae3SMatthew Knepley 
509014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
5108d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
511014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
5148d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
515014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
516014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
517014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
51821c89e3eSBarry Smith 
519014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
5201d6018f0SLisandro Dalcin 
521014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
522d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
523014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
524d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
525efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
526efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
527f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
528818ad0c1SBarry Smith 
529014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
530d6ebe24aSShri Abhyankar 
531967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
53224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
53324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
53424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
53524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
53624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
53724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
53824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
53924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
540efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
541efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
542efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
543efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
544efe9872eSLisandro Dalcin 
545e3c11fc1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSTransientVariable)(TS,Vec,Vec,void*);
546438f35afSJed Brown PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS,TSTransientVariable,void*);
547e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM,TSTransientVariable,void*);
548e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM,TSTransientVariable*,void*);
549e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS,Vec,Vec);
550e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS,PetscBool*);
551e3c11fc1SJed Brown 
552ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
553ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
554d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
555d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
556e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckResidual(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscReal *);
557e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckJacobian(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscBool *, PetscReal *);
5587f96f943SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec);
5599b7cd975SBarry Smith 
560d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
561d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
562d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
5636c6b9e74SPeter Brune 
5646c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5656c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5666c6b9e74SPeter Brune 
5676c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
568d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
5696c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
570d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
5716c6b9e74SPeter Brune 
5726c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
573d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
5746c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
575d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
5766c6b9e74SPeter Brune 
577b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
5786dbbd306SMatthew G. Knepley 
579be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
580d1212d36SBarry Smith typedef struct {
581d1212d36SBarry Smith   Vec            ray;
582d1212d36SBarry Smith   VecScatter     scatter;
583d1212d36SBarry Smith   PetscViewer    viewer;
58451b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
585d1212d36SBarry Smith } TSMonitorDMDARayCtx;
586d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
587d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
58851b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
589d1212d36SBarry Smith 
590bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
591140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
59219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
59319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
594bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
59530de9b25SBarry Smith 
596014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
597deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
598014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
599818ad0c1SBarry Smith 
600014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
60155849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
602fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS,PetscObject,const char[]);
603fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory,PetscObject,const char[]);
60455849f57SBarry Smith 
60555849f57SBarry Smith #define TS_FILE_CLASSID 1211225
60621c89e3eSBarry Smith 
607014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
608014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
60921c89e3eSBarry Smith 
610a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
611a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
6124f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
6134f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
61431152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
615b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
616e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
617a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
618a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
6197684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
6207684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
6214f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
622201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
623201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
624edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
625d0c080abSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSDMSwarmMonitorMoments(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
626ef20d060SBarry Smith 
627e669de00SBarry Smith struct _n_TSMonitorLGCtxNetwork {
628e669de00SBarry Smith   PetscInt       nlg;
629e669de00SBarry Smith   PetscDrawLG    *lg;
630e669de00SBarry Smith   PetscBool      semilogy;
631e669de00SBarry Smith   PetscInt       howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
632e669de00SBarry Smith };
633e669de00SBarry Smith typedef struct _n_TSMonitorLGCtxNetwork*  TSMonitorLGCtxNetwork;
634e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkDestroy(TSMonitorLGCtxNetwork*);
635e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkCreate(TS,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtxNetwork*);
636e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkSolution(TS,PetscInt,PetscReal,Vec,void*);
637e669de00SBarry Smith 
638b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
639b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
640b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
641b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
642b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
643b3d3934dSBarry Smith 
6448189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
6458189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
6468189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
6478189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
6483914022bSBarry Smith 
6491b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx;
6501b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*);
6511b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*);
6520ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*);
6531b575b74SJoseph Pusztay 
6542589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
6550e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal);
6566427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
6571ea83e56SMiguel PETSC_EXTERN PetscErrorCode TSGetNumEvents(TS,PetscInt*);
6581ea83e56SMiguel 
65976bdecfbSBarry Smith /*J
660815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
661815f1ad5SJed Brown 
662815f1ad5SJed Brown    Level: beginner
663815f1ad5SJed Brown 
664815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
66576bdecfbSBarry Smith J*/
66619fd82e9SBarry Smith typedef const char* TSSSPType;
667815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
668815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
669815f1ad5SJed Brown #define TSSSPRK104 "rk104"
670815f1ad5SJed Brown 
67119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
67219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
673014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
674014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
675787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
676560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
677013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
678815f1ad5SJed Brown 
679ed657a08SJed Brown /*S
68084df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
68184df9cb4SJed Brown 
68284df9cb4SJed Brown    Level: beginner
68384df9cb4SJed Brown 
68484df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType
68584df9cb4SJed Brown S*/
68684df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
68784df9cb4SJed Brown 
688f0fc11ceSJed Brown /*J
6898f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
69084df9cb4SJed Brown 
69184df9cb4SJed Brown    Level: beginner
69284df9cb4SJed Brown 
69384df9cb4SJed Brown .seealso: TSAdaptSetType(), TS
694f0fc11ceSJed Brown J*/
695f8963224SJed Brown typedef const char *TSAdaptType;
696b0f836d7SJed Brown #define TSADAPTNONE    "none"
6971917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
698cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
6998d59e960SJed Brown #define TSADAPTCFL     "cfl"
7001917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
701d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
70284df9cb4SJed Brown 
703552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
704bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
705607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
706014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
707014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
70819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
709d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
710014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
711014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
712014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
713014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
714014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
715b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
716014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
717ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
7184416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
719099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
720014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
721014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
722bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
7231917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
7241917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
72576cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt,PetscReal);
72676cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt,PetscReal*);
7271917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
7281917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
72962c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt,PetscReal);
73062c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt,PetscReal*);
731014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
7321917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
733b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
734d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
73575017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool);
73675017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*);
737de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt);
738cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
739cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);
74084df9cb4SJed Brown 
74184df9cb4SJed Brown /*S
74226d28e4eSEmil Constantinescu    TSGLLEAdapt - Abstract object that manages time-step adaptivity
743ed657a08SJed Brown 
744ed657a08SJed Brown    Level: beginner
745ed657a08SJed Brown 
74684df9cb4SJed Brown    Developer Notes:
74784df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
74884df9cb4SJed Brown 
74926d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
750ed657a08SJed Brown S*/
75126d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
752ed657a08SJed Brown 
75376bdecfbSBarry Smith /*J
75426d28e4eSEmil Constantinescu     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
755ed657a08SJed Brown 
756ed657a08SJed Brown    Level: beginner
757ed657a08SJed Brown 
75826d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS
75976bdecfbSBarry Smith J*/
76026d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
76126d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
76226d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
76326d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
764ed657a08SJed Brown 
76526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
76626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
76726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
76826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
76926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
77026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
77126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
77226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
77326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
77426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
775ed657a08SJed Brown 
77676bdecfbSBarry Smith /*J
77726d28e4eSEmil Constantinescu     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
778ed657a08SJed Brown 
779ed657a08SJed Brown    Level: beginner
780ed657a08SJed Brown 
78126d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS
78276bdecfbSBarry Smith J*/
78326d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
78426d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
785ed657a08SJed Brown 
78626d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
78726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
788ed657a08SJed Brown 
78976bdecfbSBarry Smith /*J
79026d28e4eSEmil Constantinescu   TSGLLEType - family of time integration method within the General Linear class
79118b56cb9SJed Brown 
79218b56cb9SJed Brown   Level: beginner
79318b56cb9SJed Brown 
79426d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister()
79576bdecfbSBarry Smith J*/
79626d28e4eSEmil Constantinescu typedef const char* TSGLLEType;
79726d28e4eSEmil Constantinescu #define TSGLLE_IRKS   "irks"
79818b56cb9SJed Brown 
79926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
80026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
80126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
80226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
80326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
80426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
80518b56cb9SJed Brown 
806020d8f30SJed Brown /*J
8077d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
8087d5697caSHong Zhang 
8097d5697caSHong Zhang    Level: beginner
8107d5697caSHong Zhang 
8117d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
8127d5697caSHong Zhang J*/
8137d5697caSHong Zhang #define TSEIMEXType   char*
8147d5697caSHong Zhang 
8157d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
8167d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
8177d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
8187d5697caSHong Zhang 
8197d5697caSHong Zhang /*J
820f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
821f68a32c8SEmil Constantinescu 
822f68a32c8SEmil Constantinescu    Level: beginner
823f68a32c8SEmil Constantinescu 
824f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
825f68a32c8SEmil Constantinescu J*/
826f68a32c8SEmil Constantinescu typedef const char* TSRKType;
827f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
828fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
829f68a32c8SEmil Constantinescu #define TSRK3     "3"
830fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
831f68a32c8SEmil Constantinescu #define TSRK4     "4"
832fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
833fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
83405e23783SLisandro Dalcin #define TSRK5BS   "5bs"
83537acaa02SHendrik Ranocha #define TSRK6VR   "6vr"
83637acaa02SHendrik Ranocha #define TSRK7VR   "7vr"
83737acaa02SHendrik Ranocha #define TSRK8VR   "8vr"
83805e23783SLisandro Dalcin 
8392ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS,PetscInt*);
8400f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS,TSRKType*);
8410f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS,TSRKType);
8420f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS,PetscInt*,const PetscReal**,const PetscReal**,const PetscReal**,const PetscReal**,PetscInt*,const PetscReal**,PetscBool*);
8430fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool);
8440fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*);
845f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
846f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
847560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
848f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
849f68a32c8SEmil Constantinescu 
850f68a32c8SEmil Constantinescu /*J
8514b84eec9SHong Zhang    TSMPRKType - String with the name of a Partitioned Runge-Kutta method
8529f537349Sluzhanghpp 
8539f537349Sluzhanghpp    Level: beginner
8549f537349Sluzhanghpp 
8554b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister()
8569f537349Sluzhanghpp J*/
8574b84eec9SHong Zhang typedef const char* TSMPRKType;
85819c2959aSHong Zhang #define TSMPRK2A22  "2a22"
85919c2959aSHong Zhang #define TSMPRK2A23  "2a23"
86019c2959aSHong Zhang #define TSMPRK2A32  "2a32"
86119c2959aSHong Zhang #define TSMPRK2A33  "2a33"
8624b84eec9SHong Zhang #define TSMPRKP2    "p2"
8634b84eec9SHong Zhang #define TSMPRKP3    "p3"
8649f537349Sluzhanghpp 
8654b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*);
8664b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType);
86779bc8a77SHong 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[]);
8684b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
8694b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
8704b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);
8719f537349Sluzhanghpp 
8729f537349Sluzhanghpp /*J
873b6a60446SDebojyoti Ghosh     TSGLEEType - String with the name of a General Linear with Error Estimation method.
874b6a60446SDebojyoti Ghosh 
875b6a60446SDebojyoti Ghosh    Level: beginner
876b6a60446SDebojyoti Ghosh 
877b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
878b6a60446SDebojyoti Ghosh J*/
879b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType;
880ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
881b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
882b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
883b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
884b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
885b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
886b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
887b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
888b6a60446SDebojyoti Ghosh /*J
889b6a60446SDebojyoti Ghosh     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
890b6a60446SDebojyoti Ghosh 
891b6a60446SDebojyoti Ghosh    Level: beginner
892b6a60446SDebojyoti Ghosh 
893b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
894b6a60446SDebojyoti Ghosh J*/
895b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
896b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
89757df6a1bSDebojyoti 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[]);
898b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
899b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
900b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
901b6a60446SDebojyoti Ghosh 
902b6a60446SDebojyoti Ghosh /*J
903020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
904020d8f30SJed Brown 
905020d8f30SJed Brown    Level: beginner
906020d8f30SJed Brown 
907020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
908020d8f30SJed Brown J*/
90919fd82e9SBarry Smith typedef const char* TSARKIMEXType;
910e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
9111f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
9121f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
9131f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
9141f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
9158a381b04SJed Brown #define TSARKIMEX2D     "2d"
916a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
9176cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
9188a381b04SJed Brown #define TSARKIMEX3      "3"
9196cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
9206cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
9218a381b04SJed Brown #define TSARKIMEX4      "4"
9228a381b04SJed Brown #define TSARKIMEX5      "5"
92319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
92419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
925014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
9263a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS,PetscBool*);
92719fd82e9SBarry 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[]);
928607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
929560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
930014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
9318a381b04SJed Brown 
932020d8f30SJed Brown /*J
933020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
934020d8f30SJed Brown 
935020d8f30SJed Brown    Level: beginner
936020d8f30SJed Brown 
937020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
938020d8f30SJed Brown J*/
93919fd82e9SBarry Smith typedef const char* TSRosWType;
94061692a83SJed Brown #define TSROSW2M          "2m"
94161692a83SJed Brown #define TSROSW2P          "2p"
942fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
943fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
944ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
945ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
946961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
947961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
94843b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
949753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
9503606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
9513606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
95242faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
95342faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
95442faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
95542faf41dSJed Brown #define TSROSW4L          "4l"
956b1c69cc3SEmil Constantinescu 
9576bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
9586bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
959014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
96019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
96119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
962607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
963560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
964014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
965e27a552bSJed Brown 
966211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
967211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
968211a84d6SLisandro Dalcin 
9696bd7aeb5SHong Zhang /*J
970e49d4f37SHong Zhang   TSBasicSymplecticType - String with the name of a basic symplectic integration method.
9716bd7aeb5SHong Zhang 
9726bd7aeb5SHong Zhang   Level: beginner
9736bd7aeb5SHong Zhang 
974e49d4f37SHong Zhang   .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister()
9756bd7aeb5SHong Zhang J*/
976e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType;
977e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
978e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
979e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
980e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
981e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
982e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
983e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
984e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
985e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
986e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
9876bd7aeb5SHong Zhang 
98840be0ff1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSDiscGradSetFormulation(TS, PetscErrorCode(*)(TS, PetscReal, Vec, Mat, void *), PetscErrorCode(*)(TS, PetscReal, Vec, PetscScalar *, void *), PetscErrorCode(*)(TS, PetscReal, Vec, Vec, void *), void *);
98940be0ff1SMatthew G. Knepley 
99083e2fdc7SBarry Smith /*
9910f3b3ca1SHong Zhang        PETSc interface to Sundials
99283e2fdc7SBarry Smith */
993e808b789SPatrick Sanan #ifdef PETSC_HAVE_SUNDIALS2
9946fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
9956a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
9966fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
9976a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
998014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
999014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
1000014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
1001014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
1002014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
1003014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
1004014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
1005014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
1006014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
1007014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool);
1008014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
1009014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
1010c4e80e11SFlorian PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS,PetscInt);
10116dc17ff5SMatthew Knepley #endif
101283e2fdc7SBarry Smith 
1013014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
1014014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
1015014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
1016014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
10170de4c49aSJed Brown 
1018014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
1019014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
1020014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
102188df8a41SLisandro Dalcin 
1022818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
1023818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
1024818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
1025818efac9SLisandro Dalcin 
1026014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
1027014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
10286c699258SBarry Smith 
1029014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
1030d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
10310f5c6efeSJed Brown 
1032f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
1033f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
1034aad739acSMatthew G. Knepley 
10352e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec));
10362e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec));
10372e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec);
10382e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec));
1039aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec));
1040aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec);
1041f2ed2dc7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool);
1042d60b7d5cSBarry Smith 
1043d60b7d5cSBarry Smith PETSC_EXTERN PetscErrorCode TSSetMatStructure(TS,MatStructure);
1044818ad0c1SBarry Smith #endif
1045