DMViewFromOptions#

View a DM in a particular way based on a request in the options database

Synopsis#

#include "petscdm.h"          
#include "petscdmlabel.h"     
#include "petscds.h"     
PetscErrorCode DMViewFromOptions(DM dm, PeOp PetscObject obj, const char name[])

Collective

Input Parameters#

  • dm - the DM object

  • obj - optional object that provides the prefix for the options database (if NULL then the prefix in obj is used)

  • name - option string that is used to activate viewing

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#

DM Basics, DM, DMView(), PetscObjectViewFromOptions(), DMCreate(), PetscOptionsCreateViewer()

Level#

intermediate

Location#

src/dm/interface/dm.c

Examples#

src/snes/tutorials/ex26.c
src/snes/tutorials/ex71.c
src/snes/tutorials/ex12.c
src/snes/tutorials/ex17.c
src/snes/tutorials/ex8.c
src/snes/tutorials/ex62.c
src/snes/tutorials/ex36.c
src/snes/tutorials/ex13.c
src/snes/tutorials/ex23.c
src/snes/tutorials/ex7.c


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