PyFoam.Execution.GnuplotRunner module

Runner that outputs the residuals of the linear solver with Gnuplot

class PyFoam.Execution.GnuplotRunner.GnuplotCommon(fname, smallestFreq=0.0, persist=None, quiet=False, splitThres=2048, split_fraction_unchanged=0.2, plotLinear=True, plotCont=True, plotBound=True, plotIterations=False, plotCourant=False, plotExecution=False, plotDeltaT=False, hardcopy=False, hardcopyFormat='png', hardcopyPrefix=None, hardcopyTerminalOptions=None, customRegexp=None, writeFiles=False, raiseit=False, progress=False, longProgress=False, start=None, end=None, singleFile=False, writePickled=True, plottingImplementation=None, gnuplotTerminal=None, adaptFrequency=True)[source]

Bases: PyFoam.Execution.StepAnalyzedCommon.StepAnalyzedCommon

Class that collects the Gnuplotting-Stuff for two other classes

__init__(fname, smallestFreq=0.0, persist=None, quiet=False, splitThres=2048, split_fraction_unchanged=0.2, plotLinear=True, plotCont=True, plotBound=True, plotIterations=False, plotCourant=False, plotExecution=False, plotDeltaT=False, hardcopy=False, hardcopyFormat='png', hardcopyPrefix=None, hardcopyTerminalOptions=None, customRegexp=None, writeFiles=False, raiseit=False, progress=False, longProgress=False, start=None, end=None, singleFile=False, writePickled=True, plottingImplementation=None, gnuplotTerminal=None, adaptFrequency=True)[source]

TODO: Docu

__module__ = 'PyFoam.Execution.GnuplotRunner'
addPlots(plots)[source]

Add plots. To be overriden

stopHandle()[source]
timeChanged()[source]

React to a change of the simulation time in the log

timeHandle()[source]

Handler that reacts to the change of time. To be overridden be sub-classes

class PyFoam.Execution.GnuplotRunner.GnuplotRunner(argv=None, smallestFreq=0.0, persist=None, quiet=False, splitThres=2048, split_fraction_unchanged=0.2, plotLinear=True, plotCont=True, plotBound=True, plotIterations=False, plotCourant=False, plotExecution=False, plotDeltaT=False, customRegexp=None, hardcopy=False, hardcopyFormat='png', hardcopyPrefix=None, hardcopyTerminalOptions=None, writeFiles=False, server=False, lam=None, raiseit=False, steady=False, progress=False, longProgress=False, silent=False, restart=False, logname=None, compressLog=False, noLog=False, logTail=None, singleFile=False, writePickled=True, plottingImplementation=None, gnuplotTerminal=None, remark=None, parameters=None, jobId=None, echoCommandLine=None)[source]

Bases: PyFoam.Execution.GnuplotRunner.GnuplotCommon, PyFoam.Execution.BasicRunner.BasicRunner

__init__(argv=None, smallestFreq=0.0, persist=None, quiet=False, splitThres=2048, split_fraction_unchanged=0.2, plotLinear=True, plotCont=True, plotBound=True, plotIterations=False, plotCourant=False, plotExecution=False, plotDeltaT=False, customRegexp=None, hardcopy=False, hardcopyFormat='png', hardcopyPrefix=None, hardcopyTerminalOptions=None, writeFiles=False, server=False, lam=None, raiseit=False, steady=False, progress=False, longProgress=False, silent=False, restart=False, logname=None, compressLog=False, noLog=False, logTail=None, singleFile=False, writePickled=True, plottingImplementation=None, gnuplotTerminal=None, remark=None, parameters=None, jobId=None, echoCommandLine=None)[source]
Parameters
  • smallestFreq – smallest Frequency of output

  • persist – Gnuplot window persistst after run

  • steady – Is it a steady run? Then stop it after convergence

__module__ = 'PyFoam.Execution.GnuplotRunner'
lineHandle(line)[source]

Not to be called: Stops the solver

stopHandle()[source]

Not to be called: Restores controlDict

class PyFoam.Execution.GnuplotRunner.GnuplotWatcher(logfile, smallestFreq=0.0, persist=None, quiet=False, splitThres=2048, split_fraction_unchanged=0.2, silent=False, tailLength=1000, sleep=0.1, replotFrequency=3600, plotLinear=True, plotCont=True, plotBound=True, plotIterations=False, plotCourant=False, plotExecution=False, plotDeltaT=False, customRegexp=None, writeFiles=False, hardcopy=False, hardcopyFormat='png', hardcopyPrefix=None, hardcopyTerminalOptions=None, raiseit=False, progress=False, longProgress=False, start=None, end=None, singleFile=False, writePickled=True, gnuplotTerminal=None, plottingImplementation=None, solverNotRunning=False)[source]

Bases: PyFoam.Execution.GnuplotRunner.GnuplotCommon, PyFoam.Execution.BasicWatcher.BasicWatcher

__init__(logfile, smallestFreq=0.0, persist=None, quiet=False, splitThres=2048, split_fraction_unchanged=0.2, silent=False, tailLength=1000, sleep=0.1, replotFrequency=3600, plotLinear=True, plotCont=True, plotBound=True, plotIterations=False, plotCourant=False, plotExecution=False, plotDeltaT=False, customRegexp=None, writeFiles=False, hardcopy=False, hardcopyFormat='png', hardcopyPrefix=None, hardcopyTerminalOptions=None, raiseit=False, progress=False, longProgress=False, start=None, end=None, singleFile=False, writePickled=True, gnuplotTerminal=None, plottingImplementation=None, solverNotRunning=False)[source]
Parameters
  • smallestFreq – smallest Frequency of output

  • persist – Gnuplot window persistst after run

__module__ = 'PyFoam.Execution.GnuplotRunner'
startHandle()[source]

to be called before the program is started

tailingHandle()[source]

called when the first line is output

timeChanged()[source]

React to a change of the simulation time in the log

timeHandle()[source]

Handler that reacts to the change of time. To be overridden be sub-classes