siderust 0.9.1

High-precision astronomy and satellite mechanics in 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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (C) 2026 Vallés Puig, Ramon

//! Third-body perturbation force model.

use std::sync::Arc;

use affn::cartesian::Displacement;
use principia::{AccelerationModel, PrincipiaError};

use crate::astro::dynamics::context::DynamicsContext;
use crate::astro::dynamics::errors::DynamicsError;
use crate::astro::dynamics::state::{Acceleration, AccelerationUnit, OrbitState};
use crate::astro::precession::ecliptic_of_date_to_mean_equatorial_matrix;
use crate::coordinates::centers::Geocentric;
use crate::coordinates::frames::{EclipticMeanJ2000, GCRS};
use crate::ephemeris::DynEphemeris;
use crate::qtty::{AstronomicalUnit, Kilometer};
use crate::time::{JulianDate, JD, TT};

use super::{GravitationalParameter, GM_MOON, GM_SUN};

fn battin_third_body_accel(r_s: [f64; 3], r_b: [f64; 3], mu: f64) -> [f64; 3] {
    let r_b_sq = r_b[0] * r_b[0] + r_b[1] * r_b[1] + r_b[2] * r_b[2];
    let r_b_norm = r_b_sq.sqrt();
    if r_b_norm == 0.0 {
        return [0.0; 3];
    }
    let q = (r_s[0] * (r_s[0] - 2.0 * r_b[0])
        + r_s[1] * (r_s[1] - 2.0 * r_b[1])
        + r_s[2] * (r_s[2] - 2.0 * r_b[2]))
        / r_b_sq;
    let fq = q * (3.0 + q * (3.0 + q)) / (1.0 + (1.0 + q).powf(1.5));
    let denom = r_b_norm * r_b_sq * (1.0 + fq);
    if denom == 0.0 {
        return [0.0; 3];
    }
    let scale = -mu / denom;
    [
        scale * (r_b[0] * fq + r_s[0]),
        scale * (r_b[1] * fq + r_s[1]),
        scale * (r_b[2] * fq + r_s[2]),
    ]
}

pub(super) fn sun_geocentric(
    eph: &Arc<dyn DynEphemeris + Send + Sync>,
    jd: JulianDate,
) -> Result<Displacement<GCRS, Kilometer>, DynamicsError> {
    let sun_b = eph
        .try_sun_barycentric(jd)
        .map_err(|e| DynamicsError::EphemerisUnavailable {
            body: "Sun",
            source: Some(Box::new(e)),
        })?;
    let earth_b =
        eph.try_earth_barycentric(jd)
            .map_err(|e| DynamicsError::EphemerisUnavailable {
                body: "Earth",
                source: Some(Box::new(e)),
            })?;
    let d_ecl: Displacement<EclipticMeanJ2000, AstronomicalUnit> = sun_b - earth_b;
    let rot = ecliptic_of_date_to_mean_equatorial_matrix(JulianDate::JD_EPOCH_J2000_0);
    Ok(rot.apply_vec(d_ecl).to_unit::<Kilometer>())
}

pub(super) fn moon_geocentric(
    eph: &Arc<dyn DynEphemeris + Send + Sync>,
    jd: JulianDate,
) -> Result<Displacement<GCRS, Kilometer>, DynamicsError> {
    let m = eph
        .try_moon_geocentric(jd)
        .map_err(|e| DynamicsError::EphemerisUnavailable {
            body: "Moon",
            source: Some(Box::new(e)),
        })?;
    let m_ecl = Displacement::<EclipticMeanJ2000, Kilometer>::new(
        m.x().value(),
        m.y().value(),
        m.z().value(),
    );
    let rot = ecliptic_of_date_to_mean_equatorial_matrix(JulianDate::JD_EPOCH_J2000_0);
    Ok(rot.apply_vec(m_ecl))
}

