:orphan: # PetscOptionsBoundedInt Gets an integer value greater than or equal a given bound for a particular option in the database. ## Synopsis ``` #include "petscsys.h" PetscErrorCode PetscOptionsBoundedInt(const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool *flg,PetscInt 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 ```none PetscOptionsInt(..., obj->value,&obj->value,...) ``` or ```none value = defaultvalue PetscOptionsInt(..., value,&value,&flg); if (flg) { ``` - ***bound -*** the requested value should be greater than or equal this bound or an error is generated ## Output Parameters - ***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 `flg` is `PETSC_TRUE`. The `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()`, `PetscOptionsGetBool()`, `PetscOptionsRangeInt()` `PetscOptionsInt()`, `PetscOptionsString()`, `PetscOptionsReal()`, `PetscOptionsBool()`, `PetscOptionsName()`, `PetscOptionsBegin()`, `PetscOptionsEnd()`, `PetscOptionsHeadBegin()`, `PetscOptionsStringArray()`, `PetscOptionsRealArray()`, `PetscOptionsScalar()`, `PetscOptionsBoolGroupBegin()`, `PetscOptionsBoolGroup()`, `PetscOptionsBoolGroupEnd()`, `PetscOptionsFList()`, `PetscOptionsEList()` ## Level beginner ## Location src/sys/objects/aoptions.c ## Examples src/dm/field/tutorials/ex1.c
src/dm/impls/plex/tutorials/ex6.c
src/dm/tutorials/ex9.c
--- [Edit on GitLab](https://gitlab.com/petsc/petsc/-/edit/release/src/sys/objects/aoptions.c) [Index of all Sys routines](index.md) [Table of Contents for all manual pages](/manualpages/index.md) [Index of all manual pages](/manualpages/singleindex.md)