petsc-3.5.4 2015-05-23
PetscOptionsString
Gets the string value for a particular option in the database.
Synopsis
#include "petscsys.h"
PetscErrorCode PetscOptionsString(const char opt[],const char text[],const char man[],const char defaultv[],char value[],size_t len,PetscBool *set)
Logically 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, if the user does not provide a value this is returned in value
|
| len | - length of the result string including null terminator
|
Output Parameter
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd()
Even if the user provided no string (for example -optionname -someotheroption) the flag is set to PETSC_TRUE (and the string is fulled with nulls).
See Also
PetscOptionsGetReal(), PetscOptionsHasName(), PetscOptionsGetString(), PetscOptionsGetInt(),
PetscOptionsGetIntArray(), PetscOptionsGetRealArray(), PetscOptionsBool()
PetscOptionsInt(), PetscOptionsReal(), 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/vec/is/sf/examples/tutorials/ex1.c.html
src/snes/examples/tutorials/ex12.c.html
src/snes/examples/tutorials/ex15.c.html
src/snes/examples/tutorials/ex48.c.html
src/snes/examples/tutorials/ex62.c.html
src/ts/examples/tutorials/ex9.c.html
src/ts/examples/tutorials/ex10.c.html
src/ts/examples/tutorials/ex11.c.html
src/ts/examples/tutorials/ex14.c.html
src/ts/examples/tutorials/ex31.c.html