Struct GravityBody 

pub struct GravityBody {
    pub mass: f64,
    pub radius: f64,
}

Mass and radius for a body used in gravity calculations.

Fields

mass: f64

radius: f64

Implementations

impl GravityBody

pub fn new(mass: f64, radius: f64) -> Option<Self>

Creates a gravity body from a mass and radius.

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

Examples found in repository

examples/basic_usage.rs (line 4)

fn main() -> Result<(), &'static str> {
    let earth = GravityBody::new(5.972e24, 6.371e6).ok_or("invalid Earth body")?;
    let surface_gravity = earth
        .surface_gravity()
        .ok_or("invalid surface gravity calculation")?;
    let force = gravitational_force(1.0, 1.0, 1.0).ok_or("invalid force calculation")?;
    let velocity = escape_velocity(5.972e24, 6.371e6).ok_or("invalid escape calculation")?;

    assert!((force - GRAVITATIONAL_CONSTANT).abs() < f64::EPSILON);
    assert!(surface_gravity > 9.8);
    assert!(velocity > 11_000.0);

    Ok(())
}

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

Computes the surface gravity of the body.

Examples

use use_gravity::GravityBody;

let earth = GravityBody::new(5.972e24, 6.371e6).unwrap();
let gravity = earth.surface_gravity().unwrap();

assert!((gravity - 9.82).abs() < 0.05);

Examples found in repository

examples/basic_usage.rs (line 6)

fn main() -> Result<(), &'static str> {
    let earth = GravityBody::new(5.972e24, 6.371e6).ok_or("invalid Earth body")?;
    let surface_gravity = earth
        .surface_gravity()
        .ok_or("invalid surface gravity calculation")?;
    let force = gravitational_force(1.0, 1.0, 1.0).ok_or("invalid force calculation")?;
    let velocity = escape_velocity(5.972e24, 6.371e6).ok_or("invalid escape calculation")?;

    assert!((force - GRAVITATIONAL_CONSTANT).abs() < f64::EPSILON);
    assert!(surface_gravity > 9.8);
    assert!(velocity > 11_000.0);

    Ok(())
}

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

Computes the escape velocity from the body’s surface.

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

Computes the circular orbital velocity at a given radius from the body’s center.

Trait Implementations

impl Clone for GravityBody

fn clone(&self) -> GravityBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GravityBody

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

Formats the value using the given formatter.

impl PartialEq for GravityBody

fn eq(&self, other: &GravityBody) -> 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 GravityBody

impl StructuralPartialEq for GravityBody