Struct nyx_space::celestia::OrbitDual

pub struct OrbitDual {
    pub x: Hyperdual<f64, U7>,
    pub y: Hyperdual<f64, U7>,
    pub z: Hyperdual<f64, U7>,
    pub vx: Hyperdual<f64, U7>,
    pub vy: Hyperdual<f64, U7>,
    pub vz: Hyperdual<f64, U7>,
    pub dt: Epoch,
    pub frame: Frame,
}

Orbit defines an orbital state

Unless noted otherwise, algorithms are from GMAT 2016a StateConversionUtil.cpp. Regardless of the constructor used, this struct stores all the state information in Cartesian coordinates as these are always non singular. Note: although not yet supported, this struct may change once True of Date or other nutation frames are added to the toolkit.

Fields

x: Hyperdual<f64, U7>

in km

y: Hyperdual<f64, U7>

in km

z: Hyperdual<f64, U7>

in km

vx: Hyperdual<f64, U7>

in km/s

vy: Hyperdual<f64, U7>

in km/s

vz: Hyperdual<f64, U7>

in km/s

dt: Epoch

frame: Frame

Frame contains everything we need to compute state information

Implementations

impl OrbitDual

pub fn partial_for(
    &self,
    param: &StateParameter
) -> Result<OrbitPartial, NyxError>

pub fn rmag(&self) -> OrbitPartial

Returns the magnitude of the radius vector in km

pub fn vmag(&self) -> OrbitPartial

Returns the magnitude of the velocity vector in km/s

pub fn hx(&self) -> OrbitPartial

Returns the orbital momentum value on the X axis

pub fn hy(&self) -> OrbitPartial

Returns the orbital momentum value on the Y axis

pub fn hz(&self) -> OrbitPartial

Returns the orbital momentum value on the Z axis

pub fn hmag(&self) -> OrbitPartial

Returns the norm of the orbital momentum

pub fn energy(&self) -> OrbitPartial

Returns the specific mechanical energy

pub fn sma(&self) -> OrbitPartial

Returns the semi-major axis in km

pub fn ecc(&self) -> OrbitPartial

Returns the eccentricity (no unit)

pub fn inc(&self) -> OrbitPartial

Returns the inclination in degrees

pub fn aop(&self) -> OrbitPartial

Returns the argument of periapsis in degrees

pub fn raan(&self) -> OrbitPartial

Returns the right ascension of ther ascending node in degrees

pub fn ta(&self) -> OrbitPartial

Returns the true anomaly in degrees between 0 and 360.0

NOTE: This function will emit a warning stating that the TA should be avoided if in a very near circular orbit Code from https://github.com/ChristopherRabotin/GMAT/blob/80bde040e12946a61dae90d9fc3538f16df34190/src/gmatutil/util/StateConversionUtil.cpp#L6835

pub fn tlong(&self) -> OrbitPartial

Returns the true longitude in degrees

pub fn aol(&self) -> OrbitPartial

Returns the argument of latitude in degrees

NOTE: If the orbit is near circular, the AoL will be computed from the true longitude instead of relying on the ill-defined true anomaly.

pub fn periapsis(&self) -> OrbitPartial

Returns the radius of periapsis (or perigee around Earth), in kilometers.

pub fn apoapsis(&self) -> OrbitPartial

Returns the radius of apoapsis (or apogee around Earth), in kilometers.

pub fn ea(&self) -> OrbitPartial

Returns the eccentric anomaly in degrees

This is a conversion from GMAT’s StateConversionUtil::TrueToEccentricAnomaly

pub fn fpa(&self) -> OrbitPartial

Returns the flight path angle in degrees

pub fn ma(&self) -> OrbitPartial

Returns the mean anomaly in degrees

This is a conversion from GMAT’s StateConversionUtil::TrueToMeanAnomaly

pub fn semi_parameter(&self) -> OrbitPartial

Returns the semi parameter (or semilatus rectum)

pub fn geodetic_longitude(&self) -> OrbitPartial

Returns the geodetic longitude (λ) in degrees. Value is between 0 and 360 degrees.

Although the reference is not Vallado, the math from Vallado proves to be equivalent. Reference: G. Xu and Y. Xu, “GPS”, DOI 10.1007/978-3-662-50367-6_2, 2016

pub fn geodetic_latitude(&self) -> OrbitPartial

Returns the geodetic latitude (φ) in degrees. Value is between -180 and +180 degrees.

Reference: Vallado, 4th Ed., Algorithm 12 page 172.

pub fn geodetic_height(&self) -> OrbitPartial

Returns the geodetic height in km.

Reference: Vallado, 4th Ed., Algorithm 12 page 172.

pub fn right_ascension(&self) -> OrbitPartial

Returns the right ascension of this orbit in degrees

pub fn declination(&self) -> OrbitPartial

Returns the declination of this orbit in degrees

pub fn semi_minor_axis(&self) -> OrbitPartial

Returns the semi minor axis in km, includes code for a hyperbolic orbit

pub fn velocity_declination(&self) -> OrbitPartial

Returns the velocity declination of this orbit in degrees

pub fn c3(&self) -> OrbitPartial

Returns the $C_3$ of this orbit

pub fn hyperbolic_anomaly(&self) -> Result<OrbitPartial, NyxError>

Returns the hyperbolic anomaly in degrees between 0 and 360.0

Trait Implementations

impl Clone for OrbitDual

fn clone(&self) -> OrbitDual

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrbitDual

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

Formats the value using the given formatter.

impl From<Orbit> for OrbitDual

fn from(orbit: Orbit) -> Self

Initialize a new OrbitDual from an orbit, no other initializers

impl TimeTagged for OrbitDual

fn epoch(&self) -> Epoch

Retrieve the Epoch

fn set_epoch(&mut self, epoch: Epoch)

Set the Epoch

fn shift_by(&mut self, duration: Duration)

Shift this epoch by a duration (can be negative)

impl Copy for OrbitDual