petsc-3.12.5 2020-03-29
PetscOptionsName
Determines if a particular option has been set in the database. This returns true whether the option is a number, string or boolean, even its value is set to false.
Synopsis
#include "petscsys.h"
PetscErrorCode PetscOptionsName_Private(PetscOptionItems *PetscOptionsObject,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 -PETSC_TRUE if found, else PETSC_FALSE
Notes
Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
See Also
PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(),
PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
PetscOptionsFList(), PetscOptionsEList()
Level
beginner
Location
src/sys/objects/aoptions.c
Examples
src/snes/examples/tutorials/ex15.c.html
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages