PetscOptionsEList#

Puts a list of option values that a single one may be selected from Logically Collective on the communicator passed in PetscOptionsBegin()

Synopsis#

#include "petscsys.h"
PetscErrorCode  PetscOptionsEList(const char opt[],const char ltext[],const char man[],const char *const *list,PetscInt ntext,const char currentvalue[],PetscInt *value,PetscBool  *set)

Input Parameters#

opt - option name
ltext - short string that describes the option
man - manual page with additional information on option
list - the possible choices (one of these must be selected, anything else is invalid)
ntext - number of choices
currentvalue - the current value; caller is responsible for setting this value correctly. Normally this is done with

PetscOptionsElist(..., obj->value,&value,&flg);

if (flg) {

Output Parameters#

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

Notes#

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

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.

See PetscOptionsFList() for when the choices are given in a PetscFunctionList()