petsc-3.9.0 2018-04-07
Report Typos and Errors

PetscOptionsEnum

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

Synopsis

#include "petscsys.h"   
PetscErrorCode  PetscOptionsEnum_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum currentvalue,PetscEnum *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
list - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null
currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with either
                PetscOptionsEnum(..., obj->value,&object->value,...) or
                value = defaultvalue
                PetscOptionsEnum(..., value,&value,&flg);
                if (flg) {

Output Parameter

value - the value to return
set - PETSC_TRUE if found, else PETSC_FALSE

Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()

list is usually something like PCASMTypes or some other predefined list of enum names

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.

See Also

PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() 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

src/snes/examples/tutorials/ex15.c.html
src/snes/examples/tutorials/ex48.c.html
src/ts/examples/tutorials/ex9.c.html
src/ts/examples/tutorials/ex10.c.html
src/ts/examples/tutorials/ex11.c.html
src/ts/examples/tutorials/ex14.c.html
src/ts/examples/tutorials/ex17.c.html

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