PyFoam.Applications.Comparator module

Application class that implements pyFoamComparator

class PyFoam.Applications.Comparator.BoundaryCommand(c)

Bases: FieldSetterCommand

Sets a boundary condition

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.ChangeEnvironmentCommand(c)

Bases: Command

Changes Environment variables by executing a script-file

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.Command(c)

Bases: object

__annotations__ = {}

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.Comparator', 'parallel': None, '__init__': <function Command.__init__>, 'doIt': <function Command.doIt>, 'execute': <function Command.execute>, '__dict__': <attribute '__dict__' of 'Command' objects>, '__weakref__': <attribute '__weakref__' of 'Command' objects>, '__doc__': None, '__annotations__': {}})

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

__weakref__

list of weak references to the object (if defined)

doIt(para)

execute(vals, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

parallel = None

Abstract base class of all commands

class PyFoam.Applications.Comparator.CommandChain(c)

Bases: object

Abstract base class for a number of commands

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.Comparator', '__doc__': 'Abstract base class for a number of commands', '__init__': <function CommandChain.__init__>, 'execute': <function CommandChain.execute>, 'hasObjectOfType': <function CommandChain.hasObjectOfType>, '__dict__': <attribute '__dict__' of 'CommandChain' objects>, '__weakref__': <attribute '__weakref__' of 'CommandChain' objects>, '__annotations__': {}})

__init__(c)

Parameters:

c – XML-Subtree that represents the chain

__module__ = 'PyFoam.Applications.Comparator'

__weakref__

list of weak references to the object (if defined)

execute(para, log)

Executes the chain :param para:A dictionary with the parameters :param log: Logfile to write to

hasObjectOfType(typ)

Checks whether there is an object of a specific type

class PyFoam.Applications.Comparator.Comparator(args=None, **kwargs)

Bases: PyFoamApplication

__annotations__ = {}

__init__(args=None, **kwargs)

Parameters:

• description – description of the command

• epilog – text to be printed after the options-help

• examples – usage examples to be printed after the epilog

• usage – Usage

• interspersed – Is the command line allowed to be interspersed (options after the arguments)

• args – Command line arguments when using the Application as a ‘class’ from a script

• nr – Number of required arguments

• changeVersion – May this application change the version of OF used?

• exactNr – Must not have more than the required number of arguments

• subcommands – parse and use subcommands from the command line. Either True or a list with subcommands

• inputApp – Application with input data. Used to allow a ‘pipe-like’ behaviour if the class is used from a Script

• localConfigurationFile – Use this file (or list of files) as a local configuration

• findLocalConfigurationFile – Method to find a configuration file BEFORE the actual parameters are parsed

• allowCurses – This application can wrap the output in a curses-window

__module__ = 'PyFoam.Applications.Comparator'

addOptions()

Add options to the parser

run()

Run the real application

class PyFoam.Applications.Comparator.ComparatorData(doc)

Bases: object

The object that holds the actual data

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.Comparator', '__doc__': ' The object that holds the actual data', '__init__': <function ComparatorData.__init__>, '_ComparatorData__parseBase': <function ComparatorData.__parseBase>, '__len__': <function ComparatorData.__len__>, '__getitem__': <function ComparatorData.__getitem__>, '__dict__': <attribute '__dict__' of 'ComparatorData' objects>, '__weakref__': <attribute '__weakref__' of 'ComparatorData' objects>, '__annotations__': {}})

__getitem__(nr)

Parameters:

nr – Number of the variation

Returns:

dictionary with the variation

__init__(doc)

Parameters:

doc – the parsed XML-data from which the object is constructed

__len__()

Returns:

The total number of variations

__module__ = 'PyFoam.Applications.Comparator'

__parseBase(e)

Parameters:

e – The ‘base’-element

__weakref__

list of weak references to the object (if defined)

class PyFoam.Applications.Comparator.CopyLogCommand(c)

Bases: Command

Copies the log file to the results

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.DecomposeCommand(c)

Bases: Command

Decomposes a case and generates the LAM

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.DerivedCommand(c)

Bases: Command

Derives an additional value

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.DictWriteCommand(c)

Bases: SetterCommand

Writes a value to a dictionary

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.DictionaryCommand(c)

Bases: Command

Returns values from the chains dictionaries

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.EvaluationChain(c)

Bases: CommandChain

Chain of evaluation commands

__annotations__ = {}

__init__(c)

Parameters:

c – XML-Subtree that represents the chain

__module__ = 'PyFoam.Applications.Comparator'

class PyFoam.Applications.Comparator.FieldSetterCommand(c)

Bases: SetterCommand

Common class for commands that set values on fields

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

class PyFoam.Applications.Comparator.FoamCommand(c)

Bases: Command

Executes a OpenFOAM-utility

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.FoamUtilityCommand(c)

Bases: FoamCommand

Executes a OpenFOAM-utility and extracts information

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.FoamVersionCommand(c)

Bases: Command

Changes the used OpenFOAM-version

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.GenericCommand(c)

Bases: Command

Executes a shell command

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.InitialCommand(c)

Bases: FieldSetterCommand

Sets an initial condition

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.LastResultCommand(c)

Bases: Command

Copies the result of the last time-step to the resultsd directory

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.PreparationChain(c)

Bases: CommandChain

Chain of Preparation commands

__annotations__ = {}

__init__(c)

Parameters:

c – XML-Subtree that represents the chain

__module__ = 'PyFoam.Applications.Comparator'

class PyFoam.Applications.Comparator.ReconstructCommand(c)

Bases: Command

Reconstructs a case and deleted the LAM

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.SetDictionaryCommand(c)

Bases: Command

Sets value in the chains dictionaries

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.SetEnvironmentCommand(c)

Bases: Command

Sets an environment variable

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.SetterCommand(c)

Bases: Command

Common class for commands that operate on dictionaries

__annotations__ = {}

__init__(c)

__module__ = 'PyFoam.Applications.Comparator'

execute(para, log)

Parameters:

vals – Dictionary with the keywords

Returns:

A boolean whether it completed successfully and a list with results (None if no results are generated)

class PyFoam.Applications.Comparator.Variation(e)

Bases: object

Represents one variation

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.Comparator', '__doc__': 'Represents one variation', '__init__': <function Variation.__init__>, '__str__': <function Variation.__str__>, '__len__': <function Variation.__len__>, '__getitem__': <function Variation.__getitem__>, '__dict__': <attribute '__dict__' of 'Variation' objects>, '__weakref__': <attribute '__weakref__' of 'Variation' objects>, '__annotations__': {}})

__getitem__(key)

__init__(e)

Parameters:

e – the XML-data from which it is created

__len__()

Returns:

number of values

__module__ = 'PyFoam.Applications.Comparator'

__str__()

Return str(self).

__weakref__

list of weak references to the object (if defined)

PyFoam.Applications.Comparator.getNonEmpty(e, name, default=None)

PyFoam.Applications.Comparator.replaceValues(orig, para)

Replaces all strings enclosed by $$ with the parameters :param orig: the original string :param para: dictionary with the parameters