PyFoam.Applications.Comparator module¶
Application class that implements pyFoamComparator
-
class
PyFoam.Applications.Comparator.
BoundaryCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.FieldSetterCommand
Sets a boundary condition
-
class
PyFoam.Applications.Comparator.
ChangeEnvironmentCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Changes Environment variables by executing a script-file
-
class
PyFoam.Applications.Comparator.
Command
(c)[source]¶ Bases:
object
-
execute
(vals, log)[source]¶ 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)[source]¶ Bases:
object
Abstract base class for a number of commands
-
class
PyFoam.Applications.Comparator.
Comparator
(args=None, **kwargs)[source]¶ Bases:
PyFoam.Applications.PyFoamApplication.PyFoamApplication
-
class
PyFoam.Applications.Comparator.
ComparatorData
(doc)[source]¶ Bases:
object
The object that holds the actual data
-
class
PyFoam.Applications.Comparator.
CopyLogCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Copies the log file to the results
-
class
PyFoam.Applications.Comparator.
DecomposeCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Decomposes a case and generates the LAM
-
class
PyFoam.Applications.Comparator.
DerivedCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Derives an additional value
-
class
PyFoam.Applications.Comparator.
DictWriteCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.SetterCommand
Writes a value to a dictionary
-
class
PyFoam.Applications.Comparator.
DictionaryCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Returns values from the chains dictionaries
-
class
PyFoam.Applications.Comparator.
EvaluationChain
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.CommandChain
Chain of evaluation commands
-
class
PyFoam.Applications.Comparator.
FieldSetterCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.SetterCommand
Common class for commands that set values on fields
-
class
PyFoam.Applications.Comparator.
FoamCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Executes a OpenFOAM-utility
-
class
PyFoam.Applications.Comparator.
FoamUtilityCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.FoamCommand
Executes a OpenFOAM-utility and extracts information
-
class
PyFoam.Applications.Comparator.
FoamVersionCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Changes the used OpenFOAM-version
-
class
PyFoam.Applications.Comparator.
GenericCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Executes a shell command
-
class
PyFoam.Applications.Comparator.
InitialCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.FieldSetterCommand
Sets an initial condition
-
class
PyFoam.Applications.Comparator.
LastResultCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Copies the result of the last time-step to the resultsd directory
-
class
PyFoam.Applications.Comparator.
PreparationChain
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.CommandChain
Chain of Preparation commands
-
class
PyFoam.Applications.Comparator.
ReconstructCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Reconstructs a case and deleted the LAM
-
class
PyFoam.Applications.Comparator.
SetDictionaryCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Sets value in the chains dictionaries
-
class
PyFoam.Applications.Comparator.
SetEnvironmentCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Sets an environment variable
-
class
PyFoam.Applications.Comparator.
SetterCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Common class for commands that operate on dictionaries