106 static bool bannerEnabled;
131 static void printOptionUsage
133 const label location,
147 bool regroupArgv(
int& argc,
char**& argv);
179 class initValidTables
196 bool checkArgs =
true,
197 bool checkOpts =
true,
198 bool initialise =
true 206 bool checkArgs =
true,
207 bool checkOpts =
true,
208 bool initialise =
true 254 inline const string&
arg(
const label index)
const;
272 inline const string&
option(
const word& opt)
const;
333 const string& usage =
"" 341 const string& param =
"",
342 const string& usage =
"" 354 static void addNote(
const string&);
397 bool check(
bool checkArgs=
true,
bool checkOpts=
true)
const;
bool setOption(const word &opt, const string ¶m="")
Set option directly (use with caution)
static void removeOption(const word &opt)
Remove option from validOptions and from optionUsage.
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
List< T > optionReadList(const word &opt) const
Read a List of values from the named option.
A class for handling file names.
T optionRead(const word &opt) const
Read a value from the named option.
Helper class for initializing parallel jobs from the command arguments.
static word postProcessOptionName
Standard name for the post-processing option.
bool unsetOption(const word &opt)
Unset option directly (use with caution)
static void addUsage(const word &opt, const string &usage)
Add option usage information to optionUsage.
argList(int &argc, char **&argv, bool checkArgs=true, bool checkOpts=true, bool initialise=true)
Construct from argc and argv.
bool optionReadIfPresent(const word &opt, T &) const
Read a value from the named option if present.
static SLList< string > notes
Additional notes for usage.
const ParRunControl & parRunControl() const
Return parRunControl.
static void noParallel()
Remove the parallel options.
static SLList< string > validArgs
A list of valid (mandatory) arguments.
const string & arg(const label index) const
Return the argument corresponding to index.
static bool postProcess(int argc, char *argv[])
Return true if the post-processing option is specified.
const fileName & rootPath() const
Return root path.
virtual ~argList()
Destructor.
T optionLookupOrDefault(const word &opt, const T &deflt) const
Read a value from the named option if present.
const Foam::HashTable< string > & options() const
Return options.
const word & executable() const
Name of executable without the path.
void parse(bool checkArgs, bool checkOpts, bool initialise)
Parse.
fileName path() const
Return the path to the caseName.
const fileName & caseName() const
Return case name (parallel run) or global case (serial run)
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
Signal handler for QUIT interupt.
const stringList & args() const
Return arguments.
static HashTable< string > validParOptions
A list of valid parallel options.
bool optionFound(const word &opt) const
Return true if the named option is found.
Set up trapping for floating point exceptions (signal FPE).
A class for handling words, derived from string.
Extract command arguments and options from the supplied argc and argv parameters. ...
bool check(bool checkArgs=true, bool checkOpts=true) const
Check argument list.
static void addOption(const word &opt, const string ¶m="", const string &usage="")
Add to an option to validOptions with usage information.
bool checkRootCase() const
Check root path and case path.
Non-intrusive singly-linked list.
static HashTable< string > optionUsage
Short usage information for validOptions.
const fileName & globalCaseName() const
Return case name.
An STL-conforming hash table.
graph_traits< Graph >::vertices_size_type size_type
void printNotes() const
Print notes (if any)
Signal handler for INT interupt.
const string & option(const word &opt) const
Return the argument string associated with the named option.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
T argRead(const label index) const
Read a value from the argument at index.
Input from memory buffer stream.
IStringStream optionLookup(const word &opt) const
Return an IStringStream from the named option.
label size() const
Return the number of arguments.
static void noBanner()
Disable emitting the banner information.
void displayDoc(bool source=false) const
Display documentation in browser.
const string & operator[](const label index) const
Return the argument corresponding to index.
static void addBoolOption(const word &opt, const string &usage="")
Add to a bool option to validOptions with usage information.
static void addNote(const string &)
Add extra notes for the usage information.
static string::size_type usageMin
Min offset for displaying usage (default: 20)
void printUsage() const
Print usage.
static string::size_type usageMax
Max screen width for displaying usage (default: 80)
static HashTable< string > validOptions
A list of valid options.
Signal handler for SEGV interupt.