dimensional_analyser 0.2.0

Runtime dimensional analysis and unit-aware quantities for Rust
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

//! This interpretation of the natural units defines the universal constants plank units are derived from.

use crate::{dimension, {dimension::{DeepDereferrenceable, DimensionalAnalysable}, dimensions::{le_systeme_international_d_unites::{JOULE, base_units::{AMPERE, KELVIN, KILOGRAM, METER, SECOND}}, natural_units::base_units::BASE_UNITS, the_seven_c_s::base_units::{C_AS_THE_SPEED_OF_LIGHT, COULOMB}}}};
use std::{f64::consts::PI, sync::LazyLock};
use crate::dimension::Dimension;

/// Contains the five fundamental physical constants used as base units.
pub mod base_units {
    use super::{dimension, JOULE, SECOND, METER, KILOGRAM, AMPERE, KELVIN, LazyLock, Dimension, C_AS_THE_SPEED_OF_LIGHT};
    
    dimension!(REDUCED_PLANCK_CONSTANT =;1.054_571_817e-34;JOULE SECOND "ℏ (h-bar).");
    dimension!(GRAVITATIONAL_CONSTANT =;6.674_30e-11;METER^3 KILOGRAM^-1 SECOND^-2  "G, Newton's gravitational constant.");
    dimension!(VACUUM_PERMITTIVITY =;8.854_187_818_8e-12;SECOND^4 KILOGRAM^-1 METER^-3 AMPERE^2 "ε₀");
    dimension!(BOLTZMANN_CONSTANT =;1.380_649e-23;JOULE KELVIN^-1 "`k_B`");
    
    /// The five fundamental constants as base units.
    pub static BASE_UNITS: LazyLock<Box<[&LazyLock<Dimension>]>> = LazyLock::new(|| [
        &C_AS_THE_SPEED_OF_LIGHT, &REDUCED_PLANCK_CONSTANT, &GRAVITATIONAL_CONSTANT,
        &VACUUM_PERMITTIVITY, &BOLTZMANN_CONSTANT
    ].into());
}

dimension!(,137.035_999_177,FINE_STRUCTURE_CONSTANT = "(alpha), the dimensionless coupling constant.");
dimension!(
    DERIVED_CHARGE
    = BASE_UNITS.get().product_of_powers(&BASE_UNITS.get().exponents_to(&COULOMB).expect("Convertible"))
    => "Charge unit derived from the five fundamental constants."
);
dimension!(PLANK_CHARGE =;(4.0 * PI).sqrt();DERIVED_CHARGE "Charge in Planck units.");
dimension!(ELEMENTARY_CHARGE = PLANK_CHARGE FINE_STRUCTURE_CONSTANT^0.5 "e, the charge of an electron/proton.");

#[cfg(test)]
mod tests {
    use crate::{debug_println, {dimension::{DeepDereferrenceable, DimensionalAnalysable}, dimensions::natural_units::{DERIVED_CHARGE, ELEMENTARY_CHARGE, PLANK_CHARGE, base_units::BASE_UNITS}}};
    #[test]
    fn coherency_of_system() {
        let exponents = BASE_UNITS.get().coherent_system5().expect("The natural units system should be coherent");
        debug_println!("The unit for mass:                {}", BASE_UNITS.get().product_of_powers(&exponents[0]));
        debug_println!("The unit for length:              {}", BASE_UNITS.get().product_of_powers(&exponents[1]));
        debug_println!("The unit for time:                {}", BASE_UNITS.get().product_of_powers(&exponents[2]));
        debug_println!("The unit for electrical current:  {}", BASE_UNITS.get().product_of_powers(&exponents[3]));
        debug_println!("The unit for temperature:         {}", BASE_UNITS.get().product_of_powers(&exponents[4]));
        debug_println!("The unit for charge:              {}", *DERIVED_CHARGE);
        debug_println!("The unit for plank charge:        {}", *PLANK_CHARGE);
        debug_println!("The unit for elementary charge:   {}", *ELEMENTARY_CHARGE);
    }
}