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
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
ChangeEnvironmentCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Changes Environment variables by executing a script-file
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
Command
(c)[source]¶ Bases:
object
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Applications.Comparator', 'execute': <function execute>, '__doc__': None, 'doIt': <function doIt>, '__dict__': <attribute '__dict__' of 'Command' objects>, '__weakref__': <attribute '__weakref__' of 'Command' objects>, 'parallel': None, '__init__': <function __init__>})¶
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
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
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Applications.Comparator', 'execute': <function execute>, '__dict__': <attribute '__dict__' of 'CommandChain' objects>, 'hasObjectOfType': <function hasObjectOfType>, '__weakref__': <attribute '__weakref__' of 'CommandChain' objects>, '__doc__': 'Abstract base class for a number of commands', '__init__': <function __init__>})¶
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Applications.Comparator.
Comparator
(args=None, **kwargs)[source]¶ Bases:
PyFoam.Applications.PyFoamApplication.PyFoamApplication
-
__init__
(args=None, **kwargs)[source]¶ 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'¶
-
-
class
PyFoam.Applications.Comparator.
ComparatorData
(doc)[source]¶ Bases:
object
The object that holds the actual data
-
_ComparatorData__parseBase
(e)¶ Parameters: e – The ‘base’-element
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Applications.Comparator', '__len__': <function __len__>, '__getitem__': <function __getitem__>, '__dict__': <attribute '__dict__' of 'ComparatorData' objects>, '__weakref__': <attribute '__weakref__' of 'ComparatorData' objects>, '__doc__': ' The object that holds the actual data', '__init__': <function __init__>, '_ComparatorData__parseBase': <function __parseBase>})¶
-
__getitem__
(nr)[source]¶ Parameters: nr – Number of the variation Returns: dictionary with the variation
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
PyFoam.Applications.Comparator.
CopyLogCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Copies the log file to the results
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
DecomposeCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Decomposes a case and generates the LAM
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
DerivedCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Derives an additional value
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
DictWriteCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.SetterCommand
Writes a value to a dictionary
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
DictionaryCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Returns values from the chains dictionaries
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
EvaluationChain
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.CommandChain
Chain of evaluation commands
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
FieldSetterCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.SetterCommand
Common class for commands that set values on fields
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
FoamCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Executes a OpenFOAM-utility
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
FoamUtilityCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.FoamCommand
Executes a OpenFOAM-utility and extracts information
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
FoamVersionCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Changes the used OpenFOAM-version
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
GenericCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Executes a shell command
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
InitialCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.FieldSetterCommand
Sets an initial condition
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
LastResultCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Copies the result of the last time-step to the resultsd directory
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
PreparationChain
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.CommandChain
Chain of Preparation commands
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
ReconstructCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Reconstructs a case and deleted the LAM
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
SetDictionaryCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Sets value in the chains dictionaries
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
SetEnvironmentCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Sets an environment variable
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
SetterCommand
(c)[source]¶ Bases:
PyFoam.Applications.Comparator.Command
Common class for commands that operate on dictionaries
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
-
class
PyFoam.Applications.Comparator.
Variation
(e)[source]¶ Bases:
object
Represents one variation
-
__dict__
= dict_proxy({'__module__': 'PyFoam.Applications.Comparator', '__len__': <function __len__>, '__getitem__': <function __getitem__>, '__dict__': <attribute '__dict__' of 'Variation' objects>, '__str__': <function __str__>, '__weakref__': <attribute '__weakref__' of 'Variation' objects>, '__doc__': 'Represents one variation', '__init__': <function __init__>})¶
-
__module__
= 'PyFoam.Applications.Comparator'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-