PyFoam.Applications.Comparator module

Application class that implements pyFoamComparator

class PyFoam.Applications.Comparator.BoundaryCommand(c)

Bases: PyFoam.Applications.Comparator.FieldSetterCommand

Sets a boundary condition

execute(para, log)

class PyFoam.Applications.Comparator.ChangeEnvironmentCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Changes Environment variables by executing a script-file

execute(para, log)

class PyFoam.Applications.Comparator.Command(c)

Bases: object

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

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: PyFoam.Applications.PyFoamApplication.PyFoamApplication

addOptions()

run()

class PyFoam.Applications.Comparator.ComparatorData(doc)

Bases: object

The object that holds the actual data

class PyFoam.Applications.Comparator.CopyLogCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Copies the log file to the results

execute(para, log)

class PyFoam.Applications.Comparator.DecomposeCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Decomposes a case and generates the LAM

execute(para, log)

class PyFoam.Applications.Comparator.DerivedCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Derives an additional value

execute(para, log)

class PyFoam.Applications.Comparator.DictWriteCommand(c)

Bases: PyFoam.Applications.Comparator.SetterCommand

Writes a value to a dictionary

execute(para, log)

class PyFoam.Applications.Comparator.DictionaryCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Returns values from the chains dictionaries

execute(para, log)

class PyFoam.Applications.Comparator.EvaluationChain(c)

Bases: PyFoam.Applications.Comparator.CommandChain

Chain of evaluation commands

class PyFoam.Applications.Comparator.FieldSetterCommand(c)

Bases: PyFoam.Applications.Comparator.SetterCommand

Common class for commands that set values on fields

class PyFoam.Applications.Comparator.FoamCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Executes a OpenFOAM-utility

execute(para, log)

class PyFoam.Applications.Comparator.FoamUtilityCommand(c)

Bases: PyFoam.Applications.Comparator.FoamCommand

Executes a OpenFOAM-utility and extracts information

execute(para, log)

class PyFoam.Applications.Comparator.FoamVersionCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Changes the used OpenFOAM-version

execute(para, log)

class PyFoam.Applications.Comparator.GenericCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Executes a shell command

execute(para, log)

class PyFoam.Applications.Comparator.InitialCommand(c)

Bases: PyFoam.Applications.Comparator.FieldSetterCommand

Sets an initial condition

execute(para, log)

class PyFoam.Applications.Comparator.LastResultCommand(c)

Bases: PyFoam.Applications.Comparator.Command

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

execute(para, log)

class PyFoam.Applications.Comparator.PreparationChain(c)

Bases: PyFoam.Applications.Comparator.CommandChain

Chain of Preparation commands

class PyFoam.Applications.Comparator.ReconstructCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Reconstructs a case and deleted the LAM

execute(para, log)

class PyFoam.Applications.Comparator.SetDictionaryCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Sets value in the chains dictionaries

execute(para, log)

class PyFoam.Applications.Comparator.SetEnvironmentCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Sets an environment variable

execute(para, log)

class PyFoam.Applications.Comparator.SetterCommand(c)

Bases: PyFoam.Applications.Comparator.Command

Common class for commands that operate on dictionaries

execute(para, log)

class PyFoam.Applications.Comparator.Variation(e)

Bases: object

Represents one variation

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