Cabana::NeighborList< NeighborListType > Class Template Reference

Neighbor list interface. Provides an interface callable at the functor level that gives access to neighbor data for particles. More...

#include <Cabana_NeighborList.hpp>

Public Types
using	memory_space = typename NeighborListType::memory_space
	Kokkos memory space.

Public Member Functions
KOKKOS_INLINE_FUNCTION std::size_t	setNeighbor (NeighborListType &list, const std::size_t particle_index, const std::size_t neighbor_index)
	Set the id for a neighbor for a given particle index and neighbor index.

Static Public Member Functions
static KOKKOS_INLINE_FUNCTION std::size_t	totalNeighbor (const NeighborListType &list)
	Get the total number of neighbors across all particles.
static KOKKOS_INLINE_FUNCTION std::size_t	maxNeighbor (const NeighborListType &list)
	Get the maximum number of neighbors across all particles.
static KOKKOS_INLINE_FUNCTION std::size_t	numNeighbor (const NeighborListType &list, const std::size_t particle_index)
	Get the number of neighbors for a given particle index.
static KOKKOS_INLINE_FUNCTION std::size_t	getNeighbor (const NeighborListType &list, const std::size_t particle_index, const std::size_t neighbor_index)
	Get the id for a neighbor for a given particle index and neighbor index.

Detailed Description

template<class NeighborListType>
class Cabana::NeighborList< NeighborListType >

Neighbor list interface. Provides an interface callable at the functor level that gives access to neighbor data for particles.

---

The documentation for this class was generated from the following file:

• core/src/Cabana_NeighborList.hpp