#include "petscsys.h" /*@C PetscOptionsRangeInt - Gets an integer value within a range of values for a particular option in the database. 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 $ PetscOptionsInt(..., obj->value,&object->value,...) or $ value = defaultvalue $ PetscOptionsInt(..., value,&value,&flg); $ if (flg)Logically Collective on the communicator passed in PetscOptionsBegin()
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 large than this bound |
value | - the integer value to return | |
flg | - PETSC_TRUE if found, else PETSC_FALSE |
The default/currentvalue passed into this routine does not get transferred to the output value variable automatically.
Errors if the supplied integer does not satisfy the bound
Must be between a PetscOptionsBegin() and a PetscOptionsEnd()