Struct nyx_space::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,
}

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

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

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 enable_traj_stm(&mut self)

Sets the STM of this state of identity, which also enables computation of the STM for trajectory optimization

pub fn with_stm(self) -> Self

Copies the current state but sets the STM to identity

pub fn stm_identity(&mut self)

Sets the STM of this state of identity

pub fn stm(&self) -> Matrix6<f64>

Unwraps this STM, or panics if unset.

Trait Implementations

impl Add<Matrix<f64, U6, U1, <DefaultAllocator as Allocator<f64, U6, U1>>::Buffer>> for Spacecraft

fn add(self, other: VectorN<f64, U6>) -> Self

Adds the provided state deviation to this orbit

type Output = Self

The resulting type after applying the + operator.

impl Add<Matrix<f64, U7, U1, <DefaultAllocator as Allocator<f64, U7, U1>>::Buffer>> for Spacecraft

fn add(self, other: VectorN<f64, U7>) -> 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 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

fn add_dev(to: &Spacecraft, dev: VectorN<f64, Self::Size>) -> Spacecraft

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 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 ==.

#[must_use]

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

This method tests for !=.

impl State for Spacecraft

fn stm(&self) -> Result<MatrixN<f64, U7>, NyxError>

WARNING: Currently the STM assumes that the fuel mass is constant at ALL TIMES!

type Size = U7

Size of the state and its STM

type PropVecSize = U43

fn zeros() -> Self

Initialize an empty state

fn as_vector(&self) -> Result<VectorN<f64, U43>, NyxError>

Return this state as a vector for the propagation/estimation

fn set(
    &mut self,
    epoch: Epoch,
    vector: &VectorN<f64, U43>
) -> Result<(), NyxError>

Set this state

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

fn ctor_from(
    self,
    delta_t_s: f64,
    vector: &VectorN<f64, Self::PropVecSize>
) -> Self where
    DefaultAllocator: Allocator<f64, Self::PropVecSize>, 

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

impl TimeTagged for Spacecraft

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 Spacecraft