Package PyFoam :: Package RunDictionary :: Module BoundaryDict :: Class BoundaryDict
[hide private]
[frames] | no frames]

Class BoundaryDict

source code

                 object --+                    
                          |                    
 Basics.Utilities.Utilities --+                
                              |                
            FileBasis.FileBasis --+            
                                  |            
          FileBasis.FileBasisBackup --+        
                                      |        
ParsedParameterFile.ParsedParameterFile --+    
                                          |    
     ParsedParameterFile.ParsedBoundaryDict --+
                                              |
                                             BoundaryDict

Handles data in a boundary-File

Instance Methods [hide private]
 
__init__(self, case, backup=False, region=None, processor=None, time=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__getitem__(self, key) source code
 
__setitem__(self, key, value) source code
 
__iter__(self) source code
 
patches(self, patchType=None)
Returns a list with the names of the patches
source code

Inherited from ParsedParameterFile.ParsedBoundaryDict: __str__, parse

Inherited from ParsedParameterFile.ParsedParameterFile: __contains__, __delitem__, __len__

Inherited from FileBasis.FileBasisBackup: restore

Inherited from FileBasis.FileBasis: baseName, closeFile, copyRest, getCaseDir, goMatch, goTo, makeTemp, openFile, purgeFile, readFile, realName, writeFile, writeFileAs

Inherited from Basics.Utilities.Utilities: execute, listDirectory, writeDictionaryHeader

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

Class Variables [hide private]

Inherited from FileBasis.FileBasis: addedString, removedString

Inherited from Basics.Utilities.Utilities: excludeNames

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, case, backup=False, region=None, processor=None, time=None)
(Constructor)

source code 

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

Parameters:
  • case - Path to the case-directory
Overrides: object.__init__

__getitem__(self, key)
(Indexing operator)

source code 
Overrides: ParsedParameterFile.ParsedParameterFile.__getitem__

__setitem__(self, key, value)
(Index assignment operator)

source code 
Overrides: ParsedParameterFile.ParsedParameterFile.__setitem__

__iter__(self)

source code 
Overrides: ParsedParameterFile.ParsedParameterFile.__iter__

patches(self, patchType=None)

source code 

Returns a list with the names of the patches

Parameters:
  • patchType - If specified only patches of the specific type are returned