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'
addOptions()[source]

Add options to the parser

run()[source]

Run the real application

class PyFoam.Applications.PotentialRunner.PotentialTrigger(sol, correctors, tolerance, relTol, pRefValue=None, pRefCell=None, removeLibs=False, removeFunctions=False)[source]
__init__(sol, correctors, tolerance, relTol, pRefValue=None, pRefCell=None, removeLibs=False, removeFunctions=False)[source]
__module__ = 'PyFoam.Applications.PotentialRunner'
resetIt()[source]