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

Class LogLineAnalyzer

Known Subclasses:
ContextLineAnalyzer, EchoLineAnalyzer, GeneralLineAnalyzer, SteadyConvergedLineAnalyzer, TimeLineAnalyzer

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

Lines are available one at a time
Method Summary
  __init__(self)
  doAnalysis(self, line)
Analyze a line
  getTime(self)
Return current time
  goOn(self)
If the analyzer thinks the simulation should be stopped (for instance because of convergence) it returns false
  setDirectory(self, oDir)
Set the directory to which output is to be written (if any output is written)
  setParent(self, parent)
Introduces the LineAnalyzer to its supervisor
  timeChanged(self)
The value of the time has changed in the Log-file

Method Details

doAnalysis(self, line)

Analyze a line

line - the line to be analyzed

This method carries the main functionality in the sub-classes

getTime(self)

Returns:
current time

goOn(self)

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

setDirectory(self, oDir)

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

setParent(self, parent)

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

timeChanged(self)

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

For subclasses that need to know the current time

Generated by Epydoc 2.1 on Mon Jan 22 23:52:48 2007 http://epydoc.sf.net