PyFoam.LogAnalysis.LogLineAnalyzer module

Base class for analyzing lines

class PyFoam.LogAnalysis.LogLineAnalyzer.LogLineAnalyzer

Bases: object

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

Lines are available one at a time

addListener(func)

Parameters:func – a new listener-function that gets notified every time

the line-analyzer encounters something interesting

allRegexp = []

doAnalysis(line)

Analyze a line

line - the line to be analyzed

This method carries the main functionality in the sub-classes

floatRegExp = '[-+]?[0-9]*\\.?[0-9]+(?:[eE][-+]?[0-9]+)?'

getCurrentData(structured=False)

Give back the current analyzed data in a dictionary

To be overwritten by subclasses

getTime()

Returns:current time

goOn()

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

notify(*data)

Notifys the event listeners of an event :param data: The data of the event. Everything is possible

classmethod registerRegexp(exp)

resetFile()

Restart the analysis because we’re using a new input file

setDirectory(oDir)

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

setParent(parent)

Introduces the LineAnalyzer to its supervisor

Parameters:parent – The Analyzer class of which this is a part

tearDown()

Hook to let every analyzer give its stuff back when the analysis has ended

timeChanged()

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

For subclasses that need to know the current time

writeProgress(msg)

Let the parent write an additional progress message