Package PyFoam :: Package Site :: Module ChangeGGIBoundary :: Class ChangeGGIBoundary
[hide private]
[frames] | no frames]

Class ChangeGGIBoundary

source code


Nested Classes [hide private]
    Inherited from Applications.PyFoamApplication.PyFoamApplication
  iDict
This class is a quick and dirty wrapper to use a dictionary like a struct
Instance Methods [hide private]
 
__init__(self, args=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
addOptions(self)
Add options to the parser
source code
 
run(self)
Run the real application
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

    Inherited from Applications.PyFoamApplication.PyFoamApplication
 
__getattr__(self, key) source code
 
__getitem__(self, key)
Get application data
source code
 
__iter__(self)
Iterate over the application data
source code
 
__setitem__(self, key, value)
Set data.
source code
 
addLocalConfig(self, directory=None)
Adds a local directory (assuming it is found)
source code
 
addToCaseLog(self, name, *text)
Add information about the application that was run to the case-log
source code
 
checkCase(self, name, fatal=True, verbose=True)
Check whether this is a valid OpenFOAM-case
source code
 
ensureGeneralOptions(self) source code
 
error(self, *args)
Raise a error exception.
source code
 
errorPrint(self, *args)
Prints an error message and exits
source code
 
getData(self)
Get the application data
source code
 
iteritems(self) source code
 
iterkeys(self) source code
 
setData(self, data)
Set the application data
source code
 
silent(self, *args)
Don't print a warning message
source code
 
warning(self, *args)
Prints a warning message
source code
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, args=None)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Parameters:
  • description - description of the command
  • epilog - text to be printed after the options-help
  • examples - usage examples to be printed after the epilog
  • usage - Usage
  • interspersed - Is the command line allowed to be interspersed (options after the arguments)
  • args - Command line arguments when using the Application as a 'class' from a script
  • nr - Number of required arguments
  • changeVersion - May this application change the version of OF used?
  • exactNr - Must not have more than the required number of arguments
  • subcommands - parse and use subcommands from the command line. Either True or a list with subcommands
  • inputApp - Application with input data. Used to allow a 'pipe-like' behaviour if the class is used from a Script
Overrides: object.__init__
(inherited documentation)

addOptions(self)

source code 

Add options to the parser

Overrides: Applications.PyFoamApplication.PyFoamApplication.addOptions
(inherited documentation)

run(self)

source code 

Run the real application

Overrides: Applications.PyFoamApplication.PyFoamApplication.run
(inherited documentation)