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