#include "petscsys.h" PetscErrorCode PetscOptionsString_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],const char currentvalue[],char value[],size_t len,PetscBool *set)Logically Collective on the communicator passed in PetscOptionsBegin() Many br
opt | - option name Many br | |
text | - short string that describes the option Many br | |
man | - manual page with additional information on option Many br | |
currentvalue | - the current value; caller is responsible for setting this value correctly. This is not used to set value Many br | |
len | - length of the result string including null terminator Many br |
value | - the value to return Many br | |
flg | - PETSC_TRUE if found, else PETSC_FALSE Many br |
Many br
Notes: Must be between a PetscOptionsBegin() and a PetscOptionsEnd() Many br
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). Many br
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