Package PyFoam :: Package Applications :: Module PyFoamApplication :: Class PyFoamApplication
[hide private]
[frames] | no frames]

Class PyFoamApplication

source code

object --+
         |
        PyFoamApplication
Known Subclasses:
DisplayBlockMesh.DisplayBlockMesh, ChangeBoundaryType.ChangeBoundaryType, CreateBoundaryPatches.CreateBoundaryPatches, UpdateDictionary.UpdateDictionary, ReadDictionary.ReadDictionary, ClusterTester.ClusterTester, CompareDictionary.CompareDictionary, CloneCase.CloneCase, Decomposer.Decomposer, Comparator.Comparator, Benchmark.Benchmark, WriteDictionary.WriteDictionary, PackCase.PackCase, Runner.Runner, ClearCase.ClearCase, UtilityRunnerApp.UtilityRunnerApp, SteadyRunner.SteadyRunner, MeshUtilityRunner.MeshUtilityRunner, FromTemplate.FromTemplate

Instance Methods [hide private]
  __init__(self, args=None, description=None, usage=None, interspersed=False, nr=3)
  addOptions(self)
Add options to the parser
  run(self)
Run the real application
  error(self, *args)
Prints an error message and exits

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__


Properties [hide private]

Inherited from object: __class__


Method Details [hide private]

__init__(self, args=None, description=None, usage=None, interspersed=False, nr=3)
(Constructor)

source code 
Parameters:
  • description - description of the command
  • 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
Overrides: object.__init__

addOptions(self)

source code 
Add options to the parser

run(self)

source code 
Run the real application

error(self, *args)

source code 
Prints an error message and exits
Parameters:
  • args - Arguments that are to be printed