VecScatterViewFromOptions

View a VecScatter object based on values in the options database

Synopsis

#include "petscsf.h" 
PetscErrorCode VecScatterViewFromOptions(VecScatter sf, PetscObject obj, const char name[])

Collective

Input Parameters

• sf - the scatter context

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

• 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

Low-level Vector Communication, VecScatter, VecScatterView(), PetscObjectViewFromOptions(), VecScatterCreate(), PetscOptionsCreateViewer()

Level

intermediate

Location

src/vec/vec/utils/vscat.c

---

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