EBFaceFAB Class Reference

#include <EBFaceFAB.H>

Inheritance diagram for EBFaceFAB:

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 FArrayBox &	getFArrayBox () const
FArrayBox &	getFArrayBox ()
EBFaceFAB &	operator+= (const EBFaceFAB &a_ebfab)
	EBFaceFAB (const Interval &a_interval, EBFaceFAB &a_original)
	aliasing constructor More...
EBFaceFAB &	plus (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBFaceFAB &	operator-= (const EBFaceFAB &a_ebfab)
EBFaceFAB &	minus (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBFaceFAB &	operator*= (const EBFaceFAB &a_ebfab)
EBFaceFAB &	mult (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBFaceFAB &	operator/= (const EBFaceFAB &a_ebfab)
EBFaceFAB &	divide (const EBFaceFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBFaceFAB &	operator+= (const Real &a_scalar)
EBFaceFAB &	operator-= (const Real &a_scalar)
EBFaceFAB &	operator*= (const Real &a_scalar)
EBFaceFAB &	operator/= (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...
Real *	dataPtr (int a_dataType, int a_ivar)
	for AggStencil More...
const Real *	dataPtr (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 Box &	getRegion () const
const Box &	getCellRegion () const
Real &	operator() (const FaceIndex &a_facein, int a_nVarLoc)
const Real &	operator() (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 EBISBox &	getEBISBox () 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 ()
Public Attributes inherited from BaseEBFaceFAB< Real >
bool	m_verbose
Protected Attributes inherited from BaseEBFaceFAB< Real >
MiniIFFAB< Real >	m_irrFAB
	data at faces which abut multi-valued cells More...
BaseFab< Real >	m_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() [1/5]

EBFaceFAB::EBFaceFAB

(

)

EBFaceFAB() [2/5]

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.

~EBFaceFAB()

virtual EBFaceFAB::~EBFaceFAB ( )

virtual

EBFaceFAB() [3/5]

EBFaceFAB::EBFaceFAB ( const Interval &  a_interval, EBFaceFAB &  a_original  )

inline

aliasing constructor

References divide(), max(), min(), minus(), mult(), operator*=(), operator+=(), operator-=(), operator/=(), and plus().

EBFaceFAB() [4/5]

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

inline

References MayDay::Error().

EBFaceFAB() [5/5]

EBFaceFAB::EBFaceFAB ( const EBFaceFAB &  ebcin )

inlineprivate

References MayDay::Error().

Member Function Documentation

define()

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 >.

getFArrayBox() [1/2]

const FArrayBox& EBFaceFAB::getFArrayBox

(

)

const

getFArrayBox() [2/2]

FArrayBox& EBFaceFAB::getFArrayBox

(

)

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

operator+=() [1/2]

EBFaceFAB& EBFaceFAB::operator+=

(

const EBFaceFAB &

a_ebfab

)

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

Referenced by EBFaceFAB().

plus()

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

Both fabs need the same ebisBox and region.

Referenced by EBFaceFAB().

operator-=() [1/2]

EBFaceFAB& EBFaceFAB::operator-=

(

const EBFaceFAB &

a_ebfab

)

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

Referenced by EBFaceFAB().

minus()

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

Both fabs need the same ebisBox and region.

Referenced by EBFaceFAB().

operator*=() [1/2]

EBFaceFAB& EBFaceFAB::operator*=

(

const EBFaceFAB &

a_ebfab

)

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

Referenced by EBFaceFAB().

mult()

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

Both fabs need the same ebisBox and region.

Referenced by EBFaceFAB().

operator/=() [1/2]

EBFaceFAB& EBFaceFAB::operator/=

(

const EBFaceFAB &

a_ebfab

)

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

Referenced by EBFaceFAB().

divide()

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

Both fabs need the same ebisBox and region.

Referenced by EBFaceFAB().

operator+=() [2/2]

EBFaceFAB& EBFaceFAB::operator+=

(

const Real &

a_scalar

)

operator-=() [2/2]

EBFaceFAB& EBFaceFAB::operator-=

(

const Real &

a_scalar

)

operator*=() [2/2]

EBFaceFAB& EBFaceFAB::operator*=

(

const Real &

a_scalar

)

operator/=() [2/2]

EBFaceFAB& EBFaceFAB::operator/=

(

const Real &

a_scalar

)

max()

Real EBFaceFAB::max

(

int

a_comp = 0

)

const

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

Referenced by EBFaceFAB().

min()

Real EBFaceFAB::min

(

int

a_comp = 0

)

const

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

Referenced by EBFaceFAB().

operator=()

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

inlineprivate

References MayDay::Error().

---

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

• EBFaceFAB.H