PetscDSViewFromOptions#

View a PetscDS based on values in the options database

Synopsis#

#include "petscds.h" 
PetscErrorCode PetscDSViewFromOptions(PetscDS A, PetscObject obj, const char name[])

Collective

Input Parameters#

  • A - the PetscDS object

  • obj - optional object that provides the options prefix used in the search of 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#

PetscDSType, PetscDS, PetscDSView(), PetscObjectViewFromOptions(), PetscDSCreate(), PetscOptionsCreateViewer()

Level#

intermediate

Location#

src/dm/dt/interface/dtds.c

Examples#

src/snes/tutorials/ex56.c


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