OptionsGetScalar

Gets the scalar value for a particular option in the database.

Synopsis

#include "petsc.h"   
int OptionsGetScalar(const char pre[],const char name[],Scalar *dvalue,PetscTruth *flg)
Not Collective

Input Parameters

name - the option one is seeking
pre - string to prepend to each name or PETSC_NULL

Output Parameter

dvalue - the double value to return
flg - PETSC_TRUE if found, else PETSC_FALSE

Usage

A complex number 2+3i can be specified as 2,3 at the command line. or a number 2.0e-10 - 3.3e-20 i can be specified as 2.0e-10,3.3e-20

See Also

OptionsGetInt(), OptionsHasName(),
OptionsGetString(), OptionsGetIntArray(), OptionsGetDoubleArray()

Level:beginner
Location:
src/sys/src/objects/options.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages

Examples

src/sles/examples/tutorials/ex4.c