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,
    // mean anomaly at epoch, and gravitational parameter

    // 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, ) -> Self

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.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let eccentricity = 0.2;
let periapsis = 2.8;
let inclination = 1.0;
let argument_of_periapsis = 0.7;
let longitude_of_ascending_node = 4.5;
let mean_anomaly_at_epoch = 2.9;
let gravitational_parameter = 9.2;

let orbit = Orbit::new(
    eccentricity,
    periapsis,
    inclination,
    argument_of_periapsis,
    longitude_of_ascending_node,
    mean_anomaly_at_epoch,
    gravitational_parameter
);

assert_eq!(orbit.get_eccentricity(), eccentricity);
assert_eq!(orbit.get_periapsis(), periapsis);
assert_eq!(orbit.get_inclination(), inclination);
assert_eq!(orbit.get_arg_pe(), argument_of_periapsis);
assert_eq!(orbit.get_long_asc_node(), longitude_of_ascending_node);
assert_eq!(orbit.get_mean_anomaly_at_epoch(), mean_anomaly_at_epoch);
assert_eq!(orbit.get_gravitational_parameter(), gravitational_parameter);

Source

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

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 at epoch, in radians.
mu: The gravitational parameter of the parent body, in m^3 s^-2.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let apoapsis = 4.1;
let periapsis = 2.8;
let inclination = 1.0;
let argument_of_periapsis = 0.7;
let longitude_of_ascending_node = 4.5;
let mean_anomaly_at_epoch = 2.9;
let gravitational_parameter = 9.2;

let orbit = Orbit::with_apoapsis(
    apoapsis,
    periapsis,
    inclination,
    argument_of_periapsis,
    longitude_of_ascending_node,
    mean_anomaly_at_epoch,
    gravitational_parameter
);

let eccentricity = (apoapsis - periapsis) / (apoapsis + periapsis);

assert_eq!(orbit.get_eccentricity(), eccentricity);
assert_eq!(orbit.get_periapsis(), periapsis);
assert_eq!(orbit.get_inclination(), inclination);
assert_eq!(orbit.get_arg_pe(), argument_of_periapsis);
assert_eq!(orbit.get_long_asc_node(), longitude_of_ascending_node);
assert_eq!(orbit.get_mean_anomaly_at_epoch(), mean_anomaly_at_epoch);
assert_eq!(orbit.get_gravitational_parameter(), gravitational_parameter);

Source

pub fn new_circular( radius: f64, inclination: f64, long_asc_node: f64, mean_anomaly: f64, mu: f64, ) -> Self

Creates a new circular Orbit instance with the given parameters.

§Parameters

radius: The radius 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.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let radius = 4.2;
let inclination = 1.8;
let longitude_of_ascending_node = 3.1;
let mean_anomaly_at_epoch = 1.5;
let gravitational_parameter = 5.0;

let orbit = Orbit::new_circular(
    radius,
    inclination,
    longitude_of_ascending_node,
    mean_anomaly_at_epoch,
    gravitational_parameter,
);

assert_eq!(orbit.get_eccentricity(), 0.0);
assert_eq!(orbit.get_periapsis(), radius);
assert_eq!(orbit.get_inclination(), inclination);
assert_eq!(orbit.get_arg_pe(), 0.0);
assert_eq!(orbit.get_long_asc_node(), longitude_of_ascending_node);
assert_eq!(orbit.get_mean_anomaly_at_epoch(), mean_anomaly_at_epoch);
assert_eq!(orbit.get_gravitational_parameter(), gravitational_parameter);

Source

pub fn new_flat( eccentricity: f64, periapsis: f64, arg_pe: f64, mean_anomaly: f64, mu: f64, ) -> Self

Creates a new Orbit instance parallel to the XY plane with the given parameters.

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

§Parameters

eccentricity: The eccentricity of the orbit.
periapsis: The periapsis of the orbit, in meters.
arg_pe: The argument of periapsis 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.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let eccentricity = 2.0;
let periapsis = 8.0;
let argument_of_periapsis = 2.1;
let mean_anomaly_at_epoch = 9.8;
let gravitational_parameter = 5.0;

let orbit = Orbit::new_flat(
    eccentricity,
    periapsis,
    argument_of_periapsis,
    mean_anomaly_at_epoch,
    gravitational_parameter,
);

assert_eq!(orbit.get_eccentricity(), eccentricity);
assert_eq!(orbit.get_periapsis(), periapsis);
assert_eq!(orbit.get_inclination(), 0.0);
assert_eq!(orbit.get_arg_pe(), argument_of_periapsis);
assert_eq!(orbit.get_long_asc_node(), 0.0);
assert_eq!(orbit.get_mean_anomaly_at_epoch(), mean_anomaly_at_epoch);
assert_eq!(orbit.get_gravitational_parameter(), gravitational_parameter);

Source

pub fn new_flat_with_apoapsis( apoapsis: f64, periapsis: f64, arg_pe: f64, mean_anomaly: f64, mu: f64, ) -> Self

Creates a new Orbit instance parallel to the XY plane with the given parameters.

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

§Parameters

apoapsis: The apoapsis of the orbit, in meters.
periapsis: The periapsis of the orbit, in meters.
arg_pe: The argument of periapsis 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.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let apoapsis = 10.1;
let periapsis = 8.0;
let argument_of_periapsis = 2.1;
let mean_anomaly_at_epoch = 9.8;
let gravitational_parameter = 5.0;

let orbit = Orbit::new_flat_with_apoapsis(
    apoapsis,
    periapsis,
    argument_of_periapsis,
    mean_anomaly_at_epoch,
    gravitational_parameter,
);

let eccentricity = (apoapsis - periapsis) / (apoapsis + periapsis);

assert_eq!(orbit.get_eccentricity(), eccentricity);
assert_eq!(orbit.get_periapsis(), periapsis);
assert_eq!(orbit.get_inclination(), 0.0);
assert_eq!(orbit.get_arg_pe(), argument_of_periapsis);
assert_eq!(orbit.get_long_asc_node(), 0.0);
assert_eq!(orbit.get_mean_anomaly_at_epoch(), mean_anomaly_at_epoch);
assert_eq!(orbit.get_gravitational_parameter(), gravitational_parameter);

Source

pub fn new_flat_circular(radius: f64, mean_anomaly: f64, mu: f64) -> Self

Creates a new circular Orbit instance parallel to the XY plane with the given parameters.

§Parameters

radius: The radius of the orbit, in meters.
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.

§Example

use keplerian_sim::{Orbit, OrbitTrait};

let radius = 90.0;
let mean_anomaly_at_epoch = 0.5;
let gravitational_parameter = 6.0;

let orbit = Orbit::new_flat_circular(
    radius,
    mean_anomaly_at_epoch,
    gravitational_parameter
);

assert_eq!(orbit.get_eccentricity(), 0.0);
assert_eq!(orbit.get_periapsis(), radius);
assert_eq!(orbit.get_inclination(), 0.0);
assert_eq!(orbit.get_arg_pe(), 0.0);
assert_eq!(orbit.get_long_asc_node(), 0.0);
assert_eq!(orbit.get_mean_anomaly_at_epoch(), mean_anomaly_at_epoch);
assert_eq!(orbit.get_gravitational_parameter(), gravitational_parameter);

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() -> Self

Creates a unit orbit.

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

It also uses a gravitational parameter of 1.

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.\ 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 §