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 544e3c11fc1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSTransientVariable)(TS,Vec,Vec,void*); 545438f35afSJed Brown PETSC_EXTERN PetscErrorCode TSSetTransientVariable(TS,TSTransientVariable,void*); 546e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSSetTransientVariable(DM,TSTransientVariable,void*); 547e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode DMTSGetTransientVariable(DM,TSTransientVariable*,void*); 548e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSComputeTransientVariable(TS,Vec,Vec); 549e3c11fc1SJed Brown PETSC_EXTERN PetscErrorCode TSHasTransientVariable(TS,PetscBool*); 550e3c11fc1SJed Brown 551ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 552ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 553d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*); 554d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**); 555924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*); 556924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal); 5577f96f943SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec); 5589b7cd975SBarry Smith 559d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*); 560d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*); 561d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*); 5626c6b9e74SPeter Brune 5636c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5646c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5656c6b9e74SPeter Brune 5666c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 567d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*); 5686c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 569d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*); 5706c6b9e74SPeter Brune 5716c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 572d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *); 5736c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 574d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *); 5756c6b9e74SPeter Brune 576b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 577560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*); 5786dbbd306SMatthew G. Knepley 579be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 580d1212d36SBarry Smith typedef struct { 581d1212d36SBarry Smith Vec ray; 582d1212d36SBarry Smith VecScatter scatter; 583d1212d36SBarry Smith PetscViewer viewer; 58451b4a12fSMatthew G. Knepley TSMonitorLGCtx lgctx; 585d1212d36SBarry Smith } TSMonitorDMDARayCtx; 586d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 587d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 58851b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 589d1212d36SBarry Smith 590bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 591140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList; 59219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 59319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 594bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 59530de9b25SBarry Smith 596014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 597deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 598014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 599818ad0c1SBarry Smith 600014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 60155849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 602fe2efc57SMark PETSC_EXTERN PetscErrorCode TSViewFromOptions(TS,PetscObject,const char[]); 603fe2efc57SMark PETSC_EXTERN PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory,PetscObject,const char[]); 60455849f57SBarry Smith 60555849f57SBarry Smith #define TS_FILE_CLASSID 1211225 60621c89e3eSBarry Smith 607014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 608014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 60921c89e3eSBarry Smith 610a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 611a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 6124f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 6134f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 61431152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 615b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **); 616e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *); 617a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 618a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*); 6197684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 6207684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *); 6214f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 622201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 623201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 624edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *); 625ef20d060SBarry Smith 626b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx* TSMonitorEnvelopeCtx; 627b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*); 628b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*); 629b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*); 630b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*); 631b3d3934dSBarry Smith 6328189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 6338189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 6348189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 6358189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 6363914022bSBarry Smith 6371b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx; 6381b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*); 6391b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*); 6400ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*); 6411b575b74SJoseph Pusztay 6422589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*); 6430e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal); 6446427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]); 64576bdecfbSBarry Smith /*J 646815f1ad5SJed Brown TSSSPType - string with the name of TSSSP scheme. 647815f1ad5SJed Brown 648815f1ad5SJed Brown Level: beginner 649815f1ad5SJed Brown 650815f1ad5SJed Brown .seealso: TSSSPSetType(), TS 65176bdecfbSBarry Smith J*/ 65219fd82e9SBarry Smith typedef const char* TSSSPType; 653815f1ad5SJed Brown #define TSSSPRKS2 "rks2" 654815f1ad5SJed Brown #define TSSSPRKS3 "rks3" 655815f1ad5SJed Brown #define TSSSPRK104 "rk104" 656815f1ad5SJed Brown 65719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 65819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 659014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 660014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 661787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 662560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 663013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList; 664815f1ad5SJed Brown 665ed657a08SJed Brown /*S 66684df9cb4SJed Brown TSAdapt - Abstract object that manages time-step adaptivity 66784df9cb4SJed Brown 66884df9cb4SJed Brown Level: beginner 66984df9cb4SJed Brown 67084df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType 67184df9cb4SJed Brown S*/ 67284df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt; 67384df9cb4SJed Brown 674f0fc11ceSJed Brown /*J 6758f6c3df8SBarry Smith TSAdaptType - String with the name of TSAdapt scheme. 67684df9cb4SJed Brown 67784df9cb4SJed Brown Level: beginner 67884df9cb4SJed Brown 67984df9cb4SJed Brown .seealso: TSAdaptSetType(), TS 680f0fc11ceSJed Brown J*/ 681f8963224SJed Brown typedef const char *TSAdaptType; 682b0f836d7SJed Brown #define TSADAPTNONE "none" 6831917a363SLisandro Dalcin #define TSADAPTBASIC "basic" 684cb7ab186SLisandro Dalcin #define TSADAPTDSP "dsp" 6858d59e960SJed Brown #define TSADAPTCFL "cfl" 6861917a363SLisandro Dalcin #define TSADAPTGLEE "glee" 687d949e4a4SStefano Zampini #define TSADAPTHISTORY "history" 68884df9cb4SJed Brown 689552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 690bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 691607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 692014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 693014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 69419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 695d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*); 696014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 697014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 698014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 699014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 700014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 701b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*); 702014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 703ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 7044416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt); 705099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 706014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 707014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 708bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool); 7091917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal); 7101917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*); 71176cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptSetMaxIgnore(TSAdapt,PetscReal); 71276cddca1SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSAdaptGetMaxIgnore(TSAdapt,PetscReal*); 7131917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal); 7141917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*); 71562c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptSetScaleSolveFailed(TSAdapt,PetscReal); 71662c23b28SMark PETSC_EXTERN PetscErrorCode TSAdaptGetScaleSolveFailed(TSAdapt,PetscReal*); 717014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 7181917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*); 719b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*)); 720d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool); 72175017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetTrajectory(TSAdapt,TSTrajectory,PetscBool); 72275017583SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistoryGetStep(TSAdapt,PetscInt,PetscReal*,PetscReal*); 723de50f1caSBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetTimeStepIncreaseDelay(TSAdapt,PetscInt); 724cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *); 725cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal); 72684df9cb4SJed Brown 72784df9cb4SJed Brown /*S 72826d28e4eSEmil Constantinescu TSGLLEAdapt - Abstract object that manages time-step adaptivity 729ed657a08SJed Brown 730ed657a08SJed Brown Level: beginner 731ed657a08SJed Brown 73284df9cb4SJed Brown Developer Notes: 73384df9cb4SJed Brown This functionality should be replaced by the TSAdapt. 73484df9cb4SJed Brown 73526d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType 736ed657a08SJed Brown S*/ 73726d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt; 738ed657a08SJed Brown 73976bdecfbSBarry Smith /*J 74026d28e4eSEmil Constantinescu TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme 741ed657a08SJed Brown 742ed657a08SJed Brown Level: beginner 743ed657a08SJed Brown 74426d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS 74576bdecfbSBarry Smith J*/ 74626d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType; 74726d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none" 74826d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size" 74926d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both" 750ed657a08SJed Brown 75126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt)); 75226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void); 75326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void); 75426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*); 75526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType); 75626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]); 75726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 75826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer); 75926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt); 76026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*); 761ed657a08SJed Brown 76276bdecfbSBarry Smith /*J 76326d28e4eSEmil Constantinescu TSGLLEAcceptType - String with the name of TSGLLEAccept scheme 764ed657a08SJed Brown 765ed657a08SJed Brown Level: beginner 766ed657a08SJed Brown 76726d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS 76876bdecfbSBarry Smith J*/ 76926d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType; 77026d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always" 771ed657a08SJed Brown 77226d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 77326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction); 774ed657a08SJed Brown 77576bdecfbSBarry Smith /*J 77626d28e4eSEmil Constantinescu TSGLLEType - family of time integration method within the General Linear class 77718b56cb9SJed Brown 77818b56cb9SJed Brown Level: beginner 77918b56cb9SJed Brown 78026d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister() 78176bdecfbSBarry Smith J*/ 78226d28e4eSEmil Constantinescu typedef const char* TSGLLEType; 78326d28e4eSEmil Constantinescu #define TSGLLE_IRKS "irks" 78418b56cb9SJed Brown 78526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS)); 78626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void); 78726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void); 78826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType); 78926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*); 79026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType); 79118b56cb9SJed Brown 792020d8f30SJed Brown /*J 7937d5697caSHong Zhang TSEIMEXType - String with the name of an Extrapolated IMEX method. 7947d5697caSHong Zhang 7957d5697caSHong Zhang Level: beginner 7967d5697caSHong Zhang 7977d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister() 7987d5697caSHong Zhang J*/ 7997d5697caSHong Zhang #define TSEIMEXType char* 8007d5697caSHong Zhang 8017d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt); 8027d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt); 8037d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool); 8047d5697caSHong Zhang 8057d5697caSHong Zhang /*J 806f68a32c8SEmil Constantinescu TSRKType - String with the name of a Runge-Kutta method. 807f68a32c8SEmil Constantinescu 808f68a32c8SEmil Constantinescu Level: beginner 809f68a32c8SEmil Constantinescu 810f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister() 811f68a32c8SEmil Constantinescu J*/ 812f68a32c8SEmil Constantinescu typedef const char* TSRKType; 813f68a32c8SEmil Constantinescu #define TSRK1FE "1fe" 814fdefd5e5SDebojyoti Ghosh #define TSRK2A "2a" 815f68a32c8SEmil Constantinescu #define TSRK3 "3" 816fdefd5e5SDebojyoti Ghosh #define TSRK3BS "3bs" 817f68a32c8SEmil Constantinescu #define TSRK4 "4" 818fdefd5e5SDebojyoti Ghosh #define TSRK5F "5f" 819fdefd5e5SDebojyoti Ghosh #define TSRK5DP "5dp" 82005e23783SLisandro Dalcin #define TSRK5BS "5bs" 82137acaa02SHendrik Ranocha #define TSRK6VR "6vr" 82237acaa02SHendrik Ranocha #define TSRK7VR "7vr" 82337acaa02SHendrik Ranocha #define TSRK8VR "8vr" 82405e23783SLisandro Dalcin 8252ea87ba9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKGetOrder(TS,PetscInt*); 8260f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetType(TS,TSRKType*); 8270f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKSetType(TS,TSRKType); 8280f7a28cdSStefano Zampini PETSC_EXTERN PetscErrorCode TSRKGetTableau(TS,PetscInt*,const PetscReal**,const PetscReal**,const PetscReal**,const PetscReal**,PetscInt*,const PetscReal**,PetscBool*); 8290fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool); 8300fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*); 831f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 832f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 833560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 834f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 835f68a32c8SEmil Constantinescu 836f68a32c8SEmil Constantinescu /*J 8374b84eec9SHong Zhang TSMPRKType - String with the name of a Partitioned Runge-Kutta method 8389f537349Sluzhanghpp 8399f537349Sluzhanghpp Level: beginner 8409f537349Sluzhanghpp 8414b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister() 8429f537349Sluzhanghpp J*/ 8434b84eec9SHong Zhang typedef const char* TSMPRKType; 84419c2959aSHong Zhang #define TSMPRK2A22 "2a22" 84519c2959aSHong Zhang #define TSMPRK2A23 "2a23" 84619c2959aSHong Zhang #define TSMPRK2A32 "2a32" 84719c2959aSHong Zhang #define TSMPRK2A33 "2a33" 8484b84eec9SHong Zhang #define TSMPRKP2 "p2" 8494b84eec9SHong Zhang #define TSMPRKP3 "p3" 8509f537349Sluzhanghpp 8514b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*); 8524b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType); 85379bc8a77SHong 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[]); 8544b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void); 8554b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void); 8564b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void); 8579f537349Sluzhanghpp 8589f537349Sluzhanghpp /*J 859b6a60446SDebojyoti Ghosh TSGLEEType - String with the name of a General Linear with Error Estimation method. 860b6a60446SDebojyoti Ghosh 861b6a60446SDebojyoti Ghosh Level: beginner 862b6a60446SDebojyoti Ghosh 863b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister() 864b6a60446SDebojyoti Ghosh J*/ 865b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType; 866ab8c5912SEmil Constantinescu #define TSGLEEi1 "BE1" 867b6a60446SDebojyoti Ghosh #define TSGLEE23 "23" 868b6a60446SDebojyoti Ghosh #define TSGLEE24 "24" 869b6a60446SDebojyoti Ghosh #define TSGLEE25I "25i" 870b6a60446SDebojyoti Ghosh #define TSGLEE35 "35" 871b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A "exrk2a" 872b6a60446SDebojyoti Ghosh #define TSGLEERK32G1 "rk32g1" 873b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex" 874b6a60446SDebojyoti Ghosh /*J 875b6a60446SDebojyoti Ghosh TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method. 876b6a60446SDebojyoti Ghosh 877b6a60446SDebojyoti Ghosh Level: beginner 878b6a60446SDebojyoti Ghosh 879b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister() 880b6a60446SDebojyoti Ghosh J*/ 881b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*); 882b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType); 88357df6a1bSDebojyoti 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[]); 884b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void); 885b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void); 886b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void); 887b6a60446SDebojyoti Ghosh 888b6a60446SDebojyoti Ghosh /*J 889020d8f30SJed Brown TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 890020d8f30SJed Brown 891020d8f30SJed Brown Level: beginner 892020d8f30SJed Brown 893020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 894020d8f30SJed Brown J*/ 89519fd82e9SBarry Smith typedef const char* TSARKIMEXType; 896e817cc15SEmil Constantinescu #define TSARKIMEX1BEE "1bee" 8971f80e275SEmil Constantinescu #define TSARKIMEXA2 "a2" 8981f80e275SEmil Constantinescu #define TSARKIMEXL2 "l2" 8991f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122" 9001f80e275SEmil Constantinescu #define TSARKIMEX2C "2c" 9018a381b04SJed Brown #define TSARKIMEX2D "2d" 902a3a57f36SJed Brown #define TSARKIMEX2E "2e" 9036cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2" 9048a381b04SJed Brown #define TSARKIMEX3 "3" 9056cf0794eSJed Brown #define TSARKIMEXBPR3 "bpr3" 9066cf0794eSJed Brown #define TSARKIMEXARS443 "ars443" 9078a381b04SJed Brown #define TSARKIMEX4 "4" 9088a381b04SJed Brown #define TSARKIMEX5 "5" 90919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 91019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 911014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 9123a28c0e5SStefano Zampini PETSC_EXTERN PetscErrorCode TSARKIMEXGetFullyImplicit(TS,PetscBool*); 91319fd82e9SBarry 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[]); 914607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 915560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 916014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 9178a381b04SJed Brown 918020d8f30SJed Brown /*J 919020d8f30SJed Brown TSRosWType - String with the name of a Rosenbrock-W method. 920020d8f30SJed Brown 921020d8f30SJed Brown Level: beginner 922020d8f30SJed Brown 923020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 924020d8f30SJed Brown J*/ 92519fd82e9SBarry Smith typedef const char* TSRosWType; 92661692a83SJed Brown #define TSROSW2M "2m" 92761692a83SJed Brown #define TSROSW2P "2p" 928fe7e6d57SJed Brown #define TSROSWRA3PW "ra3pw" 929fe7e6d57SJed Brown #define TSROSWRA34PW2 "ra34pw2" 930ef3c5b88SJed Brown #define TSROSWRODAS3 "rodas3" 931ef3c5b88SJed Brown #define TSROSWSANDU3 "sandu3" 932961f28d0SJed Brown #define TSROSWASSP3P3S1C "assp3p3s1c" 933961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c" 93443b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 935753f8adbSEmil Constantinescu #define TSROSWARK3 "ark3" 9363606a31eSEmil Constantinescu #define TSROSWTHETA1 "theta1" 9373606a31eSEmil Constantinescu #define TSROSWTHETA2 "theta2" 93842faf41dSJed Brown #define TSROSWGRK4T "grk4t" 93942faf41dSJed Brown #define TSROSWSHAMP4 "shamp4" 94042faf41dSJed Brown #define TSROSWVELDD4 "veldd4" 94142faf41dSJed Brown #define TSROSW4L "4l" 942b1c69cc3SEmil Constantinescu 9436bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*); 9446bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType); 945014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 94619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 94719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 948607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 949560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 950014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 951e27a552bSJed Brown 952211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt); 953211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*); 954211a84d6SLisandro Dalcin 9556bd7aeb5SHong Zhang /*J 956e49d4f37SHong Zhang TSBasicSymplecticType - String with the name of a basic symplectic integration method. 9576bd7aeb5SHong Zhang 9586bd7aeb5SHong Zhang Level: beginner 9596bd7aeb5SHong Zhang 960e49d4f37SHong Zhang .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister() 9616bd7aeb5SHong Zhang J*/ 962e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType; 963e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER "1" 964e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2" 965e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3 "3" 966e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4 "4" 967e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType); 968e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*); 969e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]); 970e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void); 971e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void); 972e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void); 9736bd7aeb5SHong Zhang 97483e2fdc7SBarry Smith /* 9750f3b3ca1SHong Zhang PETSc interface to Sundials 97683e2fdc7SBarry Smith */ 9776dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 9786fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 9796a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 9806fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 9816a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 982014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 983014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 984014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 985014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 986014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 987014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 988014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 989014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 990014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 991014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 992014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 993014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 994c4e80e11SFlorian PETSC_EXTERN PetscErrorCode TSSundialsSetMaxord(TS,PetscInt); 9956dc17ff5SMatthew Knepley #endif 99683e2fdc7SBarry Smith 997014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 998014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 999014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 1000014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 10010de4c49aSJed Brown 1002014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 1003014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 1004014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 100588df8a41SLisandro Dalcin 1006818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal); 1007818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal); 1008818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 1009818efac9SLisandro Dalcin 1010014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 1011014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 10126c699258SBarry Smith 1013014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 1014d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*); 10150f5c6efeSJed Brown 1016f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*); 1017f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*); 1018aad739acSMatthew G. Knepley 10192e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeInitialCondition(TS, PetscErrorCode (**)(TS, Vec)); 10202e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeInitialCondition(TS, PetscErrorCode (*)(TS, Vec)); 10212e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeInitialCondition(TS, Vec); 10222e61be88SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSGetComputeExactError(TS, PetscErrorCode (**)(TS, Vec, Vec)); 1023aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSSetComputeExactError(TS, PetscErrorCode (*)(TS, Vec, Vec)); 1024aad739acSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeExactError(TS, Vec, Vec); 1025*f2ed2dc7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscConvEstUseTS(PetscConvEst, PetscBool); 1026818ad0c1SBarry Smith #endif 1027