PetscOptionsScalar

Gets the scalar value for a particular option in the database.

Synopsis

#include "petsc.h"   
int PetscOptionsScalar(char *opt,char *text,char *man,PetscScalar defaultv,PetscScalar *value,PetscTruth *set)
Collective on the communicator passed in PetscOptionsBegin()

Input Parameters

opt - option name
text - short string that describes the option
man - manual page with additional information on option
defaultv - the default (current) value

Output Parameter

value - the value to return
flg - PETSC_TRUE if found, else PETSC_FALSE

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

See Also

PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsLogical() PetscOptionsInt(), PetscOptionsString(), PetscOptionsReal(), PetscOptionsLogical(), PetscOptionsName(), PetscOptionsBegin(), PetscOptionsEnd(), PetscOptionsHead(), PetscOptionsStringArray(),PetscOptionsRealArray(), PetscOptionsScalar(), PetscOptionsLogicalGroupBegin(), PetscOptionsLogicalGroup(), PetscOptionsLogicalGroupEnd(), PetscOptionsList(), PetscOptionsEList()

Level:beginner
Location:
src/sys/src/objects/ams/aoptions.c
Index of all Sys routines
Table of Contents for all manual pages
Index of all manual pages