SpECTRE  v2024.09.29
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Neighbors< VolumeDim > Class Template Reference

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

#include <Neighbors.hpp>

Public Member Functions

 Neighbors (std::unordered_set< ElementId< VolumeDim > > ids, OrientationMap< VolumeDim > orientation)
 Construct with the ids and orientation of the neighbors relative to the host. More...
 
 Neighbors ()=default
 Default constructor for Charm++ serialization.
 
 Neighbors (const Neighbors< VolumeDim > &neighbor)=default
 
 Neighbors (Neighbors< VolumeDim > &&)=default
 
Neighborsoperator= (const Neighbors &rhs)=default
 
Neighborsoperator= (Neighbors &&)=default
 
const std::unordered_set< ElementId< VolumeDim > > & ids () const
 
const OrientationMap< VolumeDim > & orientation () const
 
void set_ids_to (const std::unordered_set< ElementId< VolumeDim > > new_ids)
 Reset the ids of the neighbors.
 
void add_ids (const std::unordered_set< ElementId< VolumeDim > > &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< ElementId< VolumeDim > >::iterator begin ()
 
std::unordered_set< ElementId< VolumeDim > >::iterator end ()
 
std::unordered_set< ElementId< VolumeDim > >::const_iterator begin () const
 
std::unordered_set< ElementId< VolumeDim > >::const_iterator end () const
 
std::unordered_set< ElementId< VolumeDim > >::const_iterator cbegin () const
 
std::unordered_set< ElementId< VolumeDim > >::const_iterator cend () const
 

Detailed Description

template<size_t VolumeDim>
class Neighbors< VolumeDim >

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

Template Parameters
VolumeDimthe volume dimension.

Constructor & Destructor Documentation

◆ Neighbors()

template<size_t VolumeDim>
Neighbors< VolumeDim >::Neighbors ( std::unordered_set< ElementId< VolumeDim > >  ids,
OrientationMap< VolumeDim >  orientation 
)

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

Parameters
idsthe ids of the neighbors.
orientationThis 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: