xref: /petsc/include/petscts.h (revision ad24ef9b0309ced034242e7d8e3705fa63c44aae)
1818ad0c1SBarry Smith /*
2316643e7SJed Brown    User interface for the timestepping package. This package
3f64a0f93SLois Curfman McInnes    is for use in solving time-dependent PDEs.
4818ad0c1SBarry Smith */
50a835dfdSSatish Balay #if !defined(__PETSCTS_H)
60a835dfdSSatish Balay #define __PETSCTS_H
70a835dfdSSatish Balay #include "petscsnes.h"
8e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN
9818ad0c1SBarry Smith 
10435da068SBarry Smith /*S
11435da068SBarry Smith      TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
12435da068SBarry Smith 
13435da068SBarry Smith    Level: beginner
14435da068SBarry Smith 
15435da068SBarry Smith   Concepts: ODE solvers
16435da068SBarry Smith 
1794b7f48cSBarry Smith .seealso:  TSCreate(), TSSetType(), TSType, SNES, KSP, PC
18435da068SBarry Smith S*/
19f09e8eb9SSatish Balay typedef struct _p_TS* TS;
20435da068SBarry Smith 
2176bdecfbSBarry Smith /*J
22435da068SBarry Smith     TSType - String with the name of a PETSc TS method or the creation function
23435da068SBarry Smith        with an optional dynamic library name, for example
24435da068SBarry Smith        http://www.mcs.anl.gov/petsc/lib.a:mytscreate()
25435da068SBarry Smith 
26435da068SBarry Smith    Level: beginner
27435da068SBarry Smith 
28435da068SBarry Smith .seealso: TSSetType(), TS
2976bdecfbSBarry Smith J*/
30a313700dSBarry Smith #define TSType char*
319596e0b4SJed Brown #define TSEULER           "euler"
329596e0b4SJed Brown #define TSBEULER          "beuler"
339596e0b4SJed Brown #define TSPSEUDO          "pseudo"
344d91e141SJed Brown #define TSCN              "cn"
359596e0b4SJed Brown #define TSSUNDIALS        "sundials"
364d91e141SJed Brown #define TSRK              "rk"
379596e0b4SJed Brown #define TSPYTHON          "python"
389596e0b4SJed Brown #define TSTHETA           "theta"
3988df8a41SLisandro Dalcin #define TSALPHA           "alpha"
409596e0b4SJed Brown #define TSGL              "gl"
41ef7bb5aaSJed Brown #define TSSSP             "ssp"
428a381b04SJed Brown #define TSARKIMEX         "arkimex"
43e27a552bSJed Brown #if defined(PETSC_HAVE_ROSW)
44e27a552bSJed Brown #define TSROSW            "rosw"
45e27a552bSJed Brown #endif
4682bf6240SBarry Smith 
47435da068SBarry Smith /*E
48435da068SBarry Smith     TSProblemType - Determines the type of problem this TS object is to be used to solve
49435da068SBarry Smith 
50435da068SBarry Smith    Level: beginner
51435da068SBarry Smith 
52435da068SBarry Smith .seealso: TSCreate()
53435da068SBarry Smith E*/
5419bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
55818ad0c1SBarry Smith 
56193ac0bcSJed Brown typedef enum {
57193ac0bcSJed Brown   TS_CONVERGED_ITERATING      = 0,
58193ac0bcSJed Brown   TS_CONVERGED_TIME           = 1,
59193ac0bcSJed Brown   TS_CONVERGED_ITS            = 2,
60193ac0bcSJed Brown   TS_DIVERGED_NONLINEAR_SOLVE = -1,
61193ac0bcSJed Brown   TS_DIVERGED_STEP_REJECTED   = -2
62193ac0bcSJed Brown } TSConvergedReason;
63193ac0bcSJed Brown extern const char *const*TSConvergedReasons;
64193ac0bcSJed Brown 
65000e7ae3SMatthew Knepley /* Logging support */
667087cfbeSBarry Smith extern PetscClassId  TS_CLASSID;
67000e7ae3SMatthew Knepley 
687087cfbeSBarry Smith extern PetscErrorCode   TSInitializePackage(const char[]);
698ba1e511SMatthew Knepley 
707087cfbeSBarry Smith extern PetscErrorCode   TSCreate(MPI_Comm,TS*);
71fcfd50ebSBarry Smith extern PetscErrorCode   TSDestroy(TS*);
72818ad0c1SBarry Smith 
737087cfbeSBarry Smith extern PetscErrorCode   TSSetProblemType(TS,TSProblemType);
747087cfbeSBarry Smith extern PetscErrorCode   TSGetProblemType(TS,TSProblemType*);
75228d79bcSJed Brown extern PetscErrorCode   TSMonitor(TS,PetscInt,PetscReal,Vec);
76c2efdce3SBarry Smith extern PetscErrorCode   TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**));
777087cfbeSBarry Smith extern PetscErrorCode   TSMonitorCancel(TS);
78818ad0c1SBarry Smith 
797087cfbeSBarry Smith extern PetscErrorCode   TSSetOptionsPrefix(TS,const char[]);
807087cfbeSBarry Smith extern PetscErrorCode   TSAppendOptionsPrefix(TS,const char[]);
817087cfbeSBarry Smith extern PetscErrorCode   TSGetOptionsPrefix(TS,const char *[]);
827087cfbeSBarry Smith extern PetscErrorCode   TSSetFromOptions(TS);
837087cfbeSBarry Smith extern PetscErrorCode   TSSetUp(TS);
84277b19d0SLisandro Dalcin extern PetscErrorCode   TSReset(TS);
85818ad0c1SBarry Smith 
867087cfbeSBarry Smith extern PetscErrorCode   TSSetSolution(TS,Vec);
877087cfbeSBarry Smith extern PetscErrorCode   TSGetSolution(TS,Vec*);
88818ad0c1SBarry Smith 
897087cfbeSBarry Smith extern PetscErrorCode   TSSetDuration(TS,PetscInt,PetscReal);
907087cfbeSBarry Smith extern PetscErrorCode   TSGetDuration(TS,PetscInt*,PetscReal*);
91a43b19c4SJed Brown extern PetscErrorCode   TSSetExactFinalTime(TS,PetscBool);
92818ad0c1SBarry Smith 
937087cfbeSBarry Smith extern PetscErrorCode   TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*);
947087cfbeSBarry Smith extern PetscErrorCode   TSMonitorSolution(TS,PetscInt,PetscReal,Vec,void*);
956083293cSBarry Smith extern PetscErrorCode   TSMonitorSolutionCreate(TS,PetscViewer,void**);
966083293cSBarry Smith extern PetscErrorCode   TSMonitorSolutionDestroy(void**);
97fb1732b5SBarry Smith extern PetscErrorCode   TSMonitorSolutionBinary(TS,PetscInt,PetscReal,Vec,void*);
98fb1732b5SBarry Smith 
99193ac0bcSJed Brown extern PetscErrorCode   TSStep(TS);
1005a3a76d0SJed Brown extern PetscErrorCode   TSSolve(TS,Vec,PetscReal*);
101193ac0bcSJed Brown extern PetscErrorCode   TSGetConvergedReason(TS,TSConvergedReason*);
1029f67acb7SJed Brown extern PetscErrorCode   TSGetNonlinearSolveIterations(TS,PetscInt*);
1039f67acb7SJed Brown extern PetscErrorCode   TSGetLinearSolveIterations(TS,PetscInt*);
104818ad0c1SBarry Smith 
1057087cfbeSBarry Smith extern PetscErrorCode   TSSetInitialTimeStep(TS,PetscReal,PetscReal);
1067087cfbeSBarry Smith extern PetscErrorCode   TSGetTimeStep(TS,PetscReal*);
1077087cfbeSBarry Smith extern PetscErrorCode   TSGetTime(TS,PetscReal*);
1087087cfbeSBarry Smith extern PetscErrorCode   TSSetTime(TS,PetscReal);
1097087cfbeSBarry Smith extern PetscErrorCode   TSGetTimeStepNumber(TS,PetscInt*);
1107087cfbeSBarry Smith extern PetscErrorCode   TSSetTimeStep(TS,PetscReal);
111818ad0c1SBarry Smith 
1122d4b5aceSLisandro Dalcin typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*);
1132d4b5aceSLisandro Dalcin typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
114089b2837SJed Brown extern PetscErrorCode   TSSetRHSFunction(TS,Vec,TSRHSFunction,void*);
115089b2837SJed Brown extern PetscErrorCode   TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**);
1162d4b5aceSLisandro Dalcin extern PetscErrorCode   TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*);
117089b2837SJed Brown extern PetscErrorCode   TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**);
118818ad0c1SBarry Smith 
119316643e7SJed Brown typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*);
120316643e7SJed Brown typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*);
121089b2837SJed Brown extern PetscErrorCode   TSSetIFunction(TS,Vec,TSIFunction,void*);
122089b2837SJed Brown extern PetscErrorCode   TSGetIFunction(TS,Vec*,TSIFunction*,void**);
1237087cfbeSBarry Smith extern PetscErrorCode   TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*);
1247087cfbeSBarry Smith extern PetscErrorCode   TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**);
125316643e7SJed Brown 
1260e4ef248SJed Brown extern PetscErrorCode   TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*);
1270e4ef248SJed Brown extern PetscErrorCode   TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
1280026cea9SSean Farley extern PetscErrorCode   TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*);
1290026cea9SSean Farley extern PetscErrorCode   TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*);
1307087cfbeSBarry Smith extern PetscErrorCode   TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
1317087cfbeSBarry Smith extern PetscErrorCode   TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
132e34be4c2SBarry Smith 
1337087cfbeSBarry Smith extern PetscErrorCode   TSSetPreStep(TS, PetscErrorCode (*)(TS));
1347087cfbeSBarry Smith extern PetscErrorCode   TSSetPostStep(TS, PetscErrorCode (*)(TS));
1357087cfbeSBarry Smith extern PetscErrorCode   TSPreStep(TS);
1367087cfbeSBarry Smith extern PetscErrorCode   TSPostStep(TS);
137cd652676SJed Brown extern PetscErrorCode   TSSetRetainStages(TS,PetscBool);
138cd652676SJed Brown extern PetscErrorCode   TSInterpolate(TS,PetscReal,Vec);
139000e7ae3SMatthew Knepley 
1407087cfbeSBarry Smith extern PetscErrorCode   TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
1417087cfbeSBarry Smith extern PetscErrorCode   TSPseudoDefaultTimeStep(TS,PetscReal*,void*);
1427087cfbeSBarry Smith extern PetscErrorCode   TSPseudoComputeTimeStep(TS,PetscReal *);
143*ad24ef9bSSatish Balay extern PetscErrorCode   TSPseudoSetMaxTimeStep(TS,PetscReal);
144d8345c25SBarry Smith 
1457087cfbeSBarry Smith extern PetscErrorCode   TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*);
1467087cfbeSBarry Smith extern PetscErrorCode   TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscBool *);
1477087cfbeSBarry Smith extern PetscErrorCode   TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *);
1487087cfbeSBarry Smith extern PetscErrorCode   TSPseudoSetTimeStepIncrement(TS,PetscReal);
1497087cfbeSBarry Smith extern PetscErrorCode   TSPseudoIncrementDtFromInitialDt(TS);
15021c89e3eSBarry Smith 
1517087cfbeSBarry Smith extern PetscErrorCode   TSPythonSetType(TS,const char[]);
1521d6018f0SLisandro Dalcin 
1537087cfbeSBarry Smith extern PetscErrorCode   TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
1547087cfbeSBarry Smith extern PetscErrorCode   TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*);
155214bc6a2SJed Brown extern PetscErrorCode   TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool);
156214bc6a2SJed Brown extern PetscErrorCode   TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,PetscBool);
157818ad0c1SBarry Smith 
158d6ebe24aSShri Abhyankar extern PetscErrorCode   TSVISetVariableBounds(TS,Vec,Vec);
159d6ebe24aSShri Abhyankar 
160bdad233fSMatthew Knepley /* Dynamic creation and loading functions */
161b0a32e0cSBarry Smith extern PetscFList TSList;
162ace3abfcSBarry Smith extern PetscBool  TSRegisterAllCalled;
1637087cfbeSBarry Smith extern PetscErrorCode   TSGetType(TS,const TSType*);
1647087cfbeSBarry Smith extern PetscErrorCode   TSSetType(TS,const TSType);
1657087cfbeSBarry Smith extern PetscErrorCode   TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS));
1667087cfbeSBarry Smith extern PetscErrorCode   TSRegisterAll(const char[]);
1677087cfbeSBarry Smith extern PetscErrorCode   TSRegisterDestroy(void);
16830de9b25SBarry Smith 
16930de9b25SBarry Smith /*MC
17030de9b25SBarry Smith   TSRegisterDynamic - Adds a creation method to the TS package.
17130de9b25SBarry Smith 
17230de9b25SBarry Smith   Synopsis:
1731890ba74SBarry Smith   PetscErrorCode TSRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(TS))
17430de9b25SBarry Smith 
17530de9b25SBarry Smith   Not Collective
17630de9b25SBarry Smith 
17730de9b25SBarry Smith   Input Parameters:
17830de9b25SBarry Smith + name        - The name of a new user-defined creation routine
17930de9b25SBarry Smith . path        - The path (either absolute or relative) of the library containing this routine
18030de9b25SBarry Smith . func_name   - The name of the creation routine
18130de9b25SBarry Smith - create_func - The creation routine itself
18230de9b25SBarry Smith 
18330de9b25SBarry Smith   Notes:
18430de9b25SBarry Smith   TSRegisterDynamic() may be called multiple times to add several user-defined tses.
18530de9b25SBarry Smith 
18630de9b25SBarry Smith   If dynamic libraries are used, then the fourth input argument (create_func) is ignored.
18730de9b25SBarry Smith 
18830de9b25SBarry Smith   Sample usage:
18930de9b25SBarry Smith .vb
19030de9b25SBarry Smith   TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate);
19130de9b25SBarry Smith .ve
19230de9b25SBarry Smith 
19330de9b25SBarry Smith   Then, your ts type can be chosen with the procedural interface via
19430de9b25SBarry Smith .vb
19565f2c13aSKai Germaschewski     TS ts;
19665f2c13aSKai Germaschewski     TSCreate(MPI_Comm, &ts);
19765f2c13aSKai Germaschewski     TSSetType(ts, "my_ts")
19830de9b25SBarry Smith .ve
19930de9b25SBarry Smith   or at runtime via the option
20030de9b25SBarry Smith .vb
20130de9b25SBarry Smith     -ts_type my_ts
20230de9b25SBarry Smith .ve
20330de9b25SBarry Smith 
204ab901514SBarry Smith   Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
20530de9b25SBarry Smith         If your function is not being put into a shared library then use TSRegister() instead
20630de9b25SBarry Smith 
20730de9b25SBarry Smith   Level: advanced
20830de9b25SBarry Smith 
20930de9b25SBarry Smith .keywords: TS, register
21030de9b25SBarry Smith .seealso: TSRegisterAll(), TSRegisterDestroy()
21130de9b25SBarry Smith M*/
212aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
213f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0)
2146df38c32SLois Curfman McInnes #else
215f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d)
2166df38c32SLois Curfman McInnes #endif
2176df38c32SLois Curfman McInnes 
2187087cfbeSBarry Smith extern PetscErrorCode   TSGetSNES(TS,SNES*);
2197087cfbeSBarry Smith extern PetscErrorCode   TSGetKSP(TS,KSP*);
220818ad0c1SBarry Smith 
2217087cfbeSBarry Smith extern PetscErrorCode   TSView(TS,PetscViewer);
22221c89e3eSBarry Smith 
2237087cfbeSBarry Smith extern PetscErrorCode   TSSetApplicationContext(TS,void *);
224e71120c6SJed Brown extern PetscErrorCode   TSGetApplicationContext(TS,void *);
22521c89e3eSBarry Smith 
2267087cfbeSBarry Smith extern PetscErrorCode   TSMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG *);
2277087cfbeSBarry Smith extern PetscErrorCode   TSMonitorLG(TS,PetscInt,PetscReal,Vec,void *);
228fcfd50ebSBarry Smith extern PetscErrorCode   TSMonitorLGDestroy(PetscDrawLG*);
2293914022bSBarry Smith 
23076bdecfbSBarry Smith /*J
231815f1ad5SJed Brown    TSSSPType - string with the name of TSSSP scheme.
232815f1ad5SJed Brown 
233815f1ad5SJed Brown    Level: beginner
234815f1ad5SJed Brown 
235815f1ad5SJed Brown .seealso: TSSSPSetType(), TS
23676bdecfbSBarry Smith J*/
237815f1ad5SJed Brown #define TSSSPType char*
238815f1ad5SJed Brown #define TSSSPRKS2  "rks2"
239815f1ad5SJed Brown #define TSSSPRKS3  "rks3"
240815f1ad5SJed Brown #define TSSSPRK104 "rk104"
241815f1ad5SJed Brown 
242815f1ad5SJed Brown extern PetscErrorCode TSSSPSetType(TS,const TSSSPType);
243815f1ad5SJed Brown extern PetscErrorCode TSSSPGetType(TS,const TSSSPType*);
244815f1ad5SJed Brown extern PetscErrorCode TSSSPSetNumStages(TS,PetscInt);
245815f1ad5SJed Brown extern PetscErrorCode TSSSPGetNumStages(TS,PetscInt*);
246815f1ad5SJed Brown 
247ed657a08SJed Brown /*S
248ed657a08SJed Brown    TSGLAdapt - Abstract object that manages time-step adaptivity
249ed657a08SJed Brown 
250ed657a08SJed Brown    Level: beginner
251ed657a08SJed Brown 
252ed657a08SJed Brown .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType
253ed657a08SJed Brown S*/
254ed657a08SJed Brown typedef struct _p_TSGLAdapt *TSGLAdapt;
255ed657a08SJed Brown 
25676bdecfbSBarry Smith /*J
257ed657a08SJed Brown     TSGLAdaptType - String with the name of TSGLAdapt scheme or the creation function
258ed657a08SJed Brown        with an optional dynamic library name, for example
259ed657a08SJed Brown        http://www.mcs.anl.gov/petsc/lib.a:mytsgladaptcreate()
260ed657a08SJed Brown 
261ed657a08SJed Brown    Level: beginner
262ed657a08SJed Brown 
263ed657a08SJed Brown .seealso: TSGLAdaptSetType(), TS
26476bdecfbSBarry Smith J*/
265ed657a08SJed Brown #define TSGLAdaptType  char*
266ed657a08SJed Brown #define TSGLADAPT_NONE "none"
267ed657a08SJed Brown #define TSGLADAPT_SIZE "size"
268ed657a08SJed Brown #define TSGLADAPT_BOTH "both"
269ed657a08SJed Brown 
270ed657a08SJed Brown /*MC
271ed657a08SJed Brown    TSGLAdaptRegisterDynamic - adds a TSGLAdapt implementation
272ed657a08SJed Brown 
273ed657a08SJed Brown    Synopsis:
2741890ba74SBarry Smith    PetscErrorCode TSGLAdaptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS))
275ed657a08SJed Brown 
276ed657a08SJed Brown    Not Collective
277ed657a08SJed Brown 
278ed657a08SJed Brown    Input Parameters:
279ed657a08SJed Brown +  name_scheme - name of user-defined adaptivity scheme
280ed657a08SJed Brown .  path - path (either absolute or relative) the library containing this scheme
281ed657a08SJed Brown .  name_create - name of routine to create method context
282ed657a08SJed Brown -  routine_create - routine to create method context
283ed657a08SJed Brown 
284ed657a08SJed Brown    Notes:
285ed657a08SJed Brown    TSGLAdaptRegisterDynamic() may be called multiple times to add several user-defined families.
286ed657a08SJed Brown 
287ed657a08SJed Brown    If dynamic libraries are used, then the fourth input argument (routine_create)
288ed657a08SJed Brown    is ignored.
289ed657a08SJed Brown 
290ed657a08SJed Brown    Sample usage:
291ed657a08SJed Brown .vb
292ed657a08SJed Brown    TSGLAdaptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a,
293ed657a08SJed Brown                             "MySchemeCreate",MySchemeCreate);
294ed657a08SJed Brown .ve
295ed657a08SJed Brown 
296ed657a08SJed Brown    Then, your scheme can be chosen with the procedural interface via
297ed657a08SJed Brown $     TSGLAdaptSetType(ts,"my_scheme")
298ed657a08SJed Brown    or at runtime via the option
299ed657a08SJed Brown $     -ts_adapt_type my_scheme
300ed657a08SJed Brown 
301ed657a08SJed Brown    Level: advanced
302ed657a08SJed Brown 
303ed657a08SJed Brown    Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},
304ed657a08SJed Brown           and others of the form ${any_environmental_variable} occuring in pathname will be
305ed657a08SJed Brown           replaced with appropriate values.
306ed657a08SJed Brown 
307ed657a08SJed Brown .keywords: TSGLAdapt, register
308ed657a08SJed Brown 
309ed657a08SJed Brown .seealso: TSGLAdaptRegisterAll()
310ed657a08SJed Brown M*/
311ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
312ed657a08SJed Brown #  define TSGLAdaptRegisterDynamic(a,b,c,d)  TSGLAdaptRegister(a,b,c,0)
313ed657a08SJed Brown #else
314ed657a08SJed Brown #  define TSGLAdaptRegisterDynamic(a,b,c,d)  TSGLAdaptRegister(a,b,c,d)
315ed657a08SJed Brown #endif
316ed657a08SJed Brown 
3177087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptRegister(const char[],const char[],const char[],PetscErrorCode (*)(TSGLAdapt));
3187087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptRegisterAll(const char[]);
3197087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptRegisterDestroy(void);
3207087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptInitializePackage(const char[]);
3217087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptFinalizePackage(void);
3227087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptCreate(MPI_Comm,TSGLAdapt*);
3237087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptSetType(TSGLAdapt,const TSGLAdaptType);
3247087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]);
3257087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *);
3267087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptView(TSGLAdapt,PetscViewer);
3277087cfbeSBarry Smith extern PetscErrorCode  TSGLAdaptSetFromOptions(TSGLAdapt);
328fcfd50ebSBarry Smith extern PetscErrorCode  TSGLAdaptDestroy(TSGLAdapt*);
329ed657a08SJed Brown 
33076bdecfbSBarry Smith /*J
331ed657a08SJed Brown     TSGLAcceptType - String with the name of TSGLAccept scheme or the function
332ed657a08SJed Brown        with an optional dynamic library name, for example
333ed657a08SJed Brown        http://www.mcs.anl.gov/petsc/lib.a:mytsglaccept()
334ed657a08SJed Brown 
335ed657a08SJed Brown    Level: beginner
336ed657a08SJed Brown 
337ed657a08SJed Brown .seealso: TSGLSetAcceptType(), TS
33876bdecfbSBarry Smith J*/
339ed657a08SJed Brown #define TSGLAcceptType  char*
340ed657a08SJed Brown #define TSGLACCEPT_ALWAYS "always"
341ed657a08SJed Brown 
342ace3abfcSBarry Smith typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *);
3437087cfbeSBarry Smith extern PetscErrorCode  TSGLAcceptRegister(const char[],const char[],const char[],TSGLAcceptFunction);
344ed657a08SJed Brown 
345ed657a08SJed Brown /*MC
346ed657a08SJed Brown    TSGLAcceptRegisterDynamic - adds a TSGL acceptance scheme
347ed657a08SJed Brown 
348ed657a08SJed Brown    Synopsis:
3491890ba74SBarry Smith    PetscErrorCode TSGLAcceptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS))
350ed657a08SJed Brown 
351ed657a08SJed Brown    Not Collective
352ed657a08SJed Brown 
353ed657a08SJed Brown    Input Parameters:
354ed657a08SJed Brown +  name_scheme - name of user-defined acceptance scheme
355ed657a08SJed Brown .  path - path (either absolute or relative) the library containing this scheme
356ed657a08SJed Brown .  name_create - name of routine to create method context
357ed657a08SJed Brown -  routine_create - routine to create method context
358ed657a08SJed Brown 
359ed657a08SJed Brown    Notes:
360ed657a08SJed Brown    TSGLAcceptRegisterDynamic() may be called multiple times to add several user-defined families.
361ed657a08SJed Brown 
362ed657a08SJed Brown    If dynamic libraries are used, then the fourth input argument (routine_create)
363ed657a08SJed Brown    is ignored.
364ed657a08SJed Brown 
365ed657a08SJed Brown    Sample usage:
366ed657a08SJed Brown .vb
367ed657a08SJed Brown    TSGLAcceptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a,
368ed657a08SJed Brown                              "MySchemeCreate",MySchemeCreate);
369ed657a08SJed Brown .ve
370ed657a08SJed Brown 
371ed657a08SJed Brown    Then, your scheme can be chosen with the procedural interface via
372ed657a08SJed Brown $     TSGLSetAcceptType(ts,"my_scheme")
373ed657a08SJed Brown    or at runtime via the option
374ed657a08SJed Brown $     -ts_gl_accept_type my_scheme
375ed657a08SJed Brown 
376ed657a08SJed Brown    Level: advanced
377ed657a08SJed Brown 
378ed657a08SJed Brown    Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},
379ed657a08SJed Brown           and others of the form ${any_environmental_variable} occuring in pathname will be
380ed657a08SJed Brown           replaced with appropriate values.
381ed657a08SJed Brown 
382ed657a08SJed Brown .keywords: TSGL, TSGLAcceptType, register
383ed657a08SJed Brown 
384ed657a08SJed Brown .seealso: TSGLRegisterAll()
385ed657a08SJed Brown M*/
386ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
387ed657a08SJed Brown #  define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,0)
388ed657a08SJed Brown #else
389ed657a08SJed Brown #  define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,d)
390ed657a08SJed Brown #endif
391ed657a08SJed Brown 
39276bdecfbSBarry Smith /*J
39318b56cb9SJed Brown   TSGLType - family of time integration method within the General Linear class
39418b56cb9SJed Brown 
39518b56cb9SJed Brown   Level: beginner
39618b56cb9SJed Brown 
39718b56cb9SJed Brown .seealso: TSGLSetType(), TSGLRegister()
39876bdecfbSBarry Smith J*/
39918b56cb9SJed Brown #define TSGLType char*
400ed657a08SJed Brown #define TSGL_IRKS   "irks"
40118b56cb9SJed Brown 
402ed657a08SJed Brown /*MC
403ed657a08SJed Brown    TSGLRegisterDynamic - adds a TSGL implementation
40418b56cb9SJed Brown 
405ed657a08SJed Brown    Synopsis:
4061890ba74SBarry Smith    PetscErrorCode TSGLRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS))
407ed657a08SJed Brown 
408ed657a08SJed Brown    Not Collective
409ed657a08SJed Brown 
410ed657a08SJed Brown    Input Parameters:
411ed657a08SJed Brown +  name_scheme - name of user-defined general linear scheme
412ed657a08SJed Brown .  path - path (either absolute or relative) the library containing this scheme
413ed657a08SJed Brown .  name_create - name of routine to create method context
414ed657a08SJed Brown -  routine_create - routine to create method context
415ed657a08SJed Brown 
416ed657a08SJed Brown    Notes:
417ed657a08SJed Brown    TSGLRegisterDynamic() may be called multiple times to add several user-defined families.
418ed657a08SJed Brown 
419ed657a08SJed Brown    If dynamic libraries are used, then the fourth input argument (routine_create)
420ed657a08SJed Brown    is ignored.
421ed657a08SJed Brown 
422ed657a08SJed Brown    Sample usage:
423ed657a08SJed Brown .vb
424ed657a08SJed Brown    TSGLRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a,
425ed657a08SJed Brown                        "MySchemeCreate",MySchemeCreate);
426ed657a08SJed Brown .ve
427ed657a08SJed Brown 
428ed657a08SJed Brown    Then, your scheme can be chosen with the procedural interface via
429ed657a08SJed Brown $     TSGLSetType(ts,"my_scheme")
430ed657a08SJed Brown    or at runtime via the option
431ed657a08SJed Brown $     -ts_gl_type my_scheme
432ed657a08SJed Brown 
433ed657a08SJed Brown    Level: advanced
434ed657a08SJed Brown 
435ed657a08SJed Brown    Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR},
436ed657a08SJed Brown           and others of the form ${any_environmental_variable} occuring in pathname will be
437ed657a08SJed Brown           replaced with appropriate values.
438ed657a08SJed Brown 
439ed657a08SJed Brown .keywords: TSGL, register
440ed657a08SJed Brown 
441ed657a08SJed Brown .seealso: TSGLRegisterAll()
442ed657a08SJed Brown M*/
443ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
444ed657a08SJed Brown #  define TSGLRegisterDynamic(a,b,c,d)       TSGLRegister(a,b,c,0)
445ed657a08SJed Brown #else
446ed657a08SJed Brown #  define TSGLRegisterDynamic(a,b,c,d)       TSGLRegister(a,b,c,d)
447ed657a08SJed Brown #endif
448ed657a08SJed Brown 
4497087cfbeSBarry Smith extern PetscErrorCode  TSGLRegister(const char[],const char[],const char[],PetscErrorCode(*)(TS));
4507087cfbeSBarry Smith extern PetscErrorCode  TSGLRegisterAll(const char[]);
4517087cfbeSBarry Smith extern PetscErrorCode  TSGLRegisterDestroy(void);
4527087cfbeSBarry Smith extern PetscErrorCode  TSGLInitializePackage(const char[]);
4537087cfbeSBarry Smith extern PetscErrorCode  TSGLFinalizePackage(void);
4547087cfbeSBarry Smith extern PetscErrorCode  TSGLSetType(TS,const TSGLType);
4557087cfbeSBarry Smith extern PetscErrorCode  TSGLGetAdapt(TS,TSGLAdapt*);
4567087cfbeSBarry Smith extern PetscErrorCode  TSGLSetAcceptType(TS,const TSGLAcceptType);
45718b56cb9SJed Brown 
4588a381b04SJed Brown #define TSARKIMEXType char*
4598a381b04SJed Brown #define TSARKIMEX2D "2d"
460a3a57f36SJed Brown #define TSARKIMEX2E "2e"
4618a381b04SJed Brown #define TSARKIMEX3  "3"
4628a381b04SJed Brown #define TSARKIMEX4  "4"
4638a381b04SJed Brown #define TSARKIMEX5  "5"
4648a381b04SJed Brown extern PetscErrorCode TSARKIMEXGetType(TS ts,const TSARKIMEXType*);
4658a381b04SJed Brown extern PetscErrorCode TSARKIMEXSetType(TS ts,const TSARKIMEXType);
4664cc180ffSJed Brown extern PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool);
467cd652676SJed Brown extern PetscErrorCode TSARKIMEXRegister(const TSARKIMEXType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[],const PetscReal[]);
4688a381b04SJed Brown extern PetscErrorCode TSARKIMEXFinalizePackage(void);
4698a381b04SJed Brown extern PetscErrorCode TSARKIMEXInitializePackage(const char path[]);
4708a381b04SJed Brown extern PetscErrorCode TSARKIMEXRegisterDestroy(void);
4718a381b04SJed Brown extern PetscErrorCode TSARKIMEXRegisterAll(void);
4728a381b04SJed Brown 
473e27a552bSJed Brown #if defined(PETSC_HAVE_ROSW)
474e27a552bSJed Brown #define TSRosWType char*
475e27a552bSJed Brown #define TSROSW2D "2d"
476e27a552bSJed Brown #define TSROSW2E "2e"
477e27a552bSJed Brown #define TSROSW3  "3"
478e27a552bSJed Brown #define TSROSW4  "4"
479e27a552bSJed Brown #define TSROSW5  "5"
480e27a552bSJed Brown extern PetscErrorCode TSRosWGetType(TS ts,const TSRosWType*);
481e27a552bSJed Brown extern PetscErrorCode TSRosWSetType(TS ts,const TSRosWType);
482e27a552bSJed Brown extern PetscErrorCode TSRosWSetFullyImplicit(TS,PetscBool);
483e27a552bSJed Brown extern PetscErrorCode TSRosWRegister(const TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[],const PetscReal[]);
484e27a552bSJed Brown extern PetscErrorCode TSRosWFinalizePackage(void);
485e27a552bSJed Brown extern PetscErrorCode TSRosWInitializePackage(const char path[]);
486e27a552bSJed Brown extern PetscErrorCode TSRosWRegisterDestroy(void);
487e27a552bSJed Brown extern PetscErrorCode TSRosWRegisterAll(void);
488e27a552bSJed Brown #endif
489e27a552bSJed Brown 
49083e2fdc7SBarry Smith /*
4910f3b3ca1SHong Zhang        PETSc interface to Sundials
49283e2fdc7SBarry Smith */
4936dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS
4946fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType;
4956fadb2cdSHong Zhang extern const char *TSSundialsLmmTypes[];
4966fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType;
497a04cf4d8SBarry Smith extern const char *TSSundialsGramSchmidtTypes[];
4987087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetType(TS,TSSundialsLmmType);
4997087cfbeSBarry Smith extern PetscErrorCode   TSSundialsGetPC(TS,PC*);
5007087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetTolerance(TS,PetscReal,PetscReal);
5017087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetMinTimeStep(TS,PetscReal);
5027087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetMaxTimeStep(TS,PetscReal);
5037087cfbeSBarry Smith extern PetscErrorCode   TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
5047087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
5057087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetGMRESRestart(TS,PetscInt);
5067087cfbeSBarry Smith extern PetscErrorCode   TSSundialsSetLinearTolerance(TS,PetscReal);
5077087cfbeSBarry Smith extern PetscErrorCode   TSSundialsMonitorInternalSteps(TS,PetscBool );
5087087cfbeSBarry Smith extern PetscErrorCode   TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]);
50954c84890SJed Brown extern PetscErrorCode   TSSundialsSetMaxl(TS,PetscInt);
5106dc17ff5SMatthew Knepley #endif
51183e2fdc7SBarry Smith 
5127087cfbeSBarry Smith extern PetscErrorCode   TSRKSetTolerance(TS,PetscReal);
513262ff7bbSBarry Smith 
5147087cfbeSBarry Smith extern PetscErrorCode  TSThetaSetTheta(TS,PetscReal);
5157087cfbeSBarry Smith extern PetscErrorCode  TSThetaGetTheta(TS,PetscReal*);
51626f2ff8fSLisandro Dalcin extern PetscErrorCode  TSThetaGetEndpoint(TS,PetscBool*);
517eb284becSJed Brown extern PetscErrorCode  TSThetaSetEndpoint(TS,PetscBool);
5180de4c49aSJed Brown 
5197087cfbeSBarry Smith extern PetscErrorCode  TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*);
5207087cfbeSBarry Smith extern PetscErrorCode  TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*);
5217087cfbeSBarry Smith extern PetscErrorCode  TSAlphaSetRadius(TS,PetscReal);
5227087cfbeSBarry Smith extern PetscErrorCode  TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal);
5237087cfbeSBarry Smith extern PetscErrorCode  TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*);
52488df8a41SLisandro Dalcin 
5257087cfbeSBarry Smith extern PetscErrorCode  TSSetDM(TS,DM);
5267087cfbeSBarry Smith extern PetscErrorCode  TSGetDM(TS,DM*);
5276c699258SBarry Smith 
5287087cfbeSBarry Smith extern PetscErrorCode  SNESTSFormFunction(SNES,Vec,Vec,void*);
5297087cfbeSBarry Smith extern PetscErrorCode  SNESTSFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*);
5300f5c6efeSJed Brown 
531e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END
532818ad0c1SBarry Smith #endif
533