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

PetscOptionsEnumArray

 Gets an array of enum values for a particular option in the database.

Synopsis

#include "petscsys.h"   
PetscErrorCode  PetscOptionsEnumArray_Private(PetscOptions *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum value[],PetscInt *n,PetscBool  *set)
Logically Collective on the communicator passed in PetscOptionsBegin()

Input Parameters

opt - the option one is seeking
text - short string describing option
man - manual page for option
n - maximum number of values

Output Parameter

value - location to copy values
n - actual number of values found
set - PETSC_TRUE if found, else PETSC_FALSE

Notes

The array must be passed as a comma separated list.

There must be no intervening spaces between the values.

Must be between a PetscOptionsBegin() and a PetscOptionsEnd()

See Also

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

Level:beginner
Location:src/sys/objects/aoptions.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages