deep_causality_physics 0.6.2

Standard library of physics formulas and engineering primitives for DeepCausality.
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

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */

use crate::{Length, Mass, PhysicsError, Speed};
use crate::{NEWTONIAN_CONSTANT_OF_GRAVITATION, SPEED_OF_LIGHT};
use deep_causality_num::{FromPrimitive, RealField};

/// Calculates orbital velocity: $v = \sqrt{\frac{GM}{r}}$.
pub fn orbital_velocity_kernel<R>(
    mass_primary: &Mass<R>,
    radius: &Length<R>,
) -> Result<Speed<R>, PhysicsError>
where
    R: RealField + FromPrimitive,
{
    let r = radius.value();
    if r <= R::zero() {
        return Err(PhysicsError::MetricSingularity(
            "Non-positive radius in orbital velocity".into(),
        ));
    }
    let g = R::from_f64(NEWTONIAN_CONSTANT_OF_GRAVITATION)
        .ok_or_else(|| PhysicsError::NumericalInstability("R::from_f64(G) failed".into()))?;
    let gm = g * mass_primary.value();
    let v = (gm / r).sqrt();
    Speed::new(v)
}

/// Calculates escape velocity: $v_e = \sqrt{\frac{2GM}{r}}$.
pub fn escape_velocity_kernel<R>(
    mass_primary: &Mass<R>,
    radius: &Length<R>,
) -> Result<Speed<R>, PhysicsError>
where
    R: RealField + FromPrimitive,
{
    if radius.value() == R::zero() {
        return Err(PhysicsError::MetricSingularity(
            "Zero radius in escape velocity".into(),
        ));
    }
    let g = R::from_f64(NEWTONIAN_CONSTANT_OF_GRAVITATION)
        .ok_or_else(|| PhysicsError::NumericalInstability("R::from_f64(G) failed".into()))?;
    let two = R::from_f64(2.0)
        .ok_or_else(|| PhysicsError::NumericalInstability("R::from_f64(2.0) failed".into()))?;
    let gm = g * mass_primary.value();
    let v = (two * gm / radius.value()).sqrt();
    Speed::new(v)
}

/// Calculates Schwarzschild radius: $r_s = \frac{2GM}{c^2}$.
pub fn schwarzschild_radius_kernel<R>(mass: &Mass<R>) -> Result<Length<R>, PhysicsError>
where
    R: RealField + FromPrimitive,
{
    let g = R::from_f64(NEWTONIAN_CONSTANT_OF_GRAVITATION)
        .ok_or_else(|| PhysicsError::NumericalInstability("R::from_f64(G) failed".into()))?;
    let two = R::from_f64(2.0)
        .ok_or_else(|| PhysicsError::NumericalInstability("R::from_f64(2.0) failed".into()))?;
    let c = R::from_f64(SPEED_OF_LIGHT)
        .ok_or_else(|| PhysicsError::NumericalInstability("R::from_f64(c) failed".into()))?;
    let num = two * g * mass.value();
    let den = c * c;
    let r = num / den;
    Length::new(r)
}