astrodyn_planet 0.2.0

Planet definitions and presets (Earth, Moon, Sun, Mars) for the astrodyn orbital-dynamics pipeline
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

//! Canonical [`PlanetShape`] constants matching the
//! per-body data files under
//! [`models/environment/planet/data/src/`](https://github.com/nasa/jeod/blob/jeod_v5.4.0/models/environment/planet/data/src/)
//! in JEOD v5.4.0.
//!
//! Each preset combines the shape parameters from `<body>.cc` with the
//! gravitational parameter from the corresponding `<body>_<model>.cc`
//! gravity-coefficient file, so a downstream caller can pull a single
//! `PlanetShape` constant rather than reconstructing the values
//! field-by-field. The numeric values themselves live in
//! [`astrodyn_quantities::body_constants`] (the universal-leaf crate),
//! so kernel-level test code can read the same constants without
//! depending on `astrodyn_planet`.

use astrodyn_quantities::body_constants::{
    EARTH_FLAT_COEFF, EARTH_MU, EARTH_R_EQ, EARTH_R_POL, JUPITER_FLAT_COEFF, JUPITER_MU,
    JUPITER_R_EQ, JUPITER_R_POL, MARS_FLAT_COEFF, MARS_MU, MARS_R_EQ, MARS_R_POL, MOON_FLAT_COEFF,
    MOON_MU, MOON_R_EQ, MOON_R_POL, SATURN_FLAT_COEFF, SATURN_MU, SATURN_R_EQ, SATURN_R_POL,
    SUN_FLAT_COEFF, SUN_MU, SUN_R_EQ, SUN_R_POL,
};

use crate::planet::PlanetShape;

/// Earth (WGS84 ellipsoid). Constants from JEOD `earth.cc` and
/// `earth_GGM05C.cc`; numeric values live in
/// [`astrodyn_quantities::body_constants`].
pub const EARTH: PlanetShape =
    PlanetShape::new("Earth", EARTH_MU, EARTH_R_EQ, EARTH_R_POL, EARTH_FLAT_COEFF);

/// Moon. Constants from JEOD `moon.cc` and `moon_GRAIL150.cc`; numeric
/// values live in [`astrodyn_quantities::body_constants`].
pub const MOON: PlanetShape =
    PlanetShape::new("Moon", MOON_MU, MOON_R_EQ, MOON_R_POL, MOON_FLAT_COEFF);

/// Sun. Constants from JEOD `sun.cc` and `sun_spherical.cc`; numeric
/// values live in [`astrodyn_quantities::body_constants`].
pub const SUN: PlanetShape = PlanetShape::new("Sun", SUN_MU, SUN_R_EQ, SUN_R_POL, SUN_FLAT_COEFF);

/// Mars. Constants from JEOD `mars.cc` and `mars_MRO110B2.cc`; numeric
/// values live in [`astrodyn_quantities::body_constants`].
pub const MARS: PlanetShape =
    PlanetShape::new("Mars", MARS_MU, MARS_R_EQ, MARS_R_POL, MARS_FLAT_COEFF);

/// Jupiter (1-bar oblate ellipsoid). Constants from JEOD
/// `planet/data/src/jupiter.cc` and `gravity/data/src/jupiter_spherical.cc`;
/// numeric values live in [`astrodyn_quantities::body_constants`].
///
/// Like all [`PlanetShape`] presets this is an oblate ellipsoid (r_pol ≤ r_eq);
/// see [`PlanetShape::new`] for the oblate-only restriction.
pub const JUPITER: PlanetShape = PlanetShape::new(
    "Jupiter",
    JUPITER_MU,
    JUPITER_R_EQ,
    JUPITER_R_POL,
    JUPITER_FLAT_COEFF,
);

/// Saturn (1-bar oblate ellipsoid). Constants from JEOD
/// `ephemerides/verif/SIM_prop_planet/data/src/saturn_planet.cc` and
/// `saturn_spherical_gravity.cc`; numeric values live in
/// [`astrodyn_quantities::body_constants`].
pub const SATURN: PlanetShape = PlanetShape::new(
    "Saturn",
    SATURN_MU,
    SATURN_R_EQ,
    SATURN_R_POL,
    SATURN_FLAT_COEFF,
);