EBCellFAB Class Reference

#include <EBCellFAB.H>

Inheritance diagram for EBCellFAB:

Inheritance graph
[legend]

List of all members.


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)
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 FArrayBoxgetFArrayBox () const
FArrayBoxgetFArrayBox ()
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 (const EBCellFAB &a_ebfab, 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)
EBCellFABaxby (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.
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.

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.

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

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

const FArrayBox& EBCellFAB::getFArrayBox (  )  const

FArrayBox& EBCellFAB::getFArrayBox (  ) 

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

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

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.

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

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

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.

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:

Generated on Fri Apr 28 04:03:48 2017 for Chombo + EB by  doxygen 1.5.5