PetscOptionsBoolGroupBegin#
First in a series of logical queries on the options database for which at most a single value can be true.
Synopsis#
#include <petscoptions.h>
PetscErrorCode PetscOptionsBoolGroupBegin(const char opt[], const char text[], const char man[], PetscBool *flg)
Logically Collective on the communicator passed in PetscOptionsBegin()
Input Parameters#
opt - option name
text - short string that describes the option
man - manual page with additional information on option
Output Parameter#
flg - whether that option was set or not
Notes#
Must be used between a PetscOptionsBegin() and a PetscOptionsEnd()
Must be followed by 0 or more PetscOptionsBoolGroup()s and PetscOptionsBoolGroupEnd()
See Also#
PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHeadBegin(),
PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
PetscOptionsFList(), PetscOptionsEList()
Level#
intermediate
Location#
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages