PetscOptionsStringToReal

Converts a string to a PetscReal value. Handles special cases like default and decide

Synopsis

#include "petscsys.h"   
PetscErrorCode PetscOptionsStringToReal(const char name[], PetscReal *a)

Not Collective

Input Parameter

• name - the string to convert

Output Parameter

• a - the resulting PetscReal value

Note

Recognizes the special strings PETSC_DEFAULT, DEFAULT, PETSC_DECIDE, DECIDE, PETSC_DETERMINE, DETERMINE, PETSC_UNLIMITED, and UNLIMITED. Otherwise the value is parsed as a floating-point number.

See Also

PetscOptionsStringToInt(), PetscOptionsStringToScalar(), PetscOptionsStringToBool(), PetscOptionsGetReal()

Level

developer

Location

src/sys/objects/options.c

---

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