PetscRandomViewFromOptions#

View a PetscRandom object based on the options database

Synopsis#

#include "petscsys.h" 
PetscErrorCode PetscRandomViewFromOptions(PetscRandom A, PetscObject obj, const char name[])

Collective

Input Parameters#

  • A - the random number generator context

  • obj - optional object that provides the prefix for the option names, 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#

PetscRandom, PetscRandomView(), PetscOptionsCreateViewer(), PetscObjectViewFromOptions(), PetscRandomCreate()

Level#

intermediate

Location#

src/sys/classes/random/interface/randomc.c


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