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 */ 56524c165SJacob Faibussowitsch #ifndef PETSCTS_H 626bd1501SBarry Smith #define PETSCTS_H 7ac09b921SBarry Smith 82c8e378dSBarry Smith #include <petscsnes.h> 9900f6b5bSMatthew G. Knepley #include <petscconvest.h> 10818ad0c1SBarry Smith 11ac09b921SBarry Smith /* SUBMANSEC = TS */ 12ac09b921SBarry Smith 13435da068SBarry Smith /*S 14435da068SBarry Smith TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 15435da068SBarry Smith 16435da068SBarry Smith Level: beginner 17435da068SBarry Smith 18db781477SPatrick Sanan .seealso: `TSCreate()`, `TSSetType()`, `TSType`, `SNES`, `KSP`, `PC`, `TSDestroy()` 19435da068SBarry Smith S*/ 20f09e8eb9SSatish Balay typedef struct _p_TS *TS; 21435da068SBarry Smith 2276bdecfbSBarry Smith /*J 2387497f52SBarry Smith TSType - String with the name of a PETSc `TS` method. 24435da068SBarry Smith 25435da068SBarry Smith Level: beginner 26435da068SBarry Smith 27db781477SPatrick Sanan .seealso: `TSSetType()`, `TS`, `TSRegister()` 2876bdecfbSBarry Smith J*/ 2919fd82e9SBarry Smith typedef const char *TSType; 309596e0b4SJed Brown #define TSEULER "euler" 319596e0b4SJed Brown #define TSBEULER "beuler" 32e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic" 339596e0b4SJed Brown #define TSPSEUDO "pseudo" 344d91e141SJed Brown #define TSCN "cn" 359596e0b4SJed Brown #define TSSUNDIALS "sundials" 364d91e141SJed Brown #define TSRK "rk" 379596e0b4SJed Brown #define TSPYTHON "python" 389596e0b4SJed Brown #define TSTHETA "theta" 3988df8a41SLisandro Dalcin #define TSALPHA "alpha" 40818efac9SLisandro Dalcin #define TSALPHA2 "alpha2" 4126d28e4eSEmil Constantinescu #define TSGLLE "glle" 42b6a60446SDebojyoti Ghosh #define TSGLEE "glee" 43ef7bb5aaSJed Brown #define TSSSP "ssp" 448a381b04SJed Brown #define TSARKIMEX "arkimex" 45e27a552bSJed Brown #define TSROSW "rosw" 467d5697caSHong Zhang #define TSEIMEX "eimex" 47abadfa0fSMatthew G. Knepley #define TSMIMEX "mimex" 48211a84d6SLisandro Dalcin #define TSBDF "bdf" 49d249a78fSBarry Smith #define TSRADAU5 "radau5" 504b84eec9SHong Zhang #define TSMPRK "mprk" 5140be0ff1SMatthew G. Knepley #define TSDISCGRAD "discgrad" 52d2567f34SHong Zhang #define TSIRK "irk" 5340be0ff1SMatthew G. Knepley 54435da068SBarry Smith /*E 5587497f52SBarry Smith TSProblemType - Determines the type of problem this `TS` object is to be used to solve 56435da068SBarry Smith 57435da068SBarry Smith Level: beginner 58435da068SBarry Smith 59db781477SPatrick Sanan .seealso: `TSCreate()` 60435da068SBarry Smith E*/ 619371c9d4SSatish Balay typedef enum { 629371c9d4SSatish Balay TS_LINEAR, 639371c9d4SSatish Balay TS_NONLINEAR 649371c9d4SSatish Balay } TSProblemType; 65818ad0c1SBarry Smith 66b93fea0eSJed Brown /*E 6787497f52SBarry Smith TSEquationType - type of `TS` problem that is solved 68e817cc15SEmil Constantinescu 69e817cc15SEmil Constantinescu Level: beginner 70e817cc15SEmil Constantinescu 7195452b02SPatrick Sanan Developer Notes: 7295452b02SPatrick Sanan this must match petsc/finclude/petscts.h 73e817cc15SEmil Constantinescu 74e817cc15SEmil Constantinescu Supported types are: 7587497f52SBarry Smith `TS_EQ_UNSPECIFIED` (default) 7687497f52SBarry Smith `TS_EQ_EXPLICIT` {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) := M(t) U_t - G(U,t) = 0 7787497f52SBarry Smith `TS_EQ_IMPLICIT` {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0 78e817cc15SEmil Constantinescu 79db781477SPatrick Sanan .seealso: `TSGetEquationType()`, `TSSetEquationType()` 80e817cc15SEmil Constantinescu E*/ 81e817cc15SEmil Constantinescu typedef enum { 82e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED = -1, 83e817cc15SEmil Constantinescu TS_EQ_EXPLICIT = 0, 84e817cc15SEmil Constantinescu TS_EQ_ODE_EXPLICIT = 1, 85e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 86e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 87e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 88e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 89e817cc15SEmil Constantinescu TS_EQ_IMPLICIT = 1000, 90e817cc15SEmil Constantinescu TS_EQ_ODE_IMPLICIT = 1001, 91e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 92e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 93e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 9419436ca2SJed Brown TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 95e817cc15SEmil Constantinescu } TSEquationType; 96e817cc15SEmil Constantinescu PETSC_EXTERN const char *const *TSEquationTypes; 97e817cc15SEmil Constantinescu 98e817cc15SEmil Constantinescu /*E 9987497f52SBarry Smith TSConvergedReason - reason a `TS` method has converged or not 100b93fea0eSJed Brown 101b93fea0eSJed Brown Level: beginner 102b93fea0eSJed Brown 10395452b02SPatrick Sanan Developer Notes: 10495452b02SPatrick Sanan this must match petsc/finclude/petscts.h 105b93fea0eSJed Brown 106b93fea0eSJed Brown Each reason has its own manual page. 107b93fea0eSJed Brown 108db781477SPatrick Sanan .seealso: `TSGetConvergedReason()` 109b93fea0eSJed Brown E*/ 110193ac0bcSJed Brown typedef enum { 111193ac0bcSJed Brown TS_CONVERGED_ITERATING = 0, 112193ac0bcSJed Brown TS_CONVERGED_TIME = 1, 113193ac0bcSJed Brown TS_CONVERGED_ITS = 2, 114d6ad946cSShri Abhyankar TS_CONVERGED_USER = 3, 1152b7db910SShri Abhyankar TS_CONVERGED_EVENT = 4, 1163118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FATOL = 5, 1173118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FRTOL = 6, 118193ac0bcSJed Brown TS_DIVERGED_NONLINEAR_SOLVE = -1, 119b5b4017aSHong Zhang TS_DIVERGED_STEP_REJECTED = -2, 12005c9950eSHong Zhang TSFORWARD_DIVERGED_LINEAR_SOLVE = -3, 12105c9950eSHong Zhang TSADJOINT_DIVERGED_LINEAR_SOLVE = -4 122193ac0bcSJed Brown } TSConvergedReason; 123014dd563SJed Brown PETSC_EXTERN const char *const *TSConvergedReasons; 1241957e957SBarry Smith 125b93fea0eSJed Brown /*MC 12687497f52SBarry Smith TS_CONVERGED_ITERATING - this only occurs if `TSGetConvergedReason()` is called during the `TSSolve()` 127b93fea0eSJed Brown 128b93fea0eSJed Brown Level: beginner 129b93fea0eSJed Brown 130db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()` 131b93fea0eSJed Brown M*/ 132b93fea0eSJed Brown 133b93fea0eSJed Brown /*MC 134b93fea0eSJed Brown TS_CONVERGED_TIME - the final time was reached 135b93fea0eSJed Brown 136b93fea0eSJed Brown Level: beginner 137b93fea0eSJed Brown 138db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxTime()`, `TSGetMaxTime()`, `TSGetSolveTime()` 139b93fea0eSJed Brown M*/ 140b93fea0eSJed Brown 141b93fea0eSJed Brown /*MC 1421957e957SBarry Smith TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 143b93fea0eSJed Brown 144b93fea0eSJed Brown Level: beginner 145b93fea0eSJed Brown 146db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxSteps()`, `TSGetMaxSteps()` 147b93fea0eSJed Brown M*/ 1481957e957SBarry Smith 149d6ad946cSShri Abhyankar /*MC 150d6ad946cSShri Abhyankar TS_CONVERGED_USER - user requested termination 151d6ad946cSShri Abhyankar 152d6ad946cSShri Abhyankar Level: beginner 153d6ad946cSShri Abhyankar 154db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()` 155b93fea0eSJed Brown M*/ 156b93fea0eSJed Brown 157b93fea0eSJed Brown /*MC 158d76fc68cSShri Abhyankar TS_CONVERGED_EVENT - user requested termination on event detection 159d76fc68cSShri Abhyankar 160d76fc68cSShri Abhyankar Level: beginner 161d76fc68cSShri Abhyankar 162db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()` 163d76fc68cSShri Abhyankar M*/ 164d76fc68cSShri Abhyankar 165d76fc68cSShri Abhyankar /*MC 16687497f52SBarry Smith TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for `TSPSEUDO` 1673118ae5eSBarry Smith 1683118ae5eSBarry Smith Level: beginner 1693118ae5eSBarry Smith 1703118ae5eSBarry Smith Options Database: 171*d5b43468SJose E. Roman . -ts_pseudo_frtol <rtol> - use specified rtol 1723118ae5eSBarry Smith 173db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FATOL` 1743118ae5eSBarry Smith M*/ 1753118ae5eSBarry Smith 1763118ae5eSBarry Smith /*MC 17787497f52SBarry Smith TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for `TSPSEUDO` 1783118ae5eSBarry Smith 1793118ae5eSBarry Smith Level: beginner 1803118ae5eSBarry Smith 1813118ae5eSBarry Smith Options Database: 18267b8a455SSatish Balay . -ts_pseudo_fatol <atol> - use specified atol 1833118ae5eSBarry Smith 184db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSSetConvergedReason()`, `TS_CONVERGED_PSEUDO_FRTOL` 1853118ae5eSBarry Smith M*/ 1863118ae5eSBarry Smith 1873118ae5eSBarry Smith /*MC 188b93fea0eSJed Brown TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 189b93fea0eSJed Brown 190b93fea0eSJed Brown Level: beginner 191b93fea0eSJed Brown 19295452b02SPatrick Sanan Notes: 19395452b02SPatrick Sanan See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures. 1941957e957SBarry Smith 195db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSGetSNES()`, `SNESGetConvergedReason()`, `TSSetMaxSNESFailures()` 196b93fea0eSJed Brown M*/ 197b93fea0eSJed Brown 198b93fea0eSJed Brown /*MC 199b93fea0eSJed Brown TS_DIVERGED_STEP_REJECTED - too many steps were rejected 200b93fea0eSJed Brown 201b93fea0eSJed Brown Level: beginner 202b93fea0eSJed Brown 20395452b02SPatrick Sanan Notes: 20495452b02SPatrick Sanan See TSSetMaxStepRejections() for how to allow more step rejections. 2051957e957SBarry Smith 206db781477SPatrick Sanan .seealso: `TSSolve()`, `TSGetConvergedReason()`, `TSGetAdapt()`, `TSSetMaxStepRejections()` 207b93fea0eSJed Brown M*/ 208b93fea0eSJed Brown 209d6ad946cSShri Abhyankar /*E 210d6ad946cSShri Abhyankar TSExactFinalTimeOption - option for handling of final time step 211d6ad946cSShri Abhyankar 212d6ad946cSShri Abhyankar Level: beginner 213d6ad946cSShri Abhyankar 21495452b02SPatrick Sanan Developer Notes: 21595452b02SPatrick Sanan this must match petsc/finclude/petscts.h 216d6ad946cSShri Abhyankar 21787497f52SBarry Smith $ `TS_EXACTFINALTIME_STEPOVER` - Don't do anything if final time is exceeded 21887497f52SBarry Smith $ `TS_EXACTFINALTIME_INTERPOLATE` - Interpolate back to final time 21987497f52SBarry Smith $ `TS_EXACTFINALTIME_MATCHSTEP` - Adapt final time step to match the final time 220feed9e9dSBarry Smith 221db781477SPatrick Sanan .seealso: `TSGetConvergedReason()`, `TSSetExactFinalTime()`, `TSGetExactFinalTime()` 2224ceb6c04SBarry Smith 223d6ad946cSShri Abhyankar E*/ 2249371c9d4SSatish Balay typedef enum { 2259371c9d4SSatish Balay TS_EXACTFINALTIME_UNSPECIFIED = 0, 2269371c9d4SSatish Balay TS_EXACTFINALTIME_STEPOVER = 1, 2279371c9d4SSatish Balay TS_EXACTFINALTIME_INTERPOLATE = 2, 2289371c9d4SSatish Balay TS_EXACTFINALTIME_MATCHSTEP = 3 2299371c9d4SSatish Balay } TSExactFinalTimeOption; 230d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 231d6ad946cSShri Abhyankar 232000e7ae3SMatthew Knepley /* Logging support */ 233014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID; 234d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID; 2351b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID; 236000e7ae3SMatthew Knepley 237607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 238560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void); 2398ba1e511SMatthew Knepley 240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm, TS *); 241baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS, TS *); 242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS *); 243818ad0c1SBarry Smith 244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS, TSProblemType); 245014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS, TSProblemType *); 246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS, PetscInt, PetscReal, Vec); 247014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, void *), void *, PetscErrorCode (*)(void **)); 248721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS, const char[], const char[], const char[], PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *), PetscErrorCode (*)(TS, PetscViewerAndFormat *)); 249014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 250818ad0c1SBarry Smith 251014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS, const char[]); 252014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS, const char[]); 253014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS, const char *[]); 254014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 255014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS); 256014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS); 257818ad0c1SBarry Smith 258014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS, Vec); 259014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS, Vec *); 260818ad0c1SBarry Smith 261efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS, Vec, Vec); 262efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS, Vec *, Vec *); 26357df6a1bSDebojyoti Ghosh 264642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS, PetscInt *, Vec *); 265642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS, Vec *); 2660a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS, PetscInt, Vec *); 26757df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS, Vec); 2686e2e232bSDebojyoti Ghosh 269a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), void *); 270cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS, Mat *, PetscErrorCode (**)(TS, PetscReal, Vec, Mat, void *), void **); 271a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS, PetscReal, Vec, Mat); 27233f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Vec, PetscReal, Mat, void *), void *); 27333f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS, PetscReal, Vec, Vec, PetscReal, Mat, PetscBool); 27425ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSComputeDRDPFunction(TS, PetscReal, Vec, Vec *); 27525ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSComputeDRDUFunction(TS, PetscReal, Vec, Vec *); 2769371c9d4SSatish Balay 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 *); 277b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS, PetscReal, Vec, Vec *, Vec, Vec *); 278b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS, PetscReal, Vec, Vec *, Vec, Vec *); 279b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS, PetscReal, Vec, Vec *, Vec, Vec *); 280b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS, PetscReal, Vec, Vec *, Vec, Vec *); 2819371c9d4SSatish Balay 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 *); 282b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS, PetscReal, Vec, Vec *, Vec, Vec *); 283b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS, PetscReal, Vec, Vec *, Vec, Vec *); 284b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS, PetscReal, Vec, Vec *, Vec, Vec *); 285b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS, PetscReal, Vec, Vec *, Vec, Vec *); 286b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS, PetscInt, Vec *, Vec *, Vec); 287b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS, PetscInt *, Vec **, Vec **, Vec *); 288ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS, Vec, Mat, Mat); 289a05bf03eSHong Zhang 290bc952696SBarry Smith /*S 291e91eccc2SStefano Zampini TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step) 292bc952696SBarry Smith 293bc952696SBarry Smith Level: advanced 294bc952696SBarry Smith 295db781477SPatrick Sanan .seealso: `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectorySetType()`, `TSTrajectoryDestroy()`, `TSTrajectoryReset()` 296bc952696SBarry Smith S*/ 297bc952696SBarry Smith typedef struct _p_TSTrajectory *TSTrajectory; 298bc952696SBarry Smith 299bc952696SBarry Smith /*J 30087497f52SBarry Smith TSTrajectorySetType - String with the name of a PETSc `TS` trajectory storage method 301bc952696SBarry Smith 302bc952696SBarry Smith Level: intermediate 303bc952696SBarry Smith 304db781477SPatrick Sanan .seealso: `TSSetSaveTrajectory()`, `TSTrajectoryCreate()`, `TSTrajectoryDestroy()` 305bc952696SBarry Smith J*/ 306bc952696SBarry Smith typedef const char *TSTrajectoryType; 307bc952696SBarry Smith #define TSTRAJECTORYBASIC "basic" 3081c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE "singlefile" 3099a53571cSHong Zhang #define TSTRAJECTORYMEMORY "memory" 3102b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization" 311bc952696SBarry Smith 312bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList; 313bc952696SBarry Smith PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 314bc952696SBarry Smith PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 315bc952696SBarry Smith 316bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 3172d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS); 31867a3cfb0SHong Zhang PETSC_EXTERN PetscErrorCode TSRemoveTrajectory(TS); 319bc952696SBarry Smith 320bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm, TSTrajectory *); 3219a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory); 322bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory *); 323560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory, PetscViewer); 324fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory, TS, TSTrajectoryType); 325881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory, TS, TSTrajectoryType *); 326bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory, TS, PetscInt, PetscReal, Vec); 327c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory, TS, PetscInt, PetscReal *); 328fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory, TS, PetscInt, PetscReal *, Vec, Vec); 329fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory, TS, PetscReal, Vec *, Vec *); 330fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory, PetscInt *); 331fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory, Vec *, Vec *); 332972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory, TS); 333560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[], PetscErrorCode (*)(TSTrajectory, TS)); 334bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 33568bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory, TS); 3369ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory, PetscBool); 3372bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory, PetscBool); 33878fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory, const char *const *); 33908347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory, PetscErrorCode (*)(void *, Vec, Vec *), PetscErrorCode (*)(void *), void *); 340fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory, PetscBool); 341fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory, PetscBool *); 34264fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory, PetscBool); 34364e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory, const char[]); 34464e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory, const char[]); 34578fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS, TSTrajectory *); 346bc952696SBarry Smith 347dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS, PetscInt, Vec *, Vec *); 348dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS, PetscInt *, Vec **, Vec **); 34925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() then set up the sub-TS (since version 3.12)") 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 *); 350dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS, Vec *); 351022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS, PetscReal, Vec, Vec); 352cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS, PetscBool, TS *); 353cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS, PetscBool *, TS *); 354d4aa0a58SBarry Smith 355dbbe0bcdSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(TS, PetscOptionItems *); 356a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *); 357a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS, PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, void *), void *, PetscErrorCode (*)(void **)); 358a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 359a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS, const char[], const char[], const char[], PetscErrorCode (*)(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, PetscViewerAndFormat *), PetscErrorCode (*)(TS, PetscViewerAndFormat *)); 360a05bf03eSHong Zhang 36125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetRHSJacobianP()") PetscErrorCode TSAdjointSetRHSJacobian(TS, Mat, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), void *); 36225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSComputeRHSJacobianP()") PetscErrorCode TSAdjointComputeRHSJacobian(TS, PetscReal, Vec, Mat); 36325ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeDRDPFunction(TS, PetscReal, Vec, Vec *); 36425ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSAdjointComputeDRDYFunction(TS, PetscReal, Vec, Vec *); 3652c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 36673b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS, PetscInt); 367d4aa0a58SBarry Smith 36873b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 369f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 370ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS); 371999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS); 372ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS, Mat); 373ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS); 374715f1b00SHong Zhang 37513b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS, PetscInt, Mat); 37613b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS, PetscInt *, Mat *); 37725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() and TSForwardSetSensitivities() (since version 3.12)") PetscErrorCode TSForwardSetIntegralGradients(TS, PetscInt, Vec *); 37825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSForwardGetSensitivities()") PetscErrorCode TSForwardGetIntegralGradients(TS, PetscInt *, Vec **); 379715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS); 3807adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS); 381999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS); 382715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS); 383b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS, Mat); 384cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS, PetscInt *, Mat *[]); 385c235aa8dSHong Zhang 386618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS, PetscInt); 387618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS, PetscInt *); 388618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS, PetscReal); 389618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS, PetscReal *); 39049354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS, TSExactFinalTimeOption); 391f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS, TSExactFinalTimeOption *); 3924a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSSetTimeSpan(TS, PetscInt, PetscReal *); 3934a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSGetTimeSpan(TS, PetscInt *, const PetscReal **); 3944a658b32SHong Zhang PETSC_EXTERN PetscErrorCode TSGetTimeSpanSolutions(TS, PetscInt *, Vec **); 395818ad0c1SBarry Smith 39625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetTime[Step]() (since version 3.8)") PetscErrorCode TSSetInitialTimeStep(TS, PetscReal, PetscReal); 39725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSSetDuration(TS, PetscInt, PetscReal); 39825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSGetDuration(TS, PetscInt *, PetscReal *); 39925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)") PetscErrorCode TSGetTimeStepNumber(TS, PetscInt *); 40025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)") PetscErrorCode TSGetTotalSteps(TS, PetscInt *); 40119eac22cSLisandro Dalcin 402721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 403cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 40483a4ac43SBarry Smith 40583a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx *TSMonitorDrawCtx; 40683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorDrawCtx *); 40783a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx *); 40883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS, PetscInt, PetscReal, Vec, void *); 4092d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS, PetscInt, PetscReal, Vec, void *); 41083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS, PetscInt, PetscReal, Vec, void *); 4110ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS, PetscInt, PetscReal, Vec, void *); 41283a4ac43SBarry Smith 413721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, PetscViewerAndFormat *); 4149110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS, PetscInt, PetscReal, Vec, PetscInt, Vec *, Vec *, void *); 4159110b2e7SHong Zhang 416721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 417014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS, PetscInt, PetscReal, Vec, void *); 418014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void *); 419fb1732b5SBarry Smith 420014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS); 4217cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS, NormType, PetscInt *, PetscReal *); 422014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS, PetscInt, Vec, PetscBool *); 423cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS, Vec); 424e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS, TSEquationType *); 425e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS, TSEquationType); 426014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS, TSConvergedReason *); 427d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS, TSConvergedReason); 428487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS, PetscReal *); 4295ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS, PetscInt *); 4305ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS, PetscInt *); 431cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS, PetscInt *); 432cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS, PetscInt); 433cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS, PetscInt *); 434cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS, PetscInt); 435cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS, PetscBool); 436dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS); 43724655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS); 438d2daff3dSHong Zhang 439cc4f23bcSHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS, PetscInt *, Vec *[]); 440818ad0c1SBarry Smith 441014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS, PetscReal *); 442014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS, PetscReal); 443e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS, PetscReal *); 44480275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS, PetscReal *); 44580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS, PetscReal); 44680275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS, PetscInt *); 44780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS, PetscInt); 448818ad0c1SBarry Smith 449638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS, PetscReal, Vec, Vec, void *); 450d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS, PetscReal, Vec, Mat, Mat, void *); 451cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS, PetscReal, Vec, Mat, void *); 452014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS, Vec, TSRHSFunction, void *); 453014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS, Vec *, TSRHSFunction *, void **); 454014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS, Mat, Mat, TSRHSJacobian, void *); 455014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS, Mat *, Mat *, TSRHSJacobian *, void **); 456e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS, PetscBool); 457818ad0c1SBarry Smith 458ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS, PetscReal, Vec, void *); 459ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS, TSSolutionFunction, void *); 460d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS, PetscReal, Vec, void *); 461d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS, TSForcingFunction, void *); 462ef20d060SBarry Smith 463638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS, PetscReal, Vec, Vec, Vec, void *); 464d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *); 465014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS, Vec, TSIFunction, void *); 466014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS, Vec *, TSIFunction *, void **); 467014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS, Mat, Mat, TSIJacobian, void *); 468014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS, Mat *, Mat *, TSIJacobian *, void **); 469316643e7SJed Brown 470efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS, PetscReal, Vec, Vec, Vec, Vec, void *); 471efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS, PetscReal, Vec, Vec, Vec, PetscReal, PetscReal, Mat, Mat, void *); 472efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS, Vec, TSI2Function, void *); 473efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS, Vec *, TSI2Function *, void **); 474efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS, Mat, Mat, TSI2Jacobian, void *); 475efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS, Mat *, Mat *, TSI2Jacobian *, void **); 476efe9872eSLisandro Dalcin 477545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS, const char[], IS); 478545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS, const char[], IS *); 479545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS, const char[], Vec, TSRHSFunction, void *); 4801d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS, const char[], TS *); 4811d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS, PetscInt *, TS *[]); 4820fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool); 4830fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool *); 484d9194312SHong Zhang 485014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS, PetscReal, Vec, Vec, void *); 486d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS, PetscReal, Vec, Mat, Mat, void *); 487014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS, PetscReal, Vec, Vec, Vec, void *); 488d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *); 4891c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS, PetscReal, Vec); 4909b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS, PetscReal, Vec); 491847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *); 492e34be4c2SBarry Smith 493014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 494b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS, PetscReal)); 4959be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS, PetscReal, PetscInt, Vec *)); 496c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode (*)(TS)); 497014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 498014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS); 499b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS, PetscReal); 5009be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS, PetscReal, PetscInt, Vec *); 501c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS); 502014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS); 503014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS, PetscReal, Vec); 504014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS, PetscReal, Vec, PetscReal, Vec); 505c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS, PetscReal *, Vec *, PetscReal *, Vec *); 5067453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS, Vec, Vec, PetscReal *, PetscReal *, PetscReal *); 5077453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS, Vec, Vec, PetscReal *, PetscReal *, PetscReal *); 5087453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS, Vec, Vec, NormType, PetscReal *, PetscReal *, PetscReal *); 5098a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *); 5108a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *); 5118a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS, Vec, Vec, Vec, NormType, PetscReal *, PetscReal *, PetscReal *); 512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS, PetscReal); 513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS, PetscReal *); 514d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS, PetscReal, Vec, PetscBool *)); 515d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS, PetscReal, Vec, PetscBool *); 516000e7ae3SMatthew Knepley 517014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS, PetscErrorCode (*)(TS, PetscReal *, void *), void *); 5188d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS, PetscReal *, void *); 519014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS, PetscReal *); 520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS, PetscReal); 521014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS, PetscErrorCode (*)(TS, Vec, void *, PetscReal *, PetscBool *), void *); 5228d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS, Vec, void *, PetscReal *, PetscBool *); 523014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS, Vec, PetscReal *, PetscBool *); 524014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS, PetscReal); 525014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 52621c89e3eSBarry Smith 527014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS, const char[]); 528ebead697SStefano Zampini PETSC_EXTERN PetscErrorCode TSPythonGetType(TS, const char *[]); 5291d6018f0SLisandro Dalcin 530014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS, PetscReal, Vec, Vec); 531d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS, PetscReal, Vec, Mat, Mat); 532014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS, PetscReal, Vec, Vec, Vec, PetscBool); 533d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS, PetscReal, Vec, Vec, PetscReal, Mat, Mat, PetscBool); 534efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS, PetscReal, Vec, Vec, Vec, Vec); 535efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS, PetscReal, Vec, Vec, Vec, PetscReal, PetscReal, Mat, Mat); 536f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS, PetscReal, PetscReal, PetscReal *, PetscReal *); 537818ad0c1SBarry Smith 538014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS, Vec, Vec); 539d6ebe24aSShri Abhyankar 540967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 54124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM, TSRHSFunction, void *); 54224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM, TSRHSFunction *, void **); 543800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionContextDestroy(DM, PetscErrorCode (*)(void *)); 54424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM, TSRHSJacobian, void *); 54524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM, TSRHSJacobian *, void **); 546800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobianContextDestroy(DM, PetscErrorCode (*)(void *)); 54724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM, TSIFunction, void *); 54824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM, TSIFunction *, void **); 549800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetIFunctionContextDestroy(DM, PetscErrorCode (*)(void *)); 55024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM, TSIJacobian, void *); 55124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM, TSIJacobian *, void **); 552800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetIJacobianContextDestroy(DM, PetscErrorCode (*)(void *)); 553efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM, TSI2Function, void *); 554efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM, TSI2Function *, void **); 555800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetI2FunctionContextDestroy(DM, PetscErrorCode (*)(void *)); 556efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM, TSI2Jacobian, void *); 557efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM, TSI2Jacobian *, void **); 558800f99ffSJeremy L Thompson PETSC_EXTERN PetscErrorCode DMTSSetI2JacobianContextDestroy(DM, PetscErrorCode (*)(void *)); 559efe9872eSLisandro Dalcin 560e3c11fc1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSTransientVariable)(TS, Vec, Vec, void *); 561438f35afSJed Brown PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS, TSTransientVariable, void *); 562e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM, TSTransientVariable, void *); 563e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM, TSTransientVariable *, void *); 564e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS, Vec, Vec); 565e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS, PetscBool *); 566e3c11fc1SJed Brown 567ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM, TSSolutionFunction, void *); 568ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM, TSSolutionFunction *, void **); 569d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM, TSForcingFunction, void *); 570d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM, TSForcingFunction *, void **); 571e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckResidual(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscReal *); 572e17bd7bbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckJacobian(TS, DM, PetscReal, Vec, Vec, PetscReal, PetscBool *, PetscReal *); 5737f96f943SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec); 5749b7cd975SBarry Smith 5750c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetIFunctionLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, Vec, void *), void **); 576d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, Vec, void *), void *); 5770c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetIJacobianLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *), void **); 578d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, PetscReal, Mat, Mat, void *), void *); 5790c9409e4SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetRHSFunctionLocal(DM, PetscErrorCode (**)(DM, PetscReal, Vec, Vec, void *), void **); 580d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 581b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrix(DM); 582b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCreateRHSMassMatrixLumped(DM); 583b4937a87SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSDestroyRHSMassMatrix(DM); 5846c6b9e74SPeter Brune 5856c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM, PetscErrorCode (*)(void *, PetscViewer), PetscErrorCode (*)(void **, PetscViewer)); 5866c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM, PetscErrorCode (*)(void *, PetscViewer), PetscErrorCode (*)(void **, PetscViewer)); 5876c6b9e74SPeter Brune 5886c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo *, PetscReal, void *, void *, void *); 589d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo *, PetscReal, void *, Mat, Mat, void *); 5906c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo *, PetscReal, void *, void *, void *, void *); 591d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo *, PetscReal, void *, void *, PetscReal, Mat, Mat, void *); 5926c6b9e74SPeter Brune 5936c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM, InsertMode, PetscErrorCode (*)(DMDALocalInfo *, PetscReal, void *, void *, void *), void *); 594d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM, PetscErrorCode (*)(DMDALocalInfo *, PetscReal, void *, Mat, Mat, void *), void *); 5956c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM, InsertMode, PetscErrorCode (*)(DMDALocalInfo *, PetscReal, void *, void *, void *, void *), void *); 596d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM, PetscErrorCode (*)(DMDALocalInfo *, PetscReal, void *, void *, PetscReal, Mat, Mat, void *), void *); 5976c6b9e74SPeter Brune 598b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM, Vec *, Vec *, PetscReal *); 5996dbbd306SMatthew G. Knepley 600be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx *TSMonitorLGCtx; 601d1212d36SBarry Smith typedef struct { 602d1212d36SBarry Smith Vec ray; 603d1212d36SBarry Smith VecScatter scatter; 604d1212d36SBarry Smith PetscViewer viewer; 60551b4a12fSMatthew G. Knepley TSMonitorLGCtx lgctx; 606d1212d36SBarry Smith } TSMonitorDMDARayCtx; 607d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void **); 608d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS, PetscInt, PetscReal, Vec, void *); 60951b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS, PetscInt, PetscReal, Vec, void *); 610d1212d36SBarry Smith 611bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 612140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList; 61319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS, TSType *); 61419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS, TSType); 615bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 61630de9b25SBarry Smith 617014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS, SNES *); 618deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS, SNES); 619014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS, KSP *); 620818ad0c1SBarry Smith 621014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS, PetscViewer); 62255849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS, PetscViewer); 623fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS, PetscObject, const char[]); 624fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory, PetscObject, const char[]); 62555849f57SBarry Smith 62655849f57SBarry Smith #define TS_FILE_CLASSID 1211225 62721c89e3eSBarry Smith 628014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS, void *); 629014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS, void *); 63021c89e3eSBarry Smith 631a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorLGCtx *); 632a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx *); 6334f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS, PetscInt, PetscReal, Vec, void *); 6344f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS, PetscInt, PetscReal, Vec, void *); 63531152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS, const char *const *); 636b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS, const char *const **); 637e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx, const char *const *); 638a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS, const char *const *); 639a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx, const char *const *); 6407684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS, PetscErrorCode (*)(void *, Vec, Vec *), PetscErrorCode (*)(void *), void *); 6417684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx, PetscErrorCode (*)(void *, Vec, Vec *), PetscErrorCode (*)(void *), void *); 6424f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS, PetscInt, PetscReal, Vec, void *); 643201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS, PetscInt, PetscReal, Vec, void *); 644201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS, PetscInt, PetscReal, Vec, void *); 645edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 646d0c080abSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSDMSwarmMonitorMoments(TS, PetscInt, PetscReal, Vec, PetscViewerAndFormat *); 647ef20d060SBarry Smith 648e669de00SBarry Smith struct _n_TSMonitorLGCtxNetwork { 649e669de00SBarry Smith PetscInt nlg; 650e669de00SBarry Smith PetscDrawLG *lg; 651e669de00SBarry Smith PetscBool semilogy; 652e669de00SBarry Smith PetscInt howoften; /* when > 0 uses step % howoften, when negative only final solution plotted */ 653e669de00SBarry Smith }; 654e669de00SBarry Smith typedef struct _n_TSMonitorLGCtxNetwork *TSMonitorLGCtxNetwork; 655e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkDestroy(TSMonitorLGCtxNetwork *); 656e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkCreate(TS, const char[], const char[], int, int, int, int, PetscInt, TSMonitorLGCtxNetwork *); 657e669de00SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxNetworkSolution(TS, PetscInt, PetscReal, Vec, void *); 658e669de00SBarry Smith 659b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx *TSMonitorEnvelopeCtx; 660b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS, TSMonitorEnvelopeCtx *); 661b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS, PetscInt, PetscReal, Vec, void *); 662b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS, Vec *, Vec *); 663b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx *); 664b3d3934dSBarry Smith 6658189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx *TSMonitorSPEigCtx; 6668189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, TSMonitorSPEigCtx *); 6678189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx *); 6688189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS, PetscInt, PetscReal, Vec, void *); 6693914022bSBarry Smith 6701b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx *TSMonitorSPCtx; 671d7462660SMatthew Knepley PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm, const char[], const char[], int, int, int, int, PetscInt, PetscInt, PetscBool, TSMonitorSPCtx *); 6721b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx *); 6730ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS, PetscInt, PetscReal, Vec, void *); 6741b575b74SJoseph Pusztay 6752589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS, PetscInt, PetscInt[], PetscBool[], PetscErrorCode (*)(TS, PetscReal, Vec, PetscScalar[], void *), PetscErrorCode (*)(TS, PetscInt, PetscInt[], PetscReal, Vec, PetscBool, void *), void *); 6760e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS, PetscReal); 6776427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS, PetscReal, PetscReal[]); 6781ea83e56SMiguel PETSC_EXTERN PetscErrorCode TSGetNumEvents(TS, PetscInt *); 6791ea83e56SMiguel 68076bdecfbSBarry Smith /*J 68187497f52SBarry Smith TSSSPType - string with the name of `TSSSP` scheme. 682815f1ad5SJed Brown 683815f1ad5SJed Brown Level: beginner 684815f1ad5SJed Brown 685db781477SPatrick Sanan .seealso: `TSSSPSetType()`, `TS` 68676bdecfbSBarry Smith J*/ 68719fd82e9SBarry Smith typedef const char *TSSSPType; 688815f1ad5SJed Brown #define TSSSPRKS2 "rks2" 689815f1ad5SJed Brown #define TSSSPRKS3 "rks3" 690815f1ad5SJed Brown #define TSSSPRK104 "rk104" 691815f1ad5SJed Brown 69219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS, TSSSPType); 69319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS, TSSSPType *); 694014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS, PetscInt); 695014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS, PetscInt *); 696787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 697560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 698013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList; 699815f1ad5SJed Brown 700ed657a08SJed Brown /*S 70184df9cb4SJed Brown TSAdapt - Abstract object that manages time-step adaptivity 70284df9cb4SJed Brown 70384df9cb4SJed Brown Level: beginner 70484df9cb4SJed Brown 705db781477SPatrick Sanan .seealso: `TS`, `TSAdaptCreate()`, `TSAdaptType` 70684df9cb4SJed Brown S*/ 70784df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt; 70884df9cb4SJed Brown 709f0fc11ceSJed Brown /*J 71087497f52SBarry Smith TSAdaptType - String with the name of `TSAdapt` scheme. 71184df9cb4SJed Brown 71284df9cb4SJed Brown Level: beginner 71384df9cb4SJed Brown 714db781477SPatrick Sanan .seealso: `TSAdaptSetType()`, `TS` 715f0fc11ceSJed Brown J*/ 716f8963224SJed Brown typedef const char *TSAdaptType; 717b0f836d7SJed Brown #define TSADAPTNONE "none" 7181917a363SLisandro Dalcin #define TSADAPTBASIC "basic" 719cb7ab186SLisandro Dalcin #define TSADAPTDSP "dsp" 7208d59e960SJed Brown #define TSADAPTCFL "cfl" 7211917a363SLisandro Dalcin #define TSADAPTGLEE "glee" 722d949e4a4SStefano Zampini #define TSADAPTHISTORY "history" 72384df9cb4SJed Brown 724552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS, TSAdapt *); 725bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[], PetscErrorCode (*)(TSAdapt)); 726607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 727014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 728014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm, TSAdapt *); 72919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt, TSAdaptType); 730d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt, TSAdaptType *); 731014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt, const char[]); 732014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 733014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt, const char[], PetscInt, PetscInt, PetscReal, PetscReal, PetscBool); 734014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt, PetscInt *, const PetscInt **, const PetscInt **, const PetscReal **, const PetscReal **); 735014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt, TS, PetscReal, PetscInt *, PetscReal *, PetscBool *); 736b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt, TS, PetscReal, Vec, PetscBool *); 737014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt, PetscViewer); 738ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt, PetscViewer); 739dbbe0bcdSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(TSAdapt, PetscOptionItems *); 740099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 741014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt *); 742014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt, PetscBool); 743bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt, PetscBool); 7441917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt, PetscReal, PetscReal); 7451917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt, PetscReal *, PetscReal *); 74676cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt, PetscReal); 74776cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt, PetscReal *); 7481917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt, PetscReal, PetscReal); 7491917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt, PetscReal *, PetscReal *); 75062c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt, PetscReal); 75162c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt, PetscReal *); 752014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt, PetscReal, PetscReal); 7531917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt, PetscReal *, PetscReal *); 754b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt, PetscErrorCode (*)(TSAdapt, TS, PetscReal, Vec, PetscBool *)); 755d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt, PetscInt n, PetscReal hist[], PetscBool); 75675017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt, TSTrajectory, PetscBool); 75775017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt, PetscInt, PetscReal *, PetscReal *); 758de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt, PetscInt); 759cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt, const char *); 760cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt, PetscReal, PetscReal, PetscReal); 76184df9cb4SJed Brown 76284df9cb4SJed Brown /*S 76387497f52SBarry Smith TSGLLEAdapt - Abstract object that manages time-step adaptivity for `TSGLLE` 764ed657a08SJed Brown 765ed657a08SJed Brown Level: beginner 766ed657a08SJed Brown 76784df9cb4SJed Brown Developer Notes: 76887497f52SBarry Smith This functionality should be replaced by the `TSAdapt`. 76984df9cb4SJed Brown 770db781477SPatrick Sanan .seealso: `TSGLLE`, `TSGLLEAdaptCreate()`, `TSGLLEAdaptType` 771ed657a08SJed Brown S*/ 77226d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt; 773ed657a08SJed Brown 77476bdecfbSBarry Smith /*J 77587497f52SBarry Smith TSGLLEAdaptType - String with the name of `TSGLLEAdapt` scheme 776ed657a08SJed Brown 777ed657a08SJed Brown Level: beginner 778ed657a08SJed Brown 779db781477SPatrick Sanan .seealso: `TSGLLEAdaptSetType()`, `TS` 78076bdecfbSBarry Smith J*/ 78126d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType; 78226d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none" 78326d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size" 78426d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both" 785ed657a08SJed Brown 78626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[], PetscErrorCode (*)(TSGLLEAdapt)); 78726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void); 78826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void); 78926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm, TSGLLEAdapt *); 79026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt, TSGLLEAdaptType); 79126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt, const char[]); 79226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt, PetscInt, const PetscInt[], const PetscReal[], const PetscReal[], PetscInt, PetscReal, PetscReal, PetscInt *, PetscReal *, PetscBool *); 79326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt, PetscViewer); 794dbbe0bcdSBarry Smith PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(TSGLLEAdapt, PetscOptionItems *); 79526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt *); 796ed657a08SJed Brown 79776bdecfbSBarry Smith /*J 79887497f52SBarry Smith TSGLLEAcceptType - String with the name of `TSGLLEAccept` scheme 799ed657a08SJed Brown 800ed657a08SJed Brown Level: beginner 801ed657a08SJed Brown 802db781477SPatrick Sanan .seealso: `TSGLLESetAcceptType()`, `TS` 80376bdecfbSBarry Smith J*/ 80426d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType; 80526d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always" 806ed657a08SJed Brown 80726d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS, PetscReal, PetscReal, const PetscReal[], PetscBool *); 80826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[], TSGLLEAcceptFunction); 809ed657a08SJed Brown 81076bdecfbSBarry Smith /*J 81126d28e4eSEmil Constantinescu TSGLLEType - family of time integration method within the General Linear class 81218b56cb9SJed Brown 81318b56cb9SJed Brown Level: beginner 81418b56cb9SJed Brown 815db781477SPatrick Sanan .seealso: `TSGLLESetType()`, `TSGLLERegister()` 81676bdecfbSBarry Smith J*/ 81726d28e4eSEmil Constantinescu typedef const char *TSGLLEType; 81826d28e4eSEmil Constantinescu #define TSGLLE_IRKS "irks" 81918b56cb9SJed Brown 82026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[], PetscErrorCode (*)(TS)); 82126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void); 82226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void); 82326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS, TSGLLEType); 82426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS, TSGLLEAdapt *); 82526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS, TSGLLEAcceptType); 82618b56cb9SJed Brown 827020d8f30SJed Brown /*J 8287d5697caSHong Zhang TSEIMEXType - String with the name of an Extrapolated IMEX method. 8297d5697caSHong Zhang 8307d5697caSHong Zhang Level: beginner 8317d5697caSHong Zhang 832db781477SPatrick Sanan .seealso: `TSEIMEXSetType()`, `TS`, `TSEIMEX`, `TSEIMEXRegister()` 8337d5697caSHong Zhang J*/ 8347d5697caSHong Zhang #define TSEIMEXType char * 8357d5697caSHong Zhang 8367d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts, PetscInt); 8377d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts, PetscInt, PetscInt); 8387d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS, PetscBool); 8397d5697caSHong Zhang 8407d5697caSHong Zhang /*J 841f68a32c8SEmil Constantinescu TSRKType - String with the name of a Runge-Kutta method. 842f68a32c8SEmil Constantinescu 843f68a32c8SEmil Constantinescu Level: beginner 844f68a32c8SEmil Constantinescu 845db781477SPatrick Sanan .seealso: `TSRKSetType()`, `TS`, `TSRK`, `TSRKRegister()` 846f68a32c8SEmil Constantinescu J*/ 847f68a32c8SEmil Constantinescu typedef const char *TSRKType; 848f68a32c8SEmil Constantinescu #define TSRK1FE "1fe" 849fdefd5e5SDebojyoti Ghosh #define TSRK2A "2a" 850e7685601SHong Zhang #define TSRK2B "2b" 851f68a32c8SEmil Constantinescu #define TSRK3 "3" 852fdefd5e5SDebojyoti Ghosh #define TSRK3BS "3bs" 853f68a32c8SEmil Constantinescu #define TSRK4 "4" 854fdefd5e5SDebojyoti Ghosh #define TSRK5F "5f" 855fdefd5e5SDebojyoti Ghosh #define TSRK5DP "5dp" 85605e23783SLisandro Dalcin #define TSRK5BS "5bs" 85737acaa02SHendrik Ranocha #define TSRK6VR "6vr" 85837acaa02SHendrik Ranocha #define TSRK7VR "7vr" 85937acaa02SHendrik Ranocha #define TSRK8VR "8vr" 86005e23783SLisandro Dalcin 8612ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS, PetscInt *); 8620f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS, TSRKType *); 8630f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS, TSRKType); 8640f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS, PetscInt *, const PetscReal **, const PetscReal **, const PetscReal **, const PetscReal **, PetscInt *, const PetscReal **, PetscBool *); 8650fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS, PetscBool); 8660fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS, PetscBool *); 867f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]); 868f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 869560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 870f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 871f68a32c8SEmil Constantinescu 872f68a32c8SEmil Constantinescu /*J 8734b84eec9SHong Zhang TSMPRKType - String with the name of a Partitioned Runge-Kutta method 8749f537349Sluzhanghpp 8759f537349Sluzhanghpp Level: beginner 8769f537349Sluzhanghpp 877db781477SPatrick Sanan .seealso: `TSMPRKSetType()`, `TS`, `TSMPRK`, `TSMPRKRegister()` 8789f537349Sluzhanghpp J*/ 8794b84eec9SHong Zhang typedef const char *TSMPRKType; 88019c2959aSHong Zhang #define TSMPRK2A22 "2a22" 88119c2959aSHong Zhang #define TSMPRK2A23 "2a23" 88219c2959aSHong Zhang #define TSMPRK2A32 "2a32" 88319c2959aSHong Zhang #define TSMPRK2A33 "2a33" 8844b84eec9SHong Zhang #define TSMPRKP2 "p2" 8854b84eec9SHong Zhang #define TSMPRKP3 "p3" 8869f537349Sluzhanghpp 8874b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts, TSMPRKType *); 8884b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts, TSMPRKType); 88979bc8a77SHong Zhang 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[]); 8904b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void); 8914b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void); 8924b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void); 8939f537349Sluzhanghpp 8949f537349Sluzhanghpp /*J 895d2567f34SHong Zhang TSIRKType - String with the name of an implicit Runge-Kutta method. 896d2567f34SHong Zhang 897d2567f34SHong Zhang Level: beginner 898d2567f34SHong Zhang 899db781477SPatrick Sanan .seealso: `TSIRKSetType()`, `TS`, `TSIRK`, `TSIRKRegister()` 900d2567f34SHong Zhang J*/ 901d2567f34SHong Zhang typedef const char *TSIRKType; 902d2567f34SHong Zhang #define TSIRKGAUSS "gauss" 903d2567f34SHong Zhang 904d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetOrder(TS, PetscInt *); 905d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetType(TS, TSIRKType *); 906d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetType(TS, TSIRKType); 907d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKGetNumStages(TS, PetscInt *); 908d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKSetNumStages(TS, PetscInt); 909d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegister(const char[], PetscErrorCode (*function)(TS)); 910d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKTableauCreate(TS, PetscInt, const PetscReal *, const PetscReal *, const PetscReal *, const PetscReal *, const PetscScalar *, const PetscScalar *, const PetscScalar *); 911d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKInitializePackage(void); 912d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKFinalizePackage(void); 913d2567f34SHong Zhang PETSC_EXTERN PetscErrorCode TSIRKRegisterDestroy(void); 914d2567f34SHong Zhang 915d2567f34SHong Zhang /*J 916b6a60446SDebojyoti Ghosh TSGLEEType - String with the name of a General Linear with Error Estimation method. 917b6a60446SDebojyoti Ghosh 918b6a60446SDebojyoti Ghosh Level: beginner 919b6a60446SDebojyoti Ghosh 920db781477SPatrick Sanan .seealso: `TSGLEESetType()`, `TS`, `TSGLEE`, `TSGLEERegister()` 921b6a60446SDebojyoti Ghosh J*/ 922b6a60446SDebojyoti Ghosh typedef const char *TSGLEEType; 923ab8c5912SEmil Constantinescu #define TSGLEEi1 "BE1" 924b6a60446SDebojyoti Ghosh #define TSGLEE23 "23" 925b6a60446SDebojyoti Ghosh #define TSGLEE24 "24" 926b6a60446SDebojyoti Ghosh #define TSGLEE25I "25i" 927b6a60446SDebojyoti Ghosh #define TSGLEE35 "35" 928b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A "exrk2a" 929b6a60446SDebojyoti Ghosh #define TSGLEERK32G1 "rk32g1" 930b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex" 931b6a60446SDebojyoti Ghosh /*J 932b6a60446SDebojyoti Ghosh TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method. 933b6a60446SDebojyoti Ghosh 934b6a60446SDebojyoti Ghosh Level: beginner 935b6a60446SDebojyoti Ghosh 936db781477SPatrick Sanan .seealso: `TSGLEESetMode()`, `TS`, `TSGLEE`, `TSGLEERegister()` 937b6a60446SDebojyoti Ghosh J*/ 938b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts, TSGLEEType *); 939b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts, TSGLEEType); 94057df6a1bSDebojyoti Ghosh 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[]); 941b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void); 942b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void); 943b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void); 944b6a60446SDebojyoti Ghosh 945b6a60446SDebojyoti Ghosh /*J 946020d8f30SJed Brown TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 947020d8f30SJed Brown 948020d8f30SJed Brown Level: beginner 949020d8f30SJed Brown 950db781477SPatrick Sanan .seealso: `TSARKIMEXSetType()`, `TS`, `TSARKIMEX`, `TSARKIMEXRegister()` 951020d8f30SJed Brown J*/ 95219fd82e9SBarry Smith typedef const char *TSARKIMEXType; 953e817cc15SEmil Constantinescu #define TSARKIMEX1BEE "1bee" 9541f80e275SEmil Constantinescu #define TSARKIMEXA2 "a2" 9551f80e275SEmil Constantinescu #define TSARKIMEXL2 "l2" 9561f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122" 9571f80e275SEmil Constantinescu #define TSARKIMEX2C "2c" 9588a381b04SJed Brown #define TSARKIMEX2D "2d" 959a3a57f36SJed Brown #define TSARKIMEX2E "2e" 9606cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2" 9618a381b04SJed Brown #define TSARKIMEX3 "3" 9626cf0794eSJed Brown #define TSARKIMEXBPR3 "bpr3" 9636cf0794eSJed Brown #define TSARKIMEXARS443 "ars443" 9648a381b04SJed Brown #define TSARKIMEX4 "4" 9658a381b04SJed Brown #define TSARKIMEX5 "5" 96619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts, TSARKIMEXType *); 96719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts, TSARKIMEXType); 968014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS, PetscBool); 9693a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS, PetscBool *); 97019fd82e9SBarry 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[]); 971607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 972560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 973014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 9748a381b04SJed Brown 975020d8f30SJed Brown /*J 976020d8f30SJed Brown TSRosWType - String with the name of a Rosenbrock-W method. 977020d8f30SJed Brown 978020d8f30SJed Brown Level: beginner 979020d8f30SJed Brown 980db781477SPatrick Sanan .seealso: `TSRosWSetType()`, `TS`, `TSROSW`, `TSRosWRegister()` 981020d8f30SJed Brown J*/ 98219fd82e9SBarry Smith typedef const char *TSRosWType; 98361692a83SJed Brown #define TSROSW2M "2m" 98461692a83SJed Brown #define TSROSW2P "2p" 985fe7e6d57SJed Brown #define TSROSWRA3PW "ra3pw" 986fe7e6d57SJed Brown #define TSROSWRA34PW2 "ra34pw2" 987ef3c5b88SJed Brown #define TSROSWRODAS3 "rodas3" 988ef3c5b88SJed Brown #define TSROSWSANDU3 "sandu3" 989961f28d0SJed Brown #define TSROSWASSP3P3S1C "assp3p3s1c" 990961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c" 99143b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 992753f8adbSEmil Constantinescu #define TSROSWARK3 "ark3" 9933606a31eSEmil Constantinescu #define TSROSWTHETA1 "theta1" 9943606a31eSEmil Constantinescu #define TSROSWTHETA2 "theta2" 99542faf41dSJed Brown #define TSROSWGRK4T "grk4t" 99642faf41dSJed Brown #define TSROSWSHAMP4 "shamp4" 99742faf41dSJed Brown #define TSROSWVELDD4 "veldd4" 99842faf41dSJed Brown #define TSROSW4L "4l" 999b1c69cc3SEmil Constantinescu 10006bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS, TSRosWType *); 10016bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS, TSRosWType); 1002014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS, PetscBool); 100319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType, PetscInt, PetscInt, const PetscReal[], const PetscReal[], const PetscReal[], const PetscReal[], PetscInt, const PetscReal[]); 100419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal); 1005607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 1006560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 1007014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 1008e27a552bSJed Brown 1009211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS, PetscInt); 1010211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS, PetscInt *); 1011211a84d6SLisandro Dalcin 10126bd7aeb5SHong Zhang /*J 1013e49d4f37SHong Zhang TSBasicSymplecticType - String with the name of a basic symplectic integration method. 10146bd7aeb5SHong Zhang 10156bd7aeb5SHong Zhang Level: beginner 10166bd7aeb5SHong Zhang 1017db781477SPatrick Sanan .seealso: `TSBasicSymplecticSetType()`, `TS`, `TSBASICSYMPLECTIC`, `TSBasicSymplecticRegister()` 10186bd7aeb5SHong Zhang J*/ 1019e49d4f37SHong Zhang typedef const char *TSBasicSymplecticType; 1020e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER "1" 1021e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2" 1022e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3 "3" 1023e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4 "4" 1024e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS, TSBasicSymplecticType); 1025e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS, TSBasicSymplecticType *); 1026e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType, PetscInt, PetscInt, PetscReal[], PetscReal[]); 1027e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void); 1028e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void); 1029e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void); 10306bd7aeb5SHong Zhang 1031db4653c2SDaniel Finn /*J 103287497f52SBarry Smith TSDiscreteGradient - The Discrete Gradient integrator is a timestepper for Hamiltonian systems designed to conserve the first integral (energy), 103387497f52SBarry Smith but also has the property for some systems of monotonicity in a functional. 1034db4653c2SDaniel Finn 1035db4653c2SDaniel Finn Level: beginner 1036db4653c2SDaniel Finn 1037db781477SPatrick Sanan .seealso: `TS`, `TSDISCGRAD`, `TSDiscGradSetFormulation()`, `TSDiscGradGetFormulation` 1038db4653c2SDaniel Finn J*/ 103940be0ff1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSDiscGradSetFormulation(TS, PetscErrorCode (*)(TS, PetscReal, Vec, Mat, void *), PetscErrorCode (*)(TS, PetscReal, Vec, PetscScalar *, void *), PetscErrorCode (*)(TS, PetscReal, Vec, Vec, void *), void *); 1040db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradIsGonzalez(TS, PetscBool *); 1041db4653c2SDaniel Finn PETSC_EXTERN PetscErrorCode TSDiscGradUseGonzalez(TS, PetscBool); 104240be0ff1SMatthew G. Knepley 104383e2fdc7SBarry Smith /* 10440f3b3ca1SHong Zhang PETSc interface to Sundials 104583e2fdc7SBarry Smith */ 1046e808b789SPatrick Sanan #ifdef PETSC_HAVE_SUNDIALS2 10479371c9d4SSatish Balay typedef enum { 10489371c9d4SSatish Balay SUNDIALS_ADAMS = 1, 10499371c9d4SSatish Balay SUNDIALS_BDF = 2 10509371c9d4SSatish Balay } TSSundialsLmmType; 10516a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 10529371c9d4SSatish Balay typedef enum { 10539371c9d4SSatish Balay SUNDIALS_MODIFIED_GS = 1, 10549371c9d4SSatish Balay SUNDIALS_CLASSICAL_GS = 2 10559371c9d4SSatish Balay } TSSundialsGramSchmidtType; 10566a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 1057014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS, TSSundialsLmmType); 1058014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS, PC *); 1059014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS, PetscReal, PetscReal); 1060014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS, PetscReal); 1061014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS, PetscReal); 1062014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS, PetscInt *, PetscInt *); 1063014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS, TSSundialsGramSchmidtType); 1064014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS, PetscInt); 1065014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS, PetscReal); 1066014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS, PetscBool); 1067014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS, PetscInt *, long *[], double *[]); 1068014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS, PetscInt); 1069c4e80e11SFlorian PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS, PetscInt); 1070918687b8SPatrick Sanan PETSC_EXTERN PetscErrorCode TSSundialsSetUseDense(TS, PetscBool); 10716dc17ff5SMatthew Knepley #endif 107283e2fdc7SBarry Smith 1073014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS, PetscReal); 1074014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS, PetscReal *); 1075014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS, PetscBool *); 1076014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS, PetscBool); 10770de4c49aSJed Brown 1078014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS, PetscReal); 1079014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS, PetscReal, PetscReal, PetscReal); 1080014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS, PetscReal *, PetscReal *, PetscReal *); 108188df8a41SLisandro Dalcin 1082818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS, PetscReal); 1083818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS, PetscReal, PetscReal, PetscReal, PetscReal); 1084818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS, PetscReal *, PetscReal *, PetscReal *, PetscReal *); 1085818efac9SLisandro Dalcin 1086014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS, DM); 1087014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS, DM *); 10886c699258SBarry Smith 1089014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES, Vec, Vec, void *); 1090d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES, Vec, Mat, Mat, void *); 10910f5c6efeSJed Brown 1092f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS, PetscBool *); 1093f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS, PetscBool *); 1094aad739acSMatthew G. Knepley 10952e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec)); 10962e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec)); 10972e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec); 10982e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec)); 1099aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec)); 1100aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec); 1101f2ed2dc7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool); 1102d60b7d5cSBarry Smith 1103d60b7d5cSBarry Smith PETSC_EXTERN PetscErrorCode TSSetMatStructure(TS, MatStructure); 1104818ad0c1SBarry Smith #endif 1105