xref: /petsc/include/petscts.h (revision 3d96e9964ff330fd2a9eee374bcd4376da7efe60) 
1 /*
2    User interface for the timestepping package. This package
3    is for use in solving time-dependent PDEs.
4 */
5 #if !defined(__PETSCTS_H)
6 #define __PETSCTS_H
7 #include <petscsnes.h>
8 
9 /*S
10      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
11 
12    Level: beginner
13 
14   Concepts: ODE solvers
15 
16 .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
17 S*/
18 typedef struct _p_TS* TS;
19 
20 /*J
21     TSType - String with the name of a PETSc TS method.
22 
23    Level: beginner
24 
25 .seealso: TSSetType(), TS, TSRegister()
26 J*/
27 typedef const char* TSType;
28 #define TSEULER           "euler"
29 #define TSBEULER          "beuler"
30 #define TSPSEUDO          "pseudo"
31 #define TSCN              "cn"
32 #define TSSUNDIALS        "sundials"
33 #define TSRK              "rk"
34 #define TSPYTHON          "python"
35 #define TSTHETA           "theta"
36 #define TSALPHA           "alpha"
37 #define TSALPHA2          "alpha2"
38 #define TSGLLE            "glle"
39 #define TSGLEE            "glee"
40 #define TSSSP             "ssp"
41 #define TSARKIMEX         "arkimex"
42 #define TSROSW            "rosw"
43 #define TSEIMEX           "eimex"
44 #define TSMIMEX           "mimex"
45 #define TSBDF             "bdf"
46 
47 /*E
48     TSProblemType - Determines the type of problem this TS object is to be used to solve
49 
50    Level: beginner
51 
52 .seealso: TSCreate()
53 E*/
54 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
55 
56 /*E
57    TSEquationType - type of TS problem that is solved
58 
59    Level: beginner
60 
61    Developer Notes: this must match petsc/finclude/petscts.h
62 
63    Supported types are:
64      TS_EQ_UNSPECIFIED (default)
65      TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0
66      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0
67 
68 .seealso: TSGetEquationType(), TSSetEquationType()
69 E*/
70 typedef enum {
71   TS_EQ_UNSPECIFIED               = -1,
72   TS_EQ_EXPLICIT                  = 0,
73   TS_EQ_ODE_EXPLICIT              = 1,
74   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
75   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
76   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
77   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
78   TS_EQ_IMPLICIT                  = 1000,
79   TS_EQ_ODE_IMPLICIT              = 1001,
80   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
81   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
82   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
83   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
84 } TSEquationType;
85 PETSC_EXTERN const char *const*TSEquationTypes;
86 
87 /*E
88    TSConvergedReason - reason a TS method has converged or not
89 
90    Level: beginner
91 
92    Developer Notes: this must match petsc/finclude/petscts.h
93 
94    Each reason has its own manual page.
95 
96 .seealso: TSGetConvergedReason()
97 E*/
98 typedef enum {
99   TS_CONVERGED_ITERATING      = 0,
100   TS_CONVERGED_TIME           = 1,
101   TS_CONVERGED_ITS            = 2,
102   TS_CONVERGED_USER           = 3,
103   TS_CONVERGED_EVENT          = 4,
104   TS_CONVERGED_PSEUDO_FATOL   = 5,
105   TS_CONVERGED_PSEUDO_FRTOL   = 6,
106   TS_DIVERGED_NONLINEAR_SOLVE = -1,
107   TS_DIVERGED_STEP_REJECTED   = -2
108 } TSConvergedReason;
109 PETSC_EXTERN const char *const*TSConvergedReasons;
110 
111 /*MC
112    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()
113 
114    Level: beginner
115 
116 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
117 M*/
118 
119 /*MC
120    TS_CONVERGED_TIME - the final time was reached
121 
122    Level: beginner
123 
124 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration(), TSGetSolveTime()
125 M*/
126 
127 /*MC
128    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time
129 
130    Level: beginner
131 
132 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration()
133 M*/
134 
135 /*MC
136    TS_CONVERGED_USER - user requested termination
137 
138    Level: beginner
139 
140 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration()
141 M*/
142 
143 /*MC
144    TS_CONVERGED_EVENT - user requested termination on event detection
145 
146    Level: beginner
147 
148 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration()
149 M*/
150 
151 /*MC
152    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO
153 
154    Level: beginner
155 
156    Options Database:
157 .   -ts_pseudo_frtol <rtol>
158 
159 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration(), TS_CONVERGED_PSEUDO_FATOL
160 M*/
161 
162 /*MC
163    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO
164 
165    Level: beginner
166 
167    Options Database:
168 .   -ts_pseudo_fatol <atol>
169 
170 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration(), TS_CONVERGED_PSEUDO_FRTOL
171 M*/
172 
173 /*MC
174    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed
175 
176    Level: beginner
177 
178    Notes: See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.
179 
180 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
181 M*/
182 
183 /*MC
184    TS_DIVERGED_STEP_REJECTED - too many steps were rejected
185 
186    Level: beginner
187 
188    Notes: See TSSetMaxStepRejections() for how to allow more step rejections.
189 
190 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
191 M*/
192 
193 /*E
194    TSExactFinalTimeOption - option for handling of final time step
195 
196    Level: beginner
197 
198    Developer Notes: this must match petsc/finclude/petscts.h
199 
200 $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
201 $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
202 $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time
203 
204 .seealso: TSGetConvergedReason(), TSSetExactFinalTime()
205 
206 E*/
207 typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
208 PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
209 
210 /* Logging support */
211 PETSC_EXTERN PetscClassId TS_CLASSID;
212 PETSC_EXTERN PetscClassId DMTS_CLASSID;
213 PETSC_EXTERN PetscClassId TSADAPT_CLASSID;
214 
215 PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
216 PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);
217 
218 PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
219 PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
220 PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
221 
222 PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
223 PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
224 PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
225 PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
226 PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
227 PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
228 
229 PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
230 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
231 PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
232 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
233 
234 PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
235 PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
236 PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
237 PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
238 PETSC_EXTERN PetscErrorCode TSSetUp(TS);
239 PETSC_EXTERN PetscErrorCode TSReset(TS);
240 
241 PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
242 PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
243 
244 PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
245 PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);
246 
247 PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
248 PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
249 PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
250 PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);
251 
252 /*S
253      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/ADE at each time step)
254 
255    Level: advanced
256 
257   Concepts: ODE solvers, trajectory
258 
259 .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy()
260 S*/
261 typedef struct _p_TSTrajectory* TSTrajectory;
262 
263 /*J
264     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method
265 
266    Level: intermediate
267 
268 .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy()
269 J*/
270 typedef const char* TSTrajectoryType;
271 #define TSTRAJECTORYBASIC         "basic"
272 #define TSTRAJECTORYSINGLEFILE    "singlefile"
273 #define TSTRAJECTORYMEMORY        "memory"
274 #define TSTRAJECTORYVISUALIZATION "visualization"
275 
276 PETSC_EXTERN PetscFunctionList TSTrajectoryList;
277 PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
278 PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
279 
280 PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
281 
282 PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
283 PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
284 PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
285 PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,const TSTrajectoryType);
286 PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
287 PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
288 PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
289 PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
290 PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
291 PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
292 PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
293 PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
294 PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
295 PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);
296 
297 PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
298 PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
299 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*);
300 PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
301 PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);
302 
303 PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
304 PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
305 PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
306 
307 PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
308 PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
309 PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
310 PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
311 PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
312 PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);
313 
314 PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Vec*,PetscInt,Vec*);
315 PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Vec**,PetscInt*,Vec**);
316 PETSC_EXTERN PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *,Vec *);
317 PETSC_EXTERN PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **,Vec **);
318 PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*);
319 PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*);
320 PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
321 PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
322 PETSC_EXTERN PetscErrorCode TSForwardStep(TS);
323 
324 PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
325 PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
326 PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
327 
328 PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
329 
330 typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
331 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
332 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
333 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
334 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
335 PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
336 
337 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
338 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
339 
340 PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
341 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
342 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
343 
344 PETSC_EXTERN PetscErrorCode TSStep(TS);
345 PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
346 PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
347 PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
348 PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
349 PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
350 PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
351 PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
352 PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
353 PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
354 PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
355 PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
356 PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
357 PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
358 PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
359 PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
360 PETSC_EXTERN PetscErrorCode TSRollBack(TS);
361 PETSC_EXTERN PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
362 
363 PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);
364 
365 PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
366 PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
367 PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
368 PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
369 PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
370 PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
371 PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
372 
373 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
374 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
375 PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
376 PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
377 PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
378 PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
379 PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
380 
381 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
382 PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
383 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
384 PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);
385 
386 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
387 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
388 PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
389 PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
390 PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
391 PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
392 
393 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
394 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
395 PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
396 PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
397 PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
398 PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);
399 
400 PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
401 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
402 PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
403 PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
404 PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
405 PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
406 PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
407 
408 PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
409 PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
410 PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
411 PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
412 PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
413 PETSC_EXTERN PetscErrorCode TSPreStep(TS);
414 PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
415 PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
416 PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
417 PETSC_EXTERN PetscErrorCode TSPostStep(TS);
418 PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
419 PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
420 PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
421 PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
422 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
423 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
424 PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
425 PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
426 PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
427 PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
428 PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
429 PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
430 PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
431 
432 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
433 PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
434 PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
435 PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
436 PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
437 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
438 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
439 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
440 PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
441 
442 PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
443 
444 PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
445 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
446 PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
447 PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
448 PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
449 PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
450 PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
451 
452 PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
453 
454 PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
455 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
456 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
457 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
458 PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
459 PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
460 PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
461 PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
462 PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
463 PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
464 PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
465 PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
466 PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);
467 
468 PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
469 PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
470 PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
471 PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
472 PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
473 PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
474 PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **);
475 
476 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
477 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
478 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
479 
480 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
481 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
482 
483 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
484 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
485 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
486 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
487 
488 PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
489 PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
490 PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
491 PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
492 
493 PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
494 PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*);
495 
496 typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
497 typedef struct {
498   Vec            ray;
499   VecScatter     scatter;
500   PetscViewer    viewer;
501   TSMonitorLGCtx lgctx;
502 } TSMonitorDMDARayCtx;
503 PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
504 PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
505 PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
506 
507 /* Dynamic creation and loading functions */
508 PETSC_EXTERN PetscFunctionList TSList;
509 PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
510 PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
511 PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
512 
513 PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
514 PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
515 PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
516 
517 PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
518 PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
519 PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
520 PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
521 
522 #define TS_FILE_CLASSID 1211225
523 
524 PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
525 PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
526 
527 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
528 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
529 PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
530 PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
531 PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
532 PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
533 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
534 PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
535 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
536 PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
537 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
538 PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
539 PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
540 PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
541 
542 typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
543 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
544 PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
545 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
546 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
547 
548 typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
549 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
550 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
551 PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
552 
553 PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
554 PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
555 /*J
556    TSSSPType - string with the name of TSSSP scheme.
557 
558    Level: beginner
559 
560 .seealso: TSSSPSetType(), TS
561 J*/
562 typedef const char* TSSSPType;
563 #define TSSSPRKS2  "rks2"
564 #define TSSSPRKS3  "rks3"
565 #define TSSSPRK104 "rk104"
566 
567 PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
568 PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
569 PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
570 PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
571 PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
572 PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
573 PETSC_EXTERN PetscFunctionList TSSSPList;
574 
575 /*S
576    TSAdapt - Abstract object that manages time-step adaptivity
577 
578    Level: beginner
579 
580 .seealso: TS, TSAdaptCreate(), TSAdaptType
581 S*/
582 typedef struct _p_TSAdapt *TSAdapt;
583 
584 /*E
585     TSAdaptType - String with the name of TSAdapt scheme.
586 
587    Level: beginner
588 
589 .seealso: TSAdaptSetType(), TS
590 E*/
591 typedef const char *TSAdaptType;
592 #define TSADAPTNONE  "none"
593 #define TSADAPTBASIC "basic"
594 #define TSADAPTCFL   "cfl"
595 #define TSADAPTGLEE  "glee"
596 
597 PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
598 PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
599 PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
600 PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
601 PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
602 PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
603 PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
604 PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
605 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
606 PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
607 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
608 PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
609 PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
610 PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
611 PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
612 PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
613 PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
614 PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
615 PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
616 PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
617 PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
618 PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
619 PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
620 PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
621 PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
622 PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
623 PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
624 
625 /*S
626    TSGLLEAdapt - Abstract object that manages time-step adaptivity
627 
628    Level: beginner
629 
630    Developer Notes:
631    This functionality should be replaced by the TSAdapt.
632 
633 .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
634 S*/
635 typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;
636 
637 /*J
638     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme
639 
640    Level: beginner
641 
642 .seealso: TSGLLEAdaptSetType(), TS
643 J*/
644 typedef const char *TSGLLEAdaptType;
645 #define TSGLLEADAPT_NONE "none"
646 #define TSGLLEADAPT_SIZE "size"
647 #define TSGLLEADAPT_BOTH "both"
648 
649 PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
650 PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
651 PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
652 PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
653 PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
654 PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
655 PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
656 PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
657 PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
658 PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);
659 
660 /*J
661     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme
662 
663    Level: beginner
664 
665 .seealso: TSGLLESetAcceptType(), TS
666 J*/
667 typedef const char *TSGLLEAcceptType;
668 #define TSGLLEACCEPT_ALWAYS "always"
669 
670 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
671 PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);
672 
673 /*J
674   TSGLLEType - family of time integration method within the General Linear class
675 
676   Level: beginner
677 
678 .seealso: TSGLLESetType(), TSGLLERegister()
679 J*/
680 typedef const char* TSGLLEType;
681 #define TSGLLE_IRKS   "irks"
682 
683 PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
684 PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
685 PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
686 PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
687 PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
688 PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);
689 
690 /*J
691     TSEIMEXType - String with the name of an Extrapolated IMEX method.
692 
693    Level: beginner
694 
695 .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
696 J*/
697 #define TSEIMEXType   char*
698 
699 PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
700 PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
701 PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
702 
703 /*J
704     TSRKType - String with the name of a Runge-Kutta method.
705 
706    Level: beginner
707 
708 .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
709 J*/
710 typedef const char* TSRKType;
711 #define TSRK1FE   "1fe"
712 #define TSRK2A    "2a"
713 #define TSRK3     "3"
714 #define TSRK3BS   "3bs"
715 #define TSRK4     "4"
716 #define TSRK5F    "5f"
717 #define TSRK5DP   "5dp"
718 #define TSRK5BS   "5bs"
719 
720 PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
721 PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
722 PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
723 PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
724 PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
725 PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
726 PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
727 
728 /*J
729     TSGLEEType - String with the name of a General Linear with Error Estimation method.
730 
731    Level: beginner
732 
733 .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
734 J*/
735 typedef const char* TSGLEEType;
736 #define TSGLEEi1      "BE1"
737 #define TSGLEE23      "23"
738 #define TSGLEE24      "24"
739 #define TSGLEE25I     "25i"
740 #define TSGLEE35      "35"
741 #define TSGLEEEXRK2A  "exrk2a"
742 #define TSGLEERK32G1  "rk32g1"
743 #define TSGLEERK285EX "rk285ex"
744 /*J
745     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.
746 
747    Level: beginner
748 
749 .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
750 J*/
751 PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
752 PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
753 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[]);
754 PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
755 PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
756 PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);
757 
758 /*J
759     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
760 
761    Level: beginner
762 
763 .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
764 J*/
765 typedef const char* TSARKIMEXType;
766 #define TSARKIMEX1BEE   "1bee"
767 #define TSARKIMEXA2     "a2"
768 #define TSARKIMEXL2     "l2"
769 #define TSARKIMEXARS122 "ars122"
770 #define TSARKIMEX2C     "2c"
771 #define TSARKIMEX2D     "2d"
772 #define TSARKIMEX2E     "2e"
773 #define TSARKIMEXPRSSP2 "prssp2"
774 #define TSARKIMEX3      "3"
775 #define TSARKIMEXBPR3   "bpr3"
776 #define TSARKIMEXARS443 "ars443"
777 #define TSARKIMEX4      "4"
778 #define TSARKIMEX5      "5"
779 PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
780 PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
781 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
782 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[]);
783 PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
784 PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
785 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
786 
787 /*J
788     TSRosWType - String with the name of a Rosenbrock-W method.
789 
790    Level: beginner
791 
792 .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
793 J*/
794 typedef const char* TSRosWType;
795 #define TSROSW2M          "2m"
796 #define TSROSW2P          "2p"
797 #define TSROSWRA3PW       "ra3pw"
798 #define TSROSWRA34PW2     "ra34pw2"
799 #define TSROSWRODAS3      "rodas3"
800 #define TSROSWSANDU3      "sandu3"
801 #define TSROSWASSP3P3S1C  "assp3p3s1c"
802 #define TSROSWLASSP3P4S2C "lassp3p4s2c"
803 #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
804 #define TSROSWARK3        "ark3"
805 #define TSROSWTHETA1      "theta1"
806 #define TSROSWTHETA2      "theta2"
807 #define TSROSWGRK4T       "grk4t"
808 #define TSROSWSHAMP4      "shamp4"
809 #define TSROSWVELDD4      "veldd4"
810 #define TSROSW4L          "4l"
811 
812 PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*);
813 PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType);
814 PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
815 PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
816 PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
817 PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
818 PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
819 PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
820 
821 PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
822 PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);
823 
824 /*
825        PETSc interface to Sundials
826 */
827 #ifdef PETSC_HAVE_SUNDIALS
828 typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
829 PETSC_EXTERN const char *const TSSundialsLmmTypes[];
830 typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
831 PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
832 PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
833 PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
834 PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
835 PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
836 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
837 PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
838 PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
839 PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
840 PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
841 PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
842 PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
843 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
844 #endif
845 
846 PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
847 PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
848 PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
849 PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
850 
851 PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
852 PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
853 PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
854 
855 PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
856 PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
857 PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
858 
859 PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
860 PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
861 
862 PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
863 PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
864 
865 #endif
866