petsc-3.13.6 2020-09-29

PetscOptionsGetEnum

Gets the enum value for a particular option in the database.

Synopsis

#include "petscsys.h"   
PetscErrorCode PetscOptionsGetEnum(PetscOptions options,const char pre[],const char opt[],const char * const *list,PetscEnum *value,PetscBool *set)

Not Collective

Input Parameters

	options	- options database, use NULL for default global database
	pre	- option prefix or NULL
	opt	- option name
	list	- array containing the list of choices, followed by the enum name, followed by the enum prefix, followed by a null
	defaultv	- the default (current) value

Output Parameter

	value	- the value to return
	set	- PETSC_TRUE if found, else PETSC_FALSE

Notes

If the user does not supply the option value is NOT changed. Thus you should ALWAYS initialize the ivalue if you access it without first checking if the set flag is true.

List is usually something like PCASMTypes or some other predefined list of enum names

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

Level

beginner

Location

src/sys/objects/options.c

Examples

src/sys/tutorials/ex8f90.F90.html
src/mat/tutorials/ex10.c.html
src/ksp/ksp/tutorials/ex10.c.html

Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages