petsc-3.6.1 2015-08-06
Report Typos and Errors

PetscOptionsFList

Puts a list of option values that a single one may be selected from

Synopsis

#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()

Input Parameters

                PetscOptionsFlist(..., obj->value,value,len,&flg);
                if (flg) {
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

Output Parameter

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

See Also

PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList(), PetscOptionsEnum()

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

Examples

src/ksp/ksp/examples/tutorials/ex18.c.html
src/snes/examples/tutorials/ex48.c.html
src/ts/examples/tutorials/ex8.c.html
src/ts/examples/tutorials/ex9.c.html
src/ts/examples/tutorials/ex11.c.html
src/ts/examples/tutorials/ex14.c.html