1 /* 2 User interface for the timestepping package. This 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 9 /*S 10 TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 11 12 Level: beginner 13 14 Concepts: ODE solvers 15 16 .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy() 17 S*/ 18 typedef struct _p_TS* TS; 19 20 /*J 21 TSType - String with the name of a PETSc TS method. 22 23 Level: beginner 24 25 .seealso: TSSetType(), TS, TSRegister() 26 J*/ 27 typedef const char* TSType; 28 #define TSEULER "euler" 29 #define TSBEULER "beuler" 30 #define TSPSEUDO "pseudo" 31 #define TSCN "cn" 32 #define TSSUNDIALS "sundials" 33 #define TSRK "rk" 34 #define TSPYTHON "python" 35 #define TSTHETA "theta" 36 #define TSALPHA "alpha" 37 #define TSGL "gl" 38 #define TSSSP "ssp" 39 #define TSARKIMEX "arkimex" 40 #define TSROSW "rosw" 41 #define TSEIMEX "eimex" 42 /*E 43 TSProblemType - Determines the type of problem this TS object is to be used to solve 44 45 Level: beginner 46 47 .seealso: TSCreate() 48 E*/ 49 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 50 51 /*E 52 TSEquationType - type of TS problem that is solved 53 54 Level: beginner 55 56 Developer Notes: this must match finclude/petscts.h 57 58 Supported types are: 59 TS_EQ_UNSPECIFIED (default) 60 TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0 61 TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0 62 63 .seealso: TSGetEquationType(), TSSetEquationType() 64 E*/ 65 typedef enum { 66 TS_EQ_UNSPECIFIED = -1, 67 TS_EQ_EXPLICIT = 0, 68 TS_EQ_ODE_EXPLICIT = 1, 69 TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 70 TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 71 TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 72 TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 73 TS_EQ_IMPLICIT = 1000, 74 TS_EQ_ODE_IMPLICIT = 1001, 75 TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 76 TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 77 TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 78 TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 79 } TSEquationType; 80 PETSC_EXTERN const char *const*TSEquationTypes; 81 82 /*E 83 TSConvergedReason - reason a TS method has converged or not 84 85 Level: beginner 86 87 Developer Notes: this must match finclude/petscts.h 88 89 Each reason has its own manual page. 90 91 .seealso: TSGetConvergedReason() 92 E*/ 93 typedef enum { 94 TS_CONVERGED_ITERATING = 0, 95 TS_CONVERGED_TIME = 1, 96 TS_CONVERGED_ITS = 2, 97 TS_CONVERGED_USER = 3, 98 TS_DIVERGED_NONLINEAR_SOLVE = -1, 99 TS_DIVERGED_STEP_REJECTED = -2 100 } TSConvergedReason; 101 PETSC_EXTERN const char *const*TSConvergedReasons; 102 /*MC 103 TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 104 105 Level: beginner 106 107 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 108 M*/ 109 110 /*MC 111 TS_CONVERGED_TIME - the final time was reached 112 113 Level: beginner 114 115 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration(), TSGetSolveTime() 116 M*/ 117 118 /*MC 119 TS_CONVERGED_ITS - the maximum number of iterations was reached prior to the final time 120 121 Level: beginner 122 123 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration() 124 M*/ 125 /*MC 126 TS_CONVERGED_USER - user requested termination 127 128 Level: beginner 129 130 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration() 131 M*/ 132 133 /*MC 134 TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 135 136 Level: beginner 137 138 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason() 139 M*/ 140 141 /*MC 142 TS_DIVERGED_STEP_REJECTED - too many steps were rejected 143 144 Level: beginner 145 146 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 147 M*/ 148 149 /*E 150 TSExactFinalTimeOption - option for handling of final time step 151 152 Level: beginner 153 154 Developer Notes: this must match finclude/petscts.h 155 156 $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 157 $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 158 $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 159 .seealso: TSGetConvergedReason(), TSSetExactFinalTime() 160 161 E*/ 162 typedef enum {TS_EXACTFINALTIME_STEPOVER=0,TS_EXACTFINALTIME_INTERPOLATE=1,TS_EXACTFINALTIME_MATCHSTEP=2} TSExactFinalTimeOption; 163 PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 164 165 166 /* Logging support */ 167 PETSC_EXTERN PetscClassId TS_CLASSID; 168 PETSC_EXTERN PetscClassId DMTS_CLASSID; 169 170 PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 171 172 PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 173 PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 174 175 PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 176 PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 177 PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 178 PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 179 PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 180 181 PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 182 PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 183 PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 184 PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 185 PETSC_EXTERN PetscErrorCode TSSetUp(TS); 186 PETSC_EXTERN PetscErrorCode TSReset(TS); 187 188 PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 189 PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 190 191 PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 192 PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 193 PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption); 194 195 PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*); 196 197 typedef struct _n_TSMonitorDrawCtx* TSMonitorDrawCtx; 198 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *); 199 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*); 200 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*); 201 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*); 202 PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*); 203 204 PETSC_EXTERN PetscErrorCode TSMonitorSolutionBinary(TS,PetscInt,PetscReal,Vec,void*); 205 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 206 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 207 208 PETSC_EXTERN PetscErrorCode TSStep(TS); 209 PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 210 PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec); 211 PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*); 212 PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType); 213 PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 214 PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason); 215 PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*); 216 PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 217 PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 218 PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 219 PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 220 PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 221 PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 222 PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 223 224 PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 225 PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 226 PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 227 PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 228 PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 229 PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 230 231 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 232 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 233 PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 234 PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 235 PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 236 PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 237 PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool); 238 239 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 240 PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 241 PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*),void*); 242 243 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 244 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 245 PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 246 PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 247 PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 248 PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 249 250 PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 251 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 252 PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 253 PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 254 PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 255 PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec); 256 257 PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 258 PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 259 PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*)); 260 PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 261 PETSC_EXTERN PetscErrorCode TSPreStep(TS); 262 PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 263 PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*); 264 PETSC_EXTERN PetscErrorCode TSPostStep(TS); 265 PETSC_EXTERN PetscErrorCode TSSetRetainStages(TS,PetscBool); 266 PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 267 PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 268 PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 269 PETSC_EXTERN PetscErrorCode TSErrorNormWRMS(TS,Vec,PetscReal*); 270 PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 271 PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 272 273 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 274 PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*); 275 PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 276 PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 277 278 PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 279 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *); 280 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 281 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 282 PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 283 284 PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 285 286 PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 287 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 288 PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 289 PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,PetscBool); 290 PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*); 291 292 PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 293 294 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 295 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 296 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 297 PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 298 PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 299 PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 300 PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 301 PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 302 PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 303 PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 304 PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*),void*); 305 PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,PetscErrorCode (**TSForcingFunction)(TS,PetscReal,Vec,void*),void**); 306 307 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 308 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 309 310 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 311 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,MatStructure*,void*); 312 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 313 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,MatStructure*,void*); 314 315 PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 316 PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,MatStructure*,void*),void *); 317 PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 318 PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,MatStructure*,void*),void *); 319 320 typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 321 typedef struct { 322 Vec ray; 323 VecScatter scatter; 324 PetscViewer viewer; 325 TSMonitorLGCtx lgctx; 326 } TSMonitorDMDARayCtx; 327 PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 328 PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 329 PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 330 331 332 /* Dynamic creation and loading functions */ 333 PETSC_EXTERN PetscFunctionList TSList; 334 PETSC_EXTERN PetscBool TSRegisterAllCalled; 335 PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 336 PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 337 PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 338 PETSC_EXTERN PetscErrorCode TSRegisterAll(void); 339 340 PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 341 PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 342 PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 343 344 PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 345 PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 346 347 #define TS_FILE_CLASSID 1211225 348 349 PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 350 PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 351 352 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 353 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 354 PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 355 PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 356 PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 357 PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 358 PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec),void*); 359 PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 360 PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 361 PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 362 363 typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 364 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 365 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 366 PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 367 368 /*J 369 TSSSPType - string with the name of TSSSP scheme. 370 371 Level: beginner 372 373 .seealso: TSSSPSetType(), TS 374 J*/ 375 typedef const char* TSSSPType; 376 #define TSSSPRKS2 "rks2" 377 #define TSSSPRKS3 "rks3" 378 #define TSSSPRK104 "rk104" 379 380 PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 381 PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 382 PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 383 PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 384 PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 385 PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 386 387 /*S 388 TSAdapt - Abstract object that manages time-step adaptivity 389 390 Level: beginner 391 392 .seealso: TS, TSAdaptCreate(), TSAdaptType 393 S*/ 394 typedef struct _p_TSAdapt *TSAdapt; 395 396 /*E 397 TSAdaptType - String with the name of TSAdapt scheme. 398 399 Level: beginner 400 401 .seealso: TSAdaptSetType(), TS 402 E*/ 403 typedef const char *TSAdaptType; 404 #define TSADAPTBASIC "basic" 405 #define TSADAPTNONE "none" 406 #define TSADAPTCFL "cfl" 407 408 PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 409 PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 410 PETSC_EXTERN PetscErrorCode TSAdaptRegisterAll(void); 411 PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 412 PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 413 PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 414 PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 415 PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 416 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 417 PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 418 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 419 PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 420 PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscBool*); 421 PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 422 PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 423 PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(TSAdapt); 424 PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 425 PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 426 PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 427 PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscBool*)); 428 429 /*S 430 TSGLAdapt - Abstract object that manages time-step adaptivity 431 432 Level: beginner 433 434 Developer Notes: 435 This functionality should be replaced by the TSAdapt. 436 437 .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 438 S*/ 439 typedef struct _p_TSGLAdapt *TSGLAdapt; 440 441 /*J 442 TSGLAdaptType - String with the name of TSGLAdapt scheme 443 444 Level: beginner 445 446 .seealso: TSGLAdaptSetType(), TS 447 J*/ 448 typedef const char *TSGLAdaptType; 449 #define TSGLADAPT_NONE "none" 450 #define TSGLADAPT_SIZE "size" 451 #define TSGLADAPT_BOTH "both" 452 453 PETSC_EXTERN PetscErrorCode TSGLAdaptRegister(const char[],PetscErrorCode (*)(TSGLAdapt)); 454 PETSC_EXTERN PetscErrorCode TSGLAdaptRegisterAll(void); 455 PETSC_EXTERN PetscErrorCode TSGLAdaptInitializePackage(void); 456 PETSC_EXTERN PetscErrorCode TSGLAdaptFinalizePackage(void); 457 PETSC_EXTERN PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 458 PETSC_EXTERN PetscErrorCode TSGLAdaptSetType(TSGLAdapt,TSGLAdaptType); 459 PETSC_EXTERN PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 460 PETSC_EXTERN PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 461 PETSC_EXTERN PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer); 462 PETSC_EXTERN PetscErrorCode TSGLAdaptSetFromOptions(TSGLAdapt); 463 PETSC_EXTERN PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*); 464 465 /*J 466 TSGLAcceptType - String with the name of TSGLAccept scheme 467 468 Level: beginner 469 470 .seealso: TSGLSetAcceptType(), TS 471 J*/ 472 typedef const char *TSGLAcceptType; 473 #define TSGLACCEPT_ALWAYS "always" 474 475 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 476 PETSC_EXTERN PetscErrorCode TSGLAcceptRegister(const char[],TSGLAcceptFunction); 477 478 /*J 479 TSGLType - family of time integration method within the General Linear class 480 481 Level: beginner 482 483 .seealso: TSGLSetType(), TSGLRegister() 484 J*/ 485 typedef const char* TSGLType; 486 #define TSGL_IRKS "irks" 487 488 PETSC_EXTERN PetscErrorCode TSGLRegister(const char[],PetscErrorCode(*)(TS)); 489 PETSC_EXTERN PetscErrorCode TSGLRegisterAll(void); 490 PETSC_EXTERN PetscErrorCode TSGLInitializePackage(void); 491 PETSC_EXTERN PetscErrorCode TSGLFinalizePackage(void); 492 PETSC_EXTERN PetscErrorCode TSGLSetType(TS,TSGLType); 493 PETSC_EXTERN PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*); 494 PETSC_EXTERN PetscErrorCode TSGLSetAcceptType(TS,TSGLAcceptType); 495 496 /*J 497 TSEIMEXType - String with the name of an Extrapolated IMEX method. 498 499 Level: beginner 500 501 .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister() 502 J*/ 503 #define TSEIMEXType char* 504 505 PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt); 506 PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt); 507 PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool); 508 509 /*J 510 TSRKType - String with the name of a Runge-Kutta method. 511 512 Level: beginner 513 514 .seealso: TSRKSetType(), TS, TSRK, TSRKRegister() 515 J*/ 516 typedef const char* TSRKType; 517 #define TSRK1FE "1fe" 518 #define TSRK2A "2a" 519 #define TSRK3 "3" 520 #define TSRK3BS "3bs" 521 #define TSRK4 "4" 522 #define TSRK5F "5f" 523 #define TSRK5DP "5dp" 524 PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*); 525 PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType); 526 PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool); 527 PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 528 PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 529 PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 530 PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 531 PETSC_EXTERN PetscErrorCode TSRKRegisterAll(void); 532 533 /*J 534 TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 535 536 Level: beginner 537 538 .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 539 J*/ 540 typedef const char* TSARKIMEXType; 541 #define TSARKIMEX1BEE "1bee" 542 #define TSARKIMEXA2 "a2" 543 #define TSARKIMEXL2 "l2" 544 #define TSARKIMEXARS122 "ars122" 545 #define TSARKIMEX2C "2c" 546 #define TSARKIMEX2D "2d" 547 #define TSARKIMEX2E "2e" 548 #define TSARKIMEXPRSSP2 "prssp2" 549 #define TSARKIMEX3 "3" 550 #define TSARKIMEXBPR3 "bpr3" 551 #define TSARKIMEXARS443 "ars443" 552 #define TSARKIMEX4 "4" 553 #define TSARKIMEX5 "5" 554 PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 555 PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 556 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 557 PETSC_EXTERN PetscErrorCode TSARKIMEXRegister(TSARKIMEXType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[],const PetscReal[]); 558 PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 559 PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 560 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 561 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterAll(void); 562 563 /*J 564 TSRosWType - String with the name of a Rosenbrock-W method. 565 566 Level: beginner 567 568 .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 569 J*/ 570 typedef const char* TSRosWType; 571 #define TSROSW2M "2m" 572 #define TSROSW2P "2p" 573 #define TSROSWRA3PW "ra3pw" 574 #define TSROSWRA34PW2 "ra34pw2" 575 #define TSROSWRODAS3 "rodas3" 576 #define TSROSWSANDU3 "sandu3" 577 #define TSROSWASSP3P3S1C "assp3p3s1c" 578 #define TSROSWLASSP3P4S2C "lassp3p4s2c" 579 #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 580 #define TSROSWARK3 "ark3" 581 #define TSROSWTHETA1 "theta1" 582 #define TSROSWTHETA2 "theta2" 583 #define TSROSWGRK4T "grk4t" 584 #define TSROSWSHAMP4 "shamp4" 585 #define TSROSWVELDD4 "veldd4" 586 #define TSROSW4L "4l" 587 588 PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*); 589 PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType); 590 PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 591 PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 592 PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 593 PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 594 PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 595 PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 596 PETSC_EXTERN PetscErrorCode TSRosWRegisterAll(void); 597 598 /* 599 PETSc interface to Sundials 600 */ 601 #ifdef PETSC_HAVE_SUNDIALS 602 typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 603 PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 604 typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 605 PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 606 PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 607 PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 608 PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 609 PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 610 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 611 PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 612 PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 613 PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 614 PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 615 PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 616 PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 617 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 618 #endif 619 620 PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 621 PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 622 PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 623 PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 624 625 PETSC_EXTERN PetscErrorCode TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*); 626 PETSC_EXTERN PetscErrorCode TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*); 627 PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 628 PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 629 PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 630 631 PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 632 PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 633 634 PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 635 PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 636 637 #endif 638