17c307921SBarry Smith 27c307921SBarry Smith #if !defined(__PETSCBAG_H) 37c307921SBarry Smith #define __PETSCBAG_H 4d382aafbSBarry Smith #include "petscsys.h" 57c307921SBarry Smith PETSC_EXTERN_CXX_BEGIN 67c307921SBarry Smith 77c307921SBarry Smith /*S 87c307921SBarry Smith PetscBag - PETSc object that manages a collection of user data including parameters. 9f588057bSBarry Smith A bag is essentially a C struct with serialization (you can save it and load it from files). 107c307921SBarry Smith 117c307921SBarry Smith Level: beginner 127c307921SBarry Smith 137c307921SBarry Smith Sample Usage: 147c307921SBarry Smith $ typedef struct { 157c307921SBarry Smith $ PetscInt height; 167c307921SBarry Smith $ PetscScalar root; 177c307921SBarry Smith $ PetscReal byebye; 187c307921SBarry Smith $ } MyParameters; 197c307921SBarry Smith $ 20b29011acSSatish Balay $ PetscBag bag; 217c307921SBarry Smith $ MyParameters *params; 227c307921SBarry Smith $ 23f621e05eSBarry Smith $ ierr = PetscBagCreate(PETSC_COMM_WORLD,sizeof(MyParameters),&bag); 24b29011acSSatish Balay $ ierr = PetscBagGetData(bag,(void **)¶ms); 25f621e05eSBarry Smith $ ierr = PetscBagSetName(bag,"MyParameters"); 26f621e05eSBarry Smith $ ierr = PetscBagRegisterInt(bag,¶ms.height,22,"height","Height of the water tower"); 277c307921SBarry Smith $ 287c307921SBarry Smith 29b29011acSSatish Balay .seealso: PetscBagSetName(), PetscBagGetName(), PetscBagView(), PetscBagLoad(), PetscBagGetData() 30acfcf0e5SJed Brown PetscBagRegisterReal(), PetscBagRegisterInt(), PetscBagRegisterBool(), PetscBagRegisterScalar() 319dcbbd2bSBarry Smith PetscBagSetFromOptions(), PetscBagRegisterVec(), PetscBagCreate(), PetscBagDestroy(), PetscBagRegisterEnum() 327c307921SBarry Smith S*/ 33b29011acSSatish Balay typedef struct _n_PetscBag* PetscBag; 34b29011acSSatish Balay typedef struct _n_PetscBagItem* PetscBagItem; 35f588057bSBarry Smith 367087cfbeSBarry Smith extern PetscErrorCode PetscBagCreate(MPI_Comm,size_t,PetscBag*); 37fcfd50ebSBarry Smith extern PetscErrorCode PetscBagDestroy(PetscBag*); 387087cfbeSBarry Smith extern PetscErrorCode PetscBagGetData(PetscBag,void **); 397087cfbeSBarry Smith extern PetscErrorCode PetscBagRegisterReal(PetscBag,void*,PetscReal, const char*, const char*); 407087cfbeSBarry Smith extern PetscErrorCode PetscBagRegisterString(PetscBag,void*,PetscInt,const char*, const char*, const char*); 417087cfbeSBarry Smith extern PetscErrorCode PetscBagRegisterScalar(PetscBag,void*,PetscScalar,const char*,const char*); 427087cfbeSBarry Smith extern PetscErrorCode PetscBagRegisterInt(PetscBag,void*,PetscInt,const char*,const char*); 437087cfbeSBarry Smith extern PetscErrorCode PetscBagRegisterEnum(PetscBag,void*,const char*[],PetscEnum,const char*,const char*); 447087cfbeSBarry Smith extern PetscErrorCode PetscBagRegisterBool(PetscBag,void*,PetscBool ,const char*,const char*); 45f588057bSBarry Smith 467087cfbeSBarry Smith extern PetscErrorCode PetscBagSetFromOptions(PetscBag); 477087cfbeSBarry Smith extern PetscErrorCode PetscBagGetName(PetscBag, char **); 487087cfbeSBarry Smith extern PetscErrorCode PetscBagSetName(PetscBag, const char *, const char *); 494becb982SEthan Coon extern PetscErrorCode PetscBagSetOptionsPrefix(PetscBag, const char *); 508cbb96b3SSatish Balay 517087cfbeSBarry Smith extern PetscErrorCode PetscBagView(PetscBag,PetscViewer); 527087cfbeSBarry Smith extern PetscErrorCode PetscBagLoad(PetscViewer,PetscBag*); 53f588057bSBarry Smith 547087cfbeSBarry Smith extern PetscErrorCode PetscBagSetViewer(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 557087cfbeSBarry Smith extern PetscErrorCode PetscBagSetLoader(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 567087cfbeSBarry Smith extern PetscErrorCode PetscBagSetDestroy(PetscBag,PetscErrorCode (*)(PetscBag)); 577c307921SBarry Smith 58*bc2bf880SBarry Smith #define PETSC_BAG_FILE_CLASSID 1211219 59*bc2bf880SBarry Smith 60e1fa1e0fSSatish Balay PETSC_EXTERN_CXX_END 617c307921SBarry Smith #endif 62