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
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

use std::f64::consts::PI;

use rebound_bind as rb;

use crate::{
    error::{OrbitalElementsError, Result},
    particles::{IntoParticle, Particle},
    simulation::{SimulationParticlesRead, SimulationSettingsRead, SimulationStateRead},
    utils,
};

use super::SemiMajorAxisInput;

#[derive(Clone, Copy, Default)]
pub struct PalOrbitalElementsBuilder {
    primary: Option<Particle>,
    g: Option<f64>,
    hash: u32,
    mass: f64,
    radius: f64,
    mean_longitude: f64,
    h: f64,
    k: f64,
    ix: f64,
    iy: f64,
    size: SemiMajorAxisInput,
}

impl PalOrbitalElementsBuilder {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn with_simulation_defaults<S>(mut self, simulation: &S) -> Self
    where
        S: SimulationParticlesRead + SimulationSettingsRead + SimulationStateRead + ?Sized,
    {
        if self.primary.is_none() {
            self.primary = Some(simulation.com());
        }
        if self.g.is_none() {
            self.g = Some(simulation.g());
        }
        self
    }

    pub fn set_primary(mut self, primary: Particle) -> Self {
        self.primary = Some(primary);
        self
    }

    pub fn set_g(mut self, g: f64) -> Self {
        self.g = Some(g);
        self
    }

    pub fn set_hash(mut self, hash: u32) -> Self {
        self.hash = hash;
        self
    }

    pub fn set_hash_by_name(mut self, hash: &str) -> Self {
        self.hash = utils::hash(hash);
        self
    }

    pub fn set_mass(mut self, mass: f64) -> Self {
        self.mass = mass;
        self
    }

    pub fn set_radius(mut self, radius: f64) -> Self {
        self.radius = radius;
        self
    }

    /// Sets the semi-major axis.
    /// Upstream REBOUND/Python name: `a`.
    pub fn set_semi_major_axis(mut self, semi_major_axis: f64) -> Self {
        self.size = self.size.set_semi_major_axis(semi_major_axis);
        self
    }

    /// Sets the orbital period.
    /// Upstream REBOUND/Python name: `P`.
    pub fn set_period(mut self, period: f64) -> Self {
        self.size = self.size.set_period(period);
        self
    }

    /// Sets the mean longitude in Pal coordinates.
    /// Upstream REBOUND/Python name: `l`.
    pub fn set_mean_longitude(mut self, mean_longitude: f64) -> Self {
        self.mean_longitude = mean_longitude;
        self
    }

    /// Sets the Pal `h` coordinate.
    /// Upstream REBOUND/Python name: `h`.
    pub fn set_h(mut self, h: f64) -> Self {
        self.h = h;
        self
    }

    /// Sets the Pal `k` coordinate.
    /// Upstream REBOUND/Python name: `k`.
    pub fn set_k(mut self, k: f64) -> Self {
        self.k = k;
        self
    }

    /// Sets the Pal `ix` coordinate.
    /// Upstream REBOUND/Python name: `ix`.
    pub fn set_ix(mut self, ix: f64) -> Self {
        self.ix = ix;
        self
    }

    /// Sets the Pal `iy` coordinate.
    /// Upstream REBOUND/Python name: `iy`.
    pub fn set_iy(mut self, iy: f64) -> Self {
        self.iy = iy;
        self
    }

    fn resolve_primary(self) -> Result<Particle> {
        self.primary
            .ok_or(OrbitalElementsError::MissingPrimary.into())
    }

    fn resolve_g(self) -> Result<f64> {
        self.g.ok_or(OrbitalElementsError::MissingGravity.into())
    }

    fn resolve_semi_major_axis(self, g: f64, primary: Particle) -> Result<f64> {
        match self.size {
            SemiMajorAxisInput::Unset => {
                Err(OrbitalElementsError::MissingSemiMajorAxisOrPeriod.into())
            }
            SemiMajorAxisInput::SemiMajorAxis(semi_major_axis) => Ok(semi_major_axis),
            SemiMajorAxisInput::Period(period) => {
                Ok((period * period * g * (primary.mass + self.mass) / (4.0 * PI * PI)).cbrt())
            }
            SemiMajorAxisInput::Conflicting => {
                Err(OrbitalElementsError::BothSemiMajorAxisAndPeriod.into())
            }
        }
    }
}

impl IntoParticle for PalOrbitalElementsBuilder {
    fn with_simulation_defaults<S>(self, simulation: &S) -> Self
    where
        S: SimulationParticlesRead + SimulationSettingsRead + SimulationStateRead + ?Sized,
    {
        PalOrbitalElementsBuilder::with_simulation_defaults(self, simulation)
    }

    fn into_particle(self) -> Result<Particle> {
        let primary = self.resolve_primary()?;
        let g = self.resolve_g()?;
        let semi_major_axis = self.resolve_semi_major_axis(g, primary)?;

        if (self.ix * self.ix + self.iy * self.iy) > 4.0 {
            return Err(OrbitalElementsError::InvalidPalInclinationComponents.into());
        }

        let particle = unsafe {
            rb::reb_particle_from_pal(
                g,
                primary.into(),
                self.mass,
                semi_major_axis,
                self.mean_longitude,
                self.k,
                self.h,
                self.ix,
                self.iy,
            )
        };

        let mut particle: Particle = particle.into();
        particle.hash = self.hash;
        particle.radius = self.radius;
        Ok(particle)
    }
}