PyFoam.Applications.PotentialRunner module¶
Application class that implements pyFoamSteadyRunner
-
class
PyFoam.Applications.PotentialRunner.
PotentialRunner
(args=None, **kwargs)[source]¶ Bases:
PyFoam.Applications.PyFoamApplication.PyFoamApplication
,PyFoam.Applications.CommonStandardOutput.CommonStandardOutput
,PyFoam.Applications.CommonServer.CommonServer
,PyFoam.Applications.CommonLibFunctionTrigger.CommonLibFunctionTrigger
,PyFoam.Applications.CommonParallel.CommonParallel
,PyFoam.Applications.CommonVCSCommit.CommonVCSCommit
-
__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.PotentialRunner'¶
-
-
class
PyFoam.Applications.PotentialRunner.
PotentialTrigger
(sol, correctors, tolerance, relTol, pRefValue=None, pRefCell=None, removeLibs=False, removeFunctions=False)[source]¶ Bases:
object
-
__dict__
= mappingproxy({'__module__': 'PyFoam.Applications.PotentialRunner', '__init__': <function PotentialTrigger.__init__>, 'resetIt': <function PotentialTrigger.resetIt>, '__dict__': <attribute '__dict__' of 'PotentialTrigger' objects>, '__weakref__': <attribute '__weakref__' of 'PotentialTrigger' objects>, '__doc__': None})¶
-
__init__
(sol, correctors, tolerance, relTol, pRefValue=None, pRefCell=None, removeLibs=False, removeFunctions=False)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
__module__
= 'PyFoam.Applications.PotentialRunner'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-