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 17 S*/ 18 typedef struct _p_TS* TS; 19 20 /*J 21 TSType - String with the name of a PETSc TS method or the creation function 22 with an optional dynamic library name, for example 23 http://www.mcs.anl.gov/petsc/lib.a:mytscreate() 24 25 Level: beginner 26 27 .seealso: TSSetType(), TS 28 J*/ 29 typedef const char* TSType; 30 #define TSEULER "euler" 31 #define TSBEULER "beuler" 32 #define TSPSEUDO "pseudo" 33 #define TSCN "cn" 34 #define TSSUNDIALS "sundials" 35 #define TSRK "rk" 36 #define TSPYTHON "python" 37 #define TSTHETA "theta" 38 #define TSALPHA "alpha" 39 #define TSGL "gl" 40 #define TSSSP "ssp" 41 #define TSARKIMEX "arkimex" 42 #define TSROSW "rosw" 43 44 /*E 45 TSProblemType - Determines the type of problem this TS object is to be used to solve 46 47 Level: beginner 48 49 .seealso: TSCreate() 50 E*/ 51 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 52 53 /*E 54 TSConvergedReason - reason a TS method has converged or not 55 56 Level: beginner 57 58 Developer Notes: this must match finclude/petscts.h 59 60 Each reason has its own manual page. 61 62 .seealso: TSGetConvergedReason() 63 E*/ 64 typedef enum { 65 TS_CONVERGED_ITERATING = 0, 66 TS_CONVERGED_TIME = 1, 67 TS_CONVERGED_ITS = 2, 68 TS_DIVERGED_NONLINEAR_SOLVE = -1, 69 TS_DIVERGED_STEP_REJECTED = -2 70 } TSConvergedReason; 71 PETSC_EXTERN const char *const*TSConvergedReasons; 72 73 /*MC 74 TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 75 76 Level: beginner 77 78 .seealso: TSSolve(), TSConvergedReason(), TSGetAdapt() 79 M*/ 80 81 /*MC 82 TS_CONVERGED_TIME - the final time was reached 83 84 Level: beginner 85 86 .seealso: TSSolve(), TSConvergedReason(), TSGetAdapt(), TSSetDuration() 87 M*/ 88 89 /*MC 90 TS_CONVERGED_ITS - the maximum number of iterations was reached prior to the final time 91 92 Level: beginner 93 94 .seealso: TSSolve(), TSConvergedReason(), TSGetAdapt(), TSSetDuration() 95 M*/ 96 97 /*MC 98 TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 99 100 Level: beginner 101 102 .seealso: TSSolve(), TSConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason() 103 M*/ 104 105 /*MC 106 TS_DIVERGED_STEP_REJECTED - too many steps were rejected 107 108 Level: beginner 109 110 .seealso: TSSolve(), TSConvergedReason(), TSGetAdapt() 111 M*/ 112 113 /* Logging support */ 114 PETSC_EXTERN PetscClassId TS_CLASSID; 115 116 PETSC_EXTERN PetscErrorCode TSInitializePackage(const char[]); 117 118 PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 119 PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 120 121 PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 122 PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 123 PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 124 PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 125 PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 126 127 PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 128 PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 129 PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 130 PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 131 PETSC_EXTERN PetscErrorCode TSSetUp(TS); 132 PETSC_EXTERN PetscErrorCode TSReset(TS); 133 134 PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 135 PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 136 137 PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 138 PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 139 PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,PetscBool); 140 141 PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*); 142 PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,void*); 143 PETSC_EXTERN PetscErrorCode TSMonitorSolutionCreate(TS,PetscViewer,void**); 144 PETSC_EXTERN PetscErrorCode TSMonitorSolutionDestroy(void**); 145 PETSC_EXTERN PetscErrorCode TSMonitorSolutionBinary(TS,PetscInt,PetscReal,Vec,void*); 146 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 147 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 148 149 PETSC_EXTERN PetscErrorCode TSStep(TS); 150 PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 151 PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec,PetscReal*); 152 PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 153 PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 154 PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 155 PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 156 PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 157 PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 158 PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 159 PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 160 161 PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 162 PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 163 PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 164 PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 165 PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 166 PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 167 168 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 169 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 170 PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 171 PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 172 PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 173 PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 174 175 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 176 PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 177 178 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 179 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 180 PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 181 PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 182 PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 183 PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 184 185 PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 186 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 187 PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 188 PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 189 PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 190 191 PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 192 PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 193 PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 194 PETSC_EXTERN PetscErrorCode TSPreStep(TS); 195 PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 196 PETSC_EXTERN PetscErrorCode TSPostStep(TS); 197 PETSC_EXTERN PetscErrorCode TSSetRetainStages(TS,PetscBool); 198 PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 199 PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 200 PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 201 PETSC_EXTERN PetscErrorCode TSErrorNormWRMS(TS,Vec,PetscReal*); 202 PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 203 PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 204 205 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 206 PETSC_EXTERN PetscErrorCode TSPseudoDefaultTimeStep(TS,PetscReal*,void*); 207 PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 208 PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 209 210 PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 211 PETSC_EXTERN PetscErrorCode TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscBool *); 212 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 213 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 214 PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 215 216 PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 217 218 PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 219 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 220 PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 221 PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,PetscBool); 222 223 PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 224 225 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 226 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 227 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 228 PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 229 PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 230 PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 231 PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 232 PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 233 PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 234 PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 235 236 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 237 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,MatStructure*,void*); 238 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 239 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,MatStructure*,void*); 240 241 PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 242 PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,MatStructure*,void*),void *); 243 PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 244 PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,MatStructure*,void*),void *); 245 246 /* Dynamic creation and loading functions */ 247 PETSC_EXTERN PetscFList TSList; 248 PETSC_EXTERN PetscBool TSRegisterAllCalled; 249 PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 250 PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 251 PETSC_EXTERN PetscErrorCode TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS)); 252 PETSC_EXTERN PetscErrorCode TSRegisterAll(const char[]); 253 PETSC_EXTERN PetscErrorCode TSRegisterDestroy(void); 254 255 /*MC 256 TSRegisterDynamic - Adds a creation method to the TS package. 257 258 Synopsis: 259 PetscErrorCode TSRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(TS)) 260 261 Not Collective 262 263 Input Parameters: 264 + name - The name of a new user-defined creation routine 265 . path - The path (either absolute or relative) of the library containing this routine 266 . func_name - The name of the creation routine 267 - create_func - The creation routine itself 268 269 Notes: 270 TSRegisterDynamic() may be called multiple times to add several user-defined tses. 271 272 If dynamic libraries are used, then the fourth input argument (create_func) is ignored. 273 274 Sample usage: 275 .vb 276 TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate); 277 .ve 278 279 Then, your ts type can be chosen with the procedural interface via 280 .vb 281 TS ts; 282 TSCreate(MPI_Comm, &ts); 283 TSSetType(ts, "my_ts") 284 .ve 285 or at runtime via the option 286 .vb 287 -ts_type my_ts 288 .ve 289 290 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 291 If your function is not being put into a shared library then use TSRegister() instead 292 293 Level: advanced 294 295 .keywords: TS, register 296 .seealso: TSRegisterAll(), TSRegisterDestroy() 297 M*/ 298 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 299 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 300 #else 301 #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 302 #endif 303 304 PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 305 PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 306 307 PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 308 309 PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 310 PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 311 312 typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 313 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 314 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 315 PETSC_EXTERN PetscErrorCode TSMonitorTimeStep(TS,PetscInt,PetscReal,Vec,void *); 316 PETSC_EXTERN PetscErrorCode TSMonitorSolutionODE(TS,PetscInt,PetscReal,Vec,void *); 317 PETSC_EXTERN PetscErrorCode TSMonitorErrorODE(TS,PetscInt,PetscReal,Vec,void *); 318 319 /*J 320 TSSSPType - string with the name of TSSSP scheme. 321 322 Level: beginner 323 324 .seealso: TSSSPSetType(), TS 325 J*/ 326 typedef const char* TSSSPType; 327 #define TSSSPRKS2 "rks2" 328 #define TSSSPRKS3 "rks3" 329 #define TSSSPRK104 "rk104" 330 331 PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 332 PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 333 PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 334 PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 335 336 /*S 337 TSAdapt - Abstract object that manages time-step adaptivity 338 339 Level: beginner 340 341 .seealso: TS, TSAdaptCreate(), TSAdaptType 342 S*/ 343 typedef struct _p_TSAdapt *TSAdapt; 344 345 /*E 346 TSAdaptType - String with the name of TSAdapt scheme or the creation function 347 with an optional dynamic library name, for example 348 http://www.mcs.anl.gov/petsc/lib.a:mytsgladaptcreate() 349 350 Level: beginner 351 352 .seealso: TSAdaptSetType(), TS 353 E*/ 354 typedef const char *TSAdaptType; 355 #define TSADAPTBASIC "basic" 356 #define TSADAPTNONE "none" 357 #define TSADAPTCFL "cfl" 358 359 /*MC 360 TSAdaptRegisterDynamic - adds a TSAdapt implementation 361 362 Synopsis: 363 PetscErrorCode TSAdaptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 364 365 Not Collective 366 367 Input Parameters: 368 + name_scheme - name of user-defined adaptivity scheme 369 . path - path (either absolute or relative) the library containing this scheme 370 . name_create - name of routine to create method context 371 - routine_create - routine to create method context 372 373 Notes: 374 TSAdaptRegisterDynamic() may be called multiple times to add several user-defined families. 375 376 If dynamic libraries are used, then the fourth input argument (routine_create) 377 is ignored. 378 379 Sample usage: 380 .vb 381 TSAdaptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 382 "MySchemeCreate",MySchemeCreate); 383 .ve 384 385 Then, your scheme can be chosen with the procedural interface via 386 $ TSAdaptSetType(ts,"my_scheme") 387 or at runtime via the option 388 $ -ts_adapt_type my_scheme 389 390 Level: advanced 391 392 Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 393 and others of the form ${any_environmental_variable} occuring in pathname will be 394 replaced with appropriate values. 395 396 .keywords: TSAdapt, register 397 398 .seealso: TSAdaptRegisterAll() 399 M*/ 400 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 401 # define TSAdaptRegisterDynamic(a,b,c,d) TSAdaptRegister(a,b,c,0) 402 #else 403 # define TSAdaptRegisterDynamic(a,b,c,d) TSAdaptRegister(a,b,c,d) 404 #endif 405 406 PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 407 PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],const char[],const char[],PetscErrorCode (*)(TSAdapt)); 408 PETSC_EXTERN PetscErrorCode TSAdaptRegisterAll(const char[]); 409 PETSC_EXTERN PetscErrorCode TSAdaptRegisterDestroy(void); 410 PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(const char[]); 411 PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 412 PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 413 PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 414 PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 415 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 416 PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 417 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 418 PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 419 PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscBool*); 420 PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 421 PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(TSAdapt); 422 PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 423 PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 424 PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 425 PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscBool*)); 426 427 /*S 428 TSGLAdapt - Abstract object that manages time-step adaptivity 429 430 Level: beginner 431 432 Developer Notes: 433 This functionality should be replaced by the TSAdapt. 434 435 .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 436 S*/ 437 typedef struct _p_TSGLAdapt *TSGLAdapt; 438 439 /*J 440 TSGLAdaptType - String with the name of TSGLAdapt scheme or the creation function 441 with an optional dynamic library name, for example 442 http://www.mcs.anl.gov/petsc/lib.a:mytsgladaptcreate() 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 /*MC 454 TSGLAdaptRegisterDynamic - adds a TSGLAdapt implementation 455 456 Synopsis: 457 PetscErrorCode TSGLAdaptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 458 459 Not Collective 460 461 Input Parameters: 462 + name_scheme - name of user-defined adaptivity scheme 463 . path - path (either absolute or relative) the library containing this scheme 464 . name_create - name of routine to create method context 465 - routine_create - routine to create method context 466 467 Notes: 468 TSGLAdaptRegisterDynamic() may be called multiple times to add several user-defined families. 469 470 If dynamic libraries are used, then the fourth input argument (routine_create) 471 is ignored. 472 473 Sample usage: 474 .vb 475 TSGLAdaptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 476 "MySchemeCreate",MySchemeCreate); 477 .ve 478 479 Then, your scheme can be chosen with the procedural interface via 480 $ TSGLAdaptSetType(ts,"my_scheme") 481 or at runtime via the option 482 $ -ts_adapt_type my_scheme 483 484 Level: advanced 485 486 Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 487 and others of the form ${any_environmental_variable} occuring in pathname will be 488 replaced with appropriate values. 489 490 .keywords: TSGLAdapt, register 491 492 .seealso: TSGLAdaptRegisterAll() 493 M*/ 494 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 495 # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,0) 496 #else 497 # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,d) 498 #endif 499 500 PETSC_EXTERN PetscErrorCode TSGLAdaptRegister(const char[],const char[],const char[],PetscErrorCode (*)(TSGLAdapt)); 501 PETSC_EXTERN PetscErrorCode TSGLAdaptRegisterAll(const char[]); 502 PETSC_EXTERN PetscErrorCode TSGLAdaptRegisterDestroy(void); 503 PETSC_EXTERN PetscErrorCode TSGLAdaptInitializePackage(const char[]); 504 PETSC_EXTERN PetscErrorCode TSGLAdaptFinalizePackage(void); 505 PETSC_EXTERN PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 506 PETSC_EXTERN PetscErrorCode TSGLAdaptSetType(TSGLAdapt,TSGLAdaptType); 507 PETSC_EXTERN PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 508 PETSC_EXTERN PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 509 PETSC_EXTERN PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer); 510 PETSC_EXTERN PetscErrorCode TSGLAdaptSetFromOptions(TSGLAdapt); 511 PETSC_EXTERN PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*); 512 513 /*J 514 TSGLAcceptType - String with the name of TSGLAccept scheme or the function 515 with an optional dynamic library name, for example 516 http://www.mcs.anl.gov/petsc/lib.a:mytsglaccept() 517 518 Level: beginner 519 520 .seealso: TSGLSetAcceptType(), TS 521 J*/ 522 typedef const char *TSGLAcceptType; 523 #define TSGLACCEPT_ALWAYS "always" 524 525 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 526 PETSC_EXTERN PetscErrorCode TSGLAcceptRegister(const char[],const char[],const char[],TSGLAcceptFunction); 527 528 /*MC 529 TSGLAcceptRegisterDynamic - adds a TSGL acceptance scheme 530 531 Synopsis: 532 PetscErrorCode TSGLAcceptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 533 534 Not Collective 535 536 Input Parameters: 537 + name_scheme - name of user-defined acceptance scheme 538 . path - path (either absolute or relative) the library containing this scheme 539 . name_create - name of routine to create method context 540 - routine_create - routine to create method context 541 542 Notes: 543 TSGLAcceptRegisterDynamic() may be called multiple times to add several user-defined families. 544 545 If dynamic libraries are used, then the fourth input argument (routine_create) 546 is ignored. 547 548 Sample usage: 549 .vb 550 TSGLAcceptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 551 "MySchemeCreate",MySchemeCreate); 552 .ve 553 554 Then, your scheme can be chosen with the procedural interface via 555 $ TSGLSetAcceptType(ts,"my_scheme") 556 or at runtime via the option 557 $ -ts_gl_accept_type my_scheme 558 559 Level: advanced 560 561 Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 562 and others of the form ${any_environmental_variable} occuring in pathname will be 563 replaced with appropriate values. 564 565 .keywords: TSGL, TSGLAcceptType, register 566 567 .seealso: TSGLRegisterAll() 568 M*/ 569 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 570 # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,0) 571 #else 572 # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,d) 573 #endif 574 575 /*J 576 TSGLType - family of time integration method within the General Linear class 577 578 Level: beginner 579 580 .seealso: TSGLSetType(), TSGLRegister() 581 J*/ 582 typedef const char* TSGLType; 583 #define TSGL_IRKS "irks" 584 585 /*MC 586 TSGLRegisterDynamic - adds a TSGL implementation 587 588 Synopsis: 589 PetscErrorCode TSGLRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 590 591 Not Collective 592 593 Input Parameters: 594 + name_scheme - name of user-defined general linear scheme 595 . path - path (either absolute or relative) the library containing this scheme 596 . name_create - name of routine to create method context 597 - routine_create - routine to create method context 598 599 Notes: 600 TSGLRegisterDynamic() may be called multiple times to add several user-defined families. 601 602 If dynamic libraries are used, then the fourth input argument (routine_create) 603 is ignored. 604 605 Sample usage: 606 .vb 607 TSGLRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 608 "MySchemeCreate",MySchemeCreate); 609 .ve 610 611 Then, your scheme can be chosen with the procedural interface via 612 $ TSGLSetType(ts,"my_scheme") 613 or at runtime via the option 614 $ -ts_gl_type my_scheme 615 616 Level: advanced 617 618 Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 619 and others of the form ${any_environmental_variable} occuring in pathname will be 620 replaced with appropriate values. 621 622 .keywords: TSGL, register 623 624 .seealso: TSGLRegisterAll() 625 M*/ 626 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 627 # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,0) 628 #else 629 # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,d) 630 #endif 631 632 PETSC_EXTERN PetscErrorCode TSGLRegister(const char[],const char[],const char[],PetscErrorCode(*)(TS)); 633 PETSC_EXTERN PetscErrorCode TSGLRegisterAll(const char[]); 634 PETSC_EXTERN PetscErrorCode TSGLRegisterDestroy(void); 635 PETSC_EXTERN PetscErrorCode TSGLInitializePackage(const char[]); 636 PETSC_EXTERN PetscErrorCode TSGLFinalizePackage(void); 637 PETSC_EXTERN PetscErrorCode TSGLSetType(TS,TSGLType); 638 PETSC_EXTERN PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*); 639 PETSC_EXTERN PetscErrorCode TSGLSetAcceptType(TS,TSGLAcceptType); 640 641 /*J 642 TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 643 644 Level: beginner 645 646 .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 647 J*/ 648 typedef const char* TSARKIMEXType; 649 #define TSARKIMEXA2 "a2" 650 #define TSARKIMEXL2 "l2" 651 #define TSARKIMEXARS122 "ars122" 652 #define TSARKIMEX2C "2c" 653 #define TSARKIMEX2D "2d" 654 #define TSARKIMEX2E "2e" 655 #define TSARKIMEXPRSSP2 "prssp2" 656 #define TSARKIMEX3 "3" 657 #define TSARKIMEXBPR3 "bpr3" 658 #define TSARKIMEXARS443 "ars443" 659 #define TSARKIMEX4 "4" 660 #define TSARKIMEX5 "5" 661 PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 662 PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 663 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 664 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[]); 665 PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 666 PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(const char path[]); 667 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 668 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterAll(void); 669 670 /*J 671 TSRosWType - String with the name of a Rosenbrock-W method. 672 673 Level: beginner 674 675 .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 676 J*/ 677 typedef const char* TSRosWType; 678 #define TSROSW2M "2m" 679 #define TSROSW2P "2p" 680 #define TSROSWRA3PW "ra3pw" 681 #define TSROSWRA34PW2 "ra34pw2" 682 #define TSROSWRODAS3 "rodas3" 683 #define TSROSWSANDU3 "sandu3" 684 #define TSROSWASSP3P3S1C "assp3p3s1c" 685 #define TSROSWLASSP3P4S2C "lassp3p4s2c" 686 #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 687 #define TSROSWARK3 "ark3" 688 #define TSROSWTHETA1 "theta1" 689 #define TSROSWTHETA2 "theta2" 690 #define TSROSWGRK4T "grk4t" 691 #define TSROSWSHAMP4 "shamp4" 692 #define TSROSWVELDD4 "veldd4" 693 #define TSROSW4L "4l" 694 695 PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*); 696 PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType); 697 PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 698 PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 699 PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 700 PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 701 PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(const char path[]); 702 PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 703 PETSC_EXTERN PetscErrorCode TSRosWRegisterAll(void); 704 705 /* 706 PETSc interface to Sundials 707 */ 708 #ifdef PETSC_HAVE_SUNDIALS 709 typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 710 PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 711 typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 712 PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 713 PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 714 PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 715 PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 716 PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 717 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 718 PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 719 PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 720 PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 721 PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 722 PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 723 PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 724 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 725 #endif 726 727 PETSC_EXTERN PetscErrorCode TSRKSetTolerance(TS,PetscReal); 728 729 PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 730 PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 731 PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 732 PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 733 734 PETSC_EXTERN PetscErrorCode TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*); 735 PETSC_EXTERN PetscErrorCode TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*); 736 PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 737 PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 738 PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 739 740 PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 741 PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 742 743 PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 744 PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 745 746 #endif 747