Struct nyx_space::dynamics::spacecraft::BaseSpacecraft

pub struct BaseSpacecraft<X: SpacecraftExt> {
    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 stm: Option<OMatrix<f64, Const<9>, Const<9>>>,
    pub ext: X,
}

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>

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)

ext: X

Any extra information or extension that is needed for specific guidance laws

Implementations

impl<X: SpacecraftExt> BaseSpacecraft<X>

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_thruster( orbit: Orbit, dry_mass_kg: f64, fuel_mass_kg: f64, thruster: Thruster, ext: X ) -> Self

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

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 with_dv(self, dv: Vector3<f64>) -> Self

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

pub fn degrade_to_spacecraft(&self) -> Spacecraft

Allows the automatic conversion of a BaseSpacecraft into a standard spacecraft. WARNING: This will IGNORE the extra of BaseSpacecraft

impl BaseSpacecraft<GuidanceMode>

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

Returns a copy of the state with the provided guidance mode

pub fn mode(&self) -> GuidanceMode

pub fn mut_mode(&mut self, mode: GuidanceMode)

Trait Implementations

impl<X: SpacecraftExt> Add<Matrix<f64, Const<6>, Const<1>, <DefaultAllocator as Allocator<f64, Const<6>, Const<1>>>::Buffer>> for BaseSpacecraft<X>

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

Adds the provided state deviation to this orbit

type Output = BaseSpacecraft<X>

The resulting type after applying the + operator.

impl<X: SpacecraftExt> Add<Matrix<f64, Const<9>, Const<1>, <DefaultAllocator as Allocator<f64, Const<9>, Const<1>>>::Buffer>> for BaseSpacecraft<X>

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

Adds the provided state deviation to this orbit

type Output = BaseSpacecraft<X>

The resulting type after applying the + operator.

impl<X: Clone + SpacecraftExt> Clone for BaseSpacecraft<X>

fn clone(&self) -> BaseSpacecraft<X>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<X: Debug + SpacecraftExt> Debug for BaseSpacecraft<X>

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

Formats the value using the given formatter.

impl<X: SpacecraftExt> Default for BaseSpacecraft<X>

fn default() -> Self

Returns the “default value” for a type.

impl<X: SpacecraftExt> Display for BaseSpacecraft<X>

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

Formats the value using the given formatter.

impl EstimateFrom<BaseSpacecraft<GuidanceMode>> for Orbit

fn extract(from: Spacecraft) -> Self

From the state extract the state to be estimated

impl EstimateFrom<BaseSpacecraft<GuidanceMode>> for Spacecraft

fn extract(from: Spacecraft) -> Self

From the state extract the state to be estimated

impl EventEvaluator<BaseSpacecraft<GuidanceMode>> 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 EventEvaluator<BaseSpacecraft<GuidanceMode>> 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<BaseSpacecraft<GuidanceMode>> 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<X: SpacecraftExt> LowerExp for BaseSpacecraft<X>

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

Formats the value using the given formatter.

impl<X: SpacecraftExt> LowerHex for BaseSpacecraft<X>

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

Formats the value using the given formatter.

impl MdHdlr<BaseSpacecraft<GuidanceMode>> for OrbitStateOutput

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

impl MeasurementDevice<BaseSpacecraft<GuidanceMode>, StdMeasurement> for GroundStation

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

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

impl<X: SpacecraftExt> PartialEq<BaseSpacecraft<X>> for BaseSpacecraft<X>

fn eq(&self, other: &Self) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<X: SpacecraftExt> State for BaseSpacecraft<X>

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 value(&self, param: &StateParameter) -> Result<f64, NyxError>

Return the value of the parameter, returns an error by default

fn set_value(&mut self, param: &StateParameter, val: f64) -> Result<(), NyxError>

Allows setting the value of the given parameter. NOTE: Most parameters where the value is available CANNOT be also set for that parameter (it’s a much harder problem!)

impl<X: SpacecraftExt> UpperExp for BaseSpacecraft<X>

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

Formats the value using the given formatter.

impl<X: SpacecraftExt> UpperHex for BaseSpacecraft<X>

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

Formats the value using the given formatter.

impl<X: Copy + SpacecraftExt> Copy for BaseSpacecraft<X>