/// Trait for objects that provide the position and gravitational parameter of a
/// perturbing third body relative to the reference frame origin.
pub trait ThirdBodyProvider: Send + Sync {
    /// Short human-readable name of the perturbing body (e.g. `"Sun"`).
    fn name(&self) -> &'static str;
    /// Standard gravitational parameter µ = GM (km³ s⁻²) of the body.
    fn gm(&self) -> GravitationalParameter;
    /// Geocentric position of the body in GCRS at `epoch`.
    fn position_relative_to_origin(
        &self,
        eph: &Arc<dyn DynEphemeris + Send + Sync>,
        epoch: JulianDate,
    ) -> Result<Displacement<GCRS, Kilometer>, DynamicsError>;
}

/// Third-body perturbation due to solar gravity.
#[derive(Debug, Clone, Copy, Default)]
pub struct SunPerturbation;
impl ThirdBodyProvider for SunPerturbation {
    fn name(&self) -> &'static str {
        "Sun"
    }
    fn gm(&self) -> GravitationalParameter {
        GM_SUN
    }
    fn position_relative_to_origin(
        &self,
        eph: &Arc<dyn DynEphemeris + Send + Sync>,
        epoch: JulianDate,
    ) -> Result<Displacement<GCRS, Kilometer>, DynamicsError> {
        sun_geocentric(eph, epoch)
    }
}

/// Third-body perturbation due to lunar gravity.
#[derive(Debug, Clone, Copy, Default)]
pub struct MoonPerturbation;
impl ThirdBodyProvider for MoonPerturbation {
    fn name(&self) -> &'static str {
        "Moon"
    }
    fn gm(&self) -> GravitationalParameter {
        GM_MOON
    }
    fn position_relative_to_origin(
        &self,
        eph: &Arc<dyn DynEphemeris + Send + Sync>,
        epoch: JulianDate,
    ) -> Result<Displacement<GCRS, Kilometer>, DynamicsError> {
        moon_geocentric(eph, epoch)
    }
}

/// Composite third-body force model: accumulates contributions from any number
/// of [`ThirdBodyProvider`]s using the Battin formulation for numerical stability.
pub struct ThirdBody {
    bodies: Vec<Box<dyn ThirdBodyProvider>>,
}

impl ThirdBody {
    /// Create an empty model with no perturbing bodies.
    pub fn new() -> Self {
        Self { bodies: Vec::new() }
    }
    /// Add solar gravity perturbation.
    pub fn with_sun(mut self) -> Self {
        self.bodies.push(Box::new(SunPerturbation));
        self
    }
    /// Add lunar gravity perturbation.
    pub fn with_moon(mut self) -> Self {
        self.bodies.push(Box::new(MoonPerturbation));
        self
    }
    /// Add an arbitrary third-body provider.
    pub fn with(mut self, body: Box<dyn ThirdBodyProvider>) -> Self {
        self.bodies.push(body);
        self
    }
    /// Convenience constructor: Sun + Moon perturbations.
    pub fn sun_and_moon() -> Self {
        Self::new().with_sun().with_moon()
    }
}

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

impl AccelerationModel<DynamicsContext, TT, Geocentric, GCRS> for ThirdBody {
    fn name(&self) -> &'static str {
        "third_body"
    }

    fn acceleration(
        &self,
        s: &OrbitState<Geocentric, GCRS>,
        ctx: &DynamicsContext,
    ) -> Result<Acceleration<GCRS, AccelerationUnit>, PrincipiaError> {
        if self.bodies.is_empty() {
            return Ok(Acceleration::new(0.0, 0.0, 0.0));
        }
        let eph = ctx
            .require_ephemeris()
            .map_err(DynamicsError::into_principia)?;
        let jd = s.epoch.to::<JD>();
        let r_s = [
            s.position.x().value(),
            s.position.y().value(),
            s.position.z().value(),
        ];
        let mut total = [0.0; 3];
        for body in &self.bodies {
            let r_b = body
                .position_relative_to_origin(eph, jd)
                .map_err(DynamicsError::into_principia)?;
            let a = battin_third_body_accel(
                r_s,
                [r_b.x().value(), r_b.y().value(), r_b.z().value()],
                body.gm().value(),
            );
            total[0] += a[0];
            total[1] += a[1];
            total[2] += a[2];
        }
        Ok(Acceleration::new(total[0], total[1], total[2]))
    }
}

