Actual source code: petscts.h

petsc-master 2019-04-24
Report Typos and Errors
  1: /*
  2:    User interface for the timestepping package. This package
  3:    is for use in solving time-dependent PDEs.
  4: */
  7:  #include <petscsnes.h>

  9: /*S
 10:      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)

 12:    Level: beginner

 14:   Concepts: ODE solvers

 16: .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy()
 17: S*/
 18: typedef struct _p_TS* TS;

 20: /*J
 21:     TSType - String with the name of a PETSc TS method.

 23:    Level: beginner

 25: .seealso: TSSetType(), TS, TSRegister()
 26: J*/
 27: typedef const char* TSType;
 28: #define TSEULER           "euler"
 29: #define TSBEULER          "beuler"
 30: #define TSBASICSYMPLECTIC "basicsymplectic"
 31: #define TSPSEUDO          "pseudo"
 32: #define TSCN              "cn"
 33: #define TSSUNDIALS        "sundials"
 34: #define TSRK              "rk"
 35: #define TSPYTHON          "python"
 36: #define TSTHETA           "theta"
 37: #define TSALPHA           "alpha"
 38: #define TSALPHA2          "alpha2"
 39: #define TSGLLE            "glle"
 40: #define TSGLEE            "glee"
 41: #define TSSSP             "ssp"
 42: #define TSARKIMEX         "arkimex"
 43: #define TSROSW            "rosw"
 44: #define TSEIMEX           "eimex"
 45: #define TSMIMEX           "mimex"
 46: #define TSBDF             "bdf"
 47: #define TSRADAU5          "radau5"
 48: #define TSMPRK            "mprk"

 50: /*E
 51:     TSProblemType - Determines the type of problem this TS object is to be used to solve

 53:    Level: beginner

 55: .seealso: TSCreate()
 56: E*/
 57: typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;

 59: /*E
 60:    TSEquationType - type of TS problem that is solved

 62:    Level: beginner

 64:    Developer Notes:
 65:     this must match petsc/finclude/petscts.h

 67:    Supported types are:
 68:      TS_EQ_UNSPECIFIED (default)
 69:      TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0
 70:      TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0

 72: .seealso: TSGetEquationType(), TSSetEquationType()
 73: E*/
 74: typedef enum {
 75:   TS_EQ_UNSPECIFIED               = -1,
 76:   TS_EQ_EXPLICIT                  = 0,
 77:   TS_EQ_ODE_EXPLICIT              = 1,
 78:   TS_EQ_DAE_SEMI_EXPLICIT_INDEX1  = 100,
 79:   TS_EQ_DAE_SEMI_EXPLICIT_INDEX2  = 200,
 80:   TS_EQ_DAE_SEMI_EXPLICIT_INDEX3  = 300,
 81:   TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500,
 82:   TS_EQ_IMPLICIT                  = 1000,
 83:   TS_EQ_ODE_IMPLICIT              = 1001,
 84:   TS_EQ_DAE_IMPLICIT_INDEX1       = 1100,
 85:   TS_EQ_DAE_IMPLICIT_INDEX2       = 1200,
 86:   TS_EQ_DAE_IMPLICIT_INDEX3       = 1300,
 87:   TS_EQ_DAE_IMPLICIT_INDEXHI      = 1500
 88: } TSEquationType;
 89: PETSC_EXTERN const char *const*TSEquationTypes;

 91: /*E
 92:    TSConvergedReason - reason a TS method has converged or not

 94:    Level: beginner

 96:    Developer Notes:
 97:     this must match petsc/finclude/petscts.h

 99:    Each reason has its own manual page.

101: .seealso: TSGetConvergedReason()
102: E*/
103: typedef enum {
104:   TS_CONVERGED_ITERATING      = 0,
105:   TS_CONVERGED_TIME           = 1,
106:   TS_CONVERGED_ITS            = 2,
107:   TS_CONVERGED_USER           = 3,
108:   TS_CONVERGED_EVENT          = 4,
109:   TS_CONVERGED_PSEUDO_FATOL   = 5,
110:   TS_CONVERGED_PSEUDO_FRTOL   = 6,
111:   TS_DIVERGED_NONLINEAR_SOLVE = -1,
112:   TS_DIVERGED_STEP_REJECTED   = -2
113: } TSConvergedReason;
114: PETSC_EXTERN const char *const*TSConvergedReasons;

