EBFluxFAB Class Reference

#include <EBFluxFAB.H>

List of all members.


Detailed Description

A EBFaceFAB-like container for edge-centered fluxes.

This is a class to contain face-centered fluxes on a box.

Public Member Functions

 EBFluxFAB ()
 default constructor
 ~EBFluxFAB ()
 destructor
void clear ()
 this function returns the EBFluxFAB to the undefined state
EBFluxFABoperator+= (const EBFluxFAB &a_ebfab)
EBFluxFABoperator-= (const EBFluxFAB &a_ebfab)
EBFluxFABoperator*= (const EBFluxFAB &a_ebfab)
EBFluxFABoperator/= (const EBFluxFAB &a_ebfab)
const Boxbox () const
void define (const EBFluxFAB &a_fb)
Real max (int a_dir, int a_comp=0) const
Real min (int a_dir, int a_comp=0) const
int nComp () const
 { access functions}
const BoxgetRegion () const
 returns cell-centered box which defines fluxBox
EBFaceFABoperator[] (const int dir)
 returns EBFaceFAB in direction dir
const EBFaceFABoperator[] (const int dir) const
 constant version
void setVal (const Real &val)
void clone (const EBFluxFAB &a_input)
 defines this from input and copies the values
void copy (const Box &Rfrom, const Interval &Cdest, const Box &Rto, const EBFluxFAB &src, const Interval &Csrc)
bool isDefined () const
 EBFluxFAB (const EBISBox &a_ebisBox, const Box &bx, int n)
void define (const EBISBox &a_ebisBox, const Box &bx, int n)
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)
void alias (Vector< EBFaceFAB * > a_inputFAB)
 EBFluxFAB (const Box &bx, int n)
 Invalid but necessary for LevelData<EBFluxFAB> to compile.
EBISBox getEBISBox () const

Static Public Member Functions

static int preAllocatable ()

Protected Member Functions

void setDefaultValues ()

Protected Attributes

bool m_aliased
 true if facefabs set by hand, false otherwise
Box m_region
EBISBox m_ebisBox
int m_nComp
bool m_isDefined
Tuple< EBFaceFAB *, CH_SPACEDIM > m_fluxes
 CH_SPACEDIM EBFaceFABes which hold fluxes.

Private Member Functions

 EBFluxFAB (const EBFluxFAB &)
 these are disallowed
void operator= (const EBFluxFAB &)


Constructor & Destructor Documentation

EBFluxFAB::EBFluxFAB (  ) 

default constructor

EBFluxFAB::~EBFluxFAB (  ) 

destructor

EBFluxFAB::EBFluxFAB ( const EBISBox a_ebisBox,
const Box bx,
int  n 
)

EBFluxFAB::EBFluxFAB ( const Box bx,
int  n 
) [inline]

Invalid but necessary for LevelData<EBFluxFAB> to compile.

References MayDay::Error().

EBFluxFAB::EBFluxFAB ( const EBFluxFAB  )  [inline, private]

these are disallowed

References MayDay::Error().


Member Function Documentation

static int EBFluxFAB::preAllocatable (  )  [inline, static]

This stuff required by LevelData in parallel:

void EBFluxFAB::clear (  ) 

this function returns the EBFluxFAB to the undefined state

EBFluxFAB& EBFluxFAB::operator+= ( const EBFluxFAB a_ebfab  )  [inline]

References m_fluxes, and SpaceDim.

EBFluxFAB& EBFluxFAB::operator-= ( const EBFluxFAB a_ebfab  )  [inline]

References m_fluxes, and SpaceDim.

EBFluxFAB& EBFluxFAB::operator*= ( const EBFluxFAB a_ebfab  )  [inline]

References m_fluxes, and SpaceDim.

EBFluxFAB& EBFluxFAB::operator/= ( const EBFluxFAB a_ebfab  )  [inline]

References m_fluxes, and SpaceDim.

const Box& EBFluxFAB::box (  )  const [inline]

References getRegion().

Referenced by define().

void EBFluxFAB::define ( const EBFluxFAB a_fb  )  [inline]

References box(), getEBISBox(), and nComp().

Real EBFluxFAB::max ( int  a_dir,
int  a_comp = 0 
) const [inline]

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

Parameters:
a_dir The direction in which the maximum value will be returned.
a_comp The component whose maximum value will be returned.

References m_fluxes.

Real EBFluxFAB::min ( int  a_dir,
int  a_comp = 0 
) const [inline]

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

Parameters:
a_dir The direction in which the minimum value will be returned.
a_comp The component whose minimum value will be returned.

References m_fluxes.

int EBFluxFAB::nComp (  )  const

{ access functions}

number of components

Referenced by define().

const Box& EBFluxFAB::getRegion (  )  const

returns cell-centered box which defines fluxBox

Referenced by box().

EBFaceFAB& EBFluxFAB::operator[] ( const int  dir  ) 

returns EBFaceFAB in direction dir

const EBFaceFAB& EBFluxFAB::operator[] ( const int  dir  )  const

constant version

void EBFluxFAB::setVal ( const Real val  ) 

void EBFluxFAB::clone ( const EBFluxFAB a_input  ) 

defines this from input and copies the values

void EBFluxFAB::copy ( const Box Rfrom,
const Interval Cdest,
const Box Rto,
const EBFluxFAB src,
const Interval Csrc 
)

Copies from a subsection of one box into another. Assumes the boxes are both in the same index space, and that box R is completely contained in both the src and destination boxes. This function equired by BoxLayoutData

bool EBFluxFAB::isDefined (  )  const

void EBFluxFAB::define ( const EBISBox a_ebisBox,
const Box bx,
int  n 
)

int EBFluxFAB::size ( const Box R,
const Interval comps 
) const

void EBFluxFAB::linearOut ( void *  buf,
const Box R,
const Interval comps 
) const

void EBFluxFAB::linearIn ( void *  buf,
const Box R,
const Interval comps 
)

void EBFluxFAB::alias ( Vector< EBFaceFAB * >  a_inputFAB  ) 

Can only be used for an undefined ebfluxfab. Turns off deletion of pointers.

EBISBox EBFluxFAB::getEBISBox (  )  const [inline]

References m_ebisBox.

Referenced by define().

void EBFluxFAB::setDefaultValues (  )  [protected]

void EBFluxFAB::operator= ( const EBFluxFAB  )  [inline, private]

References MayDay::Error().


Member Data Documentation

bool EBFluxFAB::m_aliased [protected]

true if facefabs set by hand, false otherwise

Box EBFluxFAB::m_region [protected]

Referenced by getEBISBox().

int EBFluxFAB::m_nComp [protected]

bool EBFluxFAB::m_isDefined [protected]

Tuple<EBFaceFAB*, CH_SPACEDIM> EBFluxFAB::m_fluxes [protected]

CH_SPACEDIM EBFaceFABes which hold fluxes.

Referenced by max(), min(), operator*=(), operator+=(), operator-=(), and operator/=().


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

Generated on Mon Jun 26 03:27:06 2017 for Chombo + EB + MF by  doxygen 1.5.5