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