116: /*MC
117:    TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve()

119:    Level: beginner

121: .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt()
122: M*/

124: /*MC
125:    TS_CONVERGED_TIME - the final time was reached

127:    Level: beginner

129: .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime()
130: M*/

132: /*MC
133:    TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time

135:    Level: beginner

137: .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps()
138: M*/

140: /*MC
141:    TS_CONVERGED_USER - user requested termination

143:    Level: beginner

145: .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
146: M*/

148: /*MC
149:    TS_CONVERGED_EVENT - user requested termination on event detection

151:    Level: beginner

153: .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason()
154: M*/

156: /*MC
157:    TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO

159:    Level: beginner

161:    Options Database:
162: .   -ts_pseudo_frtol <rtol>

164: .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL
165: M*/

167: /*MC
168:    TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO

170:    Level: beginner

172:    Options Database:
173: .   -ts_pseudo_fatol <atol>

175: .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL
176: M*/

178: /*MC
179:    TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed

181:    Level: beginner

183:    Notes:
184:     See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures.

186: .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures()
187: M*/

189: /*MC
190:    TS_DIVERGED_STEP_REJECTED - too many steps were rejected

192:    Level: beginner

194:    Notes:
195:     See TSSetMaxStepRejections() for how to allow more step rejections.

197: .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections()
198: M*/

200: /*E
201:    TSExactFinalTimeOption - option for handling of final time step

203:    Level: beginner

205:    Developer Notes:
206:     this must match petsc/finclude/petscts.h

208: $  TS_EXACTFINALTIME_STEPOVER    - Don't do anything if final time is exceeded
209: $  TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time
210: $  TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time

212: .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime()

214: E*/
215: typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption;
216: PETSC_EXTERN const char *const TSExactFinalTimeOptions[];

218: /* Logging support */
219: PETSC_EXTERN PetscClassId TS_CLASSID;
220: PETSC_EXTERN PetscClassId DMTS_CLASSID;
221: PETSC_EXTERN PetscClassId TSADAPT_CLASSID;

223: PETSC_EXTERN PetscErrorCode TSInitializePackage(void);
224: PETSC_EXTERN PetscErrorCode TSFinalizePackage(void);

226: PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
227: PETSC_EXTERN PetscErrorCode TSClone(TS,TS*);
228: PETSC_EXTERN PetscErrorCode TSDestroy(TS*);

230: PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
231: PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
232: PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec);
233: PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
234: PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));
235: PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS);

237: PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
238: PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
239: PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]);
240: PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS);
241: PETSC_EXTERN PetscErrorCode TSSetUp(TS);
242: PETSC_EXTERN PetscErrorCode TSReset(TS);

244: PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec);
245: PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*);

247: PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec);
248: PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*);

250: PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*);
251: PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*);
252: PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*);
253: PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec);

255: PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
256: PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat);
257: PETSC_EXTERN PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
258: PETSC_EXTERN PetscErrorCode TSComputeDRDYFunction(TS,PetscReal,Vec,Vec*);

260: /*S
261:      TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step)

263:    Level: advanced

265:   Concepts: ODE solvers, trajectory

267: .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset()
268: S*/
269: typedef struct _p_TSTrajectory* TSTrajectory;

271: /*J
272:     TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method

274:    Level: intermediate

276: .seealso:  TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy()
277: J*/
278: typedef const char* TSTrajectoryType;
279: #define TSTRAJECTORYBASIC         "basic"
280: #define TSTRAJECTORYSINGLEFILE    "singlefile"
281: #define TSTRAJECTORYMEMORY        "memory"
282: #define TSTRAJECTORYVISUALIZATION "visualization"

