#include "petscsys.h" PetscErrorCode PetscOptionsFList_Private(PetscOptions *PetscOptionsObject,const char opt[],const char ltext[],const char man[],PetscFunctionList list,const char currentvalue[],char value[],size_t len,PetscBool *set)Logically 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 | |
| currentvalue | - the current value; caller is responsible for setting this value correctly. Normally this is done with | |
| len | - the length of the character array 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 PetscOptionsView() or PetscOptionsGetAll()
Developer Note: This cannot check for invalid selection because of things like MATAIJ that are not included in the list
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