faunus
Public Member Functions | Public Attributes | List of all members
Faunus::CellList::Grid::GridOffsets3D Class Reference

A simple data holder for common offsets in 3D grids, e.g., nearest neighbors or forward neighbors. More...

#include <celllist.h>

Public Member Functions

 GridOffsets3D (CellIndex distance)
 

Public Attributes

const std::vector< CellCoord > self {{0, 0, 0}}
 the cell itself
 
std::vector< CellCoord > neighbors
 all neighbors (excluding self); (1 + 2×distance)³ - 1
 
std::vector< CellCoord > forward_neighbors
 only the preceding half of all neighbors
 
CellIndex distance
 maximal distance of neighbours (1 for the nearest neighbors)
 

Detailed Description

A simple data holder for common offsets in 3D grids, e.g., nearest neighbors or forward neighbors.

Constructor & Destructor Documentation

◆ GridOffsets3D()

Faunus::CellList::Grid::GridOffsets3D::GridOffsets3D ( CellIndex  distance)
explicit
Parameters
distancemaximal distance of neighbours (1 for the nearest neighbors)

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