17c307921SBarry Smith 27c307921SBarry Smith #if !defined(__PETSCBAG_H) 37c307921SBarry Smith #define __PETSCBAG_H 4d382aafbSBarry 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 $ 22f621e05eSBarry Smith $ ierr = PetscBagCreate(PETSC_COMM_WORLD,sizeof(MyParameters),&bag); 23b29011acSSatish Balay $ ierr = PetscBagGetData(bag,(void **)¶ms); 24f621e05eSBarry Smith $ ierr = PetscBagSetName(bag,"MyParameters"); 25f621e05eSBarry Smith $ ierr = PetscBagRegisterInt(bag,¶ms.height,22,"height","Height of the water tower"); 267c307921SBarry Smith $ 277c307921SBarry Smith 28b29011acSSatish Balay .seealso: PetscBagSetName(), PetscBagGetName(), PetscBagView(), PetscBagLoad(), PetscBagGetData() 29acfcf0e5SJed Brown PetscBagRegisterReal(), PetscBagRegisterInt(), PetscBagRegisterBool(), PetscBagRegisterScalar() 309dcbbd2bSBarry Smith PetscBagSetFromOptions(), PetscBagRegisterVec(), PetscBagCreate(), PetscBagDestroy(), PetscBagRegisterEnum() 317c307921SBarry Smith S*/ 32b29011acSSatish Balay typedef struct _n_PetscBag* PetscBag; 33b29011acSSatish Balay typedef struct _n_PetscBagItem* PetscBagItem; 34f588057bSBarry Smith 35*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagCreate(MPI_Comm,size_t,PetscBag*); 36*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagDestroy(PetscBag*); 37*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagGetData(PetscBag,void **); 38*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterReal(PetscBag,void*,PetscReal, const char*, const char*); 39*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterRealArray(PetscBag,void*,PetscInt, const char*, const char*); 40*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterString(PetscBag,void*,PetscInt,const char*, const char*, const char*); 41*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterScalar(PetscBag,void*,PetscScalar,const char*,const char*); 42*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterInt(PetscBag,void*,PetscInt,const char*,const char*); 43*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterIntArray(PetscBag,void*,PetscInt,const char*,const char*); 44*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterEnum(PetscBag,void*,const char*[],PetscEnum,const char*,const char*); 45*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagRegisterBool(PetscBag,void*,PetscBool ,const char*,const char*); 46f588057bSBarry Smith 47*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetFromOptions(PetscBag); 48*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagGetName(PetscBag, char **); 49*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetName(PetscBag, const char *, const char *); 50*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetOptionsPrefix(PetscBag, const char *); 518cbb96b3SSatish Balay 52*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagView(PetscBag,PetscViewer); 53*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagLoad(PetscViewer,PetscBag); 54f588057bSBarry Smith 55*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetViewer(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 56*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetLoader(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 57*014dd563SJed Brown PETSC_EXTERN PetscErrorCode PetscBagSetDestroy(PetscBag,PetscErrorCode (*)(PetscBag)); 587c307921SBarry Smith 59bc2bf880SBarry Smith #define PETSC_BAG_FILE_CLASSID 1211219 60bc2bf880SBarry Smith 617c307921SBarry Smith #endif 62