Package PyFoam :: Package Execution :: Module AnalyzedCommon :: Class AnalyzedCommon
[hide private]
[frames] | no frames]

Class AnalyzedCommon

source code

object --+
         |
        AnalyzedCommon

This class collects information and methods that are needed for handling analyzers

Instance Methods [hide private]
 
__init__(self, filename, analyzer, doPickling=True)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
tearDown(self) source code
 
listAnalyzers(self)
Returns: A list with the names of the analyzers
source code
 
getAnalyzer(self, name) source code
 
hasAnalyzer(self, name) source code
 
addAnalyzer(self, name, analyzer) source code
 
lineHandle(self, line)
Not to be called: calls the analyzer for the current line
source code
 
reset(self)
reset the analyzer
source code
 
getDirname(self)
Get the name of the directory where the data is written to
source code
 
getTime(self)
Get the execution time
source code
 
addTrigger(self, time, func, once=True, until=None)
Adds a timed trigger to the Analyzer
source code
 
createPlots(self, persist=None, raiseit=False, splitThres=2048, plotLinear=True, plotCont=True, plotBound=True, plotIterations=True, plotCourant=True, plotExecution=True, plotDeltaT=True, start=None, end=None, writeFiles=False, customRegexp=None, plottingImplementation="dummy") source code
 
picklePlots(self, wait=False)
Writes the necessary information for the plots permanently to disc, so that it doesn't have to be generated again
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, filename, analyzer, doPickling=True)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • filename - name of the file that is being analyzed
  • analyzer - the analyzer itself
  • doPickling - write the pickled plot data
Overrides: object.__init__

listAnalyzers(self)

source code 
Returns:
A list with the names of the analyzers

getAnalyzer(self, name)

source code 
Parameters:
  • name - name of the LineAnalyzer to get

hasAnalyzer(self, name)

source code 
Parameters:
  • name - name of the LineAnalyzer we ask for

addAnalyzer(self, name, analyzer)

source code 
Parameters:
  • name - name of the LineAnalyzer to add
  • analyzer - the analyzer to add

addTrigger(self, time, func, once=True, until=None)

source code 

Adds a timed trigger to the Analyzer

Parameters:
  • time - the time at which the function should be triggered
  • func - the trigger function
  • once - Should this function be called once or at every time-step
  • until - The time until which the trigger should be called

picklePlots(self, wait=False)

source code 

Writes the necessary information for the plots permanently to disc, so that it doesn't have to be generated again

Parameters:
  • wait - wait for the lock to be allowed to pickle