OptionsGetLogical
Gets the Logical (true or false) value for a particular option in the database.
Synopsis
int OptionsGetLogical(const char pre[],const char name[],PetscTruth *ivalue,int *flg)
Not Collective
Input Parameters
name | - the option one is seeking
|
pre | - the string to prepend to the name or PETSC_NULL
|
Output Parameter
ivalue | - the logical value to return
|
flg | - 1 if found, else 0
|
Notes
TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE
FALSE, false, NO, no, and 0 all translate to PETSC_FALSE
Keywords
options, database, get, logical
See Also
OptionsGetDouble(), OptionsHasName(), OptionsGetString(),
OptionsGetIntArray(), OptionsGetDoubleArray(), OptionsGetInt()
Level:beginner
Location:src/sys/src/objects/options.c
System Index
Table of Contents