rebound-rs 4.6.0-alpha.1

Rust wrapper for the REBOUND N-body simulation library.
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

use crate::bind;

/// Returns `angle` wrapped into the interval `[0, 2π)`.
///
/// # Arguments
///
/// * `angle` - The angle to wrap.
///
/// # Returns
///
/// The wrapped angle.
pub fn mod_2pi(angle: f64) -> f64 {
    unsafe { bind::reb_mod2pi(angle) }
}

/// Converts mean anomaly to eccentric anomaly.
///
/// # Arguments
///
/// * `eccentricity` - The eccentricity of the orbit.
/// * `mean_anomaly` - The mean anomaly to convert.
///
/// # Returns
///
/// The eccentric anomaly.
pub fn mean_to_eccentric_anomaly(eccentricity: f64, mean_anomaly: f64) -> f64 {
    unsafe { bind::reb_M_to_E(eccentricity, mean_anomaly) }
}

/// Converts mean anomaly to true anomaly.
///
/// # Arguments
///
/// * `eccentricity` - The eccentricity of the orbit.
/// * `mean_anomaly` - The mean anomaly to convert.
///
/// # Returns
///
/// The true anomaly.
pub fn mean_to_true_anomaly(eccentricity: f64, mean_anomaly: f64) -> f64 {
    unsafe { bind::reb_M_to_f(eccentricity, mean_anomaly) }
}

/// Converts eccentric anomaly to true anomaly.
///
/// # Arguments
///
/// * `eccentricity` - The eccentricity of the orbit.
/// * `eccentric_anomaly` - The eccentric anomaly to convert.
///
/// # Returns
///
/// The true anomaly.
pub fn eccentric_to_true_anomaly(eccentricity: f64, eccentric_anomaly: f64) -> f64 {
    unsafe { bind::reb_E_to_f(eccentricity, eccentric_anomaly) }
}