mundy::search::NeighborPair< NeighborListType > Class Template Reference

Lightweight neighbor-pair view.

#include <Neighbors.hpp>

Public Types
Aliases
using	neighbor_list_type = NeighborListType
using	size_type = typename neighbor_list_type::size_type
using	source_index_type = typename neighbor_list_type::source_index_type

Public Member Functions
Constructors
	NeighborPair ()=default
	Default constructor.
	NeighborPair (const neighbor_list_type &list, size_type target_index, size_type neighbor_ordinal)
	Construct a pair payload.
Accessors
size_type	target_index () const noexcept
	Get the dense target ordinal for this pair.
source_index_type	source_index () const
	Get the dense source ordinal for this pair.
stk::mesh::Entity	target_entity () const
	Get the target STK entity.
stk::mesh::Entity	source_entity () const
	Get the source STK entity.

Member Typedef Documentation

neighbor_list_type

template<typename NeighborListType>

using mundy::search::NeighborPair< NeighborListType >::neighbor_list_type = NeighborListType

size_type

template<typename NeighborListType>

using mundy::search::NeighborPair< NeighborListType >::size_type = typename neighbor_list_type::size_type

source_index_type

template<typename NeighborListType>

using mundy::search::NeighborPair< NeighborListType >::source_index_type = typename neighbor_list_type::source_index_type

Constructor & Destructor Documentation

NeighborPair() [1/2]

template<typename NeighborListType>

mundy::search::NeighborPair< NeighborListType >::NeighborPair ( )

default

NeighborPair() [2/2]

template<typename NeighborListType>

mundy::search::NeighborPair< NeighborListType >::NeighborPair ( const neighbor_list_type & list, size_type target_index, size_type neighbor_ordinal )

inline

Parameters

list	[in] Concrete neighbor list to view.
target_index	[in] Dense target ordinal.
neighbor_ordinal	[in] Ordinal of the source neighbor for the target.

Member Function Documentation

target_index()

template<typename NeighborListType>

size_type mundy::search::NeighborPair< NeighborListType >::target_index ( ) const

inlinenoexcept

source_index()

template<typename NeighborListType>

source_index_type mundy::search::NeighborPair< NeighborListType >::source_index ( ) const

inline

target_entity()

template<typename NeighborListType>

stk::mesh::Entity mundy::search::NeighborPair< NeighborListType >::target_entity ( ) const

inline

source_entity()

template<typename NeighborListType>

stk::mesh::Entity mundy::search::NeighborPair< NeighborListType >::source_entity ( ) const

inline