Struct nyx_space::cosmic::eclipse::Spacecraft

pub struct Spacecraft {
    pub orbit: Orbit,
    pub dry_mass_kg: f64,
    pub fuel_mass_kg: f64,
    pub srp_area_m2: f64,
    pub drag_area_m2: f64,
    pub cr: f64,
    pub cd: f64,
    pub thruster: Option<Thruster>,
    pub mode: GuidanceMode,
    pub stm: Option<OMatrix<f64, Const<9>, Const<9>>>,
}

A spacecraft state

Fields

orbit: Orbit

Initial orbit the vehicle is in

dry_mass_kg: f64

Dry mass, i.e. mass without fuel, in kg

fuel_mass_kg: f64

Fuel mass (if fuel mass is negative, thrusting will fail, unless configured to break laws of physics)

srp_area_m2: f64

in m^2

drag_area_m2: f64

in m^2

cr: f64

coefficient of reflectivity, must be between 0.0 (translucent) and 2.0 (all radiation absorbed and twice the force is transmitted back).

cd: f64

coefficient of drag; (spheres are between 2.0 and 2.1, use 2.2 in Earth’s atmosphere).

thruster: Option<Thruster>

mode: GuidanceMode

Guidance mode determines whether the thruster should fire or not

stm: Option<OMatrix<f64, Const<9>, Const<9>>>

Optionally stores the state transition matrix from the start of the propagation until the current time (i.e. trajectory STM, not step-size STM)

Implementations

impl Spacecraft

pub fn new(
    orbit: Orbit,
    dry_mass_kg: f64,
    fuel_mass_kg: f64,
    srp_area_m2: f64,
    drag_area_m2: f64,
    cr: f64,
    cd: f64
) -> Self

Initialize a spacecraft state from all of its parameters

pub fn from_srp_defaults(
    orbit: Orbit,
    dry_mass_kg: f64,
    srp_area_m2: f64
) -> Self

Initialize a spacecraft state from the SRP default 1.8 for coefficient of reflectivity (fuel mass and drag parameters nullified!)

pub fn from_drag_defaults(
    orbit: Orbit,
    dry_mass_kg: f64,
    drag_area_m2: f64
) -> Self

Initialize a spacecraft state from the SRP default 1.8 for coefficient of drag (fuel mass and SRP parameters nullified!)

pub fn from_thruster(
    orbit: Orbit,
    dry_mass_kg: f64,
    fuel_mass_kg: f64,
    thruster: Thruster,
    init_mode: GuidanceMode
) -> Self

Initialize a spacecraft state from only a thruster and mass. Use this when designing control laws whilke ignoring drag and SRP.

pub fn with_dry_mass(self, dry_mass_kg: f64) -> Self

Returns a copy of the state with a new dry mass

pub fn with_fuel_mass(self, fuel_mass_kg: f64) -> Self

Returns a copy of the state with a new fuel mass

pub fn with_srp(self, srp_area_m2: f64, cr: f64) -> Self

Returns a copy of the state with a new SRP area and CR

pub fn with_srp_area(self, srp_area_m2: f64) -> Self

Returns a copy of the state with a new SRP area

pub fn with_cr(self, cr: f64) -> Self

Returns a copy of the state with a new coefficient of reflectivity

pub fn with_drag(self, drag_area_m2: f64, cd: f64) -> Self

Returns a copy of the state with a new drag area and CD

pub fn with_drag_area(self, drag_area_m2: f64) -> Self

Returns a copy of the state with a new SRP area

pub fn with_cd(self, cd: f64) -> Self

Returns a copy of the state with a new coefficient of drag

pub fn with_orbit(self, orbit: Orbit) -> Self

Returns a copy of the state with a new orbit

pub fn with_guidance_mode(self, mode: GuidanceMode) -> Self

Returns a copy of the state with the provided guidance mode

pub fn rss(&self, other: &Self) -> (f64, f64, f64)

Returns the root sum square error between this spacecraft and the other, in kilometers for the position, kilometers per second in velocity, and kilograms in fuel

pub fn enable_stm(&mut self)

Sets the STM of this state of identity, which also enables computation of the STM for spacecraft navigation

pub fn with_stm(self) -> Self

Copies the current state but sets the STM to identity

pub fn mass_kg(&self) -> f64

Returns the total mass in kilograms

Trait Implementations

impl Add<Matrix<f64, Const<6_usize>, Const<1_usize>, <DefaultAllocator as Allocator<f64, Const<6_usize>, Const<1_usize>>>::Buffer>> for Spacecraft

fn add(self, other: OVector<f64, Const<6>>) -> Self

Adds the provided state deviation to this orbit

type Output = Self

The resulting type after applying the + operator.

impl Add<Matrix<f64, Const<9_usize>, Const<1_usize>, <DefaultAllocator as Allocator<f64, Const<9_usize>, Const<1_usize>>>::Buffer>> for Spacecraft

fn add(self, other: OVector<f64, Const<9>>) -> Self

