NeighborList.hpp File Reference

Umbrella header: includes all public neighbor-list types for mundy::search. More...

Detailed Description

Including this header brings in the full neighbor-list interface:

• Search candidate types (SearchCandidate.hpp)
• Excluder concept and built-in excluders (Excluder.hpp)
• NeighborListType concept and Neighbors/NeighborPair access types (Neighbors.hpp)
• NeighborListIterationTraits primary template and 2D specializations (NeighborListIterationTraits.hpp, ArborX2dNeighborList.hpp)
• ForEach parallel iteration entry points (ForEach.hpp)
• NeighborListInputType concept and NeighborListBuildTraits primary template (NeighborListBuildTraits.hpp)
• Type-state fluent builder (NeighborListBuilder.hpp)
• ArborX-backed concrete list types and their build-traits specializations (ArborXNeighborList.hpp)
• STK-coarse-search-backed concrete list types and their build-traits specializations (STKSearchNeighborList.hpp)

Downstream code that only uses a subset of the interface may include individual headers directly. This umbrella is provided for convenience when the full interface is needed.