#[cfg(test)]
mod tests {
    use std::sync::Arc;

    use super::*;
    use crate::astro::dynamics::context::DynamicsContextBuilder;
    use crate::astro::dynamics::{Position, Velocity};
    use crate::ephemeris::Vsop87Ephemeris;

    fn direct_third_body_accel(r_s: [f64; 3], r_b: [f64; 3], mu: f64) -> [f64; 3] {
        let d = [r_b[0] - r_s[0], r_b[1] - r_s[1], r_b[2] - r_s[2]];
        let d3 = (d[0] * d[0] + d[1] * d[1] + d[2] * d[2]).powf(1.5);
        let rb3 = (r_b[0] * r_b[0] + r_b[1] * r_b[1] + r_b[2] * r_b[2]).powf(1.5);
        [
            mu * (d[0] / d3 - r_b[0] / rb3),
            mu * (d[1] / d3 - r_b[1] / rb3),
            mu * (d[2] / d3 - r_b[2] / rb3),
        ]
    }

    fn leo() -> OrbitState {
        OrbitState::new(
            JulianDate::JD_EPOCH_J2000_0.to_j2000s(),
            Position::<GCRS>::new(7000.0, 0.0, 0.0),
            Velocity::<GCRS>::new(0.0, 7.5, 0.0),
        )
    }

    fn ctx_with_eph() -> DynamicsContext {
        DynamicsContextBuilder::new()
            .with_ephemeris(Arc::new(Vsop87Ephemeris))
            .build()
    }

    #[test]
    fn empty_body_list_returns_zero_without_ephemeris() {
        let a = ThirdBody::new()
            .acceleration(&leo(), &DynamicsContext::empty())
            .unwrap();
        assert_eq!(a.magnitude().value(), 0.0);
    }

    #[test]
    fn sun_and_moon_nonzero_acceleration() {
        let mag = ThirdBody::sun_and_moon()
            .acceleration(&leo(), &ctx_with_eph())
            .unwrap()
            .magnitude()
            .value();
        assert!(mag > 0.0 && mag < 1e-4);
    }

    /// Verify the Battin formula matches the direct (numerically naive) formula
    /// for well-separated geometries (LEO, MEO, GEO spacecraft vs Moon/Sun).
    #[test]
    fn battin_matches_direct_formula_well_separated() {
        const MU_MOON: f64 = 4902.8;
        const MU_SUN: f64 = 1.327_124_4e11;

        let cases: &[(&str, [f64; 3], [f64; 3], f64)] = &[
            // LEO spacecraft, Moon roughly in +Y
            (
                "leo_moon",
                [7_000.0, 0.0, 0.0],
                [0.0, 384_400.0, 0.0],
                MU_MOON,
            ),
            // MEO spacecraft, Moon at an angle
            (
                "meo_moon",
                [20_000.0, 5_000.0, 0.0],
                [200_000.0, 300_000.0, 50_000.0],
                MU_MOON,
            ),
            // GEO spacecraft, Sun in +X
            ("geo_sun", [42_164.0, 0.0, 0.0], [1.496e8, 0.0, 0.0], MU_SUN),
            // Out-of-plane spacecraft, Moon at angle
            (
                "inclined_moon",
                [5_000.0, 3_000.0, 4_000.0],
                [-150_000.0, 330_000.0, 80_000.0],
                MU_MOON,
            ),
        ];

        for (name, r_s, r_b, mu) in cases {
            let battin = battin_third_body_accel(*r_s, *r_b, *mu);
            let direct = direct_third_body_accel(*r_s, *r_b, *mu);

            let mag =
                (direct[0] * direct[0] + direct[1] * direct[1] + direct[2] * direct[2]).sqrt();
            assert!(mag > 0.0, "{name}: reference magnitude is zero");

            for i in 0..3 {
                let rel_err = ((battin[i] - direct[i]) / mag).abs();
                assert!(
                    rel_err < 1e-10,
                    "{name}[{i}]: Battin={:.6e}, direct={:.6e}, rel_err={:.3e}",
                    battin[i],
                    direct[i],
                    rel_err
                );
            }
        }
    }
}