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