petsc-3.7.1 2016-05-15
PetscOptionsReal
Gets the PetscReal value for a particular option in the database.
Synopsis
#include "petscsys.h"
PetscErrorCode PetscOptionsReal_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal currentvalue,PetscReal *value,PetscBool *set)
Logically Collective on the communicator passed in PetscOptionsBegin() Many br
Input Parameters
| opt | - option name Many br |
| text | - short string that describes the option Many br |
| man | - manual page with additional information on option Many br |
| currentvalue | - the current value; caller is responsible for setting this value correctly. Normally this is done with either Many br |
PetscOptionsReal(..., obj->value,&object->value,...) or
value = defaultvalue
PetscOptionsReal(..., value,&value,&flg);
if (flg) {
Output Parameter
Many br
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd() Many br
See Also
PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(NULL,),
PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool() Many brPetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsBool(), Many brPetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), Many brPetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), Many brPetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), Many brPetscOptionsFList(), PetscOptionsEList() Many br
Level:beginner
Location:src/sys/objects/aoptions.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages
Examples
src/ksp/ksp/examples/tutorials/ex29.c.html
src/ksp/ksp/examples/tutorials/ex56.c.html
src/snes/examples/tutorials/ex12.c.html
src/snes/examples/tutorials/ex15.c.html
src/snes/examples/tutorials/ex46.c.html
src/snes/examples/tutorials/ex48.c.html
src/snes/examples/tutorials/ex62.c.html
src/snes/examples/tutorials/ex77.c.html
src/ts/examples/tutorials/ex8.c.html
src/ts/examples/tutorials/ex9.c.html
src/ts/examples/tutorials/ex10.c.html