PetscOptionsLogicalGroupBegin
First in a series of logical queries on the options database for which only a single value can be true.
Synopsis
#include "petsc.h"
int PetscOptionsLogicalGroupBegin(char *opt,char *text,char *man,PetscTruth *flg)
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 between a PetscOptionsBegin() and a PetscOptionsEnd()
Must be followed by 0 or more PetscOptionsLogicalGroup()s and PetscOptionsLogicalGroupEnd()
See Also
PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsLogical(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsLogicalGroupBegin(), PetscOptionsLogicalGroup(), PetscOptionsLogicalGroupEnd(),
PetscOptionsList(), PetscOptionsEList()
Level:intermediate
Location:src/sys/src/objects/ams/aoptions.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages