PyFoam.LogAnalysis.LogLineAnalyzer module¶
Base class for analyzing lines
-
class
PyFoam.LogAnalysis.LogLineAnalyzer.
LogLineAnalyzer
[source]¶ Bases:
object
Base class for the analysis of all lines from a OpenFOAM-log
Lines are available one at a time
-
__dict__
= mappingproxy({'__weakref__': <attribute '__weakref__' of 'LogLineAnalyzer' objects>, 'setParent': <function LogLineAnalyzer.setParent>, '__init__': <function LogLineAnalyzer.__init__>, '__doc__': 'Base class for the analysis of all lines from a OpenFOAM-log\n\n Lines are available one at a time', '__module__': 'PyFoam.LogAnalysis.LogLineAnalyzer', 'goOn': <function LogLineAnalyzer.goOn>, 'notify': <function LogLineAnalyzer.notify>, 'tearDown': <function LogLineAnalyzer.tearDown>, 'setDirectory': <function LogLineAnalyzer.setDirectory>, 'getCurrentData': <function LogLineAnalyzer.getCurrentData>, 'addListener': <function LogLineAnalyzer.addListener>, 'doAnalysis': <function LogLineAnalyzer.doAnalysis>, '__dict__': <attribute '__dict__' of 'LogLineAnalyzer' objects>, 'timeChanged': <function LogLineAnalyzer.timeChanged>, 'getTime': <function LogLineAnalyzer.getTime>, 'writeProgress': <function LogLineAnalyzer.writeProgress>})¶
-
__module__
= 'PyFoam.LogAnalysis.LogLineAnalyzer'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
addListener
(func)[source]¶ Parameters: func – a new listener-function that gets notified every time the line-analyzer encounters something interesting
-
doAnalysis
(line)[source]¶ Analyze a line
line - the line to be analyzed
This method carries the main functionality in the sub-classes
-
getCurrentData
()[source]¶ Give back the current analyzed data in a dictionary
To be overwritten by subclasses
-
goOn
()[source]¶ If the analyzer thinks the simulation should be stopped (for instance because of convergence) it returns false
-
notify
(*data)[source]¶ Notifys the event listeners of an event :param data: The data of the event. Everything is possible
-
setDirectory
(oDir)[source]¶ Set the directory to which output is to be written (if any output is written)
-
setParent
(parent)[source]¶ Introduces the LineAnalyzer to its supervisor
Parameters: parent – The Analyzer class of which this is a part
-