PyFoam.Applications.CommonStandardOutput module

Class that implements the common functionality for treatment of the standard output

class PyFoam.Applications.CommonStandardOutput.CommonStandardOutput

Bases: object

The class that defines options for standard output

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.CommonStandardOutput', '__doc__': ' The class that defines options for standard output\n    ', 'addOptions': <function CommonStandardOutput.addOptions>, 'getRunParameters': <function CommonStandardOutput.getRunParameters>, 'setLogname': <function CommonStandardOutput.setLogname>, '__dict__': <attribute '__dict__' of 'CommonStandardOutput' objects>, '__weakref__': <attribute '__weakref__' of 'CommonStandardOutput' objects>, '__annotations__': {}})

__module__ = 'PyFoam.Applications.CommonStandardOutput'

__weakref__

list of weak references to the object (if defined)

addOptions(logname=None, longProgress=False)

getRunParameters()

Return a dictionary with the parameters

setLogname(default='PyFoamRunner', useApplication=True, force=False)

Builds a logfile-name :param default: Default value if no prefix for the logfile-has been defined :param useApplication: append the name of the application to the prefix