xref: /petsc/include/petscts.h (revision fe8322adceea202af5179e23400eaf47190af617)
1818ad0c1SBarry Smith /*
2316643e7SJed Brown    User interface for the timestepping package. This package
3f64a0f93SLois Curfman McInnes    is for use in solving time-dependent PDEs.
4818ad0c1SBarry Smith */
50a835dfdSSatish Balay #if !defined(__PETSCTS_H)
60a835dfdSSatish Balay #define __PETSCTS_H
72c8e378dSBarry Smith #include <petscsnes.h>
8818ad0c1SBarry Smith 
9435da068SBarry Smith /*S
10435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
11435da068SBarry Smith 
12435da068SBarry Smith    Level: beginner
13435da068SBarry Smith 
14435da068SBarry Smith   Concepts: ODE solvers
15435da068SBarry Smith 
168f6c3df8SBarry Smith .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
17435da068SBarry Smith S*/
18f09e8eb9SSatish Balay typedef struct _p_TS* TS;
19435da068SBarry Smith 
2076bdecfbSBarry Smith /*J
218f6c3df8SBarry Smith     TSType - String with the name of a PETSc TS method.
22435da068SBarry Smith 
23435da068SBarry Smith    Level: beginner
24435da068SBarry Smith 
258f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister()
2676bdecfbSBarry Smith J*/
2719fd82e9SBarry Smith typedef const char* TSType;
289596e0b4SJed Brown #define TSEULER           "euler"
299596e0b4SJed Brown #define TSBEULER          "beuler"
30e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic"
319596e0b4SJed Brown #define TSPSEUDO          "pseudo"
324d91e141SJed Brown #define TSCN              "cn"
339596e0b4SJed Brown #define TSSUNDIALS        "sundials"
344d91e141SJed Brown #define TSRK              "rk"
359596e0b4SJed Brown #define TSPYTHON          "python"
369596e0b4SJed Brown #define TSTHETA           "theta"
3788df8a41SLisandro Dalcin #define TSALPHA           "alpha"
38818efac9SLisandro Dalcin #define TSALPHA2          "alpha2"
3926d28e4eSEmil Constantinescu #define TSGLLE            "glle"
40b6a60446SDebojyoti Ghosh #define TSGLEE            "glee"
41ef7bb5aaSJed Brown #define TSSSP             "ssp"
428a381b04SJed Brown #define TSARKIMEX         "arkimex"
43e27a552bSJed Brown #define TSROSW            "rosw"
447d5697caSHong Zhang #define TSEIMEX           "eimex"
45abadfa0fSMatthew G. Knepley #define TSMIMEX           "mimex"
46211a84d6SLisandro Dalcin #define TSBDF             "bdf"
47d249a78fSBarry Smith #define TSRADAU5          "radau5"
48211a84d6SLisandro Dalcin 
49435da068SBarry Smith /*E
50435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
51435da068SBarry Smith 
52435da068SBarry Smith    Level: beginner
53435da068SBarry Smith 
54435da068SBarry Smith .seealso: TSCreate()
55435da068SBarry Smith E*/
5619bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
57818ad0c1SBarry Smith 
58b93fea0eSJed Brown /*E
59e817cc15SEmil Constantinescu    TSEquationType - type of TS problem that is solved
60e817cc15SEmil Constantinescu 
61e817cc15SEmil Constantinescu    Level: beginner
62e817cc15SEmil Constantinescu 
6395452b02SPatrick Sanan    Developer Notes:
6495452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
65e817cc15SEmil Constantinescu 
66e817cc15SEmil Constantinescu    Supported types are:
67e817cc15SEmil Constantinescu      TS_EQ_UNSPECIFIED (default)
68e817cc15SEmil Constantinescu      TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0
69e817cc15SEmil Constantinescu      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
70e817cc15SEmil Constantinescu 
71e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType()
72e817cc15SEmil Constantinescu E*/
73e817cc15SEmil Constantinescu typedef enum {
74e817cc15SEmil Constantinescu   TS_EQ_UNSPECIFIED               = -1,
75e817cc15SEmil Constantinescu   TS_EQ_EXPLICIT                  = 0,
76e817cc15SEmil Constantinescu   TS_EQ_ODE_EXPLICIT              = 1,
77e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
78e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
79e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
80e817cc15SEmil Constantinescu   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
81e817cc15SEmil Constantinescu   TS_EQ_IMPLICIT                  = 1000,
82e817cc15SEmil Constantinescu   TS_EQ_ODE_IMPLICIT              = 1001,
83e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
84e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
85e817cc15SEmil Constantinescu   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
8619436ca2SJed Brown   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
87e817cc15SEmil Constantinescu } TSEquationType;
88e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes;
89e817cc15SEmil Constantinescu 
90e817cc15SEmil Constantinescu /*E
91b93fea0eSJed Brown    TSConvergedReason - reason a TS method has converged or not
92b93fea0eSJed Brown 
93b93fea0eSJed Brown    Level: beginner
94b93fea0eSJed Brown 
9595452b02SPatrick Sanan    Developer Notes:
9695452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
97b93fea0eSJed Brown 
98b93fea0eSJed Brown    Each reason has its own manual page.
99b93fea0eSJed Brown 
100b93fea0eSJed Brown .seealso: TSGetConvergedReason()
101b93fea0eSJed Brown E*/
102193ac0bcSJed Brown typedef enum {
103193ac0bcSJed Brown   TS_CONVERGED_ITERATING      = 0,
104193ac0bcSJed Brown   TS_CONVERGED_TIME           = 1,
105193ac0bcSJed Brown   TS_CONVERGED_ITS            = 2,
106d6ad946cSShri Abhyankar   TS_CONVERGED_USER           = 3,
1072b7db910SShri Abhyankar   TS_CONVERGED_EVENT          = 4,
1083118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FATOL   = 5,
1093118ae5eSBarry Smith   TS_CONVERGED_PSEUDO_FRTOL   = 6,
110193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE = -1,
111193ac0bcSJed Brown   TS_DIVERGED_STEP_REJECTED   = -2
112193ac0bcSJed Brown } TSConvergedReason;
113014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons;
1141957e957SBarry Smith 
115b93fea0eSJed Brown /*MC
116b93fea0eSJed Brown    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
117b93fea0eSJed Brown 
118b93fea0eSJed Brown    Level: beginner
119b93fea0eSJed Brown 
120552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
121b93fea0eSJed Brown M*/
122b93fea0eSJed Brown 
123b93fea0eSJed Brown /*MC
124b93fea0eSJed Brown    TS_CONVERGED_TIME - the final time was reached
125b93fea0eSJed Brown 
126b93fea0eSJed Brown    Level: beginner
127b93fea0eSJed Brown 
12819eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime()
129b93fea0eSJed Brown M*/
130b93fea0eSJed Brown 
131b93fea0eSJed Brown /*MC
1321957e957SBarry Smith    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
133b93fea0eSJed Brown 
134b93fea0eSJed Brown    Level: beginner
135b93fea0eSJed Brown 
13619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps()
137b93fea0eSJed Brown M*/
1381957e957SBarry Smith 
139d6ad946cSShri Abhyankar /*MC
140d6ad946cSShri Abhyankar    TS_CONVERGED_USER - user requested termination
141d6ad946cSShri Abhyankar 
142d6ad946cSShri Abhyankar    Level: beginner
143d6ad946cSShri Abhyankar 
14419eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
145b93fea0eSJed Brown M*/
146b93fea0eSJed Brown 
147b93fea0eSJed Brown /*MC
148d76fc68cSShri Abhyankar    TS_CONVERGED_EVENT - user requested termination on event detection
149d76fc68cSShri Abhyankar 
150d76fc68cSShri Abhyankar    Level: beginner
151d76fc68cSShri Abhyankar 
15219eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
153d76fc68cSShri Abhyankar M*/
154d76fc68cSShri Abhyankar 
155d76fc68cSShri Abhyankar /*MC
1563118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
1573118ae5eSBarry Smith 
1583118ae5eSBarry Smith    Level: beginner
1593118ae5eSBarry Smith 
1603118ae5eSBarry Smith    Options Database:
1613118ae5eSBarry Smith .   -ts_pseudo_frtol <rtol>
1623118ae5eSBarry Smith 
16319eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL
1643118ae5eSBarry Smith M*/
1653118ae5eSBarry Smith 
1663118ae5eSBarry Smith /*MC
1673118ae5eSBarry Smith    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
1683118ae5eSBarry Smith 
1693118ae5eSBarry Smith    Level: beginner
1703118ae5eSBarry Smith 
1713118ae5eSBarry Smith    Options Database:
1723118ae5eSBarry Smith .   -ts_pseudo_fatol <atol>
1733118ae5eSBarry Smith 
17419eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL
1753118ae5eSBarry Smith M*/
1763118ae5eSBarry Smith 
1773118ae5eSBarry Smith /*MC
178b93fea0eSJed Brown    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
179b93fea0eSJed Brown 
180b93fea0eSJed Brown    Level: beginner
181b93fea0eSJed Brown 
18295452b02SPatrick Sanan    Notes:
18395452b02SPatrick Sanan     See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
1841957e957SBarry Smith 
1851957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
186b93fea0eSJed Brown M*/
187b93fea0eSJed Brown 
188b93fea0eSJed Brown /*MC
189b93fea0eSJed Brown    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
190b93fea0eSJed Brown 
191b93fea0eSJed Brown    Level: beginner
192b93fea0eSJed Brown 
19395452b02SPatrick Sanan    Notes:
19495452b02SPatrick Sanan     See TSSetMaxStepRejections() for how to allow more step rejections.
1951957e957SBarry Smith 
1961957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
197b93fea0eSJed Brown M*/
198b93fea0eSJed Brown 
199d6ad946cSShri Abhyankar /*E
200d6ad946cSShri Abhyankar    TSExactFinalTimeOption - option for handling of final time step
201d6ad946cSShri Abhyankar 
202d6ad946cSShri Abhyankar    Level: beginner
203d6ad946cSShri Abhyankar 
20495452b02SPatrick Sanan    Developer Notes:
20595452b02SPatrick Sanan     this must match petsc/finclude/petscts.h
206d6ad946cSShri Abhyankar 
207d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
208d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
209d6ad946cSShri Abhyankar $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
210feed9e9dSBarry Smith 
211f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime()
2124ceb6c04SBarry Smith 
213d6ad946cSShri Abhyankar E*/
214feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
215d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
216d6ad946cSShri Abhyankar 
217000e7ae3SMatthew Knepley /* Logging support */
218014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID;
219d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID;
2201b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
221000e7ae3SMatthew Knepley 
222607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
223560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
2248ba1e511SMatthew Knepley 
225014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
226baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
227014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
228818ad0c1SBarry Smith 
229014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
230014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
231014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
233721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
235818ad0c1SBarry Smith 
236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
237014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS);
241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS);
242818ad0c1SBarry Smith 
243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
245818ad0c1SBarry Smith 
246efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
247efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
24857df6a1bSDebojyoti Ghosh 
249642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
250642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
2510a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
25257df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);
2536e2e232bSDebojyoti Ghosh 
254a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
255a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat);
256a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
257a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
258a05bf03eSHong Zhang 
259bc952696SBarry Smith /*S
260e91eccc2SStefano Zampini      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)
261bc952696SBarry Smith 
262bc952696SBarry Smith    Level: advanced
263bc952696SBarry Smith 
2643c0fce88SHong Zhang   Concepts: ODE solvers, trajectory
265bc952696SBarry Smith 
2661550c9b9SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset()
267bc952696SBarry Smith S*/
268bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory;
269bc952696SBarry Smith 
270bc952696SBarry Smith /*J
2713c0fce88SHong Zhang     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method
272bc952696SBarry Smith 
273bc952696SBarry Smith    Level: intermediate
274bc952696SBarry Smith 
2753c0fce88SHong Zhang .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy()
276bc952696SBarry Smith J*/
277bc952696SBarry Smith typedef const char* TSTrajectoryType;
278bc952696SBarry Smith #define TSTRAJECTORYBASIC         "basic"
2791c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE    "singlefile"
2809a53571cSHong Zhang #define TSTRAJECTORYMEMORY        "memory"
2812b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization"
282bc952696SBarry Smith 
283bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList;
284bc952696SBarry Smith PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
285bc952696SBarry Smith PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
286bc952696SBarry Smith 
287bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
288bc952696SBarry Smith 
289bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
2909a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
291bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
292560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
293fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType);
294bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
295c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
296*fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec);
297*fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*);
298*fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*);
299*fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*);
300972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
301560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
302bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
30368bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
3042bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
30578fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
30608347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
307*fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool);
308*fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*);
30964fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool);
31064e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]);
31164e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]);
31278fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);
313bc952696SBarry Smith 
314dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
315dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
3163d1d12c6SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostIntegrand(TS,PetscInt,Vec,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscBool,void*);
317dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
318022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);
319d4aa0a58SBarry Smith 
320a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
321a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
322a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
323a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
324a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
325a05bf03eSHong Zhang 
3265bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
3272c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
32873b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
329d4aa0a58SBarry Smith 
3305bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
33173b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
332f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
333d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
334d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
335999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
336715f1b00SHong Zhang 
33713b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
33813b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
33913b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
34013b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
341715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*);
342715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*);
343715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
344999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
345715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
346c235aa8dSHong Zhang 
347618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
348618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
349618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
350618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
35149354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
352f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);
353818ad0c1SBarry Smith 
354aaa6c58dSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetTime[Step]")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
35519eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetMax{Steps|Time}") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
35619eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetMax{Steps|Time}") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
3575c5f5948SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
3584f4e0956SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
35919eac22cSLisandro Dalcin 
360721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
361cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
36283a4ac43SBarry Smith 
36383a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
36483a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
36583a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
36683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
3672d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
36883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
3690ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);
37083a4ac43SBarry Smith 
371721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
3729110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
3739110b2e7SHong Zhang 
374721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
375014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
376014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
377fb1732b5SBarry Smith 
378014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS);
3797cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
380014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
381cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
382e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
383e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
384014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
385d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
386487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
3875ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
3885ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
389cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
390cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
391cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
392cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
393cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
394dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
39524655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS);
396d2daff3dSHong Zhang 
397ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);
398818ad0c1SBarry Smith 
399014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
400014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
401e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
40280275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
40380275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
40480275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
40580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);
406818ad0c1SBarry Smith 
407638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
408d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
409014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
412014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
413e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
414818ad0c1SBarry Smith 
415ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
416ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
417d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
418d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
419ef20d060SBarry Smith 
420638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
421d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
422014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
423014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
424014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
425014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
426316643e7SJed Brown 
427efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
428efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
429efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
430efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
431efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
432efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
433efe9872eSLisandro Dalcin 
434545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
435545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
436545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
4371d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
4381d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
439d9194312SHong Zhang 
440014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
441d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
442014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
443d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
4441c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
4459b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
446847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
447e34be4c2SBarry Smith 
448014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
449b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
4509be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
451c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
452014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
453014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS);
454b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
4559be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
456c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
457014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS);
458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
460c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
4617453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4627453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4637453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
4648a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4658a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
4668a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
467014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
468014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
469d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
470d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
471000e7ae3SMatthew Knepley 
472014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
4738d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
474014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
475014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
476014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
4778d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
478014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
479014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
480014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
48121c89e3eSBarry Smith 
482014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
4831d6018f0SLisandro Dalcin 
484014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
485d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
486014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
487d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
488efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
489efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
490f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
491818ad0c1SBarry Smith 
492014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
493d6ebe24aSShri Abhyankar 
494967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
49524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
49624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
49724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
49824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
49924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
50024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
50124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
50224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
503efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
504efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
505efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
506efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
507efe9872eSLisandro Dalcin 
508ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
509ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
510d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
511d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
512924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
513924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
5140163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **);
5159b7cd975SBarry Smith 
516d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
517d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
518d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
5196c6b9e74SPeter Brune 
5206c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5216c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
5226c6b9e74SPeter Brune 
5236c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
524d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
5256c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
526d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
5276c6b9e74SPeter Brune 
5286c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
529d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
5306c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
531d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
5326c6b9e74SPeter Brune 
533b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
534560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*);
5356dbbd306SMatthew G. Knepley 
536be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
537d1212d36SBarry Smith typedef struct {
538d1212d36SBarry Smith   Vec            ray;
539d1212d36SBarry Smith   VecScatter     scatter;
540d1212d36SBarry Smith   PetscViewer    viewer;
54151b4a12fSMatthew G. Knepley   TSMonitorLGCtx lgctx;
542d1212d36SBarry Smith } TSMonitorDMDARayCtx;
543d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
544d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
54551b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
546d1212d36SBarry Smith 
547bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
548140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList;
54919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
55019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
551bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
55230de9b25SBarry Smith 
553014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
554deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
555014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
556818ad0c1SBarry Smith 
557014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
55855849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
559685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
56039c6b90dSHong Zhang PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
56155849f57SBarry Smith 
56255849f57SBarry Smith #define TS_FILE_CLASSID 1211225
56321c89e3eSBarry Smith 
564014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
565014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
56621c89e3eSBarry Smith 
567a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
568a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
5694f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
5704f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
57131152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
572b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
573e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
574a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
575a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
5767684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
5777684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
5784f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
579201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
580201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
581edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);
582ef20d060SBarry Smith 
583b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
584b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
585b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
586b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
587b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
588b3d3934dSBarry Smith 
5898189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
5908189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
5918189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
5928189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
5933914022bSBarry Smith 
5942589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
5956427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
59676bdecfbSBarry Smith /*J
597815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
598815f1ad5SJed Brown 
599815f1ad5SJed Brown    Level: beginner
600815f1ad5SJed Brown 
601815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
60276bdecfbSBarry Smith J*/
60319fd82e9SBarry Smith typedef const char* TSSSPType;
604815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
605815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
606815f1ad5SJed Brown #define TSSSPRK104 "rk104"
607815f1ad5SJed Brown 
60819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
60919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
610014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
611014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
612787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
613560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
614013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList;
615815f1ad5SJed Brown 
616ed657a08SJed Brown /*S
61784df9cb4SJed Brown    TSAdapt - Abstract object that manages time-step adaptivity
61884df9cb4SJed Brown 
61984df9cb4SJed Brown    Level: beginner
62084df9cb4SJed Brown 
62184df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType
62284df9cb4SJed Brown S*/
62384df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt;
62484df9cb4SJed Brown 
62584df9cb4SJed Brown /*E
6268f6c3df8SBarry Smith     TSAdaptType - String with the name of TSAdapt scheme.
62784df9cb4SJed Brown 
62884df9cb4SJed Brown    Level: beginner
62984df9cb4SJed Brown 
63084df9cb4SJed Brown .seealso: TSAdaptSetType(), TS
63184df9cb4SJed Brown E*/
632f8963224SJed Brown typedef const char *TSAdaptType;
633b0f836d7SJed Brown #define TSADAPTNONE    "none"
6341917a363SLisandro Dalcin #define TSADAPTBASIC   "basic"
635cb7ab186SLisandro Dalcin #define TSADAPTDSP     "dsp"
6368d59e960SJed Brown #define TSADAPTCFL     "cfl"
6371917a363SLisandro Dalcin #define TSADAPTGLEE    "glee"
638d949e4a4SStefano Zampini #define TSADAPTHISTORY "history"
63984df9cb4SJed Brown 
640552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
641bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
642607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
643014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
644014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
64519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
646d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
647014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
648014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
649014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
650014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
651014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
652b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
653014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
654ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
6554416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
656099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
657014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
658014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
659bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
6601917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
6611917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
6621917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
6631917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
664014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
6651917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
666b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
667d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
668cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
669cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);
67084df9cb4SJed Brown 
67184df9cb4SJed Brown /*S
67226d28e4eSEmil Constantinescu    TSGLLEAdapt - Abstract object that manages time-step adaptivity
673ed657a08SJed Brown 
674ed657a08SJed Brown    Level: beginner
675ed657a08SJed Brown 
67684df9cb4SJed Brown    Developer Notes:
67784df9cb4SJed Brown    This functionality should be replaced by the TSAdapt.
67884df9cb4SJed Brown 
67926d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
680ed657a08SJed Brown S*/
68126d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
682ed657a08SJed Brown 
68376bdecfbSBarry Smith /*J
68426d28e4eSEmil Constantinescu     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
685ed657a08SJed Brown 
686ed657a08SJed Brown    Level: beginner
687ed657a08SJed Brown 
68826d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS
68976bdecfbSBarry Smith J*/
69026d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType;
69126d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none"
69226d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size"
69326d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both"
694ed657a08SJed Brown 
69526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
69626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
69726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
69826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
69926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
70026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
70126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
70226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
70326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
70426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
705ed657a08SJed Brown 
70676bdecfbSBarry Smith /*J
70726d28e4eSEmil Constantinescu     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
708ed657a08SJed Brown 
709ed657a08SJed Brown    Level: beginner
710ed657a08SJed Brown 
71126d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS
71276bdecfbSBarry Smith J*/
71326d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType;
71426d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always"
715ed657a08SJed Brown 
71626d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
71726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
718ed657a08SJed Brown 
71976bdecfbSBarry Smith /*J
72026d28e4eSEmil Constantinescu   TSGLLEType - family of time integration method within the General Linear class
72118b56cb9SJed Brown 
72218b56cb9SJed Brown   Level: beginner
72318b56cb9SJed Brown 
72426d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister()
72576bdecfbSBarry Smith J*/
72626d28e4eSEmil Constantinescu typedef const char* TSGLLEType;
72726d28e4eSEmil Constantinescu #define TSGLLE_IRKS   "irks"
72818b56cb9SJed Brown 
72926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
73026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
73126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
73226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
73326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
73426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
73518b56cb9SJed Brown 
736020d8f30SJed Brown /*J
7377d5697caSHong Zhang     TSEIMEXType - String with the name of an Extrapolated IMEX method.
7387d5697caSHong Zhang 
7397d5697caSHong Zhang    Level: beginner
7407d5697caSHong Zhang 
7417d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
7427d5697caSHong Zhang J*/
7437d5697caSHong Zhang #define TSEIMEXType   char*
7447d5697caSHong Zhang 
7457d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
7467d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
7477d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
7487d5697caSHong Zhang 
7497d5697caSHong Zhang /*J
750f68a32c8SEmil Constantinescu     TSRKType - String with the name of a Runge-Kutta method.
751f68a32c8SEmil Constantinescu 
752f68a32c8SEmil Constantinescu    Level: beginner
753f68a32c8SEmil Constantinescu 
754f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
755f68a32c8SEmil Constantinescu J*/
756f68a32c8SEmil Constantinescu typedef const char* TSRKType;
757f68a32c8SEmil Constantinescu #define TSRK1FE   "1fe"
758fdefd5e5SDebojyoti Ghosh #define TSRK2A    "2a"
759f68a32c8SEmil Constantinescu #define TSRK3     "3"
760fdefd5e5SDebojyoti Ghosh #define TSRK3BS   "3bs"
761f68a32c8SEmil Constantinescu #define TSRK4     "4"
762fdefd5e5SDebojyoti Ghosh #define TSRK5F    "5f"
763fdefd5e5SDebojyoti Ghosh #define TSRK5DP   "5dp"
76405e23783SLisandro Dalcin #define TSRK5BS   "5bs"
76505e23783SLisandro Dalcin 
766f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
767f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
768f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
769f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
770f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
771560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
772f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
773f68a32c8SEmil Constantinescu 
774f68a32c8SEmil Constantinescu /*J
775b6a60446SDebojyoti Ghosh     TSGLEEType - String with the name of a General Linear with Error Estimation method.
776b6a60446SDebojyoti Ghosh 
777b6a60446SDebojyoti Ghosh    Level: beginner
778b6a60446SDebojyoti Ghosh 
779b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
780b6a60446SDebojyoti Ghosh J*/
781b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType;
782ab8c5912SEmil Constantinescu #define TSGLEEi1      "BE1"
783b6a60446SDebojyoti Ghosh #define TSGLEE23      "23"
784b6a60446SDebojyoti Ghosh #define TSGLEE24      "24"
785b6a60446SDebojyoti Ghosh #define TSGLEE25I     "25i"
786b6a60446SDebojyoti Ghosh #define TSGLEE35      "35"
787b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A  "exrk2a"
788b6a60446SDebojyoti Ghosh #define TSGLEERK32G1  "rk32g1"
789b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex"
790b6a60446SDebojyoti Ghosh /*J
791b6a60446SDebojyoti Ghosh     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
792b6a60446SDebojyoti Ghosh 
793b6a60446SDebojyoti Ghosh    Level: beginner
794b6a60446SDebojyoti Ghosh 
795b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
796b6a60446SDebojyoti Ghosh J*/
797b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
798b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
79957df6a1bSDebojyoti 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[]);
800b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
801b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
802b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
803b6a60446SDebojyoti Ghosh 
804b6a60446SDebojyoti Ghosh /*J
805020d8f30SJed Brown     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
806020d8f30SJed Brown 
807020d8f30SJed Brown    Level: beginner
808020d8f30SJed Brown 
809020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
810020d8f30SJed Brown J*/
81119fd82e9SBarry Smith typedef const char* TSARKIMEXType;
812e817cc15SEmil Constantinescu #define TSARKIMEX1BEE   "1bee"
8131f80e275SEmil Constantinescu #define TSARKIMEXA2     "a2"
8141f80e275SEmil Constantinescu #define TSARKIMEXL2     "l2"
8151f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122"
8161f80e275SEmil Constantinescu #define TSARKIMEX2C     "2c"
8178a381b04SJed Brown #define TSARKIMEX2D     "2d"
818a3a57f36SJed Brown #define TSARKIMEX2E     "2e"
8196cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2"
8208a381b04SJed Brown #define TSARKIMEX3      "3"
8216cf0794eSJed Brown #define TSARKIMEXBPR3   "bpr3"
8226cf0794eSJed Brown #define TSARKIMEXARS443 "ars443"
8238a381b04SJed Brown #define TSARKIMEX4      "4"
8248a381b04SJed Brown #define TSARKIMEX5      "5"
82519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
82619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
827014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
82819fd82e9SBarry 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[]);
829607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
830560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
831014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
8328a381b04SJed Brown 
833020d8f30SJed Brown /*J
834020d8f30SJed Brown     TSRosWType - String with the name of a Rosenbrock-W method.
835020d8f30SJed Brown 
836020d8f30SJed Brown    Level: beginner
837020d8f30SJed Brown 
838020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
839020d8f30SJed Brown J*/
84019fd82e9SBarry Smith typedef const char* TSRosWType;
84161692a83SJed Brown #define TSROSW2M          "2m"
84261692a83SJed Brown #define TSROSW2P          "2p"
843fe7e6d57SJed Brown #define TSROSWRA3PW       "ra3pw"
844fe7e6d57SJed Brown #define TSROSWRA34PW2     "ra34pw2"
845ef3c5b88SJed Brown #define TSROSWRODAS3      "rodas3"
846ef3c5b88SJed Brown #define TSROSWSANDU3      "sandu3"
847961f28d0SJed Brown #define TSROSWASSP3P3S1C  "assp3p3s1c"
848961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c"
84943b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
850753f8adbSEmil Constantinescu #define TSROSWARK3        "ark3"
8513606a31eSEmil Constantinescu #define TSROSWTHETA1      "theta1"
8523606a31eSEmil Constantinescu #define TSROSWTHETA2      "theta2"
85342faf41dSJed Brown #define TSROSWGRK4T       "grk4t"
85442faf41dSJed Brown #define TSROSWSHAMP4      "shamp4"
85542faf41dSJed Brown #define TSROSWVELDD4      "veldd4"
85642faf41dSJed Brown #define TSROSW4L          "4l"
857b1c69cc3SEmil Constantinescu 
8586bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
8596bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
860014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
86119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
86219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
863607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
864560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
865014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
866e27a552bSJed Brown 
867211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
868211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
869211a84d6SLisandro Dalcin 
8706bd7aeb5SHong Zhang /*J
871e49d4f37SHong Zhang   TSBasicSymplecticType - String with the name of a basic symplectic integration method.
8726bd7aeb5SHong Zhang 
8736bd7aeb5SHong Zhang   Level: beginner
8746bd7aeb5SHong Zhang 
875e49d4f37SHong Zhang   .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister()
8766bd7aeb5SHong Zhang J*/
877e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType;
878e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER   "1"
879e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2"
880e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3         "3"
881e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4         "4"
882e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
883e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
884e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
885e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
886e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
887e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);
8886bd7aeb5SHong Zhang 
88983e2fdc7SBarry Smith /*
8900f3b3ca1SHong Zhang        PETSc interface to Sundials
89183e2fdc7SBarry Smith */
8926dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS
8936fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
8946a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[];
8956fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
8966a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
897014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
898014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
899014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
900014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
901014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
902014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
903014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
904014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
905014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
906014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
907014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
908014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
9096dc17ff5SMatthew Knepley #endif
91083e2fdc7SBarry Smith 
911014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
912014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
913014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
914014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
9150de4c49aSJed Brown 
916014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
917014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
918014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
91988df8a41SLisandro Dalcin 
920818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
921818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
922818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
923818efac9SLisandro Dalcin 
924014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
925014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
9266c699258SBarry Smith 
927014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
928d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
9290f5c6efeSJed Brown 
930f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
931f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
932818ad0c1SBarry Smith #endif
933