Struct Orbit

Source

pub struct Orbit { /* private fields */ }

Expand description

A struct representing a Keplerian orbit with some cached values.

This struct consumes significantly more memory because of the cache.
However, this will speed up orbital calculations.
If memory efficiency is your goal, you may consider using the CompactOrbit struct instead.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let orbit = Orbit::new(
    // Initialize using eccentricity, periapsis, inclination,
    // argument of periapsis, longitude of ascending node,
    // and mean anomaly at epoch

    // Eccentricity
    0.0,

    // Periapsis
    1.0,

    // Inclination
    0.0,

    // Argument of periapsis
    0.0,

    // Longitude of ascending node
    0.0,

    // Mean anomaly at epoch
    0.0,

    // Gravitational parameter of the parent body
    1.0,
);

let orbit = Orbit::with_apoapsis(
    // Initialize using apoapsis in place of eccentricity
     
    // Apoapsis
    2.0,

    // Periapsis
    1.0,

    // Inclination
    0.0,

    // Argument of periapsis
    0.0,

    // Longitude of ascending node
    0.0,

    // Mean anomaly at epoch
    0.0,

    // Gravitational parameter of the parent body
    1.0,
);

See Orbit::new and Orbit::with_apoapsis for more information.

Implementations§

Source §

impl Orbit

Source

pub fn new( eccentricity: f64, periapsis: f64, inclination: f64, arg_pe: f64, long_asc_node: f64, mean_anomaly: f64, mu: f64, ) -> Orbit

Creates a new orbit with the given parameters.

Note: This function uses eccentricity instead of apoapsis.
If you want to provide an apoapsis instead, consider using the Orbit::with_apoapsis function instead.

§Parameters

eccentricity: The eccentricity of the orbit.
periapsis: The periapsis of the orbit, in meters.
inclination: The inclination of the orbit, in radians.
arg_pe: The argument of periapsis of the orbit, in radians.
long_asc_node: The longitude of ascending node of the orbit, in radians.
mean_anomaly: The mean anomaly of the orbit at epoch, in radians.
mu: The gravitational parameter of the parent body, in m^3 s^-2.

Source

pub fn with_apoapsis( apoapsis: f64, periapsis: f64, inclination: f64, arg_pe: f64, long_asc_node: f64, mean_anomaly: f64, mu: f64, ) -> Orbit

Creates a new orbit with the given parameters.

Note: This function uses apoapsis instead of eccentricity.
Because of this, it’s not recommended to initialize parabolic or hyperbolic ‘orbits’ with this function.
If you’re looking to initialize a parabolic or hyperbolic trajectory, consider using the Orbit::new function instead.

§Parameters

apoapsis: The apoapsis of the orbit, in meters.
periapsis: The periapsis of the orbit, in meters.
inclination: The inclination of the orbit, in radians.
arg_pe: The argument of periapsis of the orbit, in radians.
long_asc_node: The longitude of ascending node of the orbit, in radians.
mean_anomaly: The mean anomaly of the orbit, in radians.
mu: The gravitational parameter of the parent body, in m^3 s^-2.

Trait Implementations§

Source §

impl Clone for Orbit

Source §

fn clone(&self) -> Orbit

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Orbit

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Orbit

Source §

fn default() -> Orbit

Creates a unit orbit.

The unit orbit is a perfect circle of radius 1 and no “tilt”.

Source §

impl From<CompactOrbit> for Orbit

Source §

fn from(compact: CompactOrbit) -> Self

Converts to this type from the input type.

Source §

impl From<Orbit> for CompactOrbit

Source §

fn from(cached: Orbit) -> Self

Converts to this type from the input type.

Source §

impl OrbitTrait for Orbit

Source §

fn set_apoapsis(&mut self, apoapsis: f64) -> Result<(), ApoapsisSetterError>

Sets the apoapsis of the orbit.
Errors when the apoapsis is less than the periapsis, or less than zero.
If you want a setter that does not error, use set_apoapsis_force, which will try its best to interpret what you might have meant, but may have undesirable behavior. Read more

Source §

fn set_apoapsis_force(&mut self, apoapsis: f64)

Sets the apoapsis of the orbit, with a best-effort attempt at interpreting possibly-invalid values.
This function will not error, but may have undesirable behavior: Read more

Source §