OpenFOAM logo
Open Source CFD Toolkit

argList Class Reference

Collaboration diagram for argList:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 argList (int &argc, char **&argv)
 Construct arom argc and argv.
virtual ~argList ()
const stringListargs () const
 Return arguments.
const HashTable< string > & options () const
 Return options.
const wordexecutable () const
 Name of executable.
const fileNamerootPath () const
 Return root path.
const fileNameglobalCaseName () const
 Return case name.
const fileNamecaseName () const
 Return case name.
fileName path () const
 Return path.
bool parRun () const
 Is this a parallel run.
void printUsage () const
 Print usage.
bool check () const
 Check argument list.
bool checkRootCase () const
 Check root path and case path.

Static Public Member Functions

void noParallel ()
 Remove the parallel options.

Static Public Attributes

SLList< stringvalidArgs
HashTable< stringvalidOptions
HashTable< stringvalidParOptions

Constructor & Destructor Documentation

argList int &  argc,
char **&  argv
 

Construct arom argc and argv.

virtual ~argList  )  [virtual]
 


Member Function Documentation

const stringList& args  )  const [inline]
 

Return arguments.

Definition at line 118 of file argList.H.

const fileName& caseName  )  const [inline]
 

Return case name.

or parallel processor case name for parallel run

Definition at line 151 of file argList.H.

bool check  )  const
 

Check argument list.

bool checkRootCase  )  const
 

Check root path and case path.

const word& executable  )  const [inline]
 

Name of executable.

Definition at line 130 of file argList.H.

const fileName& globalCaseName  )  const [inline]
 

Return case name.

Definition at line 142 of file argList.H.

void noParallel  )  [static]
 

Remove the parallel options.

const HashTable<string>& options  )  const [inline]
 

Return options.

Definition at line 124 of file argList.H.

bool parRun  )  const [inline]
 

Is this a parallel run.

Definition at line 163 of file argList.H.

fileName path  )  const [inline]
 

Return path.

Definition at line 157 of file argList.H.

void printUsage  )  const
 

Print usage.

const fileName& rootPath  )  const [inline]
 

Return root path.

Definition at line 136 of file argList.H.


Member Data Documentation

SLList<string> validArgs [static]
 

Definition at line 90 of file argList.H.

HashTable<string> validOptions [static]
 

Definition at line 91 of file argList.H.

HashTable<string> validParOptions [static]
 

Definition at line 92 of file argList.H.


The documentation for this class was generated from the following file:
For further information go to www.openfoam.org