Loading...
Searching...
No Matches
eonc::VesinNeighbors Class Reference

RAII wrapper around vesin_neighbors for Matter-style boxes (double[9] row-major 3×3 cell, same layout as Matter::cell). More...

#include <VesinNeighbors.h>

Classes

struct  Options

Public Member Functions

 VesinNeighbors ()=default
 VesinNeighbors (const VesinNeighbors &)=delete
VesinNeighbors & operator= (const VesinNeighbors &)=delete
 VesinNeighbors (VesinNeighbors &&other) noexcept
VesinNeighbors & operator= (VesinNeighbors &&other) noexcept
 ~VesinNeighbors ()
void compute (const double *R, std::size_t n, const double *box, const Options &opt)
 Build / rebuild the list.
std::size_t size () const
std::size_t i (std::size_t p) const
std::size_t j (std::size_t p) const
double distance (std::size_t p) const
 Distance |r_ij| (requires return_distances).
const double * vector (std::size_t p) const
 Vector r_j − r_i (+ PBC). Requires return_vectors.
const int32_t * shift (std::size_t p) const
const VesinNeighborList & raw () const
 Raw list for advanced consumers (Metatomic tensor conversion).
VesinNeighborList & raw ()
VesinNeighborList * release ()
 Steal ownership of the internal list (for Metatomic custom deleters).

Private Member Functions

void free_list ()

Private Attributes

VesinNeighborList list_ {}
bool owns_ {false}

Detailed Description

RAII wrapper around vesin_neighbors for Matter-style boxes (double[9] row-major 3×3 cell, same layout as Matter::cell).

Pair vector convention matches vesin: r_ij = r_j - r_i + S @ H. Classical pair pots that used r_i - r_j must flip the sign.

Definition at line 27 of file VesinNeighbors.h.

Constructor & Destructor Documentation

◆ VesinNeighbors() [1/3]

eonc::VesinNeighbors::VesinNeighbors ( )
default

◆ VesinNeighbors() [2/3]

eonc::VesinNeighbors::VesinNeighbors ( const VesinNeighbors & )
delete

◆ VesinNeighbors() [3/3]

eonc::VesinNeighbors::VesinNeighbors ( VesinNeighbors && other)
noexcept

Definition at line 15 of file VesinNeighbors.cpp.

16 : list_(other.list_),
17 owns_(other.owns_) {
18 other.list_ = VesinNeighborList{};
19 other.owns_ = false;
20}
VesinNeighborList list_

◆ ~VesinNeighbors()

eonc::VesinNeighbors::~VesinNeighbors ( )

Definition at line 33 of file VesinNeighbors.cpp.

Member Function Documentation

◆ compute()

void eonc::VesinNeighbors::compute ( const double * R,
std::size_t n,
const double * box,
const Options & opt )

Build / rebuild the list.

R is length 3*n (x,y,z interleaved); box is length 9 (row-major cell vectors).

Keep the same VesinNeighbors instance across force evaluations so vesin can re-use pair/distance/vector allocations (see vesin_neighbors docs). Freeing before every compute is incorrect and expensive.

Definition at line 43 of file VesinNeighbors.cpp.

44 {
45 if (R == nullptr || (n > 0 && box == nullptr)) {
46 throw std::invalid_argument("VesinNeighbors::compute: null R or box");
47 }
48 if (opt.cutoff <= 0.0) {
49 free_list();
50 return;
51 }
52
53 // Pass the existing VesinNeighborList through so vesin can re-use pair /
54 // distance / vector buffers (upstream contract). Do not vesin_free first —
55 // that forces a full realloc every call and is the #386 ASV regression.
56 VesinOptions vopt{};
57 vopt.cutoff = opt.cutoff;
58 vopt.full = opt.full;
59 vopt.sorted = opt.sorted;
60 vopt.algorithm = opt.algorithm;
61 vopt.skin = opt.skin;
62 vopt.n_threads = opt.n_threads;
63 vopt.return_shifts = opt.return_shifts;
64 vopt.return_distances = opt.return_distances;
65 vopt.return_vectors = opt.return_vectors;
66
67 bool periodic[3] = {opt.periodic[0], opt.periodic[1], opt.periodic[2]};
68 double box33[3][3];
69 for (int a = 0; a < 3; ++a) {
70 for (int b = 0; b < 3; ++b) {
71 box33[a][b] = box[3 * a + b];
72 }
73 }
74
75 VesinDevice cpu{VesinCPU, 0};
76 const char *error_message = nullptr;
77 int status =
78 vesin_neighbors(reinterpret_cast<const double (*)[3]>(R), n, box33,
79 periodic, cpu, vopt, &list_, &error_message);
80 if (status != EXIT_SUCCESS) {
81 std::string err = "vesin_neighbors failed";
82 if (error_message != nullptr) {
83 err += ": ";
84 err += error_message;
85 }
86 free_list();
87 throw std::runtime_error(err);
88 }
89 owns_ = true;
90}

