petsc-3.13.6 2020-09-29
Report Typos and Errors

PetscOptionsRealArray

 Gets an array of double values for a particular option in the database. The values must be separated with commas with no intervening spaces. Logically Collective on the communicator passed in PetscOptionsBegin()

Synopsis

#include "petscsys.h"
PetscErrorCode PetscOptionsRealArray(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscReal value[],PetscInt *n,PetscBool  *set)

Input Parameters

opt - the option one is seeking
text - short string describing option
man - manual page for option
nmax - maximum number of values

Output Parameter

value - location to copy values
nmax - actual number of values found
set - PETSC_TRUE if found, else PETSC_FALSE

Notes

The user should pass in an array of doubles

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

See Also

PetscOptionsGetInt(), PetscOptionsGetReal(),
PetscOptionsHasName(), PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(), PetscOptionsFList(), PetscOptionsEList()

Level

beginner

Location

src/sys/objects/aoptions.c

Examples

src/ts/tutorials/ex11.c.html
src/ts/tutorials/ex48.c.html

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