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 TSType char* 31 #define TS_EULER "euler" 32 #define TS_BEULER "beuler" 33 #define TS_PSEUDO "pseudo" 34 #define TS_CRANK_NICHOLSON "crank-nicholson" 35 #define TS_SUNDIALS "sundials" 36 #define TS_RUNGE_KUTTA "runge-kutta" 37 #define TS_PYTHON "python" 38 39 /*E 40 TSProblemType - Determines the type of problem this TS object is to be used to solve 41 42 Level: beginner 43 44 .seealso: TSCreate() 45 E*/ 46 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 47 48 /* Logging support */ 49 extern PetscCookie PETSCTS_DLLEXPORT TS_COOKIE; 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 TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void*)); 59 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorCancel(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 TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*); 74 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorSolution(TS,PetscInt,PetscReal,Vec,void*); 75 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSStep(TS,PetscInt *,PetscReal*); 76 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSolve(TS,Vec); 77 78 79 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetInitialTimeStep(TS,PetscReal,PetscReal); 80 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTimeStep(TS,PetscReal*); 81 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTime(TS,PetscReal*); 82 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetTime(TS,PetscReal); 83 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTimeStepNumber(TS,PetscInt*); 84 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetTimeStep(TS,PetscReal); 85 86 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSFunction(TS,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),void*); 87 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetMatrices(TS,Mat,PetscErrorCode (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),Mat,PetscErrorCode (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),MatStructure,void*); 88 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetMatrices(TS,Mat*,Mat*,void**); 89 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSJacobian(TS,Mat,Mat,PetscErrorCode (*)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*),void*); 90 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetRHSJacobian(TS,Mat*,Mat*,void**); 91 92 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 93 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 94 95 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetPreStep(TS, PetscErrorCode (*)(TS)); 96 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetPostStep(TS, PetscErrorCode (*)(TS)); 97 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultPreStep(TS); 98 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultUpdate(TS, PetscReal, PetscReal *); 99 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultPostStep(TS); 100 101 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 102 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoDefaultTimeStep(TS,PetscReal*,void*); 103 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoComputeTimeStep(TS,PetscReal *); 104 105 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscTruth*),void*); 106 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscTruth*); 107 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscTruth*); 108 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetTimeStepIncrement(TS,PetscReal); 109 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoIncrementDtFromInitialDt(TS); 110 111 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPythonSetType(TS,const char[]); 112 113 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 114 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 115 116 /* Dynamic creation and loading functions */ 117 extern PetscFList TSList; 118 extern PetscTruth TSRegisterAllCalled; 119 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetType(TS,const TSType*); 120 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetType(TS,const TSType); 121 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS)); 122 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegisterAll(const char[]); 123 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegisterDestroy(void); 124 125 /*MC 126 TSRegisterDynamic - Adds a creation method to the TS package. 127 128 Synopsis: 129 PetscErrorCode TSRegisterDynamic(char *name, char *path, char *func_name, PetscErrorCode (*create_func)(TS)) 130 131 Not Collective 132 133 Input Parameters: 134 + name - The name of a new user-defined creation routine 135 . path - The path (either absolute or relative) of the library containing this routine 136 . func_name - The name of the creation routine 137 - create_func - The creation routine itself 138 139 Notes: 140 TSRegisterDynamic() may be called multiple times to add several user-defined tses. 141 142 If dynamic libraries are used, then the fourth input argument (create_func) is ignored. 143 144 Sample usage: 145 .vb 146 TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate); 147 .ve 148 149 Then, your ts type can be chosen with the procedural interface via 150 .vb 151 TS ts; 152 TSCreate(MPI_Comm, &ts); 153 TSSetType(ts, "my_ts") 154 .ve 155 or at runtime via the option 156 .vb 157 -ts_type my_ts 158 .ve 159 160 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 161 If your function is not being put into a shared library then use TSRegister() instead 162 163 Level: advanced 164 165 .keywords: TS, register 166 .seealso: TSRegisterAll(), TSRegisterDestroy() 167 M*/ 168 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 169 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 170 #else 171 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 172 #endif 173 174 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetSNES(TS,SNES*); 175 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetKSP(TS,KSP*); 176 177 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSView(TS,PetscViewer); 178 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSViewFromOptions(TS,const char[]); 179 180 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetApplicationContext(TS,void *); 181 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetApplicationContext(TS,void **); 182 183 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG *); 184 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorLG(TS,PetscInt,PetscReal,Vec,void *); 185 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorLGDestroy(PetscDrawLG); 186 187 /* 188 PETSc interface to Sundials 189 */ 190 #ifdef PETSC_HAVE_SUNDIALS 191 typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 192 extern const char *TSSundialsLmmTypes[]; 193 typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 194 extern const char *TSSundialsGramSchmidtTypes[]; 195 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetType(TS,TSSundialsLmmType); 196 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetPC(TS,PC*); 197 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetTolerance(TS,PetscReal,PetscReal); 198 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 199 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 200 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetGMRESRestart(TS,PetscInt); 201 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetLinearTolerance(TS,PetscReal); 202 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetExactFinalTime(TS,PetscTruth); 203 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 204 #endif 205 206 EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRKSetTolerance(TS,PetscReal); 207 208 PETSC_EXTERN_CXX_END 209 #endif 210