PyFoam.Execution.AnalyzedCommon module

Common stuff for classes that use analyzers

class PyFoam.Execution.AnalyzedCommon.AnalyzedCommon(filenames, analyzer, splitThres=2048, split_fraction_unchanged=0.2, doPickling=True)[source]

Bases: object

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

__dict__ = mappingproxy({'__module__': 'PyFoam.Execution.AnalyzedCommon', '__doc__': 'This class collects information and methods that are needed for\n handling analyzers', '__init__': <function AnalyzedCommon.__init__>, 'addTicker': <function AnalyzedCommon.addTicker>, 'addPlots': <function AnalyzedCommon.addPlots>, 'execNameFound': <function AnalyzedCommon.execNameFound>, 'tearDown': <function AnalyzedCommon.tearDown>, 'listAnalyzers': <function AnalyzedCommon.listAnalyzers>, 'getAnalyzer': <function AnalyzedCommon.getAnalyzer>, 'hasAnalyzer': <function AnalyzedCommon.hasAnalyzer>, 'addAnalyzer': <function AnalyzedCommon.addAnalyzer>, 'lineHandle': <function AnalyzedCommon.lineHandle>, 'reset': <function AnalyzedCommon.reset>, 'getDirname': <function AnalyzedCommon.getDirname>, 'getTime': <function AnalyzedCommon.getTime>, 'addTrigger': <function AnalyzedCommon.addTrigger>, 'createPlots': <function AnalyzedCommon.createPlots>, 'addCustomExpressions': <function AnalyzedCommon.addCustomExpressions>, 'picklePlots': <function AnalyzedCommon.picklePlots>, 'setDataSet': <function AnalyzedCommon.setDataSet>, 'resetFile': <function AnalyzedCommon.resetFile>, '__dict__': <attribute '__dict__' of 'AnalyzedCommon' objects>, '__weakref__': <attribute '__weakref__' of 'AnalyzedCommon' objects>})
__init__(filenames, analyzer, splitThres=2048, split_fraction_unchanged=0.2, doPickling=True)[source]
Parameters
  • filename – name of the file that is being analyzed

  • analyzer – the analyzer itself

  • doPickling – write the pickled plot data

__module__ = 'PyFoam.Execution.AnalyzedCommon'
__weakref__

list of weak references to the object (if defined)

addAnalyzer(name, analyzer)[source]
Parameters
  • name – name of the LineAnalyzer to add

  • analyzer – the analyzer to add

addCustomExpressions(customRegexp, persist=None, quiet=False, start=None, end=None, raiseit=False, writeFiles=False, splitThres=2048, split_fraction_unchanged=0.2, gnuplotTerminal=None, plottingImplementation='dummy')[source]
addPlots(plots)[source]

Add plots. To be overriden

addTicker(ticker)[source]

Add a callable that will be called at every timestep

addTrigger(time, func, once=True, until=None)[source]

Adds a timed trigger to the Analyzer :param time: the time at which the function should be triggered :param func: the trigger function :param once: Should this function be called once or at every time-step :param until: The time until which the trigger should be called

createPlots(persist=None, quiet=False, raiseit=False, splitThres=2048, split_fraction_unchanged=0.2, plotLinear=True, plotCont=True, plotBound=True, plotIterations=True, plotCourant=True, plotExecution=True, plotDeltaT=True, start=None, end=None, writeFiles=False, customRegexp=None, gnuplotTerminal=None, plottingImplementation='dummy')[source]
execNameFound(execName)[source]
getAnalyzer(name)[source]
Parameters

name – name of the LineAnalyzer to get

getDirname()[source]

Get the name of the directory where the data is written to

getTime()[source]

Get the execution time

hasAnalyzer(name)[source]
Parameters

name – name of the LineAnalyzer we ask for

lineHandle(line)[source]

Not to be called: calls the analyzer for the current line

listAnalyzers()[source]
Returns

A list with the names of the analyzers

picklePlots(wait=False)[source]

Writes the necessary information for the plots permanently to disc, so that it doesn’t have to be generated again :param wait: wait for the lock to be allowed to pickle

reset()[source]

reset the analyzer

resetFile()[source]

The input file changed and we add a marker to all plots

setDataSet(data)[source]
tearDown()[source]