Chombo + EB  3.2
Public Member Functions | Private Member Functions | List of all members
EBFaceFAB Class Reference

#include <EBFaceFAB.H>

Inheritance diagram for EBFaceFAB:
Inheritance graph
[legend]

Public Member Functions

 EBFaceFAB ()
 
 EBFaceFAB (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_nComp)
 
virtual ~EBFaceFAB ()
 
const FArrayBoxgetFArrayBox () const
 
FArrayBoxgetFArrayBox ()
 
EBFaceFABoperator+= (const EBFaceFAB &a_ebfab)
 
 EBFaceFAB (const Interval &a_interval, EBFaceFAB &a_original)
 aliasing constructor More...
 
EBFaceFABplus (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBFaceFABoperator-= (const EBFaceFAB &a_ebfab)
 
EBFaceFABminus (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBFaceFABoperator*= (const EBFaceFAB &a_ebfab)
 
EBFaceFABmult (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBFaceFABoperator/= (const EBFaceFAB &a_ebfab)
 
EBFaceFABdivide (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBFaceFABoperator+= (const Real &a_scalar)
 
EBFaceFABoperator-= (const Real &a_scalar)
 
EBFaceFABoperator*= (const Real &a_scalar)
 
EBFaceFABoperator/= (const Real &a_scalar)
 
Real max (int a_comp=0) const
 Returns the maximum value for the given component in the FAB. More...
 
Real min (int a_comp=0) const
 Returns the minimum value for the given component in the FAB. More...
 
 EBFaceFAB (const Box &a_region, int a_nComp)
 
- Public Member Functions inherited from BaseEBFaceFAB< Real >
int numDataTypes () const
 for AggStencil More...
 
int dataType (const BaseIndex &a_baseInd) const
 for AggStencil More...
 
long offset (const BaseIndex &a_baseInd, const int a_ivar) const
 for AggStencil More...
 
RealdataPtr (int a_dataType, int a_ivar)
 for AggStencil More...
 
const RealdataPtr (int a_dataType, int a_ivar) const
 
 BaseEBFaceFAB ()
 
 BaseEBFaceFAB (const EBISBox &a_ebisBox, const Box &a_region, int a_iDir, int a_nVar)
 
 BaseEBFaceFAB (const Box &a_region, int a_nVar)
 Invalid but necessary for LevelData<T> to compile. More...
 
 BaseEBFaceFAB (const Interval &a_comps, BaseEBFaceFAB< Real > &a_original)
 aliasing copy-ish constructor. Used when the 'alias' function is invoked on LevelData More...
 
virtual ~BaseEBFaceFAB ()
 
void clear ()
 
void setVal (const Real &value)
 
void setVal (int ivar, const Real &value)
 
bool isDefined () const
 
int nComp () const
 
const MiniIFFAB< Real > & getMultiValuedFAB () const
 
MiniIFFAB< Real > & getMultiValuedFAB ()
 
const BaseFab< Real > & getSingleValuedFAB () const
 
BaseFab< Real > & getSingleValuedFAB ()
 
int direction () const
 
const BoxgetRegion () const
 
const BoxgetCellRegion () const
 
Realoperator() (const FaceIndex &a_facein, int a_nVarLoc)
 
const Realoperator() (const FaceIndex &a_facein, int a_nVarLoc) const
 
void copy (const Box &RegionFrom, const Interval &destInt, const Box &RegionTo, const BaseEBFaceFAB< Real > &source, const Interval &srcInt)
 
BaseEBFaceFAB< Real > & copy (const BaseEBFaceFAB< Real > &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)
 
const EBISBoxgetEBISBox () const
 
void setCoveredFaceVal (const Real &a_val, const int &a_comp, const bool &a_doMulti=true)
 

Private Member Functions

 EBFaceFAB (const EBFaceFAB &ebcin)
 
void operator= (const EBFaceFAB &ebcin)
 

Additional Inherited Members

- Static Public Member Functions inherited from BaseEBFaceFAB< Real >
static bool preAllocatable ()
 
- Protected Attributes inherited from BaseEBFaceFAB< Real >
MiniIFFAB< Realm_irrFAB
 data at faces which abut multi-valued cells More...
 
BaseFab< Realm_regFAB
 data at faces between two single-valued cells More...
 
int m_nComp
 number of data values at each face in BaseEBFaceFAB More...
 
int m_iDir
 
Box m_regionFace
 the face-centered region over which the BaseEBFaceFAB lives More...
 
Box m_region
 the cell-centered region over which the BaseEBFaceFAB lives More...
 
bool m_isDefined
 has the full define function been called for the BaseEBFaceFAB? More...
 
EBISBox m_ebisBox
 

Detailed Description

EBFaceFAB is a BaseEBFaceFAB<Real> which includes arithmetic functions.

Constructor & Destructor Documentation

EBFaceFAB::EBFaceFAB ( )
EBFaceFAB::EBFaceFAB ( const EBISBox a_ebisBox,
const Box a_region,
int  a_iDir,
int  a_nVar 
)

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

virtual EBFaceFAB::~EBFaceFAB ( )
virtual
EBFaceFAB::EBFaceFAB ( const Interval a_interval,
EBFaceFAB a_original 
)
inline

aliasing constructor

EBFaceFAB::EBFaceFAB ( const Box a_region,
int  a_nComp 
)
inline

References MayDay::Error().

EBFaceFAB::EBFaceFAB ( const EBFaceFAB ebcin)
inlineprivate

References MayDay::Error().

Member Function Documentation

void EBFaceFAB::define ( const EBISBox a_ebisBox,
const Box a_region,
int  a_iDir,
int  a_nVar 
)
virtual

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

Reimplemented from BaseEBFaceFAB< Real >.

const FArrayBox& EBFaceFAB::getFArrayBox ( ) const
FArrayBox& EBFaceFAB::getFArrayBox ( )

Does a dynamic cast of the BaseFab<Real> to a FArrayBox for arithmetic purposes.

EBFaceFAB& EBFaceFAB::operator+= ( const EBFaceFAB a_ebfab)

Both fabs need the same ebisBox and region and number of components.

EBFaceFAB& EBFaceFAB::plus ( const EBFaceFAB a_ebfab,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

Both fabs need the same ebisBox and region.

EBFaceFAB& EBFaceFAB::operator-= ( const EBFaceFAB a_ebfab)

Both fabs need the same ebisBox and region and number of components.

EBFaceFAB& EBFaceFAB::minus ( const EBFaceFAB a_ebfab,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

Both fabs need the same ebisBox and region.

EBFaceFAB& EBFaceFAB::operator*= ( const EBFaceFAB a_ebfab)

Both fabs need the same ebisBox and region and number of components.

EBFaceFAB& EBFaceFAB::mult ( const EBFaceFAB a_ebfab,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

Both fabs need the same ebisBox and region.

EBFaceFAB& EBFaceFAB::operator/= ( const EBFaceFAB a_ebfab)

Both fabs need the same ebisBox and region and number of components.

EBFaceFAB& EBFaceFAB::divide ( const EBFaceFAB a_ebfab,
int  a_srccomp,
int  a_destcomp,
int  a_numcomp 
)

Both fabs need the same ebisBox and region.

EBFaceFAB& EBFaceFAB::operator+= ( const Real a_scalar)
EBFaceFAB& EBFaceFAB::operator-= ( const Real a_scalar)
EBFaceFAB& EBFaceFAB::operator*= ( const Real a_scalar)
EBFaceFAB& EBFaceFAB::operator/= ( const Real a_scalar)
Real EBFaceFAB::max ( int  a_comp = 0) const

Returns the maximum value for the given component in the FAB.

Real EBFaceFAB::min ( int  a_comp = 0) const

Returns the minimum value for the given component in the FAB.

void EBFaceFAB::operator= ( const EBFaceFAB ebcin)
inlineprivate

References MayDay::Error().


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