1 2 #if !defined(PETSCBAG_H) 3 #define PETSCBAG_H 4 5 #include <petscsys.h> 6 7 /* SUBMANSEC = Sys */ 8 9 /*S 10 PetscBag - PETSc object that manages a collection of user data including parameters. 11 A bag is essentially a C struct with serialization (you can save it and load it from files). 12 13 Level: beginner 14 15 Sample Usage: 16 $ typedef struct { 17 $ PetscInt height; 18 $ PetscScalar root; 19 $ PetscReal byebye; 20 $ } MyParameters; 21 $ 22 $ PetscBag bag; 23 $ MyParameters *params; 24 $ 25 $ PetscCall(PetscBagCreate(PETSC_COMM_WORLD,sizeof(MyParameters),&bag)); 26 $ PetscCall(PetscBagGetData(bag,(void **)¶ms)); 27 $ PetscCall(PetscBagSetName(bag,"MyParameters")); 28 $ PetscCall(PetscBagRegisterInt(bag,¶ms.height,22,"height","Height of the water tower")); 29 $ 30 31 .seealso: `PetscBagSetName()`, `PetscBagGetName()`, `PetscBagView()`, `PetscBagLoad()`, `PetscBagGetData()` 32 `PetscBagRegisterReal()`, `PetscBagRegisterInt()`, `PetscBagRegisterBool()`, `PetscBagRegisterScalar()` 33 `PetscBagSetFromOptions()`, `PetscBagRegisterVec()`, `PetscBagCreate()`, `PetscBagDestroy()`, `PetscBagRegisterEnum()` 34 S*/ 35 typedef struct _n_PetscBag* PetscBag; 36 typedef struct _n_PetscBagItem* PetscBagItem; 37 38 PETSC_EXTERN PetscErrorCode PetscBagCreate(MPI_Comm,size_t,PetscBag*); 39 PETSC_EXTERN PetscErrorCode PetscBagDestroy(PetscBag*); 40 PETSC_EXTERN PetscErrorCode PetscBagGetData(PetscBag,void **); 41 PETSC_EXTERN PetscErrorCode PetscBagRegisterReal(PetscBag,void*,PetscReal, const char*, const char*); 42 PETSC_EXTERN PetscErrorCode PetscBagRegisterRealArray(PetscBag,void*,PetscInt, const char*, const char*); 43 PETSC_EXTERN PetscErrorCode PetscBagRegisterString(PetscBag,void*,PetscInt,const char*, const char*, const char*); 44 PETSC_EXTERN PetscErrorCode PetscBagRegisterScalar(PetscBag,void*,PetscScalar,const char*,const char*); 45 PETSC_EXTERN PetscErrorCode PetscBagRegisterInt(PetscBag,void*,PetscInt,const char*,const char*); 46 PETSC_EXTERN PetscErrorCode PetscBagRegisterInt64(PetscBag,void*,PetscInt64,const char*,const char*); 47 PETSC_EXTERN PetscErrorCode PetscBagRegisterIntArray(PetscBag,void*,PetscInt,const char*,const char*); 48 PETSC_EXTERN PetscErrorCode PetscBagRegisterEnum(PetscBag,void*,const char*const*,PetscEnum,const char*,const char*); 49 PETSC_EXTERN PetscErrorCode PetscBagRegisterBool(PetscBag,void*,PetscBool ,const char*,const char*); 50 PETSC_EXTERN PetscErrorCode PetscBagRegisterBoolArray(PetscBag,void*,PetscInt,const char*,const char*); 51 PETSC_EXTERN PetscErrorCode PetscBagGetNames(PetscBag, const char *[]); 52 53 PETSC_EXTERN PetscErrorCode PetscBagSetFromOptions(PetscBag); 54 PETSC_EXTERN PetscErrorCode PetscBagGetName(PetscBag, char **); 55 PETSC_EXTERN PetscErrorCode PetscBagSetName(PetscBag, const char *, const char *); 56 PETSC_EXTERN PetscErrorCode PetscBagSetOptionsPrefix(PetscBag, const char *); 57 58 PETSC_EXTERN PetscErrorCode PetscBagView(PetscBag,PetscViewer); 59 PETSC_EXTERN PetscErrorCode PetscBagLoad(PetscViewer,PetscBag); 60 PETSC_EXTERN PetscErrorCode PetscBagViewFromOptions(PetscBag,PetscObject,const char[]); 61 62 PETSC_EXTERN PetscErrorCode PetscBagSetViewer(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 63 PETSC_EXTERN PetscErrorCode PetscBagSetLoader(PetscBag,PetscErrorCode (*)(PetscBag,PetscViewer)); 64 PETSC_EXTERN PetscErrorCode PetscBagSetDestroy(PetscBag,PetscErrorCode (*)(PetscBag)); 65 66 #define PETSC_BAG_FILE_CLASSID 1211219 67 68 #endif 69