PetscBagViewFromOptions

Processes command line options to determine if/how a PetscBag is to be viewed.

Synopsis

#include "petscbag.h"   
PetscErrorCode PetscBagViewFromOptions(PetscBag bag, PetscObject bobj, const char name[])

Collective

Input Parameters

• bag - the object

• bobj - optional other object that provides prefix (if NULL then the prefix in obj is used)

• name - option to activate viewing

Options Database Key

• -name viewer_specification - See PetscOptionsCreateViewer() for the values of viewer_specification

Note

This checks the options database, creates the viewer on-the-fly, uses it and then destroys it. Hence it should not be called in heavily used routines, rather PetscOptionsCreateViewer() should be used to construct the viewer once which can then be utilized in the heavily used routine.

See Also

PetscBagCreate(), PetscBag, PetscViewer, PetscBagView(), PetscObjectViewFromOptions(), PetscOptionsCreateViewer()

Level

intermediate

Location

src/sys/classes/bag/bag.c

Examples

src/snes/tutorials/ex69.c

---

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