#include "petsc.h" PetscErrorCode PetscOptionsList(const char opt[],const char ltext[],const char man[],PetscFList list,const char defaultv[],char value[],PetscInt len,PetscTruth *set)Collective on the communicator passed in PetscOptionsBegin()
opt | - option name | |
text | - short string that describes the option | |
man | - manual page with additional information on option | |
list | - the possible choices | |
defaultv | - the default (current) value |
value | - the value to return | |
set | - PETSC_TRUE if found, else PETSC_FALSE |
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
See PetscOptionsEList() for when the choices are given in a string array
To get a listing of all currently specified options, see PetscOptionsPrint() or PetscOptionsGetAll()
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