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" 39*88df8a41SLisandro Dalcin #define TSALPHA "alpha" 409596e0b4SJed Brown #define TSGL "gl" 41ef7bb5aaSJed Brown #define TSSSP "ssp" 4282bf6240SBarry Smith 43435da068SBarry Smith /*E 44435da068SBarry Smith TSProblemType - Determines the type of problem this TS object is to be used to solve 45435da068SBarry Smith 46435da068SBarry Smith Level: beginner 47435da068SBarry Smith 48435da068SBarry Smith .seealso: TSCreate() 49435da068SBarry Smith E*/ 5019bcc07fSBarry Smith typedef enum {TS_LINEAR,TS_NONLINEAR} TSProblemType; 51818ad0c1SBarry Smith 52000e7ae3SMatthew Knepley /* Logging support */ 530700a824SBarry Smith extern PetscClassId PETSCTS_DLLEXPORT TS_CLASSID; 54000e7ae3SMatthew Knepley 5563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSInitializePackage(const char[]); 568ba1e511SMatthew Knepley 5763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSCreate(MPI_Comm,TS*); 5863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDestroy(TS); 59818ad0c1SBarry Smith 6063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetProblemType(TS,TSProblemType); 6163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetProblemType(TS,TSProblemType*); 62a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorSet(TS,PetscErrorCode(*)(TS,PetscInt,PetscReal,Vec,void*),void *,PetscErrorCode (*)(void*)); 63a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorCancel(TS); 64818ad0c1SBarry Smith 6563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetOptionsPrefix(TS,const char[]); 6663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSAppendOptionsPrefix(TS,const char[]); 67e060cb09SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetOptionsPrefix(TS,const char *[]); 6863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetFromOptions(TS); 6963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetUp(TS); 70818ad0c1SBarry Smith 7163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetSolution(TS,Vec); 7263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetSolution(TS,Vec*); 73818ad0c1SBarry Smith 7463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetDuration(TS,PetscInt,PetscReal); 7563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetDuration(TS,PetscInt*,PetscReal*); 76818ad0c1SBarry Smith 77a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorDefault(TS,PetscInt,PetscReal,Vec,void*); 78a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorSolution(TS,PetscInt,PetscReal,Vec,void*); 7963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSStep(TS,PetscInt *,PetscReal*); 806a4d4014SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSolve(TS,Vec); 816a4d4014SLisandro Dalcin 82818ad0c1SBarry Smith 8363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetInitialTimeStep(TS,PetscReal,PetscReal); 8463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTimeStep(TS,PetscReal*); 8563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTime(TS,PetscReal*); 866a4d4014SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetTime(TS,PetscReal); 8763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetTimeStepNumber(TS,PetscInt*); 8863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetTimeStep(TS,PetscReal); 89818ad0c1SBarry Smith 9063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSFunction(TS,PetscErrorCode (*)(TS,PetscReal,Vec,Vec,void*),void*); 9195f0b562SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetMatrices(TS,Mat,PetscErrorCode (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),Mat,PetscErrorCode (*)(TS,PetscReal,Mat*,Mat*,MatStructure*,void*),MatStructure,void*); 92cda39b92SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetMatrices(TS,Mat*,Mat*,void**); 9363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetRHSJacobian(TS,Mat,Mat,PetscErrorCode (*)(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*),void*); 9426d46c62SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetRHSJacobian(TS,Mat*,Mat*,void**); 95818ad0c1SBarry Smith 96316643e7SJed Brown typedef PetscErrorCode (*TSIFunction)(TS,PetscReal,Vec,Vec,Vec,void*); 97316643e7SJed Brown typedef PetscErrorCode (*TSIJacobian)(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*,void*); 98316643e7SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetIFunction(TS,TSIFunction,void*); 99316643e7SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetIJacobian(TS,Mat,Mat,TSIJacobian,void*); 1002eca1d9cSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetIJacobian(TS,Mat*,Mat*,TSIJacobian*,void**); 101316643e7SJed Brown 10263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultComputeJacobianColor(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 10363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultComputeJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*,void*); 104e34be4c2SBarry Smith 10563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetPreStep(TS, PetscErrorCode (*)(TS)); 10663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetPostStep(TS, PetscErrorCode (*)(TS)); 10763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultPreStep(TS); 10863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSDefaultPostStep(TS); 1093f2090d5SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPreStep(TS); 1103f2090d5SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPostStep(TS); 111000e7ae3SMatthew Knepley 11263dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetTimeStep(TS,PetscErrorCode(*)(TS,PetscReal*,void*),void*); 11363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoDefaultTimeStep(TS,PetscReal*,void*); 11463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoComputeTimeStep(TS,PetscReal *); 115d8345c25SBarry Smith 116ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetVerifyTimeStep(TS,PetscErrorCode(*)(TS,Vec,void*,PetscReal*,PetscBool *),void*); 117ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoDefaultVerifyTimeStep(TS,Vec,void*,PetscReal*,PetscBool *); 118ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoVerifyTimeStep(TS,Vec,PetscReal*,PetscBool *); 11963dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoSetTimeStepIncrement(TS,PetscReal); 12063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPseudoIncrementDtFromInitialDt(TS); 12121c89e3eSBarry Smith 1221d6018f0SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSPythonSetType(TS,const char[]); 1231d6018f0SLisandro Dalcin 12463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSFunction(TS,PetscReal,Vec,Vec); 12563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeRHSJacobian(TS,PetscReal,Vec,Mat*,Mat*,MatStructure*); 126316643e7SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeIFunction(TS,PetscReal,Vec,Vec,Vec); 127316643e7SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSComputeIJacobian(TS,PetscReal,Vec,Vec,PetscReal,Mat*,Mat*,MatStructure*); 128818ad0c1SBarry Smith 129bdad233fSMatthew Knepley /* Dynamic creation and loading functions */ 130b0a32e0cSBarry Smith extern PetscFList TSList; 131ace3abfcSBarry Smith extern PetscBool TSRegisterAllCalled; 132a313700dSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetType(TS,const TSType*); 133a313700dSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetType(TS,const TSType); 13463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegister(const char[], const char[], const char[], PetscErrorCode (*)(TS)); 13563dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegisterAll(const char[]); 13663dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRegisterDestroy(void); 13730de9b25SBarry Smith 13830de9b25SBarry Smith /*MC 13930de9b25SBarry Smith TSRegisterDynamic - Adds a creation method to the TS package. 14030de9b25SBarry Smith 14130de9b25SBarry Smith Synopsis: 1421890ba74SBarry Smith PetscErrorCode TSRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(TS)) 14330de9b25SBarry Smith 14430de9b25SBarry Smith Not Collective 14530de9b25SBarry Smith 14630de9b25SBarry Smith Input Parameters: 14730de9b25SBarry Smith + name - The name of a new user-defined creation routine 14830de9b25SBarry Smith . path - The path (either absolute or relative) of the library containing this routine 14930de9b25SBarry Smith . func_name - The name of the creation routine 15030de9b25SBarry Smith - create_func - The creation routine itself 15130de9b25SBarry Smith 15230de9b25SBarry Smith Notes: 15330de9b25SBarry Smith TSRegisterDynamic() may be called multiple times to add several user-defined tses. 15430de9b25SBarry Smith 15530de9b25SBarry Smith If dynamic libraries are used, then the fourth input argument (create_func) is ignored. 15630de9b25SBarry Smith 15730de9b25SBarry Smith Sample usage: 15830de9b25SBarry Smith .vb 15930de9b25SBarry Smith TSRegisterDynamic("my_ts", "/home/username/my_lib/lib/libO/solaris/libmy.a", "MyTSCreate", MyTSCreate); 16030de9b25SBarry Smith .ve 16130de9b25SBarry Smith 16230de9b25SBarry Smith Then, your ts type can be chosen with the procedural interface via 16330de9b25SBarry Smith .vb 16465f2c13aSKai Germaschewski TS ts; 16565f2c13aSKai Germaschewski TSCreate(MPI_Comm, &ts); 16665f2c13aSKai Germaschewski TSSetType(ts, "my_ts") 16730de9b25SBarry Smith .ve 16830de9b25SBarry Smith or at runtime via the option 16930de9b25SBarry Smith .vb 17030de9b25SBarry Smith -ts_type my_ts 17130de9b25SBarry Smith .ve 17230de9b25SBarry Smith 173ab901514SBarry Smith Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 17430de9b25SBarry Smith If your function is not being put into a shared library then use TSRegister() instead 17530de9b25SBarry Smith 17630de9b25SBarry Smith Level: advanced 17730de9b25SBarry Smith 17830de9b25SBarry Smith .keywords: TS, register 17930de9b25SBarry Smith .seealso: TSRegisterAll(), TSRegisterDestroy() 18030de9b25SBarry Smith M*/ 181aa482453SBarry Smith #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 182f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,0) 1836df38c32SLois Curfman McInnes #else 184f1af5d2fSBarry Smith #define TSRegisterDynamic(a,b,c,d) TSRegister(a,b,c,d) 1856df38c32SLois Curfman McInnes #endif 1866df38c32SLois Curfman McInnes 18763dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetSNES(TS,SNES*); 18863dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetKSP(TS,KSP*); 189818ad0c1SBarry Smith 19063dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSView(TS,PetscViewer); 19163dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSViewFromOptions(TS,const char[]); 19221c89e3eSBarry Smith 19363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetApplicationContext(TS,void *); 19463dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetApplicationContext(TS,void **); 19521c89e3eSBarry Smith 196a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorLGCreate(const char[],const char[],int,int,int,int,PetscDrawLG *); 197a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorLG(TS,PetscInt,PetscReal,Vec,void *); 198a6570f20SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSMonitorLGDestroy(PetscDrawLG); 1993914022bSBarry Smith 200ed657a08SJed Brown /*S 201ed657a08SJed Brown TSGLAdapt - Abstract object that manages time-step adaptivity 202ed657a08SJed Brown 203ed657a08SJed Brown Level: beginner 204ed657a08SJed Brown 205ed657a08SJed Brown .seealso: TSGL, TSGLAdaptCreate(), TSGLAdaptType 206ed657a08SJed Brown S*/ 207ed657a08SJed Brown typedef struct _p_TSGLAdapt *TSGLAdapt; 208ed657a08SJed Brown 209ed657a08SJed Brown /*E 210ed657a08SJed Brown TSGLAdaptType - String with the name of TSGLAdapt scheme or the creation function 211ed657a08SJed Brown with an optional dynamic library name, for example 212ed657a08SJed Brown http://www.mcs.anl.gov/petsc/lib.a:mytsgladaptcreate() 213ed657a08SJed Brown 214ed657a08SJed Brown Level: beginner 215ed657a08SJed Brown 216ed657a08SJed Brown .seealso: TSGLAdaptSetType(), TS 217ed657a08SJed Brown E*/ 218ed657a08SJed Brown #define TSGLAdaptType char* 219ed657a08SJed Brown #define TSGLADAPT_NONE "none" 220ed657a08SJed Brown #define TSGLADAPT_SIZE "size" 221ed657a08SJed Brown #define TSGLADAPT_BOTH "both" 222ed657a08SJed Brown 223ed657a08SJed Brown /*MC 224ed657a08SJed Brown TSGLAdaptRegisterDynamic - adds a TSGLAdapt implementation 225ed657a08SJed Brown 226ed657a08SJed Brown Synopsis: 2271890ba74SBarry Smith PetscErrorCode TSGLAdaptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 228ed657a08SJed Brown 229ed657a08SJed Brown Not Collective 230ed657a08SJed Brown 231ed657a08SJed Brown Input Parameters: 232ed657a08SJed Brown + name_scheme - name of user-defined adaptivity scheme 233ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 234ed657a08SJed Brown . name_create - name of routine to create method context 235ed657a08SJed Brown - routine_create - routine to create method context 236ed657a08SJed Brown 237ed657a08SJed Brown Notes: 238ed657a08SJed Brown TSGLAdaptRegisterDynamic() may be called multiple times to add several user-defined families. 239ed657a08SJed Brown 240ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 241ed657a08SJed Brown is ignored. 242ed657a08SJed Brown 243ed657a08SJed Brown Sample usage: 244ed657a08SJed Brown .vb 245ed657a08SJed Brown TSGLAdaptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 246ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 247ed657a08SJed Brown .ve 248ed657a08SJed Brown 249ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 250ed657a08SJed Brown $ TSGLAdaptSetType(ts,"my_scheme") 251ed657a08SJed Brown or at runtime via the option 252ed657a08SJed Brown $ -ts_adapt_type my_scheme 253ed657a08SJed Brown 254ed657a08SJed Brown Level: advanced 255ed657a08SJed Brown 256ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 257ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 258ed657a08SJed Brown replaced with appropriate values. 259ed657a08SJed Brown 260ed657a08SJed Brown .keywords: TSGLAdapt, register 261ed657a08SJed Brown 262ed657a08SJed Brown .seealso: TSGLAdaptRegisterAll() 263ed657a08SJed Brown M*/ 264ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 265ed657a08SJed Brown # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,0) 266ed657a08SJed Brown #else 267ed657a08SJed Brown # define TSGLAdaptRegisterDynamic(a,b,c,d) TSGLAdaptRegister(a,b,c,d) 268ed657a08SJed Brown #endif 269ed657a08SJed Brown 270ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptRegister(const char[],const char[],const char[],PetscErrorCode (*)(TSGLAdapt)); 271ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptRegisterAll(const char[]); 272ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptRegisterDestroy(void); 273ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptInitializePackage(const char[]); 274ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptFinalizePackage(void); 275ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptCreate(MPI_Comm,TSGLAdapt*); 276ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptSetType(TSGLAdapt,const TSGLAdaptType); 277ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptSetOptionsPrefix(TSGLAdapt,const char[]); 278ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptChoose(TSGLAdapt,PetscInt,const PetscInt[],const PetscReal[],const PetscReal[],PetscInt,PetscReal,PetscReal,PetscInt*,PetscReal*,PetscBool *); 279ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptView(TSGLAdapt,PetscViewer); 280ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptSetFromOptions(TSGLAdapt); 281ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAdaptDestroy(TSGLAdapt); 282ed657a08SJed Brown 283ed657a08SJed Brown /*E 284ed657a08SJed Brown TSGLAcceptType - String with the name of TSGLAccept scheme or the function 285ed657a08SJed Brown with an optional dynamic library name, for example 286ed657a08SJed Brown http://www.mcs.anl.gov/petsc/lib.a:mytsglaccept() 287ed657a08SJed Brown 288ed657a08SJed Brown Level: beginner 289ed657a08SJed Brown 290ed657a08SJed Brown .seealso: TSGLSetAcceptType(), TS 291ed657a08SJed Brown E*/ 292ed657a08SJed Brown #define TSGLAcceptType char* 293ed657a08SJed Brown #define TSGLACCEPT_ALWAYS "always" 294ed657a08SJed Brown 295ace3abfcSBarry Smith typedef PetscErrorCode (*TSGLAcceptFunction)(TS,PetscReal,PetscReal,const PetscReal[],PetscBool *); 296ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLAcceptRegister(const char[],const char[],const char[],TSGLAcceptFunction); 297ed657a08SJed Brown 298ed657a08SJed Brown /*MC 299ed657a08SJed Brown TSGLAcceptRegisterDynamic - adds a TSGL acceptance scheme 300ed657a08SJed Brown 301ed657a08SJed Brown Synopsis: 3021890ba74SBarry Smith PetscErrorCode TSGLAcceptRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 303ed657a08SJed Brown 304ed657a08SJed Brown Not Collective 305ed657a08SJed Brown 306ed657a08SJed Brown Input Parameters: 307ed657a08SJed Brown + name_scheme - name of user-defined acceptance scheme 308ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 309ed657a08SJed Brown . name_create - name of routine to create method context 310ed657a08SJed Brown - routine_create - routine to create method context 311ed657a08SJed Brown 312ed657a08SJed Brown Notes: 313ed657a08SJed Brown TSGLAcceptRegisterDynamic() may be called multiple times to add several user-defined families. 314ed657a08SJed Brown 315ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 316ed657a08SJed Brown is ignored. 317ed657a08SJed Brown 318ed657a08SJed Brown Sample usage: 319ed657a08SJed Brown .vb 320ed657a08SJed Brown TSGLAcceptRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 321ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 322ed657a08SJed Brown .ve 323ed657a08SJed Brown 324ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 325ed657a08SJed Brown $ TSGLSetAcceptType(ts,"my_scheme") 326ed657a08SJed Brown or at runtime via the option 327ed657a08SJed Brown $ -ts_gl_accept_type my_scheme 328ed657a08SJed Brown 329ed657a08SJed Brown Level: advanced 330ed657a08SJed Brown 331ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 332ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 333ed657a08SJed Brown replaced with appropriate values. 334ed657a08SJed Brown 335ed657a08SJed Brown .keywords: TSGL, TSGLAcceptType, register 336ed657a08SJed Brown 337ed657a08SJed Brown .seealso: TSGLRegisterAll() 338ed657a08SJed Brown M*/ 339ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 340ed657a08SJed Brown # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,0) 341ed657a08SJed Brown #else 342ed657a08SJed Brown # define TSGLAcceptRegisterDynamic(a,b,c,d) TSGLAcceptRegister(a,b,c,d) 343ed657a08SJed Brown #endif 344ed657a08SJed Brown 34518b56cb9SJed Brown /*E 34618b56cb9SJed Brown TSGLType - family of time integration method within the General Linear class 34718b56cb9SJed Brown 34818b56cb9SJed Brown Level: beginner 34918b56cb9SJed Brown 35018b56cb9SJed Brown .seealso: TSGLSetType(), TSGLRegister() 35118b56cb9SJed Brown E*/ 35218b56cb9SJed Brown #define TSGLType char* 353ed657a08SJed Brown #define TSGL_IRKS "irks" 35418b56cb9SJed Brown 355ed657a08SJed Brown /*MC 356ed657a08SJed Brown TSGLRegisterDynamic - adds a TSGL implementation 35718b56cb9SJed Brown 358ed657a08SJed Brown Synopsis: 3591890ba74SBarry Smith PetscErrorCode TSGLRegisterDynamic(const char *name_scheme,const char *path,const char *name_create,PetscErrorCode (*routine_create)(TS)) 360ed657a08SJed Brown 361ed657a08SJed Brown Not Collective 362ed657a08SJed Brown 363ed657a08SJed Brown Input Parameters: 364ed657a08SJed Brown + name_scheme - name of user-defined general linear scheme 365ed657a08SJed Brown . path - path (either absolute or relative) the library containing this scheme 366ed657a08SJed Brown . name_create - name of routine to create method context 367ed657a08SJed Brown - routine_create - routine to create method context 368ed657a08SJed Brown 369ed657a08SJed Brown Notes: 370ed657a08SJed Brown TSGLRegisterDynamic() may be called multiple times to add several user-defined families. 371ed657a08SJed Brown 372ed657a08SJed Brown If dynamic libraries are used, then the fourth input argument (routine_create) 373ed657a08SJed Brown is ignored. 374ed657a08SJed Brown 375ed657a08SJed Brown Sample usage: 376ed657a08SJed Brown .vb 377ed657a08SJed Brown TSGLRegisterDynamic("my_scheme",/home/username/my_lib/lib/libO/solaris/mylib.a, 378ed657a08SJed Brown "MySchemeCreate",MySchemeCreate); 379ed657a08SJed Brown .ve 380ed657a08SJed Brown 381ed657a08SJed Brown Then, your scheme can be chosen with the procedural interface via 382ed657a08SJed Brown $ TSGLSetType(ts,"my_scheme") 383ed657a08SJed Brown or at runtime via the option 384ed657a08SJed Brown $ -ts_gl_type my_scheme 385ed657a08SJed Brown 386ed657a08SJed Brown Level: advanced 387ed657a08SJed Brown 388ed657a08SJed Brown Notes: Environmental variables such as ${PETSC_ARCH}, ${PETSC_DIR}, ${PETSC_LIB_DIR}, 389ed657a08SJed Brown and others of the form ${any_environmental_variable} occuring in pathname will be 390ed657a08SJed Brown replaced with appropriate values. 391ed657a08SJed Brown 392ed657a08SJed Brown .keywords: TSGL, register 393ed657a08SJed Brown 394ed657a08SJed Brown .seealso: TSGLRegisterAll() 395ed657a08SJed Brown M*/ 396ed657a08SJed Brown #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 397ed657a08SJed Brown # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,0) 398ed657a08SJed Brown #else 399ed657a08SJed Brown # define TSGLRegisterDynamic(a,b,c,d) TSGLRegister(a,b,c,d) 400ed657a08SJed Brown #endif 401ed657a08SJed Brown 4029596e0b4SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLRegister(const char[],const char[],const char[],PetscErrorCode(*)(TS)); 403ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLRegisterAll(const char[]); 404ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLRegisterDestroy(void); 405ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLInitializePackage(const char[]); 406ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLFinalizePackage(void); 407ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLSetType(TS,const TSGLType); 408ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLGetAdapt(TS,TSGLAdapt*); 409ed657a08SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGLSetAcceptType(TS,const TSGLAcceptType); 41018b56cb9SJed Brown 41183e2fdc7SBarry Smith /* 4120f3b3ca1SHong Zhang PETSc interface to Sundials 41383e2fdc7SBarry Smith */ 4146dc17ff5SMatthew Knepley #ifdef PETSC_HAVE_SUNDIALS 4156fadb2cdSHong Zhang typedef enum { SUNDIALS_ADAMS=1,SUNDIALS_BDF=2} TSSundialsLmmType; 4166fadb2cdSHong Zhang extern const char *TSSundialsLmmTypes[]; 4176fadb2cdSHong Zhang typedef enum { SUNDIALS_MODIFIED_GS = 1,SUNDIALS_CLASSICAL_GS = 2 } TSSundialsGramSchmidtType; 418a04cf4d8SBarry Smith extern const char *TSSundialsGramSchmidtTypes[]; 4196fadb2cdSHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetType(TS,TSSundialsLmmType); 4200f3b3ca1SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetPC(TS,PC*); 4210f3b3ca1SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetTolerance(TS,PetscReal,PetscReal); 422f1cd61daSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetMinTimeStep(TS,PetscReal); 423f1cd61daSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetMaxTimeStep(TS,PetscReal); 4240f3b3ca1SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetIterations(TS,PetscInt *,PetscInt *); 4250f3b3ca1SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetGramSchmidtType(TS,TSSundialsGramSchmidtType); 4260f3b3ca1SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetGMRESRestart(TS,PetscInt); 4270f3b3ca1SHong Zhang EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetLinearTolerance(TS,PetscReal); 428ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsSetExactFinalTime(TS,PetscBool ); 429ace3abfcSBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsMonitorInternalSteps(TS,PetscBool ); 4302337a6e7SBarry Smith EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSundialsGetParameters(TS,PetscInt *,long*[],double*[]); 4316dc17ff5SMatthew Knepley #endif 43283e2fdc7SBarry Smith 43363dd3a1aSKris Buschelman EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSRKSetTolerance(TS,PetscReal); 434262ff7bbSBarry Smith 4350de4c49aSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSThetaSetTheta(TS,PetscReal); 4360de4c49aSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSThetaGetTheta(TS,PetscReal*); 4370de4c49aSJed Brown 438*88df8a41SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSAlphaSetAccept(TS,PetscErrorCode(*)(TS,PetscReal,Vec,Vec,PetscReal*,PetscBool*,void*),void*); 439*88df8a41SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSAlphaSetRadius(TS,PetscReal); 440*88df8a41SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSAlphaSetParams(TS,PetscReal,PetscReal,PetscReal); 441*88df8a41SLisandro Dalcin EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSAlphaGetParams(TS,PetscReal*,PetscReal*,PetscReal*); 442*88df8a41SLisandro Dalcin 443e3bc8d58SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSSetDM(TS,DM); 444e3bc8d58SJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT TSGetDM(TS,DM*); 4456c699258SBarry Smith 4460f5c6efeSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT SNESTSFormFunction(SNES,Vec,Vec,void*); 4470f5c6efeSJed Brown EXTERN PetscErrorCode PETSCTS_DLLEXPORT SNESTSFormJacobian(SNES,Vec,Mat*,Mat*,MatStructure*,void*); 4480f5c6efeSJed Brown 449e9fa29b7SSatish Balay PETSC_EXTERN_CXX_END 450818ad0c1SBarry Smith #endif 451