PetscOptionsMPIInt#

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

Synopsis#

#include <petscoptions.h>
PetscErrorCode PetscOptionsMPIInt(const char opt[], const char text[], const char man[], PetscMPIInt currentvalue, PetscMPIInt *value, PetscBool *set)

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, &set);
                 if (set) {

Output Parameters#

value - the MPI integer value to return
set - 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 that set 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(), PetscOptionsBoundedReal(), PetscOptionsRangeReal()

Level#

beginner

Location#

include/petscoptions.h

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