petsc-3.3-p7 2013-05-11
PetscOptionsTail
Ends a section of options begun with PetscOptionsHead() See, for example, KSPSetFromOptions_GMRES(). Collective on the communicator passed in PetscOptionsBegin()
Synopsis: PetscErrorCode PetscOptionsTail(void)
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
Must be preceded by a call to PetscOptionsHead() in the same function.
This needs to be used only if the code below PetscOptionsTail() can be run ONLY once.
See, for example, PCSetFromOptions_Composite(). This is a return(0) in it for early exit
from the function.
This is only for use with the PETSc options GUI; which does not currently exist.
See Also
PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
PetscOptionsList(), PetscOptionsEList(), PetscOptionsEnum()
Level:intermediate
Location:src/sys/objects/../../../include/petscoptions.h
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages