PetscOptionsGetIntArray#
Gets an array of integer values for a particular option in the database.
Synopsis#
#include "petscsys.h"   
PetscErrorCode PetscOptionsGetIntArray(PetscOptions options, const char pre[], const char name[], PetscInt ivalue[], PetscInt *nmax, PetscBool *set)
Not Collective
Input Parameters#
- options - options database, use - NULLfor default global database
- pre - string to prepend to each name or - NULL
- name - the option one is seeking 
Output Parameters#
- ivalue - the integer values to return 
- nmax - On input maximum number of values to retrieve, on output the actual number of values retrieved 
- set - - PETSC_TRUEif found, else- PETSC_FALSE
Notes#
The array can be passed as
- a comma separated list - 0,1,2,3,4,5,6,7 
- a range (start-end+1) - 0-8 
- a range with given increment (start-end+1:inc) - 0-7:2 
- a combination of values and ranges separated by commas - 0,1-8,8-15:2 
There must be no intervening spaces between the values.
See Also#
PetscOptionsGetInt(), PetscOptionsHasName(),
PetscOptionsGetString(), PetscOptionsGetRealArray(), PetscOptionsBool(),
PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHeadBegin(),
PetscOptionsStringArray(), PetscOptionsRealArray(), PetscOptionsScalar(),
PetscOptionsBoolGroupBegin(), PetscOptionsBoolGroup(), PetscOptionsBoolGroupEnd(),
PetscOptionsFList(), PetscOptionsEList()
Level#
beginner
Location#
Examples#
src/mat/tutorials/ex17f.F90
src/ksp/ksp/tutorials/ex81.c
src/ksp/ksp/tutorials/ex73.c
src/dm/impls/swarm/tutorials/ex1.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages