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

Class CaseBuilderFile

source code

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
source code
 
name(self) source code
 
description(self) source code
 
helpText(self) source code
 
argTree(self) source code
 
varTree(self) source code
 
filesTree(self) source code
 
boundaryTree(self) source code
 
fieldTree(self) source code
 
parameterTree(self) source code
 
templatePath(self) source code
 
initialDir(self) source code
 
expandVars(self, orig, keys=None) source code
 
boundaries(self) source code
 
boundaryPatterns(self) source code
 
boundaryPatternDict(self) source code
 
boundaryDescriptions(self) source code
 
argumentGroups(self) source code
 
argumentGroupDescription(self) source code
 
arguments(self) source code
 
groupArguments(self, name=None)
Returns a list with the arguments belongin to a specific group
source code
 
argumentDescriptions(self) source code
 
argumentDefaults(self) source code
 
getSingleElement(self, parent, name, optional=False)
Get an element and check that it is the only one
source code
 
makeBC(self, node, args) source code
 
verifyArguments(self, args)
Validate the arguments with the provided code (if it exists)
source code
 
calculateVariables(self, _args_)
Add derived variables to the argument dictionary
source code
 
buildCase(self, cName, args)
Builds the case
source code

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)

source code 

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__

groupArguments(self, name=None)

source code 

Returns a list with the arguments belongin to a specific group

Parameters:
  • name - Name of the group. If none is given, then all the arguments belonging to no group are returned

getSingleElement(self, parent, name, optional=False)

source code 

Get an element and check that it is the only one

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

buildCase(self, cName, args)

source code 

Builds the case

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