PetscSFViewFromOptions

View a PetscSF based on arguments in the options database

Synopsis

#include "petscsf.h" 
PetscErrorCode PetscSFViewFromOptions(PetscSF A, PetscObject obj, const char name[])

Collective

Input Parameters

• A - the star forest

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

• name - command line option

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

PetscSF - an alternative to low-level MPI calls for data communication, PetscSF, PetscSFView(), PetscObjectViewFromOptions(), PetscSFCreate(), PetscOptionsCreateViewer()

Level

intermediate

Location

src/vec/is/sf/interface/sf.c

Examples

src/dm/impls/plex/tutorials/ex15.c

---

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