Information about the neighbor of a host Block in a particular direction. More...

#include <BlockNeighbor.hpp>

Public Member Functions
	BlockNeighbor (size_t id, OrientationMap< VolumeDim > orientation) noexcept
	Construct with the Id and orientation of the neighbor relative to the host. More...

	BlockNeighbor (const BlockNeighbor< VolumeDim > &neighbor)=default

	BlockNeighbor (BlockNeighbor< VolumeDim > &&) noexcept=default

BlockNeighbor< VolumeDim > &	operator= (const BlockNeighbor< VolumeDim > &rhs)=default

BlockNeighbor< VolumeDim > &	operator= (BlockNeighbor< VolumeDim > &&) noexcept=default

size_t	id () const noexcept

const OrientationMap< VolumeDim > &	orientation () const noexcept

void	pup (PUP::er &p) noexcept

Detailed Description

template<size_t VolumeDim>
class BlockNeighbor< VolumeDim >

Information about the neighbor of a host Block in a particular direction.

Template Parameters

VolumeDim the volume dimension.

Constructor & Destructor Documentation

template<size_t VolumeDim>

BlockNeighbor< VolumeDim >::BlockNeighbor	(	size_t	id,
		OrientationMap< VolumeDim >	orientation
	)

noexcept

Construct with the Id and orientation of the neighbor relative to the host.

Parameters

id	the Id of the neighbor.
orientation	This OrientationMap takes objects in the logical coordinate frame of the host Block and maps them to the logical coordinate frame of the neighbor Block.