petsc-3.13.4 2020-08-01
Report Typos and Errors

PetscOptionsBoolGroupEnd

Last in a series of logical queries on the options database for which at most a single value can be true. Logically Collective on the communicator passed in PetscOptionsBegin()

Synopsis

#include "petscsys.h"
PetscErrorCode PetscOptionsBoolGroupEnd(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool  *flg)

Input Parameters

opt - option name
text - short string that describes the option
man - manual page with additional information on option

Output Parameter

flg -PETSC_TRUE if found, else PETSC_FALSE

Notes

Must be between a PetscOptionsBegin() and a PetscOptionsEnd()

Must follow a PetscOptionsBoolGroupBegin()

See Also

PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList()

Level

intermediate

Location

src/sys/objects/aoptions.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages