1 /* 2 User interface for the timestepping package. This package 3 is for use in solving time-dependent PDEs. 4 */ 5 #pragma once 6 7 #include <petscsnes.h> 8 #include <petscconvest.h> 9 10 /*I <petscts.h> I*/ 11 12 /* SUBMANSEC = TS */ 13 14 /*S 15 TS - Abstract PETSc object that manages integrating an ODE. 16 17 Level: beginner 18 19 .seealso: [](integrator_table), [](ch_ts), `TSCreate()`, `TSSetType()`, `TSType`, `SNES`, `KSP`, `PC`, `TSDestroy()` 20 S*/ 21 typedef struct _p_TS *TS; 22 23 /*J 24 TSType - String with the name of a PETSc `TS` method. These are all the time/ODE integrators that PETSc provides. 25 26 Level: beginner 27 28 Note: 29 Use `TSSetType()` or the options database key `-ts_type` to set the ODE integrator method to use with a given `TS` object 30 31 .seealso: [](integrator_table), [](ch_ts), `TSSetType()`, `TS`, `TSRegister()` 32 J*/ 33 typedef const char *TSType; 34 #define TSEULER "euler" 35 #define TSBEULER "beuler" 36 #define TSBASICSYMPLECTIC "basicsymplectic" 37 #define TSPSEUDO "pseudo" 38 #define TSCN "cn" 39 #define TSSUNDIALS "sundials" 40 #define TSRK "rk" 41 #define TSPYTHON "python" 42 #define TSTHETA "theta" 43 #define TSALPHA "alpha" 44 #define TSALPHA2 "alpha2" 45 #define TSGLLE "glle" 46 #define TSGLEE "glee" 47 #define TSSSP "ssp" 48 #define TSARKIMEX "arkimex" 49 #define TSROSW "rosw" 50 #define TSEIMEX "eimex" 51 #define TSMIMEX "mimex" 52 #define TSBDF "bdf" 53 #define TSRADAU5 "radau5" 54 #define TSMPRK "mprk" 55 #define TSDISCGRAD "discgrad" 56 #define TSIRK "irk" 57 #define TSDIRK "dirk" 58 59 /*E 60 TSProblemType - Determines the type of problem this `TS` object is to be used to solve 61 62 Values: 63 + `TS_LINEAR` - a linear ODE or DAE 64 - `TS_NONLINEAR` - a nonlinear ODE or DAE 65 66 Level: beginner 67 68 .seealso: [](ch_ts), `TS`, `TSCreate()` 69 E*/ 70 typedef enum { 71 TS_LINEAR, 72 TS_NONLINEAR 73 } TSProblemType; 74 75 /*E 76 TSEquationType - type of `TS` problem that is solved 77 78 Values: 79 + `TS_EQ_UNSPECIFIED` - (default) 80 . `TS_EQ_EXPLICIT` - {ODE and DAE index 1, 2, 3, HI} F(t,U,U_t) := M(t) U_t - G(U,t) = 0 81 - `TS_EQ_IMPLICIT` - {ODE and DAE index 1, 2, 3, HI} F(t,U,U_t) = 0 82 83 Level: beginner 84 85 .seealso: [](ch_ts), `TS`, `TSGetEquationType()`, `TSSetEquationType()` 86 E*/ 87 typedef enum { 88 TS_EQ_UNSPECIFIED = -1, 89 TS_EQ_EXPLICIT = 0, 90 TS_EQ_ODE_EXPLICIT = 1, 91 TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 92 TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 93 TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 94 TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 95 TS_EQ_IMPLICIT = 1000, 96 TS_EQ_ODE_IMPLICIT = 1001, 97 TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 98 TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 99 TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 100 TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 101 } TSEquationType; 102 PETSC_EXTERN const char *const *TSEquationTypes; 103 104 /*E 105 TSConvergedReason - reason a `TS` method has converged (integrated to the requested time) or not 106 107 Values: 108 + `TS_CONVERGED_ITERATING` - this only occurs if `TSGetConvergedReason()` is called during the `TSSolve()` 109 . `TS_CONVERGED_TIME` - the final time was reached 110 . `TS_CONVERGED_ITS` - the maximum number of iterations (time-steps) was reached prior to the final time 111 . `TS_CONVERGED_USER` - user requested termination 112 . `TS_CONVERGED_EVENT` - user requested termination on event detection 113 . `TS_CONVERGED_PSEUDO_FATOL` - stops when function norm decreased by a set amount, used only for `TSPSEUDO` 114 . `TS_CONVERGED_PSEUDO_FRTOL` - stops when function norm decreases below a set amount, used only for `TSPSEUDO` 115 . `TS_DIVERGED_NONLINEAR_SOLVE` - too many nonlinear solve failures have occurred 116 . `TS_DIVERGED_STEP_REJECTED` - too many steps were rejected 117 . `TSFORWARD_DIVERGED_LINEAR_SOLVE` - tangent linear solve failed 118 - `TSADJOINT_DIVERGED_LINEAR_SOLVE` - transposed linear solve failed 119 120 Level: beginner 121 122 .seealso: [](ch_ts), `TS`, `TSGetConvergedReason()` 123 E*/ 124 typedef enum { 125 TS_CONVERGED_ITERATING = 0, 126 TS_CONVERGED_TIME = 1, 127 TS_CONVERGED_ITS = 2, 128 TS_CONVERGED_USER = 3, 129 TS_CONVERGED_EVENT = 4, 130 TS_CONVERGED_PSEUDO_FATOL = 5, 131 TS_CONVERGED_PSEUDO_FRTOL = 6, 132 TS_DIVERGED_NONLINEAR_SOLVE = -1, 133 TS_DIVERGED_STEP_REJECTED = -2, 134 TSFORWARD_DIVERGED_LINEAR_SOLVE = -3, 135 TSADJOINT_DIVERGED_LINEAR_SOLVE = -4 136 } TSConvergedReason; 137 PETSC_EXTERN const char *const *TSConvergedReasons; 138 139 /*MC 140 TS_CONVERGED_ITERATING - this only occurs if `TSGetConvergedReason()` is called during the `TSSolve()` 141 142 Level: beginner 143 144 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()` 145 M*/ 146 147 /*MC 148 TS_CONVERGED_TIME - the final time was reached 149 150 Level: beginner 151 152 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxTime()`, `TSGetMaxTime()`, `TSGetSolveTime()` 153 M*/ 154 155 /*MC 156 TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 157 158 Level: beginner 159 160 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxSteps()`, `TSGetMaxSteps()` 161 M*/ 162 163 /*MC 164 TS_CONVERGED_USER - user requested termination 165 166 Level: beginner 167 168 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()` 169 M*/ 170 171 /*MC 172 TS_CONVERGED_EVENT - user requested termination on event detection 173 174 Level: beginner 175 176 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()` 177 M*/ 178 179 /*MC 180 TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for `TSPSEUDO` 181 182 Options Database Key: 183 . -ts_pseudo_frtol <rtol> - use specified rtol 184 185 Level: beginner 186 187 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FATOL` 188 M*/ 189 190 /*MC 191 TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for `TSPSEUDO` 192 193 Options Database Key: 194 . -ts_pseudo_fatol <atol> - use specified atol 195 196 Level: beginner 197 198 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FRTOL` 199 M*/ 200 201 /*MC 202 TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 203 204 Level: beginner 205 206 Note: 207 See `TSSetMaxSNESFailures()` for how to allow more nonlinear solver failures. 208 209 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSGetSNES()`, `SNESGetConvergedReason()`, `TSSetMaxSNESFailures()` 210 M*/ 211 212 /*MC 213 TS_DIVERGED_STEP_REJECTED - too many steps were rejected 214 215 Level: beginner 216 217 Notes: 218 See `TSSetMaxStepRejections()` for how to allow more step rejections. 219 220 .seealso: [](ch_ts), `TS`, `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxStepRejections()` 221 M*/ 222 223 /*E 224 TSExactFinalTimeOption - option for handling of final time step 225 226 Values: 227 + `TS_EXACTFINALTIME_STEPOVER` - Don't do anything if requested final time is exceeded 228 . `TS_EXACTFINALTIME_INTERPOLATE` - Interpolate back to final time 229 - `TS_EXACTFINALTIME_MATCHSTEP` - Adapt final time step to match the final time requested 230 231 Level: beginner 232 233 .seealso: [](ch_ts), `TS`, `TSGetConvergedReason()`, `TSSetExactFinalTime()`, `TSGetExactFinalTime()` 234 E*/ 235 typedef enum { 236 TS_EXACTFINALTIME_UNSPECIFIED = 0, 237 TS_EXACTFINALTIME_STEPOVER = 1, 238 TS_EXACTFINALTIME_INTERPOLATE = 2, 239 TS_EXACTFINALTIME_MATCHSTEP = 3 240 } TSExactFinalTimeOption; 241 PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 242 243 /* Logging support */ 244 PETSC_EXTERN PetscClassId TS_CLASSID; 245 PETSC_EXTERN PetscClassId DMTS_CLASSID; 246 PETSC_EXTERN PetscClassId TSADAPT_CLASSID; 247 248 PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 249 PETSC_EXTERN PetscErrorCode TSFinalizePackage(void); 250 251 PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm, TS *); 252 PETSC_EXTERN PetscErrorCode TSClone(TS, TS *); 253 PETSC_EXTERN PetscErrorCode TSDestroy(TS *); 254 255 PETSC_EXTERN PetscErrorCode TSSetProblemType(TS, TSProblemType); 256 PETSC_EXTERN PetscErrorCode TSGetProblemType(TS, TSProblemType *); 257 PETSC_EXTERN PetscErrorCode TSMonitor(TS, PetscInt, PetscReal, Vec); 258 PETSC_EXTERN PetscErrorCode TSMonitorSet(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, void *), void *, PetscCtxDestroyFn *); 259 PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS, const char[], const char[], const char[], PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *), PetscErrorCode (*)(TS, PetscViewerAndFormat *)); 260 PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 261 262 PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS, const char[]); 263 PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS, const char[]); 264 PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS, const char *[]); 265 PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 266 PETSC_EXTERN PetscErrorCode TSSetUp(TS); 267 PETSC_EXTERN PetscErrorCode TSReset(TS); 268 269 PETSC_EXTERN PetscErrorCode TSSetSolution(TS, Vec); 270 PETSC_EXTERN PetscErrorCode TSGetSolution(TS, Vec *); 271 272 PETSC_EXTERN PetscErrorCode TS2SetSolution(TS, Vec, Vec); 273 PETSC_EXTERN PetscErrorCode TS2GetSolution(TS, Vec *, Vec *); 274 275 PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS, PetscInt *, Vec *); 276 PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS, Vec *); 277 PETSC_EXTERN PetscErrorCode TSGetTimeError(TS, PetscInt, Vec *); 278 PETSC_EXTERN PetscErrorCode TSSetTimeError(TS, Vec); 279 280 PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), void *); 281 PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS, Mat *, PetscErrorCode (**)(TS, PetscReal, Vec, Mat, void *), void **); 282 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS, PetscReal, Vec, Mat); 283 PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Vec, PetscReal, Mat, void *), void *); 284 PETSC_EXTERN PetscErrorCode TSGetIJacobianP(TS, Mat *, PetscErrorCode (**)(TS, PetscReal, Vec, Vec, PetscReal, Mat, void *), void **); 285 PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS, PetscReal, Vec, Vec, PetscReal, Mat, PetscBool); 286 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS() then TSComputeRHSJacobianP()", ) PetscErrorCode TSComputeDRDPFunction(TS, PetscReal, Vec, Vec *); 287 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS() then TSComputeRHSJacobian()", ) PetscErrorCode TSComputeDRDUFunction(TS, PetscReal, Vec, Vec *); 288 PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS, Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec *, PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), void *); 289 PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 290 PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 291 PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 292 PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 293 PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS, Vec[], PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec[], PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec[], PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), Vec[], PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, Vec, Vec *, void *), void *); 294 PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 295 PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 296 PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 297 PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS, PetscReal, Vec, Vec[], Vec, Vec[]); 298 PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS, PetscInt, Vec[], Vec[], Vec); 299 PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS, PetscInt *, Vec *[], Vec *[], Vec *); 300 PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS, Vec, Mat, Mat); 301 302 /*S 303 TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step) 304 305 Level: advanced 306 307 .seealso: [](ch_ts), `TS`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectorySetType()`, `TSTrajectoryDestroy()`, `TSTrajectoryReset()` 308 S*/ 309 typedef struct _p_TSTrajectory *TSTrajectory; 310 311 /*J 312 TSTrajectoryType - String with the name of a PETSc `TS` trajectory storage method 313 314 Level: intermediate 315 316 .seealso: [](ch_ts), `TS`, `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()` 317 J*/ 318 typedef const char *TSTrajectoryType; 319 #define TSTRAJECTORYBASIC "basic" 320 #define TSTRAJECTORYSINGLEFILE "singlefile" 321 #define TSTRAJECTORYMEMORY "memory" 322 #define TSTRAJECTORYVISUALIZATION "visualization" 323 324 PETSC_EXTERN PetscFunctionList TSTrajectoryList; 325 PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 326 PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 327 328 PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 329 PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS); 330 PETSC_EXTERN PetscErrorCode TSRemoveTrajectory(TS); 331 332 PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm, TSTrajectory *); 333 PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory); 334 PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory *); 335 PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory, PetscViewer); 336 PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory, TS, TSTrajectoryType); 337 PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory, TS, TSTrajectoryType *); 338 PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory, TS, PetscInt, PetscReal, Vec); 339 PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory, TS, PetscInt, PetscReal *); 340 PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory, TS, PetscInt, PetscReal *, Vec, Vec); 341 PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory, TS, PetscReal, Vec *, Vec *); 342 PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory, PetscInt *); 343 PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory, Vec *, Vec *); 344 PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory, TS); 345 PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[], PetscErrorCode (*)(TSTrajectory, TS)); 346 PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 347 PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory, TS); 348 PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory, PetscBool); 349 PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory, PetscBool); 350 PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory, const char *const *); 351 PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory, PetscErrorCode (*)(void *, Vec, Vec *), PetscCtxDestroyFn *, void *); 352 PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory, PetscBool); 353 PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory, PetscBool *); 354 PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory, PetscBool); 355 PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory, const char[]); 356 PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory, const char[]); 357 PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS, TSTrajectory *); 358 359 typedef enum { 360 TJ_REVOLVE, 361 TJ_CAMS, 362 TJ_PETSC 363 } TSTrajectoryMemoryType; 364 PETSC_EXTERN const char *const TSTrajectoryMemoryTypes[]; 365 366 PETSC_EXTERN PetscErrorCode TSTrajectoryMemorySetType(TSTrajectory, TSTrajectoryMemoryType); 367 PETSC_EXTERN PetscErrorCode TSTrajectorySetMaxCpsRAM(TSTrajectory, PetscInt); 368 PETSC_EXTERN PetscErrorCode TSTrajectorySetMaxCpsDisk(TSTrajectory, PetscInt); 369 PETSC_EXTERN PetscErrorCode TSTrajectorySetMaxUnitsRAM(TSTrajectory, PetscInt); 370 PETSC_EXTERN PetscErrorCode TSTrajectorySetMaxUnitsDisk(TSTrajectory, PetscInt); 371 372 PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS, PetscInt, Vec[], Vec[]); 373 PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS, PetscInt *, Vec *[], Vec *[]); 374 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 12, 0, "TSCreateQuadratureTS() and TSForwardSetSensitivities()", ) PetscErrorCode TSSetCostIntegrand(TS, PetscInt, Vec, PetscErrorCode (*)(TS, PetscReal, Vec, Vec, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec *, void *), PetscBool, void *); 375 PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS, Vec *); 376 PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS, PetscReal, Vec, Vec); 377 PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS, PetscBool, TS *); 378 PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS, PetscBool *, TS *); 379 380 PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(TS, PetscOptionItems); 381 PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS, PetscInt, PetscReal, Vec, PetscInt, Vec[], Vec[]); 382 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, void *), void *, PetscCtxDestroyFn *); 383 PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 384 PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS, const char[], const char[], const char[], PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, PetscViewerAndFormat *), PetscErrorCode (*)(TS, PetscViewerAndFormat *)); 385 386 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSSetRHSJacobianP()", ) PetscErrorCode TSAdjointSetRHSJacobian(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), void *); 387 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSComputeRHSJacobianP()", ) PetscErrorCode TSAdjointComputeRHSJacobian(TS, PetscReal, Vec, Mat); 388 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS()", ) PetscErrorCode TSAdjointComputeDRDPFunction(TS, PetscReal, Vec, Vec *); 389 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 5, 0, "TSGetQuadratureTS()", ) PetscErrorCode TSAdjointComputeDRDYFunction(TS, PetscReal, Vec, Vec *); 390 PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 391 PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS, PetscInt); 392 393 PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 394 PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 395 PETSC_EXTERN PetscErrorCode TSAdjointReset(TS); 396 PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS); 397 PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS, Mat); 398 PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS); 399 400 PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS, PetscInt, Mat); 401 PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS, PetscInt *, Mat *); 402 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 12, 0, "TSCreateQuadratureTS()", ) PetscErrorCode TSForwardSetIntegralGradients(TS, PetscInt, Vec[]); 403 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 12, 0, "TSForwardGetSensitivities()", ) PetscErrorCode TSForwardGetIntegralGradients(TS, PetscInt *, Vec *[]); 404 PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS); 405 PETSC_EXTERN PetscErrorCode TSForwardReset(TS); 406 PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS); 407 PETSC_EXTERN PetscErrorCode TSForwardStep(TS); 408 PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS, Mat); 409 PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS, PetscInt *, Mat *[]); 410 411 PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS, PetscInt); 412 PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS, PetscInt *); 413 PETSC_EXTERN PetscErrorCode TSSetRunSteps(TS, PetscInt); 414 PETSC_EXTERN PetscErrorCode TSGetRunSteps(TS, PetscInt *); 415 PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS, PetscReal); 416 PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS, PetscReal *); 417 PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS, TSExactFinalTimeOption); 418 PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS, TSExactFinalTimeOption *); 419 PETSC_EXTERN PetscErrorCode TSSetEvaluationTimes(TS, PetscInt, PetscReal[]); 420 PETSC_EXTERN PetscErrorCode TSGetEvaluationTimes(TS, PetscInt *, const PetscReal *[]); 421 PETSC_EXTERN PetscErrorCode TSGetEvaluationSolutions(TS, PetscInt *, const PetscReal *[], Vec *[]); 422 PETSC_EXTERN PetscErrorCode TSSetTimeSpan(TS, PetscInt, PetscReal[]); 423 424 /*@C 425 TSGetTimeSpan - gets the time span set with `TSSetTimeSpan()` 426 427 Not Collective 428 429 Input Parameter: 430 . ts - the time-stepper 431 432 Output Parameters: 433 + n - number of the time points (>=2) 434 - span_times - array of the time points. The first element and the last element are the initial time and the final time respectively. 435 436 Level: deprecated 437 438 Note: 439 Deprecated, use `TSGetEvaluationTimes()`. 440 441 The values obtained are valid until the `TS` object is destroyed. 442 443 Both `n` and `span_times` can be `NULL`. 444 445 .seealso: [](ch_ts), `TS`, `TSGetEvaluationTimes()`, `TSSetTimeSpan()`, `TSSetEvaluationTimes()`, `TSGetEvaluationSolutions()` 446 @*/ 447 PETSC_DEPRECATED_FUNCTION(3, 23, 0, "TSGetEvaluationTimes()", ) static inline PetscErrorCode TSGetTimeSpan(TS ts, PetscInt *n, const PetscReal *span_times[]) 448 { 449 return TSGetEvaluationTimes(ts, n, span_times); 450 } 451 452 /*@C 453 TSGetTimeSpanSolutions - Get the number of solutions and the solutions at the time points specified by the time span. 454 455 Input Parameter: 456 . ts - the `TS` context obtained from `TSCreate()` 457 458 Output Parameters: 459 + nsol - the number of solutions 460 - Sols - the solution vectors 461 462 Level: deprecated 463 464 Notes: 465 Deprecated, use `TSGetEvaluationSolutions()`. 466 467 Both `nsol` and `Sols` can be `NULL`. 468 469 Some time points in the time span may be skipped by `TS` so that `nsol` is less than the number of points specified by `TSSetTimeSpan()`. 470 For example, manipulating the step size, especially with a reduced precision, may cause `TS` to step over certain points in the span. 471 This issue is alleviated in `TSGetEvaluationSolutions()` by returning the solution times that `Sols` were recorded at. 472 473 .seealso: [](ch_ts), `TS`, `TSGetEvaluationSolutions()`, `TSSetTimeSpan()`, `TSGetEvaluationTimes()`, `TSSetEvaluationTimes()` 474 @*/ 475 PETSC_DEPRECATED_FUNCTION(3, 23, 0, "TSGetEvaluationSolutions()", ) static inline PetscErrorCode TSGetTimeSpanSolutions(TS ts, PetscInt *nsol, Vec **Sols) 476 { 477 return TSGetEvaluationSolutions(ts, nsol, NULL, Sols); 478 } 479 480 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSSetTime()", ) PetscErrorCode TSSetInitialTimeStep(TS, PetscReal, PetscReal); 481 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSSetMax()", ) PetscErrorCode TSSetDuration(TS, PetscInt, PetscReal); 482 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSGetMax()", ) PetscErrorCode TSGetDuration(TS, PetscInt *, PetscReal *); 483 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSGetStepNumber()", ) PetscErrorCode TSGetTimeStepNumber(TS, PetscInt *); 484 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION(3, 8, 0, "TSGetStepNumber()", ) PetscErrorCode TSGetTotalSteps(TS, PetscInt *); 485 486 PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 487 PETSC_EXTERN PetscErrorCode TSMonitorWallClockTime(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 488 PETSC_EXTERN PetscErrorCode TSMonitorWallClockTimeSetUp(TS, PetscViewerAndFormat *); 489 PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 490 491 typedef struct _n_TSMonitorDrawCtx *TSMonitorDrawCtx; 492 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorDrawCtx *); 493 PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *); 494 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS, PetscInt, PetscReal, Vec, void *); 495 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS, PetscInt, PetscReal, Vec, void *); 496 PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS, PetscInt, PetscReal, Vec, void *); 497 PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS, PetscInt, PetscReal, Vec, void *); 498 499 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS, PetscInt, PetscReal, Vec, PetscInt, Vec[], Vec[], PetscViewerAndFormat *); 500 PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS, PetscInt, PetscReal, Vec, PetscInt, Vec[], Vec[], void *); 501 502 typedef struct _n_TSMonitorSolutionCtx *TSMonitorSolutionCtx; 503 PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 504 PETSC_EXTERN PetscErrorCode TSMonitorSolutionSetup(TS, PetscViewerAndFormat *); 505 506 typedef struct _n_TSMonitorVTKCtx *TSMonitorVTKCtx; 507 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS, PetscInt, PetscReal, Vec, TSMonitorVTKCtx); 508 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(TSMonitorVTKCtx *); 509 PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKCtxCreate(const char *, TSMonitorVTKCtx *); 510 511 PETSC_EXTERN PetscErrorCode TSStep(TS); 512 PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS, NormType, PetscInt *, PetscReal *); 513 PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS, PetscInt, Vec, PetscBool *); 514 PETSC_EXTERN PetscErrorCode TSSolve(TS, Vec); 515 PETSC_EXTERN PetscErrorCode TSGetEquationType(TS, TSEquationType *); 516 PETSC_EXTERN PetscErrorCode TSSetEquationType(TS, TSEquationType); 517 PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS, TSConvergedReason *); 518 PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS, TSConvergedReason); 519 PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS, PetscReal *); 520 PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS, PetscInt *); 521 PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS, PetscInt *); 522 PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS, PetscInt *); 523 PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS, PetscInt); 524 PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS, PetscInt *); 525 PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS, PetscInt); 526 PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS, PetscBool); 527 PETSC_EXTERN PetscErrorCode TSRestartStep(TS); 528 PETSC_EXTERN PetscErrorCode TSRollBack(TS); 529 PETSC_EXTERN PetscErrorCode TSGetStepRollBack(TS, PetscBool *); 530 531 PETSC_EXTERN PetscErrorCode TSGetStages(TS, PetscInt *, Vec *[]); 532 533 PETSC_EXTERN PetscErrorCode TSGetTime(TS, PetscReal *); 534 PETSC_EXTERN PetscErrorCode TSSetTime(TS, PetscReal); 535 PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS, PetscReal *); 536 PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS, PetscReal *); 537 PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS, PetscReal); 538 PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS, PetscInt *); 539 PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS, PetscInt); 540 541 /*S 542 TSRHSFunctionFn - A prototype of a `TS` right-hand-side evaluation function that would be passed to `TSSetRHSFunction()` 543 544 Calling Sequence: 545 + ts - timestep context 546 . t - current time 547 . u - input vector 548 . F - function vector 549 - ctx - [optional] user-defined function context 550 551 Level: beginner 552 553 Note: 554 The deprecated `TSRHSFunction` still works as a replacement for `TSRHSFunctionFn` *. 555 556 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `DMTSSetRHSFunction()`, `TSIFunctionFn`, 557 `TSIJacobianFn`, `TSRHSJacobianFn` 558 S*/ 559 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSRHSFunctionFn(TS ts, PetscReal t, Vec u, Vec F, void *ctx); 560 561 PETSC_EXTERN_TYPEDEF typedef TSRHSFunctionFn *TSRHSFunction; 562 563 /*S 564 TSRHSJacobianFn - A prototype of a `TS` right-hand-side Jacobian evaluation function that would be passed to `TSSetRHSJacobian()` 565 566 Calling Sequence: 567 + ts - the `TS` context obtained from `TSCreate()` 568 . t - current time 569 . u - input vector 570 . Amat - (approximate) Jacobian matrix 571 . Pmat - matrix from which preconditioner is to be constructed (usually the same as `Amat`) 572 - ctx - [optional] user-defined context for matrix evaluation routine 573 574 Level: beginner 575 576 Note: 577 The deprecated `TSRHSJacobian` still works as a replacement for `TSRHSJacobianFn` *. 578 579 .seealso: [](ch_ts), `TS`, `TSSetRHSJacobian()`, `DMTSSetRHSJacobian()`, `TSRHSFunctionFn`, 580 `TSIFunctionFn`, `TSIJacobianFn` 581 S*/ 582 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSRHSJacobianFn(TS ts, PetscReal t, Vec u, Mat Amat, Mat Pmat, void *ctx); 583 584 PETSC_EXTERN_TYPEDEF typedef TSRHSJacobianFn *TSRHSJacobian; 585 586 /*S 587 TSRHSJacobianPFn - A prototype of a function that computes the Jacobian of G w.r.t. the parameters P where 588 U_t = G(U,P,t), as well as the location to store the matrix that would be passed to `TSSetRHSJacobianP()` 589 590 Calling Sequence: 591 + ts - the `TS` context 592 . t - current timestep 593 . U - input vector (current ODE solution) 594 . A - output matrix 595 - ctx - [optional] user-defined function context 596 597 Level: beginner 598 599 Note: 600 The deprecated `TSRHSJacobianP` still works as a replacement for `TSRHSJacobianPFn` *. 601 602 .seealso: [](ch_ts), `TS`, `TSSetRHSJacobianP()`, `TSGetRHSJacobianP()` 603 S*/ 604 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSRHSJacobianPFn(TS ts, PetscReal t, Vec U, Mat A, void *ctx); 605 606 PETSC_EXTERN_TYPEDEF typedef TSRHSJacobianPFn *TSRHSJacobianP; 607 608 PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS, Vec, TSRHSFunctionFn *, void *); 609 PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS, Vec *, TSRHSFunctionFn **, void **); 610 PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS, Mat, Mat, TSRHSJacobianFn *, void *); 611 PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS, Mat *, Mat *, TSRHSJacobianFn **, void **); 612 PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS, PetscBool); 613 614 /*S 615 TSSolutionFn - A prototype of a `TS` solution evaluation function that would be passed to `TSSetSolutionFunction()` 616 617 Calling Sequence: 618 + ts - timestep context 619 . t - current time 620 . u - output vector 621 - ctx - [optional] user-defined function context 622 623 Level: advanced 624 625 Note: 626 The deprecated `TSSolutionFunction` still works as a replacement for `TSSolutionFn` *. 627 628 .seealso: [](ch_ts), `TS`, `TSSetSolutionFunction()`, `DMTSSetSolutionFunction()` 629 S*/ 630 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSSolutionFn(TS ts, PetscReal t, Vec u, void *ctx); 631 632 PETSC_EXTERN_TYPEDEF typedef TSSolutionFn *TSSolutionFunction; 633 634 PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS, TSSolutionFn *, void *); 635 636 /*S 637 TSForcingFn - A prototype of a `TS` forcing function evaluation function that would be passed to `TSSetForcingFunction()` 638 639 Calling Sequence: 640 + ts - timestep context 641 . t - current time 642 . f - output vector 643 - ctx - [optional] user-defined function context 644 645 Level: advanced 646 647 Note: 648 The deprecated `TSForcingFunction` still works as a replacement for `TSForcingFn` *. 649 650 .seealso: [](ch_ts), `TS`, `TSSetForcingFunction()`, `DMTSSetForcingFunction()` 651 S*/ 652 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSForcingFn(TS ts, PetscReal t, Vec f, void *ctx); 653 654 PETSC_EXTERN_TYPEDEF typedef TSForcingFn *TSForcingFunction; 655 656 PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS, TSForcingFn *, void *); 657 658 /*S 659 TSIFunctionFn - A prototype of a `TS` implicit function evaluation function that would be passed to `TSSetIFunction() 660 661 Calling Sequence: 662 + ts - the `TS` context obtained from `TSCreate()` 663 . t - time at step/stage being solved 664 . U - state vector 665 . U_t - time derivative of state vector 666 . F - function vector 667 - ctx - [optional] user-defined context for function 668 669 Level: beginner 670 671 Note: 672 The deprecated `TSIFunction` still works as a replacement for `TSIFunctionFn` *. 673 674 .seealso: [](ch_ts), `TS`, `TSSetIFunction()`, `DMTSSetIFunction()`, `TSIJacobianFn`, `TSRHSFunctionFn`, `TSRHSJacobianFn` 675 S*/ 676 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSIFunctionFn(TS ts, PetscReal t, Vec U, Vec U_t, Vec F, void *ctx); 677 678 PETSC_EXTERN_TYPEDEF typedef TSIFunctionFn *TSIFunction; 679 680 /*S 681 TSIJacobianFn - A prototype of a `TS` Jacobian evaluation function that would be passed to `TSSetIJacobian()` 682 683 Calling Sequence: 684 + ts - the `TS` context obtained from `TSCreate()` 685 . t - time at step/stage being solved 686 . U - state vector 687 . U_t - time derivative of state vector 688 . a - shift 689 . Amat - (approximate) Jacobian of F(t,U,W+a*U), equivalent to dF/dU + a*dF/dU_t 690 . Pmat - matrix used for constructing preconditioner, usually the same as `Amat` 691 - ctx - [optional] user-defined context for Jacobian evaluation routine 692 693 Level: beginner 694 695 Note: 696 The deprecated `TSIJacobian` still works as a replacement for `TSIJacobianFn` *. 697 698 .seealso: [](ch_ts), `TSSetIJacobian()`, `DMTSSetIJacobian()`, `TSIFunctionFn`, `TSRHSFunctionFn`, `TSRHSJacobianFn` 699 S*/ 700 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSIJacobianFn(TS ts, PetscReal t, Vec U, Vec U_t, PetscReal a, Mat Amat, Mat Pmat, void *ctx); 701 702 PETSC_EXTERN_TYPEDEF typedef TSIJacobianFn *TSIJacobian; 703 704 PETSC_EXTERN PetscErrorCode TSSetIFunction(TS, Vec, TSIFunctionFn *, void *); 705 PETSC_EXTERN PetscErrorCode TSGetIFunction(TS, Vec *, TSIFunctionFn **, void **); 706 PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS, Mat, Mat, TSIJacobianFn *, void *); 707 PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS, Mat *, Mat *, TSIJacobianFn **, void **); 708 709 /*S 710 TSI2FunctionFn - A prototype of a `TS` implicit function evaluation function for 2nd order systems that would be passed to `TSSetI2Function()` 711 712 Calling Sequence: 713 + ts - the `TS` context obtained from `TSCreate()` 714 . t - time at step/stage being solved 715 . U - state vector 716 . U_t - time derivative of state vector 717 . U_tt - second time derivative of state vector 718 . F - function vector 719 - ctx - [optional] user-defined context for matrix evaluation routine (may be `NULL`) 720 721 Level: advanced 722 723 Note: 724 The deprecated `TSI2Function` still works as a replacement for `TSI2FunctionFn` *. 725 726 .seealso: [](ch_ts), `TS`, `TSSetI2Function()`, `DMTSSetI2Function()`, `TSIFunctionFn` 727 S*/ 728 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSI2FunctionFn(TS ts, PetscReal t, Vec U, Vec U_t, Vec U_tt, Vec F, void *ctx); 729 730 PETSC_EXTERN_TYPEDEF typedef TSI2FunctionFn *TSI2Function; 731 732 /*S 733 TSI2JacobianFn - A prototype of a `TS` implicit Jacobian evaluation function for 2nd order systems that would be passed to `TSSetI2Jacobian()` 734 735 Calling Sequence: 736 + ts - the `TS` context obtained from `TSCreate()` 737 . t - time at step/stage being solved 738 . U - state vector 739 . U_t - time derivative of state vector 740 . U_tt - second time derivative of state vector 741 . v - shift for U_t 742 . a - shift for U_tt 743 . J - Jacobian of G(U) = F(t,U,W+v*U,W'+a*U), equivalent to dF/dU + v*dF/dU_t + a*dF/dU_tt 744 . jac - matrix from which to construct the preconditioner, may be same as `J` 745 - ctx - [optional] user-defined context for matrix evaluation routine 746 747 Level: advanced 748 749 Note: 750 The deprecated `TSI2Jacobian` still works as a replacement for `TSI2JacobianFn` *. 751 752 .seealso: [](ch_ts), `TS`, `TSSetI2Jacobian()`, `DMTSSetI2Jacobian()`, `TSIFunctionFn`, `TSIJacobianFn`, `TSRHSFunctionFn`, `TSRHSJacobianFn` 753 S*/ 754 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSI2JacobianFn(TS ts, PetscReal t, Vec U, Vec U_t, Vec U_tt, PetscReal v, PetscReal a, Mat J, Mat Jac, void *ctx); 755 756 PETSC_EXTERN_TYPEDEF typedef TSI2JacobianFn *TSI2Jacobian; 757 758 PETSC_EXTERN PetscErrorCode TSSetI2Function(TS, Vec, TSI2FunctionFn *, void *); 759 PETSC_EXTERN PetscErrorCode TSGetI2Function(TS, Vec *, TSI2FunctionFn **, void **); 760 PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS, Mat, Mat, TSI2JacobianFn *, void *); 761 PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS, Mat *, Mat *, TSI2JacobianFn **, void **); 762 763 PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS, const char[], IS); 764 PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS, const char[], IS *); 765 PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS, const char[], Vec, TSRHSFunctionFn *, void *); 766 PETSC_EXTERN PetscErrorCode TSRHSSplitSetIFunction(TS, const char[], Vec, TSIFunctionFn *, void *); 767 PETSC_EXTERN PetscErrorCode TSRHSSplitSetIJacobian(TS, const char[], Mat, Mat, TSIJacobianFn *, void *); 768 PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS, const char[], TS *); 769 PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS, PetscInt *, TS *[]); 770 PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool); 771 PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool *); 772 PETSC_EXTERN PetscErrorCode TSRHSSplitGetSNES(TS, SNES *); 773 PETSC_EXTERN PetscErrorCode TSRHSSplitSetSNES(TS, SNES); 774 775 PETSC_EXTERN TSRHSFunctionFn TSComputeRHSFunctionLinear; 776 PETSC_EXTERN TSRHSJacobianFn TSComputeRHSJacobianConstant; 777 PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS, PetscReal, Vec, Vec, Vec, void *); 778 PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *); 779 PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS, PetscReal, Vec); 780 PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS, PetscReal, Vec); 781 PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *); 782 PETSC_EXTERN PetscErrorCode TSPruneIJacobianColor(TS, Mat, Mat); 783 784 PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 785 PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS, PetscReal)); 786 PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS, PetscReal, PetscInt, Vec *)); 787 PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode (*)(TS)); 788 PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 789 PETSC_EXTERN PetscErrorCode TSSetResize(TS, PetscBool, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscBool *, void *), PetscErrorCode (*)(TS, PetscInt, Vec[], Vec[], void *), void *); 790 PETSC_EXTERN PetscErrorCode TSPreStep(TS); 791 PETSC_EXTERN PetscErrorCode TSPreStage(TS, PetscReal); 792 PETSC_EXTERN PetscErrorCode TSPostStage(TS, PetscReal, PetscInt, Vec[]); 793 PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS); 794 PETSC_EXTERN PetscErrorCode TSPostStep(TS); 795 PETSC_EXTERN PetscErrorCode TSResize(TS); 796 PETSC_EXTERN PetscErrorCode TSResizeRetrieveVec(TS, const char *, Vec *); 797 PETSC_EXTERN PetscErrorCode TSResizeRegisterVec(TS, const char *, Vec); 798 PETSC_EXTERN PetscErrorCode TSGetStepResize(TS, PetscBool *); 799 800 PETSC_EXTERN PetscErrorCode TSInterpolate(TS, PetscReal, Vec); 801 PETSC_EXTERN PetscErrorCode TSSetTolerances(TS, PetscReal, Vec, PetscReal, Vec); 802 PETSC_EXTERN PetscErrorCode TSGetTolerances(TS, PetscReal *, Vec *, PetscReal *, Vec *); 803 PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS, Vec, Vec, NormType, PetscReal *, PetscReal *, PetscReal *); 804 PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS, Vec, Vec, Vec, NormType, PetscReal *, PetscReal *, PetscReal *); 805 PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS, PetscReal); 806 PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS, PetscReal *); 807 PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS, PetscReal, Vec, PetscBool *)); 808 PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS, PetscReal, Vec, PetscBool *); 809 810 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS, PetscErrorCode (*)(TS, PetscReal *, void *), void *); 811 PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS, PetscReal *, void *); 812 PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS, PetscReal *); 813 PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS, PetscReal); 814 PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS, PetscErrorCode (*)(TS, Vec, void *, PetscReal *, PetscBool *), void *); 815 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS, Vec, void *, PetscReal *, PetscBool *); 816 PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS, Vec, PetscReal *, PetscBool *); 817 PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS, PetscReal); 818 PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 819 PETSC_EXTERN PetscErrorCode TSPseudoComputeFunction(TS, Vec, Vec *, PetscReal *); 820 821 PETSC_EXTERN PetscErrorCode TSPythonSetType(TS, const char[]); 822 PETSC_EXTERN PetscErrorCode TSPythonGetType(TS, const char *[]); 823 824 PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS, PetscReal, Vec, Vec); 825 PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS, PetscReal, Vec, Mat, Mat); 826 PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS, PetscReal, Vec, Vec, Vec, PetscBool); 827 PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, PetscBool); 828 PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS, PetscReal, Vec, Vec, Vec, Vec); 829 PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS, PetscReal, Vec, Vec, Vec, PetscReal, PetscReal, Mat, Mat); 830 PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS, PetscReal, PetscReal, PetscReal *, PetscReal *); 831 832 PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS, Vec, Vec); 833 834 PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 835 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM, TSRHSFunctionFn *, void *); 836 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM, TSRHSFunctionFn **, void **); 837 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionContextDestroy(DM, PetscCtxDestroyFn *); 838 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM, TSRHSJacobianFn *, void *); 839 PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM, TSRHSJacobianFn **, void **); 840 PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobianContextDestroy(DM, PetscCtxDestroyFn *); 841 PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM, TSIFunctionFn *, void *); 842 PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM, TSIFunctionFn **, void **); 843 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionContextDestroy(DM, PetscCtxDestroyFn *); 844 PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM, TSIJacobianFn *, void *); 845 PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM, TSIJacobianFn **, void **); 846 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianContextDestroy(DM, PetscCtxDestroyFn *); 847 PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM, TSI2FunctionFn *, void *); 848 PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM, TSI2FunctionFn **, void **); 849 PETSC_EXTERN PetscErrorCode DMTSSetI2FunctionContextDestroy(DM, PetscCtxDestroyFn *); 850 PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM, TSI2JacobianFn *, void *); 851 PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM, TSI2JacobianFn **, void **); 852 PETSC_EXTERN PetscErrorCode DMTSSetI2JacobianContextDestroy(DM, PetscCtxDestroyFn *); 853 854 /*S 855 TSTransientVariableFn - A prototype of a function to transform from state to transient variables that would be passed to `TSSetTransientVariable()` 856 857 Calling Sequence: 858 + ts - timestep context 859 . p - input vector (primitive form) 860 . c - output vector, transient variables (conservative form) 861 - ctx - [optional] user-defined function context 862 863 Level: advanced 864 865 Note: 866 The deprecated `TSTransientVariable` still works as a replacement for `TSTransientVariableFn` *. 867 868 .seealso: [](ch_ts), `TS`, `TSSetTransientVariable()`, `DMTSSetTransientVariable()` 869 S*/ 870 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSTransientVariableFn(TS ts, Vec p, Vec c, void *ctx); 871 872 PETSC_EXTERN_TYPEDEF typedef TSTransientVariableFn *TSTransientVariable; 873 874 PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS, TSTransientVariableFn *, void *); 875 PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM, TSTransientVariableFn *, void *); 876 PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM, TSTransientVariableFn **, void *); 877 PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS, Vec, Vec); 878 PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS, PetscBool *); 879 880 PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM, TSSolutionFn *, void *); 881 PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM, TSSolutionFn **, void **); 882 PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM, TSForcingFn *, void *); 883 PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM, TSForcingFn **, void **); 884 PETSC_EXTERN PetscErrorCode DMTSCheckResidual(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscReal *); 885 PETSC_EXTERN PetscErrorCode DMTSCheckJacobian(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscBool *, PetscReal *); 886 PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec); 887 888 PETSC_EXTERN PetscErrorCode DMTSGetIFunctionLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, Vec, void *), void **); 889 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, Vec, void *), void *); 890 PETSC_EXTERN PetscErrorCode DMTSGetIJacobianLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *), void **); 891 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *), void *); 892 PETSC_EXTERN PetscErrorCode DMTSGetRHSFunctionLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, void *), void **); 893 PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 894 PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrix(DM); 895 PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrixLumped(DM); 896 PETSC_EXTERN PetscErrorCode DMTSDestroyRHSMassMatrix(DM); 897 898 PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM, PetscErrorCode (*)(void *, PetscViewer), PetscErrorCode (*)(void **, PetscViewer)); 899 PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM, PetscErrorCode (*)(void *, PetscViewer), PetscErrorCode (*)(void **, PetscViewer)); 900 901 /*S 902 DMDATSRHSFunctionLocalFn - A prototype of a local `TS` right-hand side residual evaluation function for use with `DMDA` that would be passed to `DMDATSSetRHSFunctionLocal()` 903 904 Calling Sequence: 905 + info - defines the subdomain to evaluate the residual on 906 . t - time at which to evaluate residual 907 . x - array of local state information 908 . f - output array of local residual information 909 - ctx - optional user context 910 911 Level: beginner 912 913 Note: 914 The deprecated `DMDATSRHSFunctionLocal` still works as a replacement for `DMDATSRHSFunctionLocalFn` *. 915 916 .seealso: `DMDA`, `DMDATSSetRHSFunctionLocal()`, `TSRHSFunctionFn`, `DMDATSRHSJacobianLocalFn`, `DMDATSIJacobianLocalFn`, `DMDATSIFunctionLocalFn` 917 S*/ 918 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode DMDATSRHSFunctionLocalFn(DMDALocalInfo *info, PetscReal t, void *x, void *f, void *ctx); 919 920 PETSC_EXTERN_TYPEDEF typedef DMDATSRHSFunctionLocalFn *DMDATSRHSFunctionLocal; 921 922 /*S 923 DMDATSRHSJacobianLocalFn - A prototype of a local residual evaluation function for use with `DMDA` that would be passed to `DMDATSSetRHSJacobianLocal()` 924 925 Calling Sequence: 926 + info - defines the subdomain to evaluate the residual on 927 . t - time at which to evaluate residual 928 . x - array of local state information 929 . J - Jacobian matrix 930 . B - matrix from which to construct the preconditioner; often same as `J` 931 - ctx - optional context 932 933 Level: beginner 934 935 Note: 936 The deprecated `DMDATSRHSJacobianLocal` still works as a replacement for `DMDATSRHSJacobianLocalFn` *. 937 938 .seealso: `DMDA`, `DMDATSSetRHSJacobianLocal()`, `TSRHSJacobianFn`, `DMDATSRHSFunctionLocalFn`, `DMDATSIJacobianLocalFn`, `DMDATSIFunctionLocalFn` 939 S*/ 940 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode DMDATSRHSJacobianLocalFn(DMDALocalInfo *info, PetscReal t, void *x, Mat J, Mat B, void *ctx); 941 942 PETSC_EXTERN_TYPEDEF typedef DMDATSRHSJacobianLocalFn *DMDATSRHSJacobianLocal; 943 944 /*S 945 DMDATSIFunctionLocalFn - A prototype of a local residual evaluation function for use with `DMDA` that would be passed to `DMDATSSetIFunctionLocal()` 946 947 Calling Sequence: 948 + info - defines the subdomain to evaluate the residual on 949 . t - time at which to evaluate residual 950 . x - array of local state information 951 . xdot - array of local time derivative information 952 . imode - output array of local function evaluation information 953 - ctx - optional context 954 955 Level: beginner 956 957 Note: 958 The deprecated `DMDATSIFunctionLocal` still works as a replacement for `DMDATSIFunctionLocalFn` *. 959 960 .seealso: `DMDA`, `DMDATSSetIFunctionLocal()`, `DMDATSIJacobianLocalFn`, `TSIFunctionFn` 961 S*/ 962 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode DMDATSIFunctionLocalFn(DMDALocalInfo *info, PetscReal t, void *x, void *xdot, void *imode, void *ctx); 963 964 PETSC_EXTERN_TYPEDEF typedef DMDATSIFunctionLocalFn *DMDATSIFunctionLocal; 965 966 /*S 967 DMDATSIJacobianLocalFn - A prototype of a local residual evaluation function for use with `DMDA` that would be passed to `DMDATSSetIJacobianLocal()` 968 969 Calling Sequence: 970 + info - defines the subdomain to evaluate the residual on 971 . t - time at which to evaluate the jacobian 972 . x - array of local state information 973 . xdot - time derivative at this state 974 . shift - see `TSSetIJacobian()` for the meaning of this parameter 975 . J - Jacobian matrix 976 . B - matrix from which to construct the preconditioner; often same as `J` 977 - ctx - optional context 978 979 Level: beginner 980 981 Note: 982 The deprecated `DMDATSIJacobianLocal` still works as a replacement for `DMDATSIJacobianLocalFn` *. 983 984 .seealso: `DMDA` `DMDATSSetIJacobianLocal()`, `TSIJacobianFn`, `DMDATSIFunctionLocalFn`, `DMDATSRHSFunctionLocalFn`, `DMDATSRHSJacobianlocal()` 985 S*/ 986 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode DMDATSIJacobianLocalFn(DMDALocalInfo *info, PetscReal t, void *x, void *xdot, PetscReal shift, Mat J, Mat B, void *ctx); 987 988 PETSC_EXTERN_TYPEDEF typedef DMDATSIJacobianLocalFn *DMDATSIJacobianLocal; 989 990 PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM, InsertMode, DMDATSRHSFunctionLocalFn *, void *); 991 PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM, DMDATSRHSJacobianLocalFn *, void *); 992 PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM, InsertMode, DMDATSIFunctionLocalFn *, void *); 993 PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM, DMDATSIJacobianLocalFn *, void *); 994 995 typedef struct _n_TSMonitorLGCtx *TSMonitorLGCtx; 996 typedef struct { 997 Vec ray; 998 VecScatter scatter; 999 PetscViewer viewer; 1000 TSMonitorLGCtx lgctx; 1001 } TSMonitorDMDARayCtx; 1002 PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void **); 1003 PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS, PetscInt, PetscReal, Vec, void *); 1004 PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS, PetscInt, PetscReal, Vec, void *); 1005 1006 /* Dynamic creation and loading functions */ 1007 PETSC_EXTERN PetscFunctionList TSList; 1008 PETSC_EXTERN PetscErrorCode TSGetType(TS, TSType *); 1009 PETSC_EXTERN PetscErrorCode TSSetType(TS, TSType); 1010 PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 1011 1012 PETSC_EXTERN PetscErrorCode TSGetSNES(TS, SNES *); 1013 PETSC_EXTERN PetscErrorCode TSSetSNES(TS, SNES); 1014 PETSC_EXTERN PetscErrorCode TSGetKSP(TS, KSP *); 1015 1016 PETSC_EXTERN PetscErrorCode TSView(TS, PetscViewer); 1017 PETSC_EXTERN PetscErrorCode TSLoad(TS, PetscViewer); 1018 PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS, PetscObject, const char[]); 1019 PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory, PetscObject, const char[]); 1020 1021 #define TS_FILE_CLASSID 1211225 1022 1023 PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS, void *); 1024 PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS, void *); 1025 1026 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorLGCtx *); 1027 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *); 1028 PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS, PetscInt, PetscReal, Vec, void *); 1029 PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS, PetscInt, PetscReal, Vec, void *); 1030 PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS, const char *const *); 1031 PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS, const char *const **); 1032 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx, const char *const *); 1033 PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS, const char *const *); 1034 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx, const char *const *); 1035 PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS, PetscErrorCode (*)(void *, Vec, Vec *), PetscCtxDestroyFn *, void *); 1036 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx, PetscErrorCode (*)(void *, Vec, Vec *), PetscCtxDestroyFn *, void *); 1037 PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS, PetscInt, PetscReal, Vec, void *); 1038 PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS, PetscInt, PetscReal, Vec, void *); 1039 PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS, PetscInt, PetscReal, Vec, void *); 1040 PETSC_EXTERN PetscErrorCode TSMonitorError(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 1041 PETSC_EXTERN PetscErrorCode TSDMSwarmMonitorMoments(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 1042 1043 struct _n_TSMonitorLGCtxNetwork { 1044 PetscInt nlg; 1045 PetscDrawLG *lg; 1046 PetscBool semilogy; 1047 PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 1048 }; 1049 typedef struct _n_TSMonitorLGCtxNetwork *TSMonitorLGCtxNetwork; 1050 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkDestroy(TSMonitorLGCtxNetwork *); 1051 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkCreate(TS, const char[], const char[], int, int, int, int, PetscInt, TSMonitorLGCtxNetwork *); 1052 PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkSolution(TS, PetscInt, PetscReal, Vec, void *); 1053 1054 typedef struct _n_TSMonitorEnvelopeCtx *TSMonitorEnvelopeCtx; 1055 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS, TSMonitorEnvelopeCtx *); 1056 PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS, PetscInt, PetscReal, Vec, void *); 1057 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS, Vec *, Vec *); 1058 PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *); 1059 1060 typedef struct _n_TSMonitorSPEigCtx *TSMonitorSPEigCtx; 1061 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorSPEigCtx *); 1062 PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx *); 1063 PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS, PetscInt, PetscReal, Vec, void *); 1064 1065 typedef struct _n_TSMonitorSPCtx *TSMonitorSPCtx; 1066 PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, PetscInt, PetscBool, PetscBool, TSMonitorSPCtx *); 1067 PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *); 1068 PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS, PetscInt, PetscReal, Vec, void *); 1069 1070 typedef struct _n_TSMonitorHGCtx *TSMonitorHGCtx; 1071 PETSC_EXTERN PetscErrorCode TSMonitorHGCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, PetscInt, PetscInt, PetscBool, TSMonitorHGCtx *); 1072 PETSC_EXTERN PetscErrorCode TSMonitorHGSwarmSolution(TS, PetscInt, PetscReal, Vec, void *); 1073 PETSC_EXTERN PetscErrorCode TSMonitorHGCtxDestroy(TSMonitorHGCtx *); 1074 PETSC_EXTERN PetscErrorCode TSMonitorHGSwarmSolution(TS, PetscInt, PetscReal, Vec, void *); 1075 1076 PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS, PetscInt, PetscInt[], PetscBool[], PetscErrorCode (*)(TS, PetscReal, Vec, PetscReal[], void *), PetscErrorCode (*)(TS, PetscInt, PetscInt[], PetscReal, Vec, PetscBool, void *), void *); 1077 PETSC_EXTERN PetscErrorCode TSSetPostEventStep(TS, PetscReal); 1078 PETSC_EXTERN PetscErrorCode TSSetPostEventSecondStep(TS, PetscReal); 1079 PETSC_DEPRECATED_FUNCTION(3, 21, 0, "TSSetPostEventSecondStep()", ) static inline PetscErrorCode TSSetPostEventIntervalStep(TS ts, PetscReal dt) 1080 { 1081 return TSSetPostEventSecondStep(ts, dt); 1082 } 1083 PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS, PetscReal, PetscReal[]); 1084 PETSC_EXTERN PetscErrorCode TSGetNumEvents(TS, PetscInt *); 1085 1086 /*J 1087 TSSSPType - string with the name of a `TSSSP` scheme. 1088 1089 Level: beginner 1090 1091 .seealso: [](ch_ts), `TSSSPSetType()`, `TS`, `TSSSP` 1092 J*/ 1093 typedef const char *TSSSPType; 1094 #define TSSSPRKS2 "rks2" 1095 #define TSSSPRKS3 "rks3" 1096 #define TSSSPRK104 "rk104" 1097 1098 PETSC_EXTERN PetscErrorCode TSSSPSetType(TS, TSSSPType); 1099 PETSC_EXTERN PetscErrorCode TSSSPGetType(TS, TSSSPType *); 1100 PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS, PetscInt); 1101 PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS, PetscInt *); 1102 PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 1103 PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 1104 PETSC_EXTERN PetscFunctionList TSSSPList; 1105 1106 /*S 1107 TSAdapt - Abstract object that manages time-step adaptivity 1108 1109 Level: beginner 1110 1111 .seealso: [](ch_ts), `TS`, `TSGetAdapt()`, `TSAdaptCreate()`, `TSAdaptType` 1112 S*/ 1113 typedef struct _p_TSAdapt *TSAdapt; 1114 1115 /*J 1116 TSAdaptType - String with the name of `TSAdapt` scheme. 1117 1118 Level: beginner 1119 1120 .seealso: [](ch_ts), `TSGetAdapt()`, `TSAdaptSetType()`, `TS`, `TSAdapt` 1121 J*/ 1122 typedef const char *TSAdaptType; 1123 #define TSADAPTNONE "none" 1124 #define TSADAPTBASIC "basic" 1125 #define TSADAPTDSP "dsp" 1126 #define TSADAPTCFL "cfl" 1127 #define TSADAPTGLEE "glee" 1128 #define TSADAPTHISTORY "history" 1129 1130 PETSC_EXTERN PetscErrorCode TSGetAdapt(TS, TSAdapt *); 1131 PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[], PetscErrorCode (*)(TSAdapt)); 1132 PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 1133 PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 1134 PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm, TSAdapt *); 1135 PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt, TSAdaptType); 1136 PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt, TSAdaptType *); 1137 PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt, const char[]); 1138 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 1139 PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt, const char[], PetscInt, PetscInt, PetscReal, PetscReal, PetscBool); 1140 PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt, PetscInt *, const PetscInt **, const PetscInt **, const PetscReal **, const PetscReal **); 1141 PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt, TS, PetscReal, PetscInt *, PetscReal *, PetscBool *); 1142 PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt, TS, PetscReal, Vec, PetscBool *); 1143 PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt, PetscViewer); 1144 PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt, PetscViewer); 1145 PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(TSAdapt, PetscOptionItems); 1146 PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 1147 PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt *); 1148 PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt, PetscBool); 1149 PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt, PetscBool); 1150 PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt, PetscReal, PetscReal); 1151 PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt, PetscReal *, PetscReal *); 1152 PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt, PetscReal); 1153 PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt, PetscReal *); 1154 PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt, PetscReal, PetscReal); 1155 PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt, PetscReal *, PetscReal *); 1156 PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt, PetscReal); 1157 PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt, PetscReal *); 1158 PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt, PetscReal, PetscReal); 1159 PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt, PetscReal *, PetscReal *); 1160 PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt, PetscErrorCode (*)(TSAdapt, TS, PetscReal, Vec, PetscBool *)); 1161 PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt, PetscInt, PetscReal[], PetscBool); 1162 PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt, TSTrajectory, PetscBool); 1163 PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt, PetscInt, PetscReal *, PetscReal *); 1164 PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt, PetscInt); 1165 PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt, const char *); 1166 PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt, PetscReal, PetscReal, PetscReal); 1167 1168 /*S 1169 TSGLLEAdapt - Abstract object that manages time-step adaptivity for `TSGLLE` 1170 1171 Level: beginner 1172 1173 Developer Note: 1174 This functionality should be replaced by the `TSAdapt`. 1175 1176 .seealso: [](ch_ts), `TS`, `TSGLLE`, `TSGLLEAdaptCreate()`, `TSGLLEAdaptType` 1177 S*/ 1178 typedef struct _p_TSGLLEAdapt *TSGLLEAdapt; 1179 1180 /*J 1181 TSGLLEAdaptType - String with the name of `TSGLLEAdapt` scheme 1182 1183 Level: beginner 1184 1185 Developer Note: 1186 This functionality should be replaced by the `TSAdaptType`. 1187 1188 .seealso: [](ch_ts), `TSGLLEAdaptSetType()`, `TS` 1189 J*/ 1190 typedef const char *TSGLLEAdaptType; 1191 #define TSGLLEADAPT_NONE "none" 1192 #define TSGLLEADAPT_SIZE "size" 1193 #define TSGLLEADAPT_BOTH "both" 1194 1195 PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[], PetscErrorCode (*)(TSGLLEAdapt)); 1196 PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void); 1197 PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void); 1198 PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm, TSGLLEAdapt *); 1199 PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt, TSGLLEAdaptType); 1200 PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt, const char[]); 1201 PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt, PetscInt, const PetscInt[], const PetscReal[], const PetscReal[], PetscInt, PetscReal, PetscReal, PetscInt *, PetscReal *, PetscBool *); 1202 PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt, PetscViewer); 1203 PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(TSGLLEAdapt, PetscOptionItems); 1204 PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt *); 1205 1206 /*J 1207 TSGLLEAcceptType - String with the name of `TSGLLEAccept` scheme 1208 1209 Level: beginner 1210 1211 .seealso: [](ch_ts), `TSGLLESetAcceptType()`, `TS`, `TSGLLEAccept` 1212 J*/ 1213 typedef const char *TSGLLEAcceptType; 1214 #define TSGLLEACCEPT_ALWAYS "always" 1215 1216 /*S 1217 TSGLLEAcceptFn - A prototype of a `TS` accept function that would be passed to `TSGLLEAcceptRegister()` 1218 1219 Calling Sequence: 1220 + ts - timestep context 1221 . nt - time to end of solution time 1222 . h - the proposed step-size 1223 . enorm - unknown 1224 - accept - output, if the proposal is accepted 1225 1226 Level: beginner 1227 1228 Note: 1229 The deprecated `TSGLLEAcceptFunction` still works as a replacement for `TSGLLEAcceptFn` * 1230 1231 .seealso: [](ch_ts), `TS`, `TSSetRHSFunction()`, `DMTSSetRHSFunction()`, `TSIFunctionFn`, 1232 `TSIJacobianFn`, `TSRHSJacobianFn`, `TSGLLEAcceptRegister()` 1233 S*/ 1234 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode(TSGLLEAcceptFn)(TS ts, PetscReal nt, PetscReal h, const PetscReal enorm[], PetscBool *accept); 1235 1236 PETSC_EXTERN_TYPEDEF typedef TSGLLEAcceptFn *TSGLLEAcceptFunction; 1237 1238 PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[], TSGLLEAcceptFn *); 1239 1240 /*J 1241 TSGLLEType - string with the name of a General Linear `TSGLLE` type 1242 1243 Level: beginner 1244 1245 .seealso: [](ch_ts), `TS`, `TSGLLE`, `TSGLLESetType()`, `TSGLLERegister()`, `TSGLLEAccept` 1246 J*/ 1247 typedef const char *TSGLLEType; 1248 #define TSGLLE_IRKS "irks" 1249 1250 PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[], PetscErrorCode (*)(TS)); 1251 PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void); 1252 PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void); 1253 PETSC_EXTERN PetscErrorCode TSGLLESetType(TS, TSGLLEType); 1254 PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS, TSGLLEAdapt *); 1255 PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS, TSGLLEAcceptType); 1256 1257 /*J 1258 TSEIMEXType - String with the name of an Extrapolated IMEX `TSEIMEX` type 1259 1260 Level: beginner 1261 1262 .seealso: [](ch_ts), `TSEIMEXSetType()`, `TS`, `TSEIMEX`, `TSEIMEXRegister()` 1263 J*/ 1264 #define TSEIMEXType char * 1265 1266 PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS, PetscInt); 1267 PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS, PetscInt, PetscInt); 1268 PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS, PetscBool); 1269 1270 /*J 1271 TSRKType - String with the name of a Runge-Kutta `TSRK` type 1272 1273 Level: beginner 1274 1275 .seealso: [](ch_ts), `TS`, `TSRKSetType()`, `TS`, `TSRK`, `TSRKRegister()` 1276 J*/ 1277 typedef const char *TSRKType; 1278 #define TSRK1FE "1fe" 1279 #define TSRK2A "2a" 1280 #define TSRK2B "2b" 1281 #define TSRK3 "3" 1282 #define TSRK3BS "3bs" 1283 #define TSRK4 "4" 1284 #define TSRK5F "5f" 1285 #define TSRK5DP "5dp" 1286 #define TSRK5BS "5bs" 1287 #define TSRK6VR "6vr" 1288 #define TSRK7VR "7vr" 1289 #define TSRK8VR "8vr" 1290 1291 PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS, PetscInt *); 1292 PETSC_EXTERN PetscErrorCode TSRKGetType(TS, TSRKType *); 1293 PETSC_EXTERN PetscErrorCode TSRKSetType(TS, TSRKType); 1294 PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS, PetscInt *, const PetscReal **, const PetscReal **, const PetscReal **, const PetscReal **, PetscInt *, const PetscReal **, PetscBool *); 1295 PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS, PetscBool); 1296 PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS, PetscBool *); 1297 PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]); 1298 PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 1299 PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 1300 PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 1301 1302 /*J 1303 TSMPRKType - String with the name of a partitioned Runge-Kutta `TSMPRK` type 1304 1305 Level: beginner 1306 1307 .seealso: [](ch_ts), `TSMPRKSetType()`, `TS`, `TSMPRK`, `TSMPRKRegister()` 1308 J*/ 1309 typedef const char *TSMPRKType; 1310 #define TSMPRK2A22 "2a22" 1311 #define TSMPRK2A23 "2a23" 1312 #define TSMPRK2A32 "2a32" 1313 #define TSMPRK2A33 "2a33" 1314 #define TSMPRKP2 "p2" 1315 #define TSMPRKP3 "p3" 1316 1317 PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS, TSMPRKType *); 1318 PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS, TSMPRKType); 1319 PETSC_EXTERN PetscErrorCode TSMPRKRegister(TSMPRKType, PetscInt, PetscInt, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscInt[], const PetscReal[], const PetscReal[], const PetscReal[], const PetscInt[], const PetscReal[], const PetscReal[], const PetscReal[]); 1320 PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void); 1321 PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void); 1322 PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void); 1323 1324 /*J 1325 TSIRKType - String with the name of an implicit Runge-Kutta `TSIRK` type 1326 1327 Level: beginner 1328 1329 .seealso: [](ch_ts), `TSIRKSetType()`, `TS`, `TSIRK`, `TSIRKRegister()` 1330 J*/ 1331 typedef const char *TSIRKType; 1332 #define TSIRKGAUSS "gauss" 1333 1334 PETSC_EXTERN PetscErrorCode TSIRKGetType(TS, TSIRKType *); 1335 PETSC_EXTERN PetscErrorCode TSIRKSetType(TS, TSIRKType); 1336 PETSC_EXTERN PetscErrorCode TSIRKGetNumStages(TS, PetscInt *); 1337 PETSC_EXTERN PetscErrorCode TSIRKSetNumStages(TS, PetscInt); 1338 PETSC_EXTERN PetscErrorCode TSIRKRegister(const char[], PetscErrorCode (*function)(TS)); 1339 PETSC_EXTERN PetscErrorCode TSIRKTableauCreate(TS, PetscInt, const PetscReal *, const PetscReal *, const PetscReal *, const PetscReal *, const PetscScalar *, const PetscScalar *, const PetscScalar *); 1340 PETSC_EXTERN PetscErrorCode TSIRKInitializePackage(void); 1341 PETSC_EXTERN PetscErrorCode TSIRKFinalizePackage(void); 1342 PETSC_EXTERN PetscErrorCode TSIRKRegisterDestroy(void); 1343 1344 /*J 1345 TSGLEEType - String with the name of a General Linear with Error Estimation `TSGLEE` type 1346 1347 Level: beginner 1348 1349 .seealso: [](ch_ts), `TSGLEESetType()`, `TS`, `TSGLEE`, `TSGLEERegister()` 1350 J*/ 1351 typedef const char *TSGLEEType; 1352 #define TSGLEEi1 "BE1" 1353 #define TSGLEE23 "23" 1354 #define TSGLEE24 "24" 1355 #define TSGLEE25I "25i" 1356 #define TSGLEE35 "35" 1357 #define TSGLEEEXRK2A "exrk2a" 1358 #define TSGLEERK32G1 "rk32g1" 1359 #define TSGLEERK285EX "rk285ex" 1360 1361 /*J 1362 TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation `TSGLEE` type 1363 1364 Level: beginner 1365 1366 .seealso: [](ch_ts), `TSGLEESetMode()`, `TS`, `TSGLEE`, `TSGLEERegister()` 1367 J*/ 1368 PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS, TSGLEEType *); 1369 PETSC_EXTERN PetscErrorCode TSGLEESetType(TS, TSGLEEType); 1370 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[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]); 1371 PETSC_EXTERN PetscErrorCode TSGLEERegisterAll(void); 1372 PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void); 1373 PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void); 1374 PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void); 1375 1376 /*J 1377 TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX `TSARKIMEX` type 1378 1379 Level: beginner 1380 1381 .seealso: [](ch_ts), `TSARKIMEXSetType()`, `TS`, `TSARKIMEX`, `TSARKIMEXRegister()` 1382 J*/ 1383 typedef const char *TSARKIMEXType; 1384 #define TSARKIMEX1BEE "1bee" 1385 #define TSARKIMEXA2 "a2" 1386 #define TSARKIMEXL2 "l2" 1387 #define TSARKIMEXARS122 "ars122" 1388 #define TSARKIMEX2C "2c" 1389 #define TSARKIMEX2D "2d" 1390 #define TSARKIMEX2E "2e" 1391 #define TSARKIMEXPRSSP2 "prssp2" 1392 #define TSARKIMEX3 "3" 1393 #define TSARKIMEXBPR3 "bpr3" 1394 #define TSARKIMEXARS443 "ars443" 1395 #define TSARKIMEX4 "4" 1396 #define TSARKIMEX5 "5" 1397 1398 PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS, TSARKIMEXType *); 1399 PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS, TSARKIMEXType); 1400 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS, PetscBool); 1401 PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS, PetscBool *); 1402 PETSC_EXTERN PetscErrorCode TSARKIMEXSetFastSlowSplit(TS, PetscBool); 1403 PETSC_EXTERN PetscErrorCode TSARKIMEXGetFastSlowSplit(TS, PetscBool *); 1404 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[]); 1405 PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 1406 PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 1407 PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 1408 1409 /*J 1410 TSDIRKType - String with the name of a Diagonally Implicit Runge-Kutta `TSDIRK` type 1411 1412 Level: beginner 1413 1414 .seealso: [](ch_ts), `TSDIRKSetType()`, `TS`, `TSDIRK`, `TSDIRKRegister()` 1415 J*/ 1416 typedef const char *TSDIRKType; 1417 #define TSDIRKS212 "s212" 1418 #define TSDIRKES122SAL "es122sal" 1419 #define TSDIRKES213SAL "es213sal" 1420 #define TSDIRKES324SAL "es324sal" 1421 #define TSDIRKES325SAL "es325sal" 1422 #define TSDIRK657A "657a" 1423 #define TSDIRKES648SA "es648sa" 1424 #define TSDIRK658A "658a" 1425 #define TSDIRKS659A "s659a" 1426 #define TSDIRK7510SAL "7510sal" 1427 #define TSDIRKES7510SA "es7510sa" 1428 #define TSDIRK759A "759a" 1429 #define TSDIRKS7511SAL "s7511sal" 1430 #define TSDIRK8614A "8614a" 1431 #define TSDIRK8616SAL "8616sal" 1432 #define TSDIRKES8516SAL "es8516sal" 1433 1434 PETSC_EXTERN PetscErrorCode TSDIRKGetType(TS, TSDIRKType *); 1435 PETSC_EXTERN PetscErrorCode TSDIRKSetType(TS, TSDIRKType); 1436 PETSC_EXTERN PetscErrorCode TSDIRKRegister(TSDIRKType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]); 1437 1438 /*J 1439 TSRosWType - String with the name of a Rosenbrock-W `TSROSW` type 1440 1441 Level: beginner 1442 1443 .seealso: [](ch_ts), `TSRosWSetType()`, `TS`, `TSROSW`, `TSRosWRegister()` 1444 J*/ 1445 typedef const char *TSRosWType; 1446 #define TSROSW2M "2m" 1447 #define TSROSW2P "2p" 1448 #define TSROSWRA3PW "ra3pw" 1449 #define TSROSWRA34PW2 "ra34pw2" 1450 #define TSROSWR34PRW "r34prw" 1451 #define TSROSWR3PRL2 "r3prl2" 1452 #define TSROSWRODAS3 "rodas3" 1453 #define TSROSWRODASPR "rodaspr" 1454 #define TSROSWRODASPR2 "rodaspr2" 1455 #define TSROSWSANDU3 "sandu3" 1456 #define TSROSWASSP3P3S1C "assp3p3s1c" 1457 #define TSROSWLASSP3P4S2C "lassp3p4s2c" 1458 #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 1459 #define TSROSWARK3 "ark3" 1460 #define TSROSWTHETA1 "theta1" 1461 #define TSROSWTHETA2 "theta2" 1462 #define TSROSWGRK4T "grk4t" 1463 #define TSROSWSHAMP4 "shamp4" 1464 #define TSROSWVELDD4 "veldd4" 1465 #define TSROSW4L "4l" 1466 1467 PETSC_EXTERN PetscErrorCode TSRosWGetType(TS, TSRosWType *); 1468 PETSC_EXTERN PetscErrorCode TSRosWSetType(TS, TSRosWType); 1469 PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS, PetscBool); 1470 PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]); 1471 PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal); 1472 PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 1473 PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 1474 PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 1475 1476 PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS, PetscInt); 1477 PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS, PetscInt *); 1478 1479 /*J 1480 TSBasicSymplecticType - String with the name of a basic symplectic integration `TSBASICSYMPLECTIC` type 1481 1482 Level: beginner 1483 1484 .seealso: [](ch_ts), `TSBasicSymplecticSetType()`, `TS`, `TSBASICSYMPLECTIC`, `TSBasicSymplecticRegister()` 1485 J*/ 1486 typedef const char *TSBasicSymplecticType; 1487 #define TSBASICSYMPLECTICSIEULER "1" 1488 #define TSBASICSYMPLECTICVELVERLET "2" 1489 #define TSBASICSYMPLECTIC3 "3" 1490 #define TSBASICSYMPLECTIC4 "4" 1491 1492 PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS, TSBasicSymplecticType); 1493 PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS, TSBasicSymplecticType *); 1494 PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType, PetscInt, PetscInt, PetscReal[], PetscReal[]); 1495 PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterAll(void); 1496 PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void); 1497 PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void); 1498 PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void); 1499 1500 /*J 1501 TSDISCGRAD - The Discrete Gradient integrator is a timestepper for Hamiltonian systems designed to conserve the first integral (energy), 1502 but also has the property for some systems of monotonicity in a functional. 1503 1504 Level: beginner 1505 1506 .seealso: [](ch_ts), `TS`, TSDiscGradSetFormulation()`, `TSDiscGradGetFormulation()`, `TSDiscGradSetType()`, `TSDiscGradGetType()` 1507 J*/ 1508 typedef enum { 1509 TS_DG_GONZALEZ, 1510 TS_DG_AVERAGE, 1511 TS_DG_NONE 1512 } TSDGType; 1513 PETSC_EXTERN PetscErrorCode TSDiscGradSetFormulation(TS, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), PetscErrorCode (*)(TS, PetscReal, Vec, PetscScalar *, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec, void *), void *); 1514 PETSC_EXTERN PetscErrorCode TSDiscGradGetFormulation(TS, PetscErrorCode (**)(TS, PetscReal, Vec, Mat, void *), PetscErrorCode (**)(TS, PetscReal, Vec, PetscScalar *, void *), PetscErrorCode (**)(TS, PetscReal, Vec, Vec, void *), void *); 1515 PETSC_EXTERN PetscErrorCode TSDiscGradSetType(TS, TSDGType); 1516 PETSC_EXTERN PetscErrorCode TSDiscGradGetType(TS, TSDGType *); 1517 1518 /* 1519 PETSc interface to Sundials 1520 */ 1521 #ifdef PETSC_HAVE_SUNDIALS2 1522 typedef enum { 1523 SUNDIALS_ADAMS = 1, 1524 SUNDIALS_BDF = 2 1525 } TSSundialsLmmType; 1526 PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 1527 typedef enum { 1528 SUNDIALS_MODIFIED_GS = 1, 1529 SUNDIALS_CLASSICAL_GS = 2 1530 } TSSundialsGramSchmidtType; 1531 PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 1532 1533 PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS, TSSundialsLmmType); 1534 PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS, PC *); 1535 PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS, PetscReal, PetscReal); 1536 PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS, PetscReal); 1537 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS, PetscReal); 1538 PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS, PetscInt *, PetscInt *); 1539 PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS, TSSundialsGramSchmidtType); 1540 PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS, PetscInt); 1541 PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS, PetscReal); 1542 PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS, PetscBool); 1543 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS, PetscInt); 1544 PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS, PetscInt); 1545 PETSC_EXTERN PetscErrorCode TSSundialsSetUseDense(TS, PetscBool); 1546 #endif 1547 1548 PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS, PetscReal); 1549 PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS, PetscReal *); 1550 PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS, PetscBool *); 1551 PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS, PetscBool); 1552 1553 PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS, PetscReal); 1554 PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS, PetscReal, PetscReal, PetscReal); 1555 PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS, PetscReal *, PetscReal *, PetscReal *); 1556 1557 PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS, PetscReal); 1558 PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS, PetscReal, PetscReal, PetscReal, PetscReal); 1559 PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS, PetscReal *, PetscReal *, PetscReal *, PetscReal *); 1560 1561 /*S 1562 TSAlpha2PredictorFn - A callback to set the predictor (i.e., the initial guess for the nonlinear solver) in 1563 a second-order generalized-alpha time integrator. 1564 1565 Calling Sequence: 1566 + ts - the `TS` context obtained from `TSCreate()` 1567 . X0 - the previous time step's state vector 1568 . V0 - the previous time step's first derivative of the state vector 1569 . A0 - the previous time step's second derivative of the state vector 1570 . X1 - the vector into which the initial guess for the current time step will be written 1571 - ctx - [optional] user-defined context for the predictor evaluation routine (may be `NULL`) 1572 1573 Level: intermediate 1574 1575 Note: 1576 The deprecated `TSAlpha2Predictor` still works as a replacement for `TSAlpha2PredictorFn` *. 1577 1578 .seealso: [](ch_ts), `TS`, `TSAlpha2SetPredictor()` 1579 S*/ 1580 PETSC_EXTERN_TYPEDEF typedef PetscErrorCode TSAlpha2PredictorFn(TS ts, Vec X0, Vec V0, Vec A0, Vec X1, void *ctx); 1581 1582 PETSC_EXTERN_TYPEDEF typedef TSAlpha2PredictorFn *TSAlpha2Predictor; 1583 1584 PETSC_EXTERN PetscErrorCode TSAlpha2SetPredictor(TS, TSAlpha2PredictorFn *, void *); 1585 1586 PETSC_EXTERN PetscErrorCode TSSetDM(TS, DM); 1587 PETSC_EXTERN PetscErrorCode TSGetDM(TS, DM *); 1588 1589 PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES, Vec, Vec, void *); 1590 PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES, Vec, Mat, Mat, void *); 1591 1592 PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS, PetscBool *); 1593 PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS, PetscBool *); 1594 1595 PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec)); 1596 PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec)); 1597 PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec); 1598 PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec)); 1599 PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec)); 1600 PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec); 1601 PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool); 1602 1603 PETSC_EXTERN PetscErrorCode TSSetMatStructure(TS, MatStructure); 1604