Public Member Functions | List of all members
BlockNeighbor< VolumeDim > Class Template Reference

Information about the neighbor of a 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. 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 Block in a particular direction.

Template Parameters
VolumeDimthe volume dimension.

Constructor & Destructor Documentation

◆ BlockNeighbor()

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

Construct with the Id and orientation of the neighbor.

Parameters
idthe Id of the neighbor.
orientationthe OrientationMap of the neighbor.

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