#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()
| opt | - option name | |
| text | - short string that describes the option | |
| man | - manual page with additional information on option | |
| currentvalue | - the current value; caller is responsible for setting this value correctly. Normally this is done with either |
PetscOptionsReal(..., obj->value,&object->value,...) or
value = defaultvalue
PetscOptionsReal(..., value,&value,&flg);
if (flg) {
| value | - the value to return | |
| flg | - PETSC_TRUE if found, else PETSC_FALSE |
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
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