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

Class PlotRunner

source code


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 PyFoamApplication.PyFoamApplication
 
__getitem__(self, key)
Get application data
source code
 
__iter__(self)
Iterate over the application 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 CommonPlotOptions.CommonPlotOptions
 
processPlotOptions(self) source code
    Inherited from CommonPlotLines.CommonPlotLines
 
addFileRegexps(self, fName)
Adds the lines from a file to the custom regular expressions
source code
 
addPlotLine(self, line)
Add a single line
source code
 
addPlotLines(self, lines, name=None)
Adds a list of lines
source code
 
plotLines(self) source code
 
processPlotLineOptions(self, autoPath=None)
Process the options that have to do with plot-lines
source code
    Inherited from CommonSafeTrigger.CommonSafeTrigger
 
addSafeTrigger(self, run, sol, steady=True) source code
    Inherited from CommonWriteAllTrigger.CommonWriteAllTrigger
 
addWriteAllTrigger(self, run, sol) source code
    Inherited from CommonLibFunctionTrigger.CommonLibFunctionTrigger
 
addLibFunctionTrigger(self, run, sol) source code
    Inherited from CommonClearCase.CommonClearCase
 
clearCase(self, sol) source code
    Inherited from CommonReportUsage.CommonReportUsage
 
reportUsage(self, run) source code
    Inherited from CommonReportRunnerData.CommonReportRunnerData
 
reportRunnerData(self, run) source code
    Inherited from CommonParallel.CommonParallel
 
getParallel(self, sol=None) source code
    Inherited from CommonStandardOutput.CommonStandardOutput
 
getRunParameters(self)
Return a dictionary with the parameters
source code
 
setLogname(self, default='PyFoamRunner', useApplication=True)
Builds a logfile-name
source code
    Inherited from CommonVCSCommit.CommonVCSCommit
 
checkAndCommit(self, sol, msg=None) 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
  • 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
  • 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: CommonVCSCommit.CommonVCSCommit.addOptions

run(self)

source code 

Run the real application

Overrides: PyFoamApplication.PyFoamApplication.run
(inherited documentation)