petsc-3.14.6 2021-03-30

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. Logically Collective on the communicator passed in PetscOptionsBegin()

Synopsis

#include "petscsys.h"
PetscErrorCode PetscOptionsName(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()

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/tutorials/ex15.c.html

Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages