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