petsc-3.13.6 2020-09-29
Report Typos and Errors

PetscOptionsBoundedInt

 Gets an integer value greater than or equal a given bound for a particular option in the database. Logically Collective on the communicator passed in PetscOptionsBegin()

Synopsis

#include "petscsys.h"
PetscErrorCode  PetscOptionsBoundInt(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *flg,PetscInt bound)

Input Parameters

                PetscOptionsInt(..., obj->value,&obj->value,...) or

                value = defaultvalue

                PetscOptionsInt(..., value,&value,&flg);

                if (flg) {
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
bound - the requested value should be greater than or equal this bound or an error is generated

Output Parameter

value - the integer value to return
flg - 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 if the set flag is true.

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

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

See Also

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

Level

beginner

Location

src/sys/objects/aoptions.c

Examples

src/dm/impls/plex/tutorials/ex6.c.html
src/dm/tutorials/ex9.c.html
src/dm/field/tutorials/ex1.c.html

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