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