AOViewFromOptions#

View an AO based on values in the options database

Synopsis#

#include "petscao.h" 
PetscErrorCode AOViewFromOptions(AO ao, PetscObject obj, const char name[])

Collective

Input Parameters#

  • ao - the application ordering context

  • obj - optional object that provides the prefix used to search the options database

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

Application Orderings, AO, AOView(), PetscObjectViewFromOptions(), AOCreate(), PetscOptionsCreateViewer()

Level#

intermediate

Location#

src/vec/is/ao/interface/ao.c


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