284: PETSC_EXTERN PetscFunctionList TSTrajectoryList;
285: PETSC_EXTERN PetscClassId      TSTRAJECTORY_CLASSID;
286: PETSC_EXTERN PetscBool         TSTrajectoryRegisterAllCalled;

288: PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS);
289: PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS);

291: PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*);
292: PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory);
293: PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*);
294: PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer);
295: PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType);
296: PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec);
297: PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*);
298: PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec);
299: PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*);
300: PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*);
301: PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*);
302: PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS);
303: PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS));
304: PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void);
305: PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS);
306: PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool);
307: PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*);
308: PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
309: PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool);
310: PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*);
311: PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool);
312: PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]);
313: PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]);
314: PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*);

316: PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*);
317: PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**);
318: PETSC_EXTERN PetscErrorCode TSSetCostIntegrand(TS,PetscInt,Vec,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscBool,void*);
319: PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*);
320: PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec);

322: PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS);
323: PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*);
324: PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**));
325: PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS);
326: PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*));

328: PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*);
329: PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS);
330: PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt);

332: PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat);
333: PETSC_EXTERN PetscErrorCode TSAdjointStep(TS);
334: PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS);
335: PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*);
336: PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*);
337: PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS);

339: PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat);
340: PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*);
341: PETSC_EXTERN PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *);
342: PETSC_EXTERN PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **);
343: PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*);
344: PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*);
345: PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS);
346: PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS);
347: PETSC_EXTERN PetscErrorCode TSForwardStep(TS);

349: PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt);
350: PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*);
351: PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal);
352: PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*);
353: PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption);
354: PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*);

356: PETSC_EXTERN PETSC_DEPRECATED("Use TSSetTime[Step]")      PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
357: PETSC_EXTERN PETSC_DEPRECATED("Use TSSetMax{Steps|Time}") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
358: PETSC_EXTERN PETSC_DEPRECATED("Use TSGetMax{Steps|Time}") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);
359: PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber")      PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
360: PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber")      PetscErrorCode TSGetTotalSteps(TS,PetscInt*);

362: PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
363: PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);

365: typedef struct _n_TSMonitorDrawCtx*  TSMonitorDrawCtx;
366: PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *);
367: PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*);
368: PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*);
369: PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*);
370: PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*);
371: PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*);

373: PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *);
374: PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*);

376: PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*);
377: PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*);
378: PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*);

380: PETSC_EXTERN PetscErrorCode TSStep(TS);
381: PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*);
382: PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*);
383: PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec);
384: PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*);
385: PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType);
386: PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*);
387: PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason);
388: PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*);
389: PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*);
390: PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*);
391: PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*);
392: PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt);
393: PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*);
394: PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt);
395: PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool);
396: PETSC_EXTERN PetscErrorCode TSRestartStep(TS);
397: PETSC_EXTERN PetscErrorCode TSRollBack(TS);

399: PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**);

401: PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
402: PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal);
403: PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*);
404: PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
405: PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);
406: PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*);
407: PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt);

409: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
410: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*);
411: PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
412: PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
413: PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
414: PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
415: PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool);

417: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*);
418: PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*);
419: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*);
420: PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*);

422: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
423: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
424: PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*);
425: PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**);
426: PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
427: PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);

429: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*);
430: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*);
431: PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*);
432: PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**);
433: PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*);
434: PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**);

436: PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS);
437: PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*);
438: PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*);
439: PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*);
440: PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]);
441: PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool);
442: PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*);

444: PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
445: PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*);
446: PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
447: PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);
448: PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec);
449: PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec);
450: PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*);

452: PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
453: PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal));
454: PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*));
455: PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS));
456: PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
457: PETSC_EXTERN PetscErrorCode TSPreStep(TS);
458: PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal);
459: PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*);
460: PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS);
461: PETSC_EXTERN PetscErrorCode TSPostStep(TS);
462: PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec);
463: PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec);
464: PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*);
465: PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
466: PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
467: PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
468: PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
469: PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*);
470: PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*);
471: PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal);
472: PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*);
473: PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*));
474: PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*);

