seams-core v2.14.0
libyodaLib, the C++ engine of d-SEAMS
Loading...
Searching...
No Matches
nneigh::SkinNeighborList Class Reference

Persistent neighbour list with a LAMMPS skin. More...

#include <src/include/internal/neighbours.hpp>

Public Member Functions

 SkinNeighborList (double cutoff, double skin, int typeI, BondGraph graph=BondGraph::KnnMutual, int k=4)
BondGraph graph () const
const std::vector< std::vector< int > > & update (const molSys::PointCloud< molSys::Point< double >, double > &yCloud)
bool lastRebuilt () const
int lastChangedAtoms () const
 Atoms whose cutoff bond set changed on the last update.
const std::vector< std::vector< int > > & bonds () const

Detailed Description

Persistent neighbour list with a LAMMPS skin.

Vesin (or the brute-force fallback) builds candidates at cutoff+skin, which is the ghost halo: periodic images already sit in that shell. The cell list is rebuilt only when some atom has moved more than skin/2 from the last rebuild, the Verlet trigger. The bond graph for rings is the candidate pairs whose current distance is inside the analysis cutoff.

Definition at line 614 of file neighbours.hpp.

Constructor & Destructor Documentation

◆ SkinNeighborList()

nneigh::SkinNeighborList::SkinNeighborList ( double cutoff,
double skin,
int typeI,
BondGraph graph = BondGraph::KnnMutual,
int k = 4 )

graph selects cutoff vs k-nearest (mutual or union). k is the neighbour count for the knn graphs (default 4).

Member Function Documentation

◆ bonds()

const std::vector< std::vector< int > > & nneigh::SkinNeighborList::bonds ( ) const
inlinenodiscard

Definition at line 631 of file neighbours.hpp.

631 {
632 return nList_;
633 }

◆ graph()

BondGraph nneigh::SkinNeighborList::graph ( ) const
inlinenodiscard

Definition at line 621 of file neighbours.hpp.

621{ return graph_; }

◆ lastChangedAtoms()

int nneigh::SkinNeighborList::lastChangedAtoms ( ) const
inlinenodiscard

Atoms whose cutoff bond set changed on the last update.

Definition at line 630 of file neighbours.hpp.

630{ return changedAtoms_; }

◆ lastRebuilt()

bool nneigh::SkinNeighborList::lastRebuilt ( ) const
inlinenodiscard

Definition at line 628 of file neighbours.hpp.

628{ return rebuilt_; }

◆ update()

const std::vector< std::vector< int > > & nneigh::SkinNeighborList::update ( const molSys::PointCloud< molSys::Point< double >, double > & yCloud)

Refresh from a new frame. The returned list is ID-keyed with a leading self entry, the same shape as neighListO.


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