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" 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, 111193ac0bcSJed Brown TS_DIVERGED_STEP_REJECTED = -2 112193ac0bcSJed Brown } TSConvergedReason; 113014dd563SJed Brown PETSC_EXTERN const char *const*TSConvergedReasons; 1141957e957SBarry Smith 115b93fea0eSJed Brown /*MC 116b93fea0eSJed Brown TS_CONVERGED_ITERATING - this only occurs if TSGetConvergedReason() is called during the TSSolve() 117b93fea0eSJed Brown 118b93fea0eSJed Brown Level: beginner 119b93fea0eSJed Brown 120552698daSJed Brown .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt() 121b93fea0eSJed Brown M*/ 122b93fea0eSJed Brown 123b93fea0eSJed Brown /*MC 124b93fea0eSJed Brown TS_CONVERGED_TIME - the final time was reached 125b93fea0eSJed Brown 126b93fea0eSJed Brown Level: beginner 127b93fea0eSJed Brown 12819eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxTime(), TSGetMaxTime(), TSGetSolveTime() 129b93fea0eSJed Brown M*/ 130b93fea0eSJed Brown 131b93fea0eSJed Brown /*MC 1321957e957SBarry Smith TS_CONVERGED_ITS - the maximum number of iterations (time-steps) was reached prior to the final time 133b93fea0eSJed Brown 134b93fea0eSJed Brown Level: beginner 135b93fea0eSJed Brown 13619eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxSteps(), TSGetMaxSteps() 137b93fea0eSJed Brown M*/ 1381957e957SBarry Smith 139d6ad946cSShri Abhyankar /*MC 140d6ad946cSShri Abhyankar TS_CONVERGED_USER - user requested termination 141d6ad946cSShri Abhyankar 142d6ad946cSShri Abhyankar Level: beginner 143d6ad946cSShri Abhyankar 14419eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason() 145b93fea0eSJed Brown M*/ 146b93fea0eSJed Brown 147b93fea0eSJed Brown /*MC 148d76fc68cSShri Abhyankar TS_CONVERGED_EVENT - user requested termination on event detection 149d76fc68cSShri Abhyankar 150d76fc68cSShri Abhyankar Level: beginner 151d76fc68cSShri Abhyankar 15219eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason() 153d76fc68cSShri Abhyankar M*/ 154d76fc68cSShri Abhyankar 155d76fc68cSShri Abhyankar /*MC 1563118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FRTOL - stops when function norm decreased by a set amount, used only for TSPSEUDO 1573118ae5eSBarry Smith 1583118ae5eSBarry Smith Level: beginner 1593118ae5eSBarry Smith 1603118ae5eSBarry Smith Options Database: 1613118ae5eSBarry Smith . -ts_pseudo_frtol <rtol> 1623118ae5eSBarry Smith 16319eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FATOL 1643118ae5eSBarry Smith M*/ 1653118ae5eSBarry Smith 1663118ae5eSBarry Smith /*MC 1673118ae5eSBarry Smith TS_CONVERGED_PSEUDO_FATOL - stops when function norm decreases below a set amount, used only for TSPSEUDO 1683118ae5eSBarry Smith 1693118ae5eSBarry Smith Level: beginner 1703118ae5eSBarry Smith 1713118ae5eSBarry Smith Options Database: 1723118ae5eSBarry Smith . -ts_pseudo_fatol <atol> 1733118ae5eSBarry Smith 17419eac22cSLisandro Dalcin .seealso: TSSolve(), TSGetConvergedReason(), TSSetConvergedReason(), TS_CONVERGED_PSEUDO_FRTOL 1753118ae5eSBarry Smith M*/ 1763118ae5eSBarry Smith 1773118ae5eSBarry Smith /*MC 178b93fea0eSJed Brown TS_DIVERGED_NONLINEAR_SOLVE - too many nonlinear solves failed 179b93fea0eSJed Brown 180b93fea0eSJed Brown Level: beginner 181b93fea0eSJed Brown 18295452b02SPatrick Sanan Notes: 18395452b02SPatrick Sanan See TSSetMaxSNESFailures() for how to allow more nonlinear solver failures. 1841957e957SBarry Smith 1851957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSGetSNES(), SNESGetConvergedReason(), TSSetMaxSNESFailures() 186b93fea0eSJed Brown M*/ 187b93fea0eSJed Brown 188b93fea0eSJed Brown /*MC 189b93fea0eSJed Brown TS_DIVERGED_STEP_REJECTED - too many steps were rejected 190b93fea0eSJed Brown 191b93fea0eSJed Brown Level: beginner 192b93fea0eSJed Brown 19395452b02SPatrick Sanan Notes: 19495452b02SPatrick Sanan See TSSetMaxStepRejections() for how to allow more step rejections. 1951957e957SBarry Smith 1961957e957SBarry Smith .seealso: TSSolve(), TSGetConvergedReason(), TSGetAdapt(), TSSetMaxStepRejections() 197b93fea0eSJed Brown M*/ 198b93fea0eSJed Brown 199d6ad946cSShri Abhyankar /*E 200d6ad946cSShri Abhyankar TSExactFinalTimeOption - option for handling of final time step 201d6ad946cSShri Abhyankar 202d6ad946cSShri Abhyankar Level: beginner 203d6ad946cSShri Abhyankar 20495452b02SPatrick Sanan Developer Notes: 20595452b02SPatrick Sanan this must match petsc/finclude/petscts.h 206d6ad946cSShri Abhyankar 207d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_STEPOVER - Don't do anything if final time is exceeded 208d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_INTERPOLATE - Interpolate back to final time 209d6ad946cSShri Abhyankar $ TS_EXACTFINALTIME_MATCHSTEP - Adapt final time step to match the final time 210feed9e9dSBarry Smith 211f6953c82SLisandro Dalcin .seealso: TSGetConvergedReason(), TSSetExactFinalTime(), TSGetExactFinalTime() 2124ceb6c04SBarry Smith 213d6ad946cSShri Abhyankar E*/ 214feed9e9dSBarry Smith typedef enum {TS_EXACTFINALTIME_UNSPECIFIED=0,TS_EXACTFINALTIME_STEPOVER=1,TS_EXACTFINALTIME_INTERPOLATE=2,TS_EXACTFINALTIME_MATCHSTEP=3} TSExactFinalTimeOption; 215d6ad946cSShri Abhyankar PETSC_EXTERN const char *const TSExactFinalTimeOptions[]; 216d6ad946cSShri Abhyankar 217000e7ae3SMatthew Knepley /* Logging support */ 218014dd563SJed Brown PETSC_EXTERN PetscClassId TS_CLASSID; 219d74926cbSBarry Smith PETSC_EXTERN PetscClassId DMTS_CLASSID; 2201b9b13dfSLisandro Dalcin PETSC_EXTERN PetscClassId TSADAPT_CLASSID; 221000e7ae3SMatthew Knepley 222607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSInitializePackage(void); 223560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSFinalizePackage(void); 2248ba1e511SMatthew Knepley 225014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSCreate(MPI_Comm,TS*); 226baa10174SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSClone(TS,TS*); 227014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSDestroy(TS*); 228818ad0c1SBarry Smith 229014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetProblemType(TS,TSProblemType); 230014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetProblemType(TS,TSProblemType*); 231014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitor(TS,PetscInt,PetscReal,Vec); 232014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 233721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 234014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorCancel(TS); 235818ad0c1SBarry Smith 236014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 237014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 238014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 239014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetFromOptions(TS); 240014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetUp(TS); 241014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSReset(TS); 242818ad0c1SBarry Smith 243014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetSolution(TS,Vec); 244014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolution(TS,Vec*); 245818ad0c1SBarry Smith 246efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2SetSolution(TS,Vec,Vec); 247efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TS2GetSolution(TS,Vec*,Vec*); 24857df6a1bSDebojyoti Ghosh 249642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetSolutionComponents(TS,PetscInt*,Vec*); 250642f3702SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetAuxSolution(TS,Vec*); 2510a01e1b2SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetTimeError(TS,PetscInt,Vec*); 25257df6a1bSDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetTimeError(TS,Vec); 2536e2e232bSDebojyoti Ghosh 254a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSSetRHSJacobianP(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 255a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianP(TS,PetscReal,Vec,Mat); 256a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 257a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeDRDYFunction(TS,PetscReal,Vec,Vec*); 258a05bf03eSHong Zhang 259bc952696SBarry Smith /*S 260e91eccc2SStefano Zampini TSTrajectory - Abstract PETSc object that stores the trajectory (solution of ODE/DAE at each time step) 261bc952696SBarry Smith 262bc952696SBarry Smith Level: advanced 263bc952696SBarry Smith 2643c0fce88SHong Zhang Concepts: ODE solvers, trajectory 265bc952696SBarry Smith 2661550c9b9SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectorySetType(), TSTrajectoryDestroy(), TSTrajectoryReset() 267bc952696SBarry Smith S*/ 268bc952696SBarry Smith typedef struct _p_TSTrajectory* TSTrajectory; 269bc952696SBarry Smith 270bc952696SBarry Smith /*J 2713c0fce88SHong Zhang TSTrajectorySetType - String with the name of a PETSc TS trajectory storage method 272bc952696SBarry Smith 273bc952696SBarry Smith Level: intermediate 274bc952696SBarry Smith 2753c0fce88SHong Zhang .seealso: TSSetSaveTrajectory(), TSTrajectoryCreate(), TSTrajectoryDestroy() 276bc952696SBarry Smith J*/ 277bc952696SBarry Smith typedef const char* TSTrajectoryType; 278bc952696SBarry Smith #define TSTRAJECTORYBASIC "basic" 2791c8c567eSBarry Smith #define TSTRAJECTORYSINGLEFILE "singlefile" 2809a53571cSHong Zhang #define TSTRAJECTORYMEMORY "memory" 2812b043167SHong Zhang #define TSTRAJECTORYVISUALIZATION "visualization" 282bc952696SBarry Smith 283bc952696SBarry Smith PETSC_EXTERN PetscFunctionList TSTrajectoryList; 284bc952696SBarry Smith PETSC_EXTERN PetscClassId TSTRAJECTORY_CLASSID; 285bc952696SBarry Smith PETSC_EXTERN PetscBool TSTrajectoryRegisterAllCalled; 286bc952696SBarry Smith 287bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSaveTrajectory(TS); 288*2d29f1f2SStefano Zampini PETSC_EXTERN PetscErrorCode TSResetTrajectory(TS); 289bc952696SBarry Smith 290bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryCreate(MPI_Comm,TSTrajectory*); 2919a992471SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryReset(TSTrajectory); 292bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryDestroy(TSTrajectory*); 293560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryView(TSTrajectory,PetscViewer); 294fd9d3c67SJed Brown PETSC_EXTERN PetscErrorCode TSTrajectorySetType(TSTrajectory,TS,TSTrajectoryType); 295bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySet(TSTrajectory,TS,PetscInt,PetscReal,Vec); 296c679fc15SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectoryGet(TSTrajectory,TS,PetscInt,PetscReal*); 297fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetVecs(TSTrajectory,TS,PetscInt,PetscReal*,Vec,Vec); 298fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetUpdatedHistoryVecs(TSTrajectory,TS,PetscReal,Vec*,Vec*); 299fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetNumSteps(TSTrajectory,PetscInt*); 300fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryRestoreUpdatedHistoryVecs(TSTrajectory,Vec*,Vec*); 301972caf09SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFromOptions(TSTrajectory,TS); 302560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSTrajectoryRegister(const char[],PetscErrorCode (*)(TSTrajectory,TS)); 303bc952696SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectoryRegisterAll(void); 30468bece0bSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetUp(TSTrajectory,TS); 3052bee684fSHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetMonitor(TSTrajectory,PetscBool); 30678fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetVariableNames(TSTrajectory,const char * const*); 30708347785SBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetTransform(TSTrajectory,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 308fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectorySetSolutionOnly(TSTrajectory,PetscBool); 309fe8322adSStefano Zampini PETSC_EXTERN PetscErrorCode TSTrajectoryGetSolutionOnly(TSTrajectory,PetscBool*); 31064fc91eeSBarry Smith PETSC_EXTERN PetscErrorCode TSTrajectorySetKeepFiles(TSTrajectory,PetscBool); 31164e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetDirname(TSTrajectory,const char[]); 31264e38db7SHong Zhang PETSC_EXTERN PetscErrorCode TSTrajectorySetFiletemplate(TSTrajectory,const char[]); 31378fbdcc8SBarry Smith PETSC_EXTERN PetscErrorCode TSGetTrajectory(TS,TSTrajectory*); 314bc952696SBarry Smith 315dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSSetCostGradients(TS,PetscInt,Vec*,Vec*); 316dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostGradients(TS,PetscInt*,Vec**,Vec**); 3173d1d12c6SHong Zhang PETSC_EXTERN 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*); 318dfb21088SHong Zhang PETSC_EXTERN PetscErrorCode TSGetCostIntegral(TS,Vec*); 319022c081aSHong Zhang PETSC_EXTERN PetscErrorCode TSComputeCostIntegrand(TS,PetscReal,Vec,Vec); 320d4aa0a58SBarry Smith 321a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointSetFromOptions(PetscOptionItems*,TS); 322a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitor(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*); 323a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*),void *,PetscErrorCode (*)(void**)); 324a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorCancel(TS); 325a05bf03eSHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorSetFromOptions(TS,const char[],const char[],const char[],PetscErrorCode (*)(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat*),PetscErrorCode (*)(TS,PetscViewerAndFormat*)); 326a05bf03eSHong Zhang 3275bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetRHSJacobian(TS,Mat,PetscErrorCode(*)(TS,PetscReal,Vec,Mat,void*),void*); 3282c39e106SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSolve(TS); 32973b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetSteps(TS,PetscInt); 330d4aa0a58SBarry Smith 3315bf8c567SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeRHSJacobian(TS,PetscReal,Vec,Mat); 33273b18844SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointStep(TS); 333f6a906c0SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointSetUp(TS); 334d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDPFunction(TS,PetscReal,Vec,Vec*); 335d4aa0a58SBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointComputeDRDYFunction(TS,PetscReal,Vec,Vec*); 336999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointCostIntegral(TS); 337715f1b00SHong Zhang 33813b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetSensitivities(TS,PetscInt,Mat); 33913b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetSensitivities(TS,PetscInt*,Mat*); 34013b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetIntegralGradients(TS,PetscInt,Vec *); 34113b1b0ffSHong Zhang PETSC_EXTERN PetscErrorCode TSForwardGetIntegralGradients(TS,PetscInt*,Vec **); 342715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetRHSJacobianP(TS,Vec*,PetscErrorCode(*)(TS,PetscReal,Vec,Vec*,void*),void*); 343715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardComputeRHSJacobianP(TS,PetscReal,Vec,Vec*); 344715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardSetUp(TS); 345999a3721SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardCostIntegral(TS); 346715f1b00SHong Zhang PETSC_EXTERN PetscErrorCode TSForwardStep(TS); 347c235aa8dSHong Zhang 348618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxSteps(TS,PetscInt); 349618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxSteps(TS,PetscInt*); 350618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetMaxTime(TS,PetscReal); 351618ce8baSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetMaxTime(TS,PetscReal*); 35249354f04SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetExactFinalTime(TS,TSExactFinalTimeOption); 353f6953c82SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetExactFinalTime(TS,TSExactFinalTimeOption*); 354818ad0c1SBarry Smith 355aaa6c58dSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetTime[Step]") PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 35619eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSSetMax{Steps|Time}") PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 35719eac22cSLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetMax{Steps|Time}") PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 3585c5f5948SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber") PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 3594f4e0956SLisandro Dalcin PETSC_EXTERN PETSC_DEPRECATED("Use TSGetStepNumber") PetscErrorCode TSGetTotalSteps(TS,PetscInt*); 36019eac22cSLisandro Dalcin 361721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 362cc9c3a59SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorExtreme(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 36383a4ac43SBarry Smith 36483a4ac43SBarry Smith typedef struct _n_TSMonitorDrawCtx* TSMonitorDrawCtx; 36583a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorDrawCtx *); 36683a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawCtxDestroy(TSMonitorDrawCtx*); 36783a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolution(TS,PetscInt,PetscReal,Vec,void*); 3682d5ee99bSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionPhase(TS,PetscInt,PetscReal,Vec,void*); 36983a4ac43SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawError(TS,PetscInt,PetscReal,Vec,void*); 3700ed3bfb6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDrawSolutionFunction(TS,PetscInt,PetscReal,Vec,void*); 37183a4ac43SBarry Smith 372721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSAdjointMonitorDefault(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,PetscViewerAndFormat *); 3739110b2e7SHong Zhang PETSC_EXTERN PetscErrorCode TSAdjointMonitorDrawSensi(TS,PetscInt,PetscReal,Vec,PetscInt,Vec*,Vec*,void*); 3749110b2e7SHong Zhang 375721cd6eeSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat*); 376014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTK(TS,PetscInt,PetscReal,Vec,void*); 377014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSMonitorSolutionVTKDestroy(void*); 378fb1732b5SBarry Smith 379014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSStep(TS); 3807cbde773SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSEvaluateWLTE(TS,NormType,PetscInt*,PetscReal*); 381014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSEvaluateStep(TS,PetscInt,Vec,PetscBool*); 382cc708dedSBarry Smith PETSC_EXTERN PetscErrorCode TSSolve(TS,Vec); 383e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGetEquationType(TS,TSEquationType*); 384e817cc15SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSSetEquationType(TS,TSEquationType); 385014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 386d6ad946cSShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetConvergedReason(TS,TSConvergedReason); 387487e0bb9SJed Brown PETSC_EXTERN PetscErrorCode TSGetSolveTime(TS,PetscReal*); 3885ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESIterations(TS,PetscInt*); 3895ef26d82SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSPIterations(TS,PetscInt*); 390cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetStepRejections(TS,PetscInt*); 391cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxStepRejections(TS,PetscInt); 392cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSGetSNESFailures(TS,PetscInt*); 393cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetMaxSNESFailures(TS,PetscInt); 394cef5090cSJed Brown PETSC_EXTERN PetscErrorCode TSSetErrorIfStepFails(TS,PetscBool); 395dcb233daSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRestartStep(TS); 39624655328SShri PETSC_EXTERN PetscErrorCode TSRollBack(TS); 397d2daff3dSHong Zhang 398ff22ae23SHong Zhang PETSC_EXTERN PetscErrorCode TSGetStages(TS,PetscInt*,Vec**); 399818ad0c1SBarry Smith 400014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetTime(TS,PetscReal*); 401014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTime(TS,PetscReal); 402e5e524a1SHong Zhang PETSC_EXTERN PetscErrorCode TSGetPrevTime(TS,PetscReal*); 40380275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetTimeStep(TS,PetscReal*); 40480275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetTimeStep(TS,PetscReal); 40580275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetStepNumber(TS,PetscInt*); 40680275a0aSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetStepNumber(TS,PetscInt); 407818ad0c1SBarry Smith 408638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 409d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat,Mat,void*); 410014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 411014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 412014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 413014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 414e1244c69SJed Brown PETSC_EXTERN PetscErrorCode TSRHSJacobianSetReuse(TS,PetscBool); 415818ad0c1SBarry Smith 416ef20d060SBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSSolutionFunction)(TS,PetscReal,Vec,void*); 417ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode TSSetSolutionFunction(TS,TSSolutionFunction,void*); 418d56366bfSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSForcingFunction)(TS,PetscReal,Vec,void*); 419d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetForcingFunction(TS,TSForcingFunction,void*); 420ef20d060SBarry Smith 421638cfed1SJed Brown PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 422d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 423014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 424014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 425014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 426014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 427316643e7SJed Brown 428efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Function)(TS,PetscReal,Vec,Vec,Vec,Vec,void*); 429efe9872eSLisandro Dalcin PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSI2Jacobian)(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat,void*); 430efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Function(TS,Vec,TSI2Function,void*); 431efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Function(TS,Vec*,TSI2Function*,void**); 432efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetI2Jacobian(TS,Mat,Mat,TSI2Jacobian,void*); 433efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSGetI2Jacobian(TS,Mat*,Mat*,TSI2Jacobian*,void**); 434efe9872eSLisandro Dalcin 435545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetIS(TS,const char[],IS); 436545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetIS(TS,const char[],IS*); 437545aaa6fSHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitSetRHSFunction(TS,const char[],Vec,TSRHSFunction,void*); 4381d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTS(TS,const char[],TS*); 4391d06f6b3SHong Zhang PETSC_EXTERN PetscErrorCode TSRHSSplitGetSubTSs(TS,PetscInt*,TS*[]); 440d9194312SHong Zhang 441014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 442d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat,Mat,void*); 443014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 444d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 4451c8a10a0SJed Brown PETSC_EXTERN PetscErrorCode TSComputeSolutionFunction(TS,PetscReal,Vec); 4469b7cd975SBarry Smith PETSC_EXTERN PetscErrorCode TSComputeForcingFunction(TS,PetscReal,Vec); 447847ff0e1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSComputeIJacobianDefaultColor(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*); 448e34be4c2SBarry Smith 449014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 450b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSSetPreStage(TS, PetscErrorCode (*)(TS,PetscReal)); 4519be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSSetPostStage(TS, PetscErrorCode (*)(TS,PetscReal,PetscInt,Vec*)); 452c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSSetPostEvaluate(TS, PetscErrorCode(*)(TS)); 453014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 454014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPreStep(TS); 455b8123daeSJed Brown PETSC_EXTERN PetscErrorCode TSPreStage(TS,PetscReal); 4569be3e283SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSPostStage(TS,PetscReal,PetscInt,Vec*); 457c688d042SShri Abhyankar PETSC_EXTERN PetscErrorCode TSPostEvaluate(TS); 458014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPostStep(TS); 459014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 460014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetTolerances(TS,PetscReal,Vec,PetscReal,Vec); 461c5033834SJed Brown PETSC_EXTERN PetscErrorCode TSGetTolerances(TS,PetscReal*,Vec*,PetscReal*,Vec*); 4627453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNormInfinity(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 4637453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm2(TS,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 4647453f775SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedNorm(TS,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*); 4658a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENormInfinity(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 4668a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm2(TS,Vec,Vec,Vec,PetscReal*,PetscReal*,PetscReal*); 4678a175baeSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSErrorWeightedENorm(TS,Vec,Vec,Vec,NormType,PetscReal*,PetscReal*,PetscReal*); 468014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetCFLTimeLocal(TS,PetscReal); 469014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetCFLTime(TS,PetscReal*); 470d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSSetFunctionDomainError(TS, PetscErrorCode (*)(TS,PetscReal,Vec,PetscBool*)); 471d183316bSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSFunctionDomainError(TS,PetscReal,Vec,PetscBool*); 472000e7ae3SMatthew Knepley 473014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 4748d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoTimeStepDefault(TS,PetscReal*,void*); 475014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 476014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetMaxTimeStep(TS,PetscReal); 477014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 4788d359177SBarry Smith PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStepDefault(TS,Vec,void*,PetscReal*,PetscBool *); 479014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 480014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 481014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 48221c89e3eSBarry Smith 483014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSPythonSetType(TS,const char[]); 4841d6018f0SLisandro Dalcin 485014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 486d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat,Mat); 487014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 488d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat,Mat,PetscBool); 489efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Function(TS,PetscReal,Vec,Vec,Vec,Vec); 490efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSComputeI2Jacobian(TS,PetscReal,Vec,Vec,Vec,PetscReal,PetscReal,Mat,Mat); 491f9c1d6abSBarry Smith PETSC_EXTERN PetscErrorCode TSComputeLinearStability(TS,PetscReal,PetscReal,PetscReal*,PetscReal*); 492818ad0c1SBarry Smith 493014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 494d6ebe24aSShri Abhyankar 495967bb25aSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetBoundaryLocal(DM, PetscErrorCode (*)(DM, PetscReal, Vec, Vec, void *), void *); 49624989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSFunction(DM,TSRHSFunction,void*); 49724989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSFunction(DM,TSRHSFunction*,void**); 49824989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetRHSJacobian(DM,TSRHSJacobian,void*); 49924989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetRHSJacobian(DM,TSRHSJacobian*,void**); 50024989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunction(DM,TSIFunction,void*); 50124989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIFunction(DM,TSIFunction*,void**); 50224989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobian(DM,TSIJacobian,void*); 50324989b8cSPeter Brune PETSC_EXTERN PetscErrorCode DMTSGetIJacobian(DM,TSIJacobian*,void**); 504efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Function(DM,TSI2Function,void*); 505efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Function(DM,TSI2Function*,void**); 506efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetI2Jacobian(DM,TSI2Jacobian,void*); 507efe9872eSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetI2Jacobian(DM,TSI2Jacobian*,void**); 508efe9872eSLisandro Dalcin 509ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSSetSolutionFunction(DM,TSSolutionFunction,void*); 510ef20d060SBarry Smith PETSC_EXTERN PetscErrorCode DMTSGetSolutionFunction(DM,TSSolutionFunction*,void**); 511d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSSetForcingFunction(DM,TSForcingFunction,void*); 512d56366bfSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMTSGetForcingFunction(DM,TSForcingFunction*,void**); 513924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSGetMinRadius(DM,PetscReal*); 514924a1b8fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetMinRadius(DM,PetscReal); 5150163fd50SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSCheckFromOptions(TS, Vec, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar *, void *), void **); 5169b7cd975SBarry Smith 517d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,Vec,void*),void*); 518d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetIJacobianLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,PetscReal,Mat,Mat,void*),void*); 519d433e6cbSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMTSSetRHSFunctionLocal(DM,PetscErrorCode (*)(DM,PetscReal,Vec,Vec,void*),void*); 5206c6b9e74SPeter Brune 5216c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIFunctionSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5226c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMTSSetIJacobianSerialize(DM,PetscErrorCode (*)(void*,PetscViewer),PetscErrorCode (*)(void**,PetscViewer)); 5236c6b9e74SPeter Brune 5246c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*); 525d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSRHSJacobianLocal)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*); 5266c6b9e74SPeter Brune PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIFunctionLocal)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*); 527d1e9a80fSBarry Smith PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*DMDATSIJacobianLocal)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*); 5286c6b9e74SPeter Brune 5296c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetRHSFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*),void *); 530d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetRHSJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,Mat,Mat,void*),void *); 5316c6b9e74SPeter Brune PETSC_EXTERN PetscErrorCode DMDATSSetIFunctionLocal(DM,InsertMode,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,void*,void*),void *); 532d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode DMDATSSetIJacobianLocal(DM,PetscErrorCode (*)(DMDALocalInfo*,PetscReal,void*,void*,PetscReal,Mat,Mat,void*),void *); 5336c6b9e74SPeter Brune 534b6aca0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMPlexTSGetGeometryFVM(DM,Vec*,Vec*,PetscReal*); 535560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode DMPlexTSGetGradientDM(DM,PetscFV,DM*); 5366dbbd306SMatthew G. Knepley 537be1b0d75SMatthew G. Knepley typedef struct _n_TSMonitorLGCtx* TSMonitorLGCtx; 538d1212d36SBarry Smith typedef struct { 539d1212d36SBarry Smith Vec ray; 540d1212d36SBarry Smith VecScatter scatter; 541d1212d36SBarry Smith PetscViewer viewer; 54251b4a12fSMatthew G. Knepley TSMonitorLGCtx lgctx; 543d1212d36SBarry Smith } TSMonitorDMDARayCtx; 544d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARayDestroy(void**); 545d1212d36SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorDMDARay(TS,PetscInt,PetscReal,Vec,void*); 54651b4a12fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode TSMonitorLGDMDARay(TS,PetscInt,PetscReal,Vec,void*); 547d1212d36SBarry Smith 548bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 549140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList TSList; 55019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSGetType(TS,TSType*); 55119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSetType(TS,TSType); 552bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSRegister(const char[], PetscErrorCode (*)(TS)); 55330de9b25SBarry Smith 554014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetSNES(TS,SNES*); 555deb2cd25SJed Brown PETSC_EXTERN PetscErrorCode TSSetSNES(TS,SNES); 556014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetKSP(TS,KSP*); 557818ad0c1SBarry Smith 558014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSView(TS,PetscViewer); 55955849f57SBarry Smith PETSC_EXTERN PetscErrorCode TSLoad(TS,PetscViewer); 560685405a1SBarry Smith PETSC_STATIC_INLINE PetscErrorCode TSViewFromOptions(TS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 56139c6b90dSHong Zhang PETSC_STATIC_INLINE PetscErrorCode TSTrajectoryViewFromOptions(TSTrajectory A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);} 56255849f57SBarry Smith 56355849f57SBarry Smith #define TS_FILE_CLASSID 1211225 56421c89e3eSBarry Smith 565014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetApplicationContext(TS,void *); 566014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetApplicationContext(TS,void *); 56721c89e3eSBarry Smith 568a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorLGCtx *); 569a9f9c1f6SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxDestroy(TSMonitorLGCtx*); 5704f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGTimeStep(TS,PetscInt,PetscReal,Vec,void *); 5714f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSolution(TS,PetscInt,PetscReal,Vec,void *); 57231152f8aSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetVariableNames(TS,const char * const*); 573b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGGetVariableNames(TS,const char *const **); 574e673d494SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetVariableNames(TSMonitorLGCtx,const char * const *); 575a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetDisplayVariables(TS,const char * const*); 576a66092f1SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetDisplayVariables(TSMonitorLGCtx,const char * const*); 5777684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSetTransform(TS,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void*); 5787684fa3eSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGCtxSetTransform(TSMonitorLGCtx,PetscErrorCode (*)(void*,Vec,Vec*),PetscErrorCode (*)(void*),void *); 5794f09c107SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGError(TS,PetscInt,PetscReal,Vec,void *); 580201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGSNESIterations(TS,PetscInt,PetscReal,Vec,void *); 581201da799SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorLGKSPIterations(TS,PetscInt,PetscReal,Vec,void *); 582edbaebb3SBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorError(TS,PetscInt,PetscReal,Vec,PetscViewerAndFormat *); 583ef20d060SBarry Smith 584b3d3934dSBarry Smith typedef struct _n_TSMonitorEnvelopeCtx* TSMonitorEnvelopeCtx; 585b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxCreate(TS,TSMonitorEnvelopeCtx*); 586b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelope(TS,PetscInt,PetscReal,Vec,void*); 587b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeGetBounds(TS,Vec*,Vec*); 588b3d3934dSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorEnvelopeCtxDestroy(TSMonitorEnvelopeCtx*); 589b3d3934dSBarry Smith 5908189c53fSBarry Smith typedef struct _n_TSMonitorSPEigCtx* TSMonitorSPEigCtx; 5918189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscInt,TSMonitorSPEigCtx *); 5928189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEigCtxDestroy(TSMonitorSPEigCtx*); 5938189c53fSBarry Smith PETSC_EXTERN PetscErrorCode TSMonitorSPEig(TS,PetscInt,PetscReal,Vec,void *); 5943914022bSBarry Smith 5952589fa24SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventHandler(TS,PetscInt,PetscInt[],PetscBool[],PetscErrorCode (*)(TS,PetscReal,Vec,PetscScalar[],void*),PetscErrorCode (*)(TS,PetscInt,PetscInt[],PetscReal,Vec,PetscBool,void*),void*); 5966427ac75SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSetEventTolerances(TS,PetscReal,PetscReal[]); 59776bdecfbSBarry Smith /*J 598815f1ad5SJed Brown TSSSPType - string with the name of TSSSP scheme. 599815f1ad5SJed Brown 600815f1ad5SJed Brown Level: beginner 601815f1ad5SJed Brown 602815f1ad5SJed Brown .seealso: TSSSPSetType(), TS 60376bdecfbSBarry Smith J*/ 60419fd82e9SBarry Smith typedef const char* TSSSPType; 605815f1ad5SJed Brown #define TSSSPRKS2 "rks2" 606815f1ad5SJed Brown #define TSSSPRKS3 "rks3" 607815f1ad5SJed Brown #define TSSSPRK104 "rk104" 608815f1ad5SJed Brown 60919fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPSetType(TS,TSSSPType); 61019fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSSSPGetType(TS,TSSSPType*); 611014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPSetNumStages(TS,PetscInt); 612014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSSPGetNumStages(TS,PetscInt*); 613787849ffSJed Brown PETSC_EXTERN PetscErrorCode TSSSPInitializePackage(void); 614560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSSSPFinalizePackage(void); 615013797aaSBarry Smith PETSC_EXTERN PetscFunctionList TSSSPList; 616815f1ad5SJed Brown 617ed657a08SJed Brown /*S 61884df9cb4SJed Brown TSAdapt - Abstract object that manages time-step adaptivity 61984df9cb4SJed Brown 62084df9cb4SJed Brown Level: beginner 62184df9cb4SJed Brown 62284df9cb4SJed Brown .seealso: TS, TSAdaptCreate(), TSAdaptType 62384df9cb4SJed Brown S*/ 62484df9cb4SJed Brown typedef struct _p_TSAdapt *TSAdapt; 62584df9cb4SJed Brown 62684df9cb4SJed Brown /*E 6278f6c3df8SBarry Smith TSAdaptType - String with the name of TSAdapt scheme. 62884df9cb4SJed Brown 62984df9cb4SJed Brown Level: beginner 63084df9cb4SJed Brown 63184df9cb4SJed Brown .seealso: TSAdaptSetType(), TS 63284df9cb4SJed Brown E*/ 633f8963224SJed Brown typedef const char *TSAdaptType; 634b0f836d7SJed Brown #define TSADAPTNONE "none" 6351917a363SLisandro Dalcin #define TSADAPTBASIC "basic" 636cb7ab186SLisandro Dalcin #define TSADAPTDSP "dsp" 6378d59e960SJed Brown #define TSADAPTCFL "cfl" 6381917a363SLisandro Dalcin #define TSADAPTGLEE "glee" 639d949e4a4SStefano Zampini #define TSADAPTHISTORY "history" 64084df9cb4SJed Brown 641552698daSJed Brown PETSC_EXTERN PetscErrorCode TSGetAdapt(TS,TSAdapt*); 642bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptRegister(const char[],PetscErrorCode (*)(TSAdapt)); 643607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptInitializePackage(void); 644014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptFinalizePackage(void); 645014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCreate(MPI_Comm,TSAdapt*); 64619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetType(TSAdapt,TSAdaptType); 647d0288e4fSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetType(TSAdapt,TSAdaptType*); 648014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetOptionsPrefix(TSAdapt,const char[]); 649014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesClear(TSAdapt); 650014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidateAdd(TSAdapt,const char[],PetscInt,PetscInt,PetscReal,PetscReal,PetscBool); 651014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptCandidatesGet(TSAdapt,PetscInt*,const PetscInt**,const PetscInt**,const PetscReal**,const PetscReal**); 652014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptChoose(TSAdapt,TS,PetscReal,PetscInt*,PetscReal*,PetscBool*); 653b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptCheckStage(TSAdapt,TS,PetscReal,Vec,PetscBool*); 654014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptView(TSAdapt,PetscViewer); 655ad6bc421SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptLoad(TSAdapt,PetscViewer); 6564416b707SBarry Smith PETSC_EXTERN PetscErrorCode TSAdaptSetFromOptions(PetscOptionItems*,TSAdapt); 657099af0a3SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptReset(TSAdapt); 658014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptDestroy(TSAdapt*); 659014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetMonitor(TSAdapt,PetscBool); 660bf997491SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetAlwaysAccept(TSAdapt,PetscBool); 6611917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetSafety(TSAdapt,PetscReal,PetscReal); 6621917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetSafety(TSAdapt,PetscReal*,PetscReal*); 6631917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptSetClip(TSAdapt,PetscReal,PetscReal); 6641917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetClip(TSAdapt,PetscReal*,PetscReal*); 665014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAdaptSetStepLimits(TSAdapt,PetscReal,PetscReal); 6661917a363SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptGetStepLimits(TSAdapt,PetscReal*,PetscReal*); 667b295832fSPierre Barbier de Reuille PETSC_EXTERN PetscErrorCode TSAdaptSetCheckStage(TSAdapt,PetscErrorCode(*)(TSAdapt,TS,PetscReal,Vec,PetscBool*)); 668d949e4a4SStefano Zampini PETSC_EXTERN PetscErrorCode TSAdaptHistorySetHistory(TSAdapt,PetscInt n,PetscReal hist[],PetscBool); 669cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetFilter(TSAdapt,const char *); 670cb7ab186SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAdaptDSPSetPID(TSAdapt,PetscReal,PetscReal,PetscReal); 67184df9cb4SJed Brown 67284df9cb4SJed Brown /*S 67326d28e4eSEmil Constantinescu TSGLLEAdapt - Abstract object that manages time-step adaptivity 674ed657a08SJed Brown 675ed657a08SJed Brown Level: beginner 676ed657a08SJed Brown 67784df9cb4SJed Brown Developer Notes: 67884df9cb4SJed Brown This functionality should be replaced by the TSAdapt. 67984df9cb4SJed Brown 68026d28e4eSEmil Constantinescu .seealso: TSGLLE, TSGLLEAdaptCreate(), TSGLLEAdaptType 681ed657a08SJed Brown S*/ 68226d28e4eSEmil Constantinescu typedef struct _p_TSGLLEAdapt *TSGLLEAdapt; 683ed657a08SJed Brown 68476bdecfbSBarry Smith /*J 68526d28e4eSEmil Constantinescu TSGLLEAdaptType - String with the name of TSGLLEAdapt scheme 686ed657a08SJed Brown 687ed657a08SJed Brown Level: beginner 688ed657a08SJed Brown 68926d28e4eSEmil Constantinescu .seealso: TSGLLEAdaptSetType(), TS 69076bdecfbSBarry Smith J*/ 69126d28e4eSEmil Constantinescu typedef const char *TSGLLEAdaptType; 69226d28e4eSEmil Constantinescu #define TSGLLEADAPT_NONE "none" 69326d28e4eSEmil Constantinescu #define TSGLLEADAPT_SIZE "size" 69426d28e4eSEmil Constantinescu #define TSGLLEADAPT_BOTH "both" 695ed657a08SJed Brown 69626d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptRegister(const char[],PetscErrorCode (*)(TSGLLEAdapt)); 69726d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptInitializePackage(void); 69826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptFinalizePackage(void); 69926d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptCreate(MPI_Comm,TSGLLEAdapt*); 70026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetType(TSGLLEAdapt,TSGLLEAdaptType); 70126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetOptionsPrefix(TSGLLEAdapt,const char[]); 70226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptChoose(TSGLLEAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 70326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptView(TSGLLEAdapt,PetscViewer); 70426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptSetFromOptions(PetscOptionItems*,TSGLLEAdapt); 70526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAdaptDestroy(TSGLLEAdapt*); 706ed657a08SJed Brown 70776bdecfbSBarry Smith /*J 70826d28e4eSEmil Constantinescu TSGLLEAcceptType - String with the name of TSGLLEAccept scheme 709ed657a08SJed Brown 710ed657a08SJed Brown Level: beginner 711ed657a08SJed Brown 71226d28e4eSEmil Constantinescu .seealso: TSGLLESetAcceptType(), TS 71376bdecfbSBarry Smith J*/ 71426d28e4eSEmil Constantinescu typedef const char *TSGLLEAcceptType; 71526d28e4eSEmil Constantinescu #define TSGLLEACCEPT_ALWAYS "always" 716ed657a08SJed Brown 71726d28e4eSEmil Constantinescu PETSC_EXTERN_TYPEDEF typedef PetscErrorCode (*TSGLLEAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 71826d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEAcceptRegister(const char[],TSGLLEAcceptFunction); 719ed657a08SJed Brown 72076bdecfbSBarry Smith /*J 72126d28e4eSEmil Constantinescu TSGLLEType - family of time integration method within the General Linear class 72218b56cb9SJed Brown 72318b56cb9SJed Brown Level: beginner 72418b56cb9SJed Brown 72526d28e4eSEmil Constantinescu .seealso: TSGLLESetType(), TSGLLERegister() 72676bdecfbSBarry Smith J*/ 72726d28e4eSEmil Constantinescu typedef const char* TSGLLEType; 72826d28e4eSEmil Constantinescu #define TSGLLE_IRKS "irks" 72918b56cb9SJed Brown 73026d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLERegister(const char[],PetscErrorCode(*)(TS)); 73126d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEInitializePackage(void); 73226d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEFinalizePackage(void); 73326d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetType(TS,TSGLLEType); 73426d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLEGetAdapt(TS,TSGLLEAdapt*); 73526d28e4eSEmil Constantinescu PETSC_EXTERN PetscErrorCode TSGLLESetAcceptType(TS,TSGLLEAcceptType); 73618b56cb9SJed Brown 737020d8f30SJed Brown /*J 7387d5697caSHong Zhang TSEIMEXType - String with the name of an Extrapolated IMEX method. 7397d5697caSHong Zhang 7407d5697caSHong Zhang Level: beginner 7417d5697caSHong Zhang 7427d5697caSHong Zhang .seealso: TSEIMEXSetType(), TS, TSEIMEX, TSEIMEXRegister() 7437d5697caSHong Zhang J*/ 7447d5697caSHong Zhang #define TSEIMEXType char* 7457d5697caSHong Zhang 7467d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetMaxRows(TS ts,PetscInt); 7477d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetRowCol(TS ts,PetscInt,PetscInt); 7487d5697caSHong Zhang PETSC_EXTERN PetscErrorCode TSEIMEXSetOrdAdapt(TS,PetscBool); 7497d5697caSHong Zhang 7507d5697caSHong Zhang /*J 751f68a32c8SEmil Constantinescu TSRKType - String with the name of a Runge-Kutta method. 752f68a32c8SEmil Constantinescu 753f68a32c8SEmil Constantinescu Level: beginner 754f68a32c8SEmil Constantinescu 755f68a32c8SEmil Constantinescu .seealso: TSRKSetType(), TS, TSRK, TSRKRegister() 756f68a32c8SEmil Constantinescu J*/ 757f68a32c8SEmil Constantinescu typedef const char* TSRKType; 758f68a32c8SEmil Constantinescu #define TSRK1FE "1fe" 759fdefd5e5SDebojyoti Ghosh #define TSRK2A "2a" 760f68a32c8SEmil Constantinescu #define TSRK3 "3" 761fdefd5e5SDebojyoti Ghosh #define TSRK3BS "3bs" 762f68a32c8SEmil Constantinescu #define TSRK4 "4" 763fdefd5e5SDebojyoti Ghosh #define TSRK5F "5f" 764fdefd5e5SDebojyoti Ghosh #define TSRK5DP "5dp" 76505e23783SLisandro Dalcin #define TSRK5BS "5bs" 76605e23783SLisandro Dalcin 767f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKGetType(TS ts,TSRKType*); 768f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetType(TS ts,TSRKType); 769f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKSetFullyImplicit(TS,PetscBool); 770f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegister(TSRKType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 771f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKInitializePackage(void); 772560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRKFinalizePackage(void); 773f68a32c8SEmil Constantinescu PETSC_EXTERN PetscErrorCode TSRKRegisterDestroy(void); 774f68a32c8SEmil Constantinescu 775f68a32c8SEmil Constantinescu /*J 776b6a60446SDebojyoti Ghosh TSGLEEType - String with the name of a General Linear with Error Estimation method. 777b6a60446SDebojyoti Ghosh 778b6a60446SDebojyoti Ghosh Level: beginner 779b6a60446SDebojyoti Ghosh 780b6a60446SDebojyoti Ghosh .seealso: TSGLEESetType(), TS, TSGLEE, TSGLEERegister() 781b6a60446SDebojyoti Ghosh J*/ 782b6a60446SDebojyoti Ghosh typedef const char* TSGLEEType; 783ab8c5912SEmil Constantinescu #define TSGLEEi1 "BE1" 784b6a60446SDebojyoti Ghosh #define TSGLEE23 "23" 785b6a60446SDebojyoti Ghosh #define TSGLEE24 "24" 786b6a60446SDebojyoti Ghosh #define TSGLEE25I "25i" 787b6a60446SDebojyoti Ghosh #define TSGLEE35 "35" 788b6a60446SDebojyoti Ghosh #define TSGLEEEXRK2A "exrk2a" 789b6a60446SDebojyoti Ghosh #define TSGLEERK32G1 "rk32g1" 790b6a60446SDebojyoti Ghosh #define TSGLEERK285EX "rk285ex" 791b6a60446SDebojyoti Ghosh /*J 792b6a60446SDebojyoti Ghosh TSGLEEMode - String with the mode of error estimation for a General Linear with Error Estimation method. 793b6a60446SDebojyoti Ghosh 794b6a60446SDebojyoti Ghosh Level: beginner 795b6a60446SDebojyoti Ghosh 796b6a60446SDebojyoti Ghosh .seealso: TSGLEESetMode(), TS, TSGLEE, TSGLEERegister() 797b6a60446SDebojyoti Ghosh J*/ 798b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEGetType(TS ts,TSGLEEType*); 799b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEESetType(TS ts,TSGLEEType); 80057df6a1bSDebojyoti 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[]); 801b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEFinalizePackage(void); 802b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEEInitializePackage(void); 803b6a60446SDebojyoti Ghosh PETSC_EXTERN PetscErrorCode TSGLEERegisterDestroy(void); 804b6a60446SDebojyoti Ghosh 805b6a60446SDebojyoti Ghosh /*J 806020d8f30SJed Brown TSARKIMEXType - String with the name of an Additive Runge-Kutta IMEX method. 807020d8f30SJed Brown 808020d8f30SJed Brown Level: beginner 809020d8f30SJed Brown 810020d8f30SJed Brown .seealso: TSARKIMEXSetType(), TS, TSARKIMEX, TSARKIMEXRegister() 811020d8f30SJed Brown J*/ 81219fd82e9SBarry Smith typedef const char* TSARKIMEXType; 813e817cc15SEmil Constantinescu #define TSARKIMEX1BEE "1bee" 8141f80e275SEmil Constantinescu #define TSARKIMEXA2 "a2" 8151f80e275SEmil Constantinescu #define TSARKIMEXL2 "l2" 8161f80e275SEmil Constantinescu #define TSARKIMEXARS122 "ars122" 8171f80e275SEmil Constantinescu #define TSARKIMEX2C "2c" 8188a381b04SJed Brown #define TSARKIMEX2D "2d" 819a3a57f36SJed Brown #define TSARKIMEX2E "2e" 8206cf0794eSJed Brown #define TSARKIMEXPRSSP2 "prssp2" 8218a381b04SJed Brown #define TSARKIMEX3 "3" 8226cf0794eSJed Brown #define TSARKIMEXBPR3 "bpr3" 8236cf0794eSJed Brown #define TSARKIMEXARS443 "ars443" 8248a381b04SJed Brown #define TSARKIMEX4 "4" 8258a381b04SJed Brown #define TSARKIMEX5 "5" 82619fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXGetType(TS ts,TSARKIMEXType*); 82719fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXSetType(TS ts,TSARKIMEXType); 828014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 82919fd82e9SBarry 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[]); 830607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSARKIMEXInitializePackage(void); 831560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSARKIMEXFinalizePackage(void); 832014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSARKIMEXRegisterDestroy(void); 8338a381b04SJed Brown 834020d8f30SJed Brown /*J 835020d8f30SJed Brown TSRosWType - String with the name of a Rosenbrock-W method. 836020d8f30SJed Brown 837020d8f30SJed Brown Level: beginner 838020d8f30SJed Brown 839020d8f30SJed Brown .seealso: TSRosWSetType(), TS, TSROSW, TSRosWRegister() 840020d8f30SJed Brown J*/ 84119fd82e9SBarry Smith typedef const char* TSRosWType; 84261692a83SJed Brown #define TSROSW2M "2m" 84361692a83SJed Brown #define TSROSW2P "2p" 844fe7e6d57SJed Brown #define TSROSWRA3PW "ra3pw" 845fe7e6d57SJed Brown #define TSROSWRA34PW2 "ra34pw2" 846ef3c5b88SJed Brown #define TSROSWRODAS3 "rodas3" 847ef3c5b88SJed Brown #define TSROSWSANDU3 "sandu3" 848961f28d0SJed Brown #define TSROSWASSP3P3S1C "assp3p3s1c" 849961f28d0SJed Brown #define TSROSWLASSP3P4S2C "lassp3p4s2c" 85043b21953SEmil Constantinescu #define TSROSWLLSSP3P4S2C "llssp3p4s2c" 851753f8adbSEmil Constantinescu #define TSROSWARK3 "ark3" 8523606a31eSEmil Constantinescu #define TSROSWTHETA1 "theta1" 8533606a31eSEmil Constantinescu #define TSROSWTHETA2 "theta2" 85442faf41dSJed Brown #define TSROSWGRK4T "grk4t" 85542faf41dSJed Brown #define TSROSWSHAMP4 "shamp4" 85642faf41dSJed Brown #define TSROSWVELDD4 "veldd4" 85742faf41dSJed Brown #define TSROSW4L "4l" 858b1c69cc3SEmil Constantinescu 8596bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWGetType(TS,TSRosWType*); 8606bd7aeb5SHong Zhang PETSC_EXTERN PetscErrorCode TSRosWSetType(TS,TSRosWType); 861014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWSetRecomputeJacobian(TS,PetscBool); 86219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegister(TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[]); 86319fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWRegisterRos4(TSRosWType,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 864607a6623SBarry Smith PETSC_EXTERN PetscErrorCode TSRosWInitializePackage(void); 865560360afSLisandro Dalcin PETSC_EXTERN PetscErrorCode TSRosWFinalizePackage(void); 866014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSRosWRegisterDestroy(void); 867e27a552bSJed Brown 868211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFSetOrder(TS,PetscInt); 869211a84d6SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSBDFGetOrder(TS,PetscInt*); 870211a84d6SLisandro Dalcin 8716bd7aeb5SHong Zhang /*J 872e49d4f37SHong Zhang TSBasicSymplecticType - String with the name of a basic symplectic integration method. 8736bd7aeb5SHong Zhang 8746bd7aeb5SHong Zhang Level: beginner 8756bd7aeb5SHong Zhang 876e49d4f37SHong Zhang .seealso: TSBasicSymplecticSetType(), TS, TSBASICSYMPLECTIC, TSBasicSymplecticRegister() 8776bd7aeb5SHong Zhang J*/ 878e49d4f37SHong Zhang typedef const char* TSBasicSymplecticType; 879e49d4f37SHong Zhang #define TSBASICSYMPLECTICSIEULER "1" 880e49d4f37SHong Zhang #define TSBASICSYMPLECTICVELVERLET "2" 881e49d4f37SHong Zhang #define TSBASICSYMPLECTIC3 "3" 882e49d4f37SHong Zhang #define TSBASICSYMPLECTIC4 "4" 883e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticSetType(TS,TSBasicSymplecticType); 884e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticGetType(TS,TSBasicSymplecticType*); 885e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegister(TSBasicSymplecticType,PetscInt,PetscInt,PetscReal[],PetscReal[]); 886e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticInitializePackage(void); 887e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticFinalizePackage(void); 888e49d4f37SHong Zhang PETSC_EXTERN PetscErrorCode TSBasicSymplecticRegisterDestroy(void); 8896bd7aeb5SHong Zhang 89083e2fdc7SBarry Smith /* 8910f3b3ca1SHong Zhang PETSc interface to Sundials 89283e2fdc7SBarry Smith */ 8936dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 8946fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 8956a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsLmmTypes[]; 8966fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 8976a6fc655SJed Brown PETSC_EXTERN const char *const TSSundialsGramSchmidtTypes[]; 898014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 899014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetPC(TS,PC*); 900014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 901014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 902014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 903014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 904014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 905014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 906014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 907014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 908014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 909014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 9106dc17ff5SMatthew Knepley #endif 91183e2fdc7SBarry Smith 912014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetTheta(TS,PetscReal); 913014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 914014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 915014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 9160de4c49aSJed Brown 917014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 918014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 919014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 92088df8a41SLisandro Dalcin 921818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetRadius(TS,PetscReal); 922818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2SetParams(TS,PetscReal,PetscReal,PetscReal,PetscReal); 923818efac9SLisandro Dalcin PETSC_EXTERN PetscErrorCode TSAlpha2GetParams(TS,PetscReal*,PetscReal*,PetscReal*,PetscReal*); 924818efac9SLisandro Dalcin 925014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSSetDM(TS,DM); 926014dd563SJed Brown PETSC_EXTERN PetscErrorCode TSGetDM(TS,DM*); 9276c699258SBarry Smith 928014dd563SJed Brown PETSC_EXTERN PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 929d1e9a80fSBarry Smith PETSC_EXTERN PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat,Mat,void*); 9300f5c6efeSJed Brown 931f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTest(TS,PetscBool*); 932f3b1f45cSBarry Smith PETSC_EXTERN PetscErrorCode TSRHSJacobianTestTranspose(TS,PetscBool*); 933818ad0c1SBarry Smith #endif 934