mundy::search::NoExcluder Class Reference

Empty excluder used as the starting point for neighbor-list builders. More...

#include <Excluder.hpp>

Public Member Functions
Constructors
	NoExcluder ()=default
	Default constructor.
Setup
void	setup (const stk::mesh::BulkData &, const stk::mesh::Selector &, const stk::mesh::Selector &)
	Prepare the empty excluder.
Filtering
template<typename Candidate>
bool	operator() (const Candidate &) const noexcept
	Return whether a candidate pair should be excluded.
template<ExcluderType NewExcluder>
ExcluderChain< NoExcluder, NewExcluder >	exclude (const NewExcluder &excluder) const
	Return a new excluder chain with one appended excluder.

Detailed Description

Excluders are build-time predicates that reject candidate target/source pairs before those pairs enter the stored neighbor list. NoExcluder rejects nothing and provides the first .exclude(...) step for type-level chaining.

Constructor & Destructor Documentation

NoExcluder()

mundy::search::NoExcluder::NoExcluder ( )

default

Member Function Documentation

setup()

void mundy::search::NoExcluder::setup ( const stk::mesh::BulkData & , const stk::mesh::Selector & , const stk::mesh::Selector &  )

inline

Parameters

bulk_data	[in] Unused bulk data.
target_selector	[in] Unused target selector.
source_selector	[in] Unused source selector.

operator()()

template<typename Candidate>

bool mundy::search::NoExcluder::operator() ( const Candidate & ) const

inlinenoexcept

Parameters

candidate

[in] Candidate pair produced by a search backend.

exclude()

template<ExcluderType NewExcluder>

ExcluderChain< NoExcluder, NewExcluder > mundy::search::NoExcluder::exclude ( const NewExcluder & excluder ) const

inline

Parameters

excluder

[in] Excluder to append to the chain.