petsc-3.8.4 2018-03-24
PetscOptionsBoolArray
Gets an array of logical values (true or false) for a particular option in the database. The values must be separated with commas with no intervening spaces.
Synopsis
#include "petscsys.h"
PetscErrorCode PetscOptionsBoolArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool 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
|
| nmax | - maximum number of values
|
Output Parameter
| value | - location to copy values
|
| nmax | - actual number of values found
|
| set | - PETSC_TRUE if found, else PETSC_FALSE
|
Notes
The user should pass in an array of doubles
Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
See Also
PetscOptionsGetInt(NULL,), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
PetscOptionsFList(), PetscOptionsEList()
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