PyFoam.Applications.CommonPlotLines module

Class that implements common functionality for collecting plot-lines

class PyFoam.Applications.CommonPlotLines.CommonPlotLines

Bases: object

This class collects the lines that should be plotted

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.CommonPlotLines', '__doc__': ' This class collects the lines that should be plotted\n    ', '__init__': <function CommonPlotLines.__init__>, 'plotLines': <function CommonPlotLines.plotLines>, 'addPlotLine': <function CommonPlotLines.addPlotLine>, 'addPlotLines': <function CommonPlotLines.addPlotLines>, 'addFileRegexps': <function CommonPlotLines.addFileRegexps>, 'addOptions': <function CommonPlotLines.addOptions>, 'processPlotLineOptions': <function CommonPlotLines.processPlotLineOptions>, '__dict__': <attribute '__dict__' of 'CommonPlotLines' objects>, '__weakref__': <attribute '__weakref__' of 'CommonPlotLines' objects>, '__annotations__': {}})

__init__()

__module__ = 'PyFoam.Applications.CommonPlotLines'

__weakref__

list of weak references to the object (if defined)

addFileRegexps(fName)

Adds the lines from a file to the custom regular expressions :param fName: The name of the file

addOptions()

addPlotLine(line)

Add a single line

addPlotLines(lines, name=None)

Adds a list of lines

plotLines()

processPlotLineOptions(autoPath=None)

Process the options that have to do with plot-lines

PyFoam.Applications.CommonPlotLines.addRegexpExclude(option, opt, value, parser, *args, **kwargs)

PyFoam.Applications.CommonPlotLines.addRegexpInclude(option, opt, value, parser, *args, **kwargs)