petsc-3.12.5 2020-03-29

PetscOptionsInt

Gets the integer value for a particular option in the database.

Synopsis

#include "petscsys.h"   
PetscErrorCode  PetscOptionsInt_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscInt currentvalue,PetscInt *value,PetscBool  *set,PetscInt lb,PetscInt ub)

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) {

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()

PetscOptionsBoundedInt(), 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