xref: /petsc/include/petscts.h (revision e52336cb213eafb6e0bc1e6a0d4ebe153339e097)
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 .seealso: TSGetConvergedReason(), TSSetExactFinalTime()
200 
201 E*/
202 typedef enum {TS_EXACTFINALTIME_STEPOVER=0,TS_EXACTFINALTIME_INTERPOLATE=1,TS_EXACTFINALTIME_MATCHSTEP=2} TSExactFinalTimeOption;
203 PETSC_EXTERN const char *const TSExactFinalTimeOptions[];
204 
205 
206 /* Logging support */
207 PETSC_EXTERN PetscClassId TS_CLASSID;
208 PETSC_EXTERN PetscClassId DMTS_CLASSID;
209 
210 PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
211 
212 PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
213 PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
214 PETSC_EXTERN PetscErrorCode TSDestroy(TS*);
215 
216 PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
217 PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
218 PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
219 PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
220 PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);
221 
222 PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
223 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
224 PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
225 
226 
227 PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
228 PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
229 PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
230 PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
231 PETSC_EXTERN PetscErrorCode TSSetUp(TS);
232 PETSC_EXTERN PetscErrorCode TSReset(TS);
233 
234 PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
235 PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);
236 
237 /*S
238      TSTrajectory - Abstract PETSc object that storing the trajectory (solution of ODE/ADE at each time step and stage)
239 
240    Level: advanced
241 
242   Concepts: ODE solvers, adjoint
243 
244 .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
245 S*/
246 typedef struct _p_TSTrajectory* TSTrajectory;
247 
248 /*J
249     TSTrajectoryType - String with the name of a PETSc TS trajectory storage method
250 
251    Level: intermediate
252 
253 .seealso: TSSetType(), TS, TSRegister(), TSTrajectoryCreate(), TSTrajectorySetType()
254 J*/
255 typedef const char* TSTrajectoryType;
256 #define TSTRAJECTORYBASIC      "basic"
257 #define TSTRAJECTORYSINGLEFILE "singlefile"
258 
259 PETSC_EXTERN PetscFunctionList TSTrajectoryList;
260 PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
261 PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;
262 
263 PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
264 
265 PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
266 PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
267 PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,const TSTrajectoryType);
268 PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
269 PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
270 PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory);
271 PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
272 
273 PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
274 PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
275 PETSC_EXTERN PetscErrorCode TSSetCostIntegrand(TS,PetscInt,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),void*);
276 PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
277 
278 PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
279 PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
280 PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);
281 
282 PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
283 PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
284 PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
285 PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
286 PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
287 PETSC_EXTERN PetscErrorCode TSAdjointComputeCostIntegrand(TS,PetscReal,Vec,Vec);
288 
289 PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
290 PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
291 PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
292 
293 PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*);
294 
295 typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
296 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
297 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
298 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
299 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
300 PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
301 
302 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void *);
303 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);
304 
305 PETSC_EXTERN PetscErrorCode TSMonitorSolutionBinary(TS,PetscInt,PetscReal,Vec,void*);
306 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
307 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);
308 
309 PETSC_EXTERN PetscErrorCode TSStep(TS);
310 PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
311 PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
312 PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
313 PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
314 PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
315 PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
316 PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
317 PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
318 PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
319 PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
320 PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
321 PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
322 PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
323 PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
324 PETSC_EXTERN PetscErrorCode TSRollBack(TS);
325 PETSC_EXTERN PetscErrorCode TSGetTotalSteps(TS,PetscInt*);
326 
327 PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);
328 
329 PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
330 PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
331 PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
332 PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
333 PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
334 PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
335 PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
336 
337 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
338 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
339 PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
340 PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
341 PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
342 PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
343 PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);
344 
345 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
346 PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
347 PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,PetscErrorCode (*)(TS,PetscReal,Vec,void*),void*);
348 
349 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
350 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
351 PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
352 PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
353 PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
354 PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
355 
356 PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
357 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
358 PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
359 PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
360 PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
361 PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
362 PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
363 
364 PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
365 PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
366 PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
367 PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
368 PETSC_EXTERN PetscErrorCode TSPreStep(TS);
369 PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
370 PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
371 PETSC_EXTERN PetscErrorCode TSPostStep(TS);
372 PETSC_EXTERN PetscErrorCode TSSetRetainStages(TS,PetscBool);
373 PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
374 PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
375 PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
376 PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*);
377 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*);
378 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*);
379 PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
380 PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
381 PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
382 PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);
383 
384 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
385 PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
386 PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
387 PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
388 
389 PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
390 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
391 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
392 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
393 PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);
394 
395 PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);
396 
397 PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
398 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
399 PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
400 PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
401 PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);
402 
403 PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);
404 
405 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
406 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
407 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
408 PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
409 PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
410 PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
411 PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
412 PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
413 PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
414 PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
415 PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,PetscErrorCode (*)(TS,PetscReal,Vec,void*),void*);
416 PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,PetscErrorCode (**)(TS,PetscReal,Vec,void*),void**);
417 PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
418 PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
419 PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, const PetscReal[], PetscInt, PetscScalar *, void *), void **);
420 
421 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
422 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
423 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);
424 
425 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
426 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
427 
428 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
429 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
430 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
431 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);
432 
433 PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
434 PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
435 PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
436 PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);
437 
438 PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM, Vec *, Vec *, PetscReal *);
439 
440 typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
441 typedef struct {
442   Vec            ray;
443   VecScatter     scatter;
444   PetscViewer    viewer;
445   TSMonitorLGCtx lgctx;
446 } TSMonitorDMDARayCtx;
447 PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
448 PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
449 PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);
450 
451 
452 /* Dynamic creation and loading functions */
453 PETSC_EXTERN PetscFunctionList TSList;
454 PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
455 PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
456 PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));
457 
458 PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
459 PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
460 PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);
461 
462 PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
463 PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
464 PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
465 
466 
467 #define TS_FILE_CLASSID 1211225
468 
469 PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
470 PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);
471 
472 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
473 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
474 PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
475 PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
476 PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
477 PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
478 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
479 PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
480 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
481 PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
482 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
483 PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
484 PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
485 PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
486 
487 typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
488 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
489 PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
490 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
491 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);
492 
493 typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
494 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
495 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
496 PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);
497 
498 PETSC_EXTERN PetscErrorCode TSSetEventMonitor(TS,PetscInt,PetscInt*,PetscBool*,PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar*,void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
499 PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal*);
500 /*J
501    TSSSPType - string with the name of TSSSP scheme.
502 
503    Level: beginner
504 
505 .seealso: TSSSPSetType(), TS
506 J*/
507 typedef const char* TSSSPType;
508 #define TSSSPRKS2  "rks2"
509 #define TSSSPRKS3  "rks3"
510 #define TSSSPRK104 "rk104"
511 
512 PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
513 PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
514 PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
515 PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
516 PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
517 PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
518 
519 /*S
520    TSAdapt - Abstract object that manages time-step adaptivity
521 
522    Level: beginner
523 
524 .seealso: TS, TSAdaptCreate(), TSAdaptType
525 S*/
526 typedef struct _p_TSAdapt *TSAdapt;
527 
528 /*E
529     TSAdaptType - String with the name of TSAdapt scheme.
530 
531    Level: beginner
532 
533 .seealso: TSAdaptSetType(), TS
534 E*/
535 typedef const char *TSAdaptType;
536 #define TSADAPTBASIC "basic"
537 #define TSADAPTNONE  "none"
538 #define TSADAPTCFL   "cfl"
539 
540 PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
541 PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
542 PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
543 PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
544 PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
545 PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
546 PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
547 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
548 PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
549 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
550 PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
551 PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
552 PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
553 PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
554 PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptions*,TSAdapt);
555 PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
556 PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
557 PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
558 PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
559 PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
560 
561 /*S
562    TSGLAdapt - Abstract object that manages time-step adaptivity
563 
564    Level: beginner
565 
566    Developer Notes:
567    This functionality should be replaced by the TSAdapt.
568 
569 .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType
570 S*/
571 typedef struct _p_TSGLAdapt *TSGLAdapt;
572 
573 /*J
574     TSGLAdaptType - String with the name of TSGLAdapt scheme
575 
576    Level: beginner
577 
578 .seealso: TSGLAdaptSetType(), TS
579 J*/
580 typedef const char *TSGLAdaptType;
581 #define TSGLADAPT_NONE "none"
582 #define TSGLADAPT_SIZE "size"
583 #define TSGLADAPT_BOTH "both"
584 
585 PETSC_EXTERN PetscErrorCode TSGLAdaptRegister(const char[],PetscErrorCode (*)(TSGLAdapt));
586 PETSC_EXTERN PetscErrorCode TSGLAdaptInitializePackage(void);
587 PETSC_EXTERN PetscErrorCode TSGLAdaptFinalizePackage(void);
588 PETSC_EXTERN PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*);
589 PETSC_EXTERN PetscErrorCode TSGLAdaptSetType(TSGLAdapt,TSGLAdaptType);
590 PETSC_EXTERN PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]);
591 PETSC_EXTERN PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
592 PETSC_EXTERN PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer);
593 PETSC_EXTERN PetscErrorCode TSGLAdaptSetFromOptions(PetscOptions*,TSGLAdapt);
594 PETSC_EXTERN PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*);
595 
596 /*J
597     TSGLAcceptType - String with the name of TSGLAccept scheme
598 
599    Level: beginner
600 
601 .seealso: TSGLSetAcceptType(), TS
602 J*/
603 typedef const char *TSGLAcceptType;
604 #define TSGLACCEPT_ALWAYS "always"
605 
606 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
607 PETSC_EXTERN PetscErrorCode TSGLAcceptRegister(const char[],TSGLAcceptFunction);
608 
609 /*J
610   TSGLType - family of time integration method within the General Linear class
611 
612   Level: beginner
613 
614 .seealso: TSGLSetType(), TSGLRegister()
615 J*/
616 typedef const char* TSGLType;
617 #define TSGL_IRKS   "irks"
618 
619 PETSC_EXTERN PetscErrorCode TSGLRegister(const char[],PetscErrorCode(*)(TS));
620 PETSC_EXTERN PetscErrorCode TSGLInitializePackage(void);
621 PETSC_EXTERN PetscErrorCode TSGLFinalizePackage(void);
622 PETSC_EXTERN PetscErrorCode TSGLSetType(TS,TSGLType);
623 PETSC_EXTERN PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*);
624 PETSC_EXTERN PetscErrorCode TSGLSetAcceptType(TS,TSGLAcceptType);
625 
626 /*J
627     TSEIMEXType - String with the name of an Extrapolated IMEX method.
628 
629    Level: beginner
630 
631 .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
632 J*/
633 #define TSEIMEXType   char*
634 
635 PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
636 PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
637 PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);
638 
639 /*J
640     TSRKType - String with the name of a Runge-Kutta method.
641 
642    Level: beginner
643 
644 .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
645 J*/
646 typedef const char* TSRKType;
647 #define TSRK1FE   "1fe"
648 #define TSRK2A    "2a"
649 #define TSRK3     "3"
650 #define TSRK3BS   "3bs"
651 #define TSRK4     "4"
652 #define TSRK5F    "5f"
653 #define TSRK5DP   "5dp"
654 PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
655 PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
656 PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
657 PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
658 PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
659 PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
660 PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);
661 
662 /*J
663     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.
664 
665    Level: beginner
666 
667 .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
668 J*/
669 typedef const char* TSARKIMEXType;
670 #define TSARKIMEX1BEE   "1bee"
671 #define TSARKIMEXA2     "a2"
672 #define TSARKIMEXL2     "l2"
673 #define TSARKIMEXARS122 "ars122"
674 #define TSARKIMEX2C     "2c"
675 #define TSARKIMEX2D     "2d"
676 #define TSARKIMEX2E     "2e"
677 #define TSARKIMEXPRSSP2 "prssp2"
678 #define TSARKIMEX3      "3"
679 #define TSARKIMEXBPR3   "bpr3"
680 #define TSARKIMEXARS443 "ars443"
681 #define TSARKIMEX4      "4"
682 #define TSARKIMEX5      "5"
683 PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
684 PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
685 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
686 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[]);
687 PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
688 PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
689 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);
690 
691 /*J
692     TSRosWType - String with the name of a Rosenbrock-W method.
693 
694    Level: beginner
695 
696 .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
697 J*/
698 typedef const char* TSRosWType;
699 #define TSROSW2M          "2m"
700 #define TSROSW2P          "2p"
701 #define TSROSWRA3PW       "ra3pw"
702 #define TSROSWRA34PW2     "ra34pw2"
703 #define TSROSWRODAS3      "rodas3"
704 #define TSROSWSANDU3      "sandu3"
705 #define TSROSWASSP3P3S1C  "assp3p3s1c"
706 #define TSROSWLASSP3P4S2C "lassp3p4s2c"
707 #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
708 #define TSROSWARK3        "ark3"
709 #define TSROSWTHETA1      "theta1"
710 #define TSROSWTHETA2      "theta2"
711 #define TSROSWGRK4T       "grk4t"
712 #define TSROSWSHAMP4      "shamp4"
713 #define TSROSWVELDD4      "veldd4"
714 #define TSROSW4L          "4l"
715 
716 PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*);
717 PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType);
718 PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
719 PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
720 PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
721 PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
722 PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
723 PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);
724 
725 /*
726        PETSc interface to Sundials
727 */
728 #ifdef PETSC_HAVE_SUNDIALS
729 typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
730 PETSC_EXTERN const char *const TSSundialsLmmTypes[];
731 typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
732 PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
733 PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
734 PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
735 PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
736 PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
737 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
738 PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
739 PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
740 PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
741 PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
742 PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
743 PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
744 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
745 #endif
746 
747 PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
748 PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
749 PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
750 PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);
751 
752 PETSC_EXTERN PetscErrorCode TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*);
753 PETSC_EXTERN PetscErrorCode TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*);
754 PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
755 PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
756 PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
757 
758 PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
759 PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);
760 
761 PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
762 PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);
763 
764 #endif
765