Package PyFoam :: Package Applications :: Module PrepareCase :: Class PrepareCase
[hide private]
[frames] | no frames]

Class PrepareCase

source code


Nested Classes [hide private]
    Inherited from 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, exactNr=True, interspersed=True, usage='%prog <caseDirectory>', examples=None, nr=1, description=None, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
addOptions(self)
Add options to the parser
source code
 
cleanExtension(self, startDir, ext)
Go recursivly through directories and remove all files that have a specific extension
source code
 
copyOriginals(self, startDir)
Go recursivly through directories and copy foo.org to foo
source code
 
overloadDir(self, here, there)
Copy files recursively.
source code
 
prepare(self, sol, cName=None, overrideParameters=None) source code
 
run(self)
Run the real application
source code
 
searchAndReplaceTemplates(self, startDir, values, templateExt)
Go through the directory recursively and replate foo.template with foo after inserting the values
source code

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

    Inherited from 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
    Inherited from CommonTemplateBehaviour.CommonTemplateBehaviour
 
pickAssignmentDebug(self, fName)
Pick the correct comment prefix according to the file extension.
source code
Class Variables [hide private]
  parameterOutFile = 'PyFoamPrepareCaseParameters'
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, args=None, exactNr=True, interspersed=True, usage='%prog <caseDirectory>', examples=None, nr=1, description=None, **kwargs)
(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: CommonTemplateFormat.CommonTemplateFormat.addOptions

overloadDir(self, here, there)

source code 

Copy files recursively. Overwrite local copies if they exist

run(self)

source code 

Run the real application

Overrides: PyFoamApplication.PyFoamApplication.run
(inherited documentation)