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

#include <BlockRegister.H>

Constructor, destructor, and defines.
int	m_verbosity

bool	m_isOpen

BlockBaseRegister< FArrayBox >	m_fluxRegister

BlockBaseRegister< FArrayBox >	m_auxRegister

	BlockRegister ()
	Empty constructor. More...

	BlockRegister (const MultiBlockCoordSys *a_mblock, const DisjointBoxLayout &a_grids, const int &a_ghost=0)
	Constructor. More...

virtual	~BlockRegister ()
	virtual destructor More...

void	define (const MultiBlockCoordSys *a_mblock, const DisjointBoxLayout &a_grids, const int &a_ghost=0)
	Define function that matches constructor. More...

virtual void	setVerbose (int a_verbose)
	Set verbosity. More...

void	storeFlux (const FArrayBox &a_flux, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side)
	Store fluxes on block-boundary faces. More...

void	incrementFlux (const FArrayBox &a_flux, const DataIndex &a_dataIndex, int a_dir, Side::LoHiSide a_side)
	increment fluxes on block-boundary faces. More...

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

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

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

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

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

bool	isNotClosed () const
	Returns true if register is open, false otherwise. More...

bool	isClosed () const
	Returns false if register is open, true otherwise. More...

Detailed Description

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

Constructor & Destructor Documentation

◆ BlockRegister() [1/2]

BlockRegister::BlockRegister ( )

inline

Empty constructor.

References close(), define(), getAux(), getFlux(), hasInterface(), incrementAux(), incrementFlux(), setToZero(), setVerbose(), storeAux(), storeFlux(), and ~BlockRegister().

◆ BlockRegister() [2/2]

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

◆ ~BlockRegister()

virtual BlockRegister::~BlockRegister ( )

virtual

virtual destructor

Referenced by BlockRegister().

Member Function Documentation

◆ define()

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

Referenced by BlockRegister().

◆ setVerbose()

virtual void BlockRegister::setVerbose ( int a_verbose )

virtual

Set verbosity.

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

Referenced by BlockRegister().

◆ storeFlux()

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.

Referenced by BlockRegister().

◆ incrementFlux()

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.

Referenced by BlockRegister().

◆ storeAux()

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.

Referenced by BlockRegister().

◆ incrementAux()

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.

Referenced by BlockRegister().

◆ close()

void BlockRegister::close ( )

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

Referenced by BlockRegister().

◆ setToZero()

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.

Referenced by BlockRegister().

◆ hasInterface()

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.

Referenced by BlockRegister().

◆ getFlux()

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.

Referenced by BlockRegister().

◆ getAux()

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.

Referenced by BlockRegister().

◆ isNotClosed()

bool BlockRegister::isNotClosed ( ) const

inlineprotected

Returns true if register is open, false otherwise.

References m_isOpen.

◆ isClosed()

bool BlockRegister::isClosed ( ) const

inlineprotected

Returns false if register is open, true otherwise.

References m_isOpen.

Member Data Documentation

◆ m_verbosity

int BlockRegister::m_verbosity

protected

◆ m_isOpen

bool BlockRegister::m_isOpen

protected

Referenced by isClosed(), and isNotClosed().

◆ m_fluxRegister

BlockBaseRegister<FArrayBox> BlockRegister::m_fluxRegister

protected

◆ m_auxRegister

BlockBaseRegister<FArrayBox> BlockRegister::m_auxRegister

protected

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

BlockRegister.H

Constructor, destructor, and defines.

Detailed Description

Constructor & Destructor Documentation

◆ BlockRegister() [1/2]

◆ BlockRegister() [2/2]

◆ ~BlockRegister()

Member Function Documentation

◆ define()

◆ setVerbose()

◆ storeFlux()

◆ incrementFlux()

◆ storeAux()

◆ incrementAux()

◆ close()

◆ setToZero()

◆ hasInterface()

◆ getFlux()

◆ getAux()

◆ isNotClosed()

◆ isClosed()

Member Data Documentation

◆ m_verbosity

◆ m_isOpen

◆ m_fluxRegister

◆ m_auxRegister