17c307921SBarry Smith 226bd1501SBarry Smith #if !defined(PETSCBAG_H) 326bd1501SBarry Smith #define PETSCBAG_H 4ac09b921SBarry Smith 52c8e378dSBarry Smith #include <petscsys.h> 67c307921SBarry Smith 7ac09b921SBarry Smith /* SUBMANSEC = Sys */ 8ac09b921SBarry Smith 97c307921SBarry Smith /*S 107c307921SBarry Smith PetscBag - PETSc object that manages a collection of user data including parameters. 11f588057bSBarry Smith A bag is essentially a C struct with serialization (you can save it and load it from files). 127c307921SBarry Smith 137c307921SBarry Smith Level: beginner 147c307921SBarry Smith 157c307921SBarry Smith Sample Usage: 16*87497f52SBarry Smith .vb 17*87497f52SBarry Smith typedef struct { 18*87497f52SBarry Smith PetscInt height; 19*87497f52SBarry Smith PetscScalar root; 20*87497f52SBarry Smith PetscReal byebye; 21*87497f52SBarry Smith } MyParameters; 22*87497f52SBarry Smith 23*87497f52SBarry Smith PetscBag bag; 24*87497f52SBarry Smith MyParameters *params; 25*87497f52SBarry Smith 26*87497f52SBarry Smith PetscCall(PetscBagCreate(PETSC_COMM_WORLD,sizeof(MyParameters),&bag)); 27*87497f52SBarry Smith PetscCall(PetscBagGetData(bag,(void **)¶ms)); 28*87497f52SBarry Smith PetscCall(PetscBagSetName(bag,"MyParameters")); 29*87497f52SBarry Smith PetscCall(PetscBagRegisterInt(bag,¶ms.height,22,"height","Height of the water tower")); 30*87497f52SBarry Smith .ve 317c307921SBarry Smith 32db781477SPatrick Sanan .seealso: `PetscBagSetName()`, `PetscBagGetName()`, `PetscBagView()`, `PetscBagLoad()`, `PetscBagGetData()` 33db781477SPatrick Sanan `PetscBagRegisterReal()`, `PetscBagRegisterInt()`, `PetscBagRegisterBool()`, `PetscBagRegisterScalar()` 34db781477SPatrick Sanan `PetscBagSetFromOptions()`, `PetscBagRegisterVec()`, `PetscBagCreate()`, `PetscBagDestroy()`, `PetscBagRegisterEnum()` 357c307921SBarry Smith S*/ 36b29011acSSatish Balay typedef struct _n_PetscBag* PetscBag; 37b29011acSSatish Balay typedef struct _n_PetscBagItem* PetscBagItem; 38f588057bSBarry Smith 39014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagCreate(MPI_Comm,size_t,PetscBag*); 40014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagDestroy(PetscBag*); 41014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagGetData(PetscBag,void **); 42014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterReal(PetscBag,void*,PetscReal, const char*, const char*); 43014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterRealArray(PetscBag,void*,PetscInt, const char*, const char*); 44014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterString(PetscBag,void*,PetscInt,const char*, const char*, const char*); 45014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterScalar(PetscBag,void*,PetscScalar,const char*,const char*); 46014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterInt(PetscBag,void*,PetscInt,const char*,const char*); 47bafee8b4SSatish Balay PETSC_EXTERN PetscErrorCode PetscBagRegisterInt64(PetscBag,void*,PetscInt64,const char*,const char*); 48014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterIntArray(PetscBag,void*,PetscInt,const char*,const char*); 49887c112dSJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterEnum(PetscBag,void*,const char*const*,PetscEnum,const char*,const char*); 50014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterBool(PetscBag,void*,PetscBool ,const char*,const char*); 51dd66f111SBlaise Bourdin PETSC_EXTERN PetscErrorCode PetscBagRegisterBoolArray(PetscBag,void*,PetscInt,const char*,const char*); 52ffb7e86cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscBagGetNames(PetscBag, const char *[]); 53f588057bSBarry Smith 54014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetFromOptions(PetscBag); 55014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagGetName(PetscBag, char **); 56014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetName(PetscBag, const char *, const char *); 57014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetOptionsPrefix(PetscBag, const char *); 588cbb96b3SSatish Balay 59014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagView(PetscBag,PetscViewer); 60014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagLoad(PetscViewer,PetscBag); 61173f9484SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscBagViewFromOptions(PetscBag,PetscObject,const char[]); 62f588057bSBarry Smith 63014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetViewer(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 64014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetLoader(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 65014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetDestroy(PetscBag,PetscErrorCode (*)(PetscBag)); 667c307921SBarry Smith 67bc2bf880SBarry Smith #define PETSC_BAG_FILE_CLASSID 1211219 68bc2bf880SBarry Smith 697c307921SBarry Smith #endif 70