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 #define TSMIMEX "mimex" 43 /*E 44 TSProblemType - Determines the type of problem this TS object is to be used to solve 45 46 Level: beginner 47 48 .seealso: TSCreate() 49 E*/ 50 typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 51 52 /*E 53 TSEquationType - type of TS problem that is solved 54 55 Level: beginner 56 57 Developer Notes: this must match petsc/finclude/petscts.h 58 59 Supported types are: 60 TS_EQ_UNSPECIFIED (default) 61 TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0 62 TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0 63 64 .seealso: TSGetEquationType(), TSSetEquationType() 65 E*/ 66 typedef enum { 67 TS_EQ_UNSPECIFIED = -1, 68 TS_EQ_EXPLICIT = 0, 69 TS_EQ_ODE_EXPLICIT = 1, 70 TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 71 TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 72 TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 73 TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 74 TS_EQ_IMPLICIT = 1000, 75 TS_EQ_ODE_IMPLICIT = 1001, 76 TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 77 TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 78 TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 79 TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 80 } TSEquationType; 81 PETSC_EXTERN const char *const*TSEquationTypes; 82 83 /*E 84 TSConvergedReason - reason a TS method has converged or not 85 86 Level: beginner 87 88 Developer Notes: this must match petsc/finclude/petscts.h 89 90 Each reason has its own manual page. 91 92 .seealso: TSGetConvergedReason() 93 E*/ 94 typedef enum { 95 TS_CONVERGED_ITERATING = 0, 96 TS_CONVERGED_TIME = 1, 97 TS_CONVERGED_ITS = 2, 98 TS_CONVERGED_USER = 3, 99 TS_CONVERGED_EVENT = 4, 100 TS_CONVERGED_PSEUDO_FATOL = 5, 101 TS_CONVERGED_PSEUDO_FRTOL = 6, 102 TS_DIVERGED_NONLINEAR_SOLVE = -1, 103 TS_DIVERGED_STEP_REJECTED = -2 104 } TSConvergedReason; 105 PETSC_EXTERN const char *const*TSConvergedReasons; 106 107 /*MC 108 TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 109 110 Level: beginner 111 112 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 113 M*/ 114 115 /*MC 116 TS_CONVERGED_TIME - the final time was reached 117 118 Level: beginner 119 120 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration(), TSGetSolveTime() 121 M*/ 122 123 /*MC 124 TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 125 126 Level: beginner 127 128 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration() 129 M*/ 130 131 /*MC 132 TS_CONVERGED_USER - user requested termination 133 134 Level: beginner 135 136 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration() 137 M*/ 138 139 /*MC 140 TS_CONVERGED_EVENT - user requested termination on event detection 141 142 Level: beginner 143 144 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration() 145 M*/ 146 147 /*MC 148 TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO 149 150 Level: beginner 151 152 Options Database: 153 . -ts_pseudo_frtol <rtol> 154 155 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration(), TS_CONVERGED_PSEUDO_FATOL 156 M*/ 157 158 /*MC 159 TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO 160 161 Level: beginner 162 163 Options Database: 164 . -ts_pseudo_fatol <atol> 165 166 .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration(), TS_CONVERGED_PSEUDO_FRTOL 167 M*/ 168 169 /*MC 170 TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 171 172 Level: beginner 173 174 Notes: See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures. 175 176 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures() 177 M*/ 178 179 /*MC 180 TS_DIVERGED_STEP_REJECTED - too many steps were rejected 181 182 Level: beginner 183 184 Notes: See TSSetMaxStepRejections() for how to allow more step rejections. 185 186 .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections() 187 M*/ 188 189 /*E 190 TSExactFinalTimeOption - option for handling of final time step 191 192 Level: beginner 193 194 Developer Notes: this must match petsc/finclude/petscts.h 195 196 $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 197 $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 198 $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 199 200 .seealso: TSGetConvergedReason(), TSSetExactFinalTime() 201 202 E*/ 203 typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption; 204 PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 205 206 207 /* Logging support */ 208 PETSC_EXTERN PetscClassId TS_CLASSID; 209 PETSC_EXTERN PetscClassId DMTS_CLASSID; 210 PETSC_EXTERN PetscClassId TSADAPT_CLASSID; 211 212 PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 213 PETSC_EXTERN PetscErrorCode TSFinalizePackage(void); 214 215 PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 216 PETSC_EXTERN PetscErrorCode TSClone(TS,TS*); 217 PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 218 219 PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 220 PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 221 PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 222 PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 223 PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 224 PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 225 226 PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*); 227 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**)); 228 PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 229 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 230 231 PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 232 PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 233 PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 234 PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 235 PETSC_EXTERN PetscErrorCode TSSetUp(TS); 236 PETSC_EXTERN PetscErrorCode TSReset(TS); 237 238 PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 239 PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 240 241 /*S 242 TSTrajectory - Abstract PETSc object that storing the trajectory (solution of ODE/ADE at each time step and stage) 243 244 Level: advanced 245 246 Concepts: ODE solvers, adjoint 247 248 .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy() 249 S*/ 250 typedef struct _p_TSTrajectory* TSTrajectory; 251 252 /*J 253 TSTrajectoryType - String with the name of a PETSc TS trajectory storage method 254 255 Level: intermediate 256 257 .seealso: TSSetType(), TS, TSRegister(), TSTrajectoryCreate(), TSTrajectorySetType() 258 J*/ 259 typedef const char* TSTrajectoryType; 260 #define TSTRAJECTORYBASIC "basic" 261 #define TSTRAJECTORYSINGLEFILE "singlefile" 262 #define TSTRAJECTORYMEMORY "memory" 263 #define TSTRAJECTORYVISUALIZATION "visualization" 264 265 PETSC_EXTERN PetscFunctionList TSTrajectoryList; 266 PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 267 PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 268 269 PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 270 271 PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*); 272 PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*); 273 PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer); 274 PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,const TSTrajectoryType); 275 PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec); 276 PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*); 277 PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS); 278 PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS)); 279 PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 280 PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS); 281 282 PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*); 283 PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**); 284 PETSC_EXTERN PetscErrorCode TSSetCostIntegrand(TS,PetscInt,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscBool,void*); 285 PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*); 286 287 PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 288 PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 289 PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt); 290 291 PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat); 292 PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 293 PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 294 PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 295 PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*); 296 PETSC_EXTERN PetscErrorCode TSAdjointComputeCostIntegrand(TS,PetscReal,Vec,Vec); 297 PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS); 298 PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS); 299 300 PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 301 PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 302 PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption); 303 304 PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 305 306 typedef struct _n_TSMonitorDrawCtx* TSMonitorDrawCtx; 307 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *); 308 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*); 309 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*); 310 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*); 311 PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*); 312 313 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *); 314 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*); 315 316 PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 317 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 318 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 319 320 PETSC_EXTERN PetscErrorCode TSStep(TS); 321 PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*); 322 PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 323 PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec); 324 PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*); 325 PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType); 326 PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 327 PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason); 328 PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*); 329 PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 330 PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 331 PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 332 PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 333 PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 334 PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 335 PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 336 PETSC_EXTERN PetscErrorCode TSRollBack(TS); 337 PETSC_EXTERN PetscErrorCode TSGetTotalSteps(TS,PetscInt*); 338 339 PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**); 340 341 PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 342 PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 343 PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 344 PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 345 PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 346 PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 347 PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*); 348 349 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 350 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*); 351 PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 352 PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 353 PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 354 PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 355 PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool); 356 357 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 358 PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 359 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*); 360 PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*); 361 362 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 363 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 364 PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 365 PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 366 PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 367 PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 368 369 PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 370 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*); 371 PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 372 PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 373 PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 374 PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec); 375 PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 376 377 PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 378 PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 379 PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*)); 380 PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 381 PETSC_EXTERN PetscErrorCode TSPreStep(TS); 382 PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 383 PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*); 384 PETSC_EXTERN PetscErrorCode TSPostStep(TS); 385 PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 386 PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 387 PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 388 PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*); 389 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*); 390 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*); 391 PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 392 PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 393 PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*)); 394 PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*); 395 396 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 397 PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*); 398 PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 399 PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 400 PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 401 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *); 402 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 403 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 404 PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 405 406 PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 407 408 PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 409 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat); 410 PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 411 PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool); 412 PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*); 413 414 PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 415 416 PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 417 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 418 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 419 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 420 PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 421 PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 422 PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 423 PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 424 PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 425 PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 426 PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 427 PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*); 428 PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**); 429 PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*); 430 PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal); 431 PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **); 432 433 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*); 434 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*); 435 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*); 436 437 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 438 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 439 440 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 441 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*); 442 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 443 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*); 444 445 PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 446 PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *); 447 PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 448 PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *); 449 450 PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 451 PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*); 452 453 typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 454 typedef struct { 455 Vec ray; 456 VecScatter scatter; 457 PetscViewer viewer; 458 TSMonitorLGCtx lgctx; 459 } TSMonitorDMDARayCtx; 460 PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 461 PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 462 PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 463 464 465 /* Dynamic creation and loading functions */ 466 PETSC_EXTERN PetscFunctionList TSList; 467 PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 468 PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 469 PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 470 471 PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 472 PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 473 PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 474 475 PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 476 PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 477 PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 478 PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 479 480 #define TS_FILE_CLASSID 1211225 481 482 PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 483 PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 484 485 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 486 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 487 PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 488 PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 489 PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 490 PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **); 491 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *); 492 PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 493 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*); 494 PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 495 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *); 496 PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 497 PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 498 PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 499 500 typedef struct _n_TSMonitorEnvelopeCtx* TSMonitorEnvelopeCtx; 501 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*); 502 PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*); 503 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*); 504 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*); 505 506 typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 507 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 508 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 509 PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 510 511 PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*); 512 PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]); 513 /*J 514 TSSSPType - string with the name of TSSSP scheme. 515 516 Level: beginner 517 518 .seealso: TSSSPSetType(), TS 519 J*/ 520 typedef const char* TSSSPType; 521 #define TSSSPRKS2 "rks2" 522 #define TSSSPRKS3 "rks3" 523 #define TSSSPRK104 "rk104" 524 525 PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 526 PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 527 PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 528 PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 529 PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 530 PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 531 532 /*S 533 TSAdapt - Abstract object that manages time-step adaptivity 534 535 Level: beginner 536 537 .seealso: TS, TSAdaptCreate(), TSAdaptType 538 S*/ 539 typedef struct _p_TSAdapt *TSAdapt; 540 541 /*E 542 TSAdaptType - String with the name of TSAdapt scheme. 543 544 Level: beginner 545 546 .seealso: TSAdaptSetType(), TS 547 E*/ 548 typedef const char *TSAdaptType; 549 #define TSADAPTBASIC "basic" 550 #define TSADAPTNONE "none" 551 #define TSADAPTCFL "cfl" 552 553 PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 554 PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 555 PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 556 PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 557 PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 558 PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 559 PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 560 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 561 PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 562 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 563 PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 564 PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*); 565 PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 566 PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 567 PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt); 568 PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 569 PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 570 PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 571 PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 572 PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*)); 573 574 PETSC_EXTERN PetscErrorCode TSAdaptBasicSetClip(TSAdapt,PetscReal,PetscReal); 575 PETSC_EXTERN PetscErrorCode TSAdaptBasicGetClip(TSAdapt,PetscReal*,PetscReal*); 576 577 /*S 578 TSGLAdapt - Abstract object that manages time-step adaptivity 579 580 Level: beginner 581 582 Developer Notes: 583 This functionality should be replaced by the TSAdapt. 584 585 .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 586 S*/ 587 typedef struct _p_TSGLAdapt *TSGLAdapt; 588 589 /*J 590 TSGLAdaptType - String with the name of TSGLAdapt scheme 591 592 Level: beginner 593 594 .seealso: TSGLAdaptSetType(), TS 595 J*/ 596 typedef const char *TSGLAdaptType; 597 #define TSGLADAPT_NONE "none" 598 #define TSGLADAPT_SIZE "size" 599 #define TSGLADAPT_BOTH "both" 600 601 PETSC_EXTERN PetscErrorCode TSGLAdaptRegister(const char[],PetscErrorCode (*)(TSGLAdapt)); 602 PETSC_EXTERN PetscErrorCode TSGLAdaptInitializePackage(void); 603 PETSC_EXTERN PetscErrorCode TSGLAdaptFinalizePackage(void); 604 PETSC_EXTERN PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 605 PETSC_EXTERN PetscErrorCode TSGLAdaptSetType(TSGLAdapt,TSGLAdaptType); 606 PETSC_EXTERN PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 607 PETSC_EXTERN PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 608 PETSC_EXTERN PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer); 609 PETSC_EXTERN PetscErrorCode TSGLAdaptSetFromOptions(PetscOptionItems*,TSGLAdapt); 610 PETSC_EXTERN PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*); 611 612 /*J 613 TSGLAcceptType - String with the name of TSGLAccept scheme 614 615 Level: beginner 616 617 .seealso: TSGLSetAcceptType(), TS 618 J*/ 619 typedef const char *TSGLAcceptType; 620 #define TSGLACCEPT_ALWAYS "always" 621 622 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 623 PETSC_EXTERN PetscErrorCode TSGLAcceptRegister(const char[],TSGLAcceptFunction); 624 625 /*J 626 TSGLType - family of time integration method within the General Linear class 627 628 Level: beginner 629 630 .seealso: TSGLSetType(), TSGLRegister() 631 J*/ 632 typedef const char* TSGLType; 633 #define TSGL_IRKS "irks" 634 635 PETSC_EXTERN PetscErrorCode TSGLRegister(const char[],PetscErrorCode(*)(TS)); 636 PETSC_EXTERN PetscErrorCode TSGLInitializePackage(void); 637 PETSC_EXTERN PetscErrorCode TSGLFinalizePackage(void); 638 PETSC_EXTERN PetscErrorCode TSGLSetType(TS,TSGLType); 639 PETSC_EXTERN PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*); 640 PETSC_EXTERN PetscErrorCode TSGLSetAcceptType(TS,TSGLAcceptType); 641 642 /*J 643 TSEIMEXType - String with the name of an Extrapolated IMEX method. 644 645 Level: beginner 646 647 .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister() 648 J*/ 649 #define TSEIMEXType char* 650 651 PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt); 652 PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt); 653 PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool); 654 655 /*J 656 TSRKType - String with the name of a Runge-Kutta method. 657 658 Level: beginner 659 660 .seealso: TSRKSetType(), TS, TSRK, TSRKRegister() 661 J*/ 662 typedef const char* TSRKType; 663 #define TSRK1FE "1fe" 664 #define TSRK2A "2a" 665 #define TSRK3 "3" 666 #define TSRK3BS "3bs" 667 #define TSRK4 "4" 668 #define TSRK5F "5f" 669 #define TSRK5DP "5dp" 670 PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*); 671 PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType); 672 PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool); 673 PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 674 PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 675 PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 676 PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 677 678 /*J 679 TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 680 681 Level: beginner 682 683 .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 684 J*/ 685 typedef const char* TSARKIMEXType; 686 #define TSARKIMEX1BEE "1bee" 687 #define TSARKIMEXA2 "a2" 688 #define TSARKIMEXL2 "l2" 689 #define TSARKIMEXARS122 "ars122" 690 #define TSARKIMEX2C "2c" 691 #define TSARKIMEX2D "2d" 692 #define TSARKIMEX2E "2e" 693 #define TSARKIMEXPRSSP2 "prssp2" 694 #define TSARKIMEX3 "3" 695 #define TSARKIMEXBPR3 "bpr3" 696 #define TSARKIMEXARS443 "ars443" 697 #define TSARKIMEX4 "4" 698 #define TSARKIMEX5 "5" 699 PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 700 PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 701 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 702 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[]); 703 PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 704 PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 705 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 706 707 /*J 708 TSRosWType - String with the name of a Rosenbrock-W method. 709 710 Level: beginner 711 712 .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 713 J*/ 714 typedef const char* TSRosWType; 715 #define TSROSW2M "2m" 716 #define TSROSW2P "2p" 717 #define TSROSWRA3PW "ra3pw" 718 #define TSROSWRA34PW2 "ra34pw2" 719 #define TSROSWRODAS3 "rodas3" 720 #define TSROSWSANDU3 "sandu3" 721 #define TSROSWASSP3P3S1C "assp3p3s1c" 722 #define TSROSWLASSP3P4S2C "lassp3p4s2c" 723 #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 724 #define TSROSWARK3 "ark3" 725 #define TSROSWTHETA1 "theta1" 726 #define TSROSWTHETA2 "theta2" 727 #define TSROSWGRK4T "grk4t" 728 #define TSROSWSHAMP4 "shamp4" 729 #define TSROSWVELDD4 "veldd4" 730 #define TSROSW4L "4l" 731 732 PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*); 733 PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType); 734 PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 735 PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 736 PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 737 PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 738 PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 739 PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 740 741 /* 742 PETSc interface to Sundials 743 */ 744 #ifdef PETSC_HAVE_SUNDIALS 745 typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 746 PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 747 typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 748 PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 749 PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 750 PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 751 PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 752 PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 753 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 754 PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 755 PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 756 PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 757 PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 758 PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 759 PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 760 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 761 #endif 762 763 PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 764 PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 765 PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 766 PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 767 768 PETSC_EXTERN PetscErrorCode TSAlphaUseAdapt(TS,PetscBool); 769 PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 770 PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 771 PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 772 773 PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 774 PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 775 776 PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 777 PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*); 778 779 #endif 780