BlockRegister Class Reference

#include <BlockRegister.H>

List of all members.


Detailed Description

Class to hold data on a mapped multiblock domain block boundary.

Constructor, destructor, and defines.

int m_verbosity
bool m_isOpen
BlockBaseRegister< FArrayBoxm_fluxRegister
BlockBaseRegister< FArrayBoxm_auxRegister
 BlockRegister ()
 Empty constructor.
 BlockRegister (const MultiBlockCoordSys *a_mblock, const DisjointBoxLayout &a_grids, const int &a_ghost=0)
 Constructor.
virtual ~BlockRegister ()
 virtual destructor
void define (const MultiBlockCoordSys *a_mblock, const DisjointBoxLayout &a_grids, const int &a_ghost=0)
 Define function that matches constructor.
virtual void setVerbose (int a_verbose)
 Set verbosity.
void storeFlux (const FArrayBox &a_flux, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side)
 Store fluxes on block-boundary faces.
void incrementFlux (const FArrayBox &a_flux, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side)
 increment fluxes on block-boundary faces.
void storeAux (const FArrayBox &a_data, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side)
 Store auxiliary data on block-boundary faces including layers of ghost faces.
void incrementAux (const FArrayBox &a_data, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side)
 Store auxiliary data on block-boundary faces including layers of ghost faces.
void close ()
void setToZero (const int a_n_comp=-1)
bool hasInterface (const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side) const
 Returns whether or not a box has a block-boundary interface on one of its faces.
void getFlux (FArrayBox &a_flux, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side, Side::LoHiSide a_sideData) const
 Return fluxes on a block-boundary interface of a box, if hasInterface(a_dataIndex, a_dir, a_side) is true.
void getAux (FArrayBox &a_data, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side, Side::LoHiSide a_sideData) const
 Return auxiliary data on a block-boundary interface of a box, if hasInterface(a_dataIndex, a_dir, a_side) is true.
bool isNotClosed () const
 Returns true if register is open, false otherwise.
bool isClosed () const
 Returns false if register is open, true otherwise.

Constructor & Destructor Documentation

BlockRegister::BlockRegister (  )  [inline]

Empty constructor.

BlockRegister::BlockRegister ( const MultiBlockCoordSys a_mblock,
const DisjointBoxLayout a_grids,
const int &  a_ghost = 0 
)

Constructor.

– a_mblock: Pointer to multiblock coordinate system. – a_grids: DisjointBoxLayout over which multiblock grid is defined. – a_ghost: Extension of register domain for auxiliary data.

Parameters:
a_grids  CELL-centered grids
a_ghost  ghost width for auxiliary data

virtual BlockRegister::~BlockRegister (  )  [virtual]

virtual destructor


Member Function Documentation

void BlockRegister::define ( const MultiBlockCoordSys a_mblock,
const DisjointBoxLayout a_grids,
const int &  a_ghost = 0 
)

Define function that matches constructor.

– a_mblock: Pointer to multiblock coordinate system. – a_grids: DisjointBoxLayout over which multiblock grid is defined. – a_ghost: Extension of register domain for auxiliary data.

Parameters:
a_grids  CELL-centered grids
a_ghost  ghost width for auxiliary data

virtual void BlockRegister::setVerbose ( int  a_verbose  )  [virtual]

Set verbosity.

Default is 0. Positive values output increasing amounts of information.

void BlockRegister::storeFlux ( const FArrayBox a_flux,
const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side 
)

Store fluxes on block-boundary faces.

– a_flux: Face-centered flux to be stored. – a_dataIndex: Index of box where flux has been computed. – a_dir: Direction of the face. – a_side: Low or high side of the box where the block-boundary face lies.

void BlockRegister::incrementFlux ( const FArrayBox a_flux,
const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side 
)

increment fluxes on block-boundary faces.

– a_flux: Face-centered flux to be stored. – a_dataIndex: Index of box where flux has been computed. – a_dir: Direction of the face. – a_side: Low or high side of the box where the block-boundary face lies.

void BlockRegister::storeAux ( const FArrayBox a_data,
const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side 
)

Store auxiliary data on block-boundary faces including layers of ghost faces.

– a_data: Face-centered data to be stored. – a_dataIndex: Index of box containing data to be stored. – a_dir: Direction of the face. – a_side: Low or high side of the box where the block-boundary face lies.

void BlockRegister::incrementAux ( const FArrayBox a_data,
const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side 
)

Store auxiliary data on block-boundary faces including layers of ghost faces.

– a_data: Face-centered data to be stored. – a_dataIndex: Index of box containing data to be stored. – a_dir: Direction of the face. – a_side: Low or high side of the box where the block-boundary face lies.

void BlockRegister::close (  ) 

Perform data manipulation of flux and auxiliary data, after it has been stored, so that accessor functions have access to it.

void BlockRegister::setToZero ( const int  a_n_comp = -1  ) 

Sets the contents of the register to zero, and sets the register to be open. If data is not already defined, argument a_n_comp must be defined to be greater than zero. – a_n_comp: Number of components in register.

bool BlockRegister::hasInterface ( const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side 
) const

Returns whether or not a box has a block-boundary interface on one of its faces.

– a_dataIndex: Index of box. – a_dir: Direction of the face of the box. – a_side: Low or high side of the box.

void BlockRegister::getFlux ( FArrayBox a_flux,
const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side,
Side::LoHiSide  a_sideData 
) const

Return fluxes on a block-boundary interface of a box, if hasInterface(a_dataIndex, a_dir, a_side) is true.

– a_flux: Face-centered flux returned. – a_dataIndex: Index of box. – a_dir: Direction of the face. – a_side: Low or high side of the box. – a_sideData: Low or high side of the block-boundary interface, from which flux will be taken.

void BlockRegister::getAux ( FArrayBox a_data,
const DataIndex a_dataIndex,
int  a_dir,
Side::LoHiSide  a_side,
Side::LoHiSide  a_sideData 
) const

Return auxiliary data on a block-boundary interface of a box, if hasInterface(a_dataIndex, a_dir, a_side) is true.

– a_flux: Face-centered data returned. – a_dataIndex: Index of box. – a_dir: Direction of the face. – a_side: Low or high side of the box. – a_sideData: Low or high side of the block-boundary interface, from which data will be taken.

bool BlockRegister::isNotClosed (  )  const [inline, protected]

Returns true if register is open, false otherwise.

References m_isOpen.

bool BlockRegister::isClosed (  )  const [inline, protected]

Returns false if register is open, true otherwise.

References m_isOpen.


Member Data Documentation

int BlockRegister::m_verbosity [protected]

bool BlockRegister::m_isOpen [protected]

Referenced by isClosed(), and isNotClosed().


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

Generated on Mon Oct 23 03:27:17 2017 for Chombo + EB + MF by  doxygen 1.5.5