476: PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
477: PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*);
478: PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);
479: PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal);
480: PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
481: PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *);
482: PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
483: PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
484: PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);

486: PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]);

488: PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
489: PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat);
490: PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
491: PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool);
492: PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec);
493: PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat);
494: PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*);

496: PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec);

498: PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *);
499: PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*);
500: PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**);
501: PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*);
502: PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**);
503: PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*);
504: PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**);
505: PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*);
506: PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**);
507: PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*);
508: PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**);
509: PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*);
510: PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**);

512: PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*);
513: PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**);
514: PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*);
515: PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**);
516: PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*);
517: PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal);
518: PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **);

520: PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*);
521: PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*);
522: PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*);

524: PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));
525: PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer));

527: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*);
528: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*);
529: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*);
530: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*);

532: PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *);
533: PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *);
534: PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *);
535: PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *);

537: PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*);
538: PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*);

540: typedef struct _n_TSMonitorLGCtx*  TSMonitorLGCtx;
541: typedef struct {
542:   Vec            ray;
543:   VecScatter     scatter;
544:   PetscViewer    viewer;
545:   TSMonitorLGCtx lgctx;
546: } TSMonitorDMDARayCtx;
547: PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**);
548: PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*);
549: PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*);

551: /* Dynamic creation and loading functions */
552: PETSC_EXTERN PetscFunctionList TSList;
553: PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*);
554: PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType);
555: PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS));

557: PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
558: PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES);
559: PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*);

561: PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer);
562: PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer);
563: PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
564: PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}

566: #define TS_FILE_CLASSID 1211225

568: PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
569: PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *);

571: PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *);
572: PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*);
573: PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *);
574: PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *);
575: PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*);
576: PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **);
577: PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *);
578: PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*);
579: PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*);
580: PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*);
581: PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *);
582: PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *);
583: PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *);
584: PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *);
585: PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *);

587: typedef struct _n_TSMonitorEnvelopeCtx*  TSMonitorEnvelopeCtx;
588: PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*);
589: PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*);
590: PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*);
591: PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*);

593: typedef struct _n_TSMonitorSPEigCtx*  TSMonitorSPEigCtx;
594: PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *);
595: PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*);
596: PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *);

598: typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx;
599: PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*);
600: PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*);
601: PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*);

603: PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*);
604: PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal);
605: PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]);
606: /*J
607:    TSSSPType - string with the name of TSSSP scheme.

609:    Level: beginner

611: .seealso: TSSSPSetType(), TS
612: J*/
613: typedef const char* TSSSPType;
614: #define TSSSPRKS2  "rks2"
615: #define TSSSPRKS3  "rks3"
616: #define TSSSPRK104 "rk104"

618: PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType);
619: PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*);
620: PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
621: PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
622: PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void);
623: PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void);
624: PETSC_EXTERN PetscFunctionList TSSSPList;

626: /*S
627:    TSAdapt - Abstract object that manages time-step adaptivity

629:    Level: beginner

631: .seealso: TS, TSAdaptCreate(), TSAdaptType
632: S*/
633: typedef struct _p_TSAdapt *TSAdapt;

635: /*E
636:     TSAdaptType - String with the name of TSAdapt scheme.

638:    Level: beginner

640: .seealso: TSAdaptSetType(), TS
641: E*/
642: typedef const char *TSAdaptType;
643: #define TSADAPTNONE    "none"
644: #define TSADAPTBASIC   "basic"
645: #define TSADAPTDSP     "dsp"
646: #define TSADAPTCFL     "cfl"
647: #define TSADAPTGLEE    "glee"
648: #define TSADAPTHISTORY "history"

650: PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*);
651: PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt));
652: PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void);
653: PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void);
654: PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*);
655: PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType);
656: PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*);
657: PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]);
658: PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt);
659: PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool);
660: PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**);
661: PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*);
662: PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*);
663: PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer);
664: PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer);
665: PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt);
666: PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt);
667: PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*);
668: PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool);
669: PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool);
670: PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal);
671: PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*);
672: PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal);
673: PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*);
674: PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal);
675: PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*);
676: PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*));
677: PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool);
678: PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool);
679: PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*);
680: PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt);
681: PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *);
682: PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal);

