SpECTRE  v2024.03.19
BlockNeighbor< VolumeDim > Class Template Reference

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)
 Construct with the Id and orientation of the neighbor relative to the host. More...
 
 BlockNeighbor (const BlockNeighbor< VolumeDim > &neighbor)=default
 
 BlockNeighbor (BlockNeighbor< VolumeDim > &&)=default
 
BlockNeighbor< VolumeDim > & operator= (const BlockNeighbor< VolumeDim > &rhs)=default
 
BlockNeighbor< VolumeDim > & operator= (BlockNeighbor< VolumeDim > &&)=default
 
size_t id () const
 
const OrientationMap< VolumeDim > & orientation () const
 
void pup (PUP::er &p)
 

Detailed Description

template<size_t VolumeDim>
class BlockNeighbor< VolumeDim >

Information about the neighbor of a host 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 
)

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

Parameters
idthe Id of the neighbor.
orientationThis OrientationMap takes objects in the logical coordinate frame of the host Block and maps them to the logical coordinate frame of the neighbor Block.

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