EBCellFAB Class Reference

#include <EBCellFAB.H>

Inheritance diagram for EBCellFAB:

Detailed Description

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


Public Member Functions
	EBCellFAB ()
	EBCellFAB (const EBISBox &a_ebisBox, const Box &a_region, int a_nVar)
	EBCellFAB (const Interval &a_comps, EBCellFAB &a_original)
	aliasing constructor
void	define (const EBISBox &a_ebisBox, const Box &a_region, int a_nVar)
virtual	~EBCellFAB ()
const FArrayBox &	getFArrayBox () const
FArrayBox &	getFArrayBox ()
MiniIVFAB< Real > &	getMultiValuedFAB ()
const MiniIVFAB< Real > &	getMultiValuedFAB () const
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 (Real a_value, int a_srccomp, int a_numcomp)
EBCellFAB &	mult (const EBCellFAB &a_src, 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)
Real	max (int a_comp=0) const
	Returns the maximum value in the FAB for the given component.
Real	min (int a_comp=0) const
	Returns the minimum value in the FAB for the given component.
virtual Real	norm (int a_power, int a_comp, int a_numComp) const
	(Not implemented) Returns the Lp-norm of this EBCellFAB
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
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
Real	dotProduct (const EBCellFAB &ebfab2) const
	(Not implemented) Return the dot product of this EBCellFAB with another
	EBCellFAB (const Box &a_region, int a_nComp)
void	clone (const EBCellFAB &a_arg)
	good for making temps.
virtual 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)

Constructor & Destructor Documentation

EBCellFAB::EBCellFAB ( )

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::EBCellFAB	(	const Interval &	a_comps,
		EBCellFAB &	a_original
	)			`[inline]`

aliasing constructor

virtual EBCellFAB::~EBCellFAB ( ) [virtual]

EBCellFAB::EBCellFAB	(	const Box &	a_region,
		int	a_nComp
	)			`[inline]`

References MayDay::Error().

EBCellFAB::EBCellFAB ( const EBCellFAB & ebcin ) [inline, private]

References MayDay::Error().

Member Function Documentation

void EBCellFAB::define	(	const EBISBox &	a_ebisBox,
		const Box &	a_region,
		int	a_nVar
	)			`[virtual]`

Reimplemented from BaseEBCellFAB< T >.

const FArrayBox& EBCellFAB::getFArrayBox ( ) const

FArrayBox& EBCellFAB::getFArrayBox ( )

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

MiniIVFAB<Real>& EBCellFAB::getMultiValuedFAB ( ) [inline]

Reimplemented from BaseEBCellFAB< T >.

References BaseEBCellFAB< T >::m_irrFAB.

const MiniIVFAB<Real>& EBCellFAB::getMultiValuedFAB ( ) const [inline]

Reimplemented from BaseEBCellFAB< T >.

References BaseEBCellFAB< T >::m_irrFAB.

EBCellFAB& EBCellFAB::negate ( void )

Negate the values in all locations

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

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

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

done over intersection of src, dst

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

done over a_region

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

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

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

done over intersection of src, dst

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

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

EBCellFAB& EBCellFAB::mult	(	Real	a_value,
		int	a_srccomp,
		int	a_numcomp
	)

done over intersection of src, dst

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

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

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

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

done over intersection of src, dst

EBCellFAB& EBCellFAB::operator+= ( const Real & a_scalar )

EBCellFAB& EBCellFAB::operator-= ( const Real & a_scalar )

EBCellFAB& EBCellFAB::operator*= ( const Real & a_scalar )

EBCellFAB& EBCellFAB::mult ( Real a_scalar )

EBCellFAB& EBCellFAB::operator/= ( const Real & a_scalar )

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.

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.

Real EBCellFAB::max ( int a_comp = 0 ) const

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

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

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

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

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

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

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.

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.

void EBCellFAB::clone ( const EBCellFAB & a_arg )

good for making temps.

virtual void EBCellFAB::setCoveredCellVal	(	const Real &	a_val,
		const int &	a_comp,
		const bool &	a_doMulti = `true`
	)			`[virtual]`

void EBCellFAB::operator= ( const EBCellFAB & fabin ) [inline, private]

References MayDay::Error().

Member Data Documentation

bool EBCellFAB::s_verbose [static]

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

EBCellFAB.H

EBCellFAB Class Reference

Detailed Description

Public Member Functions

Static Public Attributes

Private Member Functions

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation