PetscOptionsInt#

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

Synopsis#

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

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,&obj->value,...) or
                 value = defaultvalue
                 PetscOptionsInt(..., value,&value,&flg);
                 if (flg) {

Output Parameters#

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#

PetscOptionsBoundedInt(), 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/impls/plex/tutorials/ex11.c
src/dm/impls/plex/tutorials/ex13.c
src/dm/impls/plex/tutorials/ex5.c
src/dm/tutorials/ex2.c
src/ksp/ksp/tutorials/ex18.c
src/ksp/ksp/tutorials/ex35.cxx
src/ksp/ksp/tutorials/ex36.cxx
src/ksp/ksp/tutorials/ex51.c
src/ksp/ksp/tutorials/ex56.c
src/ksp/ksp/tutorials/ex62.c
src/ksp/ksp/tutorials/ex64.c


Edit on GitLab

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