Expand description
Numerical ODE integration.
SGP4 is analytic and needs no integrator; this crate is for what SGP4 cannot do — high-fidelity force models, deep space, manoeuvres, orbit determination, attitude.
Two rules govern everything here, and they come before any method:
- Coefficients are verified, never transcribed from memory. Every Butcher tableau is checked
against its order conditions in a computer algebra system (
derivations/dopri5_order.mac) and against analytic-solution and convergence-order tests. A method claiming order 5 that is secretly order 4 is caught by reading the measured order off the numbers, not by hoping. - Dense output is the interface. A propagator without a continuous interpolant forces the
caller into the ring-buffer spline hack GMAT is stuck with. Every adaptive method carries its
DenseOutput, sospacelab_coverage::find_eventscan evaluateg(t)at anytinside a step without re-integrating.
The state is a fixed-size [f64; N]: [rx, ry, rz, vx, vy, vz] for an orbit, a quaternion plus
body rate for attitude, 6·M for M bodies. Const-generic N keeps it on the stack, no_std,
and friendly to the autovectoriser.
Re-exports§
pub use attitude_law::AttitudeProvider;pub use attitude_law::LocalOrbitalFrame;pub use attitude_law::LofType;pub use attitude_law::SpinStabilized;pub use attitude_law::SunPointing;pub use attitude_law::YawSteering;pub use density_rom::jacobi_symmetric;pub use dop853::Dop853;pub use dopri5::Dopri5;pub use drag_coefficient::FreeMolecularConditions;pub use drag_coefficient::SentmanCoefficients;pub use drag_coefficient::sentman_panel;pub use drag_coefficient::speed_ratio;pub use dsst::DsstAuxiliary;pub use dsst::DsstMeanPropagator;pub use dsst::DsstSolarRadiationPressure;pub use dsst::DsstTesseral;pub use dsst::DsstThirdBody;pub use dsst::DsstZonal;pub use earth_radiation::AngularResolution;pub use earth_radiation::KnockeEarthRadiation;pub use geopotential::GeoPotential;pub use harris_priester::HarrisPriester;pub use harris_priester::HarrisPriesterAtmosphere;pub use harris_priester::harris_priester;pub use maneuver::AccelerationSignal;pub use maneuver::ConstantThrust;pub use maneuver::EmpiricalAcceleration;pub use maneuver::Frame;pub use maneuver::HarmonicSignal;pub use maneuver::ImpulsiveManeuver;pub use maneuver::PolynomialSignal;pub use nrlmsise00::Nrlmsise00Atmosphere;pub use nrlmsise00::Nrlmsise00Flags;pub use nrlmsise00::Nrlmsise00Input;pub use nrlmsise00::Nrlmsise00Output;pub use nrlmsise00::gtd7;pub use nrlmsise00::gtd7d;pub use ocean_tide::OceanTide;pub use relativity::DeSitter;pub use relativity::LenseThirring;pub use relativity::Schwarzschild;pub use solid_tide::MeanPole;pub use solid_tide::SolidEarthTide;pub use solid_tide::ocean_pole_tide_corrections;pub use solid_tide::pole_tide_corrections;pub use solid_tide::step2_corrections;pub use spacecraft::BoxWing;pub use spacecraft::Cannonball;pub use spacecraft::DragModel;pub use spacecraft::Facet;pub use spacecraft::PanelDrag;pub use spacecraft::PanelNormal;pub use spacecraft::PanelSrp;pub use spacecraft::RadiationModel;pub use time_variable_gravity::conventional_zonal_coefficients;pub use time_variable_gravity::secular_zonal_correction;pub use tolerance::Tolerance;
Modules§
- abm
- Adams–Bashforth–Moulton, order 8, fixed step, in predict–evaluate–correct–evaluate (PECE) form.
- adams_
nordsieck - Adams–Moulton (order 5) in Nordsieck form — a multistep method whose step changes for free.
- ark
- ARK4(3)6L
2SA — an additive (implicit–explicit) Runge–Kutta of order 4 (Kennedy & Carpenter 2003). - attitude
- Attitude on
SO(3)by a Lie-group integrator (Runge–Kutta–Munthe-Kaas), for the free rigid body. - attitude_
law - Attitude laws (pointing providers) — the analogue of Orekit’s
AttitudeProvider. - density_
calibration - Open, HASDM-style thermospheric density calibration — a data-driven multiplicative correction to any base density model (JB2008 / DTM2020 / NRLMSISE-00), fit to observed density/model ratios.
- density_
data - Load real accelerometer-derived thermospheric densities into calibration samples for
crate::density_calibration/crate::density_rom. - density_
rom - Reduced-order thermospheric density modelling (ML-ROM) — Proper Orthogonal Decomposition of a set of density-field snapshots plus a learned linear map from space-weather drivers to the reduced coordinates. This is the Mehta–Linares / Gondelach–Linares reduced-order-model approach, built on openly published accelerometer densities (CHAMP / GRACE / GRACE-FO / Swarm): compress the high-dimensional log-density field to a handful of energetic spatial modes, then predict the mode amplitudes from drivers (F10.7, Ap, …). No NRLMSIS 2.x code, data, or patented method is used.
- dop853
- Dormand–Prince 8(5,3), the
DOP853method, with Hairer’s 7th-order dense output. - dopri5
- Dormand–Prince 5(4), the
DOPRI5embedded pair, with Hairer’s 4th-order dense output. - drag_
coefficient - Physical free-molecular-flow drag coefficient (Sentman’s gas–surface interaction), replacing the
fixed
C_d ≈ 2.2assumption of a cannonball or a constant-coefficient box-wing. - driver
- Adaptive-step driver with Hairer’s PI controller, generic over the integration method.
- dsst
- DSST (Draper Semi-analytical Satellite Theory) — central-body zonal mean-element rates.
- earth_
radiation - Knocke Earth-reradiated radiation pressure — albedo (reflected sunlight) and thermal-IR emission —
a port of Orekit’s
KnockeRediffusedForceModel(Knocke, Ries & Tapley, “Earth Radiation Pressure Effects on Satellites”, 1988), with Lambert’s cosine where Orekit has another (below). - ephemeris
- Low-precision analytic ephemerides of the perturbing bodies.
- forces
- Force models, each written once over any
Scalarso its Jacobian — and hence the state transition matrix — comes from automatic differentiation. - gbs
- Gragg–Bulirsch–Stoer: modified-midpoint integration with Richardson extrapolation to high order.
- geopotential
- The full tesseral geopotential
C̄_nm, S̄_nmto high degree/order — longitude-dependent gravity, the piece the zonal-onlycrate::forces::Zonalcannot represent. - geopotential_
coeffs - Embedded spherical-harmonic gravity-model coefficients (fully normalized), truncated.
- gj
- Gauss–Jackson, order 8: the second-sum predictor–corrector for
x'' = a(x), the workhorse of high-precision orbit propagation (used by USSPACECOM for the public catalog). - harris_
priester - Modified Harris-Priester empirical thermospheric density model.
- ias15
- IAS15 — a 15th-order, adaptive Gauss–Radau integrator (Everhart 1985; Rein & Spiegel 2015).
- ks
- Kustaanheimo–Stiefel regularization: integrate the Kepler problem as a linear oscillator, with no
singularity at
r → 0and uniform steps in fictitious time. - lifetime
- Orbital lifetime and re-entry prediction.
- lightcurve
- The photometric forward model: how bright a box-wing spacecraft looks, from its attitude.
- linalg
- Small dense linear algebra for the implicit integrators: LU factorisation with partial pivoting.
- lunar
- The Moon as a central body: its gravity field, and the two body-fixed frames it is quoted in.
- lunar_
coeffs - Embedded lunar spherical-harmonic gravity coefficients (fully normalized), truncated.
- maneuver
- Manoeuvres and empirical accelerations — finite (continuous) thrust with mass depletion,
instantaneous impulses, and the polynomial / argument-of-latitude-harmonic empirical terms orbit
determination uses to absorb un-modelled residuals. Ports of Orekit’s
ConstantThrustManeuver,ImpulseManeuver, andParametricAcceleration/PolynomialAccelerationModel, validated against them (tools/orekit-oracle,orekit_maneuver.csv). - mercurius
- MERCURIUS — a hybrid symplectic/adaptive integrator: the Wisdom–Holman map far from a close encounter, IAS15 near it, joined by splitting the interaction with a smooth changeover (Rein et al. 2019).
- mri
- MRI-GARK-ERK33a — a multirate infinitesimal integrator of order 3 (Sandu 2019).
- netcdf_
classic - A reader for NetCDF classic files — the CDF-1 and CDF-2 formats — over a byte slice.
- nrlmsise00
- NRLMSISE-00 empirical thermospheric density and temperature model (Picone et al. 2002).
- ocean_
tide - IERS 2010 ocean-tide geopotential perturbation (IERS Conventions 2010, §6.3, Eq. 6.15).
- ocean_
tide_ admittance - FES ocean-tide admittance-inference weight tables (minor waves from the explicit FES2004
majors) — machine-generated by
derivations/ocean_tide_admittance.py. Regenerate, never hand-edit. See that script andcrate::ocean_tidefor the theory; weights are validated againstpyfesinexperiments/ocean_tide_admittance_verify.py. - ocean_
tide_ eot20 - EOT20 ocean-tide geopotential coefficients (IERS Conventions 2010, Eq. 6.21) –
machine-computed by
derivations/tide_to_stokes.pyfrom the DGFI-TUM cotidal grids. - ocean_
tide_ fes2004 - FES2004 ocean-tide geopotential coefficients (IERS Conventions 2010, Eq. 6.15) –
machine-generated by
derivations/ocean_tide_fes2004.pyfromfes2004_Cnm-Snm.dat. Verbatim file values; the 10^-11 unit isSCALE, applied at use (as Orekit does). Regenerate, never hand-edit. - ocean_
tide_ fes2014 - FES2014b ocean-tide geopotential coefficients (IERS Conventions 2010, Eq. 6.15) –
machine-generated by
derivations/ocean_tide_fes2014.pyfromfes2014b_Cnm-Snm.txt. Full model to degree/order 100 (no truncation); verbatim file values, the 10^-11 unit isSCALE, applied at use. The runtime evaluation degree is chosen oncrate::ocean_tide::OceanTide, not here. Regenerate, never hand-edit. - ocean_
tide_ got - GOT5.5 ocean-tide geopotential coefficients (IERS Conventions 2010, Eq. 6.21) –
machine-computed by
derivations/tide_to_stokes.pyfrom the GSFC cotidal grids. - radau
- Radau IIA, 3-stage, order 5: the L-stable implicit collocation Runge–Kutta.
- relativity
- IERS 2010 relativistic corrections to the satellite equation of motion (Conventions Ch. 10, Eq. 10.12).
- rk4
- Classical fourth-order Runge–Kutta, fixed step — the baseline every other method is checked against.
- rkn1210
- The RKN12(10)17 Runge–Kutta–Nyström pair of Dormand, El-Mikkawy & Prince (1987): a
twelfth-order integrator for the special second-order system
r̈ = f(t, r), with an embedded tenth-order solution for adaptive step control. - rosenbrock
- Rosenbrock GRK4T, order 4: a linearly-implicit Runge–Kutta for stiff systems.
- saba
- SABA_n — high-order symplectic integrators for a near-integrable Hamiltonian
H = A + εB(Laskar & Robutel 2001), withAthe exact Kepler drift andBthe perturbation kick. - sdtm
- SDTM — a semi-empirical total-density model of the thermosphere, on open data only.
- shadow
- Conical umbra/penumbra shadow geometry for radiation forces — the lighting ratio
ν ∈ [0, 1], the fraction of the solar disc a spherical occulting body leaves visible. - solid_
tide - IERS 2010 solid Earth tide (IERS Conventions 2010, Chapter 6).
- space_
weather - Space-weather index feed — daily F10.7 solar flux and Ap geomagnetic index, the drivers every
empirical thermosphere model (NRLMSISE-00 / JB2008 / DTM2020) and the
crate::density_romreduced dynamics need. - spacecraft
- Attitude-dependent box-wing (panel) spacecraft models for atmospheric drag and solar
radiation pressure — a faithful port of Orekit’s
BoxAndSolarArraySpacecraft(RadiationSensitive/DragSensitive). - stt
- The second-order state-transition tensor (STT), by integrating the second-order variational equations with an AD Hessian.
- symplectic
- Symplectic integrators for a separable Hamiltonian
H = T(v) + V(x)— the structure a gravitational problem has, where the force depends on position alone. - taylor
- An adaptive Taylor-series integrator, driven by automatic differentiation of the flow.
- time_
variable_ gravity - Time-variable gravity — the secular drift of the low-degree zonal geopotential coefficients (IERS Conventions 2010, §6.2, Table 6.2).
- tolerance
- Error tolerance and the scaled error norm that drives step acceptance.
- torque
- Environmental torques on a rigid box-wing spacecraft, body frame, N·m.
- variational
- The state transition matrix, by integrating the variational equations with an AD Jacobian.
- wam_ipe
- NOAA’s WAM-IPE neutral mass density — the public physics nowcast — as a field the calibration layer can be fitted to.
- whfast
- WHFast — the Wisdom–Holman symplectic map with an exact Kepler drift (Wisdom & Holman 1991; Rein & Tamayo 2015).
- wind_
data - Load measured thermospheric crosswinds into fit samples for
crate::wind_model. - wind_
model - An empirical horizontal thermospheric wind model, fitted here to measured crosswinds.
Structs§
- Step
Trial - The outcome of one trial step of an embedded method: the new state, the componentwise error estimate, and the dense interpolant for the step just taken.
Traits§
- Dense
Output - A continuous representation of the solution over one accepted step, so events and output need no
re-integration. Valid on
[t0, t0 + h]; behaviour outside that is extrapolation and unspecified. - Dynamical
System - The right-hand side of an ODE: writes
dy/dtat(t, y)intodydt.