Actual source code: petscts.h
1: /*
2: User interface for the timestepping package. This is package
3: is for use in solving time-dependent PDEs.
4: */
7: #include petscsnes.h
10: /*S
11: TS - Abstract PETSc object that manages all time-steppers (ODE integrators)
13: Level: beginner
15: Concepts: ODE solvers
17: .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC
18: S*/
19: typedef struct _p_TS* TS;
21: /*E
22: TSType - String with the name of a PETSc TS method or the creation function
23: with an optional dynamic library name, for example
24: http://www.mcs.anl.gov/petsc/lib.a:mytscreate()
26: Level: beginner
28: .seealso: TSSetType(), TS
29: E*/
30: #define TS_EULER "euler"
31: #define TS_BEULER "beuler"
32: #define TS_PSEUDO "pseudo"
33: #define TS_CRANK_NICHOLSON "crank-nicholson"
34: #define TS_SUNDIALS "sundials"
35: #define TS_RUNGE_KUTTA "runge-kutta"
36: #define TSType char*
38: /*E
39: TSProblemType - Determines the type of problem this TS object is to be used to solve
41: Level: beginner
43: .seealso: TSCreate()
44: E*/
45: typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType;
47: /* Logging support */
50: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSInitializePackage(const char[]);
52: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSCreate(MPI_Comm,TS*);
53: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDestroy(TS);
55: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetProblemType(TS,TSProblemType);
56: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetProblemType(TS,TSProblemType*);
57: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetMonitor(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void*));
58: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSClearMonitor(TS);
60: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetOptionsPrefix(TS,const char[]);
61: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSAppendOptionsPrefix(TS,const char[]);
62: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetOptionsPrefix(TS,const char *[]);
63: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetFromOptions(TS);
64: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetUp(TS);
66: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetSolution(TS,Vec);
67: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetSolution(TS,Vec*);
69: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetDuration(TS,PetscInt,PetscReal);
70: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetDuration(TS,PetscInt*,PetscReal*);
72: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultMonitor(TS,PetscInt,PetscReal,Vec,void*);
73: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSVecViewMonitor(TS,PetscInt,PetscReal,Vec,void*);
74: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSStep(TS,PetscInt *,PetscReal*);
76: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetInitialTimeStep(TS,PetscReal,PetscReal);
77: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTimeStep(TS,PetscReal*);
78: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTime(TS,PetscReal*);
79: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTimeStepNumber(TS,PetscInt*);
80: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetTimeStep(TS,PetscReal);
82: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSFunction(TS,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),void*);
83: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSMatrix(TS,Mat,Mat,PetscErrorCode (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),void*);
84: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSJacobian(TS,Mat,Mat,PetscErrorCode (*)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*),void*);
85: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSBoundaryConditions(TS,PetscErrorCode (*)(TS,PetscReal,Vec,void*),void*);
87: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
88: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
90: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetRHSMatrix(TS,Mat*,Mat*,void**);
91: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetRHSJacobian(TS,Mat*,Mat*,void**);
93: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetSystemMatrixBC(TS, PetscErrorCode (*)(TS, Mat, Mat, void *));
94: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetSolutionBC(TS, PetscErrorCode (*)(TS, Vec, void *));
95: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetPreStep(TS, PetscErrorCode (*)(TS));
96: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetUpdate(TS, PetscErrorCode (*)(TS, PetscReal, PetscReal *));
97: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetPostStep(TS, PetscErrorCode (*)(TS));
98: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultRhsBC(TS, Vec, void *);
99: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultSystemMatrixBC(TS, Mat, Mat, void *);
100: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultSolutionBC(TS, Vec, void *);
101: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultPreStep(TS);
102: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultUpdate(TS, PetscReal, PetscReal *);
103: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultPostStep(TS);
105: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
106: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoDefaultTimeStep(TS,PetscReal*,void*);
107: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoComputeTimeStep(TS,PetscReal *);
109: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscTruth*),void*);
110: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscTruth*);
111: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscTruth*);
112: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetTimeStepIncrement(TS,PetscReal);
113: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoIncrementDtFromInitialDt(TS);
115: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
116: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSBoundaryConditions(TS,PetscReal,Vec);
117: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*);
119: /* Dynamic creation and loading functions */
122: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetType(TS,TSType*);
123: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetType(TS,const TSType);
124: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS));
125: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegisterAll(const char[]);
126: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegisterDestroy(void);
128: /*MC
129: TSRegisterDynamic - Adds a creation method to the TS package.
131: Synopsis:
132: PetscErrorCode TSRegisterDynamic(char *name, char *path, char *func_name, PetscErrorCode (*create_func)(TS))
134: Not Collective
136: Input Parameters:
137: + name - The name of a new user-defined creation routine
138: . path - The path (either absolute or relative) of the library containing this routine
139: . func_name - The name of the creation routine
140: - create_func - The creation routine itself
142: Notes:
143: TSRegisterDynamic() may be called multiple times to add several user-defined tses.
145: If dynamic libraries are used, then the fourth input argument (create_func) is ignored.
147: Sample usage:
148: .vb
149: TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate);
150: .ve
152: Then, your ts type can be chosen with the procedural interface via
153: .vb
154: TSCreate(MPI_Comm, TS *);
155: TSSetType(vec, "my_ts")
156: .ve
157: or at runtime via the option
158: .vb
159: -ts_type my_ts
160: .ve
162: Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
163: If your function is not being put into a shared library then use TSRegister() instead
165: Level: advanced
167: .keywords: TS, register
168: .seealso: TSRegisterAll(), TSRegisterDestroy()
169: M*/
170: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
171: #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0)
172: #else
173: #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d)
174: #endif
176: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetSNES(TS,SNES*);
177: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetKSP(TS,KSP*);
179: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSView(TS,PetscViewer);
180: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSViewFromOptions(TS,const char[]);
182: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetApplicationContext(TS,void *);
183: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetApplicationContext(TS,void **);
185: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG *);
186: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSLGMonitor(TS,PetscInt,PetscReal,Vec,void *);
187: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSLGMonitorDestroy(PetscDrawLG);
189: /*
190: PETSc interface to Sundials
191: */
192: #ifdef PETSC_HAVE_SUNDIALS
193: #define SUNDIALS_UNMODIFIED_GS SUNDIALS_CLASSICAL_GS
194: typedef enum { SUNDIALS_ADAMS,SUNDIALS_BDF } TSSundialsType;
195: typedef enum { SUNDIALS_MODIFIED_GS = 0,SUNDIALS_CLASSICAL_GS = 1 } TSSundialsGramSchmidtType;
196: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetType(TS,TSSundialsType);
197: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetPC(TS,PC*);
198: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetTolerance(TS,PetscReal,PetscReal);
199: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetIterations(TS,PetscInt *,PetscInt *);
200: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType);
201: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetGMRESRestart(TS,PetscInt);
202: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetLinearTolerance(TS,PetscReal);
203: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetExactFinalTime(TS,PetscTruth);
204: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetParameters(TS,PetscInt *,long int*[],double*[]);
205: #endif
207: EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRKSetTolerance(TS,PetscReal);
210: #endif