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

Class BC

source code

object --+
         |
        BC
Known Subclasses:

Generic boundary condition abstract class. It's the base class that all boundary condition class should subclass.

Nested Classes [hide private]
  __metaclass__
Meta class for boundary condition class.
Instance Methods [hide private]
 
__init__(self, bc=None, fpdtype=None)
Initialize object with empty values or from another BC object.
source code
 
__len__(self) source code
 
__str__(self)
str(x)
source code
 
cloneTo(self, another)
Clone self to passed-in another BC object.
source code
 
feedValue(self, vdict)
Get feed values to self boundary condition.
source code
 
init(self, **kw)
Initializer.
source code
 
final(self, **kw)
Finalizer.
source code
 
bind(self)
Set up pointers.
source code
 
unbind(self)
Release pointer.
source code

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

Class Variables [hide private]
  _pointers_ = []
list vnames = []
settable value names.
dict vdefaults = {}
default values.
Instance Variables [hide private]
solvcon.block.Block blk
the block associated with this BC object.
int blkn
serial number of self block.
numpy.ndarray facn
list of faces.
str name
name.
int sern
serial number (for certain block).
solvcon.solver.BaseSolver svr
solver object.
numpy.ndarray value
attached value for each boundary face.
Properties [hide private]
  fpdtypestr
  nvalue
  is_bound
Determine if all the pointers are fully bound.
  is_unbound
Determine if all the pointers are fully unbound.

Inherited from object: __class__

Method Details [hide private]

__init__(self, bc=None, fpdtype=None)
(Constructor)

source code 

Initialize object with empty values or from another BC object.

Parameters:
  • bc (solvcon.boundcond.BC) - Another BC object.
Overrides: object.__init__

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

cloneTo(self, another)

source code 

Clone self to passed-in another BC object.

Parameters:
  • another (solvcon.boundcond.BC) - Another BC object.

feedValue(self, vdict)

source code 

Get feed values to self boundary condition.

Parameters:
  • vdict (dict) - name and value pairs.
Returns:
nothing.

bind(self)

source code 

Set up pointers. All attributes which are pointers have to be initialized here.


Instance Variable Details [hide private]

facn

list of faces. First column is the face index in block. The second column is the face index in bndfcs. The third column is the face index of the related block (if exists).
Type:
numpy.ndarray

Property Details [hide private]

fpdtypestr

Get Method:
unreachable.fpdtypestr(self)

nvalue

Get Method:
unreachable.nvalue(self)

is_bound

Determine if all the pointers are fully bound.

Get Method:
unreachable.is_bound(self) - Determine if all the pointers are fully bound.

is_unbound

Determine if all the pointers are fully unbound.

Get Method:
unreachable.is_unbound(self) - Determine if all the pointers are fully unbound.