numerics 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
num::VerletList2D< Scalar > Class Template Reference

#include <verlet_list.hpp>

Public Member Functions

 VerletList2D (Scalar cutoff, Scalar skin)
 
template<typename PosAccessor >
void build (PosAccessor &&get_pos, int n, const CellList2D< Scalar > &cl)
 Build the neighbour list using a pre-built CellList2D.
 
template<typename PosAccessor >
bool needs_rebuild (PosAccessor &&get_pos, int n) const
 Return true if a particle moved more than half the skin.
 
IntRange neighbors (int i) const noexcept
 Cached neighbors of particle i.
 
Scalar cutoff () const noexcept
 
Scalar skin () const noexcept
 
Scalar ext_cutoff () const noexcept
 
int n_particles () const noexcept
 

Detailed Description

template<typename Scalar>
class num::VerletList2D< Scalar >

Definition at line 13 of file verlet_list.hpp.

Constructor & Destructor Documentation

◆ VerletList2D()

template<typename Scalar >
num::VerletList2D< Scalar >::VerletList2D ( Scalar  cutoff,
Scalar  skin 
)
inline

Definition at line 15 of file verlet_list.hpp.

Member Function Documentation

◆ build()

template<typename Scalar >
template<typename PosAccessor >
void num::VerletList2D< Scalar >::build ( PosAccessor &&  get_pos,
int  n,
const CellList2D< Scalar > &  cl 
)
inline

Build the neighbour list using a pre-built CellList2D.

Definition at line 22 of file verlet_list.hpp.

References num::CellList2D< Scalar >::query().

◆ cutoff()

template<typename Scalar >
Scalar num::VerletList2D< Scalar >::cutoff ( ) const
inlinenoexcept

Definition at line 68 of file verlet_list.hpp.

◆ ext_cutoff()

template<typename Scalar >
Scalar num::VerletList2D< Scalar >::ext_cutoff ( ) const
inlinenoexcept

Definition at line 70 of file verlet_list.hpp.

◆ n_particles()

template<typename Scalar >
int num::VerletList2D< Scalar >::n_particles ( ) const
inlinenoexcept

Definition at line 71 of file verlet_list.hpp.

◆ needs_rebuild()

template<typename Scalar >
template<typename PosAccessor >
bool num::VerletList2D< Scalar >::needs_rebuild ( PosAccessor &&  get_pos,
int  n 
) const
inline

Return true if a particle moved more than half the skin.

Definition at line 49 of file verlet_list.hpp.

◆ neighbors()

template<typename Scalar >
IntRange num::VerletList2D< Scalar >::neighbors ( int  i) const
inlinenoexcept

Cached neighbors of particle i.

Definition at line 64 of file verlet_list.hpp.

◆ skin()

template<typename Scalar >
Scalar num::VerletList2D< Scalar >::skin ( ) const
inlinenoexcept

Definition at line 69 of file verlet_list.hpp.

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