interatomic 0.5.0

Library for calculating inter-particle interactions
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

// Copyright 2023-2024 Mikael Lund
//
// Licensed under the Apache license, version 2.0 (the "license");
// you may not use this file except in compliance with the license.
// You may obtain a copy of the license at
//
//     http://www.apache.org/licenses/license-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the license is distributed on an "as is" basis,
// without warranties or conditions of any kind, either express or implied.
// See the license for the specific language governing permissions and
// limitations under the license.

//! Implementation of the three-body harmonic potential.

use super::ThreebodyAngleEnergy;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

/// Harmonic torsion potential.
#[derive(Debug, Clone, PartialEq)]
#[cfg_attr(
    feature = "serde",
    derive(Deserialize, Serialize),
    serde(deny_unknown_fields)
)]
pub struct HarmonicTorsion {
    #[cfg_attr(feature = "serde", serde(rename = "aeq"))]
    eq_angle: f64,
    #[cfg_attr(feature = "serde", serde(rename = "k"))]
    spring_constant: f64,
}

impl HarmonicTorsion {
    /// Create a new harmonic torsion potential with equilibrium angle and spring constant.
    pub const fn new(eq_angle: f64, spring_constant: f64) -> Self {
        Self {
            eq_angle,
            spring_constant,
        }
    }

    /// Equilibrium angle in degrees.
    pub const fn eq_angle(&self) -> f64 {
        self.eq_angle
    }

    /// Spring constant.
    pub const fn spring_constant(&self) -> f64 {
        self.spring_constant
    }
}

impl ThreebodyAngleEnergy for HarmonicTorsion {
    #[inline(always)]
    fn threebody_angle_energy(&self, angle: f64) -> f64 {
        0.5 * self.spring_constant * (angle - self.eq_angle).powi(2)
    }

    #[inline(always)]
    fn threebody_angle_force(&self, angle: f64) -> f64 {
        -self.spring_constant * (angle - self.eq_angle)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use approx::assert_relative_eq;
    use std::f64::consts::{FRAC_PI_2, FRAC_PI_4};

    #[test]
    fn test_harmonic_torsion_force() {
        let torsion = HarmonicTorsion::new(FRAC_PI_4, 1.0);
        // At θ=π/2: force = -1*(π/2 - π/4) = -π/4
        assert_relative_eq!(
            torsion.threebody_angle_force(FRAC_PI_2),
            -FRAC_PI_4,
            epsilon = 1e-10
        );
        // At equilibrium: force = 0
        assert_relative_eq!(
            torsion.threebody_angle_force(FRAC_PI_4),
            0.0,
            epsilon = 1e-10
        );
    }
}