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