PETSc version 3.17.0
PetscBag
PETSc object that manages a collection of user data including parameters. A bag is essentially a C struct with serialization (you can save it and load it from files).
Synopsis
typedef struct _n_PetscBag* PetscBag;
Sample Usage
typedef struct {
PetscInt height;
PetscScalar root;
PetscReal byebye;
} MyParameters;
PetscBag bag;
MyParameters *params;
PetscCall(PetscBagCreate(PETSC_COMM_WORLD,sizeof(MyParameters),&bag));
PetscCall(PetscBagGetData(bag,(void **)¶ms));
PetscCall(PetscBagSetName(bag,"MyParameters"));
PetscCall(PetscBagRegisterInt(bag,¶ms.height,22,"height","Height of the water tower"));
See Also
PetscBagSetName(), PetscBagGetName(), PetscBagView(), PetscBagLoad(), PetscBagGetData()
PetscBagRegisterReal(), PetscBagRegisterInt(), PetscBagRegisterBool(), PetscBagRegisterScalar()
PetscBagSetFromOptions(), PetscBagRegisterVec(), PetscBagCreate(), PetscBagDestroy(), PetscBagRegisterEnum()
Level
beginner
Location
src/sys/classes/bag/../../../../include/petscbag.h
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages