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" 43*e27a552bSJed Brown #if defined(PETSC_HAVE_ROSW) 44*e27a552bSJed Brown #define TSROSW "rosw" 45*e27a552bSJed 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**); 96193ac0bcSJed Brown extern PetscErrorCode TSStep(TS); 975a3a76d0SJed Brown extern PetscErrorCode TSSolve(TS,Vec,PetscReal*); 98193ac0bcSJed Brown extern PetscErrorCode TSGetConvergedReason(TS,TSConvergedReason*); 99818ad0c1SBarry Smith 1007087cfbeSBarry Smith extern PetscErrorCode TSSetInitialTimeStep(TS,PetscReal,PetscReal); 1017087cfbeSBarry Smith extern PetscErrorCode TSGetTimeStep(TS,PetscReal*); 1027087cfbeSBarry Smith extern PetscErrorCode TSGetTime(TS,PetscReal*); 1037087cfbeSBarry Smith extern PetscErrorCode TSSetTime(TS,PetscReal); 1047087cfbeSBarry Smith extern PetscErrorCode TSGetTimeStepNumber(TS,PetscInt*); 1057087cfbeSBarry Smith extern PetscErrorCode TSSetTimeStep(TS,PetscReal); 106818ad0c1SBarry Smith 1072d4b5aceSLisandro Dalcin typedef PetscErrorCode (*TSRHSFunction)(TS,PetscReal,Vec,Vec,void*); 1082d4b5aceSLisandro Dalcin typedef PetscErrorCode (*TSRHSJacobian)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 109089b2837SJed Brown extern PetscErrorCode TSSetRHSFunction(TS,Vec,TSRHSFunction,void*); 110089b2837SJed Brown extern PetscErrorCode TSGetRHSFunction(TS,Vec*,TSRHSFunction*,void**); 1112d4b5aceSLisandro Dalcin extern PetscErrorCode TSSetRHSJacobian(TS,Mat,Mat,TSRHSJacobian,void*); 112089b2837SJed Brown extern PetscErrorCode TSGetRHSJacobian(TS,Mat*,Mat*,TSRHSJacobian*,void**); 113818ad0c1SBarry Smith 114316643e7SJed Brown typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 115316643e7SJed Brown typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 116089b2837SJed Brown extern PetscErrorCode TSSetIFunction(TS,Vec,TSIFunction,void*); 117089b2837SJed Brown extern PetscErrorCode TSGetIFunction(TS,Vec*,TSIFunction*,void**); 1187087cfbeSBarry Smith extern PetscErrorCode TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 1197087cfbeSBarry Smith extern PetscErrorCode TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 120316643e7SJed Brown 1210e4ef248SJed Brown extern PetscErrorCode TSComputeRHSFunctionLinear(TS,PetscReal,Vec,Vec,void*); 1220e4ef248SJed Brown extern PetscErrorCode TSComputeRHSJacobianConstant(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 1230026cea9SSean Farley extern PetscErrorCode TSComputeIFunctionLinear(TS,PetscReal,Vec,Vec,Vec,void*); 1240026cea9SSean Farley extern PetscErrorCode TSComputeIJacobianConstant(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 1257087cfbeSBarry Smith extern PetscErrorCode TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 1267087cfbeSBarry Smith extern PetscErrorCode TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 127e34be4c2SBarry Smith 1287087cfbeSBarry Smith extern PetscErrorCode TSSetPreStep(TS, PetscErrorCode (*)(TS)); 1297087cfbeSBarry Smith extern PetscErrorCode TSSetPostStep(TS, PetscErrorCode (*)(TS)); 1307087cfbeSBarry Smith extern PetscErrorCode TSPreStep(TS); 1317087cfbeSBarry Smith extern PetscErrorCode TSPostStep(TS); 132cd652676SJed Brown extern PetscErrorCode TSSetRetainStages(TS,PetscBool); 133cd652676SJed Brown extern PetscErrorCode TSInterpolate(TS,PetscReal,Vec); 134000e7ae3SMatthew Knepley 1357087cfbeSBarry Smith extern PetscErrorCode TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 1367087cfbeSBarry Smith extern PetscErrorCode TSPseudoDefaultTimeStep(TS,PetscReal*,void*); 1377087cfbeSBarry Smith extern PetscErrorCode TSPseudoComputeTimeStep(TS,PetscReal *); 138d8345c25SBarry Smith 1397087cfbeSBarry Smith extern PetscErrorCode TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 1407087cfbeSBarry Smith extern PetscErrorCode TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscBool *); 1417087cfbeSBarry Smith extern PetscErrorCode TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 1427087cfbeSBarry Smith extern PetscErrorCode TSPseudoSetTimeStepIncrement(TS,PetscReal); 1437087cfbeSBarry Smith extern PetscErrorCode TSPseudoIncrementDtFromInitialDt(TS); 14421c89e3eSBarry Smith 1457087cfbeSBarry Smith extern PetscErrorCode TSPythonSetType(TS,const char[]); 1461d6018f0SLisandro Dalcin 1477087cfbeSBarry Smith extern PetscErrorCode TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 1487087cfbeSBarry Smith extern PetscErrorCode TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 149214bc6a2SJed Brown extern PetscErrorCode TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec,PetscBool); 150214bc6a2SJed Brown extern PetscErrorCode TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,PetscBool); 151818ad0c1SBarry Smith 152d6ebe24aSShri Abhyankar extern PetscErrorCode TSVISetVariableBounds(TS,Vec,Vec); 153d6ebe24aSShri Abhyankar 154bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 155b0a32e0cSBarry Smith extern PetscFList TSList; 156ace3abfcSBarry Smith extern PetscBool TSRegisterAllCalled; 1577087cfbeSBarry Smith extern PetscErrorCode TSGetType(TS,const TSType*); 1587087cfbeSBarry Smith extern PetscErrorCode TSSetType(TS,const TSType); 1597087cfbeSBarry Smith extern PetscErrorCode TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS)); 1607087cfbeSBarry Smith extern PetscErrorCode TSRegisterAll(const char[]); 1617087cfbeSBarry Smith extern PetscErrorCode TSRegisterDestroy(void); 16230de9b25SBarry Smith 16330de9b25SBarry Smith /*MC 16430de9b25SBarry Smith TSRegisterDynamic - Adds a creation method to the TS package. 16530de9b25SBarry Smith 16630de9b25SBarry Smith Synopsis: 1671890ba74SBarry Smith PetscErrorCode TSRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(TS)) 16830de9b25SBarry Smith 16930de9b25SBarry Smith Not Collective 17030de9b25SBarry Smith 17130de9b25SBarry Smith Input Parameters: 17230de9b25SBarry Smith + name - The name of a new user-defined creation routine 17330de9b25SBarry Smith . path - The path (either absolute or relative) of the library containing this routine 17430de9b25SBarry Smith . func_name - The name of the creation routine 17530de9b25SBarry Smith - create_func - The creation routine itself 17630de9b25SBarry Smith 17730de9b25SBarry Smith Notes: 17830de9b25SBarry Smith TSRegisterDynamic() may be called multiple times to add several user-defined tses. 17930de9b25SBarry Smith 18030de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (create_func) is ignored. 18130de9b25SBarry Smith 18230de9b25SBarry Smith Sample usage: 18330de9b25SBarry Smith .vb 18430de9b25SBarry Smith TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate); 18530de9b25SBarry Smith .ve 18630de9b25SBarry Smith 18730de9b25SBarry Smith Then, your ts type can be chosen with the procedural interface via 18830de9b25SBarry Smith .vb 18965f2c13aSKai Germaschewski TS ts; 19065f2c13aSKai Germaschewski TSCreate(MPI_Comm, &ts); 19165f2c13aSKai Germaschewski TSSetType(ts, "my_ts") 19230de9b25SBarry Smith .ve 19330de9b25SBarry Smith or at runtime via the option 19430de9b25SBarry Smith .vb 19530de9b25SBarry Smith -ts_type my_ts 19630de9b25SBarry Smith .ve 19730de9b25SBarry Smith 198ab901514SBarry Smith Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 19930de9b25SBarry Smith If your function is not being put into a shared library then use TSRegister() instead 20030de9b25SBarry Smith 20130de9b25SBarry Smith Level: advanced 20230de9b25SBarry Smith 20330de9b25SBarry Smith .keywords: TS, register 20430de9b25SBarry Smith .seealso: TSRegisterAll(), TSRegisterDestroy() 20530de9b25SBarry Smith M*/ 206aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 207f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 2086df38c32SLois Curfman McInnes #else 209f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 2106df38c32SLois Curfman McInnes #endif 2116df38c32SLois Curfman McInnes 2127087cfbeSBarry Smith extern PetscErrorCode TSGetSNES(TS,SNES*); 2137087cfbeSBarry Smith extern PetscErrorCode TSGetKSP(TS,KSP*); 214818ad0c1SBarry Smith 2157087cfbeSBarry Smith extern PetscErrorCode TSView(TS,PetscViewer); 21621c89e3eSBarry Smith 2177087cfbeSBarry Smith extern PetscErrorCode TSSetApplicationContext(TS,void *); 218e71120c6SJed Brown extern PetscErrorCode TSGetApplicationContext(TS,void *); 21921c89e3eSBarry Smith 2207087cfbeSBarry Smith extern PetscErrorCode TSMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG *); 2217087cfbeSBarry Smith extern PetscErrorCode TSMonitorLG(TS,PetscInt,PetscReal,Vec,void *); 222fcfd50ebSBarry Smith extern PetscErrorCode TSMonitorLGDestroy(PetscDrawLG*); 2233914022bSBarry Smith 224ed657a08SJed Brown /*S 225ed657a08SJed Brown TSGLAdapt - Abstract object that manages time-step adaptivity 226ed657a08SJed Brown 227ed657a08SJed Brown Level: beginner 228ed657a08SJed Brown 229ed657a08SJed Brown .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 230ed657a08SJed Brown S*/ 231ed657a08SJed Brown typedef struct _p_TSGLAdapt *TSGLAdapt; 232ed657a08SJed Brown 233ed657a08SJed Brown /*E 234ed657a08SJed Brown TSGLAdaptType - String with the name of TSGLAdapt scheme or the creation function 235ed657a08SJed Brown with an optional dynamic library name, for example 236ed657a08SJed Brown http://www.mcs.anl.gov/petsc/lib.a:mytsgladaptcreate() 237ed657a08SJed Brown 238ed657a08SJed Brown Level: beginner 239ed657a08SJed Brown 240ed657a08SJed Brown .seealso: TSGLAdaptSetType(), TS 241ed657a08SJed Brown E*/ 242ed657a08SJed Brown #define TSGLAdaptType char* 243ed657a08SJed Brown #define TSGLADAPT_NONE "none" 244ed657a08SJed Brown #define TSGLADAPT_SIZE "size" 245ed657a08SJed Brown #define TSGLADAPT_BOTH "both" 246ed657a08SJed Brown 247ed657a08SJed Brown /*MC 248ed657a08SJed Brown TSGLAdaptRegisterDynamic - adds a TSGLAdapt implementation 249ed657a08SJed Brown 250ed657a08SJed Brown Synopsis: 2511890ba74SBarry Smith PetscErrorCode TSGLAdaptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 252ed657a08SJed Brown 253ed657a08SJed Brown Not Collective 254ed657a08SJed Brown 255ed657a08SJed Brown Input Parameters: 256ed657a08SJed Brown + name_scheme - name of user-defined adaptivity scheme 257ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 258ed657a08SJed Brown . name_create - name of routine to create method context 259ed657a08SJed Brown - routine_create - routine to create method context 260ed657a08SJed Brown 261ed657a08SJed Brown Notes: 262ed657a08SJed Brown TSGLAdaptRegisterDynamic() may be called multiple times to add several user-defined families. 263ed657a08SJed Brown 264ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 265ed657a08SJed Brown is ignored. 266ed657a08SJed Brown 267ed657a08SJed Brown Sample usage: 268ed657a08SJed Brown .vb 269ed657a08SJed Brown TSGLAdaptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 270ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 271ed657a08SJed Brown .ve 272ed657a08SJed Brown 273ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 274ed657a08SJed Brown $ TSGLAdaptSetType(ts,"my_scheme") 275ed657a08SJed Brown or at runtime via the option 276ed657a08SJed Brown $ -ts_adapt_type my_scheme 277ed657a08SJed Brown 278ed657a08SJed Brown Level: advanced 279ed657a08SJed Brown 280ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 281ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 282ed657a08SJed Brown replaced with appropriate values. 283ed657a08SJed Brown 284ed657a08SJed Brown .keywords: TSGLAdapt, register 285ed657a08SJed Brown 286ed657a08SJed Brown .seealso: TSGLAdaptRegisterAll() 287ed657a08SJed Brown M*/ 288ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 289ed657a08SJed Brown # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,0) 290ed657a08SJed Brown #else 291ed657a08SJed Brown # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,d) 292ed657a08SJed Brown #endif 293ed657a08SJed Brown 2947087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptRegister(const char[],const char[],const char[],PetscErrorCode (*)(TSGLAdapt)); 2957087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptRegisterAll(const char[]); 2967087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptRegisterDestroy(void); 2977087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptInitializePackage(const char[]); 2987087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptFinalizePackage(void); 2997087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 3007087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptSetType(TSGLAdapt,const TSGLAdaptType); 3017087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 3027087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 3037087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptView(TSGLAdapt,PetscViewer); 3047087cfbeSBarry Smith extern PetscErrorCode TSGLAdaptSetFromOptions(TSGLAdapt); 305fcfd50ebSBarry Smith extern PetscErrorCode TSGLAdaptDestroy(TSGLAdapt*); 306ed657a08SJed Brown 307ed657a08SJed Brown /*E 308ed657a08SJed Brown TSGLAcceptType - String with the name of TSGLAccept scheme or the function 309ed657a08SJed Brown with an optional dynamic library name, for example 310ed657a08SJed Brown http://www.mcs.anl.gov/petsc/lib.a:mytsglaccept() 311ed657a08SJed Brown 312ed657a08SJed Brown Level: beginner 313ed657a08SJed Brown 314ed657a08SJed Brown .seealso: TSGLSetAcceptType(), TS 315ed657a08SJed Brown E*/ 316ed657a08SJed Brown #define TSGLAcceptType char* 317ed657a08SJed Brown #define TSGLACCEPT_ALWAYS "always" 318ed657a08SJed Brown 319ace3abfcSBarry Smith typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 3207087cfbeSBarry Smith extern PetscErrorCode TSGLAcceptRegister(const char[],const char[],const char[],TSGLAcceptFunction); 321ed657a08SJed Brown 322ed657a08SJed Brown /*MC 323ed657a08SJed Brown TSGLAcceptRegisterDynamic - adds a TSGL acceptance scheme 324ed657a08SJed Brown 325ed657a08SJed Brown Synopsis: 3261890ba74SBarry Smith PetscErrorCode TSGLAcceptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 327ed657a08SJed Brown 328ed657a08SJed Brown Not Collective 329ed657a08SJed Brown 330ed657a08SJed Brown Input Parameters: 331ed657a08SJed Brown + name_scheme - name of user-defined acceptance scheme 332ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 333ed657a08SJed Brown . name_create - name of routine to create method context 334ed657a08SJed Brown - routine_create - routine to create method context 335ed657a08SJed Brown 336ed657a08SJed Brown Notes: 337ed657a08SJed Brown TSGLAcceptRegisterDynamic() may be called multiple times to add several user-defined families. 338ed657a08SJed Brown 339ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 340ed657a08SJed Brown is ignored. 341ed657a08SJed Brown 342ed657a08SJed Brown Sample usage: 343ed657a08SJed Brown .vb 344ed657a08SJed Brown TSGLAcceptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 345ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 346ed657a08SJed Brown .ve 347ed657a08SJed Brown 348ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 349ed657a08SJed Brown $ TSGLSetAcceptType(ts,"my_scheme") 350ed657a08SJed Brown or at runtime via the option 351ed657a08SJed Brown $ -ts_gl_accept_type my_scheme 352ed657a08SJed Brown 353ed657a08SJed Brown Level: advanced 354ed657a08SJed Brown 355ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 356ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 357ed657a08SJed Brown replaced with appropriate values. 358ed657a08SJed Brown 359ed657a08SJed Brown .keywords: TSGL, TSGLAcceptType, register 360ed657a08SJed Brown 361ed657a08SJed Brown .seealso: TSGLRegisterAll() 362ed657a08SJed Brown M*/ 363ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 364ed657a08SJed Brown # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,0) 365ed657a08SJed Brown #else 366ed657a08SJed Brown # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,d) 367ed657a08SJed Brown #endif 368ed657a08SJed Brown 36918b56cb9SJed Brown /*E 37018b56cb9SJed Brown TSGLType - family of time integration method within the General Linear class 37118b56cb9SJed Brown 37218b56cb9SJed Brown Level: beginner 37318b56cb9SJed Brown 37418b56cb9SJed Brown .seealso: TSGLSetType(), TSGLRegister() 37518b56cb9SJed Brown E*/ 37618b56cb9SJed Brown #define TSGLType char* 377ed657a08SJed Brown #define TSGL_IRKS "irks" 37818b56cb9SJed Brown 379ed657a08SJed Brown /*MC 380ed657a08SJed Brown TSGLRegisterDynamic - adds a TSGL implementation 38118b56cb9SJed Brown 382ed657a08SJed Brown Synopsis: 3831890ba74SBarry Smith PetscErrorCode TSGLRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 384ed657a08SJed Brown 385ed657a08SJed Brown Not Collective 386ed657a08SJed Brown 387ed657a08SJed Brown Input Parameters: 388ed657a08SJed Brown + name_scheme - name of user-defined general linear scheme 389ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 390ed657a08SJed Brown . name_create - name of routine to create method context 391ed657a08SJed Brown - routine_create - routine to create method context 392ed657a08SJed Brown 393ed657a08SJed Brown Notes: 394ed657a08SJed Brown TSGLRegisterDynamic() may be called multiple times to add several user-defined families. 395ed657a08SJed Brown 396ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 397ed657a08SJed Brown is ignored. 398ed657a08SJed Brown 399ed657a08SJed Brown Sample usage: 400ed657a08SJed Brown .vb 401ed657a08SJed Brown TSGLRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 402ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 403ed657a08SJed Brown .ve 404ed657a08SJed Brown 405ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 406ed657a08SJed Brown $ TSGLSetType(ts,"my_scheme") 407ed657a08SJed Brown or at runtime via the option 408ed657a08SJed Brown $ -ts_gl_type my_scheme 409ed657a08SJed Brown 410ed657a08SJed Brown Level: advanced 411ed657a08SJed Brown 412ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 413ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 414ed657a08SJed Brown replaced with appropriate values. 415ed657a08SJed Brown 416ed657a08SJed Brown .keywords: TSGL, register 417ed657a08SJed Brown 418ed657a08SJed Brown .seealso: TSGLRegisterAll() 419ed657a08SJed Brown M*/ 420ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 421ed657a08SJed Brown # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,0) 422ed657a08SJed Brown #else 423ed657a08SJed Brown # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,d) 424ed657a08SJed Brown #endif 425ed657a08SJed Brown 4267087cfbeSBarry Smith extern PetscErrorCode TSGLRegister(const char[],const char[],const char[],PetscErrorCode(*)(TS)); 4277087cfbeSBarry Smith extern PetscErrorCode TSGLRegisterAll(const char[]); 4287087cfbeSBarry Smith extern PetscErrorCode TSGLRegisterDestroy(void); 4297087cfbeSBarry Smith extern PetscErrorCode TSGLInitializePackage(const char[]); 4307087cfbeSBarry Smith extern PetscErrorCode TSGLFinalizePackage(void); 4317087cfbeSBarry Smith extern PetscErrorCode TSGLSetType(TS,const TSGLType); 4327087cfbeSBarry Smith extern PetscErrorCode TSGLGetAdapt(TS,TSGLAdapt*); 4337087cfbeSBarry Smith extern PetscErrorCode TSGLSetAcceptType(TS,const TSGLAcceptType); 43418b56cb9SJed Brown 4358a381b04SJed Brown #define TSARKIMEXType char* 4368a381b04SJed Brown #define TSARKIMEX2D "2d" 437a3a57f36SJed Brown #define TSARKIMEX2E "2e" 4388a381b04SJed Brown #define TSARKIMEX3 "3" 4398a381b04SJed Brown #define TSARKIMEX4 "4" 4408a381b04SJed Brown #define TSARKIMEX5 "5" 4418a381b04SJed Brown extern PetscErrorCode TSARKIMEXGetType(TS ts,const TSARKIMEXType*); 4428a381b04SJed Brown extern PetscErrorCode TSARKIMEXSetType(TS ts,const TSARKIMEXType); 4434cc180ffSJed Brown extern PetscErrorCode TSARKIMEXSetFullyImplicit(TS,PetscBool); 444cd652676SJed 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[]); 4458a381b04SJed Brown extern PetscErrorCode TSARKIMEXFinalizePackage(void); 4468a381b04SJed Brown extern PetscErrorCode TSARKIMEXInitializePackage(const char path[]); 4478a381b04SJed Brown extern PetscErrorCode TSARKIMEXRegisterDestroy(void); 4488a381b04SJed Brown extern PetscErrorCode TSARKIMEXRegisterAll(void); 4498a381b04SJed Brown 450*e27a552bSJed Brown #if defined(PETSC_HAVE_ROSW) 451*e27a552bSJed Brown #define TSRosWType char* 452*e27a552bSJed Brown #define TSROSW2D "2d" 453*e27a552bSJed Brown #define TSROSW2E "2e" 454*e27a552bSJed Brown #define TSROSW3 "3" 455*e27a552bSJed Brown #define TSROSW4 "4" 456*e27a552bSJed Brown #define TSROSW5 "5" 457*e27a552bSJed Brown extern PetscErrorCode TSRosWGetType(TS ts,const TSRosWType*); 458*e27a552bSJed Brown extern PetscErrorCode TSRosWSetType(TS ts,const TSRosWType); 459*e27a552bSJed Brown extern PetscErrorCode TSRosWSetFullyImplicit(TS,PetscBool); 460*e27a552bSJed 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[]); 461*e27a552bSJed Brown extern PetscErrorCode TSRosWFinalizePackage(void); 462*e27a552bSJed Brown extern PetscErrorCode TSRosWInitializePackage(const char path[]); 463*e27a552bSJed Brown extern PetscErrorCode TSRosWRegisterDestroy(void); 464*e27a552bSJed Brown extern PetscErrorCode TSRosWRegisterAll(void); 465*e27a552bSJed Brown #endif 466*e27a552bSJed Brown 46783e2fdc7SBarry Smith /* 4680f3b3ca1SHong Zhang PETSc interface to Sundials 46983e2fdc7SBarry Smith */ 4706dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 4716fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 4726fadb2cdSHong Zhang extern const char *TSSundialsLmmTypes[]; 4736fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 474a04cf4d8SBarry Smith extern const char *TSSundialsGramSchmidtTypes[]; 4757087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetType(TS,TSSundialsLmmType); 4767087cfbeSBarry Smith extern PetscErrorCode TSSundialsGetPC(TS,PC*); 4777087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetTolerance(TS,PetscReal,PetscReal); 4787087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetMinTimeStep(TS,PetscReal); 4797087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetMaxTimeStep(TS,PetscReal); 4807087cfbeSBarry Smith extern PetscErrorCode TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 4817087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 4827087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetGMRESRestart(TS,PetscInt); 4837087cfbeSBarry Smith extern PetscErrorCode TSSundialsSetLinearTolerance(TS,PetscReal); 4847087cfbeSBarry Smith extern PetscErrorCode TSSundialsMonitorInternalSteps(TS,PetscBool ); 4857087cfbeSBarry Smith extern PetscErrorCode TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 4866dc17ff5SMatthew Knepley #endif 48783e2fdc7SBarry Smith 4887087cfbeSBarry Smith extern PetscErrorCode TSRKSetTolerance(TS,PetscReal); 489262ff7bbSBarry Smith 4907087cfbeSBarry Smith extern PetscErrorCode TSThetaSetTheta(TS,PetscReal); 4917087cfbeSBarry Smith extern PetscErrorCode TSThetaGetTheta(TS,PetscReal*); 492eb284becSJed Brown extern PetscErrorCode TSThetaSetEndpoint(TS,PetscBool); 4930de4c49aSJed Brown 4947087cfbeSBarry Smith extern PetscErrorCode TSAlphaSetAdapt(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*); 4957087cfbeSBarry Smith extern PetscErrorCode TSAlphaAdaptDefault(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*); 4967087cfbeSBarry Smith extern PetscErrorCode TSAlphaSetRadius(TS,PetscReal); 4977087cfbeSBarry Smith extern PetscErrorCode TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 4987087cfbeSBarry Smith extern PetscErrorCode TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 49988df8a41SLisandro Dalcin 5007087cfbeSBarry Smith extern PetscErrorCode TSSetDM(TS,DM); 5017087cfbeSBarry Smith extern PetscErrorCode TSGetDM(TS,DM*); 5026c699258SBarry Smith 5037087cfbeSBarry Smith extern PetscErrorCode SNESTSFormFunction(SNES,Vec,Vec,void*); 5047087cfbeSBarry Smith extern PetscErrorCode SNESTSFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 5050f5c6efeSJed Brown 506e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 507818ad0c1SBarry Smith #endif 508