EBCellFAB Class Reference

#include <EBCellFAB.H>

Inheritance diagram for EBCellFAB:

Public Member Functions
	EBCellFAB ()
	EBCellFAB (const EBISBox &a_ebisBox, const Box &a_region, int a_nVar)
void	define (const EBISBox &a_ebisBox, const Box &a_region, int a_nVar)
void	setInvalidData (const Real &a_val, const int &a_comp)
virtual	~EBCellFAB ()
const FArrayBox &	getFArrayBox () const
FArrayBox &	getFArrayBox ()
EBCellFAB &	negate (void)
EBCellFAB &	operator+= (const EBCellFAB &a_ebfab)
EBCellFAB &	plus (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBCellFAB &	plus (const EBCellFAB &a_ebfab, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp)
EBCellFAB &	operator-= (const EBCellFAB &a_ebfab)
EBCellFAB &	minus (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBCellFAB &	operator*= (const EBCellFAB &a_ebfab)
EBCellFAB &	mult (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBCellFAB &	operator/= (const EBCellFAB &a_ebfab)
EBCellFAB &	divide (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
EBCellFAB &	operator+= (const Real &a_scalar)
EBCellFAB &	operator-= (const Real &a_scalar)
EBCellFAB &	operator*= (const Real &a_scalar)
EBCellFAB &	mult (Real a_scalar)
EBCellFAB &	operator/= (const Real &a_scalar)
EBCellFAB &	plus (const EBCellFAB &a_src, Real a_scalar)
EBCellFAB &	axby (const EBCellFAB &a_X, const EBCellFAB &a_Y, const Real &a_A, const Real &a_B)
EBCellFAB &	axby (const EBCellFAB &a_X, const EBCellFAB &a_Y, const Real &a_A, const Real &a_B, const int &a_destComp, const int &a_xComp, const int &a_yComp)
Real	max (int a_comp=0) const
	Returns the maximum value in the FAB for the given component. More...
Real	min (int a_comp=0) const
	Returns the minimum value in the FAB for the given component. More...
virtual Real	norm (int a_power, int a_comp, int a_numComp) const
	(Not implemented) Returns the Lp-norm of this EBCellFAB More...
virtual Real	norm (const Box &a_subbox, int a_power, int a_comp, int a_numComp) const
	(Not implemented) Returns the Lp-norm of this EBCellFAB within a region More...
virtual Real	sumPow (const Box &a_subbox, int a_power, int a_comp, int a_numComp) const
	(Not implemented) Returns a sum of powers of a subset of this EBCellFAB More...
Real	dotProduct (const EBCellFAB &ebfab2) const
	(Not implemented) Return the dot product of this EBCellFAB with another More...
	EBCellFAB (const Box &a_region, int a_nComp)
void	clone (const EBCellFAB &a_arg)
	good for making temps. More...
Public Member Functions inherited from BaseEBCellFAB< 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
	for AggStencil More...
	BaseEBCellFAB ()
	BaseEBCellFAB (const EBISBox &a_ebisBox, const Box &a_region, int a_nVar)
	BaseEBCellFAB (const Interval &a_comps, BaseEBCellFAB< Real > &a_original)
	aliasing copy-ish constructor. Used when the 'alias' function is invoked on LevelData More...
	BaseEBCellFAB (const Box &a_region, int a_nVar)
	invalid but necessary for leveldata to compile More...
virtual	~BaseEBCellFAB ()
void	clear ()
void	setVal (const Real &value)
void	setVal (int ivar, const Real &value)
void	setVal (const Real &value, const Box &a_box, int a_nstart, int a_numcomp)
bool	isDefined () const
int	nComp () const
const Box &	getRegion () const
const Box &	box () const
const IntVectSet &	getMultiCells () const
const BaseIVFAB< Real > &	getMultiValuedFAB () const
BaseIVFAB< Real > &	getMultiValuedFAB ()
const BaseFab< Real > &	getSingleValuedFAB () const
BaseFab< Real > &	getSingleValuedFAB ()
const Real &	operator() (const VolIndex &a_ndin, int a_nVarLoc, int a_isKnownMultiValued=0) const
Real &	operator() (const VolIndex &a_ndin, int a_nVarLoc, int a_isKnownMultiValued=0)
void	fill (Real *array, const VolIndex &a_ndin, const Interval &a_comps) const
void	assign (const Real *array, const VolIndex &a_ndin, const Interval &a_comps)
void	copy (const Box &RegionFrom, const Interval &destInt, const Box &RegionTo, const BaseEBCellFAB< Real > &source, const Interval &srcInt)
BaseEBCellFAB< Real > &	copy (const BaseEBCellFAB< 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	setCoveredCellVal (const Real &a_val, const int &a_comp, const bool &a_doMulti=true)

Static Public Attributes
static bool	s_verbose

Private Member Functions
	EBCellFAB (const EBCellFAB &ebcin)
void	operator= (const EBCellFAB &fabin)

Additional Inherited Members
Static Public Member Functions inherited from BaseEBCellFAB< Real >
static int	preAllocatable ()
Protected Member Functions inherited from BaseEBCellFAB< Real >
void	setDefaultValues ()
Protected Attributes inherited from BaseEBCellFAB< Real >
MiniIVFAB< Real >	m_irrFAB
	data at multi-valued cells More...
BaseFab< Real >	m_regFAB
	data at single-valued cells More...
EBISBox	m_ebisBox
int	m_nComp
Box	m_region
	region over which the BaseEBCellFAB exists More...
IntVectSet	m_multiCells
	whether each given cell is multi-valued More...
bool	m_hasMultiCells
	is m_multiCells not empty? More...
bool	m_isDefined
	has full define function been called? More...

Detailed Description

EBCellFAB is a BaseEBCellFAB<Real> which includes arithmetic functions.

Constructor & Destructor Documentation

EBCellFAB() [1/4]

EBCellFAB::EBCellFAB

(

)

EBCellFAB() [2/4]

EBCellFAB::EBCellFAB	(	const EBISBox &	a_ebisBox,
		const Box &	a_region,
		int	a_nVar
	)

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

~EBCellFAB()

virtual EBCellFAB::~EBCellFAB ( )

virtual

EBCellFAB() [3/4]

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

inline

References clone(), and MayDay::Error().

EBCellFAB() [4/4]

EBCellFAB::EBCellFAB ( const EBCellFAB &  ebcin )

inlineprivate

References MayDay::Error().

Member Function Documentation

define()

void EBCellFAB::define ( const EBISBox &  a_ebisBox, const Box &  a_region, int  a_nVar  )

virtual

Reimplemented from BaseEBCellFAB< Real >.

setInvalidData()

void EBCellFAB::setInvalidData	(	const Real &	a_val,
		const int &	a_comp
	)

getFArrayBox() [1/2]

const FArrayBox& EBCellFAB::getFArrayBox

(

)

const

getFArrayBox() [2/2]

FArrayBox& EBCellFAB::getFArrayBox

(

)

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

negate()

EBCellFAB& EBCellFAB::negate

(

void

)

Negate the values in all locations

operator+=() [1/2]

EBCellFAB& EBCellFAB::operator+=

(

const EBCellFAB &

a_ebfab

)

done over intersection of src, dst Both fabs need the same ncomp

plus() [1/3]

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

done over intersection of src, dst

plus() [2/3]

EBCellFAB& EBCellFAB::plus	(	const EBCellFAB &	a_ebfab,
		const Box &	a_region,
		int	a_srccomp,
		int	a_destcomp,
		int	a_numcomp
	)

done over a_region

operator-=() [1/2]

EBCellFAB& EBCellFAB::operator-=

(

const EBCellFAB &

a_ebfab

)

done over intersection of src, dst Both fabs need the same ncomp

minus()

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

done over intersection of src, dst

operator*=() [1/2]

EBCellFAB& EBCellFAB::operator*=

(

const EBCellFAB &

a_ebfab

)

done over intersection of src, dst Both fabs need the same ncomp

mult() [1/2]

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

done over intersection of src, dst

operator/=() [1/2]

EBCellFAB& EBCellFAB::operator/=

(

const EBCellFAB &

a_ebfab

)

done over intersection of src, dst Both fabs need the same ncomp

divide()

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

done over intersection of src, dst

operator+=() [2/2]

EBCellFAB& EBCellFAB::operator+=

(

const Real &

a_scalar

)

operator-=() [2/2]

EBCellFAB& EBCellFAB::operator-=

(

const Real &

a_scalar

)

operator*=() [2/2]

EBCellFAB& EBCellFAB::operator*=

(

const Real &

a_scalar

)

mult() [2/2]

EBCellFAB& EBCellFAB::mult

(

Real

a_scalar

)

operator/=() [2/2]

EBCellFAB& EBCellFAB::operator/=

(

const Real &

a_scalar

)

plus() [3/3]

EBCellFAB& EBCellFAB::plus	(	const EBCellFAB &	a_src,
		Real	a_scalar
	)

Current FAB += a_src FAB * a_scalar. Both fabs need the same ebisBox and region.

axby() [1/2]

EBCellFAB& EBCellFAB::axby	(	const EBCellFAB &	a_X,
		const EBCellFAB &	a_Y,
		const Real &	a_A,
		const Real &	a_B
	)

Current FAB = a_X FAB * a_A + a_Y FAB * a_B.

axby() [2/2]

EBCellFAB& EBCellFAB::axby	(	const EBCellFAB &	a_X,
		const EBCellFAB &	a_Y,
		const Real &	a_A,
		const Real &	a_B,
		const int &	a_destComp,
		const int &	a_xComp,
		const int &	a_yComp
	)

Current FAB = a_X FAB * a_A + a_Y FAB * a_B.

max()

Real EBCellFAB::max

(

int

a_comp = 0

)

const

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

min()

Real EBCellFAB::min

(

int

a_comp = 0

)

const

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

norm() [1/2]

virtual Real EBCellFAB::norm ( int  a_power, int  a_comp, int  a_numComp  ) const

virtual

(Not implemented) Returns the Lp-norm of this EBCellFAB

(Not implemented) Returns the Lp-norm of this EBCellFAB using components (a_comp : a_comp + a_numcomp - 1). a_power < 0 -> ERROR. a_power = 0 -> infinity norm (max norm). a_power = 1 -> L1-norm a_power > 1 -> Lp-norm

norm() [2/2]

virtual Real EBCellFAB::norm ( const Box &  a_subbox, int  a_power, int  a_comp, int  a_numComp  ) const

virtual

(Not implemented) Returns the Lp-norm of this EBCellFAB within a region

(Not implemented) Returns the Lp-norm of this EBCellFAB using components (a_comp : a_comp + a_numcomp - 1) and within the a_subbox. a_power < 0 -> ERROR. a_power = 0 -> infinity norm (max norm). a_power = 1 -> L1-norm a_power > 1 -> Lp-norm

sumPow()

virtual Real EBCellFAB::sumPow ( const Box &  a_subbox, int  a_power, int  a_comp, int  a_numComp  ) const

virtual

(Not implemented) Returns a sum of powers of a subset of this EBCellFAB

(Not implemented) Returns a sum of powers of a subset of this EBCellFAB, specifically components a_comp to a_comp+a_numcomp-1 within a_subbox. a_power >= 2 only.

dotProduct()

Real EBCellFAB::dotProduct

(

const EBCellFAB &

ebfab2

)

const

(Not implemented) Return the dot product of this EBCellFAB with another

(Not implemented) Return the dot product of this EBCellFAB and "ebfab2" over their overlap region and all components.

clone()

void EBCellFAB::clone

(

const EBCellFAB &

a_arg

)

good for making temps.

Referenced by EBCellFAB().

operator=()

void EBCellFAB::operator= ( const EBCellFAB &  fabin )

inlineprivate

References MayDay::Error(), and writeVectorLevelName().

Member Data Documentation

s_verbose

bool EBCellFAB::s_verbose

static

---

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

• EBCellFAB.H