1 /* $Id: petscts.h,v 1.47 2001/08/06 15:42:42 bsmith Exp $ */ 2 /* 3 User interface for the timestepping package. This is package 4 is for use in solving time-dependent PDEs. 5 */ 6 #if !defined(__PETSCTS_H) 7 #define __PETSCTS_H 8 #include "petscsnes.h" 9 10 /*S 11 TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 12 13 Level: beginner 14 15 Concepts: ODE solvers 16 17 .seealso: TSCreate(), TSSetType(), TSType, SNES, SLES, KSP, PC 18 S*/ 19 typedef struct _p_TS* TS; 20 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() 25 26 Level: beginner 27 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 typedef char *TSType; 37 38 typedef char *TSSerializeType; 39 40 /*E 41 TSProblemType - Determines the type of problem this TS object is to be used to solve 42 43 Level: beginner 44 45 .seealso: TSCreate() 46 E*/ 47 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 48 49 /* Logging support */ 50 extern int TS_COOKIE; 51 extern int TS_Step, TS_PseudoComputeTimeStep, TS_FunctionEval, TS_JacobianEval; 52 53 EXTERN int TSInitializePackage(const char[]); 54 55 EXTERN int TSCreate(MPI_Comm,TS*); 56 EXTERN int TSSerialize(MPI_Comm, TS *, PetscViewer, PetscTruth); 57 EXTERN int TSDestroy(TS); 58 59 EXTERN int TSSetProblemType(TS,TSProblemType); 60 EXTERN int TSGetProblemType(TS,TSProblemType*); 61 EXTERN int TSSetMonitor(TS,int(*)(TS,int,PetscReal,Vec,void*),void *,int (*)(void*)); 62 EXTERN int TSClearMonitor(TS); 63 64 EXTERN int TSSetOptionsPrefix(TS,const char[]); 65 EXTERN int TSAppendOptionsPrefix(TS,const char[]); 66 EXTERN int TSGetOptionsPrefix(TS,char *[]); 67 EXTERN int TSSetFromOptions(TS); 68 EXTERN int TSSetUp(TS); 69 70 EXTERN int TSSetSolution(TS,Vec); 71 EXTERN int TSGetSolution(TS,Vec*); 72 73 EXTERN int TSSetDuration(TS,int,PetscReal); 74 EXTERN int TSGetDuration(TS,int*,PetscReal*); 75 76 EXTERN int TSDefaultMonitor(TS,int,PetscReal,Vec,void*); 77 EXTERN int TSVecViewMonitor(TS,int,PetscReal,Vec,void*); 78 EXTERN int TSStep(TS,int *,PetscReal*); 79 80 EXTERN int TSSetInitialTimeStep(TS,PetscReal,PetscReal); 81 EXTERN int TSGetTimeStep(TS,PetscReal*); 82 EXTERN int TSGetTime(TS,PetscReal*); 83 EXTERN int TSGetTimeStepNumber(TS,int*); 84 EXTERN int TSSetTimeStep(TS,PetscReal); 85 86 EXTERN int TSSetRHSFunction(TS,int (*)(TS,PetscReal,Vec,Vec,void*),void*); 87 EXTERN int TSSetRHSMatrix(TS,Mat,Mat,int (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),void*); 88 EXTERN int TSSetRHSJacobian(TS,Mat,Mat,int(*)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*),void*); 89 EXTERN int TSSetRHSBoundaryConditions(TS,int (*)(TS,PetscReal,Vec,void*),void*); 90 91 EXTERN int TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 92 EXTERN int TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 93 94 EXTERN int TSGetRHSMatrix(TS,Mat*,Mat*,void**); 95 EXTERN int TSGetRHSJacobian(TS,Mat*,Mat*,void**); 96 97 extern int TSSetRhsBC(TS, int (*)(TS, Vec, void *)); 98 extern int TSSetSystemMatrixBC(TS, int (*)(TS, Mat, Mat, void *)); 99 extern int TSSetSolutionBC(TS, int (*)(TS, Vec, void *)); 100 extern int TSSetPreStep(TS, int (*)(TS)); 101 extern int TSSetUpdate(TS, int (*)(TS, PetscReal, PetscReal *)); 102 extern int TSSetPostStep(TS, int (*)(TS)); 103 extern int TSDefaultRhsBC(TS, Vec, void *); 104 extern int TSDefaultSystemMatrixBC(TS, Mat, Mat, void *); 105 extern int TSDefaultSolutionBC(TS, Vec, void *); 106 extern int TSDefaultPreStep(TS); 107 extern int TSDefaultUpdate(TS, PetscReal, PetscReal *); 108 extern int TSDefaultPostStep(TS); 109 extern int TSSetIdentity(TS, int (*)(TS, double, Mat *, void *)); 110 111 EXTERN int TSPseudoSetTimeStep(TS,int(*)(TS,PetscReal*,void*),void*); 112 EXTERN int TSPseudoDefaultTimeStep(TS,PetscReal*,void*); 113 EXTERN int TSPseudoComputeTimeStep(TS,PetscReal *); 114 115 EXTERN int TSPseudoSetVerifyTimeStep(TS,int(*)(TS,Vec,void*,PetscReal*,int*),void*); 116 EXTERN int TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,int*); 117 EXTERN int TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,int*); 118 EXTERN int TSPseudoSetTimeStepIncrement(TS,PetscReal); 119 EXTERN int TSPseudoIncrementDtFromInitialDt(TS); 120 121 EXTERN int TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 122 EXTERN int TSComputeRHSBoundaryConditions(TS,PetscReal,Vec); 123 EXTERN int TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 124 125 /* Dynamic creation and loading functions */ 126 extern PetscFList TSList; 127 extern PetscTruth TSRegisterAllCalled; 128 EXTERN int TSGetType(TS,TSType*); 129 EXTERN int TSSetType(TS,TSType); 130 EXTERN int TSRegister(const char[], const char[], const char[], int (*)(TS)); 131 EXTERN int TSRegisterAll(const char[]); 132 EXTERN int TSRegisterDestroy(void); 133 134 /*MC 135 TSRegisterDynamic - Adds a creation method to the TS package. 136 137 Synopsis: 138 139 TSRegisterDynamic(char *name, char *path, char *func_name, int (*create_func)(TS)) 140 141 Not Collective 142 143 Input Parameters: 144 + name - The name of a new user-defined creation routine 145 . path - The path (either absolute or relative) of the library containing this routine 146 . func_name - The name of the creation routine 147 - create_func - The creation routine itself 148 149 Notes: 150 TSRegisterDynamic() may be called multiple times to add several user-defined tses. 151 152 If dynamic libraries are used, then the fourth input argument (create_func) is ignored. 153 154 Sample usage: 155 .vb 156 TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate); 157 .ve 158 159 Then, your ts type can be chosen with the procedural interface via 160 .vb 161 TSCreate(MPI_Comm, TS *); 162 TSSetType(vec, "my_ts") 163 .ve 164 or at runtime via the option 165 .vb 166 -ts_type my_ts 167 .ve 168 169 Notes: $PETSC_ARCH and $BOPT occuring in pathname will be replaced with appropriate values. 170 If your function is not being put into a shared library then use TSRegister() instead 171 172 Level: advanced 173 174 .keywords: TS, register 175 .seealso: TSRegisterAll(), TSRegisterDestroy() 176 M*/ 177 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 178 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 179 #else 180 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 181 #endif 182 183 extern PetscFList TSSerializeList; 184 extern PetscTruth TSSerializeRegisterAllCalled; 185 EXTERN int TSSetSerializeType(TS, TSSerializeType); 186 EXTERN int TSGetSerializeType(TS, TSSerializeType *); 187 EXTERN int TSSerializeRegister(const char [], const char [], const char [], int (*)(MPI_Comm, TS *, PetscViewer, PetscTruth)); 188 EXTERN int TSSerializeRegisterAll(const char []); 189 EXTERN int TSSerializeRegisterDestroy(void); 190 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 191 #define TSSerializeRegisterDynamic(a,b,c,d) TSSerializeRegister(a,b,c,0) 192 #else 193 #define TSSerializeRegisterDynamic(a,b,c,d) TSSerializeRegister(a,b,c,d) 194 #endif 195 196 EXTERN int TSGetSNES(TS,SNES*); 197 EXTERN int TSGetSLES(TS,SLES*); 198 199 EXTERN int TSView(TS,PetscViewer); 200 EXTERN int TSViewFromOptions(TS,const char[]); 201 202 EXTERN int TSSetApplicationContext(TS,void *); 203 EXTERN int TSGetApplicationContext(TS,void **); 204 205 EXTERN int TSLGMonitorCreate(const char[],const char[],int,int,int,int,PetscDrawLG *); 206 EXTERN int TSLGMonitor(TS,int,PetscReal,Vec,void *); 207 EXTERN int TSLGMonitorDestroy(PetscDrawLG); 208 209 /* 210 PETSc interface to PVode 211 */ 212 #define PVODE_UNMODIFIED_GS PVODE_CLASSICAL_GS 213 typedef enum { PVODE_ADAMS,PVODE_BDF } TSPVodeType; 214 typedef enum { PVODE_MODIFIED_GS = 0,PVODE_CLASSICAL_GS = 1 } TSPVodeGramSchmidtType; 215 EXTERN int TSPVodeSetType(TS,TSPVodeType); 216 EXTERN int TSPVodeGetPC(TS,PC*); 217 EXTERN int TSPVodeSetTolerance(TS,PetscReal,PetscReal); 218 EXTERN int TSPVodeGetIterations(TS,int *,int *); 219 EXTERN int TSPVodeSetGramSchmidtType(TS,TSPVodeGramSchmidtType); 220 EXTERN int TSPVodeSetGMRESRestart(TS,int); 221 EXTERN int TSPVodeSetLinearTolerance(TS,PetscReal); 222 EXTERN int TSPVodeSetExactFinalTime(TS,PetscTruth); 223 EXTERN int TSPVodeGetParameters(TS,int *,long int*[],double*[]); 224 225 #endif 226 227 228 229 230 231