PetscOptionsScalarArray#

Gets an array of PetscScalar 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 PetscOptionsScalarArray(const char opt[],const char text[],const char man[],PetscScalar value[],PetscInt *n,PetscBool  *set)

Input Parameters#

  • opt - the option one is seeking

  • text - short string describing option

  • man - manual page for option

  • n - maximum number of values allowed in the value array

Output Parameters#

  • value - location to copy values

  • n - actual number of values found

  • set - PETSC_TRUE if found, else PETSC_FALSE

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

See Also#

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

Level#

beginner

Location#

src/sys/objects/aoptions.c


Edit on GitLab

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