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 */ 526bd1501SBarry Smith #if !defined(PETSCTS_H) 626bd1501SBarry Smith #define PETSCTS_H 72c8e378dSBarry Smith #include <petscsnes.h> 8900f6b5bSMatthew G. Knepley #include <petscconvest.h> 9818ad0c1SBarry Smith 10435da068SBarry Smith /*S 11435da068SBarry Smith TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 12435da068SBarry Smith 13435da068SBarry Smith Level: beginner 14435da068SBarry Smith 158f6c3df8SBarry Smith .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy() 16435da068SBarry Smith S*/ 17f09e8eb9SSatish Balay typedef struct _p_TS* TS; 18435da068SBarry Smith 1976bdecfbSBarry Smith /*J 208f6c3df8SBarry Smith TSType - String with the name of a PETSc TS method. 21435da068SBarry Smith 22435da068SBarry Smith Level: beginner 23435da068SBarry Smith 248f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister() 2576bdecfbSBarry Smith J*/ 2619fd82e9SBarry Smith typedef const char* TSType; 279596e0b4SJed Brown #define TSEULER "euler" 289596e0b4SJed Brown #define TSBEULER "beuler" 29e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic" 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" 37818efac9SLisandro Dalcin #define TSALPHA2 "alpha2" 3826d28e4eSEmil Constantinescu #define TSGLLE "glle" 39b6a60446SDebojyoti Ghosh #define TSGLEE "glee" 40ef7bb5aaSJed Brown #define TSSSP "ssp" 418a381b04SJed Brown #define TSARKIMEX "arkimex" 42e27a552bSJed Brown #define TSROSW "rosw" 437d5697caSHong Zhang #define TSEIMEX "eimex" 44abadfa0fSMatthew G. Knepley #define TSMIMEX "mimex" 45211a84d6SLisandro Dalcin #define TSBDF "bdf" 46d249a78fSBarry Smith #define TSRADAU5 "radau5" 474b84eec9SHong Zhang #define TSMPRK "mprk" 48211a84d6SLisandro Dalcin 49435da068SBarry Smith /*E 50435da068SBarry Smith TSProblemType - Determines the type of problem this TS object is to be used to solve 51435da068SBarry Smith 52435da068SBarry Smith Level: beginner 53435da068SBarry Smith 54435da068SBarry Smith .seealso: TSCreate() 55435da068SBarry Smith E*/ 5619bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 57818ad0c1SBarry Smith 58b93fea0eSJed Brown /*E 59e817cc15SEmil Constantinescu TSEquationType - type of TS problem that is solved 60e817cc15SEmil Constantinescu 61e817cc15SEmil Constantinescu Level: beginner 62e817cc15SEmil Constantinescu 6395452b02SPatrick Sanan Developer Notes: 6495452b02SPatrick Sanan this must match petsc/finclude/petscts.h 65e817cc15SEmil Constantinescu 66e817cc15SEmil Constantinescu Supported types are: 67e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED (default) 68e817cc15SEmil 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 69e817cc15SEmil Constantinescu TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0 70e817cc15SEmil Constantinescu 71e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType() 72e817cc15SEmil Constantinescu E*/ 73e817cc15SEmil Constantinescu typedef enum { 74e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED = -1, 75e817cc15SEmil Constantinescu TS_EQ_EXPLICIT = 0, 76e817cc15SEmil Constantinescu TS_EQ_ODE_EXPLICIT = 1, 77e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 78e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 79e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 80e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 81e817cc15SEmil Constantinescu TS_EQ_IMPLICIT = 1000, 82e817cc15SEmil Constantinescu TS_EQ_ODE_IMPLICIT = 1001, 83e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 84e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 85e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 8619436ca2SJed Brown TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 87e817cc15SEmil Constantinescu } TSEquationType; 88e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes; 89e817cc15SEmil Constantinescu 90e817cc15SEmil Constantinescu /*E 91b93fea0eSJed Brown TSConvergedReason - reason a TS method has converged or not 92b93fea0eSJed Brown 93b93fea0eSJed Brown Level: beginner 94b93fea0eSJed Brown 9595452b02SPatrick Sanan Developer Notes: 9695452b02SPatrick Sanan this must match petsc/finclude/petscts.h 97b93fea0eSJed Brown 98b93fea0eSJed Brown Each reason has its own manual page. 99b93fea0eSJed Brown 100b93fea0eSJed Brown .seealso: TSGetConvergedReason() 101b93fea0eSJed Brown E*/ 102193ac0bcSJed Brown typedef enum { 103193ac0bcSJed Brown TS_CONVERGED_ITERATING = 0, 104193ac0bcSJed Brown TS_CONVERGED_TIME = 1, 105193ac0bcSJed Brown TS_CONVERGED_ITS = 2, 106d6ad946cSShri Abhyankar TS_CONVERGED_USER = 3, 1072b7db910SShri Abhyankar TS_CONVERGED_EVENT = 4, 1083118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FATOL = 5, 1093118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FRTOL = 6, 110193ac0bcSJed Brown TS_DIVERGED_NONLINEAR_SOLVE = -1, 111b5b4017aSHong Zhang TS_DIVERGED_STEP_REJECTED = -2, 11205c9950eSHong Zhang TSFORWARD_DIVERGED_LINEAR_SOLVE = -3, 11305c9950eSHong Zhang TSADJOINT_DIVERGED_LINEAR_SOLVE = -4 114193ac0bcSJed Brown } TSConvergedReason; 115014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons; 1161957e957SBarry Smith 117b93fea0eSJed Brown /*MC 118b93fea0eSJed Brown TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 119b93fea0eSJed Brown 120b93fea0eSJed Brown Level: beginner 121b93fea0eSJed Brown 122552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 123b93fea0eSJed Brown M*/ 124b93fea0eSJed Brown 125b93fea0eSJed Brown /*MC 126b93fea0eSJed Brown TS_CONVERGED_TIME - the final time was reached 127b93fea0eSJed Brown 128b93fea0eSJed Brown Level: beginner 129b93fea0eSJed Brown 13019eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime() 131b93fea0eSJed Brown M*/ 132b93fea0eSJed Brown 133b93fea0eSJed Brown /*MC 1341957e957SBarry Smith TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 135b93fea0eSJed Brown 136b93fea0eSJed Brown Level: beginner 137b93fea0eSJed Brown 13819eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps() 139b93fea0eSJed Brown M*/ 1401957e957SBarry Smith 141d6ad946cSShri Abhyankar /*MC 142d6ad946cSShri Abhyankar TS_CONVERGED_USER - user requested termination 143d6ad946cSShri Abhyankar 144d6ad946cSShri Abhyankar Level: beginner 145d6ad946cSShri Abhyankar 14619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason() 147b93fea0eSJed Brown M*/ 148b93fea0eSJed Brown 149b93fea0eSJed Brown /*MC 150d76fc68cSShri Abhyankar TS_CONVERGED_EVENT - user requested termination on event detection 151d76fc68cSShri Abhyankar 152d76fc68cSShri Abhyankar Level: beginner 153d76fc68cSShri Abhyankar 15419eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason() 155d76fc68cSShri Abhyankar M*/ 156d76fc68cSShri Abhyankar 157d76fc68cSShri Abhyankar /*MC 1583118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO 1593118ae5eSBarry Smith 1603118ae5eSBarry Smith Level: beginner 1613118ae5eSBarry Smith 1623118ae5eSBarry Smith Options Database: 1633118ae5eSBarry Smith . -ts_pseudo_frtol <rtol> 1643118ae5eSBarry Smith 16519eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL 1663118ae5eSBarry Smith M*/ 1673118ae5eSBarry Smith 1683118ae5eSBarry Smith /*MC 1693118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO 1703118ae5eSBarry Smith 1713118ae5eSBarry Smith Level: beginner 1723118ae5eSBarry Smith 1733118ae5eSBarry Smith Options Database: 1743118ae5eSBarry Smith . -ts_pseudo_fatol <atol> 1753118ae5eSBarry Smith 17619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL 1773118ae5eSBarry Smith M*/ 1783118ae5eSBarry Smith 1793118ae5eSBarry Smith /*MC 180b93fea0eSJed Brown TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 181b93fea0eSJed Brown 182b93fea0eSJed Brown Level: beginner 183b93fea0eSJed Brown 18495452b02SPatrick Sanan Notes: 18595452b02SPatrick Sanan See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures. 1861957e957SBarry Smith 1871957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures() 188b93fea0eSJed Brown M*/ 189b93fea0eSJed Brown 190b93fea0eSJed Brown /*MC 191b93fea0eSJed Brown TS_DIVERGED_STEP_REJECTED - too many steps were rejected 192b93fea0eSJed Brown 193b93fea0eSJed Brown Level: beginner 194b93fea0eSJed Brown 19595452b02SPatrick Sanan Notes: 19695452b02SPatrick Sanan See TSSetMaxStepRejections() for how to allow more step rejections. 1971957e957SBarry Smith 1981957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections() 199b93fea0eSJed Brown M*/ 200b93fea0eSJed Brown 201d6ad946cSShri Abhyankar /*E 202d6ad946cSShri Abhyankar TSExactFinalTimeOption - option for handling of final time step 203d6ad946cSShri Abhyankar 204d6ad946cSShri Abhyankar Level: beginner 205d6ad946cSShri Abhyankar 20695452b02SPatrick Sanan Developer Notes: 20795452b02SPatrick Sanan this must match petsc/finclude/petscts.h 208d6ad946cSShri Abhyankar 209d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 210d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 211d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 212feed9e9dSBarry Smith 213f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime() 2144ceb6c04SBarry Smith 215d6ad946cSShri Abhyankar E*/ 216feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption; 217d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 218d6ad946cSShri Abhyankar 219000e7ae3SMatthew Knepley /* Logging support */ 220014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID; 221d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID; 2221b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID; 223000e7ae3SMatthew Knepley 224607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 225560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void); 2268ba1e511SMatthew Knepley 227014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 228baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*); 229014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 230818ad0c1SBarry Smith 231014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 233014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 235721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 237818ad0c1SBarry Smith 238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS); 243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS); 244818ad0c1SBarry Smith 245014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 247818ad0c1SBarry Smith 248efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec); 249efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*); 25057df6a1bSDebojyoti Ghosh 251642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*); 252642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*); 2530a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*); 25457df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec); 2556e2e232bSDebojyoti Ghosh 256a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 257cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS,Mat*,PetscErrorCode(**)(TS,PetscReal,Vec,Mat,void*),void**); 258a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat); 25933f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal,Mat,void*),void*); 26033f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS,PetscReal,Vec,Vec,PetscReal,Mat,PetscBool); 26125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 26225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSComputeDRDUFunction(TS,PetscReal,Vec,Vec*); 263b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 264b5b4017aSHong Zhang Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 265b5b4017aSHong Zhang Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 266b5b4017aSHong Zhang Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 267b5b4017aSHong Zhang void*); 268b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*); 269b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*); 270b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*); 271b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*); 27213af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 27313af1a74SHong Zhang Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 27413af1a74SHong Zhang Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 27513af1a74SHong Zhang Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 27613af1a74SHong Zhang void*); 277b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUU(TS,PetscReal,Vec,Vec*,Vec,Vec*); 278b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionUP(TS,PetscReal,Vec,Vec*,Vec,Vec*); 279b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPU(TS,PetscReal,Vec,Vec*,Vec,Vec*); 280b1e111ebSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunctionPP(TS,PetscReal,Vec,Vec*,Vec,Vec*); 281b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS,PetscInt,Vec*,Vec*,Vec); 282b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS,PetscInt*,Vec**,Vec**,Vec*); 283ba0675f6SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeSNESJacobian(TS,Vec,Mat,Mat); 284a05bf03eSHong Zhang 285bc952696SBarry Smith /*S 286e91eccc2SStefano Zampini TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step) 287bc952696SBarry Smith 288bc952696SBarry Smith Level: advanced 289bc952696SBarry Smith 2901550c9b9SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset() 291bc952696SBarry Smith S*/ 292bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory; 293bc952696SBarry Smith 294bc952696SBarry Smith /*J 2953c0fce88SHong Zhang TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method 296bc952696SBarry Smith 297bc952696SBarry Smith Level: intermediate 298bc952696SBarry Smith 2993c0fce88SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy() 300bc952696SBarry Smith J*/ 301bc952696SBarry Smith typedef const char* TSTrajectoryType; 302bc952696SBarry Smith #define TSTRAJECTORYBASIC "basic" 3031c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE "singlefile" 3049a53571cSHong Zhang #define TSTRAJECTORYMEMORY "memory" 3052b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization" 306bc952696SBarry Smith 307bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList; 308bc952696SBarry Smith PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 309bc952696SBarry Smith PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 310bc952696SBarry Smith 311bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 3122d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS); 313bc952696SBarry Smith 314bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*); 3159a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory); 316bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*); 317560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer); 318fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType); 319881c1a9bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGetType(TSTrajectory,TS,TSTrajectoryType*); 320bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec); 321c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*); 322fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec); 323fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*); 324fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*); 325fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*); 326972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS); 327560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS)); 328bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 32968bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS); 3309ffb3502SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUseHistory(TSTrajectory,PetscBool); 3312bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool); 33278fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*); 33308347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 334fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool); 335fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*); 33664fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool); 33764e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]); 33864e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]); 33978fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*); 340bc952696SBarry Smith 341dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*); 342dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**); 34325ef9dfeSBarry 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*); 344dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*); 345022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec); 346cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS,PetscBool,TS*); 347cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS,PetscBool*,TS*); 348d4aa0a58SBarry Smith 349a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS); 350a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*); 351a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**)); 352a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 353a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 354a05bf03eSHong Zhang 35525ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetRHSJacobianP()") PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 35625ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSComputeRHSJacobianP()") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat); 35725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 35825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetQuadratureTS then TSComputeRHSJacobian") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*); 3592c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 36073b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt); 361d4aa0a58SBarry Smith 36273b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 363f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 364ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS); 365999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS); 366ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetForward(TS,Mat); 367ecf68647SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointResetForward(TS); 368715f1b00SHong Zhang 36913b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat); 37013b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*); 37125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSCreateQuadratureTS() and TSForwardSetSensitivities() (since version 3.12)") PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *); 37225ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSForwardGetSensitivities()") PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **); 373715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS); 3747adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS); 375999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS); 376715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS); 377b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat); 3786affb6f8SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat**); 379c235aa8dSHong Zhang 380618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt); 381618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*); 382618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal); 383618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*); 38449354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption); 385f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*); 386818ad0c1SBarry Smith 38725ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetTime[Step]() (since version 3.8)") PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 38825ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSSetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 38925ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetMax{Steps|Time}() (since version 3.8)") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 39025ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)") PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 39125ef9dfeSBarry Smith PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use TSGetStepNumber() (since version 3.8)") PetscErrorCode TSGetTotalSteps(TS,PetscInt*); 39219eac22cSLisandro Dalcin 393721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 394cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 39583a4ac43SBarry Smith 39683a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx* TSMonitorDrawCtx; 39783a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *); 39883a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*); 39983a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*); 4002d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*); 40183a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*); 4020ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*); 40383a4ac43SBarry Smith 404721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *); 4059110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*); 4069110b2e7SHong Zhang 407721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 408014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 409014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 410fb1732b5SBarry Smith 411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS); 4127cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*); 413014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 414cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec); 415e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*); 416e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType); 417014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 418d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason); 419487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*); 4205ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 4215ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 422cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 423cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 424cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 425cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 426cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 427dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS); 42824655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS); 429d2daff3dSHong Zhang 430ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**); 431818ad0c1SBarry Smith 432014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 433014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 434e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*); 43580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 43680275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 43780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*); 43880275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt); 439818ad0c1SBarry Smith 440638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 441d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*); 442cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS,PetscReal,Vec,Mat,void*); 443014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 444014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 445014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 446014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 447e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool); 448818ad0c1SBarry Smith 449ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 450ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 451d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*); 452d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*); 453ef20d060SBarry Smith 454638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 455d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 456014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 457014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 460316643e7SJed Brown 461efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*); 462efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*); 463efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*); 464efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**); 465efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*); 466efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**); 467efe9872eSLisandro Dalcin 468545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS); 469545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*); 470545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*); 4711d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*); 4721d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]); 4730fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool); 4740fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*); 475d9194312SHong Zhang 476014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 477d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*); 478014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 479d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 4801c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 4819b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec); 482847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 483e34be4c2SBarry Smith 484014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 485b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 4869be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*)); 487c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS)); 488014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 489014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS); 490b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 4919be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*); 492c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS); 493014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS); 494014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 495014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 496c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 4977453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 4987453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 4997453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*); 5008a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 5018a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 5028a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*); 503014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 504014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 505d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*)); 506d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*); 507000e7ae3SMatthew Knepley 508014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 5098d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*); 510014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 511014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 5138d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *); 514014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 515014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 516014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 51721c89e3eSBarry Smith 518014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 5191d6018f0SLisandro Dalcin 520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 521d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat); 522014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 523d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool); 524efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec); 525efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat); 526f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*); 527818ad0c1SBarry Smith 528014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 529d6ebe24aSShri Abhyankar 530967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 53124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 53224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 53324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 53424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 53524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 53624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 53724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 53824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 539efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*); 540efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**); 541efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*); 542efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**); 543efe9872eSLisandro Dalcin 544ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 545ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 546d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*); 547d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**); 548924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*); 549924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal); 5500163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **); 5519b7cd975SBarry Smith 552d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*); 553d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*); 554d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*); 5556c6b9e74SPeter Brune 5566c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5576c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5586c6b9e74SPeter Brune 5596c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 560d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*); 5616c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 562d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*); 5636c6b9e74SPeter Brune 5646c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 565d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *); 5666c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 567d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *); 5686c6b9e74SPeter Brune 569b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 570560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*); 5716dbbd306SMatthew G. Knepley 572be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 573d1212d36SBarry Smith typedef struct { 574d1212d36SBarry Smith Vec ray; 575d1212d36SBarry Smith VecScatter scatter; 576d1212d36SBarry Smith PetscViewer viewer; 57751b4a12fSMatthew G. Knepley TSMonitorLGCtx lgctx; 578d1212d36SBarry Smith } TSMonitorDMDARayCtx; 579d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 580d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 58151b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 582d1212d36SBarry Smith 583bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 584140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList; 58519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 58619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 587bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 58830de9b25SBarry Smith 589014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 590deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 591014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 592818ad0c1SBarry Smith 593014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 59455849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 595fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS,PetscObject,const char[]); 596fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory,PetscObject,const char[]); 59755849f57SBarry Smith 59855849f57SBarry Smith #define TS_FILE_CLASSID 1211225 59921c89e3eSBarry Smith 600014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 601014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 60221c89e3eSBarry Smith 603a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 604a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 6054f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 6064f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 60731152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 608b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **); 609e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *); 610a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 611a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*); 6127684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 6137684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *); 6144f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 615201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 616201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 617edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *); 618ef20d060SBarry Smith 619b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx* TSMonitorEnvelopeCtx; 620b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*); 621b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*); 622b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*); 623b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*); 624b3d3934dSBarry Smith 6258189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 6268189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 6278189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 6288189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 6293914022bSBarry Smith 6301b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx; 6311b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*); 6321b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*); 6330ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*); 6341b575b74SJoseph Pusztay 6352589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*); 6360e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal); 6376427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]); 63876bdecfbSBarry Smith /*J 639815f1ad5SJed Brown TSSSPType - string with the name of TSSSP scheme. 640815f1ad5SJed Brown 641815f1ad5SJed Brown Level: beginner 642815f1ad5SJed Brown 643815f1ad5SJed Brown .seealso: TSSSPSetType(), TS 64476bdecfbSBarry Smith J*/ 64519fd82e9SBarry Smith typedef const char* TSSSPType; 646815f1ad5SJed Brown #define TSSSPRKS2 "rks2" 647815f1ad5SJed Brown #define TSSSPRKS3 "rks3" 648815f1ad5SJed Brown #define TSSSPRK104 "rk104" 649815f1ad5SJed Brown 65019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 65119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 652014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 653014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 654787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 655560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 656013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList; 657815f1ad5SJed Brown 658ed657a08SJed Brown /*S 65984df9cb4SJed Brown TSAdapt - Abstract object that manages time-step adaptivity 66084df9cb4SJed Brown 66184df9cb4SJed Brown Level: beginner 66284df9cb4SJed Brown 66384df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType 66484df9cb4SJed Brown S*/ 66584df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt; 66684df9cb4SJed Brown 66784df9cb4SJed Brown /*E 6688f6c3df8SBarry Smith TSAdaptType - String with the name of TSAdapt scheme. 66984df9cb4SJed Brown 67084df9cb4SJed Brown Level: beginner 67184df9cb4SJed Brown 67284df9cb4SJed Brown .seealso: TSAdaptSetType(), TS 67384df9cb4SJed Brown E*/ 674f8963224SJed Brown typedef const char *TSAdaptType; 675b0f836d7SJed Brown #define TSADAPTNONE "none" 6761917a363SLisandro Dalcin #define TSADAPTBASIC "basic" 677cb7ab186SLisandro Dalcin #define TSADAPTDSP "dsp" 6788d59e960SJed Brown #define TSADAPTCFL "cfl" 6791917a363SLisandro Dalcin #define TSADAPTGLEE "glee" 680d949e4a4SStefano Zampini #define TSADAPTHISTORY "history" 68184df9cb4SJed Brown 682552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 683bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 684607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 685014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 686014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 68719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 688d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*); 689014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 690014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 691014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 692014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 693014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 694b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*); 695014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 696ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 6974416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt); 698099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 699014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 700014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 701bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool); 7021917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal); 7031917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*); 70476cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt,PetscReal); 70576cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt,PetscReal*); 7061917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal); 7071917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*); 708014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 7091917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*); 710b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*)); 711d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool); 71275017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool); 71375017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*); 714de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt); 715cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *); 716cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal); 71784df9cb4SJed Brown 71884df9cb4SJed Brown /*S 71926d28e4eSEmil Constantinescu TSGLLEAdapt - Abstract object that manages time-step adaptivity 720ed657a08SJed Brown 721ed657a08SJed Brown Level: beginner 722ed657a08SJed Brown 72384df9cb4SJed Brown Developer Notes: 72484df9cb4SJed Brown This functionality should be replaced by the TSAdapt. 72584df9cb4SJed Brown 72626d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType 727ed657a08SJed Brown S*/ 72826d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt; 729ed657a08SJed Brown 73076bdecfbSBarry Smith /*J 73126d28e4eSEmil Constantinescu TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme 732ed657a08SJed Brown 733ed657a08SJed Brown Level: beginner 734ed657a08SJed Brown 73526d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS 73676bdecfbSBarry Smith J*/ 73726d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType; 73826d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none" 73926d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size" 74026d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both" 741ed657a08SJed Brown 74226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt)); 74326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void); 74426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void); 74526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*); 74626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType); 74726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]); 74826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 74926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer); 75026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt); 75126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*); 752ed657a08SJed Brown 75376bdecfbSBarry Smith /*J 75426d28e4eSEmil Constantinescu TSGLLEAcceptType - String with the name of TSGLLEAccept scheme 755ed657a08SJed Brown 756ed657a08SJed Brown Level: beginner 757ed657a08SJed Brown 75826d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS 75976bdecfbSBarry Smith J*/ 76026d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType; 76126d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always" 762ed657a08SJed Brown 76326d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 76426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction); 765ed657a08SJed Brown 76676bdecfbSBarry Smith /*J 76726d28e4eSEmil Constantinescu TSGLLEType - family of time integration method within the General Linear class 76818b56cb9SJed Brown 76918b56cb9SJed Brown Level: beginner 77018b56cb9SJed Brown 77126d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister() 77276bdecfbSBarry Smith J*/ 77326d28e4eSEmil Constantinescu typedef const char* TSGLLEType; 77426d28e4eSEmil Constantinescu #define TSGLLE_IRKS "irks" 77518b56cb9SJed Brown 77626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS)); 77726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void); 77826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void); 77926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType); 78026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*); 78126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType); 78218b56cb9SJed Brown 783020d8f30SJed Brown /*J 7847d5697caSHong Zhang TSEIMEXType - String with the name of an Extrapolated IMEX method. 7857d5697caSHong Zhang 7867d5697caSHong Zhang Level: beginner 7877d5697caSHong Zhang 7887d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister() 7897d5697caSHong Zhang J*/ 7907d5697caSHong Zhang #define TSEIMEXType char* 7917d5697caSHong Zhang 7927d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt); 7937d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt); 7947d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool); 7957d5697caSHong Zhang 7967d5697caSHong Zhang /*J 797f68a32c8SEmil Constantinescu TSRKType - String with the name of a Runge-Kutta method. 798f68a32c8SEmil Constantinescu 799f68a32c8SEmil Constantinescu Level: beginner 800f68a32c8SEmil Constantinescu 801f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister() 802f68a32c8SEmil Constantinescu J*/ 803f68a32c8SEmil Constantinescu typedef const char* TSRKType; 804f68a32c8SEmil Constantinescu #define TSRK1FE "1fe" 805fdefd5e5SDebojyoti Ghosh #define TSRK2A "2a" 806f68a32c8SEmil Constantinescu #define TSRK3 "3" 807fdefd5e5SDebojyoti Ghosh #define TSRK3BS "3bs" 808f68a32c8SEmil Constantinescu #define TSRK4 "4" 809fdefd5e5SDebojyoti Ghosh #define TSRK5F "5f" 810fdefd5e5SDebojyoti Ghosh #define TSRK5DP "5dp" 81105e23783SLisandro Dalcin #define TSRK5BS "5bs" 81237acaa02SHendrik Ranocha #define TSRK6VR "6vr" 81337acaa02SHendrik Ranocha #define TSRK7VR "7vr" 81437acaa02SHendrik Ranocha #define TSRK8VR "8vr" 81505e23783SLisandro Dalcin 8162ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS,PetscInt*); 8170f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS,TSRKType*); 8180f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS,TSRKType); 8190f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS,PetscInt*,const PetscReal**,const PetscReal**,const PetscReal**,const PetscReal**,PetscInt*,const PetscReal**,PetscBool*); 8200fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool); 8210fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*); 822f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 823f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 824560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 825f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 826f68a32c8SEmil Constantinescu 827f68a32c8SEmil Constantinescu /*J 8284b84eec9SHong Zhang TSMPRKType - String with the name of a Partitioned Runge-Kutta method 8299f537349Sluzhanghpp 8309f537349Sluzhanghpp Level: beginner 8319f537349Sluzhanghpp 8324b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister() 8339f537349Sluzhanghpp J*/ 8344b84eec9SHong Zhang typedef const char* TSMPRKType; 83519c2959aSHong Zhang #define TSMPRK2A22 "2a22" 83619c2959aSHong Zhang #define TSMPRK2A23 "2a23" 83719c2959aSHong Zhang #define TSMPRK2A32 "2a32" 83819c2959aSHong Zhang #define TSMPRK2A33 "2a33" 8394b84eec9SHong Zhang #define TSMPRKP2 "p2" 8404b84eec9SHong Zhang #define TSMPRKP3 "p3" 8419f537349Sluzhanghpp 8424b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*); 8434b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType); 84479bc8a77SHong 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[]); 8454b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void); 8464b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void); 8474b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void); 8489f537349Sluzhanghpp 8499f537349Sluzhanghpp /*J 850b6a60446SDebojyoti Ghosh TSGLEEType - String with the name of a General Linear with Error Estimation method. 851b6a60446SDebojyoti Ghosh 852b6a60446SDebojyoti Ghosh Level: beginner 853b6a60446SDebojyoti Ghosh 854b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister() 855b6a60446SDebojyoti Ghosh J*/ 856b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType; 857ab8c5912SEmil Constantinescu #define TSGLEEi1 "BE1" 858b6a60446SDebojyoti Ghosh #define TSGLEE23 "23" 859b6a60446SDebojyoti Ghosh #define TSGLEE24 "24" 860b6a60446SDebojyoti Ghosh #define TSGLEE25I "25i" 861b6a60446SDebojyoti Ghosh #define TSGLEE35 "35" 862b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A "exrk2a" 863b6a60446SDebojyoti Ghosh #define TSGLEERK32G1 "rk32g1" 864b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex" 865b6a60446SDebojyoti Ghosh /*J 866b6a60446SDebojyoti Ghosh TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method. 867b6a60446SDebojyoti Ghosh 868b6a60446SDebojyoti Ghosh Level: beginner 869b6a60446SDebojyoti Ghosh 870b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister() 871b6a60446SDebojyoti Ghosh J*/ 872b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*); 873b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType); 87457df6a1bSDebojyoti 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[]); 875b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void); 876b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void); 877b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void); 878b6a60446SDebojyoti Ghosh 879b6a60446SDebojyoti Ghosh /*J 880020d8f30SJed Brown TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 881020d8f30SJed Brown 882020d8f30SJed Brown Level: beginner 883020d8f30SJed Brown 884020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 885020d8f30SJed Brown J*/ 88619fd82e9SBarry Smith typedef const char* TSARKIMEXType; 887e817cc15SEmil Constantinescu #define TSARKIMEX1BEE "1bee" 8881f80e275SEmil Constantinescu #define TSARKIMEXA2 "a2" 8891f80e275SEmil Constantinescu #define TSARKIMEXL2 "l2" 8901f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122" 8911f80e275SEmil Constantinescu #define TSARKIMEX2C "2c" 8928a381b04SJed Brown #define TSARKIMEX2D "2d" 893a3a57f36SJed Brown #define TSARKIMEX2E "2e" 8946cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2" 8958a381b04SJed Brown #define TSARKIMEX3 "3" 8966cf0794eSJed Brown #define TSARKIMEXBPR3 "bpr3" 8976cf0794eSJed Brown #define TSARKIMEXARS443 "ars443" 8988a381b04SJed Brown #define TSARKIMEX4 "4" 8998a381b04SJed Brown #define TSARKIMEX5 "5" 90019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 90119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 902014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 9033a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS,PetscBool*); 90419fd82e9SBarry 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[]); 905607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 906560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 907014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 9088a381b04SJed Brown 909020d8f30SJed Brown /*J 910020d8f30SJed Brown TSRosWType - String with the name of a Rosenbrock-W method. 911020d8f30SJed Brown 912020d8f30SJed Brown Level: beginner 913020d8f30SJed Brown 914020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 915020d8f30SJed Brown J*/ 91619fd82e9SBarry Smith typedef const char* TSRosWType; 91761692a83SJed Brown #define TSROSW2M "2m" 91861692a83SJed Brown #define TSROSW2P "2p" 919fe7e6d57SJed Brown #define TSROSWRA3PW "ra3pw" 920fe7e6d57SJed Brown #define TSROSWRA34PW2 "ra34pw2" 921ef3c5b88SJed Brown #define TSROSWRODAS3 "rodas3" 922ef3c5b88SJed Brown #define TSROSWSANDU3 "sandu3" 923961f28d0SJed Brown #define TSROSWASSP3P3S1C "assp3p3s1c" 924961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c" 92543b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 926753f8adbSEmil Constantinescu #define TSROSWARK3 "ark3" 9273606a31eSEmil Constantinescu #define TSROSWTHETA1 "theta1" 9283606a31eSEmil Constantinescu #define TSROSWTHETA2 "theta2" 92942faf41dSJed Brown #define TSROSWGRK4T "grk4t" 93042faf41dSJed Brown #define TSROSWSHAMP4 "shamp4" 93142faf41dSJed Brown #define TSROSWVELDD4 "veldd4" 93242faf41dSJed Brown #define TSROSW4L "4l" 933b1c69cc3SEmil Constantinescu 9346bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*); 9356bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType); 936014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 93719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 93819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 939607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 940560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 941014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 942e27a552bSJed Brown 943211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt); 944211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*); 945211a84d6SLisandro Dalcin 9466bd7aeb5SHong Zhang /*J 947e49d4f37SHong Zhang TSBasicSymplecticType - String with the name of a basic symplectic integration method. 9486bd7aeb5SHong Zhang 9496bd7aeb5SHong Zhang Level: beginner 9506bd7aeb5SHong Zhang 951e49d4f37SHong Zhang .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister() 9526bd7aeb5SHong Zhang J*/ 953e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType; 954e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER "1" 955e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2" 956e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3 "3" 957e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4 "4" 958e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType); 959e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*); 960e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]); 961e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void); 962e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void); 963e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void); 9646bd7aeb5SHong Zhang 96583e2fdc7SBarry Smith /* 9660f3b3ca1SHong Zhang PETSc interface to Sundials 96783e2fdc7SBarry Smith */ 9686dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 9696fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 9706a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 9716fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 9726a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 973014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 974014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 975014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 976014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 977014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 978014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 979014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 980014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 981014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 982014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 983014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 984014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 985*c4e80e11SFlorian PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS,PetscInt); 9866dc17ff5SMatthew Knepley #endif 98783e2fdc7SBarry Smith 988014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 989014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 990014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 991014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 9920de4c49aSJed Brown 993014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 994014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 995014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 99688df8a41SLisandro Dalcin 997818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal); 998818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal); 999818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 1000818efac9SLisandro Dalcin 1001014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 1002014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 10036c699258SBarry Smith 1004014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 1005d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*); 10060f5c6efeSJed Brown 1007f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*); 1008f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*); 1009aad739acSMatthew G. Knepley 10102e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec)); 10112e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec)); 10122e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec); 10132e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec)); 1014aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec)); 1015aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec); 1016900f6b5bSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst); 1017818ad0c1SBarry Smith #endif 1018