PyFoam.Applications.PyFoamApplication module¶
Base class for pyFoam-applications
Classes can also be called with a command-line string
-
class
PyFoam.Applications.PyFoamApplication.
PyFoamApplication
(args=None, description=None, epilog=None, examples=None, usage=None, interspersed=False, nr=None, changeVersion=True, exactNr=True, subcommands=None, inputApp=None, localConfigurationFile=None, findLocalConfigurationFile=None, **kwArgs)[source]¶ Bases:
object
This class is the base for all pyFoam-utilities
-
__dict__
= mappingproxy({'__setitem__': <function PyFoamApplication.__setitem__>, '__init__': <function PyFoamApplication.__init__>, 'getCasePath': <function PyFoamApplication.getCasePath>, 'errorPrint': <function PyFoamApplication.errorPrint>, '__module__': 'PyFoam.Applications.PyFoamApplication', 'escapeArgument': <function PyFoamApplication.escapeArgument>, 'error': <function PyFoamApplication.error>, 'run': <function PyFoamApplication.run>, '__iter__': <function PyFoamApplication.__iter__>, '__getitem__': <function PyFoamApplication.__getitem__>, 'setData': <function PyFoamApplication.setData>, 'localConfigInCWD': <function PyFoamApplication.localConfigInCWD>, '__doc__': 'This class is the base for all pyFoam-utilities', '__weakref__': <attribute '__weakref__' of 'PyFoamApplication' objects>, 'depreciationWarning': <function PyFoamApplication.depreciationWarning>, 'warning': <function PyFoamApplication.warning>, 'replaceAutoInArgs': <function PyFoamApplication.replaceAutoInArgs>, 'checkCase': <function PyFoamApplication.checkCase>, 'iteritems': <function PyFoamApplication.iteritems>, 'iterkeys': <function PyFoamApplication.iterkeys>, 'ensureGeneralOptions': <function PyFoamApplication.ensureGeneralOptions>, 'addToCaseLog': <function PyFoamApplication.addToCaseLog>, 'iDict': <class 'PyFoam.Applications.PyFoamApplication.PyFoamApplication.iDict'>, 'localConfigInArgs': <function PyFoamApplication.localConfigInArgs>, 'addLocalConfig': <function PyFoamApplication.addLocalConfig>, '__getattr__': <function PyFoamApplication.__getattr__>, '__dict__': <attribute '__dict__' of 'PyFoamApplication' objects>, 'localConfigFromCasename': <function PyFoamApplication.localConfigFromCasename>, 'silent': <function PyFoamApplication.silent>, 'getData': <function PyFoamApplication.getData>, 'localConfigInArgsFile': <function PyFoamApplication.localConfigInArgsFile>, 'addOptions': <function PyFoamApplication.addOptions>})¶
-
__init__
(args=None, description=None, epilog=None, examples=None, usage=None, interspersed=False, nr=None, changeVersion=True, exactNr=True, subcommands=None, inputApp=None, localConfigurationFile=None, findLocalConfigurationFile=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
-
__module__
= 'PyFoam.Applications.PyFoamApplication'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
addToCaseLog
(name, *text)[source]¶ Add information about the application that was run to the case-log
-
checkCase
(name, fatal=True, verbose=True)[source]¶ Check whether this is a valid OpenFOAM-case :param name: the directory-bame that is supposed to be the case :param fatal: If this is not a case then the application ends :param verbose: If this is not a case no warning is issued
-
error
(*args)[source]¶ Raise a error exception. How it will be handled is a different story :param args: Arguments to the exception
-
errorPrint
(*args)[source]¶ Prints an error message and exits :param args: Arguments that are to be printed
-
escapeArgument
(arg)[source]¶ Check if this argument has spaces etc and surround it with ” to make it copypastable
-
class
iDict
[source]¶ Bases:
dict
This class is a quick and dirty wrapper to use a dictionary like a struct
-
__dict__
= mappingproxy({'__dict__': <attribute '__dict__' of 'iDict' objects>, '__module__': 'PyFoam.Applications.PyFoamApplication', '__weakref__': <attribute '__weakref__' of 'iDict' objects>, '__doc__': 'This class is a quick and dirty wrapper to use a dictionary like a struct', '__getattr__': <function PyFoamApplication.iDict.__getattr__>})¶
-
__module__
= 'PyFoam.Applications.PyFoamApplication'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
localConfigFromCasename
(args)[source]¶ Look for the local configuration assuming that the first argument after ‘-case’ is the case directory
-
localConfigInArgs
(args)[source]¶ Assume that the first argument that is no option and a directory can have a local configuration
-
localConfigInArgsFile
(args)[source]¶ Assume that the first argument that is no option and a file can has a local configuration in the same directory
-
replaceAutoInArgs
(args)[source]¶ If the first argument is ‘auto’ replace it with the ‘application’ entry from the controlDict
-
-
exception
PyFoam.Applications.PyFoamApplication.
PyFoamApplicationException
(app, *text)[source]¶ Bases:
PyFoam.Error.FatalErrorPyFoamException
-
__module__
= 'PyFoam.Applications.PyFoamApplication'¶
-