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 70a835dfdSSatish Balay #include "petscsnes.h" 8e9fa29b7SSatish Balay PETSC_EXTERN_CXX_BEGIN 9818ad0c1SBarry Smith 10435da068SBarry Smith /*S 11435da068SBarry Smith TS - Abstract PETSc object that manages all time-steppers (ODE integrators) 12435da068SBarry Smith 13435da068SBarry Smith Level: beginner 14435da068SBarry Smith 15435da068SBarry Smith Concepts: ODE solvers 16435da068SBarry Smith 1794b7f48cSBarry Smith .seealso: TSCreate(), TSSetType(), TSType, SNES, KSP, PC 18435da068SBarry Smith S*/ 19f09e8eb9SSatish Balay typedef struct _p_TS* TS; 20435da068SBarry Smith 21435da068SBarry Smith /*E 22435da068SBarry Smith TSType - String with the name of a PETSc TS method or the creation function 23435da068SBarry Smith with an optional dynamic library name, for example 24435da068SBarry Smith http://www.mcs.anl.gov/petsc/lib.a:mytscreate() 25435da068SBarry Smith 26435da068SBarry Smith Level: beginner 27435da068SBarry Smith 28435da068SBarry Smith .seealso: TSSetType(), TS 29435da068SBarry Smith E*/ 30a313700dSBarry Smith #define TSType char* 319596e0b4SJed Brown #define TSEULER "euler" 329596e0b4SJed Brown #define TSBEULER "beuler" 339596e0b4SJed Brown #define TSPSEUDO "pseudo" 344d91e141SJed Brown #define TSCN "cn" 359596e0b4SJed Brown #define TSSUNDIALS "sundials" 364d91e141SJed Brown #define TSRK "rk" 379596e0b4SJed Brown #define TSPYTHON "python" 389596e0b4SJed Brown #define TSTHETA "theta" 3988df8a41SLisandro Dalcin #define TSALPHA "alpha" 409596e0b4SJed Brown #define TSGL "gl" 41ef7bb5aaSJed Brown #define TSSSP "ssp" 428a381b04SJed Brown #define TSARKIMEX "arkimex" 43e27a552bSJed Brown #if defined(PETSC_HAVE_ROSW) 44e27a552bSJed Brown #define TSROSW "rosw" 45e27a552bSJed Brown #endif 4682bf6240SBarry Smith 47435da068SBarry Smith /*E 48435da068SBarry Smith TSProblemType - Determines the type of problem this TS object is to be used to solve 49435da068SBarry Smith 50435da068SBarry Smith Level: beginner 51435da068SBarry Smith 52435da068SBarry Smith .seealso: TSCreate() 53435da068SBarry Smith E*/ 5419bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 55818ad0c1SBarry Smith 56193ac0bcSJed Brown typedef enum { 57193ac0bcSJed Brown TS_CONVERGED_ITERATING = 0, 58193ac0bcSJed Brown TS_CONVERGED_TIME = 1, 59193ac0bcSJed Brown TS_CONVERGED_ITS = 2, 60193ac0bcSJed Brown TS_DIVERGED_NONLINEAR_SOLVE = -1, 61193ac0bcSJed Brown TS_DIVERGED_STEP_REJECTED = -2 62193ac0bcSJed Brown } TSConvergedReason; 63193ac0bcSJed Brown extern const char *const*TSConvergedReasons; 64193ac0bcSJed Brown 65000e7ae3SMatthew Knepley /* Logging support */ 667087cfbeSBarry Smith extern PetscClassId TS_CLASSID; 67000e7ae3SMatthew Knepley 687087cfbeSBarry Smith extern PetscErrorCode TSInitializePackage(const char[]); 698ba1e511SMatthew Knepley 707087cfbeSBarry Smith extern PetscErrorCode TSCreate(MPI_Comm,TS*); 71fcfd50ebSBarry Smith extern PetscErrorCode TSDestroy(TS*); 72818ad0c1SBarry Smith 737087cfbeSBarry Smith extern PetscErrorCode TSSetProblemType(TS,TSProblemType); 747087cfbeSBarry Smith extern PetscErrorCode TSGetProblemType(TS,TSProblemType*); 75c2efdce3SBarry Smith extern PetscErrorCode TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void**)); 767087cfbeSBarry Smith extern PetscErrorCode TSMonitorCancel(TS); 77818ad0c1SBarry Smith 787087cfbeSBarry Smith extern PetscErrorCode TSSetOptionsPrefix(TS,const char[]); 797087cfbeSBarry Smith extern PetscErrorCode TSAppendOptionsPrefix(TS,const char[]); 807087cfbeSBarry Smith extern PetscErrorCode TSGetOptionsPrefix(TS,const char *[]); 817087cfbeSBarry Smith extern PetscErrorCode TSSetFromOptions(TS); 827087cfbeSBarry Smith extern PetscErrorCode TSSetUp(TS); 83277b19d0SLisandro Dalcin extern PetscErrorCode TSReset(TS); 84818ad0c1SBarry Smith 857087cfbeSBarry Smith extern PetscErrorCode TSSetSolution(TS,Vec); 867087cfbeSBarry Smith extern PetscErrorCode TSGetSolution(TS,Vec*); 87818ad0c1SBarry Smith 887087cfbeSBarry Smith extern PetscErrorCode TSSetDuration(TS,PetscInt,PetscReal); 897087cfbeSBarry Smith extern PetscErrorCode TSGetDuration(TS,PetscInt*,PetscReal*); 90a43b19c4SJed Brown extern PetscErrorCode TSSetExactFinalTime(TS,PetscBool); 91818ad0c1SBarry Smith 927087cfbeSBarry Smith extern PetscErrorCode TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*); 937087cfbeSBarry Smith extern PetscErrorCode TSMonitorSolution(TS,PetscInt,PetscReal,Vec,void*); 946083293cSBarry Smith extern PetscErrorCode TSMonitorSolutionCreate(TS,PetscViewer,void**); 956083293cSBarry Smith extern PetscErrorCode TSMonitorSolutionDestroy(void**); 96*fb1732b5SBarry Smith extern PetscErrorCode TSMonitorSolutionBinary(TS,PetscInt,PetscReal,Vec,void*); 97*fb1732b5SBarry Smith 98193ac0bcSJed Brown extern PetscErrorCode TSStep(TS); 995a3a76d0SJed Brown extern PetscErrorCode TSSolve(TS,Vec,PetscReal*); 100193ac0bcSJed Brown extern PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 101818ad0c1SBarry Smith 1027087cfbeSBarry Smith extern PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 1037087cfbeSBarry Smith extern PetscErrorCode TSGetTimeStep(TS,PetscReal*); 1047087cfbeSBarry Smith extern PetscErrorCode TSGetTime(TS,PetscReal*); 1057087cfbeSBarry Smith extern PetscErrorCode TSSetTime(TS,PetscReal); 1067087cfbeSBarry Smith extern PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 1077087cfbeSBarry Smith extern PetscErrorCode TSSetTimeStep(TS,PetscReal); 108818ad0c1SBarry Smith 1092d4b5aceSLisandro Dalcin typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 1102d4b5aceSLisandro Dalcin typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 111089b2837SJed Brown extern PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 112089b2837SJed Brown extern PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 1132d4b5aceSLisandro Dalcin extern PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 114089b2837SJed Brown extern PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 115818ad0c1SBarry Smith 116316643e7SJed Brown typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 117316643e7SJed Brown typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 118089b2837SJed Brown extern PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 119089b2837SJed Brown extern PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 1207087cfbeSBarry Smith extern PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 1217087cfbeSBarry Smith extern PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 122316643e7SJed Brown 1230e4ef248SJed Brown extern PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 1240e4ef248SJed Brown extern PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 1250026cea9SSean Farley extern PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 1260026cea9SSean Farley extern PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 1277087cfbeSBarry Smith extern PetscErrorCode TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 1287087cfbeSBarry Smith extern PetscErrorCode TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 129e34be4c2SBarry Smith 1307087cfbeSBarry Smith extern PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 1317087cfbeSBarry Smith extern PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 1327087cfbeSBarry Smith extern PetscErrorCode TSPreStep(TS); 1337087cfbeSBarry Smith extern PetscErrorCode TSPostStep(TS); 134cd652676SJed Brown extern PetscErrorCode TSSetRetainStages(TS,PetscBool); 135cd652676SJed Brown extern PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 136000e7ae3SMatthew Knepley 1377087cfbeSBarry Smith extern PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 1387087cfbeSBarry Smith extern PetscErrorCode TSPseudoDefaultTimeStep(TS,PetscReal*,void*); 1397087cfbeSBarry Smith extern PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 140d8345c25SBarry Smith 1417087cfbeSBarry Smith extern PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 1427087cfbeSBarry Smith extern PetscErrorCode TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscBool *); 1437087cfbeSBarry Smith extern PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 1447087cfbeSBarry Smith extern PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 1457087cfbeSBarry Smith extern PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 14621c89e3eSBarry Smith 1477087cfbeSBarry Smith extern PetscErrorCode TSPythonSetType(TS,const char[]); 1481d6018f0SLisandro Dalcin 1497087cfbeSBarry Smith extern PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 1507087cfbeSBarry Smith extern PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 151214bc6a2SJed Brown extern PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 152214bc6a2SJed Brown extern PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,PetscBool); 153818ad0c1SBarry Smith 154d6ebe24aSShri Abhyankar extern PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 155d6ebe24aSShri Abhyankar 156bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 157b0a32e0cSBarry Smith extern PetscFList TSList; 158ace3abfcSBarry Smith extern PetscBool TSRegisterAllCalled; 1597087cfbeSBarry Smith extern PetscErrorCode TSGetType(TS,const TSType*); 1607087cfbeSBarry Smith extern PetscErrorCode TSSetType(TS,const TSType); 1617087cfbeSBarry Smith extern PetscErrorCode TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS)); 1627087cfbeSBarry Smith extern PetscErrorCode TSRegisterAll(const char[]); 1637087cfbeSBarry Smith extern PetscErrorCode TSRegisterDestroy(void); 16430de9b25SBarry Smith 16530de9b25SBarry Smith /*MC 16630de9b25SBarry Smith TSRegisterDynamic - Adds a creation method to the TS package. 16730de9b25SBarry Smith 16830de9b25SBarry Smith Synopsis: 1691890ba74SBarry Smith PetscErrorCode TSRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(TS)) 17030de9b25SBarry Smith 17130de9b25SBarry Smith Not Collective 17230de9b25SBarry Smith 17330de9b25SBarry Smith Input Parameters: 17430de9b25SBarry Smith + name - The name of a new user-defined creation routine 17530de9b25SBarry Smith . path - The path (either absolute or relative) of the library containing this routine 17630de9b25SBarry Smith . func_name - The name of the creation routine 17730de9b25SBarry Smith - create_func - The creation routine itself 17830de9b25SBarry Smith 17930de9b25SBarry Smith Notes: 18030de9b25SBarry Smith TSRegisterDynamic() may be called multiple times to add several user-defined tses. 18130de9b25SBarry Smith 18230de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (create_func) is ignored. 18330de9b25SBarry Smith 18430de9b25SBarry Smith Sample usage: 18530de9b25SBarry Smith .vb 18630de9b25SBarry Smith TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate); 18730de9b25SBarry Smith .ve 18830de9b25SBarry Smith 18930de9b25SBarry Smith Then, your ts type can be chosen with the procedural interface via 19030de9b25SBarry Smith .vb 19165f2c13aSKai Germaschewski TS ts; 19265f2c13aSKai Germaschewski TSCreate(MPI_Comm, &ts); 19365f2c13aSKai Germaschewski TSSetType(ts, "my_ts") 19430de9b25SBarry Smith .ve 19530de9b25SBarry Smith or at runtime via the option 19630de9b25SBarry Smith .vb 19730de9b25SBarry Smith -ts_type my_ts 19830de9b25SBarry Smith .ve 19930de9b25SBarry Smith 200ab901514SBarry Smith Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 20130de9b25SBarry Smith If your function is not being put into a shared library then use TSRegister() instead 20230de9b25SBarry Smith 20330de9b25SBarry Smith Level: advanced 20430de9b25SBarry Smith 20530de9b25SBarry Smith .keywords: TS, register 20630de9b25SBarry Smith .seealso: TSRegisterAll(), TSRegisterDestroy() 20730de9b25SBarry Smith M*/ 208aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 209f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 2106df38c32SLois Curfman McInnes #else 211f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 2126df38c32SLois Curfman McInnes #endif 2136df38c32SLois Curfman McInnes 2147087cfbeSBarry Smith extern PetscErrorCode TSGetSNES(TS,SNES*); 2157087cfbeSBarry Smith extern PetscErrorCode TSGetKSP(TS,KSP*); 216818ad0c1SBarry Smith 2177087cfbeSBarry Smith extern PetscErrorCode TSView(TS,PetscViewer); 21821c89e3eSBarry Smith 2197087cfbeSBarry Smith extern PetscErrorCode TSSetApplicationContext(TS,void *); 220e71120c6SJed Brown extern PetscErrorCode TSGetApplicationContext(TS,void *); 22121c89e3eSBarry Smith 2227087cfbeSBarry Smith extern PetscErrorCode TSMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG *); 2237087cfbeSBarry Smith extern PetscErrorCode TSMonitorLG(TS,PetscInt,PetscReal,Vec,void *); 224fcfd50ebSBarry Smith extern PetscErrorCode TSMonitorLGDestroy(PetscDrawLG*); 2253914022bSBarry Smith 226ed657a08SJed Brown /*S 227ed657a08SJed Brown TSGLAdapt - Abstract object that manages time-step adaptivity 228ed657a08SJed Brown 229ed657a08SJed Brown Level: beginner 230ed657a08SJed Brown 231ed657a08SJed Brown .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 232ed657a08SJed Brown S*/ 233ed657a08SJed Brown typedef struct _p_TSGLAdapt *TSGLAdapt; 234ed657a08SJed Brown 235ed657a08SJed Brown /*E 236ed657a08SJed Brown TSGLAdaptType - String with the name of TSGLAdapt scheme or the creation function 237ed657a08SJed Brown with an optional dynamic library name, for example 238ed657a08SJed Brown http://www.mcs.anl.gov/petsc/lib.a:mytsgladaptcreate() 239ed657a08SJed Brown 240ed657a08SJed Brown Level: beginner 241ed657a08SJed Brown 242ed657a08SJed Brown .seealso: TSGLAdaptSetType(), TS 243ed657a08SJed Brown E*/ 244ed657a08SJed Brown #define TSGLAdaptType char* 245ed657a08SJed Brown #define TSGLADAPT_NONE "none" 246ed657a08SJed Brown #define TSGLADAPT_SIZE "size" 247ed657a08SJed Brown #define TSGLADAPT_BOTH "both" 248ed657a08SJed Brown 249ed657a08SJed Brown /*MC 250ed657a08SJed Brown TSGLAdaptRegisterDynamic - adds a TSGLAdapt implementation 251ed657a08SJed Brown 252ed657a08SJed Brown Synopsis: 2531890ba74SBarry Smith PetscErrorCode TSGLAdaptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 254ed657a08SJed Brown 255ed657a08SJed Brown Not Collective 256ed657a08SJed Brown 257ed657a08SJed Brown Input Parameters: 258ed657a08SJed Brown + name_scheme - name of user-defined adaptivity scheme 259ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 260ed657a08SJed Brown . name_create - name of routine to create method context 261ed657a08SJed Brown - routine_create - routine to create method context 262ed657a08SJed Brown 263ed657a08SJed Brown Notes: 264ed657a08SJed Brown TSGLAdaptRegisterDynamic() may be called multiple times to add several user-defined families. 265ed657a08SJed Brown 266ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 267ed657a08SJed Brown is ignored. 268ed657a08SJed Brown 269ed657a08SJed Brown Sample usage: 270ed657a08SJed Brown .vb 271ed657a08SJed Brown TSGLAdaptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 272ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 273ed657a08SJed Brown .ve 274ed657a08SJed Brown 275ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 276ed657a08SJed Brown $ TSGLAdaptSetType(ts,"my_scheme") 277ed657a08SJed Brown or at runtime via the option 278ed657a08SJed Brown $ -ts_adapt_type my_scheme 279ed657a08SJed Brown 280ed657a08SJed Brown Level: advanced 281ed657a08SJed Brown 282ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 283ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 284ed657a08SJed Brown replaced with appropriate values. 285ed657a08SJed Brown 286ed657a08SJed Brown .keywords: TSGLAdapt, register 287ed657a08SJed Brown 288ed657a08SJed Brown .seealso: TSGLAdaptRegisterAll() 289ed657a08SJed Brown M*/ 290ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 291ed657a08SJed Brown # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,0) 292ed657a08SJed Brown #else 293ed657a08SJed Brown # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,d) 294ed657a08SJed Brown #endif 295ed657a08SJed Brown 2967087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptRegister(const char[],const char[],const char[],PetscErrorCode (*)(TSGLAdapt)); 2977087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptRegisterAll(const char[]); 2987087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptRegisterDestroy(void); 2997087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptInitializePackage(const char[]); 3007087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptFinalizePackage(void); 3017087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 3027087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptSetType(TSGLAdapt,const TSGLAdaptType); 3037087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 3047087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 3057087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer); 3067087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptSetFromOptions(TSGLAdapt); 307fcfd50ebSBarry Smith extern PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*); 308ed657a08SJed Brown 309ed657a08SJed Brown /*E 310ed657a08SJed Brown TSGLAcceptType - String with the name of TSGLAccept scheme or the function 311ed657a08SJed Brown with an optional dynamic library name, for example 312ed657a08SJed Brown http://www.mcs.anl.gov/petsc/lib.a:mytsglaccept() 313ed657a08SJed Brown 314ed657a08SJed Brown Level: beginner 315ed657a08SJed Brown 316ed657a08SJed Brown .seealso: TSGLSetAcceptType(), TS 317ed657a08SJed Brown E*/ 318ed657a08SJed Brown #define TSGLAcceptType char* 319ed657a08SJed Brown #define TSGLACCEPT_ALWAYS "always" 320ed657a08SJed Brown 321ace3abfcSBarry Smith typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 3227087cfbeSBarry Smith extern PetscErrorCode TSGLAcceptRegister(const char[],const char[],const char[],TSGLAcceptFunction); 323ed657a08SJed Brown 324ed657a08SJed Brown /*MC 325ed657a08SJed Brown TSGLAcceptRegisterDynamic - adds a TSGL acceptance scheme 326ed657a08SJed Brown 327ed657a08SJed Brown Synopsis: 3281890ba74SBarry Smith PetscErrorCode TSGLAcceptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 329ed657a08SJed Brown 330ed657a08SJed Brown Not Collective 331ed657a08SJed Brown 332ed657a08SJed Brown Input Parameters: 333ed657a08SJed Brown + name_scheme - name of user-defined acceptance scheme 334ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 335ed657a08SJed Brown . name_create - name of routine to create method context 336ed657a08SJed Brown - routine_create - routine to create method context 337ed657a08SJed Brown 338ed657a08SJed Brown Notes: 339ed657a08SJed Brown TSGLAcceptRegisterDynamic() may be called multiple times to add several user-defined families. 340ed657a08SJed Brown 341ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 342ed657a08SJed Brown is ignored. 343ed657a08SJed Brown 344ed657a08SJed Brown Sample usage: 345ed657a08SJed Brown .vb 346ed657a08SJed Brown TSGLAcceptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 347ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 348ed657a08SJed Brown .ve 349ed657a08SJed Brown 350ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 351ed657a08SJed Brown $ TSGLSetAcceptType(ts,"my_scheme") 352ed657a08SJed Brown or at runtime via the option 353ed657a08SJed Brown $ -ts_gl_accept_type my_scheme 354ed657a08SJed Brown 355ed657a08SJed Brown Level: advanced 356ed657a08SJed Brown 357ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 358ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 359ed657a08SJed Brown replaced with appropriate values. 360ed657a08SJed Brown 361ed657a08SJed Brown .keywords: TSGL, TSGLAcceptType, register 362ed657a08SJed Brown 363ed657a08SJed Brown .seealso: TSGLRegisterAll() 364ed657a08SJed Brown M*/ 365ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 366ed657a08SJed Brown # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,0) 367ed657a08SJed Brown #else 368ed657a08SJed Brown # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,d) 369ed657a08SJed Brown #endif 370ed657a08SJed Brown 37118b56cb9SJed Brown /*E 37218b56cb9SJed Brown TSGLType - family of time integration method within the General Linear class 37318b56cb9SJed Brown 37418b56cb9SJed Brown Level: beginner 37518b56cb9SJed Brown 37618b56cb9SJed Brown .seealso: TSGLSetType(), TSGLRegister() 37718b56cb9SJed Brown E*/ 37818b56cb9SJed Brown #define TSGLType char* 379ed657a08SJed Brown #define TSGL_IRKS "irks" 38018b56cb9SJed Brown 381ed657a08SJed Brown /*MC 382ed657a08SJed Brown TSGLRegisterDynamic - adds a TSGL implementation 38318b56cb9SJed Brown 384ed657a08SJed Brown Synopsis: 3851890ba74SBarry Smith PetscErrorCode TSGLRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 386ed657a08SJed Brown 387ed657a08SJed Brown Not Collective 388ed657a08SJed Brown 389ed657a08SJed Brown Input Parameters: 390ed657a08SJed Brown + name_scheme - name of user-defined general linear scheme 391ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 392ed657a08SJed Brown . name_create - name of routine to create method context 393ed657a08SJed Brown - routine_create - routine to create method context 394ed657a08SJed Brown 395ed657a08SJed Brown Notes: 396ed657a08SJed Brown TSGLRegisterDynamic() may be called multiple times to add several user-defined families. 397ed657a08SJed Brown 398ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 399ed657a08SJed Brown is ignored. 400ed657a08SJed Brown 401ed657a08SJed Brown Sample usage: 402ed657a08SJed Brown .vb 403ed657a08SJed Brown TSGLRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 404ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 405ed657a08SJed Brown .ve 406ed657a08SJed Brown 407ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 408ed657a08SJed Brown $ TSGLSetType(ts,"my_scheme") 409ed657a08SJed Brown or at runtime via the option 410ed657a08SJed Brown $ -ts_gl_type my_scheme 411ed657a08SJed Brown 412ed657a08SJed Brown Level: advanced 413ed657a08SJed Brown 414ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 415ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 416ed657a08SJed Brown replaced with appropriate values. 417ed657a08SJed Brown 418ed657a08SJed Brown .keywords: TSGL, register 419ed657a08SJed Brown 420ed657a08SJed Brown .seealso: TSGLRegisterAll() 421ed657a08SJed Brown M*/ 422ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 423ed657a08SJed Brown # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,0) 424ed657a08SJed Brown #else 425ed657a08SJed Brown # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,d) 426ed657a08SJed Brown #endif 427ed657a08SJed Brown 4287087cfbeSBarry Smith extern PetscErrorCode TSGLRegister(const char[],const char[],const char[],PetscErrorCode(*)(TS)); 4297087cfbeSBarry Smith extern PetscErrorCode TSGLRegisterAll(const char[]); 4307087cfbeSBarry Smith extern PetscErrorCode TSGLRegisterDestroy(void); 4317087cfbeSBarry Smith extern PetscErrorCode TSGLInitializePackage(const char[]); 4327087cfbeSBarry Smith extern PetscErrorCode TSGLFinalizePackage(void); 4337087cfbeSBarry Smith extern PetscErrorCode TSGLSetType(TS,const TSGLType); 4347087cfbeSBarry Smith extern PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*); 4357087cfbeSBarry Smith extern PetscErrorCode TSGLSetAcceptType(TS,const TSGLAcceptType); 43618b56cb9SJed Brown 4378a381b04SJed Brown #define TSARKIMEXType char* 4388a381b04SJed Brown #define TSARKIMEX2D "2d" 439a3a57f36SJed Brown #define TSARKIMEX2E "2e" 4408a381b04SJed Brown #define TSARKIMEX3 "3" 4418a381b04SJed Brown #define TSARKIMEX4 "4" 4428a381b04SJed Brown #define TSARKIMEX5 "5" 4438a381b04SJed Brown extern PetscErrorCode TSARKIMEXGetType(TS ts,const TSARKIMEXType*); 4448a381b04SJed Brown extern PetscErrorCode TSARKIMEXSetType(TS ts,const TSARKIMEXType); 4454cc180ffSJed Brown extern PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 446cd652676SJed Brown extern PetscErrorCode TSARKIMEXRegister(const TSARKIMEXType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[],const PetscReal[]); 4478a381b04SJed Brown extern PetscErrorCode TSARKIMEXFinalizePackage(void); 4488a381b04SJed Brown extern PetscErrorCode TSARKIMEXInitializePackage(const char path[]); 4498a381b04SJed Brown extern PetscErrorCode TSARKIMEXRegisterDestroy(void); 4508a381b04SJed Brown extern PetscErrorCode TSARKIMEXRegisterAll(void); 4518a381b04SJed Brown 452e27a552bSJed Brown #if defined(PETSC_HAVE_ROSW) 453e27a552bSJed Brown #define TSRosWType char* 454e27a552bSJed Brown #define TSROSW2D "2d" 455e27a552bSJed Brown #define TSROSW2E "2e" 456e27a552bSJed Brown #define TSROSW3 "3" 457e27a552bSJed Brown #define TSROSW4 "4" 458e27a552bSJed Brown #define TSROSW5 "5" 459e27a552bSJed Brown extern PetscErrorCode TSRosWGetType(TS ts,const TSRosWType*); 460e27a552bSJed Brown extern PetscErrorCode TSRosWSetType(TS ts,const TSRosWType); 461e27a552bSJed Brown extern PetscErrorCode TSRosWSetFullyImplicit(TS,PetscBool); 462e27a552bSJed Brown extern PetscErrorCode TSRosWRegister(const TSRosWType,PetscInt,PetscInt,const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],const PetscReal[],PetscInt,const PetscReal[],const PetscReal[]); 463e27a552bSJed Brown extern PetscErrorCode TSRosWFinalizePackage(void); 464e27a552bSJed Brown extern PetscErrorCode TSRosWInitializePackage(const char path[]); 465e27a552bSJed Brown extern PetscErrorCode TSRosWRegisterDestroy(void); 466e27a552bSJed Brown extern PetscErrorCode TSRosWRegisterAll(void); 467e27a552bSJed Brown #endif 468e27a552bSJed Brown 46983e2fdc7SBarry Smith /* 4700f3b3ca1SHong Zhang PETSc interface to Sundials 47183e2fdc7SBarry Smith */ 4726dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 4736fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 4746fadb2cdSHong Zhang extern const char *TSSundialsLmmTypes[]; 4756fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 476a04cf4d8SBarry Smith extern const char *TSSundialsGramSchmidtTypes[]; 4777087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 4787087cfbeSBarry Smith extern PetscErrorCode TSSundialsGetPC(TS,PC*); 4797087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 4807087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 4817087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 4827087cfbeSBarry Smith extern PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 4837087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 4847087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 4857087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 4867087cfbeSBarry Smith extern PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 4877087cfbeSBarry Smith extern PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 48854c84890SJed Brown extern PetscErrorCode TSSundialsSetMaxl(TS,PetscInt); 4896dc17ff5SMatthew Knepley #endif 49083e2fdc7SBarry Smith 4917087cfbeSBarry Smith extern PetscErrorCode TSRKSetTolerance(TS,PetscReal); 492262ff7bbSBarry Smith 4937087cfbeSBarry Smith extern PetscErrorCode TSThetaSetTheta(TS,PetscReal); 4947087cfbeSBarry Smith extern PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 49526f2ff8fSLisandro Dalcin extern PetscErrorCode TSThetaGetEndpoint(TS,PetscBool*); 496eb284becSJed Brown extern PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 4970de4c49aSJed Brown 4987087cfbeSBarry Smith extern PetscErrorCode TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*); 4997087cfbeSBarry Smith extern PetscErrorCode TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*); 5007087cfbeSBarry Smith extern PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 5017087cfbeSBarry Smith extern PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 5027087cfbeSBarry Smith extern PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 50388df8a41SLisandro Dalcin 5047087cfbeSBarry Smith extern PetscErrorCode TSSetDM(TS,DM); 5057087cfbeSBarry Smith extern PetscErrorCode TSGetDM(TS,DM*); 5066c699258SBarry Smith 5077087cfbeSBarry Smith extern PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 5087087cfbeSBarry Smith extern PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 5090f5c6efeSJed Brown 510e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 511818ad0c1SBarry Smith #endif 512