PFViewFromOptions#

View a PF based on options set in the options database

Synopsis#

#include "petscpf.h" 
PetscErrorCode PFViewFromOptions(PF A, PetscObject obj, const char name[])

Collective

Input Parameters#

  • A - the PF context

  • obj - optional object that provides the prefix used to search the options database, pass NULL to use the options prefix of A

  • name - command line option

Options Database Key#

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#

PF, PFView(), PetscObjectViewFromOptions(), PFCreate(), PetscOptionsCreateViewer()

Level#

intermediate

Location#

src/vec/pf/interface/pf.c


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