PetscOptionsHeadBegin#
Puts a heading before listing any more published options. Used, for example, in KSPSetFromOptions_GMRES().
Synopsis#
#include <petscoptions.h>
PetscErrorCode PetscOptionsHeadBegin(PetscOptionsObject optionsobject, const char head[]) PeNS
Logically Collective on the communicator passed in PetscOptionsBegin()
Input Parameters#
optionsobject - argument from calling function, see
KSPSetFromOptions_GMRES()head - the heading text
Notes#
Handles errors directly, hence does not return an error code
Must be between a PetscOptionsBegin() and a PetscOptionsEnd(), and PetscOptionsObject created in PetscOptionsBegin() should be the first argument
Must be followed by a call to PetscOptionsHeadEnd() in the same function.
See Also#
PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHeadBegin(),
PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
PetscOptionsFList(), PetscOptionsEList()
Level#
developer
Location#
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages