1818ad0c1SBarry Smith /* 2316643e7SJed Brown User interface for the timestepping package. This package 3f64a0f93SLois Curfman McInnes is for use in solving time-dependent PDEs. 4818ad0c1SBarry Smith */ 50a835dfdSSatish Balay #if !defined(__PETSCTS_H) 60a835dfdSSatish Balay #define __PETSCTS_H 72c8e378dSBarry Smith #include <petscsnes.h> 8818ad0c1SBarry Smith 9435da068SBarry Smith /*S 10435da068SBarry Smith TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 11435da068SBarry Smith 12435da068SBarry Smith Level: beginner 13435da068SBarry Smith 14435da068SBarry Smith Concepts: ODE solvers 15435da068SBarry Smith 168f6c3df8SBarry Smith .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC, TSDestroy() 17435da068SBarry Smith S*/ 18f09e8eb9SSatish Balay typedef struct _p_TS* TS; 19435da068SBarry Smith 2076bdecfbSBarry Smith /*J 218f6c3df8SBarry Smith TSType - String with the name of a PETSc TS method. 22435da068SBarry Smith 23435da068SBarry Smith Level: beginner 24435da068SBarry Smith 258f6c3df8SBarry Smith .seealso: TSSetType(), TS, TSRegister() 2676bdecfbSBarry Smith J*/ 2719fd82e9SBarry Smith typedef const char* TSType; 289596e0b4SJed Brown #define TSEULER "euler" 299596e0b4SJed Brown #define TSBEULER "beuler" 30e49d4f37SHong Zhang #define TSBASICSYMPLECTIC "basicsymplectic" 319596e0b4SJed Brown #define TSPSEUDO "pseudo" 324d91e141SJed Brown #define TSCN "cn" 339596e0b4SJed Brown #define TSSUNDIALS "sundials" 344d91e141SJed Brown #define TSRK "rk" 359596e0b4SJed Brown #define TSPYTHON "python" 369596e0b4SJed Brown #define TSTHETA "theta" 3788df8a41SLisandro Dalcin #define TSALPHA "alpha" 38818efac9SLisandro Dalcin #define TSALPHA2 "alpha2" 3926d28e4eSEmil Constantinescu #define TSGLLE "glle" 40b6a60446SDebojyoti Ghosh #define TSGLEE "glee" 41ef7bb5aaSJed Brown #define TSSSP "ssp" 428a381b04SJed Brown #define TSARKIMEX "arkimex" 43e27a552bSJed Brown #define TSROSW "rosw" 447d5697caSHong Zhang #define TSEIMEX "eimex" 45abadfa0fSMatthew G. Knepley #define TSMIMEX "mimex" 46211a84d6SLisandro Dalcin #define TSBDF "bdf" 47d249a78fSBarry Smith #define TSRADAU5 "radau5" 484b84eec9SHong Zhang #define TSMPRK "mprk" 49211a84d6SLisandro Dalcin 50435da068SBarry Smith /*E 51435da068SBarry Smith TSProblemType - Determines the type of problem this TS object is to be used to solve 52435da068SBarry Smith 53435da068SBarry Smith Level: beginner 54435da068SBarry Smith 55435da068SBarry Smith .seealso: TSCreate() 56435da068SBarry Smith E*/ 5719bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 58818ad0c1SBarry Smith 59b93fea0eSJed Brown /*E 60e817cc15SEmil Constantinescu TSEquationType - type of TS problem that is solved 61e817cc15SEmil Constantinescu 62e817cc15SEmil Constantinescu Level: beginner 63e817cc15SEmil Constantinescu 6495452b02SPatrick Sanan Developer Notes: 6595452b02SPatrick Sanan this must match petsc/finclude/petscts.h 66e817cc15SEmil Constantinescu 67e817cc15SEmil Constantinescu Supported types are: 68e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED (default) 69e817cc15SEmil 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 70e817cc15SEmil Constantinescu TS_EQ_IMPLICIT {ODE and DAE index 1, 2, 3, HI}: F(t,U,U_t) = 0 71e817cc15SEmil Constantinescu 72e817cc15SEmil Constantinescu .seealso: TSGetEquationType(), TSSetEquationType() 73e817cc15SEmil Constantinescu E*/ 74e817cc15SEmil Constantinescu typedef enum { 75e817cc15SEmil Constantinescu TS_EQ_UNSPECIFIED = -1, 76e817cc15SEmil Constantinescu TS_EQ_EXPLICIT = 0, 77e817cc15SEmil Constantinescu TS_EQ_ODE_EXPLICIT = 1, 78e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX1 = 100, 79e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX2 = 200, 80e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEX3 = 300, 81e817cc15SEmil Constantinescu TS_EQ_DAE_SEMI_EXPLICIT_INDEXHI = 500, 82e817cc15SEmil Constantinescu TS_EQ_IMPLICIT = 1000, 83e817cc15SEmil Constantinescu TS_EQ_ODE_IMPLICIT = 1001, 84e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX1 = 1100, 85e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX2 = 1200, 86e817cc15SEmil Constantinescu TS_EQ_DAE_IMPLICIT_INDEX3 = 1300, 8719436ca2SJed Brown TS_EQ_DAE_IMPLICIT_INDEXHI = 1500 88e817cc15SEmil Constantinescu } TSEquationType; 89e817cc15SEmil Constantinescu PETSC_EXTERN const char *const*TSEquationTypes; 90e817cc15SEmil Constantinescu 91e817cc15SEmil Constantinescu /*E 92b93fea0eSJed Brown TSConvergedReason - reason a TS method has converged or not 93b93fea0eSJed Brown 94b93fea0eSJed Brown Level: beginner 95b93fea0eSJed Brown 9695452b02SPatrick Sanan Developer Notes: 9795452b02SPatrick Sanan this must match petsc/finclude/petscts.h 98b93fea0eSJed Brown 99b93fea0eSJed Brown Each reason has its own manual page. 100b93fea0eSJed Brown 101b93fea0eSJed Brown .seealso: TSGetConvergedReason() 102b93fea0eSJed Brown E*/ 103193ac0bcSJed Brown typedef enum { 104193ac0bcSJed Brown TS_CONVERGED_ITERATING = 0, 105193ac0bcSJed Brown TS_CONVERGED_TIME = 1, 106193ac0bcSJed Brown TS_CONVERGED_ITS = 2, 107d6ad946cSShri Abhyankar TS_CONVERGED_USER = 3, 1082b7db910SShri Abhyankar TS_CONVERGED_EVENT = 4, 1093118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FATOL = 5, 1103118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FRTOL = 6, 111193ac0bcSJed Brown TS_DIVERGED_NONLINEAR_SOLVE = -1, 112b5b4017aSHong Zhang TS_DIVERGED_STEP_REJECTED = -2, 11305c9950eSHong Zhang TSFORWARD_DIVERGED_LINEAR_SOLVE = -3, 11405c9950eSHong Zhang TSADJOINT_DIVERGED_LINEAR_SOLVE = -4 115193ac0bcSJed Brown } TSConvergedReason; 116014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons; 1171957e957SBarry Smith 118b93fea0eSJed Brown /*MC 119b93fea0eSJed Brown TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 120b93fea0eSJed Brown 121b93fea0eSJed Brown Level: beginner 122b93fea0eSJed Brown 123552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 124b93fea0eSJed Brown M*/ 125b93fea0eSJed Brown 126b93fea0eSJed Brown /*MC 127b93fea0eSJed Brown TS_CONVERGED_TIME - the final time was reached 128b93fea0eSJed Brown 129b93fea0eSJed Brown Level: beginner 130b93fea0eSJed Brown 13119eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime() 132b93fea0eSJed Brown M*/ 133b93fea0eSJed Brown 134b93fea0eSJed Brown /*MC 1351957e957SBarry Smith TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 136b93fea0eSJed Brown 137b93fea0eSJed Brown Level: beginner 138b93fea0eSJed Brown 13919eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps() 140b93fea0eSJed Brown M*/ 1411957e957SBarry Smith 142d6ad946cSShri Abhyankar /*MC 143d6ad946cSShri Abhyankar TS_CONVERGED_USER - user requested termination 144d6ad946cSShri Abhyankar 145d6ad946cSShri Abhyankar Level: beginner 146d6ad946cSShri Abhyankar 14719eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason() 148b93fea0eSJed Brown M*/ 149b93fea0eSJed Brown 150b93fea0eSJed Brown /*MC 151d76fc68cSShri Abhyankar TS_CONVERGED_EVENT - user requested termination on event detection 152d76fc68cSShri Abhyankar 153d76fc68cSShri Abhyankar Level: beginner 154d76fc68cSShri Abhyankar 15519eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason() 156d76fc68cSShri Abhyankar M*/ 157d76fc68cSShri Abhyankar 158d76fc68cSShri Abhyankar /*MC 1593118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO 1603118ae5eSBarry Smith 1613118ae5eSBarry Smith Level: beginner 1623118ae5eSBarry Smith 1633118ae5eSBarry Smith Options Database: 1643118ae5eSBarry Smith . -ts_pseudo_frtol <rtol> 1653118ae5eSBarry Smith 16619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL 1673118ae5eSBarry Smith M*/ 1683118ae5eSBarry Smith 1693118ae5eSBarry Smith /*MC 1703118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO 1713118ae5eSBarry Smith 1723118ae5eSBarry Smith Level: beginner 1733118ae5eSBarry Smith 1743118ae5eSBarry Smith Options Database: 1753118ae5eSBarry Smith . -ts_pseudo_fatol <atol> 1763118ae5eSBarry Smith 17719eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL 1783118ae5eSBarry Smith M*/ 1793118ae5eSBarry Smith 1803118ae5eSBarry Smith /*MC 181b93fea0eSJed Brown TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 182b93fea0eSJed Brown 183b93fea0eSJed Brown Level: beginner 184b93fea0eSJed Brown 18595452b02SPatrick Sanan Notes: 18695452b02SPatrick Sanan See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures. 1871957e957SBarry Smith 1881957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures() 189b93fea0eSJed Brown M*/ 190b93fea0eSJed Brown 191b93fea0eSJed Brown /*MC 192b93fea0eSJed Brown TS_DIVERGED_STEP_REJECTED - too many steps were rejected 193b93fea0eSJed Brown 194b93fea0eSJed Brown Level: beginner 195b93fea0eSJed Brown 19695452b02SPatrick Sanan Notes: 19795452b02SPatrick Sanan See TSSetMaxStepRejections() for how to allow more step rejections. 1981957e957SBarry Smith 1991957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections() 200b93fea0eSJed Brown M*/ 201b93fea0eSJed Brown 202d6ad946cSShri Abhyankar /*E 203d6ad946cSShri Abhyankar TSExactFinalTimeOption - option for handling of final time step 204d6ad946cSShri Abhyankar 205d6ad946cSShri Abhyankar Level: beginner 206d6ad946cSShri Abhyankar 20795452b02SPatrick Sanan Developer Notes: 20895452b02SPatrick Sanan this must match petsc/finclude/petscts.h 209d6ad946cSShri Abhyankar 210d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 211d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 212d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 213feed9e9dSBarry Smith 214f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime() 2154ceb6c04SBarry Smith 216d6ad946cSShri Abhyankar E*/ 217feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption; 218d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 219d6ad946cSShri Abhyankar 220000e7ae3SMatthew Knepley /* Logging support */ 221014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID; 222d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID; 2231b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID; 224000e7ae3SMatthew Knepley 225607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 226560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void); 2278ba1e511SMatthew Knepley 228014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 229baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*); 230014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 231818ad0c1SBarry Smith 232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 233014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 235014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 236721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 237014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 238818ad0c1SBarry Smith 239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 242014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS); 244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS); 245818ad0c1SBarry Smith 246014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 247014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 248818ad0c1SBarry Smith 249efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec); 250efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*); 25157df6a1bSDebojyoti Ghosh 252642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*); 253642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*); 2540a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*); 25557df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec); 2566e2e232bSDebojyoti Ghosh 257a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 258cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetRHSJacobianP(TS,Mat*,PetscErrorCode(**)(TS,PetscReal,Vec,Mat,void*),void**); 259a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat); 26033f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal,Mat,void*),void*); 26133f72c5dSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIJacobianP(TS,PetscReal,Vec,Vec,PetscReal,Mat,PetscBool); 262a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 263c9ad9de0SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDUFunction(TS,PetscReal,Vec,Vec*); 264b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetIHessianProduct(TS,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 Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 268b5b4017aSHong Zhang void*); 269b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction1(TS,PetscReal,Vec,Vec*,Vec,Vec*); 270b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction2(TS,PetscReal,Vec,Vec*,Vec,Vec*); 271b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction3(TS,PetscReal,Vec,Vec*,Vec,Vec*); 272b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeIHessianProductFunction4(TS,PetscReal,Vec,Vec*,Vec,Vec*); 27313af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSHessianProduct(TS,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 Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,Vec,Vec*,void*), 27713af1a74SHong Zhang void*); 27813af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction1(TS,PetscReal,Vec,Vec*,Vec,Vec*); 27913af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction2(TS,PetscReal,Vec,Vec*,Vec,Vec*); 28013af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction3(TS,PetscReal,Vec,Vec*,Vec,Vec*); 28113af1a74SHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSHessianProductFunction4(TS,PetscReal,Vec,Vec*,Vec,Vec*); 282b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostHessianProducts(TS,PetscInt,Vec*,Vec*,Vec); 283b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostHessianProducts(TS,PetscInt*,Vec**,Vec**,Vec*); 284b5b4017aSHong Zhang 285a05bf03eSHong Zhang 286bc952696SBarry Smith /*S 287e91eccc2SStefano Zampini TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step) 288bc952696SBarry Smith 289bc952696SBarry Smith Level: advanced 290bc952696SBarry Smith 2913c0fce88SHong Zhang Concepts: ODE solvers, trajectory 292bc952696SBarry Smith 2931550c9b9SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset() 294bc952696SBarry Smith S*/ 295bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory; 296bc952696SBarry Smith 297bc952696SBarry Smith /*J 2983c0fce88SHong Zhang TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method 299bc952696SBarry Smith 300bc952696SBarry Smith Level: intermediate 301bc952696SBarry Smith 3023c0fce88SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy() 303bc952696SBarry Smith J*/ 304bc952696SBarry Smith typedef const char* TSTrajectoryType; 305bc952696SBarry Smith #define TSTRAJECTORYBASIC "basic" 3061c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE "singlefile" 3079a53571cSHong Zhang #define TSTRAJECTORYMEMORY "memory" 3082b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization" 309bc952696SBarry Smith 310bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList; 311bc952696SBarry Smith PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 312bc952696SBarry Smith PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 313bc952696SBarry Smith 314bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 3152d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS); 316bc952696SBarry Smith 317bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*); 3189a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory); 319bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*); 320560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer); 321fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType); 322bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec); 323c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*); 324fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec); 325fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*); 326fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*); 327fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*); 328972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS); 329560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS)); 330bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 33168bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS); 3322bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool); 33378fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*); 33408347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 335fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool); 336fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*); 33764fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool); 33864e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]); 33964e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]); 34078fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*); 341bc952696SBarry Smith 342dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*); 343dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**); 344cd4cee2dSHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSCreateQuadratureTS then set up the sub-TS") 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*); 345dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*); 346022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec); 347cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSCreateQuadratureTS(TS,PetscBool,TS*); 348cd4cee2dSHong Zhang PETSC_EXTERN PetscErrorCode TSGetQuadratureTS(TS,PetscBool*,TS*); 349d4aa0a58SBarry Smith 350a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS); 351a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*); 352a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**)); 353a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 354a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 355a05bf03eSHong Zhang 35609830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSSetRHSJacobianP") PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 35709830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSComputeRHSJacobianP") PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat); 35809830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSComputeDRDPFunction") PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 35909830bd6SHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSComputeDRDUFunction") PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*); 3602c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 36173b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt); 362d4aa0a58SBarry Smith 36373b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 364f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 365ece46509SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointReset(TS); 366999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS); 367b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointInitializeForward(TS,Mat); 368715f1b00SHong Zhang 36913b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat); 37013b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*); 371*7207e0fdSHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSCreateQuadratureTS and TSForwardSetSensitivities") PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *); 372*7207e0fdSHong Zhang PETSC_EXTERN PETSC_DEPRECATED("Use TSForwardGetSensitivities") PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **); 373715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*); 374715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*); 375715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS); 3767adebddeSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardReset(TS); 377999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS); 378715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS); 379b5b4017aSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetInitialSensitivities(TS,Mat); 3806affb6f8SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetStages(TS,PetscInt*,Mat**); 381c235aa8dSHong Zhang 382618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt); 383618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*); 384618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal); 385618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*); 38649354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption); 387f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*); 388818ad0c1SBarry Smith 389aaa6c58dSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetTime[Step]") PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 39019eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetMax{Steps|Time}") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 39119eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetMax{Steps|Time}") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 3925c5f5948SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber") PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 3934f4e0956SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber") PetscErrorCode TSGetTotalSteps(TS,PetscInt*); 39419eac22cSLisandro Dalcin 395721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 396cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 39783a4ac43SBarry Smith 39883a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx* TSMonitorDrawCtx; 39983a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *); 40083a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*); 40183a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*); 4022d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*); 40383a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*); 4040ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*); 40583a4ac43SBarry Smith 406721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *); 4079110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*); 4089110b2e7SHong Zhang 409721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 412fb1732b5SBarry Smith 413014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS); 4147cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*); 415014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 416cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec); 417e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*); 418e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType); 419014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 420d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason); 421487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*); 4225ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 4235ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 424cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 425cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 426cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 427cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 428cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 429dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS); 43024655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS); 431d2daff3dSHong Zhang 432ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**); 433818ad0c1SBarry Smith 434014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 435014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 436e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*); 43780275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 43880275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 43980275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*); 44080275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt); 441818ad0c1SBarry Smith 442638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 443d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*); 444cd4cee2dSHong Zhang PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobianP)(TS,PetscReal,Vec,Mat,void*); 445014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 446014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 447014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 448014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 449e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool); 450818ad0c1SBarry Smith 451ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 452ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 453d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*); 454d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*); 455ef20d060SBarry Smith 456638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 457d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 460014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 461014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 462316643e7SJed Brown 463efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*); 464efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*); 465efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*); 466efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**); 467efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*); 468efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**); 469efe9872eSLisandro Dalcin 470545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS); 471545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*); 472545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*); 4731d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*); 4741d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]); 4750fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetUseSplitRHSFunction(TS, PetscBool); 4760fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSGetUseSplitRHSFunction(TS, PetscBool*); 477d9194312SHong Zhang 478014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 479d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*); 480014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 481d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 4821c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 4839b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec); 484847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 485e34be4c2SBarry Smith 486014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 487b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 4889be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*)); 489c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS)); 490014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 491014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS); 492b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 4939be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*); 494c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS); 495014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS); 496014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 497014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 498c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 4997453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 5007453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 5017453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*); 5028a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 5038a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 5048a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*); 505014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 506014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 507d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*)); 508d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*); 509000e7ae3SMatthew Knepley 510014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 5118d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*); 512014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 513014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 514014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 5158d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *); 516014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 517014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 518014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 51921c89e3eSBarry Smith 520014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 5211d6018f0SLisandro Dalcin 522014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 523d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat); 524014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 525d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool); 526efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec); 527efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat); 528f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*); 529818ad0c1SBarry Smith 530014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 531d6ebe24aSShri Abhyankar 532967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 53324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 53424989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 53524989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 53624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 53724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 53824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 53924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 54024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 541efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*); 542efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**); 543efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*); 544efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**); 545efe9872eSLisandro Dalcin 546ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 547ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 548d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*); 549d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**); 550924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*); 551924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal); 5520163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **); 5539b7cd975SBarry Smith 554d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*); 555d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*); 556d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*); 5576c6b9e74SPeter Brune 5586c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5596c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5606c6b9e74SPeter Brune 5616c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 562d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*); 5636c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 564d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*); 5656c6b9e74SPeter Brune 5666c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 567d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *); 5686c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 569d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *); 5706c6b9e74SPeter Brune 571b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 572560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*); 5736dbbd306SMatthew G. Knepley 574be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 575d1212d36SBarry Smith typedef struct { 576d1212d36SBarry Smith Vec ray; 577d1212d36SBarry Smith VecScatter scatter; 578d1212d36SBarry Smith PetscViewer viewer; 57951b4a12fSMatthew G. Knepley TSMonitorLGCtx lgctx; 580d1212d36SBarry Smith } TSMonitorDMDARayCtx; 581d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 582d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 58351b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 584d1212d36SBarry Smith 585bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 586140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList; 58719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 58819fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 589bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 59030de9b25SBarry Smith 591014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 592deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 593014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 594818ad0c1SBarry Smith 595014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 59655849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 597685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 59839c6b90dSHong Zhang PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 59955849f57SBarry Smith 60055849f57SBarry Smith #define TS_FILE_CLASSID 1211225 60121c89e3eSBarry Smith 602014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 603014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 60421c89e3eSBarry Smith 605a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 606a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 6074f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 6084f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 60931152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 610b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **); 611e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *); 612a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 613a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*); 6147684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 6157684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *); 6164f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 617201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 618201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 619edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *); 620ef20d060SBarry Smith 621b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx* TSMonitorEnvelopeCtx; 622b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*); 623b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*); 624b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*); 625b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*); 626b3d3934dSBarry Smith 6278189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 6288189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 6298189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 6308189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 6313914022bSBarry Smith 6321b575b74SJoseph Pusztay typedef struct _n_TSMonitorSPCtx* TSMonitorSPCtx; 6331b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPCtx*); 6341b575b74SJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPCtxDestroy(TSMonitorSPCtx*); 6350ec8ee2bSJoseph Pusztay PETSC_EXTERN PetscErrorCode TSMonitorSPSwarmSolution(TS,PetscInt,PetscReal,Vec,void*); 6361b575b74SJoseph Pusztay 6372589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*); 6380e37a75fSKarl Rupp PETSC_EXTERN PetscErrorCode TSSetPostEventIntervalStep(TS,PetscReal); 6396427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]); 64076bdecfbSBarry Smith /*J 641815f1ad5SJed Brown TSSSPType - string with the name of TSSSP scheme. 642815f1ad5SJed Brown 643815f1ad5SJed Brown Level: beginner 644815f1ad5SJed Brown 645815f1ad5SJed Brown .seealso: TSSSPSetType(), TS 64676bdecfbSBarry Smith J*/ 64719fd82e9SBarry Smith typedef const char* TSSSPType; 648815f1ad5SJed Brown #define TSSSPRKS2 "rks2" 649815f1ad5SJed Brown #define TSSSPRKS3 "rks3" 650815f1ad5SJed Brown #define TSSSPRK104 "rk104" 651815f1ad5SJed Brown 65219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 65319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 654014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 655014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 656787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 657560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 658013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList; 659815f1ad5SJed Brown 660ed657a08SJed Brown /*S 66184df9cb4SJed Brown TSAdapt - Abstract object that manages time-step adaptivity 66284df9cb4SJed Brown 66384df9cb4SJed Brown Level: beginner 66484df9cb4SJed Brown 66584df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType 66684df9cb4SJed Brown S*/ 66784df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt; 66884df9cb4SJed Brown 66984df9cb4SJed Brown /*E 6708f6c3df8SBarry Smith TSAdaptType - String with the name of TSAdapt scheme. 67184df9cb4SJed Brown 67284df9cb4SJed Brown Level: beginner 67384df9cb4SJed Brown 67484df9cb4SJed Brown .seealso: TSAdaptSetType(), TS 67584df9cb4SJed Brown E*/ 676f8963224SJed Brown typedef const char *TSAdaptType; 677b0f836d7SJed Brown #define TSADAPTNONE "none" 6781917a363SLisandro Dalcin #define TSADAPTBASIC "basic" 679cb7ab186SLisandro Dalcin #define TSADAPTDSP "dsp" 6808d59e960SJed Brown #define TSADAPTCFL "cfl" 6811917a363SLisandro Dalcin #define TSADAPTGLEE "glee" 682d949e4a4SStefano Zampini #define TSADAPTHISTORY "history" 68384df9cb4SJed Brown 684552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 685bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 686607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 687014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 688014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 68919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 690d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*); 691014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 692014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 693014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 694014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 695014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 696b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*); 697014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 698ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 6994416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt); 700099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 701014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 702014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 703bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool); 7041917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal); 7051917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,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" 81205e23783SLisandro Dalcin 813f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*); 814f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType); 8150fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKSetMultirate(TS,PetscBool); 8160fe4d17eSHong Zhang PETSC_EXTERN PetscErrorCode TSRKGetMultirate(TS,PetscBool*); 817f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool); 818f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 819f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 820560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 821f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 822f68a32c8SEmil Constantinescu 823f68a32c8SEmil Constantinescu /*J 8244b84eec9SHong Zhang TSMPRKType - String with the name of a Partitioned Runge-Kutta method 8259f537349Sluzhanghpp 8269f537349Sluzhanghpp Level: beginner 8279f537349Sluzhanghpp 8284b84eec9SHong Zhang .seealso: TSMPRKSetType(), TS, TSMPRK, TSMPRKRegister() 8299f537349Sluzhanghpp J*/ 8304b84eec9SHong Zhang typedef const char* TSMPRKType; 83119c2959aSHong Zhang #define TSMPRK2A22 "2a22" 83219c2959aSHong Zhang #define TSMPRK2A23 "2a23" 83319c2959aSHong Zhang #define TSMPRK2A32 "2a32" 83419c2959aSHong Zhang #define TSMPRK2A33 "2a33" 8354b84eec9SHong Zhang #define TSMPRKP2 "p2" 8364b84eec9SHong Zhang #define TSMPRKP3 "p3" 8379f537349Sluzhanghpp 8384b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKGetType(TS ts,TSMPRKType*); 8394b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKSetType(TS ts,TSMPRKType); 84079bc8a77SHong 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[]); 8414b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKInitializePackage(void); 8424b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKFinalizePackage(void); 8434b84eec9SHong Zhang PETSC_EXTERN PetscErrorCode TSMPRKRegisterDestroy(void); 8449f537349Sluzhanghpp 8459f537349Sluzhanghpp /*J 846b6a60446SDebojyoti Ghosh TSGLEEType - String with the name of a General Linear with Error Estimation method. 847b6a60446SDebojyoti Ghosh 848b6a60446SDebojyoti Ghosh Level: beginner 849b6a60446SDebojyoti Ghosh 850b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister() 851b6a60446SDebojyoti Ghosh J*/ 852b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType; 853ab8c5912SEmil Constantinescu #define TSGLEEi1 "BE1" 854b6a60446SDebojyoti Ghosh #define TSGLEE23 "23" 855b6a60446SDebojyoti Ghosh #define TSGLEE24 "24" 856b6a60446SDebojyoti Ghosh #define TSGLEE25I "25i" 857b6a60446SDebojyoti Ghosh #define TSGLEE35 "35" 858b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A "exrk2a" 859b6a60446SDebojyoti Ghosh #define TSGLEERK32G1 "rk32g1" 860b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex" 861b6a60446SDebojyoti Ghosh /*J 862b6a60446SDebojyoti Ghosh TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method. 863b6a60446SDebojyoti Ghosh 864b6a60446SDebojyoti Ghosh Level: beginner 865b6a60446SDebojyoti Ghosh 866b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister() 867b6a60446SDebojyoti Ghosh J*/ 868b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*); 869b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType); 87057df6a1bSDebojyoti 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[]); 871b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void); 872b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void); 873b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void); 874b6a60446SDebojyoti Ghosh 875b6a60446SDebojyoti Ghosh /*J 876020d8f30SJed Brown TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 877020d8f30SJed Brown 878020d8f30SJed Brown Level: beginner 879020d8f30SJed Brown 880020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 881020d8f30SJed Brown J*/ 88219fd82e9SBarry Smith typedef const char* TSARKIMEXType; 883e817cc15SEmil Constantinescu #define TSARKIMEX1BEE "1bee" 8841f80e275SEmil Constantinescu #define TSARKIMEXA2 "a2" 8851f80e275SEmil Constantinescu #define TSARKIMEXL2 "l2" 8861f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122" 8871f80e275SEmil Constantinescu #define TSARKIMEX2C "2c" 8888a381b04SJed Brown #define TSARKIMEX2D "2d" 889a3a57f36SJed Brown #define TSARKIMEX2E "2e" 8906cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2" 8918a381b04SJed Brown #define TSARKIMEX3 "3" 8926cf0794eSJed Brown #define TSARKIMEXBPR3 "bpr3" 8936cf0794eSJed Brown #define TSARKIMEXARS443 "ars443" 8948a381b04SJed Brown #define TSARKIMEX4 "4" 8958a381b04SJed Brown #define TSARKIMEX5 "5" 89619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 89719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 898014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 89919fd82e9SBarry 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[]); 900607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 901560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 902014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 9038a381b04SJed Brown 904020d8f30SJed Brown /*J 905020d8f30SJed Brown TSRosWType - String with the name of a Rosenbrock-W method. 906020d8f30SJed Brown 907020d8f30SJed Brown Level: beginner 908020d8f30SJed Brown 909020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 910020d8f30SJed Brown J*/ 91119fd82e9SBarry Smith typedef const char* TSRosWType; 91261692a83SJed Brown #define TSROSW2M "2m" 91361692a83SJed Brown #define TSROSW2P "2p" 914fe7e6d57SJed Brown #define TSROSWRA3PW "ra3pw" 915fe7e6d57SJed Brown #define TSROSWRA34PW2 "ra34pw2" 916ef3c5b88SJed Brown #define TSROSWRODAS3 "rodas3" 917ef3c5b88SJed Brown #define TSROSWSANDU3 "sandu3" 918961f28d0SJed Brown #define TSROSWASSP3P3S1C "assp3p3s1c" 919961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c" 92043b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 921753f8adbSEmil Constantinescu #define TSROSWARK3 "ark3" 9223606a31eSEmil Constantinescu #define TSROSWTHETA1 "theta1" 9233606a31eSEmil Constantinescu #define TSROSWTHETA2 "theta2" 92442faf41dSJed Brown #define TSROSWGRK4T "grk4t" 92542faf41dSJed Brown #define TSROSWSHAMP4 "shamp4" 92642faf41dSJed Brown #define TSROSWVELDD4 "veldd4" 92742faf41dSJed Brown #define TSROSW4L "4l" 928b1c69cc3SEmil Constantinescu 9296bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*); 9306bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType); 931014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 93219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 93319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 934607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 935560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 936014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 937e27a552bSJed Brown 938211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt); 939211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*); 940211a84d6SLisandro Dalcin 9416bd7aeb5SHong Zhang /*J 942e49d4f37SHong Zhang TSBasicSymplecticType - String with the name of a basic symplectic integration method. 9436bd7aeb5SHong Zhang 9446bd7aeb5SHong Zhang Level: beginner 9456bd7aeb5SHong Zhang 946e49d4f37SHong Zhang .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister() 9476bd7aeb5SHong Zhang J*/ 948e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType; 949e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER "1" 950e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2" 951e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3 "3" 952e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4 "4" 953e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType); 954e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*); 955e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]); 956e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void); 957e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void); 958e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void); 9596bd7aeb5SHong Zhang 96083e2fdc7SBarry Smith /* 9610f3b3ca1SHong Zhang PETSc interface to Sundials 96283e2fdc7SBarry Smith */ 9636dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 9646fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 9656a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 9666fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 9676a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 968014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 969014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 970014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 971014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 972014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 973014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 974014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 975014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 976014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 977014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 978014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 979014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 9806dc17ff5SMatthew Knepley #endif 98183e2fdc7SBarry Smith 982014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 983014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 984014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 985014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 9860de4c49aSJed Brown 987014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 988014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 989014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 99088df8a41SLisandro Dalcin 991818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal); 992818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal); 993818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 994818efac9SLisandro Dalcin 995014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 996014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 9976c699258SBarry Smith 998014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 999d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*); 10000f5c6efeSJed Brown 1001f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*); 1002f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*); 1003818ad0c1SBarry Smith #endif 1004