mundy::search::NeighborSearchCandidate< SizeType > Class Template Reference

Non-periodic target/source candidate produced during neighbor-list construction.

#include <SearchCandidate.hpp>

Public Types
Aliases
using	size_type = SizeType

Public Member Functions
Constructors
	NeighborSearchCandidate ()=default
	Default constructor.
	NeighborSearchCandidate (size_type target_index, size_type source_index, stk::mesh::Entity target_entity, stk::mesh::Entity source_entity)
	Construct a non-periodic search candidate.
Accessors
size_type	target_index () const noexcept
	Get the dense target ordinal.
size_type	source_index () const noexcept
	Get the dense source ordinal.
stk::mesh::Entity	target_entity () const noexcept
	Get the target entity.
stk::mesh::Entity	source_entity () const noexcept
	Get the source entity.
Degenerate check
bool	is_degenerate () const noexcept
	True if this candidate is a self-interaction.
Comparison operators
bool	operator== (const NeighborSearchCandidate &o) const noexcept
bool	operator!= (const NeighborSearchCandidate &o) const noexcept
bool	operator< (const NeighborSearchCandidate &o) const noexcept
bool	operator> (const NeighborSearchCandidate &o) const noexcept

Member Typedef Documentation

size_type

template<typename SizeType = size_t>

using mundy::search::NeighborSearchCandidate< SizeType >::size_type = SizeType

Constructor & Destructor Documentation

NeighborSearchCandidate() [1/2]

template<typename SizeType = size_t>

mundy::search::NeighborSearchCandidate< SizeType >::NeighborSearchCandidate ( )

default

NeighborSearchCandidate() [2/2]

template<typename SizeType = size_t>

mundy::search::NeighborSearchCandidate< SizeType >::NeighborSearchCandidate ( size_type target_index, size_type source_index, stk::mesh::Entity target_entity, stk::mesh::Entity source_entity )

inline

Parameters

target_index	[in] Dense target ordinal.
source_index	[in] Dense source ordinal.
target_entity	[in] STK target entity.
source_entity	[in] STK source entity.

Member Function Documentation

target_index()

template<typename SizeType = size_t>

size_type mundy::search::NeighborSearchCandidate< SizeType >::target_index ( ) const

inlinenoexcept

source_index()

template<typename SizeType = size_t>

size_type mundy::search::NeighborSearchCandidate< SizeType >::source_index ( ) const

inlinenoexcept

target_entity()

template<typename SizeType = size_t>

stk::mesh::Entity mundy::search::NeighborSearchCandidate< SizeType >::target_entity ( ) const

inlinenoexcept

source_entity()

template<typename SizeType = size_t>

stk::mesh::Entity mundy::search::NeighborSearchCandidate< SizeType >::source_entity ( ) const

inlinenoexcept

is_degenerate()

template<typename SizeType = size_t>

bool mundy::search::NeighborSearchCandidate< SizeType >::is_degenerate ( ) const

inlinenoexcept

operator==()

template<typename SizeType = size_t>

bool mundy::search::NeighborSearchCandidate< SizeType >::operator== ( const NeighborSearchCandidate< SizeType > & o ) const

inlinenoexcept

operator!=()

template<typename SizeType = size_t>

bool mundy::search::NeighborSearchCandidate< SizeType >::operator!= ( const NeighborSearchCandidate< SizeType > & o ) const

inlinenoexcept

operator<()

template<typename SizeType = size_t>

bool mundy::search::NeighborSearchCandidate< SizeType >::operator< ( const NeighborSearchCandidate< SizeType > & o ) const

inlinenoexcept

operator>()

template<typename SizeType = size_t>

bool mundy::search::NeighborSearchCandidate< SizeType >::operator> ( const NeighborSearchCandidate< SizeType > & o ) const

inlinenoexcept