VecStashViewFromOptions

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

Synopsis

#include "petscvec.h"   
PetscErrorCode VecStashViewFromOptions(Vec obj, PetscObject bobj, const char name[])

Collective

Input Parameters

• obj - the Vec containing a stash

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

• 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.

Developer Notes

This cannot use PetscObjectViewFromOptions() because it takes a Vec as an argument but does not use VecView()

See Also

Vectors and Parallel Data, Vec, VecStashView(), VecStashSetInitialSize(), PetscOptionsCreateViewer()

Level

intermediate

Location

src/vec/vec/interface/vector.c

---

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