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_PVODE           "pvode"
 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 */

 51: EXTERN PetscErrorCode TSInitializePackage(const char[]);

 53: EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*);
 54: EXTERN PetscErrorCode TSDestroy(TS);

 56: EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType);
 57: EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*);
 58: EXTERN PetscErrorCode TSSetMonitor(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void*));
 59: EXTERN PetscErrorCode TSClearMonitor(TS);

 61: EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]);
 62: EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]);
 63: EXTERN PetscErrorCode TSGetOptionsPrefix(TS,char *[]);
 64: EXTERN PetscErrorCode TSSetFromOptions(TS);
 65: EXTERN PetscErrorCode TSSetUp(TS);

 67: EXTERN PetscErrorCode TSSetSolution(TS,Vec);
 68: EXTERN PetscErrorCode TSGetSolution(TS,Vec*);

 70: EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal);
 71: EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*);

 73: EXTERN PetscErrorCode TSDefaultMonitor(TS,PetscInt,PetscReal,Vec,void*);
 74: EXTERN PetscErrorCode TSVecViewMonitor(TS,PetscInt,PetscReal,Vec,void*);
 75: EXTERN PetscErrorCode TSStep(TS,PetscInt *,PetscReal*);

 77: EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal);
 78: EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*);
 79: EXTERN PetscErrorCode TSGetTime(TS,PetscReal*);
 80: EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*);
 81: EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal);

 83: EXTERN PetscErrorCode TSSetRHSFunction(TS,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),void*);
 84: EXTERN PetscErrorCode TSSetRHSMatrix(TS,Mat,Mat,PetscErrorCode (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),void*);
 85: EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,PetscErrorCode (*)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*),void*);
 86: EXTERN PetscErrorCode TSSetRHSBoundaryConditions(TS,PetscErrorCode (*)(TS,PetscReal,Vec,void*),void*);

 88: EXTERN PetscErrorCode TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);
 89: EXTERN PetscErrorCode TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*);

 91: EXTERN PetscErrorCode TSGetRHSMatrix(TS,Mat*,Mat*,void**);
 92: EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,void**);

 94: EXTERN PetscErrorCode TSSetRhsBC(TS, PetscErrorCode (*)(TS, Vec, void *));
 95: EXTERN PetscErrorCode TSSetSystemMatrixBC(TS, PetscErrorCode (*)(TS, Mat, Mat, void *));
 96: EXTERN PetscErrorCode TSSetSolutionBC(TS, PetscErrorCode (*)(TS, Vec, void *));
 97: EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS));
 98: EXTERN PetscErrorCode TSSetUpdate(TS, PetscErrorCode (*)(TS, PetscReal, PetscReal *));
 99: EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS));
100: EXTERN PetscErrorCode TSDefaultRhsBC(TS, Vec, void *);
101: EXTERN PetscErrorCode TSDefaultSystemMatrixBC(TS, Mat, Mat, void *);
102: EXTERN PetscErrorCode TSDefaultSolutionBC(TS, Vec, void *);
103: EXTERN PetscErrorCode TSDefaultPreStep(TS);
104: EXTERN PetscErrorCode TSDefaultUpdate(TS, PetscReal, PetscReal *);
105: EXTERN PetscErrorCode TSDefaultPostStep(TS);
106: EXTERN PetscErrorCode TSSetIdentity(TS, PetscErrorCode (*)(TS, double, Mat *, void *));

108: EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*);
109: EXTERN PetscErrorCode TSPseudoDefaultTimeStep(TS,PetscReal*,void*);
110: EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *);

112: EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscTruth*),void*);
113: EXTERN PetscErrorCode TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscTruth*);
114: EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscTruth*);
115: EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal);
116: EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS);

118: EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec);
119: EXTERN PetscErrorCode TSComputeRHSBoundaryConditions(TS,PetscReal,Vec);
120: EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*);

