17c307921SBarry Smith 226bd1501SBarry Smith #if !defined(PETSCBAG_H) 326bd1501SBarry Smith #define PETSCBAG_H 42c8e378dSBarry Smith #include <petscsys.h> 57c307921SBarry Smith 67c307921SBarry Smith /*S 77c307921SBarry Smith PetscBag - PETSc object that manages a collection of user data including parameters. 8f588057bSBarry Smith A bag is essentially a C struct with serialization (you can save it and load it from files). 97c307921SBarry Smith 107c307921SBarry Smith Level: beginner 117c307921SBarry Smith 127c307921SBarry Smith Sample Usage: 137c307921SBarry Smith $ typedef struct { 147c307921SBarry Smith $ PetscInt height; 157c307921SBarry Smith $ PetscScalar root; 167c307921SBarry Smith $ PetscReal byebye; 177c307921SBarry Smith $ } MyParameters; 187c307921SBarry Smith $ 19b29011acSSatish Balay $ PetscBag bag; 207c307921SBarry Smith $ MyParameters *params; 217c307921SBarry Smith $ 229566063dSJacob Faibussowitsch $ PetscCall(PetscBagCreate(PETSC_COMM_WORLD,sizeof(MyParameters),&bag)); 239566063dSJacob Faibussowitsch $ PetscCall(PetscBagGetData(bag,(void **)¶ms)); 249566063dSJacob Faibussowitsch $ PetscCall(PetscBagSetName(bag,"MyParameters")); 259566063dSJacob Faibussowitsch $ PetscCall(PetscBagRegisterInt(bag,¶ms.height,22,"height","Height of the water tower")); 267c307921SBarry Smith $ 277c307921SBarry Smith 28*db781477SPatrick Sanan .seealso: `PetscBagSetName()`, `PetscBagGetName()`, `PetscBagView()`, `PetscBagLoad()`, `PetscBagGetData()` 29*db781477SPatrick Sanan `PetscBagRegisterReal()`, `PetscBagRegisterInt()`, `PetscBagRegisterBool()`, `PetscBagRegisterScalar()` 30*db781477SPatrick Sanan `PetscBagSetFromOptions()`, `PetscBagRegisterVec()`, `PetscBagCreate()`, `PetscBagDestroy()`, `PetscBagRegisterEnum()` 317c307921SBarry Smith S*/ 32b29011acSSatish Balay typedef struct _n_PetscBag* PetscBag; 33b29011acSSatish Balay typedef struct _n_PetscBagItem* PetscBagItem; 34f588057bSBarry Smith 35014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagCreate(MPI_Comm,size_t,PetscBag*); 36014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagDestroy(PetscBag*); 37014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagGetData(PetscBag,void **); 38014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterReal(PetscBag,void*,PetscReal, const char*, const char*); 39014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterRealArray(PetscBag,void*,PetscInt, const char*, const char*); 40014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterString(PetscBag,void*,PetscInt,const char*, const char*, const char*); 41014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterScalar(PetscBag,void*,PetscScalar,const char*,const char*); 42014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterInt(PetscBag,void*,PetscInt,const char*,const char*); 43bafee8b4SSatish Balay PETSC_EXTERN PetscErrorCode PetscBagRegisterInt64(PetscBag,void*,PetscInt64,const char*,const char*); 44014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterIntArray(PetscBag,void*,PetscInt,const char*,const char*); 45887c112dSJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterEnum(PetscBag,void*,const char*const*,PetscEnum,const char*,const char*); 46014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterBool(PetscBag,void*,PetscBool ,const char*,const char*); 47dd66f111SBlaise Bourdin PETSC_EXTERN PetscErrorCode PetscBagRegisterBoolArray(PetscBag,void*,PetscInt,const char*,const char*); 48ffb7e86cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscBagGetNames(PetscBag, const char *[]); 49f588057bSBarry Smith 50014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetFromOptions(PetscBag); 51014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagGetName(PetscBag, char **); 52014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetName(PetscBag, const char *, const char *); 53014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetOptionsPrefix(PetscBag, const char *); 548cbb96b3SSatish Balay 55014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagView(PetscBag,PetscViewer); 56014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagLoad(PetscViewer,PetscBag); 57173f9484SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscBagViewFromOptions(PetscBag,PetscObject,const char[]); 58f588057bSBarry Smith 59014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetViewer(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 60014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetLoader(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 61014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetDestroy(PetscBag,PetscErrorCode (*)(PetscBag)); 627c307921SBarry Smith 63bc2bf880SBarry Smith #define PETSC_BAG_FILE_CLASSID 1211219 64bc2bf880SBarry Smith 657c307921SBarry Smith #endif 66