PetscOptionsViewer

From a PetscOptionsBegin()/PetscOptionsEnd() block, read a viewer specification from the options database and create the requested PetscViewer

Synopsis

#include <petscviewer.h>
PetscErrorCode PetscOptionsViewer(const char opt[], const char text[], const char man[], PetscViewer *viewer, PetscViewerFormat *format, PetscBool *set)

Logically Collective

Input Parameters

• opt - the option name, for example -vec_view

• text - help string shown by -help

• man - manual page name (the name of an .html file under the PETSc doc tree)

Output Parameters

• viewer - the PetscViewer created, or NULL if the option was not given

• format - the PetscViewerFormat requested by the option, or the default

• set - PETSC_TRUE if the user supplied the option, PETSC_FALSE otherwise

Note

Must be called between PetscOptionsBegin() and PetscOptionsEnd(); expands to a call to the internal PetscOptionsViewer_Private(), which has access to the current PetscOptionsObject. Destroy viewer with PetscViewerDestroy() when finished.

See Also

PetscOptionsCreateViewer(), PetscOptionsBegin(), PetscOptionsEnd(), PetscViewer, PetscViewerFormat, PetscViewerDestroy()

Level

beginner

Location

include/petscviewer.h

---

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