PetscBagRegisterString#

add a string value to a PetscBag

Synopsis#

#include "petscbag.h"   
PetscErrorCode PetscBagRegisterString(PetscBag bag, void *addr, PetscInt msize, const char *mdefault, const char *name, const char *help)

Logically Collective

Input Parameters#

  • bag - the bag of values

  • addr - location of start of string in struct, for example &params->mystring

  • msize - length of the string space in the struct

  • mdefault - the initial value

  • name - name of the string

  • help - longer string with more information about the value

Note#

The struct must have the field char mystring[msize]; not char *mystring

See Also#

PetscBag, PetscBagSetName(), PetscBagView(), PetscBagLoad(), PetscBagGetData() PetscBagRegisterInt(), PetscBagRegisterBool(), PetscBagRegisterScalar() PetscBagSetFromOptions(), PetscBagCreate(), PetscBagGetName(), PetscBagRegisterEnum()

Level#

beginner

Location#

src/sys/classes/bag/bag.c

Examples#

src/dm/tutorials/ex7.c
src/sys/tutorials/ex5.c

Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages