PetscBenchViewFromOptions#

Processes command line options to determine if/how a PetscBench is to be viewed.

Synopsis#

#include "petscbm.h"   
PetscErrorCode PetscBenchViewFromOptions(PetscBench bm, PetscObject bobj, const char name[])

Collective

Input Parameters#

  • bm - the object

  • bobj - optional other object that provides prefix (if NULL then the prefix in bm is used)

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

PetscBench, PetscBenchSetFromOptions(), PetscBenchRun(), PetscBenchCreate(), PetscBenchDestroy(), PetscBenchSetUp(), PetscBenchSetType(), PetscBenchSetSize(), PetscBenchGetSize(), PetscObjectViewFromOptions(), PetscViewer, PetscBenchView(), PetscOptionsCreateViewer()

Level#

advanced

Location#

src/sys/classes/bm/interface/bm.c


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