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