mundy::search::PeriodicSearchInput< Component, Metric > Class Template Reference

A SearchInput augmented with a periodicity metric for periodic neighbor-list builds.

#include <SearchInput.hpp>

Public Types
Aliases
using	component_type = Component
using	metric_type = Metric

Public Member Functions
Constructors
	PeriodicSearchInput (const stk::mesh::Selector &selector, Component &component, const Metric &metric)
	Construct from a selector, field-backed component, and metric; rank is taken from the field.
	PeriodicSearchInput (const stk::mesh::Selector &selector, Component &component, const Metric &metric, stk::mesh::EntityRank rank)
	Construct from a selector, component, metric, and an explicit entity rank.
	PeriodicSearchInput ()=default
	PeriodicSearchInput (const PeriodicSearchInput &)=default
	PeriodicSearchInput (PeriodicSearchInput &&)=default
PeriodicSearchInput &	operator= (const PeriodicSearchInput &)=default
PeriodicSearchInput &	operator= (PeriodicSearchInput &&)=default

Getters
const stk::mesh::Selector &	selector () const noexcept
const Component &	component () const noexcept
Component &	component () noexcept
stk::mesh::EntityRank	rank () const noexcept
const Metric &	periodic_metric () const noexcept
	Get the periodicity metric describing the periodic domain.

Member Typedef Documentation

component_type

template<typename Component, typename Metric>

using mundy::search::PeriodicSearchInput< Component, Metric >::component_type = Component

metric_type

template<typename Component, typename Metric>

using mundy::search::PeriodicSearchInput< Component, Metric >::metric_type = Metric

Constructor & Destructor Documentation

PeriodicSearchInput() [1/5]

template<typename Component, typename Metric>

mundy::search::PeriodicSearchInput< Component, Metric >::PeriodicSearchInput ( const stk::mesh::Selector & selector, Component & component, const Metric & metric )

inline

PeriodicSearchInput() [2/5]

template<typename Component, typename Metric>

mundy::search::PeriodicSearchInput< Component, Metric >::PeriodicSearchInput ( const stk::mesh::Selector & selector, Component & component, const Metric & metric, stk::mesh::EntityRank rank )

inline

PeriodicSearchInput() [3/5]

template<typename Component, typename Metric>

mundy::search::PeriodicSearchInput< Component, Metric >::PeriodicSearchInput ( )

default

PeriodicSearchInput() [4/5]

template<typename Component, typename Metric>

mundy::search::PeriodicSearchInput< Component, Metric >::PeriodicSearchInput ( const PeriodicSearchInput< Component, Metric > & )

default

PeriodicSearchInput() [5/5]

template<typename Component, typename Metric>

mundy::search::PeriodicSearchInput< Component, Metric >::PeriodicSearchInput ( PeriodicSearchInput< Component, Metric > && )

default

Member Function Documentation

operator=() [1/2]

template<typename Component, typename Metric>

PeriodicSearchInput & mundy::search::PeriodicSearchInput< Component, Metric >::operator= ( const PeriodicSearchInput< Component, Metric > & )

default

operator=() [2/2]

template<typename Component, typename Metric>

PeriodicSearchInput & mundy::search::PeriodicSearchInput< Component, Metric >::operator= ( PeriodicSearchInput< Component, Metric > && )

default

selector()

template<typename Component, typename Metric>

const stk::mesh::Selector & mundy::search::PeriodicSearchInput< Component, Metric >::selector ( ) const

inlinenoexcept

component() [1/2]

template<typename Component, typename Metric>

const Component & mundy::search::PeriodicSearchInput< Component, Metric >::component ( ) const

inlinenoexcept

component() [2/2]

template<typename Component, typename Metric>

Component & mundy::search::PeriodicSearchInput< Component, Metric >::component ( )

inlinenoexcept

rank()

template<typename Component, typename Metric>

stk::mesh::EntityRank mundy::search::PeriodicSearchInput< Component, Metric >::rank ( ) const

inlinenoexcept

periodic_metric()

template<typename Component, typename Metric>

const Metric & mundy::search::PeriodicSearchInput< Component, Metric >::periodic_metric ( ) const

inlinenoexcept