Package solvcon :: Module boundcond :: Class periodic
[hide private]
[frames] | no frames]

Class periodic

source code

object --+    
         |    
        BC --+
             |
            periodic
Known Subclasses:

BC type for periodic boundary condition.

Nested Classes [hide private]

Inherited from BC: __metaclass__

Instance Methods [hide private]
 
__init__(self, **kw)
Initialize object with empty values or from another BC object.
source code
 
cloneTo(self, another)
Clone self to passed-in another BC object.
source code
 
sort(self, ref) source code
 
couple(self, rbc)
Calculate self.rclp[:,:] form the information about related BC object provided by rbc parameter.
source code

Inherited from BC: __len__, __str__, bind, feedValue, final, init, unbind

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

Static Methods [hide private]
 
couple_all(blk, bcmap)
Couple all periodic boundary conditions.
source code
Class Variables [hide private]

Inherited from BC: _pointers_, vdefaults, vnames

Instance Variables [hide private]

Inherited from BC: blk, blkn, facn, name, sern, svr, value

Properties [hide private]

Inherited from BC: fpdtypestr, is_bound, is_unbound, nvalue

Inherited from object: __class__

Method Details [hide private]

__init__(self, **kw)
(Constructor)

source code 

Initialize object with empty values or from another BC object.

Parameters:
  • bc - Another BC object.
Overrides: object.__init__
(inherited documentation)

cloneTo(self, another)

source code 

Clone self to passed-in another BC object.

Parameters:
  • another - Another BC object.
Overrides: BC.cloneTo
(inherited documentation)

couple(self, rbc)

source code 

Calculate self.rclp[:,:] form the information about related BC object provided by rbc parameter.

Parameters:
  • rbc (solvcon.boundcond.periodic) - Related BC object.
Returns:
nothing.

couple_all(blk, bcmap)
Static Method

source code 

Couple all periodic boundary conditions.

Parameters:
  • blk (solvcon.block.Block) - the block having periodic BCs to be coupled.
  • bcmap (dict) - mapper for periodic BCs.
Returns:
nothing