684: /*S
685:    TSGLLEAdapt - Abstract object that manages time-step adaptivity

687:    Level: beginner

689:    Developer Notes:
690:    This functionality should be replaced by the TSAdapt.

692: .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType
693: S*/
694: typedef struct _p_TSGLLEAdapt *TSGLLEAdapt;

696: /*J
697:     TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme

699:    Level: beginner

701: .seealso: TSGLLEAdaptSetType(), TS
702: J*/
703: typedef const char *TSGLLEAdaptType;
704: #define TSGLLEADAPT_NONE "none"
705: #define TSGLLEADAPT_SIZE "size"
706: #define TSGLLEADAPT_BOTH "both"

708: PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt));
709: PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void);
710: PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void);
711: PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*);
712: PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType);
713: PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]);
714: PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
715: PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer);
716: PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt);
717: PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*);

719: /*J
720:     TSGLLEAcceptType - String with the name of TSGLLEAccept scheme

722:    Level: beginner

724: .seealso: TSGLLESetAcceptType(), TS
725: J*/
726: typedef const char *TSGLLEAcceptType;
727: #define TSGLLEACCEPT_ALWAYS "always"

729: PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
730: PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction);

732: /*J
733:   TSGLLEType - family of time integration method within the General Linear class

735:   Level: beginner

737: .seealso: TSGLLESetType(), TSGLLERegister()
738: J*/
739: typedef const char* TSGLLEType;
740: #define TSGLLE_IRKS   "irks"

742: PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS));
743: PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void);
744: PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void);
745: PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType);
746: PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*);
747: PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType);

749: /*J
750:     TSEIMEXType - String with the name of an Extrapolated IMEX method.

752:    Level: beginner

754: .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister()
755: J*/
756: #define TSEIMEXType   char*

758: PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt);
759: PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt);
760: PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool);

762: /*J
763:     TSRKType - String with the name of a Runge-Kutta method.

765:    Level: beginner

767: .seealso: TSRKSetType(), TS, TSRK, TSRKRegister()
768: J*/
769: typedef const char* TSRKType;
770: #define TSRK1FE   "1fe"
771: #define TSRK2A    "2a"
772: #define TSRK3     "3"
773: #define TSRK3BS   "3bs"
774: #define TSRK4     "4"
775: #define TSRK5F    "5f"
776: #define TSRK5DP   "5dp"
777: #define TSRK5BS   "5bs"

779: PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*);
780: PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType);
781: PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool);
782: PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*);
783: PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool);
784: PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
785: PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void);
786: PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void);
787: PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void);

789: /*J
790:    TSMPRKType - String with the name of a Partitioned Runge-Kutta method

792:    Level: beginner

794: .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister()
795: J*/
796: typedef const char* TSMPRKType;
797: #define TSMPRK2A22   "2a22"
798: #define TSMPRK2A23   "2a23"
799: #define TSMPRK2A32   "2a32"
800: #define TSMPRK2A33   "2a33"
801: #define TSMPRKP2    "p2"
802: #define TSMPRKP3    "p3"

804: PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*);
805: PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType);
806: PETSC_EXTERN PetscErrorCode TSMPRKRegister(TSMPRKType,PetscInt,PetscInt,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscInt[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscInt [],const PetscReal[],const PetscReal[],const PetscReal[]);
807: PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void);
808: PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void);
809: PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void);

