130 static void printOptionUsage
132 const label location,
146 bool regroupArgv(
int& argc,
char**& argv);
199 bool checkArgs =
true,
200 bool checkOpts =
true,
201 bool initialise =
true 209 bool checkArgs =
true,
210 bool checkOpts =
true,
211 bool initialise =
true 260 inline const string&
arg(
const label index)
const;
278 inline const string&
option(
const word& opt)
const;
339 const string& usage =
"" 347 const string& param =
"",
348 const string& usage =
"" 360 static void addNote(
const string&);
400 bool check(
bool checkArgs=
true,
bool checkOpts=
true)
const;
bool checkRootCase() const
Check root path and case path.
const word & executable() const
Name of executable without the path.
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.
A class for handling file names.
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)
const fileName & globalCaseName() const
Return case name.
static void addUsage(const word &opt, const string &usage)
Add option usage information to optionUsage.
const string & operator[](const label index) const
Return the argument corresponding to index.
argList(int &argc, char **&argv, bool checkArgs=true, bool checkOpts=true, bool initialise=true)
Construct from argc and argv.
const fileName & rootPath() const
Return root path.
Template class for non-intrusive linked lists.
static SLList< string > notes
Additional notes for usage.
bool optionFound(const word &opt) const
Return true if the named option is found.
static void noParallel()
Remove the parallel options.
static SLList< string > validArgs
A list of valid (mandatory) arguments.
static bool postProcess(int argc, char *argv[])
Return true if the post-processing option is specified.
virtual ~argList()
Destructor.
bool optionReadIfPresent(const word &opt, T &) const
Read a value from the named option if present.
const ParRunControl & parRunControl() const
Return parRunControl.
void parse(bool checkArgs, bool checkOpts, bool initialise)
Parse.
T optionLookupOrDefault(const word &opt, const T &deflt) const
Read a value from the named option if present.
Functions used by OpenFOAM that are specific to POSIX compliant operating systems and need to be repl...
Signal handler for QUIT interrupt.
void displayDoc(bool source=false) const
Display documentation in browser.
const Foam::HashTable< string > & options() const
Return options.
T optionRead(const word &opt) const
Read a value from the named option.
static HashTable< string > validParOptions
A list of valid parallel options.
void printNotes() const
Print notes (if any)
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. ...
static void addOption(const word &opt, const string ¶m="", const string &usage="")
Add to an option to validOptions with usage information.
label size() const
Return the number of arguments.
static HashTable< string > optionUsage
Short usage information for validOptions.
An STL-conforming hash table.
graph_traits< Graph >::vertices_size_type size_type
const fileName & caseName() const
Return case name (parallel run) or global case (serial run)
Signal handler for INT interrupt.
const string & arg(const label index) const
Return the argument corresponding to index.
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
fileName path() const
Return the path to the caseName.
Input from memory buffer stream.
T argRead(const label index) const
Read a value from the argument at index.
List< T > optionReadList(const word &opt) const
Read a List of values from the named option.
static void clear()
Clear the options table.
bool check(bool checkArgs=true, bool checkOpts=true) const
Check argument list.
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)
const string & commandLine() const
Return the command line string.
Non-intrusive singly-linked list.
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 interrupt.
const string & option(const word &opt) const
Return the argument string associated with the named option.
const stringList & args() const
Return arguments.
IStringStream optionLookup(const word &opt) const
Return an IStringStream from the named option.