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

#include <BlockNeighbors.hpp>

Additional Inherited Members
Public Member Functions inherited from Neighbors< VolumeDim, size_t >
	Neighbors (std::unordered_set< size_t > ids, std::unordered_map< size_t, OrientationMap< VolumeDim > > orientations, bool are_conforming)
	Construct with the ids, the orientation of the neighbors relative to the host, and whether the neighbors are conforming. More...

	Neighbors (std::unordered_set< size_t > ids, OrientationMap< VolumeDim > orientation)
	Construct with the ids and orientation of the neighbors relative to the host, assuming the neighbors are conforming. More...

	Neighbors (size_t id, OrientationMap< VolumeDim > orientation)
	Construct with the id and orientation of a single neighbor relative to the host, assuming the neighbor is conforming. More...

	Neighbors ()=default
	Default constructor for Charm++ serialization.

	Neighbors (const Neighbors &neighbor)=default

	Neighbors (Neighbors &&)=default

Neighbors &	operator= (const Neighbors &rhs)=default

Neighbors &	operator= (Neighbors &&)=default

const std::unordered_set< size_t > &	ids () const

const std::unordered_map< size_t, OrientationMap< VolumeDim > > &	orientations () const
	The orientations of the neighbors for each neighboring Block. More...

bool	are_conforming () const
	Whether or not the block logical coordinates of the neighbors conform to those of the host (see domain::neighbor_is_conforming)

const OrientationMap< VolumeDim > &	orientation (const size_t &id) const
	The orientation of a particular neighbor.

void	set_ids_to (std::unordered_set< size_t > new_ids)
	Reset the ids of the neighbors. More...

void	add_ids (std::unordered_set< size_t > additional_ids)
	Add ids of neighbors. More...

void	pup (PUP::er &p)
	Serialization for Charm++.

size_t	size () const
	The number of neighbors.

std::unordered_set< size_t >::iterator	begin ()

std::unordered_set< size_t >::const_iterator	begin () const

std::unordered_set< size_t >::iterator	end ()

std::unordered_set< size_t >::const_iterator	end () const

std::unordered_set< size_t >::const_iterator	cbegin () const

std::unordered_set< size_t >::const_iterator	cend () const

Detailed Description

template<size_t VolumeDim>
class BlockNeighbors< VolumeDim >

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

Template Parameters

VolumeDim the volume dimension.

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

src/Domain/Structure/BlockNeighbors.hpp

Additional Inherited Members

Detailed Description