xref: /petsc/include/petscts.h (revision 013797aa4c8daa6151fb96b01594132b064cd767)
1818ad0c1SBarry Smith /*
2316643e7SJed Brown    User interface for the timestepping package. This package
3f64a0f93SLois Curfman McInnes    is for use in solving time-dependent PDEs.
4818ad0c1SBarry Smith */
50a835dfdSSatish Balay #if !defined(__PETSCTS_H)
60a835dfdSSatish Balay #define __PETSCTS_H
72c8e378dSBarry Smith #include <petscsnes.h>
8818ad0c1SBarry Smith 
9435da068SBarry Smith /*S
10435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
11435da068SBarry Smith 
12435da068SBarry Smith    Level: beginner
13435da068SBarry Smith 
14435da068SBarry Smith   Concepts: ODE solvers
15435da068SBarry Smith 
168f6c3df8SBarry Smith .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
17435da068SBarry Smith S*/
18f09e8eb9SSatish Balay typedef struct _p_TS* TS;
19435da068SBarry Smith 
2076bdecfbSBarry Smith /*J
218f6c3df8SBarry Smith     TSType - String with the name of a PETSc TS method.
22435da068SBarry Smith 
23435da068SBarry Smith    Level: beginner
24435da068SBarry Smith 
258f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister()
2676bdecfbSBarry Smith J*/
2719fd82e9SBarry Smith typedef const char* TSType;
289596e0b4SJed Brown #define TSEULER           "euler"
299596e0b4SJed Brown #define TSBEULER          "beuler"
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"
389596e0b4SJed Brown #define TSGL              "gl"
39ef7bb5aaSJed Brown #define TSSSP             "ssp"
408a381b04SJed Brown #define TSARKIMEX         "arkimex"
41e27a552bSJed Brown #define TSROSW            "rosw"
427d5697caSHong Zhang #define TSEIMEX           "eimex"
43abadfa0fSMatthew G. Knepley #define TSMIMEX           "mimex"
44211a84d6SLisandro Dalcin #define TSBDF             "bdf"
45211a84d6SLisandro Dalcin 
46435da068SBarry Smith /*E
47435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
48435da068SBarry Smith 
49435da068SBarry Smith    Level: beginner
50435da068SBarry Smith 
51435da068SBarry Smith .seealso: TSCreate()
52435da068SBarry Smith E*/
5319bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
54818ad0c1SBarry Smith 
55b93fea0eSJed Brown /*E
56e817cc15SEmil Constantinescu    TSEquationType - type of TS problem that is solved
57e817cc15SEmil Constantinescu 
58e817cc15SEmil Constantinescu    Level: beginner
59e817cc15SEmil Constantinescu 
60af0996ceSBarry Smith    Developer Notes: this must match petsc/finclude/petscts.h
61e817cc15SEmil Constantinescu 
62e817cc15SEmil Constantinescu    Supported types are:
63e817cc15SEmil Constantinescu      TS_EQ_UNSPECIFIED (default)
64e817cc15SEmil 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
65e817cc15SEmil Constantinescu      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
66e817cc15SEmil Constantinescu 
67e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType()
68e817cc15SEmil Constantinescu E*/
69e817cc15SEmil Constantinescu typedef enum {
70e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
71e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
72e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
73e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
74e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
75e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
76e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
77e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
78e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
79e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
80e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
81e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
8219436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
83e817cc15SEmil Constantinescu } TSEquationType;
84e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes;
85e817cc15SEmil Constantinescu 
86e817cc15SEmil Constantinescu /*E
87b93fea0eSJed Brown    TSConvergedReason - reason a TS method has converged or not
88b93fea0eSJed Brown 
89b93fea0eSJed Brown    Level: beginner
90b93fea0eSJed Brown 
91af0996ceSBarry Smith    Developer Notes: this must match petsc/finclude/petscts.h
92b93fea0eSJed Brown 
93b93fea0eSJed Brown    Each reason has its own manual page.
94b93fea0eSJed Brown 
95b93fea0eSJed Brown .seealso: TSGetConvergedReason()
96b93fea0eSJed Brown E*/
97193ac0bcSJed Brown typedef enum {
98193ac0bcSJed Brown   TS_CONVERGED_ITERATING      = 0,
99193ac0bcSJed Brown   TS_CONVERGED_TIME           = 1,
100193ac0bcSJed Brown   TS_CONVERGED_ITS            = 2,
101d6ad946cSShri Abhyankar   TS_CONVERGED_USER           = 3,
1022b7db910SShri Abhyankar   TS_CONVERGED_EVENT          = 4,
1033118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL   = 5,
1043118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL   = 6,
105193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE = -1,
106193ac0bcSJed Brown   TS_DIVERGED_STEP_REJECTED   = -2
107193ac0bcSJed Brown } TSConvergedReason;
108014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons;
1091957e957SBarry Smith 
110b93fea0eSJed Brown /*MC
111b93fea0eSJed Brown    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
112b93fea0eSJed Brown 
113b93fea0eSJed Brown    Level: beginner
114b93fea0eSJed Brown 
115552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
116b93fea0eSJed Brown M*/
117b93fea0eSJed Brown 
118b93fea0eSJed Brown /*MC
119b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
120b93fea0eSJed Brown 
121b93fea0eSJed Brown    Level: beginner
122b93fea0eSJed Brown 
123552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration(), TSGetSolveTime()
124b93fea0eSJed Brown M*/
125b93fea0eSJed Brown 
126b93fea0eSJed Brown /*MC
1271957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
128b93fea0eSJed Brown 
129b93fea0eSJed Brown    Level: beginner
130b93fea0eSJed Brown 
131552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration()
132b93fea0eSJed Brown M*/
1331957e957SBarry Smith 
134d6ad946cSShri Abhyankar /*MC
135d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
136d6ad946cSShri Abhyankar 
137d6ad946cSShri Abhyankar    Level: beginner
138d6ad946cSShri Abhyankar 
139d6ad946cSShri Abhyankar .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration()
140b93fea0eSJed Brown M*/
141b93fea0eSJed Brown 
142b93fea0eSJed Brown /*MC
143d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
144d76fc68cSShri Abhyankar 
145d76fc68cSShri Abhyankar    Level: beginner
146d76fc68cSShri Abhyankar 
147d76fc68cSShri Abhyankar .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration()
148d76fc68cSShri Abhyankar M*/
149d76fc68cSShri Abhyankar 
150d76fc68cSShri Abhyankar /*MC
1513118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
1523118ae5eSBarry Smith 
1533118ae5eSBarry Smith    Level: beginner
1543118ae5eSBarry Smith 
1553118ae5eSBarry Smith    Options Database:
1563118ae5eSBarry Smith .   -ts_pseudo_frtol <rtol>
1573118ae5eSBarry Smith 
1583118ae5eSBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration(), TS_CONVERGED_PSEUDO_FATOL
1593118ae5eSBarry Smith M*/
1603118ae5eSBarry Smith 
1613118ae5eSBarry Smith /*MC
1623118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
1633118ae5eSBarry Smith 
1643118ae5eSBarry Smith    Level: beginner
1653118ae5eSBarry Smith 
1663118ae5eSBarry Smith    Options Database:
1673118ae5eSBarry Smith .   -ts_pseudo_fatol <atol>
1683118ae5eSBarry Smith 
1693118ae5eSBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration(), TS_CONVERGED_PSEUDO_FRTOL
1703118ae5eSBarry Smith M*/
1713118ae5eSBarry Smith 
1723118ae5eSBarry Smith /*MC
173b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
174b93fea0eSJed Brown 
175b93fea0eSJed Brown    Level: beginner
176b93fea0eSJed Brown 
1771957e957SBarry Smith    Notes: See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
1781957e957SBarry Smith 
1791957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
180b93fea0eSJed Brown M*/
181b93fea0eSJed Brown 
182b93fea0eSJed Brown /*MC
183b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
184b93fea0eSJed Brown 
185b93fea0eSJed Brown    Level: beginner
186b93fea0eSJed Brown 
1871957e957SBarry Smith    Notes: See TSSetMaxStepRejections() for how to allow more step rejections.
1881957e957SBarry Smith 
1891957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
190b93fea0eSJed Brown M*/
191b93fea0eSJed Brown 
192d6ad946cSShri Abhyankar /*E
193d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
194d6ad946cSShri Abhyankar 
195d6ad946cSShri Abhyankar    Level: beginner
196d6ad946cSShri Abhyankar 
197af0996ceSBarry Smith    Developer Notes: this must match petsc/finclude/petscts.h
198d6ad946cSShri Abhyankar 
199d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
200d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
201d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
202feed9e9dSBarry Smith 
2034ceb6c04SBarry Smith .seealso: TSGetConvergedReason(), TSSetExactFinalTime()
2044ceb6c04SBarry Smith 
205d6ad946cSShri Abhyankar E*/
206feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
207d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
208d6ad946cSShri Abhyankar 
209d6ad946cSShri Abhyankar 
210000e7ae3SMatthew Knepley /* Logging support */
211014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
212d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2131b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
214000e7ae3SMatthew Knepley 
215607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
216560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2178ba1e511SMatthew Knepley 
218014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
219baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
220014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
221818ad0c1SBarry Smith 
222014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
223014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
224014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
225014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
226721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
227014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
228818ad0c1SBarry Smith 
2299110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
2309110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
2319110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
232d12e167eSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
2339110b2e7SHong Zhang 
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
235014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
237014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
240818ad0c1SBarry Smith 
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
243818ad0c1SBarry Smith 
244efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
245efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
246efe9872eSLisandro Dalcin 
247bc952696SBarry Smith /*S
248bc952696SBarry Smith      TSTrajectory - Abstract PETSc object that storing the trajectory (solution of ODE/ADE at each time step and stage)
249bc952696SBarry Smith 
250bc952696SBarry Smith    Level: advanced
251bc952696SBarry Smith 
252bc952696SBarry Smith   Concepts: ODE solvers, adjoint
253bc952696SBarry Smith 
254bc952696SBarry Smith .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
255bc952696SBarry Smith S*/
256bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory;
257bc952696SBarry Smith 
258bc952696SBarry Smith /*J
259bc952696SBarry Smith     TSTrajectoryType - String with the name of a PETSc TS trajectory storage method
260bc952696SBarry Smith 
261bc952696SBarry Smith    Level: intermediate
262bc952696SBarry Smith 
263bc952696SBarry Smith .seealso: TSSetType(), TS, TSRegister(), TSTrajectoryCreate(), TSTrajectorySetType()
264bc952696SBarry Smith J*/
265bc952696SBarry Smith typedef const char* TSTrajectoryType;
266bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
2671c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
2689a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
2692b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
270bc952696SBarry Smith 
271bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
272bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
273bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
274bc952696SBarry Smith 
275bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
276bc952696SBarry Smith 
277bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
278bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
279560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
280972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,const TSTrajectoryType);
281bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
282c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
283972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
284560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
285bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
28668bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
287bc952696SBarry Smith 
288dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
289dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
290b1cb36f3SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostIntegrand(TS,PetscInt,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscBool,void*);
291dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
292d4aa0a58SBarry Smith 
2935bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
2942c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
29573b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
296d4aa0a58SBarry Smith 
2975bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
29873b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
299f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
300d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
301d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
302d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeCostIntegrand(TS,PetscReal,Vec,Vec);
303999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
304999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
305c235aa8dSHong Zhang 
306014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
307014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
30849354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
309818ad0c1SBarry Smith 
310721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
31183a4ac43SBarry Smith 
31283a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
31383a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
31483a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
31583a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
3162d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
31783a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
31883a4ac43SBarry Smith 
319721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
3209110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
3219110b2e7SHong Zhang 
322721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
323014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
324014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
325fb1732b5SBarry Smith 
326014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
3277cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
328014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
329cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
330e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
331e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
332014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
333d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
334487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
3355ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
3365ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
337cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
338cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
339cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
340cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
341cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
34224655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
3432c18e0fdSBarry Smith PETSC_EXTERN PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
344d2daff3dSHong Zhang 
345ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);
346818ad0c1SBarry Smith 
347014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
348014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
349014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
350014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
351014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
352014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
353e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
354818ad0c1SBarry Smith 
355638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
356d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
357014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
358014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
359014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
360014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
361e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
362818ad0c1SBarry Smith 
363ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
364ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
365d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
366d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
367ef20d060SBarry Smith 
368638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
369d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
370014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
371014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
372014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
373014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
374316643e7SJed Brown 
375efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
376efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
377efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
378efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
379efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
380efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
381efe9872eSLisandro Dalcin 
382014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
383d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
384014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
385d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
3861c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
3879b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
388847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
389e34be4c2SBarry Smith 
390014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
391b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
3929be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
393014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
394014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
395b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
3969be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
397014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
398014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
399014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
400c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
401a4868fbcSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*);
402a4868fbcSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*);
403a4868fbcSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*);
404014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
405014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
406d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
407d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
408000e7ae3SMatthew Knepley 
409014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
4108d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
412014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
413014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
4148d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
415014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
416014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
417014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
41821c89e3eSBarry Smith 
419014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
4201d6018f0SLisandro Dalcin 
421014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
422d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
423014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
424d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
425efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
426efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
427f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
428818ad0c1SBarry Smith 
429014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
430d6ebe24aSShri Abhyankar 
431967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
43224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
43324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
43424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
43524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
43624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
43724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
43824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
43924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
440efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
441efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
442efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
443efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
444efe9872eSLisandro Dalcin 
445ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
446ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
447d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
448d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
449924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
450924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
4510163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **);
4529b7cd975SBarry Smith 
453d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
454d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
455d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
4566c6b9e74SPeter Brune 
4576c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
4586c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
4596c6b9e74SPeter Brune 
4606c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
461d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
4626c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
463d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
4646c6b9e74SPeter Brune 
4656c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
466d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
4676c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
468d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
4696c6b9e74SPeter Brune 
470b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
471560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*);
4726dbbd306SMatthew G. Knepley 
473be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
474d1212d36SBarry Smith typedef struct {
475d1212d36SBarry Smith   Vec            ray;
476d1212d36SBarry Smith   VecScatter     scatter;
477d1212d36SBarry Smith   PetscViewer    viewer;
47851b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
479d1212d36SBarry Smith } TSMonitorDMDARayCtx;
480d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
481d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
48251b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
483d1212d36SBarry Smith 
484d1212d36SBarry Smith 
485bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
486140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
48719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
48819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
489bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
49030de9b25SBarry Smith 
491014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
492deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
493014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
494818ad0c1SBarry Smith 
495014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
49655849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
497685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
49839c6b90dSHong Zhang PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
49955849f57SBarry Smith 
50055849f57SBarry Smith #define TS_FILE_CLASSID 1211225
50121c89e3eSBarry Smith 
502014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
503014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
50421c89e3eSBarry Smith 
505a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
506a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
5074f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
5084f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
50931152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
510b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
511e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
512a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
513a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
5147684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
5157684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
5164f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
517201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
518201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
519ef20d060SBarry Smith 
520b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
521b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
522b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
523b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
524b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
525b3d3934dSBarry Smith 
5268189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
5278189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
5288189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
5298189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
5303914022bSBarry Smith 
5312589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
5326427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
53376bdecfbSBarry Smith /*J
534815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
535815f1ad5SJed Brown 
536815f1ad5SJed Brown    Level: beginner
537815f1ad5SJed Brown 
538815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
53976bdecfbSBarry Smith J*/
54019fd82e9SBarry Smith typedef const char* TSSSPType;
541815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
542815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
543815f1ad5SJed Brown #define TSSSPRK104 "rk104"
544815f1ad5SJed Brown 
54519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
54619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
547014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
548014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
549787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
550560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
551*013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
552815f1ad5SJed Brown 
553ed657a08SJed Brown /*S
55484df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
55584df9cb4SJed Brown 
55684df9cb4SJed Brown    Level: beginner
55784df9cb4SJed Brown 
55884df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType
55984df9cb4SJed Brown S*/
56084df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
56184df9cb4SJed Brown 
56284df9cb4SJed Brown /*E
5638f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
56484df9cb4SJed Brown 
56584df9cb4SJed Brown    Level: beginner
56684df9cb4SJed Brown 
56784df9cb4SJed Brown .seealso: TSAdaptSetType(), TS
56884df9cb4SJed Brown E*/
569f8963224SJed Brown typedef const char *TSAdaptType;
57084df9cb4SJed Brown #define TSADAPTBASIC "basic"
571b0f836d7SJed Brown #define TSADAPTNONE  "none"
5728d59e960SJed Brown #define TSADAPTCFL   "cfl"
57384df9cb4SJed Brown 
574552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
575bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
576607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
577014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
578014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
57919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
580014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
581014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
582014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
583014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
584014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
585b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
586014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
587ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
5884416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
589099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
590014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
591014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
592014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
593b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
59484df9cb4SJed Brown 
5951b9b13dfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptBasicSetClip(TSAdapt,PetscReal,PetscReal);
5961b9b13dfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptBasicGetClip(TSAdapt,PetscReal*,PetscReal*);
5971b9b13dfSLisandro Dalcin 
59884df9cb4SJed Brown /*S
599ed657a08SJed Brown    TSGLAdapt - Abstract object that manages time-step adaptivity
600ed657a08SJed Brown 
601ed657a08SJed Brown    Level: beginner
602ed657a08SJed Brown 
60384df9cb4SJed Brown    Developer Notes:
60484df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
60584df9cb4SJed Brown 
606ed657a08SJed Brown .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType
607ed657a08SJed Brown S*/
608ed657a08SJed Brown typedef struct _p_TSGLAdapt *TSGLAdapt;
609ed657a08SJed Brown 
61076bdecfbSBarry Smith /*J
6118f6c3df8SBarry Smith     TSGLAdaptType - String with the name of TSGLAdapt scheme
612ed657a08SJed Brown 
613ed657a08SJed Brown    Level: beginner
614ed657a08SJed Brown 
615ed657a08SJed Brown .seealso: TSGLAdaptSetType(), TS
61676bdecfbSBarry Smith J*/
617f8963224SJed Brown typedef const char *TSGLAdaptType;
618ed657a08SJed Brown #define TSGLADAPT_NONE "none"
619ed657a08SJed Brown #define TSGLADAPT_SIZE "size"
620ed657a08SJed Brown #define TSGLADAPT_BOTH "both"
621ed657a08SJed Brown 
622bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptRegister(const char[],PetscErrorCode (*)(TSGLAdapt));
623607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptInitializePackage(void);
624014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptFinalizePackage(void);
625014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*);
62619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptSetType(TSGLAdapt,TSGLAdaptType);
627014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]);
628014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
629014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer);
6304416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptSetFromOptions(PetscOptionItems*,TSGLAdapt);
631014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*);
632ed657a08SJed Brown 
63376bdecfbSBarry Smith /*J
6348f6c3df8SBarry Smith     TSGLAcceptType - String with the name of TSGLAccept scheme
635ed657a08SJed Brown 
636ed657a08SJed Brown    Level: beginner
637ed657a08SJed Brown 
638ed657a08SJed Brown .seealso: TSGLSetAcceptType(), TS
63976bdecfbSBarry Smith J*/
640f8963224SJed Brown typedef const char *TSGLAcceptType;
641ed657a08SJed Brown #define TSGLACCEPT_ALWAYS "always"
642ed657a08SJed Brown 
643638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
644bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAcceptRegister(const char[],TSGLAcceptFunction);
645ed657a08SJed Brown 
64676bdecfbSBarry Smith /*J
64718b56cb9SJed Brown   TSGLType - family of time integration method within the General Linear class
64818b56cb9SJed Brown 
64918b56cb9SJed Brown   Level: beginner
65018b56cb9SJed Brown 
65118b56cb9SJed Brown .seealso: TSGLSetType(), TSGLRegister()
65276bdecfbSBarry Smith J*/
65319fd82e9SBarry Smith typedef const char* TSGLType;
654ed657a08SJed Brown #define TSGL_IRKS   "irks"
65518b56cb9SJed Brown 
656bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSGLRegister(const char[],PetscErrorCode(*)(TS));
657607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSGLInitializePackage(void);
658014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLFinalizePackage(void);
65919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGLSetType(TS,TSGLType);
660014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*);
66119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGLSetAcceptType(TS,TSGLAcceptType);
66218b56cb9SJed Brown 
663020d8f30SJed Brown /*J
6647d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
6657d5697caSHong Zhang 
6667d5697caSHong Zhang    Level: beginner
6677d5697caSHong Zhang 
6687d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
6697d5697caSHong Zhang J*/
6707d5697caSHong Zhang #define TSEIMEXType   char*
6717d5697caSHong Zhang 
6727d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
6737d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
6747d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
6757d5697caSHong Zhang 
6767d5697caSHong Zhang /*J
677f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
678f68a32c8SEmil Constantinescu 
679f68a32c8SEmil Constantinescu    Level: beginner
680f68a32c8SEmil Constantinescu 
681f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
682f68a32c8SEmil Constantinescu J*/
683f68a32c8SEmil Constantinescu typedef const char* TSRKType;
684f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
685fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
686f68a32c8SEmil Constantinescu #define TSRK3     "3"
687fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
688f68a32c8SEmil Constantinescu #define TSRK4     "4"
689fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
690fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
691f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
692f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
693f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
694f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
695f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
696560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
697f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
698f68a32c8SEmil Constantinescu 
699f68a32c8SEmil Constantinescu /*J
700020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
701020d8f30SJed Brown 
702020d8f30SJed Brown    Level: beginner
703020d8f30SJed Brown 
704020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
705020d8f30SJed Brown J*/
70619fd82e9SBarry Smith typedef const char* TSARKIMEXType;
707e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
7081f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
7091f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
7101f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
7111f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
7128a381b04SJed Brown #define TSARKIMEX2D     "2d"
713a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
7146cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
7158a381b04SJed Brown #define TSARKIMEX3      "3"
7166cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
7176cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
7188a381b04SJed Brown #define TSARKIMEX4      "4"
7198a381b04SJed Brown #define TSARKIMEX5      "5"
72019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
72119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
722014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
72319fd82e9SBarry 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[]);
724607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
725560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
726014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
7278a381b04SJed Brown 
728020d8f30SJed Brown /*J
729020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
730020d8f30SJed Brown 
731020d8f30SJed Brown    Level: beginner
732020d8f30SJed Brown 
733020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
734020d8f30SJed Brown J*/
73519fd82e9SBarry Smith typedef const char* TSRosWType;
73661692a83SJed Brown #define TSROSW2M          "2m"
73761692a83SJed Brown #define TSROSW2P          "2p"
738fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
739fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
740ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
741ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
742961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
743961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
74443b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
745753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
7463606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
7473606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
74842faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
74942faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
75042faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
75142faf41dSJed Brown #define TSROSW4L          "4l"
752b1c69cc3SEmil Constantinescu 
75319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*);
75419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType);
755014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
75619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
75719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
758607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
759560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
760014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
761e27a552bSJed Brown 
762211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
763211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
764211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFUseAdapt(TS,PetscBool);
765211a84d6SLisandro Dalcin 
76683e2fdc7SBarry Smith /*
7670f3b3ca1SHong Zhang        PETSc interface to Sundials
76883e2fdc7SBarry Smith */
7696dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS
7706fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
7716a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
7726fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
7736a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
774014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
775014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
776014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
777014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
778014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
779014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
780014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
781014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
782014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
783014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
784014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
785014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
7866dc17ff5SMatthew Knepley #endif
78783e2fdc7SBarry Smith 
788014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
789014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
790014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
791014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
7920de4c49aSJed Brown 
793b07a2398SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlphaUseAdapt(TS,PetscBool);
794014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
795014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
796014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
79788df8a41SLisandro Dalcin 
798818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2UseAdapt(TS,PetscBool);
799818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
800818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
801818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
802818efac9SLisandro Dalcin 
803014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
804014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
8056c699258SBarry Smith 
806014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
807d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
8080f5c6efeSJed Brown 
809818ad0c1SBarry Smith #endif
810