1818ad0c1SBarry Smith /* 2316643e7SJed Brown User interface for the timestepping package. This package 3f64a0f93SLois Curfman McInnes is for use in solving time-dependent PDEs. 4818ad0c1SBarry Smith */ 50a835dfdSSatish Balay #if !defined(__PETSCTS_H) 60a835dfdSSatish Balay #define __PETSCTS_H 72c8e378dSBarry Smith #include <petscsnes.h> 8818ad0c1SBarry Smith 9435da068SBarry Smith /*S 10435da068SBarry Smith TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 11435da068SBarry Smith 12435da068SBarry Smith Level: beginner 13435da068SBarry Smith 14435da068SBarry Smith Concepts: ODE solvers 15435da068SBarry Smith 168f6c3df8SBarry Smith .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy() 17435da068SBarry Smith S*/ 18f09e8eb9SSatish Balay typedef struct _p_TS* TS; 19435da068SBarry Smith 2076bdecfbSBarry Smith /*J 218f6c3df8SBarry Smith TSType - String with the name of a PETSc TS method. 22435da068SBarry Smith 23435da068SBarry Smith Level: beginner 24435da068SBarry Smith 258f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister() 2676bdecfbSBarry Smith J*/ 2719fd82e9SBarry Smith typedef const char* TSType; 289596e0b4SJed Brown #define TSEULER "euler" 299596e0b4SJed Brown #define TSBEULER "beuler" 309596e0b4SJed Brown #define TSPSEUDO "pseudo" 314d91e141SJed Brown #define TSCN "cn" 329596e0b4SJed Brown #define TSSUNDIALS "sundials" 334d91e141SJed Brown #define TSRK "rk" 349596e0b4SJed Brown #define TSPYTHON "python" 359596e0b4SJed Brown #define TSTHETA "theta" 3688df8a41SLisandro Dalcin #define TSALPHA "alpha" 379596e0b4SJed Brown #define TSGL "gl" 38ef7bb5aaSJed Brown #define TSSSP "ssp" 398a381b04SJed Brown #define TSARKIMEX "arkimex" 40e27a552bSJed Brown #define TSROSW "rosw" 417d5697caSHong Zhang #define TSEIMEX "eimex" 42abadfa0fSMatthew G. Knepley #define TSMIMEX "mimex" 43435da068SBarry Smith /*E 44435da068SBarry Smith TSProblemType - Determines the type of problem this TS object is to be used to solve 45435da068SBarry Smith 46435da068SBarry Smith Level: beginner 47435da068SBarry Smith 48435da068SBarry Smith .seealso: TSCreate() 49435da068SBarry Smith E*/ 5019bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 51818ad0c1SBarry Smith 52b93fea0eSJed Brown /*E 53e817cc15SEmil Constantinescu TSEquationType - type of TS problem that is solved 54e817cc15SEmil Constantinescu 55e817cc15SEmil Constantinescu Level: beginner 56e817cc15SEmil Constantinescu 57af0996ceSBarry Smith Developer Notes: this must match petsc/finclude/petscts.h 58e817cc15SEmil Constantinescu 59e817cc15SEmil Constantinescu Supported types are: 60e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED (default) 61e817cc15SEmil Constantinescu TS_EQ_EXPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0 62e817cc15SEmil Constantinescu TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0 63e817cc15SEmil Constantinescu 64e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType() 65e817cc15SEmil Constantinescu E*/ 66e817cc15SEmil Constantinescu typedef enum { 67e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED = -1, 68e817cc15SEmil Constantinescu TS_EQ_EXPLICIT = 0, 69e817cc15SEmil Constantinescu TS_EQ_ODE_EXPLICIT = 1, 70e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 71e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 72e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 73e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 74e817cc15SEmil Constantinescu TS_EQ_IMPLICIT = 1000, 75e817cc15SEmil Constantinescu TS_EQ_ODE_IMPLICIT = 1001, 76e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 77e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 78e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 7919436ca2SJed Brown TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 80e817cc15SEmil Constantinescu } TSEquationType; 81e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes; 82e817cc15SEmil Constantinescu 83e817cc15SEmil Constantinescu /*E 84b93fea0eSJed Brown TSConvergedReason - reason a TS method has converged or not 85b93fea0eSJed Brown 86b93fea0eSJed Brown Level: beginner 87b93fea0eSJed Brown 88af0996ceSBarry Smith Developer Notes: this must match petsc/finclude/petscts.h 89b93fea0eSJed Brown 90b93fea0eSJed Brown Each reason has its own manual page. 91b93fea0eSJed Brown 92b93fea0eSJed Brown .seealso: TSGetConvergedReason() 93b93fea0eSJed Brown E*/ 94193ac0bcSJed Brown typedef enum { 95193ac0bcSJed Brown TS_CONVERGED_ITERATING = 0, 96193ac0bcSJed Brown TS_CONVERGED_TIME = 1, 97193ac0bcSJed Brown TS_CONVERGED_ITS = 2, 98d6ad946cSShri Abhyankar TS_CONVERGED_USER = 3, 992b7db910SShri Abhyankar TS_CONVERGED_EVENT = 4, 100193ac0bcSJed Brown TS_DIVERGED_NONLINEAR_SOLVE = -1, 101193ac0bcSJed Brown TS_DIVERGED_STEP_REJECTED = -2 102193ac0bcSJed Brown } TSConvergedReason; 103014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons; 1041957e957SBarry Smith 105b93fea0eSJed Brown /*MC 106b93fea0eSJed Brown TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 107b93fea0eSJed Brown 108b93fea0eSJed Brown Level: beginner 109b93fea0eSJed Brown 110552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 111b93fea0eSJed Brown M*/ 112b93fea0eSJed Brown 113b93fea0eSJed Brown /*MC 114b93fea0eSJed Brown TS_CONVERGED_TIME - the final time was reached 115b93fea0eSJed Brown 116b93fea0eSJed Brown Level: beginner 117b93fea0eSJed Brown 118552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration(), TSGetSolveTime() 119b93fea0eSJed Brown M*/ 120b93fea0eSJed Brown 121b93fea0eSJed Brown /*MC 1221957e957SBarry Smith TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 123b93fea0eSJed Brown 124b93fea0eSJed Brown Level: beginner 125b93fea0eSJed Brown 126552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetDuration() 127b93fea0eSJed Brown M*/ 1281957e957SBarry Smith 129d6ad946cSShri Abhyankar /*MC 130d6ad946cSShri Abhyankar TS_CONVERGED_USER - user requested termination 131d6ad946cSShri Abhyankar 132d6ad946cSShri Abhyankar Level: beginner 133d6ad946cSShri Abhyankar 134d6ad946cSShri Abhyankar .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration() 135b93fea0eSJed Brown M*/ 136b93fea0eSJed Brown 137b93fea0eSJed Brown /*MC 138d76fc68cSShri Abhyankar TS_CONVERGED_EVENT - user requested termination on event detection 139d76fc68cSShri Abhyankar 140d76fc68cSShri Abhyankar Level: beginner 141d76fc68cSShri Abhyankar 142d76fc68cSShri Abhyankar .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TSSetDuration() 143d76fc68cSShri Abhyankar M*/ 144d76fc68cSShri Abhyankar 145d76fc68cSShri Abhyankar /*MC 146b93fea0eSJed Brown TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 147b93fea0eSJed Brown 148b93fea0eSJed Brown Level: beginner 149b93fea0eSJed Brown 1501957e957SBarry Smith Notes: See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures. 1511957e957SBarry Smith 1521957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures() 153b93fea0eSJed Brown M*/ 154b93fea0eSJed Brown 155b93fea0eSJed Brown /*MC 156b93fea0eSJed Brown TS_DIVERGED_STEP_REJECTED - too many steps were rejected 157b93fea0eSJed Brown 158b93fea0eSJed Brown Level: beginner 159b93fea0eSJed Brown 1601957e957SBarry Smith Notes: See TSSetMaxStepRejections() for how to allow more step rejections. 1611957e957SBarry Smith 1621957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections() 163b93fea0eSJed Brown M*/ 164b93fea0eSJed Brown 165d6ad946cSShri Abhyankar /*E 166d6ad946cSShri Abhyankar TSExactFinalTimeOption - option for handling of final time step 167d6ad946cSShri Abhyankar 168d6ad946cSShri Abhyankar Level: beginner 169d6ad946cSShri Abhyankar 170af0996ceSBarry Smith Developer Notes: this must match petsc/finclude/petscts.h 171d6ad946cSShri Abhyankar 172d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 173d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 174d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 1754ceb6c04SBarry Smith .seealso: TSGetConvergedReason(), TSSetExactFinalTime() 1764ceb6c04SBarry Smith 177d6ad946cSShri Abhyankar E*/ 178d6ad946cSShri Abhyankar typedef enum {TS_EXACTFINALTIME_STEPOVER=0,TS_EXACTFINALTIME_INTERPOLATE=1,TS_EXACTFINALTIME_MATCHSTEP=2} TSExactFinalTimeOption; 179d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 180d6ad946cSShri Abhyankar 181d6ad946cSShri Abhyankar 182000e7ae3SMatthew Knepley /* Logging support */ 183014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID; 184d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID; 185000e7ae3SMatthew Knepley 186607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 1878ba1e511SMatthew Knepley 188014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 189baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*); 190014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 191818ad0c1SBarry Smith 192014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 193014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 194014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 195014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 196014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 197818ad0c1SBarry Smith 1989110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*); 1999110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**)); 2009110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 2019110b2e7SHong Zhang 2029110b2e7SHong Zhang 203014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 204014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 205014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 206014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 207014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS); 208014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS); 209818ad0c1SBarry Smith 210014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 211014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 212818ad0c1SBarry Smith 213bc952696SBarry Smith /*S 214bc952696SBarry Smith TSTrajectory - Abstract PETSc object that storing the trajectory (solution of ODE/ADE at each time step and stage) 215bc952696SBarry Smith 216bc952696SBarry Smith Level: advanced 217bc952696SBarry Smith 218bc952696SBarry Smith Concepts: ODE solvers, adjoint 219bc952696SBarry Smith 220bc952696SBarry Smith .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy() 221bc952696SBarry Smith S*/ 222bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory; 223bc952696SBarry Smith 224bc952696SBarry Smith /*J 225bc952696SBarry Smith TSTrajectoryType - String with the name of a PETSc TS trajectory storage method 226bc952696SBarry Smith 227bc952696SBarry Smith Level: intermediate 228bc952696SBarry Smith 229bc952696SBarry Smith .seealso: TSSetType(), TS, TSRegister(), TSTrajectoryCreate(), TSTrajectorySetType() 230bc952696SBarry Smith J*/ 231bc952696SBarry Smith typedef const char* TSTrajectoryType; 232bc952696SBarry Smith #define TSTRAJECTORYBASIC "basic" 2331c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE "singlefile" 2349a53571cSHong Zhang #define TSTRAJECTORYMEMORY "memory" 235bc952696SBarry Smith 236bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList; 237bc952696SBarry Smith PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 238bc952696SBarry Smith PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 239bc952696SBarry Smith 240bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 241bc952696SBarry Smith 242bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*); 243bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*); 244972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,const TSTrajectoryType); 245bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec); 246c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*); 247972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS); 248bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 249*68bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS); 250bc952696SBarry Smith 251dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*); 252dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**); 253dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostIntegrand(TS,PetscInt,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),PetscErrorCode (*)(TS,PetscReal,Vec,Vec*,void*),void*); 254dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*); 255d4aa0a58SBarry Smith 2565bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 2572c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 25873b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt); 259d4aa0a58SBarry Smith 2605bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat); 26173b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 262f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 263d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 264d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*); 265d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeCostIntegrand(TS,PetscReal,Vec,Vec); 266c235aa8dSHong Zhang 267014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 268014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 26949354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption); 270818ad0c1SBarry Smith 271014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*); 27283a4ac43SBarry Smith 27383a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx* TSMonitorDrawCtx; 27483a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *); 27583a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*); 27683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*); 2772d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*); 27883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*); 27983a4ac43SBarry Smith 280110eb670SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void *); 2819110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*); 2829110b2e7SHong Zhang 283014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionBinary(TS,PetscInt,PetscReal,Vec,void*); 284014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 285014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 286fb1732b5SBarry Smith 287014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS); 288014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 289cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec); 290e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*); 291e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType); 292014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 293d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason); 294487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*); 2955ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 2965ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 297cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 298cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 299cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 300cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 301cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 30224655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS); 3032c18e0fdSBarry Smith PETSC_EXTERN PetscErrorCode TSGetTotalSteps(TS,PetscInt*); 304d2daff3dSHong Zhang 305ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**); 306818ad0c1SBarry Smith 307014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 308014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 309014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 310014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 311014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 312014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 313e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*); 314818ad0c1SBarry Smith 315638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 316d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*); 317014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 318014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 319014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 320014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 321e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool); 322818ad0c1SBarry Smith 323ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 324ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 325f8b49ee9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,PetscErrorCode (*)(TS,PetscReal,Vec,void*),void*); 326ef20d060SBarry Smith 327638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 328d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 329014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 330014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 331014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 332014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 333316643e7SJed Brown 334014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 335d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*); 336014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 337d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 3381c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 3399b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec); 340847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 341e34be4c2SBarry Smith 342014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 343b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 3449be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*)); 345014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 346014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS); 347b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 3489be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*); 349014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS); 350014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRetainStages(TS,PetscBool); 351014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 352014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 353c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 354a4868fbcSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*); 355a4868fbcSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*); 356a4868fbcSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*); 357014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 358014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 359000e7ae3SMatthew Knepley 360014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 3618d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*); 362014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 363014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 364d8345c25SBarry Smith 365014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 3668d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *); 367014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 368014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 369014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 37021c89e3eSBarry Smith 371014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 3721d6018f0SLisandro Dalcin 373014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 374d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat); 375014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 376d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool); 377f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*); 378818ad0c1SBarry Smith 379014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 380d6ebe24aSShri Abhyankar 38124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 38224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 38324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 38424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 38524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 38624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 38724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 38824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 389ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 390ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 391f8b49ee9SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,PetscErrorCode (*)(TS,PetscReal,Vec,void*),void*); 392f8b49ee9SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,PetscErrorCode (**)(TS,PetscReal,Vec,void*),void**); 393924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*); 394924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal); 395ad917190SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, const PetscReal[], PetscInt, PetscScalar *, void *), void **); 3969b7cd975SBarry Smith 397d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*); 398d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*); 399d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*); 4006c6b9e74SPeter Brune 4016c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 4026c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 4036c6b9e74SPeter Brune 4046c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 405d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*); 4066c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 407d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*); 4086c6b9e74SPeter Brune 4096c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 410d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *); 4116c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 412d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *); 4136c6b9e74SPeter Brune 414b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM, Vec *, Vec *, PetscReal *); 4156dbbd306SMatthew G. Knepley 416be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 417d1212d36SBarry Smith typedef struct { 418d1212d36SBarry Smith Vec ray; 419d1212d36SBarry Smith VecScatter scatter; 420d1212d36SBarry Smith PetscViewer viewer; 42151b4a12fSMatthew G. Knepley TSMonitorLGCtx lgctx; 422d1212d36SBarry Smith } TSMonitorDMDARayCtx; 423d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 424d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 42551b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 426d1212d36SBarry Smith 427d1212d36SBarry Smith 428bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 429140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList; 43019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 43119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 432bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 43330de9b25SBarry Smith 434014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 435deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 436014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 437818ad0c1SBarry Smith 438014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 43955849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 440685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 44155849f57SBarry Smith 44255849f57SBarry Smith 44355849f57SBarry Smith #define TS_FILE_CLASSID 1211225 44421c89e3eSBarry Smith 445014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 446014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 44721c89e3eSBarry Smith 448a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 449a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 4504f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 4514f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 45231152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 453b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **); 454e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *); 455a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 456a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*); 4577684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 4587684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *); 4594f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 460201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 461201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 462ef20d060SBarry Smith 463b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx* TSMonitorEnvelopeCtx; 464b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*); 465b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*); 466b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*); 467b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*); 468b3d3934dSBarry Smith 4698189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 4708189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 4718189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 4728189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 4733914022bSBarry Smith 474031fbad4SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetEventMonitor(TS,PetscInt,PetscInt*,PetscBool*,PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar*,void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*); 475e3005195SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal*); 47676bdecfbSBarry Smith /*J 477815f1ad5SJed Brown TSSSPType - string with the name of TSSSP scheme. 478815f1ad5SJed Brown 479815f1ad5SJed Brown Level: beginner 480815f1ad5SJed Brown 481815f1ad5SJed Brown .seealso: TSSSPSetType(), TS 48276bdecfbSBarry Smith J*/ 48319fd82e9SBarry Smith typedef const char* TSSSPType; 484815f1ad5SJed Brown #define TSSSPRKS2 "rks2" 485815f1ad5SJed Brown #define TSSSPRKS3 "rks3" 486815f1ad5SJed Brown #define TSSSPRK104 "rk104" 487815f1ad5SJed Brown 48819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 48919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 490014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 491014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 492787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 493787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 494815f1ad5SJed Brown 495ed657a08SJed Brown /*S 49684df9cb4SJed Brown TSAdapt - Abstract object that manages time-step adaptivity 49784df9cb4SJed Brown 49884df9cb4SJed Brown Level: beginner 49984df9cb4SJed Brown 50084df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType 50184df9cb4SJed Brown S*/ 50284df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt; 50384df9cb4SJed Brown 50484df9cb4SJed Brown /*E 5058f6c3df8SBarry Smith TSAdaptType - String with the name of TSAdapt scheme. 50684df9cb4SJed Brown 50784df9cb4SJed Brown Level: beginner 50884df9cb4SJed Brown 50984df9cb4SJed Brown .seealso: TSAdaptSetType(), TS 51084df9cb4SJed Brown E*/ 511f8963224SJed Brown typedef const char *TSAdaptType; 51284df9cb4SJed Brown #define TSADAPTBASIC "basic" 513b0f836d7SJed Brown #define TSADAPTNONE "none" 5148d59e960SJed Brown #define TSADAPTCFL "cfl" 51584df9cb4SJed Brown 516552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 517bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 518607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 519014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 52119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 522014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 523014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 524014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 525014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 526014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 527014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscBool*); 528014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 529ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 5308c34d3f5SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptions*,TSAdapt); 531099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 532014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 533014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 534014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 5350873808bSJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscBool*)); 53684df9cb4SJed Brown 53784df9cb4SJed Brown /*S 538ed657a08SJed Brown TSGLAdapt - Abstract object that manages time-step adaptivity 539ed657a08SJed Brown 540ed657a08SJed Brown Level: beginner 541ed657a08SJed Brown 54284df9cb4SJed Brown Developer Notes: 54384df9cb4SJed Brown This functionality should be replaced by the TSAdapt. 54484df9cb4SJed Brown 545ed657a08SJed Brown .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 546ed657a08SJed Brown S*/ 547ed657a08SJed Brown typedef struct _p_TSGLAdapt *TSGLAdapt; 548ed657a08SJed Brown 54976bdecfbSBarry Smith /*J 5508f6c3df8SBarry Smith TSGLAdaptType - String with the name of TSGLAdapt scheme 551ed657a08SJed Brown 552ed657a08SJed Brown Level: beginner 553ed657a08SJed Brown 554ed657a08SJed Brown .seealso: TSGLAdaptSetType(), TS 55576bdecfbSBarry Smith J*/ 556f8963224SJed Brown typedef const char *TSGLAdaptType; 557ed657a08SJed Brown #define TSGLADAPT_NONE "none" 558ed657a08SJed Brown #define TSGLADAPT_SIZE "size" 559ed657a08SJed Brown #define TSGLADAPT_BOTH "both" 560ed657a08SJed Brown 561bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptRegister(const char[],PetscErrorCode (*)(TSGLAdapt)); 562607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptInitializePackage(void); 563014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptFinalizePackage(void); 564014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 56519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptSetType(TSGLAdapt,TSGLAdaptType); 566014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 567014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 568014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer); 5698c34d3f5SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAdaptSetFromOptions(PetscOptions*,TSGLAdapt); 570014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*); 571ed657a08SJed Brown 57276bdecfbSBarry Smith /*J 5738f6c3df8SBarry Smith TSGLAcceptType - String with the name of TSGLAccept scheme 574ed657a08SJed Brown 575ed657a08SJed Brown Level: beginner 576ed657a08SJed Brown 577ed657a08SJed Brown .seealso: TSGLSetAcceptType(), TS 57876bdecfbSBarry Smith J*/ 579f8963224SJed Brown typedef const char *TSGLAcceptType; 580ed657a08SJed Brown #define TSGLACCEPT_ALWAYS "always" 581ed657a08SJed Brown 582638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 583bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSGLAcceptRegister(const char[],TSGLAcceptFunction); 584ed657a08SJed Brown 58576bdecfbSBarry Smith /*J 58618b56cb9SJed Brown TSGLType - family of time integration method within the General Linear class 58718b56cb9SJed Brown 58818b56cb9SJed Brown Level: beginner 58918b56cb9SJed Brown 59018b56cb9SJed Brown .seealso: TSGLSetType(), TSGLRegister() 59176bdecfbSBarry Smith J*/ 59219fd82e9SBarry Smith typedef const char* TSGLType; 593ed657a08SJed Brown #define TSGL_IRKS "irks" 59418b56cb9SJed Brown 595bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSGLRegister(const char[],PetscErrorCode(*)(TS)); 596607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSGLInitializePackage(void); 597014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLFinalizePackage(void); 59819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGLSetType(TS,TSGLType); 599014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*); 60019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGLSetAcceptType(TS,TSGLAcceptType); 60118b56cb9SJed Brown 602020d8f30SJed Brown /*J 6037d5697caSHong Zhang TSEIMEXType - String with the name of an Extrapolated IMEX method. 6047d5697caSHong Zhang 6057d5697caSHong Zhang Level: beginner 6067d5697caSHong Zhang 6077d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister() 6087d5697caSHong Zhang J*/ 6097d5697caSHong Zhang #define TSEIMEXType char* 6107d5697caSHong Zhang 6117d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt); 6127d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt); 6137d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool); 6147d5697caSHong Zhang 6157d5697caSHong Zhang /*J 616f68a32c8SEmil Constantinescu TSRKType - String with the name of a Runge-Kutta method. 617f68a32c8SEmil Constantinescu 618f68a32c8SEmil Constantinescu Level: beginner 619f68a32c8SEmil Constantinescu 620f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister() 621f68a32c8SEmil Constantinescu J*/ 622f68a32c8SEmil Constantinescu typedef const char* TSRKType; 623f68a32c8SEmil Constantinescu #define TSRK1FE "1fe" 624fdefd5e5SDebojyoti Ghosh #define TSRK2A "2a" 625f68a32c8SEmil Constantinescu #define TSRK3 "3" 626fdefd5e5SDebojyoti Ghosh #define TSRK3BS "3bs" 627f68a32c8SEmil Constantinescu #define TSRK4 "4" 628fdefd5e5SDebojyoti Ghosh #define TSRK5F "5f" 629fdefd5e5SDebojyoti Ghosh #define TSRK5DP "5dp" 630f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*); 631f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType); 632f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool); 633f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 634f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 635f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 636f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 637f68a32c8SEmil Constantinescu 638f68a32c8SEmil Constantinescu /*J 639020d8f30SJed Brown TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 640020d8f30SJed Brown 641020d8f30SJed Brown Level: beginner 642020d8f30SJed Brown 643020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 644020d8f30SJed Brown J*/ 64519fd82e9SBarry Smith typedef const char* TSARKIMEXType; 646e817cc15SEmil Constantinescu #define TSARKIMEX1BEE "1bee" 6471f80e275SEmil Constantinescu #define TSARKIMEXA2 "a2" 6481f80e275SEmil Constantinescu #define TSARKIMEXL2 "l2" 6491f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122" 6501f80e275SEmil Constantinescu #define TSARKIMEX2C "2c" 6518a381b04SJed Brown #define TSARKIMEX2D "2d" 652a3a57f36SJed Brown #define TSARKIMEX2E "2e" 6536cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2" 6548a381b04SJed Brown #define TSARKIMEX3 "3" 6556cf0794eSJed Brown #define TSARKIMEXBPR3 "bpr3" 6566cf0794eSJed Brown #define TSARKIMEXARS443 "ars443" 6578a381b04SJed Brown #define TSARKIMEX4 "4" 6588a381b04SJed Brown #define TSARKIMEX5 "5" 65919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 66019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 661014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 66219fd82e9SBarry Smith 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[]); 663014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 664607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 665014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 6668a381b04SJed Brown 667020d8f30SJed Brown /*J 668020d8f30SJed Brown TSRosWType - String with the name of a Rosenbrock-W method. 669020d8f30SJed Brown 670020d8f30SJed Brown Level: beginner 671020d8f30SJed Brown 672020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 673020d8f30SJed Brown J*/ 67419fd82e9SBarry Smith typedef const char* TSRosWType; 67561692a83SJed Brown #define TSROSW2M "2m" 67661692a83SJed Brown #define TSROSW2P "2p" 677fe7e6d57SJed Brown #define TSROSWRA3PW "ra3pw" 678fe7e6d57SJed Brown #define TSROSWRA34PW2 "ra34pw2" 679ef3c5b88SJed Brown #define TSROSWRODAS3 "rodas3" 680ef3c5b88SJed Brown #define TSROSWSANDU3 "sandu3" 681961f28d0SJed Brown #define TSROSWASSP3P3S1C "assp3p3s1c" 682961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c" 68343b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 684753f8adbSEmil Constantinescu #define TSROSWARK3 "ark3" 6853606a31eSEmil Constantinescu #define TSROSWTHETA1 "theta1" 6863606a31eSEmil Constantinescu #define TSROSWTHETA2 "theta2" 68742faf41dSJed Brown #define TSROSWGRK4T "grk4t" 68842faf41dSJed Brown #define TSROSWSHAMP4 "shamp4" 68942faf41dSJed Brown #define TSROSWVELDD4 "veldd4" 69042faf41dSJed Brown #define TSROSW4L "4l" 691b1c69cc3SEmil Constantinescu 69219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWGetType(TS ts,TSRosWType*); 69319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWSetType(TS ts,TSRosWType); 694014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 69519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 69619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 697014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 698607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 699014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 700e27a552bSJed Brown 70183e2fdc7SBarry Smith /* 7020f3b3ca1SHong Zhang PETSc interface to Sundials 70383e2fdc7SBarry Smith */ 7046dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 7056fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 7066a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 7076fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 7086a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 709014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 710014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 711014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 712014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 713014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 714014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 715014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 716014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 717014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 718014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 719014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 720014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 7216dc17ff5SMatthew Knepley #endif 72283e2fdc7SBarry Smith 723014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 724014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 725014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 726014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 7270de4c49aSJed Brown 728014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*); 729014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*); 730014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 731014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 732014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 73388df8a41SLisandro Dalcin 734014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 735014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 7366c699258SBarry Smith 737014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 738d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*); 7390f5c6efeSJed Brown 740818ad0c1SBarry Smith #endif 741