#include "petscsys.h" PetscErrorCode PetscOptionsEnum_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char *const *list,PetscEnum currentvalue,PetscEnum *value,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 | - array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null Many br | |
currentvalue | - the current value; caller is responsible for setting this value correctly. Normally this is done with either Many br |
PetscOptionsEnum(..., obj->value,&object->value,...) or
value = defaultvalue
PetscOptionsEnum(..., value,&value,&flg);
if (flg) {
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
list is usually something like PCASMTypes or some other predefined list of enum names Many br
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