#include "petscsys.h" PetscErrorCode PetscOptionsFList_Private(PetscOptionItems *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() Many br
opt | - option name Many br | |
text | - short string that describes the option Many br | |
man | - manual page with additional information on option Many br | |
list | - the possible choices Many br | |
currentvalue | - the current value; caller is responsible for setting this value correctly. Normally this is done with Many br | |
len | - the length of the character array value Many br |
value | - the value to return Many br | |
set | - PETSC_TRUE if found, else PETSC_FALSE Many br |
Many br
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd() Many br
See PetscOptionsEList() for when the choices are given in a string array Many br
To get a listing of all currently specified options, Many brsee PetscOptionsView() or PetscOptionsGetAll() Many br
Developer Note: This cannot check for invalid selection because of things like MATAIJ that are not included in the list Many br
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