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