17c307921SBarry Smith 27c307921SBarry Smith #if !defined(__PETSCBAG_H) 37c307921SBarry Smith #define __PETSCBAG_H 47c307921SBarry Smith #include "petsc.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 $ 20*b29011acSSatish Balay $ PetscBag bag; 217c307921SBarry Smith $ MyParameters *params; 227c307921SBarry Smith $ 23*b29011acSSatish Balay $ ierr = PetscBagCreate(MyParameters,sizeof(MyParameters),&bag); 24*b29011acSSatish Balay $ ierr = PetscBagGetData(bag,(void **)¶ms); 257c307921SBarry Smith $ ierr = PetscBagSetName(params,"MyParameters"); 26f588057bSBarry Smith $ ierr = PetscBagRegisterInt(params,¶ms.height,22,"height","Height of the water tower"); 277c307921SBarry Smith $ 287c307921SBarry Smith $ 297c307921SBarry Smith $ 307c307921SBarry Smith $ 317c307921SBarry Smith $ 327c307921SBarry Smith 33*b29011acSSatish Balay .seealso: PetscBagSetName(), PetscBagGetName(), PetscBagView(), PetscBagLoad(), PetscBagGetData() 347c307921SBarry Smith PetscBagRegisterReal(), PetscBagRegisterInt(), PetscBagRegisterTruth(), PetscBagRegisterScalar() 359dcbbd2bSBarry Smith PetscBagSetFromOptions(), PetscBagRegisterVec(), PetscBagCreate(), PetscBagDestroy(), PetscBagRegisterEnum() 367c307921SBarry Smith S*/ 37*b29011acSSatish Balay typedef struct _n_PetscBag* PetscBag; 387c307921SBarry Smith 39*b29011acSSatish Balay typedef struct _n_PetscBagItem* PetscBagItem; 40f588057bSBarry Smith 41*b29011acSSatish Balay extern PetscErrorCode PetscBagCreate(MPI_Comm,size_t,PetscBag*); 42*b29011acSSatish Balay extern PetscErrorCode PetscBagDestroy(PetscBag); 43*b29011acSSatish Balay extern PetscErrorCode PetscBagGetData(PetscBag,void **); 44*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterReal(PetscBag,void*,PetscReal, const char*, const char*); 45*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterString(PetscBag,void*,PetscInt,const char*, const char*, const char*); 46*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterScalar(PetscBag,void*,PetscScalar,const char*,const char*); 47*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterInt(PetscBag,void*,PetscInt,const char*,const char*); 48*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterEnum(PetscBag,void*,const char*[],PetscEnum,const char*,const char*); 49*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterTruth(PetscBag,void*,PetscTruth,const char*,const char*); 50*b29011acSSatish Balay extern PetscErrorCode PetscBagRegisterVec(PetscBag,void*,const char*,const char*); 51f588057bSBarry Smith 52*b29011acSSatish Balay extern PetscErrorCode PetscBagSetFromOptions(PetscBag); 53*b29011acSSatish Balay extern PetscErrorCode PetscBagGetName(PetscBag, char **name); 54*b29011acSSatish Balay extern PetscErrorCode PetscBagSetName(PetscBag, const char *, const char *); 558cbb96b3SSatish Balay 56*b29011acSSatish Balay extern PetscErrorCode PetscBagView(PetscBag,PetscViewer); 57*b29011acSSatish Balay extern PetscErrorCode PetscBagLoad(PetscViewer,PetscBag*); 58f588057bSBarry Smith 59*b29011acSSatish Balay extern PetscErrorCode PetscBagSetViewer(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 60*b29011acSSatish Balay extern PetscErrorCode PetscBagSetLoader(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 61*b29011acSSatish Balay extern PetscErrorCode PetscBagSetDestroy(PetscBag,PetscErrorCode (*)(PetscBag)); 627c307921SBarry Smith 637c307921SBarry Smith #endif 64