Chombo + EB + MF  3.2
Public Member Functions | Static Public Attributes | Private Member Functions | List of all members
EBCellFAB Class Reference

#include <EBCellFAB.H>

Inheritance diagram for EBCellFAB:
Inheritance graph
[legend]

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 More...
 
void define (const EBISBox &a_ebisBox, const Box &a_region, int a_nVar)
 
virtual ~EBCellFAB ()
 
const FArrayBoxgetFArrayBox () const
 
FArrayBoxgetFArrayBox ()
 
MiniIVFAB< Real > & getMultiValuedFAB ()
 
const MiniIVFAB< Real > & getMultiValuedFAB () const
 
EBCellFABnegate (void)
 
EBCellFABoperator+= (const EBCellFAB &a_ebfab)
 
EBCellFABplus (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBCellFABplus (const EBCellFAB &a_ebfab, const Box &a_region, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBCellFABoperator-= (const EBCellFAB &a_ebfab)
 
EBCellFABminus (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBCellFABoperator*= (const EBCellFAB &a_ebfab)
 
EBCellFABmult (Real a_value, int a_srccomp, int a_numcomp)
 
EBCellFABmult (const EBCellFAB &a_src, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBCellFABoperator/= (const EBCellFAB &a_ebfab)
 
EBCellFABdivide (const EBCellFAB &a_ebfab, int a_srccomp, int a_destcomp, int a_numcomp)
 
EBCellFABoperator+= (const Real &a_scalar)
 
EBCellFABoperator-= (const Real &a_scalar)
 
EBCellFABoperator*= (const Real &a_scalar)
 
EBCellFABmult (Real a_scalar)
 
EBCellFABoperator/= (const Real &a_scalar)
 
EBCellFABplus (const EBCellFAB &a_src, Real a_scalar)
 
EBCellFABaxby (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. 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...
 
virtual void setCoveredCellVal (const Real &a_val, const int &a_comp, const bool &a_doMulti=true)
 
- 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...
 
RealdataPtr (int a_dataType, int a_ivar)
 for AggStencil More...
 
const RealdataPtr (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 BoxgetRegion () const
 
const Boxbox () const
 
Vector< VolIndexgetMultiCells () const
 has to be by value because sometimes the vector does not exist. More...
 
const BaseIVFAB< Real > & getMultiValuedFAB () const
 
BaseIVFAB< Real > & getMultiValuedFAB ()
 
const BaseFab< Real > & getSingleValuedFAB () const
 
BaseFab< Real > & getSingleValuedFAB ()
 
const Realoperator() (const VolIndex &a_ndin, int a_nVarLoc, int a_isKnownMultiValued=0) const
 
Realoperator() (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 EBISBoxgetEBISBox () const
 

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< Realm_irrFAB
 data at multi-valued cells More...
 
BaseFab< Realm_regFAB
 data at single-valued cells More...
 
EBISBox m_ebisBox
 
Box m_region
 
bool m_hasMultiCells
 
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::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)
inlineprivate

References MayDay::Error().

Member Function Documentation

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

Reimplemented from BaseEBCellFAB< Real >.

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
const MiniIVFAB<Real>& EBCellFAB::getMultiValuedFAB ( ) const
inline
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

Reimplemented from BaseEBCellFAB< Real >.

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

References MayDay::Error().

Member Data Documentation

bool EBCellFAB::s_verbose
static

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