xref: /petsc/include/petscts.h (revision b4937a871eb039ca2dcd55b5c176b375745f00b6)
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"
49d2567f34SHong Zhang #define TSIRK             "irk"
5040be0ff1SMatthew G. Knepley 
51435da068SBarry Smith /*E
52435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
53435da068SBarry Smith 
54435da068SBarry Smith    Level: beginner
55435da068SBarry Smith 
56435da068SBarry Smith .seealso: TSCreate()
57435da068SBarry Smith E*/
5819bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
59818ad0c1SBarry Smith 
60b93fea0eSJed Brown /*E
61e817cc15SEmil Constantinescu    TSEquationType - type of TS problem that is solved
62e817cc15SEmil Constantinescu 
63e817cc15SEmil Constantinescu    Level: beginner
64e817cc15SEmil Constantinescu 
6595452b02SPatrick Sanan    Developer Notes:
6695452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
67e817cc15SEmil Constantinescu 
68e817cc15SEmil Constantinescu    Supported types are:
69e817cc15SEmil Constantinescu      TS_EQ_UNSPECIFIED (default)
70e817cc15SEmil 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
71e817cc15SEmil Constantinescu      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
72e817cc15SEmil Constantinescu 
73e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType()
74e817cc15SEmil Constantinescu E*/
75e817cc15SEmil Constantinescu typedef enum {
76e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
77e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
78e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
79e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
80e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
81e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
82e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
83e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
84e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
85e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
86e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
87e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
8819436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
89e817cc15SEmil Constantinescu } TSEquationType;
90e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes;
91e817cc15SEmil Constantinescu 
92e817cc15SEmil Constantinescu /*E
93b93fea0eSJed Brown    TSConvergedReason - reason a TS method has converged or not
94b93fea0eSJed Brown 
95b93fea0eSJed Brown    Level: beginner
96b93fea0eSJed Brown 
9795452b02SPatrick Sanan    Developer Notes:
9895452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
99b93fea0eSJed Brown 
100b93fea0eSJed Brown    Each reason has its own manual page.
101b93fea0eSJed Brown 
102b93fea0eSJed Brown .seealso: TSGetConvergedReason()
103b93fea0eSJed Brown E*/
104193ac0bcSJed Brown typedef enum {
105193ac0bcSJed Brown   TS_CONVERGED_ITERATING          = 0,
106193ac0bcSJed Brown   TS_CONVERGED_TIME               = 1,
107193ac0bcSJed Brown   TS_CONVERGED_ITS                = 2,
108d6ad946cSShri Abhyankar   TS_CONVERGED_USER               = 3,
1092b7db910SShri Abhyankar   TS_CONVERGED_EVENT              = 4,
1103118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL       = 5,
1113118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL       = 6,
112193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE     = -1,
113b5b4017aSHong Zhang   TS_DIVERGED_STEP_REJECTED       = -2,
11405c9950eSHong Zhang   TSFORWARD_DIVERGED_LINEAR_SOLVE = -3,
11505c9950eSHong Zhang   TSADJOINT_DIVERGED_LINEAR_SOLVE = -4
116193ac0bcSJed Brown } TSConvergedReason;
117014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons;
1181957e957SBarry Smith 
119b93fea0eSJed Brown /*MC
120b93fea0eSJed Brown    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
121b93fea0eSJed Brown 
122b93fea0eSJed Brown    Level: beginner
123b93fea0eSJed Brown 
124552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
125b93fea0eSJed Brown M*/
126b93fea0eSJed Brown 
127b93fea0eSJed Brown /*MC
128b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
129b93fea0eSJed Brown 
130b93fea0eSJed Brown    Level: beginner
131b93fea0eSJed Brown 
13219eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime()
133b93fea0eSJed Brown M*/
134b93fea0eSJed Brown 
135b93fea0eSJed Brown /*MC
1361957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
137b93fea0eSJed Brown 
138b93fea0eSJed Brown    Level: beginner
139b93fea0eSJed Brown 
14019eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps()
141b93fea0eSJed Brown M*/
1421957e957SBarry Smith 
143d6ad946cSShri Abhyankar /*MC
144d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
145d6ad946cSShri Abhyankar 
146d6ad946cSShri Abhyankar    Level: beginner
147d6ad946cSShri Abhyankar 
14819eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
149b93fea0eSJed Brown M*/
150b93fea0eSJed Brown 
151b93fea0eSJed Brown /*MC
152d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
153d76fc68cSShri Abhyankar 
154d76fc68cSShri Abhyankar    Level: beginner
155d76fc68cSShri Abhyankar 
15619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
157d76fc68cSShri Abhyankar M*/
158d76fc68cSShri Abhyankar 
159d76fc68cSShri Abhyankar /*MC
1603118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
1613118ae5eSBarry Smith 
1623118ae5eSBarry Smith    Level: beginner
1633118ae5eSBarry Smith 
1643118ae5eSBarry Smith    Options Database:
1653118ae5eSBarry Smith .   -ts_pseudo_frtol <rtol>
1663118ae5eSBarry Smith 
16719eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL
1683118ae5eSBarry Smith M*/
1693118ae5eSBarry Smith 
1703118ae5eSBarry Smith /*MC
1713118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
1723118ae5eSBarry Smith 
1733118ae5eSBarry Smith    Level: beginner
1743118ae5eSBarry Smith 
1753118ae5eSBarry Smith    Options Database:
1763118ae5eSBarry Smith .   -ts_pseudo_fatol <atol>
1773118ae5eSBarry Smith 
17819eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL
1793118ae5eSBarry Smith M*/
1803118ae5eSBarry Smith 
1813118ae5eSBarry Smith /*MC
182b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
183b93fea0eSJed Brown 
184b93fea0eSJed Brown    Level: beginner
185b93fea0eSJed Brown 
18695452b02SPatrick Sanan    Notes:
18795452b02SPatrick Sanan     See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
1881957e957SBarry Smith 
1891957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
190b93fea0eSJed Brown M*/
191b93fea0eSJed Brown 
192b93fea0eSJed Brown /*MC
193b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
194b93fea0eSJed Brown 
195b93fea0eSJed Brown    Level: beginner
196b93fea0eSJed Brown 
19795452b02SPatrick Sanan    Notes:
19895452b02SPatrick Sanan     See TSSetMaxStepRejections() for how to allow more step rejections.
1991957e957SBarry Smith 
2001957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
201b93fea0eSJed Brown M*/
202b93fea0eSJed Brown 
203d6ad946cSShri Abhyankar /*E
204d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
205d6ad946cSShri Abhyankar 
206d6ad946cSShri Abhyankar    Level: beginner
207d6ad946cSShri Abhyankar 
20895452b02SPatrick Sanan    Developer Notes:
20995452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
210d6ad946cSShri Abhyankar 
211d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
212d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
213d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
214feed9e9dSBarry Smith 
215f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime()
2164ceb6c04SBarry Smith 
217d6ad946cSShri Abhyankar E*/
218feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
219d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
220d6ad946cSShri Abhyankar 
221000e7ae3SMatthew Knepley /* Logging support */
222014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
223d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2241b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
225000e7ae3SMatthew Knepley 
226607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
227560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2288ba1e511SMatthew Knepley 
229014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
230baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
231014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
232818ad0c1SBarry Smith 
233014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
235014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
237721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
239818ad0c1SBarry Smith 
240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
245014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
246818ad0c1SBarry Smith 
247014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
248014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
249818ad0c1SBarry Smith 
250efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
251efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
25257df6a1bSDebojyoti Ghosh 
253642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
254642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
2550a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
25657df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);
2576e2e232bSDebojyoti Ghosh 
258a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
259cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS,Mat*,PetscErrorCode(**)(TS,PetscReal,Vec,Mat,void*),void**);
260a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat);
26133f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal,Mat,void*),void*);
26233f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS,PetscReal,Vec,Vec,PetscReal,Mat,PetscBool);
26325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
26425ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSComputeDRDUFunction(TS,PetscReal,Vec,Vec*);
265b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS,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                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
269b5b4017aSHong Zhang                                                     void*);
270b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
271b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
272b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
273b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
27413af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,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                                                     Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*),
27813af1a74SHong Zhang                                                     void*);
279b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
280b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
281b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*);
282b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*);
283b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS,PetscInt,Vec*,Vec*,Vec);
284b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS,PetscInt*,Vec**,Vec**,Vec*);
285ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS,Vec,Mat,Mat);
286a05bf03eSHong Zhang 
287bc952696SBarry Smith /*S
288e91eccc2SStefano Zampini      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)
289bc952696SBarry Smith 
290bc952696SBarry Smith    Level: advanced
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);
321881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory,TS,TSTrajectoryType*);
322bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
323c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
324fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec);
325fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*);
326fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*);
327fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*);
328972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
329560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
330bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
33168bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
3329ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory,PetscBool);
3332bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
33478fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
33508347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
336fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool);
337fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*);
33864fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool);
33964e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]);
34064e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]);
34178fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);
342bc952696SBarry Smith 
343dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
344dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
34525ef9dfeSBarry 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*);
346dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
347022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);
348cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS,PetscBool,TS*);
349cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS,PetscBool*,TS*);
350d4aa0a58SBarry Smith 
351a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
352a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
353a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
354a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
355a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
356a05bf03eSHong Zhang 
35725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetRHSJacobianP()")     PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
35825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSComputeRHSJacobianP()") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
35925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
36025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
3612c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
36273b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
363d4aa0a58SBarry Smith 
36473b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
365f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
366ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS);
367999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
368ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS,Mat);
369ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS);
370715f1b00SHong Zhang 
37113b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
37213b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
37325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() and TSForwardSetSensitivities() (since version 3.12)") PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
37425ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSForwardGetSensitivities()")                          PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
375715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
3767adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS);
377999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
378715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
379b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat);
380cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat*[]);
381c235aa8dSHong Zhang 
382618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
383618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
384618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
385618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
38649354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
387f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);
388818ad0c1SBarry Smith 
38925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetTime[Step]() (since version 3.8)")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
39025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
39125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
39225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
39325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
39419eac22cSLisandro Dalcin 
395721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
396cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
39783a4ac43SBarry Smith 
39883a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
39983a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
40083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
40183a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
4022d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
40383a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
4040ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);
40583a4ac43SBarry Smith 
406721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
4079110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
4089110b2e7SHong Zhang 
409721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
412fb1732b5SBarry Smith 
413014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
4147cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
415014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
416cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
417e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
418e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
419014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
420d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
421487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
4225ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
4235ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
424cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
425cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
426cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
427cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
428cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
429dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
43024655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
431d2daff3dSHong Zhang 
432cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec*[]);
433818ad0c1SBarry Smith 
434014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
435014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
436e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
43780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
43880275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
43980275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
44080275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);
441818ad0c1SBarry Smith 
442638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
443d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
444cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS,PetscReal,Vec,Mat,void*);
445014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
446014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
447014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
448014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
449e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
450818ad0c1SBarry Smith 
451ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
452ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
453d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
454d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
455ef20d060SBarry Smith 
456638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
457d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
460014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
461014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
462316643e7SJed Brown 
463efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
464efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
465efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
466efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
467efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
468efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
469efe9872eSLisandro Dalcin 
470545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
471545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
472545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
4731d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
4741d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
4750fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
4760fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*);
477d9194312SHong Zhang 
478014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
479d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
480014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
481d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
4821c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
4839b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
484847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
485e34be4c2SBarry Smith 
486014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
487b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
4889be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
489c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
490014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
491014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
492b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
4939be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
494c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
495014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
496014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
497014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
498c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
4997453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5007453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5017453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
5028a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5038a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
5048a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
505014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
506014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
507d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
508d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
509000e7ae3SMatthew Knepley 
510014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
5118d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
514014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
5158d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
516014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
517014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
518014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
51921c89e3eSBarry Smith 
520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
5211d6018f0SLisandro Dalcin 
522014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
523d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
524014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
525d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
526efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
527efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
528f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
529818ad0c1SBarry Smith 
530014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
531d6ebe24aSShri Abhyankar 
532967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
53324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
53424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
53524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
53624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
53724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
53824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
53924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
54024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
541efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
542efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
543efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
544efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
545efe9872eSLisandro Dalcin 
546e3c11fc1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSTransientVariable)(TS,Vec,Vec,void*);
547438f35afSJed Brown PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS,TSTransientVariable,void*);
548e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM,TSTransientVariable,void*);
549e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM,TSTransientVariable*,void*);
550e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS,Vec,Vec);
551e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS,PetscBool*);
552e3c11fc1SJed Brown 
553ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
554ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
555d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
556d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
557e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckResidual(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscReal *);
558e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckJacobian(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscBool *, PetscReal *);
5597f96f943SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec);
5609b7cd975SBarry Smith 
561d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
562d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
563d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
564*b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrix(DM);
565*b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrixLumped(DM);
566*b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSDestroyRHSMassMatrix(DM);
5676c6b9e74SPeter Brune 
5686c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5696c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5706c6b9e74SPeter Brune 
5716c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
572d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
5736c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
574d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
5756c6b9e74SPeter Brune 
5766c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
577d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
5786c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
579d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
5806c6b9e74SPeter Brune 
581b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
5826dbbd306SMatthew G. Knepley 
583be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
584d1212d36SBarry Smith typedef struct {
585d1212d36SBarry Smith   Vec            ray;
586d1212d36SBarry Smith   VecScatter     scatter;
587d1212d36SBarry Smith   PetscViewer    viewer;
58851b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
589d1212d36SBarry Smith } TSMonitorDMDARayCtx;
590d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
591d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
59251b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
593d1212d36SBarry Smith 
594bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
595140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
59619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
59719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
598bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
59930de9b25SBarry Smith 
600014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
601deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
602014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
603818ad0c1SBarry Smith 
604014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
60555849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
606fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS,PetscObject,const char[]);
607fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory,PetscObject,const char[]);
60855849f57SBarry Smith 
60955849f57SBarry Smith #define TS_FILE_CLASSID 1211225
61021c89e3eSBarry Smith 
611014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
612014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
61321c89e3eSBarry Smith 
614a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
615a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
6164f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
6174f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
61831152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
619b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
620e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
621a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
622a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
6237684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
6247684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
6254f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
626201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
627201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
628edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
629d0c080abSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSDMSwarmMonitorMoments(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
630ef20d060SBarry Smith 
631e669de00SBarry Smith struct _n_TSMonitorLGCtxNetwork {
632e669de00SBarry Smith   PetscInt       nlg;
633e669de00SBarry Smith   PetscDrawLG    *lg;
634e669de00SBarry Smith   PetscBool      semilogy;
635e669de00SBarry Smith   PetscInt       howoften;  /* when > 0 uses step % howoften, when negative only final solution plotted */
636e669de00SBarry Smith };
637e669de00SBarry Smith typedef struct _n_TSMonitorLGCtxNetwork*  TSMonitorLGCtxNetwork;
638e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkDestroy(TSMonitorLGCtxNetwork*);
639e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkCreate(TS,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtxNetwork*);
640e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkSolution(TS,PetscInt,PetscReal,Vec,void*);
641e669de00SBarry Smith 
642b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
643b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
644b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
645b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
646b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
647b3d3934dSBarry Smith 
6488189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
6498189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
6508189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
6518189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
6523914022bSBarry Smith 
6531b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx;
654d7462660SMatthew Knepley PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,PetscInt,PetscBool,TSMonitorSPCtx*);
6551b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*);
6560ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*);
6571b575b74SJoseph Pusztay 
6582589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
6590e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal);
6606427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
6611ea83e56SMiguel PETSC_EXTERN PetscErrorCode TSGetNumEvents(TS,PetscInt*);
6621ea83e56SMiguel 
66376bdecfbSBarry Smith /*J
664815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
665815f1ad5SJed Brown 
666815f1ad5SJed Brown    Level: beginner
667815f1ad5SJed Brown 
668815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
66976bdecfbSBarry Smith J*/
67019fd82e9SBarry Smith typedef const char* TSSSPType;
671815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
672815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
673815f1ad5SJed Brown #define TSSSPRK104 "rk104"
674815f1ad5SJed Brown 
67519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
67619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
677014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
678014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
679787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
680560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
681013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
682815f1ad5SJed Brown 
683ed657a08SJed Brown /*S
68484df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
68584df9cb4SJed Brown 
68684df9cb4SJed Brown    Level: beginner
68784df9cb4SJed Brown 
68884df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType
68984df9cb4SJed Brown S*/
69084df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
69184df9cb4SJed Brown 
692f0fc11ceSJed Brown /*J
6938f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
69484df9cb4SJed Brown 
69584df9cb4SJed Brown    Level: beginner
69684df9cb4SJed Brown 
69784df9cb4SJed Brown .seealso: TSAdaptSetType(), TS
698f0fc11ceSJed Brown J*/
699f8963224SJed Brown typedef const char *TSAdaptType;
700b0f836d7SJed Brown #define TSADAPTNONE    "none"
7011917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
702cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
7038d59e960SJed Brown #define TSADAPTCFL     "cfl"
7041917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
705d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
70684df9cb4SJed Brown 
707552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
708bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
709607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
710014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
711014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
71219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
713d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
714014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
715014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
716014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
717014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
718014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
719b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
720014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
721ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
7224416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
723099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
724014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
725014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
726bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
7271917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
7281917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
72976cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt,PetscReal);
73076cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt,PetscReal*);
7311917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
7321917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
73362c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt,PetscReal);
73462c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt,PetscReal*);
735014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
7361917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
737b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
738d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
73975017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool);
74075017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*);
741de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt);
742cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
743cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);
74484df9cb4SJed Brown 
74584df9cb4SJed Brown /*S
74626d28e4eSEmil Constantinescu    TSGLLEAdapt - Abstract object that manages time-step adaptivity
747ed657a08SJed Brown 
748ed657a08SJed Brown    Level: beginner
749ed657a08SJed Brown 
75084df9cb4SJed Brown    Developer Notes:
75184df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
75284df9cb4SJed Brown 
75326d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
754ed657a08SJed Brown S*/
75526d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
756ed657a08SJed Brown 
75776bdecfbSBarry Smith /*J
75826d28e4eSEmil Constantinescu     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
759ed657a08SJed Brown 
760ed657a08SJed Brown    Level: beginner
761ed657a08SJed Brown 
76226d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS
76376bdecfbSBarry Smith J*/
76426d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
76526d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
76626d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
76726d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
768ed657a08SJed Brown 
76926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
77026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
77126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
77226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
77326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
77426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
77526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
77626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
77726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
77826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
779ed657a08SJed Brown 
78076bdecfbSBarry Smith /*J
78126d28e4eSEmil Constantinescu     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
782ed657a08SJed Brown 
783ed657a08SJed Brown    Level: beginner
784ed657a08SJed Brown 
78526d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS
78676bdecfbSBarry Smith J*/
78726d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
78826d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
789ed657a08SJed Brown 
79026d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
79126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
792ed657a08SJed Brown 
79376bdecfbSBarry Smith /*J
79426d28e4eSEmil Constantinescu   TSGLLEType - family of time integration method within the General Linear class
79518b56cb9SJed Brown 
79618b56cb9SJed Brown   Level: beginner
79718b56cb9SJed Brown 
79826d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister()
79976bdecfbSBarry Smith J*/
80026d28e4eSEmil Constantinescu typedef const char* TSGLLEType;
80126d28e4eSEmil Constantinescu #define TSGLLE_IRKS   "irks"
80218b56cb9SJed Brown 
80326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
80426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
80526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
80626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
80726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
80826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
80918b56cb9SJed Brown 
810020d8f30SJed Brown /*J
8117d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
8127d5697caSHong Zhang 
8137d5697caSHong Zhang    Level: beginner
8147d5697caSHong Zhang 
8157d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
8167d5697caSHong Zhang J*/
8177d5697caSHong Zhang #define TSEIMEXType   char*
8187d5697caSHong Zhang 
8197d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
8207d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
8217d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
8227d5697caSHong Zhang 
8237d5697caSHong Zhang /*J
824f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
825f68a32c8SEmil Constantinescu 
826f68a32c8SEmil Constantinescu    Level: beginner
827f68a32c8SEmil Constantinescu 
828f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
829f68a32c8SEmil Constantinescu J*/
830f68a32c8SEmil Constantinescu typedef const char* TSRKType;
831f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
832fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
833f68a32c8SEmil Constantinescu #define TSRK3     "3"
834fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
835f68a32c8SEmil Constantinescu #define TSRK4     "4"
836fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
837fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
83805e23783SLisandro Dalcin #define TSRK5BS   "5bs"
83937acaa02SHendrik Ranocha #define TSRK6VR   "6vr"
84037acaa02SHendrik Ranocha #define TSRK7VR   "7vr"
84137acaa02SHendrik Ranocha #define TSRK8VR   "8vr"
84205e23783SLisandro Dalcin 
8432ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS,PetscInt*);
8440f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS,TSRKType*);
8450f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS,TSRKType);
8460f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS,PetscInt*,const PetscReal**,const PetscReal**,const PetscReal**,const PetscReal**,PetscInt*,const PetscReal**,PetscBool*);
8470fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool);
8480fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*);
849f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
850f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
851560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
852f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
853f68a32c8SEmil Constantinescu 
854f68a32c8SEmil Constantinescu /*J
8554b84eec9SHong Zhang    TSMPRKType - String with the name of a Partitioned Runge-Kutta method
8569f537349Sluzhanghpp 
8579f537349Sluzhanghpp    Level: beginner
8589f537349Sluzhanghpp 
8594b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister()
8609f537349Sluzhanghpp J*/
8614b84eec9SHong Zhang typedef const char* TSMPRKType;
86219c2959aSHong Zhang #define TSMPRK2A22  "2a22"
86319c2959aSHong Zhang #define TSMPRK2A23  "2a23"
86419c2959aSHong Zhang #define TSMPRK2A32  "2a32"
86519c2959aSHong Zhang #define TSMPRK2A33  "2a33"
8664b84eec9SHong Zhang #define TSMPRKP2    "p2"
8674b84eec9SHong Zhang #define TSMPRKP3    "p3"
8689f537349Sluzhanghpp 
8694b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*);
8704b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType);
87179bc8a77SHong 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[]);
8724b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
8734b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
8744b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);
8759f537349Sluzhanghpp 
8769f537349Sluzhanghpp /*J
877d2567f34SHong Zhang     TSIRKType - String with the name of an implicit Runge-Kutta method.
878d2567f34SHong Zhang 
879d2567f34SHong Zhang    Level: beginner
880d2567f34SHong Zhang 
881d2567f34SHong Zhang .seealso: TSIRKSetType(), TS, TSIRK, TSIRKRegister()
882d2567f34SHong Zhang J*/
883d2567f34SHong Zhang typedef const char* TSIRKType;
884d2567f34SHong Zhang #define TSIRKGAUSS   "gauss"
885d2567f34SHong Zhang 
886d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetOrder(TS,PetscInt*);
887d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetType(TS,TSIRKType*);
888d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetType(TS,TSIRKType);
889d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetNumStages(TS,PetscInt*);
890d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetNumStages(TS,PetscInt);
891d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegister(const char[],PetscErrorCode (*function)(TS));
892d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKTableauCreate(TS,PetscInt,const PetscReal*,const PetscReal*,const PetscReal*,const PetscReal*,const PetscScalar*,const PetscScalar*,const PetscScalar*);
893d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKInitializePackage(void);
894d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKFinalizePackage(void);
895d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegisterDestroy(void);
896d2567f34SHong Zhang 
897d2567f34SHong Zhang /*J
898b6a60446SDebojyoti Ghosh     TSGLEEType - String with the name of a General Linear with Error Estimation method.
899b6a60446SDebojyoti Ghosh 
900b6a60446SDebojyoti Ghosh    Level: beginner
901b6a60446SDebojyoti Ghosh 
902b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
903b6a60446SDebojyoti Ghosh J*/
904b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType;
905ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
906b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
907b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
908b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
909b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
910b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
911b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
912b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
913b6a60446SDebojyoti Ghosh /*J
914b6a60446SDebojyoti Ghosh     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
915b6a60446SDebojyoti Ghosh 
916b6a60446SDebojyoti Ghosh    Level: beginner
917b6a60446SDebojyoti Ghosh 
918b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
919b6a60446SDebojyoti Ghosh J*/
920b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
921b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
92257df6a1bSDebojyoti 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[]);
923b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
924b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
925b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
926b6a60446SDebojyoti Ghosh 
927b6a60446SDebojyoti Ghosh /*J
928020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
929020d8f30SJed Brown 
930020d8f30SJed Brown    Level: beginner
931020d8f30SJed Brown 
932020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
933020d8f30SJed Brown J*/
93419fd82e9SBarry Smith typedef const char* TSARKIMEXType;
935e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
9361f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
9371f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
9381f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
9391f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
9408a381b04SJed Brown #define TSARKIMEX2D     "2d"
941a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
9426cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
9438a381b04SJed Brown #define TSARKIMEX3      "3"
9446cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
9456cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
9468a381b04SJed Brown #define TSARKIMEX4      "4"
9478a381b04SJed Brown #define TSARKIMEX5      "5"
94819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
94919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
950014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
9513a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS,PetscBool*);
95219fd82e9SBarry 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[]);
953607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
954560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
955014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
9568a381b04SJed Brown 
957020d8f30SJed Brown /*J
958020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
959020d8f30SJed Brown 
960020d8f30SJed Brown    Level: beginner
961020d8f30SJed Brown 
962020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
963020d8f30SJed Brown J*/
96419fd82e9SBarry Smith typedef const char* TSRosWType;
96561692a83SJed Brown #define TSROSW2M          "2m"
96661692a83SJed Brown #define TSROSW2P          "2p"
967fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
968fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
969ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
970ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
971961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
972961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
97343b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
974753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
9753606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
9763606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
97742faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
97842faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
97942faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
98042faf41dSJed Brown #define TSROSW4L          "4l"
981b1c69cc3SEmil Constantinescu 
9826bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
9836bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
984014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
98519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
98619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
987607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
988560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
989014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
990e27a552bSJed Brown 
991211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
992211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
993211a84d6SLisandro Dalcin 
9946bd7aeb5SHong Zhang /*J
995e49d4f37SHong Zhang   TSBasicSymplecticType - String with the name of a basic symplectic integration method.
9966bd7aeb5SHong Zhang 
9976bd7aeb5SHong Zhang   Level: beginner
9986bd7aeb5SHong Zhang 
999e49d4f37SHong Zhang   .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister()
10006bd7aeb5SHong Zhang J*/
1001e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType;
1002e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
1003e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
1004e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
1005e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
1006e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
1007e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
1008e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
1009e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
1010e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
1011e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
10126bd7aeb5SHong Zhang 
1013db4653c2SDaniel Finn /*J
1014db4653c2SDaniel Finn   TSDiscreteGradient - The Discrete Gradient integrator is a timestepper for hamiltonian systems designed to conserve the first integral (energy), but also has the property for some systems of monotonicity in a functional.
1015db4653c2SDaniel Finn 
1016db4653c2SDaniel Finn   Level: beginner
1017db4653c2SDaniel Finn 
1018db4653c2SDaniel Finn   .seealso: TS, TSDISCGRAD, TSDiscGradSetFormulation(), TSDiscGradGetFormulation
1019db4653c2SDaniel Finn J*/
102040be0ff1SMatthew 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 *);
1021db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradIsGonzalez(TS,PetscBool*);
1022db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradUseGonzalez(TS,PetscBool);
102340be0ff1SMatthew G. Knepley 
102483e2fdc7SBarry Smith /*
10250f3b3ca1SHong Zhang        PETSc interface to Sundials
102683e2fdc7SBarry Smith */
1027e808b789SPatrick Sanan #ifdef PETSC_HAVE_SUNDIALS2
10286fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
10296a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
10306fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
10316a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
1032014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
1033014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
1034014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
1035014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
1036014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
1037014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
1038014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
1039014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
1040014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
1041014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool);
1042014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
1043014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
1044c4e80e11SFlorian PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS,PetscInt);
1045918687b8SPatrick Sanan PETSC_EXTERN PetscErrorCode TSSundialsSetUseDense(TS,PetscBool);
10466dc17ff5SMatthew Knepley #endif
104783e2fdc7SBarry Smith 
1048014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
1049014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
1050014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
1051014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
10520de4c49aSJed Brown 
1053014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
1054014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
1055014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
105688df8a41SLisandro Dalcin 
1057818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
1058818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
1059818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
1060818efac9SLisandro Dalcin 
1061014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
1062014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
10636c699258SBarry Smith 
1064014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
1065d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
10660f5c6efeSJed Brown 
1067f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
1068f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
1069aad739acSMatthew G. Knepley 
10702e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec));
10712e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec));
10722e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec);
10732e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec));
1074aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec));
1075aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec);
1076f2ed2dc7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool);
1077d60b7d5cSBarry Smith 
1078d60b7d5cSBarry Smith PETSC_EXTERN PetscErrorCode TSSetMatStructure(TS,MatStructure);
1079818ad0c1SBarry Smith #endif
1080