◆ distance()

double eonc::VesinNeighbors::distance ( std::size_t p) const
inlinenodiscard

Distance |r_ij| (requires return_distances).

Definition at line 71 of file VesinNeighbors.h.

71 {
72 return list_.distances[p];
73 }

◆ free_list()

void eonc::VesinNeighbors::free_list ( )
private

Definition at line 35 of file VesinNeighbors.cpp.

35 {
36 if (owns_) {
37 vesin_free(&list_);
38 owns_ = false;
39 }
40 list_ = VesinNeighborList{};
41}

◆ i()

std::size_t eonc::VesinNeighbors::i ( std::size_t p) const
inlinenodiscard

Definition at line 67 of file VesinNeighbors.h.

67{ return list_.pairs[p][0]; }

◆ j()

std::size_t eonc::VesinNeighbors::j ( std::size_t p) const
inlinenodiscard

Definition at line 68 of file VesinNeighbors.h.

68{ return list_.pairs[p][1]; }

◆ operator=() [1/2]

VesinNeighbors & eonc::VesinNeighbors::operator= ( const VesinNeighbors & )
delete

◆ operator=() [2/2]

VesinNeighbors & eonc::VesinNeighbors::operator= ( VesinNeighbors && other)
noexcept

Definition at line 22 of file VesinNeighbors.cpp.

22 {
23 if (this != &other) {
24 free_list();
25 list_ = other.list_;
26 owns_ = other.owns_;
27 other.list_ = VesinNeighborList{};
28 other.owns_ = false;
29 }
30 return *this;
31}

◆ raw() [1/2]

VesinNeighborList & eonc::VesinNeighbors::raw ( )
inlinenodiscard

Definition at line 86 of file VesinNeighbors.h.

86{ return list_; }

◆ raw() [2/2]

const VesinNeighborList & eonc::VesinNeighbors::raw ( ) const
inlinenodiscard

Raw list for advanced consumers (Metatomic tensor conversion).

Definition at line 85 of file VesinNeighbors.h.

85{ return list_; }

◆ release()

VesinNeighborList * eonc::VesinNeighbors::release ( )

Steal ownership of the internal list (for Metatomic custom deleters).

After release, this object is empty until the next compute.

Definition at line 92 of file VesinNeighbors.cpp.

92 {
93 if (!owns_) {
94 return nullptr;
95 }
96 auto heap = std::make_unique<VesinNeighborList>(list_);
97 list_ = VesinNeighborList{};
98 owns_ = false;
99 return heap.release();
100}

◆ shift()

const int32_t * eonc::VesinNeighbors::shift ( std::size_t p) const
inlinenodiscard

Definition at line 80 of file VesinNeighbors.h.

80 {
81 return list_.shifts[p];
82 }

◆ size()

std::size_t eonc::VesinNeighbors::size ( ) const
inlinenodiscard

Definition at line 65 of file VesinNeighbors.h.

65{ return list_.length; }

◆ vector()

const double * eonc::VesinNeighbors::vector ( std::size_t p) const
inlinenodiscard

Vector r_j − r_i (+ PBC). Requires return_vectors.

Definition at line 76 of file VesinNeighbors.h.

76 {
77 return list_.vectors[p];
78 }

Member Data Documentation

◆ list_

VesinNeighborList eonc::VesinNeighbors::list_ {}
private

Definition at line 93 of file VesinNeighbors.h.

93{};

◆ owns_

bool eonc::VesinNeighbors::owns_ {false}
private

Definition at line 94 of file VesinNeighbors.h.

94{false};

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