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

Class CaseBuilderFile

object --+
         |
        CaseBuilderFile

This class reads an XML-file that describes how to build a case and gives information about the case and if asked to builds the actual case

Instance Methods [hide private]
 
__init__(self, fName)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
 
argTree(self)
 
argumentDescriptions(self)
 
arguments(self)
 
boundaries(self)
 
boundaryDescriptions(self)
 
boundaryPatterns(self)
 
boundaryTree(self)
 
buildCase(self, cName, args)
Builds the case
 
description(self)
 
expandVars(self, orig, keys=None)
 
fieldTree(self)
 
filesTree(self)
 
getSingleElement(self, parent, name)
Get an element and check that it is the only one
 
initialDir(self)
 
makeBC(self, node, args)
 
name(self)
 
parameterTree(self)
 
templatePath(self)

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, fName)
(Constructor)

 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Parameters:
  • fName - the XML-file that describes how to build the case
Overrides: object.__init__

buildCase(self, cName, args)

 

Builds the case

Parameters:
  • cName - The name of the case directory
  • args - The arguments (as a dictionary)

getSingleElement(self, parent, name)

 

Get an element and check that it is the only one

Parameters:
  • parent - the parent element
  • name - The name of the element