#include "petscsys.h" PetscErrorCode PetscOptionsEList_Private(PetscOptions *PetscOptionsObject,const char opt[],const char ltext[],const char man[],const char *const *list,PetscInt ntext,const char currentvalue[],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 (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) {
| 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 PetscOptionsFList() for when the choices are given in a PetscFunctionList()
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