Home       Trees       Indices       Help   
Package solvcon :: Module hook :: Class BlockHook
[hide private]
[frames] | no frames]

Class BlockHook

source code

Base type for hooks needing a BlockCase.

Instance Methods [hide private]
 
__init__(self, cse, **kw)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature		 source code
numpy.ndarray
_collect_interior(self, key, tovar=False, inder=False, consider_ghost=True)
Returns: the interior array hold by the solver.		 source code
numpy.ndarray
_spread_interior(self, arrg, key, consider_ghost=True)
Returns: the interior array hold by the solver.		 source code

Inherited from Hook: drop_anchor, postloop, postmarch, preloop, premarch

Inherited from Hook (private): _depend, _makedir

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

Static Methods [hide private]

Inherited from Hook (private): _deliver_anchor

Instance Variables [hide private]

Inherited from Hook: cse, info, kws, psteps

Properties [hide private]
  blk

Inherited from object: __class__

Method Details [hide private]

__init__(self, cse, **kw)
(Constructor)

source code 

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

Parameters:
  • cse - Case object.
Overrides: object.__init__
(inherited documentation)

_collect_interior(self, key, tovar=False, inder=False, consider_ghost=True)

source code 
Parameters:
  • key (str) - the name of the array to collect in a solver object.
  • tovar (bool) - flag to store collect data to case var dict.
  • inder (bool) - the array is for derived data.
  • consider_ghost (bool) - treat the array with the consideration of ghost cells. Default is True.
Returns: numpy.ndarray
the interior array hold by the solver.

_spread_interior(self, arrg, key, consider_ghost=True)

source code 
Parameters:
  • arrg (numpy.ndarray) - the global array to be spreaded.
  • key (str) - the name of the array to collect in a solver object.
  • consider_ghost (bool) - treat the arrays with the consideration of ghost cells. Default is True.
Returns: numpy.ndarray
the interior array hold by the solver.

Property Details [hide private]

blk

Get Method:
unreachable.blk(self)

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat Jan 21 09:38:33 2012 http://epydoc.sourceforge.net