PyFoam.Applications.UpgradeDictionariesTo17 module

Application class that implements pyFoamUpgradeDictionariesTo17

class PyFoam.Applications.UpgradeDictionariesTo17.DictionaryUpgradeInfo[source]

Bases: object

This class knows how to detect old versions and how to upgrade them

__dict__ = mappingproxy({'__module__': 'PyFoam.Applications.UpgradeDictionariesTo17', '__doc__': 'This class knows how to detect old versions and how to upgrade them', '__init__': <function DictionaryUpgradeInfo.__init__>, 'setFile': <function DictionaryUpgradeInfo.setFile>, 'path': <function DictionaryUpgradeInfo.path>, 'disable': <function DictionaryUpgradeInfo.disable>, 'disableCallback': <function DictionaryUpgradeInfo.disableCallback>, 'needsUpgrade': <function DictionaryUpgradeInfo.needsUpgrade>, 'upgrade': <function DictionaryUpgradeInfo.upgrade>, 'makeComment': <function DictionaryUpgradeInfo.makeComment>, '__dict__': <attribute '__dict__' of 'DictionaryUpgradeInfo' objects>, '__weakref__': <attribute '__weakref__' of 'DictionaryUpgradeInfo' objects>})
__init__()[source]

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'PyFoam.Applications.UpgradeDictionariesTo17'
__weakref__

list of weak references to the object (if defined)

disable()[source]
disableCallback(opt, value, parser, *args, **kwargs)[source]
makeComment(data)[source]
needsUpgrade()[source]
path()[source]
setFile(fName)[source]
upgrade(force, printIt)[source]
class PyFoam.Applications.UpgradeDictionariesTo17.FvSolutionUpgradeInfo[source]

Bases: PyFoam.Applications.UpgradeDictionariesTo17.DictionaryUpgradeInfo

__init__()[source]

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'PyFoam.Applications.UpgradeDictionariesTo17'
checkUpgrade(content)[source]
location()[source]
manipulate(content)[source]
name()[source]
class PyFoam.Applications.UpgradeDictionariesTo17.UpgradeDictionariesTo17(args=None, description=None, **kwargs)[source]

Bases: PyFoam.Applications.PyFoamApplication.PyFoamApplication

__init__(args=None, description=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.UpgradeDictionariesTo17'
addDicts()[source]
addOptions()[source]

Add options to the parser

run()[source]

Run the real application