PetscDAViewFromOptions

Processes command-line options to determine if a PetscDA should be viewed.

Synopsis

PetscErrorCode PetscDAViewFromOptions(PetscDA da, PetscObject obj, const char name[])

Collective

Input Parameters

• da - the PetscDA context

• obj - optional object that provides the prefix for options, pass NULL to use the options prefix of da

• name - option name to check

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

PetscDA: Data Assimilation, PetscDAView(), PetscObjectViewFromOptions(), PetscOptionsCreateViewer()

Level

beginner

Location

src/ml/da/interface/petscda.c

---

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