BaseEBFaceFAB< T > Class Template Reference

#include <BaseEBFaceFAB.H>

Inheritance diagram for BaseEBFaceFAB< T >:

Inheritance graph
[legend]

List of all members.


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.

Public Member Functions

int numDataTypes () const
 for AggStencil
int dataType (const BaseIndex &a_baseInd) const
 for AggStencil
long offset (const BaseIndex &a_baseInd, const int a_ivar) const
 for AggStencil
T * dataPtr (int a_dataType, int a_ivar)
 for AggStencil
const T * dataPtr (int a_dataType, int a_ivar) const
 BaseEBFaceFAB ()
 BaseEBFaceFAB (const EBISBox &a_ebisBox, const Box &a_region, int a_iDir, int a_nVar)
virtual void define (const EBISBox &a_ebisBox, const Box &a_region, int a_iDir, int a_nVar)
virtual ~BaseEBFaceFAB ()
void clear ()
void setVal (const T &value)
void setVal (int ivar, const T &value)
bool isDefined () const
int nComp () const
const MiniIFFAB< T > & getMultiValuedFAB () const
MiniIFFAB< T > & getMultiValuedFAB ()
const BaseFab< T > & getSingleValuedFAB () 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< T > & copy (const BaseEBFaceFAB< T > &source)
int size (const Box &R, const Interval &comps) const
void linearOut (void *buf, const Box &R, const Interval &comps) const
void linearIn (void *buf, const Box &R, const Interval &comps)
 BaseEBFaceFAB (const Box &a_region, int a_nVar)
 Invalid but necessary for LevelData<T> to compile.
const EBISBoxgetEBISBox () const
void setCoveredFaceVal (const T &a_val, const int &a_comp, const bool &a_doMulti=true)
 BaseEBFaceFAB (const Interval &a_comps, BaseEBFaceFAB< T > &a_original)
 aliasing copy-ish constructor. Used when the 'alias' function is invoked on LevelData

Static Public Member Functions

static bool preAllocatable ()

Protected Attributes

MiniIFFAB< 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 Member Functions

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


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.

References BaseEBFaceFAB< T >::define(), and BaseEBFaceFAB< T >::setDefaultValues().

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<T> to compile.

template<class T>
BaseEBFaceFAB< T >::BaseEBFaceFAB ( const Interval a_comps,
BaseEBFaceFAB< T > &  a_original 
) [inline]

aliasing copy-ish constructor. Used when the 'alias' function is invoked on LevelData

Constructs an 'aliased' BaseEBCellFab of the requested interval of the argument BaseEBCellFab. This BaseEBCellFab does not allocate any memory, but sets its data pointer into the memory pointed to by the argument BaseEBCellFab. It is the users responsiblity to ensure this aliased BaseEBCellFab is not used after the original BaseEBCellFab has deleted its data ptr (resize, define(..) called, or destruction, etc.).

This aliased BaseEBCellFab will also generate side effects (modifying the values of data in one will modify the other's data).

This aliased BaseFab will have a_comps.size() components, starting at zero.

References MayDay::Error(), and BaseEBFaceFAB< T >::m_isDefined.

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


Member Function Documentation

template<class T>
int BaseEBFaceFAB< T >::numDataTypes (  )  const [inline]

template<class T>
int BaseEBFaceFAB< T >::dataType ( const BaseIndex a_baseInd  )  const [inline]

template<class T>
long BaseEBFaceFAB< T >::offset ( const BaseIndex a_baseInd,
const int  a_ivar 
) const [inline]

template<class T>
T* BaseEBFaceFAB< T >::dataPtr ( int  a_dataType,
int  a_ivar 
) [inline]

template<class T>
const T* BaseEBFaceFAB< T >::dataPtr ( int  a_dataType,
int  a_ivar 
) const [inline]

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

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

template<class T>
void BaseEBFaceFAB< T >::setVal ( const T &  value  )  [inline]

template<class T>
void BaseEBFaceFAB< T >::setVal ( int  ivar,
const T &  value 
) [inline]

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

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

template<class T>
const MiniIFFAB< T > & BaseEBFaceFAB< T >::getMultiValuedFAB (  )  const [inline]

template<class T>
MiniIFFAB< T > & BaseEBFaceFAB< T >::getMultiValuedFAB (  )  [inline]

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

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

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

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

Returns the FACE-CENTERED region of the fab

References CH_assert, BaseEBFaceFAB< T >::isDefined(), and BaseEBFaceFAB< T >::m_regionFace.

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

Returns the CELL-CENTERED region of the fab

References CH_assert, BaseEBFaceFAB< T >::isDefined(), and BaseEBFaceFAB< T >::m_region.

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

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

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

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

template<class T>
BaseEBFaceFAB< T > & BaseEBFaceFAB< T >::copy ( const BaseEBFaceFAB< T > &  source  )  [inline]

template<class T>
int BaseEBFaceFAB< T >::size ( const Box R,
const Interval comps 
) const [inline]

template<class T>
void BaseEBFaceFAB< T >::linearOut ( void *  buf,
const Box R,
const Interval comps 
) const [inline]

template<class T>
void BaseEBFaceFAB< T >::linearIn ( void *  buf,
const Box R,
const Interval comps 
) [inline]

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

template<class T>
void BaseEBFaceFAB< T >::setCoveredFaceVal ( const T &  a_val,
const int &  a_comp,
const bool &  a_doMulti = true 
) [inline]

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

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


Member Data Documentation

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

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

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

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

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

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

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

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


The documentation for this class was generated from the following files:

Generated on Sun Jun 24 04:24:47 2018 for Chombo + EB by  doxygen 1.5.5