autd3-core 38.1.0

AUTD3 core traits and types
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
90

use core::f32::consts::PI;

use crate::common::{METER, ULTRASOUND_FREQ};

#[non_exhaustive]
#[repr(C)]
#[derive(Debug, Clone, Copy, PartialEq)]
pub struct Environment {
    #[cfg_attr(feature = "use_meter", doc = "Sound speed in the environment [m/s]")]
    #[cfg_attr(
        not(feature = "use_meter"),
        doc = "Sound speed in the environment [mm/s]"
    )]
    pub sound_speed: f32,
}

impl Environment {
    /// Creates a new environment with the default sound speed (340m/s).
    pub fn new() -> Self {
        Self {
            sound_speed: 340.0 * METER,
        }
    }

    /// Sets the sound speed of envs from the temperature.
    ///
    /// This is equivalent to [`Self::set_sound_speed_from_temp_with`](t, 1.4, 8.314_463, 28.9647e-3).
    pub fn set_sound_speed_from_temp(&mut self, t: f32) {
        self.set_sound_speed_from_temp_with(t, 1.4, 8.314_463, 28.9647e-3);
    }

    /// Sets the sound speed of envs from the temperature `t`, heat capacity ratio `k`, gas constant `r`, and molar mass `m` \[kg/mol\].
    pub fn set_sound_speed_from_temp_with(&mut self, t: f32, k: f32, r: f32, m: f32) {
        let c2 = k * r * (273.15 + t) / m;
        let c = c2.sqrt();
        self.sound_speed = c * METER;
    }

    /// Gets the wavelength of the ultrasound.
    #[must_use]
    pub const fn wavelength(&self) -> f32 {
        self.sound_speed / ULTRASOUND_FREQ.hz() as f32
    }

    /// Gets the wavenumber of the ultrasound.
    #[must_use]
    pub const fn wavenumber(&self) -> f32 {
        2.0 * PI * ULTRASOUND_FREQ.hz() as f32 / self.sound_speed
    }
}

impl Default for Environment {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
pub(crate) mod tests {
    use super::*;
    use crate::common::mm;

    #[rstest::rstest]
    #[case(340.29525e3, 15.)]
    #[case(343.23497e3, 20.)]
    #[case(349.04013e3, 30.)]
    fn set_sound_speed_from_temp(#[case] expected: f32, #[case] temp: f32) {
        let mut env = Environment::new();
        env.set_sound_speed_from_temp(temp);
        approx::assert_abs_diff_eq!(expected * mm, env.sound_speed, epsilon = 1e-3);
    }

    #[rstest::rstest]
    #[case(8.5, 340e3)]
    #[case(10., 400e3)]
    fn wavelength(#[case] expect: f32, #[case] c: f32) {
        let mut env = Environment::new();
        env.sound_speed = c;
        approx::assert_abs_diff_eq!(expect, env.wavelength());
    }

    #[rstest::rstest]
    #[case(0.739_198_27, 340e3)]
    #[case(0.628_318_55, 400e3)]
    fn wavenumber(#[case] expect: f32, #[case] c: f32) {
        let mut env = Environment::new();
        env.sound_speed = c;
        approx::assert_abs_diff_eq!(expect, env.wavenumber());
    }
}