Struct CentralBody 

pub struct CentralBody {
    pub mass: f64,
    pub radius: Option<f64>,
}

Mass and optional radius for a central body used in orbital calculations.

Fields

mass: f64

Mass in kilograms.

radius: Option<f64>

Optional radius in meters.

Implementations

impl CentralBody

pub fn new(mass: f64) -> Option<CentralBody>

Creates a central body with mass and no stored radius.

Returns None when mass is negative or not finite.

pub fn with_radius(mass: f64, radius: f64) -> Option<CentralBody>

Creates a central body with mass and radius.

Returns None when mass is negative or not finite, or when radius is less than or equal to zero or not finite.

pub fn gravitational_parameter(&self) -> Option<f64>

Computes the body’s standard gravitational parameter.

pub fn orbital_radius_from_altitude(&self, altitude: f64) -> Option<f64>

Computes orbital radius from the stored body radius and an altitude.

Returns None when the body has no stored radius or when the inputs are invalid.

pub fn circular_orbital_speed_at_radius( &self, orbital_radius: f64, ) -> Option<f64>

Computes circular orbital speed at a radius around this body.

Examples

use use_orbit::CentralBody;

let earth = CentralBody::with_radius(5.972e24, 6.371e6);
let speed = earth.and_then(|body| body.circular_orbital_speed_at_radius(6_771_000.0));

assert!(speed.is_some_and(|value| value > 7_600.0));

pub fn circular_orbital_period_at_radius( &self, orbital_radius: f64, ) -> Option<f64>

Computes circular orbital period at a radius around this body.

pub fn escape_speed_at_radius(&self, distance: f64) -> Option<f64>

Computes escape speed at a radius around this body.

Trait Implementations

impl Clone for CentralBody

fn clone(&self) -> CentralBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CentralBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for CentralBody

fn eq(&self, other: &CentralBody) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for CentralBody

impl StructuralPartialEq for CentralBody