Adds the provided state deviation to this orbit

type Output = Self

The resulting type after applying the + operator.

impl Clone for Spacecraft

fn clone(&self) -> Spacecraft

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spacecraft

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

Formats the value using the given formatter.

impl Default for Spacecraft

fn default() -> Self

Returns the “default value” for a type.

impl Display for Spacecraft

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

Formats the value using the given formatter.

impl EstimateFrom<Spacecraft> for Orbit

fn extract(from: Spacecraft) -> Self

From the state extract the state to be estimated

impl EstimateFrom<Spacecraft> for Spacecraft

fn extract(from: Spacecraft) -> Self

From the state extract the state to be estimated

impl EventEvaluator<Spacecraft> for UmbraEvent

fn epoch_precision(&self) -> Duration

Stop searching when the time has converged to less than 0.1 seconds

fn value_precision(&self) -> f64

Finds the darkest part of an eclipse within 2% of penumbra (i.e. 98% in shadow)

fn eval(&self, sc: &Spacecraft) -> f64

fn eval_crossing(&self, prev_state: &S, next_state: &S) -> bool

impl EventEvaluator<Spacecraft> for PenumbraEvent

fn epoch_precision(&self) -> Duration

Stop searching when the time has converged to less than 0.1 seconds

fn value_precision(&self) -> f64

Finds the slightest penumbra within 2%(i.e. 98% in visibility)

fn eval(&self, sc: &Spacecraft) -> f64

fn eval_crossing(&self, prev_state: &S, next_state: &S) -> bool

impl EventEvaluator<Spacecraft> for Event

fn eval(&self, state: &Spacecraft) -> f64

fn epoch_precision(&self) -> Duration

fn value_precision(&self) -> f64

fn eval_crossing(&self, prev_state: &S, next_state: &S) -> bool

impl InterpState for Spacecraft

fn params() -> Vec<StateParameter>

Return the parameters in order

fn value_and_deriv(
    &self,
    param: &StateParameter
) -> Result<(f64, f64), NyxError>

Return the requested parameter and its time derivative

fn set_value_and_deriv(
    &mut self,
    param: &StateParameter,
    value: f64,
    _: f64
) -> Result<(), NyxError>

Sets the requested parameter

fn value(&self, param: &StateParameter) -> Result<f64, NyxError>

Return the requested parameter

fn deriv(&self, param: &StateParameter) -> Result<f64, NyxError>

Return the time derivative requested parameter

impl LowerExp for Spacecraft

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

Formats the value using the given formatter.

impl LowerHex for Spacecraft

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

Formats the value using the given formatter.

impl MdHdlr<Spacecraft> for OrbitStateOutput

fn handle(&mut self, state: &Spacecraft)

impl MeasurementDevice<Spacecraft, StdMeasurement> for GroundStation

fn measure(&self, sc_rx: &Spacecraft) -> Option<StdMeasurement>

Perform a measurement from the ground station to the receiver (rx).

impl PartialEq<Spacecraft> for Spacecraft

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl State for Spacecraft

fn as_vector(&self) -> Result<OVector<f64, Const<90>>, NyxError>

The vector is organized as such: [X, Y, Z, Vx, Vy, Vz, Cr, Cd, Fuel mass, STM(9x9)]

fn set(
    &mut self,
    epoch: Epoch,
    vector: &OVector<f64, Const<90>>
) -> Result<(), NyxError>

Vector is expected to be organized as such: [X, Y, Z, Vx, Vy, Vz, Cr, Cd, Fuel mass, STM(9x9)]

fn stm(&self) -> Result<OMatrix<f64, Self::Size, Self::Size>, NyxError>

diag(STM) = [X,Y,Z,Vx,Vy,Vz,Cr,Cd,Fuel] WARNING: Currently the STM assumes that the fuel mass is constant at ALL TIMES!

type Size = Const<9>

Size of the state and its STM

type VecLength = Const<90>

fn reset_stm(&mut self)

Return this state as a vector for the propagation/estimation By default, this is not implemented. This function must be implemented when filtering on this state.

fn zeros() -> Self

Initialize an empty state By default, this is not implemented. This function must be implemented when filtering on this state.

fn epoch(&self) -> Epoch

Retrieve the Epoch

fn set_epoch(&mut self, epoch: Epoch)

Set the Epoch

fn add(self, other: OVector<f64, Self::Size>) -> Self

By default, this is not implemented. This function must be implemented when filtering on this state.

fn set_with_delta_seconds(
    self,
    delta_t_s: f64,
    vector: &OVector<f64, Self::VecLength>
) -> Self where
    DefaultAllocator: Allocator<f64, Self::VecLength>, 

Reconstruct a new State from the provided delta time in seconds compared to the current state and with the provided vector.

impl UpperExp for Spacecraft

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

Formats the value using the given formatter.

impl UpperHex for Spacecraft

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

Formats the value using the given formatter.

impl Copy for Spacecraft