petsc-3.7.7 2017-09-25
Report Typos and Errors

PetscOptionsStringArray

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

Synopsis

#include "petscsys.h"   
PetscErrorCode  PetscOptionsStringArray_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],char *value[],PetscInt *nmax,PetscBool  *set)
Logically Collective on the communicator passed in PetscOptionsBegin()

Input Parameters

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

Output Parameter

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

Notes

The user should pass in an array of pointers to char, to hold all the strings returned by this function.

The user is responsible for deallocating the strings that are returned. The Fortran interface for this routine is not supported.

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

See Also

PetscOptionsGetInt(NULL,), 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
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages

Examples

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