PetscOptionsBoundedReal#

Gets a PetscReal value greater than or equal to a given bound for a particular option in the database.

Synopsis#

#include <petscoptions.h>
PetscErrorCode  PetscOptionsBoundedReal(const char opt[], const char text[], const char man[], PetscReal currentvalue, PetscReal *value, PetscBool *set, PetscReal bound)

Logically Collective on the communicator passed in PetscOptionsBegin()

Input Parameters#

opt - option name
text - short string that describes the option
man - manual page with additional information on option
currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either

  PetscOptionsBoundedReal(..., obj->value, &obj->value, ...)

or

  value = defaultvalue
  PetscOptionsBoundedReal(..., value, &value, &set, ...);
  if (set) {

bound - the requested value should be greater than or equal to this bound or an error is generated

Output Parameters#

value - the real value to return
set - PETSC_TRUE if found, else PETSC_FALSE

Notes#

If the user does not supply the option at all value is NOT changed. Thus you should ALWAYS initialize value if you access it without first checking that set is PETSC_TRUE.

The currentvalue passed into this routine does not get transferred to the output value variable automatically.

Must be used between a PetscOptionsBegin() and a PetscOptionsEnd()

See Also#

PetscOptionsInt(), PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsGetBool(), PetscOptionsRangeInt() PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHeadBegin(), PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList(), PetscOptionsBoundedInt(), PetscOptionsRangeReal()

Level#

beginner

Location#

include/petscoptions.h

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