122: /* Dynamic creation and loading functions */
125: EXTERN PetscErrorCode TSGetType(TS,TSType*);
126: EXTERN PetscErrorCode TSSetType(TS,const TSType);
127: EXTERN PetscErrorCode TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS));
128: EXTERN PetscErrorCode TSRegisterAll(const char[]);
129: EXTERN PetscErrorCode TSRegisterDestroy(void);

131: /*MC
132:   TSRegisterDynamic - Adds a creation method to the TS package.

134:   Synopsis:
135:   PetscErrorCode TSRegisterDynamic(char *name, char *path, char *func_name, PetscErrorCode (*create_func)(TS))

137:   Not Collective

139:   Input Parameters:
140: + name        - The name of a new user-defined creation routine
141: . path        - The path (either absolute or relative) of the library containing this routine
142: . func_name   - The name of the creation routine
143: - create_func - The creation routine itself

145:   Notes:
146:   TSRegisterDynamic() may be called multiple times to add several user-defined tses.

148:   If dynamic libraries are used, then the fourth input argument (create_func) is ignored.

150:   Sample usage:
151: .vb
152:   TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate);
153: .ve

155:   Then, your ts type can be chosen with the procedural interface via
156: .vb
157:     TSCreate(MPI_Comm, TS *);
158:     TSSetType(vec, "my_ts")
159: .ve
160:   or at runtime via the option
161: .vb
162:     -ts_type my_ts
163: .ve

165:   Notes: $PETSC_ARCH and $BOPT occuring in pathname will be replaced with appropriate values.
166:         If your function is not being put into a shared library then use TSRegister() instead

168:   Level: advanced

170: .keywords: TS, register
171: .seealso: TSRegisterAll(), TSRegisterDestroy()
172: M*/
173: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
174: #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0)
175: #else
176: #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d)
177: #endif

179: EXTERN PetscErrorCode TSGetSNES(TS,SNES*);
180: EXTERN PetscErrorCode TSGetKSP(TS,KSP*);

182: EXTERN PetscErrorCode TSView(TS,PetscViewer);
183: EXTERN PetscErrorCode TSViewFromOptions(TS,const char[]);

185: EXTERN PetscErrorCode TSSetApplicationContext(TS,void *);
186: EXTERN PetscErrorCode TSGetApplicationContext(TS,void **);

188: EXTERN PetscErrorCode TSLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG *);
189: EXTERN PetscErrorCode TSLGMonitor(TS,PetscInt,PetscReal,Vec,void *);
190: EXTERN PetscErrorCode TSLGMonitorDestroy(PetscDrawLG);

192: /*
193:        PETSc interface to PVode
194: */
195: #define PVODE_UNMODIFIED_GS PVODE_CLASSICAL_GS
196: typedef enum { PVODE_ADAMS,PVODE_BDF } TSPVodeType;
197: typedef enum { PVODE_MODIFIED_GS = 0,PVODE_CLASSICAL_GS = 1 } TSPVodeGramSchmidtType;
198: EXTERN PetscErrorCode TSPVodeSetType(TS,TSPVodeType);
199: EXTERN PetscErrorCode TSPVodeGetPC(TS,PC*);
200: EXTERN PetscErrorCode TSPVodeSetTolerance(TS,PetscReal,PetscReal);
201: EXTERN PetscErrorCode TSPVodeGetIterations(TS,PetscInt *,PetscInt *);
202: EXTERN PetscErrorCode TSPVodeSetGramSchmidtType(TS,TSPVodeGramSchmidtType);
203: EXTERN PetscErrorCode TSPVodeSetGMRESRestart(TS,PetscInt);
204: EXTERN PetscErrorCode TSPVodeSetLinearTolerance(TS,PetscReal);
205: EXTERN PetscErrorCode TSPVodeSetExactFinalTime(TS,PetscTruth);
206: EXTERN PetscErrorCode TSPVodeGetParameters(TS,PetscInt *,long int*[],double*[]);

208: EXTERN PetscErrorCode TSRKSetTolerance(TS,PetscReal);

211: #endif