mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType > Class Template Reference

Periodic owner-pair candidate produced during neighbor-list construction.

#include <SearchCandidate.hpp>

Public Types
Aliases
using	image_shift_type = ImageShiftType
using	size_type = SizeType

Public Member Functions
Constructors
	PeriodicNeighborSearchCandidate ()=default
	Default constructor.
	PeriodicNeighborSearchCandidate (size_type target_owner_index, size_type source_owner_index, stk::mesh::Entity target_entity, stk::mesh::Entity source_entity, const image_shift_type &target_image_shift, const image_shift_type &source_image_shift)
	Construct a periodic search candidate.
Accessors
size_type	target_index () const noexcept
	Get the dense target owner ordinal.
size_type	source_index () const noexcept
	Get the dense source owner ordinal.
stk::mesh::Entity	target_entity () const noexcept
	Get the target owner entity.
stk::mesh::Entity	source_entity () const noexcept
	Get the source owner entity.
image_shift_type	target_image_shift () const noexcept
	Get the target owner's image shift (original → imaged reference point).
image_shift_type	source_image_shift () const noexcept
	Get the source owner's image shift (original → imaged reference point).
Degenerate check
bool	is_degenerate () const noexcept
	True if this candidate is a self-interaction in the same image.
Comparison operators
bool	operator== (const PeriodicNeighborSearchCandidate &o) const noexcept
bool	operator!= (const PeriodicNeighborSearchCandidate &o) const noexcept
bool	operator< (const PeriodicNeighborSearchCandidate &o) const noexcept
bool	operator> (const PeriodicNeighborSearchCandidate &o) const noexcept

Member Typedef Documentation

image_shift_type

template<typename ImageShiftType, typename SizeType = size_t>

using mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::image_shift_type = ImageShiftType

size_type

template<typename ImageShiftType, typename SizeType = size_t>

using mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::size_type = SizeType

Constructor & Destructor Documentation

PeriodicNeighborSearchCandidate() [1/2]

template<typename ImageShiftType, typename SizeType = size_t>

mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::PeriodicNeighborSearchCandidate ( )

default

PeriodicNeighborSearchCandidate() [2/2]

template<typename ImageShiftType, typename SizeType = size_t>

mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::PeriodicNeighborSearchCandidate ( size_type target_owner_index, size_type source_owner_index, stk::mesh::Entity target_entity, stk::mesh::Entity source_entity, const image_shift_type & target_image_shift, const image_shift_type & source_image_shift )

inline

Parameters

target_owner_index	[in] Dense target owner ordinal.
source_owner_index	[in] Dense source owner ordinal.
target_entity	[in] STK target owner entity.
source_entity	[in] STK source owner entity.
target_image_shift	[in] Displacement from the target owner's original to its imaged reference point.
source_image_shift	[in] Displacement from the source owner's original to its imaged reference point.

Member Function Documentation

target_index()

template<typename ImageShiftType, typename SizeType = size_t>

size_type mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::target_index ( ) const

inlinenoexcept

source_index()

template<typename ImageShiftType, typename SizeType = size_t>

size_type mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::source_index ( ) const

inlinenoexcept

target_entity()

template<typename ImageShiftType, typename SizeType = size_t>

stk::mesh::Entity mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::target_entity ( ) const

inlinenoexcept

source_entity()

template<typename ImageShiftType, typename SizeType = size_t>

stk::mesh::Entity mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::source_entity ( ) const

inlinenoexcept

target_image_shift()

template<typename ImageShiftType, typename SizeType = size_t>

image_shift_type mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::target_image_shift ( ) const

inlinenoexcept

source_image_shift()

template<typename ImageShiftType, typename SizeType = size_t>

image_shift_type mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::source_image_shift ( ) const

inlinenoexcept

is_degenerate()

template<typename ImageShiftType, typename SizeType = size_t>

bool mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::is_degenerate ( ) const

inlinenoexcept

operator==()

template<typename ImageShiftType, typename SizeType = size_t>

bool mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::operator== ( const PeriodicNeighborSearchCandidate< ImageShiftType, SizeType > & o ) const

inlinenoexcept

operator!=()

template<typename ImageShiftType, typename SizeType = size_t>

bool mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::operator!= ( const PeriodicNeighborSearchCandidate< ImageShiftType, SizeType > & o ) const

inlinenoexcept

operator<()

template<typename ImageShiftType, typename SizeType = size_t>

bool mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::operator< ( const PeriodicNeighborSearchCandidate< ImageShiftType, SizeType > & o ) const

inlinenoexcept

operator>()

template<typename ImageShiftType, typename SizeType = size_t>

bool mundy::search::PeriodicNeighborSearchCandidate< ImageShiftType, SizeType >::operator> ( const PeriodicNeighborSearchCandidate< ImageShiftType, SizeType > & o ) const

inlinenoexcept