petsc-3.9.4 2018-09-11

PetscOptionsBool

Determines if a particular option is in the database with a true or false

Synopsis

#include "petscsys.h"   
PetscErrorCode  PetscOptionsBool_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscBool currentvalue,PetscBool  *flg,PetscBool  *set)

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
	currentvalue	- the current value

Output Parameter

flg -PETSC_TRUE or PETSC_FALSE

set -PETSC_TRUE if found, else PETSC_FALSE

Notes

TRUE, true, YES, yes, nostring, and 1 all translate to PETSC_TRUE FALSE, false, NO, no, and 0 all translate to PETSC_FALSE

If the option is given, but no value is provided, then flg and set are both given the value PETSC_TRUE. That is -requested_bool is equivalent to -requested_bool true

If the user does not supply the option at all flg is NOT changed. Thus you should ALWAYS initialize the flg if you access it without first checking if the set flag is true.

Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()

PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(NULL,),
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