#include "petscsys.h" PetscErrorCode PetscOptionsEList(const char opt[],const char ltext[],const char man[],const char *const*list,PetscInt ntext,const char defaultv[],PetscInt *value,PetscBool *set)Logically Collective on the communicator passed in PetscOptionsBegin()
opt | - option name | |
ltext | - short string that describes the option | |
man | - manual page with additional information on option | |
list | - the possible choices | |
ntext | - number of choices | |
defaultv | - the default (current) value |
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()
See PetscOptionsList() for when the choices are given in a PetscFList()
Level:intermediate
Location:src/sys/objects/aoptions.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages