Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

BaseEBFaceFAB< T > Class Template Reference

Array defined at the Faces of an Box in an EBISBox. More...

#include <BaseEBFaceFAB.H>

Inheritance diagram for BaseEBFaceFAB< T >:

Inheritance graph
[legend]
Collaboration diagram for BaseEBFaceFAB< T >:

Collaboration graph
[legend]
List of all members.

Public Methods

 BaseEBFaceFAB ()
 BaseEBFaceFAB (const EBISBox &a_ebisBox, const Box &a_region, int a_iDir, int a_nVar)
void define (const EBISBox &a_ebisBox, const Box &a_region, int a_iDir, int a_nVar)
virtual ~BaseEBFaceFAB ()
void clear ()
void setVal (T value)
bool isDefined () const
int nComp () const
const BaseIFFAB< T > & getMultiValuedFAB () const
BaseIFFAB< T > & getMultiValuedFAB ()
const BaseFab< T > & getSingleValuedFAB () const
const IntVectSetgetMultiCells () const
BaseFab< T > & getSingleValuedFAB ()
int direction () const
const BoxgetRegion () const
const BoxgetCellRegion () const
T & operator() (const FaceIndex &a_facein, int a_nVarLoc)
const T & operator() (const FaceIndex &a_facein, int a_nVarLoc) const
void copy (const Box &RegionFrom, const Interval &destInt, const Box &RegionTo, const BaseEBFaceFAB< T > &source, const Interval &srcInt)
 BaseEBFaceFAB (const Box &a_region, int a_nVar)
 invalid but necessary for leveldata to compile

const EBISBoxgetEBISBox () const

Static Public Methods

bool preAllocatable ()

Protected Attributes

BaseIFFAB< T > m_irrFAB
 data at faces which abut multi-valued cells

BaseFab< T > m_regFAB
 data at faces between two single-valued cells

int m_nComp
 number of data values at each face in BaseEBFaceFAB

int m_iDir
Box m_regionFace
 the face-centered region over which the BaseEBFaceFAB lives

Box m_region
 the cell-centered region over which the BaseEBFaceFAB lives

bool m_isDefined
 has the full define function been called for the BaseEBFaceFAB?

EBISBox m_ebisBox

Private Methods

void setDefaultValues ()
void operator= (const BaseEBFaceFAB< T > &ebcin)
 BaseEBFaceFAB (const BaseEBFaceFAB< T > &ebcin)

Detailed Description

template<class T>
class BaseEBFaceFAB< T >

Array defined at the Faces of an Box in an EBISBox.

An BaseEBFaceFAB is a templated holder for face-centered data over a region which consists of the intersection of a face-centered box and an EBISBox. At every uncovered VoF in this intersection, the BaseEBFaceFAB contains a specified number of data values. At singly valued faces, the data is stored internally in a BaseFab. At multiply-valued faces, the data is stored internally in an INFab. A multiply-valued face is defined to be a face which abuts at least one multiply-valued Face. BaseEBFaceFAB provides indexing by Face. This class does not provide a copy constructor or assignment operator for all the usual reasons.


Constructor & Destructor Documentation

template<class T>
BaseEBFaceFAB< T >::BaseEBFaceFAB   [inline]
 

template<class T>
BaseEBFaceFAB< T >::BaseEBFaceFAB const EBISBox   a_ebisBox,
const Box   a_region,
int    a_iDir,
int    a_nVar
[inline]
 

Box going into this needs to be cell-centered. Data will exist over the surrounding nodes of the box.

template<class T>
BaseEBFaceFAB< T >::~BaseEBFaceFAB   [inline, virtual]
 

template<class T>
BaseEBFaceFAB< T >::BaseEBFaceFAB const Box   a_region,
int    a_nVar
[inline]
 

invalid but necessary for leveldata to compile

template<class T>
BaseEBFaceFAB< T >::BaseEBFaceFAB const BaseEBFaceFAB< T > &    ebcin [inline, private]
 


Member Function Documentation

template<class T>
void BaseEBFaceFAB< T >::clear   [inline]
 

template<class T>
void BaseEBFaceFAB< T >::copy const Box   RegionFrom,
const Interval   destInt,
const Box   RegionTo,
const BaseEBFaceFAB< T > &    source,
const Interval   srcInt
[inline]
 

Box going into this should be CELL CENTERED. copy done over surrounding nodes.

template<class T>
void BaseEBFaceFAB< T >::define const EBISBox   a_ebisBox,
const Box   a_region,
int    a_iDir,
int    a_nVar
[inline]
 

Box going into this needs to be cell-centered. Data will exist over the surrounding nodes of the box.

template<class T>
int BaseEBFaceFAB< T >::direction   const [inline]
 

template<class T>
const Box & BaseEBFaceFAB< T >::getCellRegion   const [inline]
 

Returns the CELL-CENTERED region of the fab

template<class T>
const EBISBox & BaseEBFaceFAB< T >::getEBISBox   const [inline]
 

template<class T>
const IntVectSet & BaseEBFaceFAB< T >::getMultiCells   const [inline]
 

template<class T>
BaseIFFAB< T > & BaseEBFaceFAB< T >::getMultiValuedFAB   [inline]
 

template<class T>
const BaseIFFAB< T > & BaseEBFaceFAB< T >::getMultiValuedFAB   const [inline]
 

template<class T>
const Box & BaseEBFaceFAB< T >::getRegion   const [inline]
 

Returns the FACE-CENTERED region of the fab

template<class T>
BaseFab< T > & BaseEBFaceFAB< T >::getSingleValuedFAB   [inline]
 

template<class T>
const BaseFab< T > & BaseEBFaceFAB< T >::getSingleValuedFAB   const [inline]
 

template<class T>
bool BaseEBFaceFAB< T >::isDefined   const [inline]
 

template<class T>
int BaseEBFaceFAB< T >::nComp   const [inline]
 

template<class T>
const T & BaseEBFaceFAB< T >::operator() const FaceIndex   a_facein,
int    a_nVarLoc
const [inline]
 

template<class T>
T & BaseEBFaceFAB< T >::operator() const FaceIndex   a_facein,
int    a_nVarLoc
[inline]
 

template<class T>
void BaseEBFaceFAB< T >::operator= const BaseEBFaceFAB< T > &    ebcin [inline, private]
 

template<class T>
bool BaseEBFaceFAB< T >::preAllocatable   [inline, static]
 

template<class T>
void BaseEBFaceFAB< T >::setDefaultValues   [inline, private]
 

template<class T>
void BaseEBFaceFAB< T >::setVal   value [inline]
 


Member Data Documentation

template<class T>
EBISBox BaseEBFaceFAB< T >::m_ebisBox [protected]
 

template<class T>
int BaseEBFaceFAB< T >::m_iDir [protected]
 

template<class T>
BaseIFFAB<T> BaseEBFaceFAB< T >::m_irrFAB [protected]
 

data at faces which abut multi-valued cells

template<class T>
bool BaseEBFaceFAB< T >::m_isDefined [protected]
 

has the full define function been called for the BaseEBFaceFAB?

template<class T>
int BaseEBFaceFAB< T >::m_nComp [protected]
 

number of data values at each face in BaseEBFaceFAB

template<class T>
BaseFab<T> BaseEBFaceFAB< T >::m_regFAB [protected]
 

data at faces between two single-valued cells

template<class T>
Box BaseEBFaceFAB< T >::m_region [protected]
 

the cell-centered region over which the BaseEBFaceFAB lives

template<class T>
Box BaseEBFaceFAB< T >::m_regionFace [protected]
 

the face-centered region over which the BaseEBFaceFAB lives


The documentation for this class was generated from the following files:
Generated on Wed Apr 16 14:34:59 2003 for EBChombo by doxygen1.2.16