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

#include <Neighbors.hpp>

Public Member Functions
	Neighbors (std::unordered_set< IdType > ids, OrientationMap< VolumeDim > orientation)
	Construct with the ids and orientation of the neighbors relative to the host. More...

	Neighbors (IdType id, OrientationMap< VolumeDim > orientation)
	Construct with the id and orientation of a single neighbor relative to the host. 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< IdType > &	ids () const

const OrientationMap< VolumeDim > &	orientation () const

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

void	add_ids (const std::unordered_set< IdType > &additional_ids)
	Add ids of neighbors. Adding an existing neighbor is allowed.

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

size_t	size () const
	The number of neighbors.

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

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

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

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

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

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

Detailed Description

template<size_t VolumeDim, typename IdType = ElementId<VolumeDim>>
class Neighbors< VolumeDim, IdType >

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

Template Parameters

VolumeDim	the volume dimension.
IdType	the type of the Id of the neighbor (either ElementId or size_t for a Block)

Constructor & Destructor Documentation

template<size_t VolumeDim, typename IdType = ElementId<VolumeDim>>

Neighbors< VolumeDim, IdType >::Neighbors	(	std::unordered_set< IdType >	ids,
		OrientationMap< VolumeDim >	orientation
	)

Construct with the ids and orientation of the neighbors relative to the host.

Parameters

ids	the ids of the neighbors.
orientation	This OrientationMap takes objects in the logical coordinate frame of the host and maps them to the logical coordinate frame of the neighbor.

template<size_t VolumeDim, typename IdType = ElementId<VolumeDim>>

Neighbors< VolumeDim, IdType >::Neighbors	(	IdType	id,
		OrientationMap< VolumeDim >	orientation
	)

Construct with the id and orientation of a single neighbor relative to the host.

Parameters

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

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