hoomd-interaction 1.1.0

Hamiltonians and other interaction models that apply to hoomd-rs simulations.
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
50
51
52
53
54
55
56
57
58

// Copyright (c) 2024-2026 The Regents of the University of Michigan.
// Part of hoomd-rs, released under the BSD 3-Clause License.

//! Implement `Zero`

use serde::{Deserialize, Serialize};

use hoomd_microstate::{Body, Microstate};

use super::{DeltaEnergyInsert, DeltaEnergyOne, DeltaEnergyRemove, TotalEnergy};

/// Set the energy of any system to 0.
///
/// *hoomd-rs* uses [`Zero`] in minimal examples that demonstrate MC simulations.
/// It returns 0 for all energies and delta energies.
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Zero;

impl<M> TotalEnergy<M> for Zero {
    #[inline]
    fn total_energy(&self, _microstate: &M) -> f64 {
        0.0
    }
}

impl<B, S, X, C> DeltaEnergyOne<B, S, X, C> for Zero {
    #[inline]
    fn delta_energy_one(
        &self,
        _initial_microstate: &Microstate<B, S, X, C>,
        _body_index: usize,
        _final_body: &Body<B, S>,
    ) -> f64 {
        0.0
    }
}

impl<B, S, X, C> DeltaEnergyInsert<B, S, X, C> for Zero {
    #[inline]
    fn delta_energy_insert(
        &self,
        _initial_microstate: &Microstate<B, S, X, C>,
        _new_body: &Body<B, S>,
    ) -> f64 {
        0.0
    }
}

impl<B, S, X, C> DeltaEnergyRemove<B, S, X, C> for Zero {
    #[inline]
    fn delta_energy_remove(
        &self,
        _initial_microstate: &Microstate<B, S, X, C>,
        _body_index: usize,
    ) -> f64 {
        0.0
    }
}