DMLabelViewFromOptions

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

Synopsis

#include "petscdmlabel.h"   
#include "petscsection.h"   
PetscErrorCode DMLabelViewFromOptions(DMLabel label, PeOp PetscObject obj, const char name[])

Collective

Input Parameters

• label - the DMLabel 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

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

See Also

DM Basics, DMLabel, DMLabelView(), PetscObjectViewFromOptions(), DMLabelCreate(), PetscOptionsCreateViewer()

Level

intermediate

Location

src/dm/label/dmlabel.c

---

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