ISColoringViewFromOptions#
Processes command line options to determine if/how an ISColoring object is to be viewed.
Synopsis#
#include "petscis.h"
PetscErrorCode ISColoringViewFromOptions(ISColoring obj, PetscObject bobj, const char name[])
Collective
Input Parameters#
obj - the
ISColoringobjectbobj - object that provides the options database key prefix to use for viewing, or
NULLto use prefix ofobjname - option to activate viewing
Options Database Key#
-name viewer_specification - See
PetscOptionsCreateViewer()for the values ofviewer_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.
Developer Note#
This cannot use PetscObjectViewFromOptions() because ISColoring is not a PetscObject
See Also#
ISColoring, ISColoringView(), PetscObjectViewFromOptions(), PetscOptionsCreateViewer()
Level#
intermediate
Location#
src/vec/is/is/utils/iscoloring.c
Index of all IS routines
Table of Contents for all manual pages
Index of all manual pages