voro_rs 0.3.0

A Rust binding for voro++ library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

//! Particle order class

#[cxx::bridge(namespace = "voro")]
pub mod ffi {
    unsafe extern "C++" {
        include!("voro_rs/src/boilerplate.hh");

        type particle_order;
        #[rust_name = "new_particle_order"]
        fn construct(
            init_size: i32,
        ) -> UniquePtr<particle_order>;
    }
}

use cxx::UniquePtr;

/// A class for storing ordering information when particles are added to
/// a container.
///
/// When particles are added to a container class, they are sorted into an
/// internal computational grid of blocks. The `ParticleMarker` class provides a
/// mechanism for remembering which block particles were sorted into. The import
/// and put routines in the container class have variants that also take a
/// `ParticleMarker` class. Each time they are called, they will store the block
/// that the particle was sorted into, plus the position of the particle within
/// the block. The `ParticleMarker` class can used by the `LoopMarked` class to
/// specifically loop over the particles that have their information stored
/// within it.
pub struct ParticleMarker {
    pub(crate) inner: UniquePtr<ffi::particle_order>,
}

impl ParticleMarker {
    /// Create a new `ParticleMarker`.
    pub fn new() -> Self {
        Self::new_with_memory(16)
    }

    /// The struct allocates memory to store the
    /// ordering information.
    /// * `initial_memory`: the initial amount of memory to allocate,
    /// in terms of particle count.
    pub fn new_with_memory(initial_memory: i32) -> Self {
        Self {
            inner: ffi::new_particle_order(initial_memory),
        }
    }
}