PyFoam.Applications.CaseBuilderBackend module

Represents the actual CaseBuilder-File and other things that have to do with the Casebuilder

class PyFoam.Applications.CaseBuilderBackend.ArgWrapper(el)[source]

Bases: object

Wraps the argument element for convenient access

class PyFoam.Applications.CaseBuilderBackend.CaseBuilderDescriptionList[source]

Bases: object

Gets a list of the case-builder files found in the current path

class PyFoam.Applications.CaseBuilderBackend.CaseBuilderFile(fName)[source]

Bases: object

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

argTree()[source]
argumentDefaults()[source]
argumentDescriptions()[source]
argumentDict()[source]
argumentGroupDescription()[source]
argumentGroups()[source]
arguments()[source]
boundaries()[source]
boundaryDescriptions()[source]
boundaryPatternDict()[source]
boundaryPatterns()[source]
boundaryTree()[source]
buildCase(cName, args)[source]

Builds the case :param cName: The name of the case directory :param args: The arguments (as a dictionary)

calculateVariables(_args_)[source]

Add derived variables to the argument dictionary

description()[source]
expandVars(orig, keys=None)[source]
fieldTree()[source]
filesTree()[source]
getSingleElement(parent, name, optional=False)[source]

Get an element and check that it is the only one :param parent: the parent element :param name: The name of the element

groupArguments(name=None)[source]

Returns a list with the arguments belongin to a specific group :param name: Name of the group. If none is given, then all the arguments belonging to no group are returned

helpText()[source]
initialDir()[source]
makeBC(node, args)[source]
name()[source]
parameterTree()[source]
templatePath()[source]
varTree()[source]
verifyArguments(args)[source]

Validate the arguments with the provided code (if it exists)