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