Package PyFoam :: Package LogAnalysis :: Module LogLineAnalyzer :: Class LogLineAnalyzer
[hide private]
[frames] | no frames]

Class LogLineAnalyzer

source code

object --+
         |
        LogLineAnalyzer
Known Subclasses:
ContextLineAnalyzer.ContextLineAnalyzer, GeneralLineAnalyzer.GeneralLineAnalyzer, EchoLineAnalyzer.EchoLineAnalyzer, TimeLineAnalyzer.TimeLineAnalyzer, SteadyConvergedLineAnalyzer.SteadyConvergedLineAnalyzer

Base class for the analysis of all lines from a OpenFOAM-log

Lines are available one at a time

Instance Methods [hide private]
  __init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  doAnalysis(self, line)
Analyze a line
  timeChanged(self)
The value of the time has changed in the Log-file
  setParent(self, parent)
Introduces the LineAnalyzer to its supervisor
  setDirectory(self, oDir)
Set the directory to which output is to be written (if any output is written)
  goOn(self)
If the analyzer thinks the simulation should be stopped (for instance because of convergence) it returns false
  getTime(self)

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)
(Constructor)

source code 
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
Overrides: object.__init__
(inherited documentation)

doAnalysis(self, line)

source code 

Analyze a line

line - the line to be analyzed

This method carries the main functionality in the sub-classes

timeChanged(self)

source code 

The value of the time has changed in the Log-file

For subclasses that need to know the current time

setParent(self, parent)

source code 
Introduces the LineAnalyzer to its supervisor
Parameters:
  • parent - The Analyzer class of which this is a part

setDirectory(self, oDir)

source code 
Set the directory to which output is to be written (if any output is written)

goOn(self)

source code 
If the analyzer thinks the simulation should be stopped (for instance because of convergence) it returns false

getTime(self)

source code 
Returns:
current time