petsc-3.14.6 2021-03-30
Report Typos and Errors

PetscOptionsGetScalarArray

 Gets an array of scalars for a particular option in the database. The values must be separated with commas with no intervening spaces.

Synopsis

#include "petscsys.h"   
PetscErrorCode PetscOptionsGetScalarArray(PetscOptions options,const char pre[],const char name[],PetscScalar dvalue[],PetscInt *nmax,PetscBool *set)
Not Collective

Input Parameters

options - options database, use NULL for default global database
pre - string to prepend to each name or NULL
name - the option one is seeking
nmax - maximum number of values to retrieve

Output Parameters

dvalue - the scalar values to return
nmax - actual number of values retreived
set - PETSC_TRUE if found, else PETSC_FALSE

See Also

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

Level

beginner

Location

src/sys/objects/options.c

Examples

src/ts/tutorials/ex31.c.html

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