mundy::search::SearchInput< Component > Class Template Reference

A selector paired with a geometry-yielding component for a non-periodic neighbor-list build.

#include <SearchInput.hpp>

Public Types
Aliases
using	component_type = Component

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

Getters
const stk::mesh::Selector &	selector () const noexcept
	Get the selector defining the searched entity chunk.
const Component &	component () const noexcept
	Get the geometry-yielding component (const).
Component &	component () noexcept
	Get the geometry-yielding component (mutable, e.g. for sync / NGP refresh).
stk::mesh::EntityRank	rank () const noexcept
	Get the entity rank of the searched chunk.

Member Typedef Documentation

component_type

template<typename Component>

using mundy::search::SearchInput< Component >::component_type = Component

Constructor & Destructor Documentation

SearchInput() [1/5]

template<typename Component>

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

inline

SearchInput() [2/5]

template<typename Component>

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

inline

SearchInput() [3/5]

template<typename Component>

mundy::search::SearchInput< Component >::SearchInput ( )

default

SearchInput() [4/5]

template<typename Component>

mundy::search::SearchInput< Component >::SearchInput ( const SearchInput< Component > & )

default

SearchInput() [5/5]

template<typename Component>

mundy::search::SearchInput< Component >::SearchInput ( SearchInput< Component > && )

default

Member Function Documentation

operator=() [1/2]

template<typename Component>

SearchInput & mundy::search::SearchInput< Component >::operator= ( const SearchInput< Component > & )

default

operator=() [2/2]

template<typename Component>

SearchInput & mundy::search::SearchInput< Component >::operator= ( SearchInput< Component > && )

default

selector()

template<typename Component>

const stk::mesh::Selector & mundy::search::SearchInput< Component >::selector ( ) const

inlinenoexcept

component() [1/2]

template<typename Component>

const Component & mundy::search::SearchInput< Component >::component ( ) const

inlinenoexcept

component() [2/2]

template<typename Component>

Component & mundy::search::SearchInput< Component >::component ( )

inlinenoexcept

rank()

template<typename Component>

stk::mesh::EntityRank mundy::search::SearchInput< Component >::rank ( ) const

inlinenoexcept