811: /*J
812:     TSGLEEType - String with the name of a General Linear with Error Estimation method.

814:    Level: beginner

816: .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister()
817: J*/
818: typedef const char* TSGLEEType;
819: #define TSGLEEi1      "BE1"
820: #define TSGLEE23      "23"
821: #define TSGLEE24      "24"
822: #define TSGLEE25I     "25i"
823: #define TSGLEE35      "35"
824: #define TSGLEEEXRK2A  "exrk2a"
825: #define TSGLEERK32G1  "rk32g1"
826: #define TSGLEERK285EX "rk285ex"
827: /*J
828:     TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method.

830:    Level: beginner

832: .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister()
833: J*/
834: PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*);
835: PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType);
836: PETSC_EXTERN PetscErrorCode TSGLEERegister(TSGLEEType,PetscInt,PetscInt,PetscInt,PetscReal,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
837: PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void);
838: PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void);
839: PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void);

841: /*J
842:     TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method.

844:    Level: beginner

846: .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister()
847: J*/
848: typedef const char* TSARKIMEXType;
849: #define TSARKIMEX1BEE   "1bee"
850: #define TSARKIMEXA2     "a2"
851: #define TSARKIMEXL2     "l2"
852: #define TSARKIMEXARS122 "ars122"
853: #define TSARKIMEX2C     "2c"
854: #define TSARKIMEX2D     "2d"
855: #define TSARKIMEX2E     "2e"
856: #define TSARKIMEXPRSSP2 "prssp2"
857: #define TSARKIMEX3      "3"
858: #define TSARKIMEXBPR3   "bpr3"
859: #define TSARKIMEXARS443 "ars443"
860: #define TSARKIMEX4      "4"
861: #define TSARKIMEX5      "5"
862: PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*);
863: PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType);
864: PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
865: 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[]);
866: PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void);
867: PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void);
868: PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void);

870: /*J
871:     TSRosWType - String with the name of a Rosenbrock-W method.

873:    Level: beginner

875: .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister()
876: J*/
877: typedef const char* TSRosWType;
878: #define TSROSW2M          "2m"
879: #define TSROSW2P          "2p"
880: #define TSROSWRA3PW       "ra3pw"
881: #define TSROSWRA34PW2     "ra34pw2"
882: #define TSROSWRODAS3      "rodas3"
883: #define TSROSWSANDU3      "sandu3"
884: #define TSROSWASSP3P3S1C  "assp3p3s1c"
885: #define TSROSWLASSP3P4S2C "lassp3p4s2c"
886: #define TSROSWLLSSP3P4S2C "llssp3p4s2c"
887: #define TSROSWARK3        "ark3"
888: #define TSROSWTHETA1      "theta1"
889: #define TSROSWTHETA2      "theta2"
890: #define TSROSWGRK4T       "grk4t"
891: #define TSROSWSHAMP4      "shamp4"
892: #define TSROSWVELDD4      "veldd4"
893: #define TSROSW4L          "4l"

895: PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*);
896: PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType);
897: PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool);
898: PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]);
899: PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal);
900: PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void);
901: PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void);
902: PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void);

904: PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt);
905: PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*);

907: /*J
908:   TSBasicSymplecticType - String with the name of a basic symplectic integration method.

910:   Level: beginner

912:   .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister()
913: J*/
914: typedef const char* TSBasicSymplecticType;
915: #define TSBASICSYMPLECTICSIEULER   "1"
916: #define TSBASICSYMPLECTICVELVERLET "2"
917: #define TSBASICSYMPLECTIC3         "3"
918: #define TSBASICSYMPLECTIC4         "4"
919: PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType);
920: PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*);
921: PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]);
922: PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void);
923: PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void);
924: PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void);

926: /*
927:        PETSc interface to Sundials
928: */
929: #ifdef PETSC_HAVE_SUNDIALS
930: typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
931: PETSC_EXTERN const char *const TSSundialsLmmTypes[];
932: typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
933: PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[];
934: PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType);
935: PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*);
936: PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal);
937: PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal);
938: PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal);
939: PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
940: PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
941: PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt);
942: PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal);
943: PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool );
944: PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
945: PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt);
946: #endif

948: PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal);
949: PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*);
950: PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*);
951: PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool);

953: PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal);
954: PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
955: PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);

957: PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal);
958: PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal);
959: PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*);

961: PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM);
962: PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*);

964: PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*);
965: PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*);

967: PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*);
968: PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*);
969: #endif