Struct nyx_space::dynamics::spacecraft::BaseSpacecraftDynamics

pub struct BaseSpacecraftDynamics<'a, X: SpacecraftExt> {
    pub orbital_dyn: OrbitalDynamics<'a>,
    pub force_models: Vec<Arc<dyn ForceModel<X> + 'a>>,
    pub guid_law: Option<Arc<dyn GuidanceLaw<X> + 'a>>,
    pub decrement_mass: bool,
}

A generic spacecraft dynamics with associated force models, guidance law, and flag specifying whether to decrement the fuel mass or not. Note: when developing new guidance laws, it is recommended to not enable fuel decrement until the guidance law seems to work without proper physics. Note: if the spacecraft runs out of fuel, the propagation segment will return an error.

Fields

orbital_dyn: OrbitalDynamics<'a>

force_models: Vec<Arc<dyn ForceModel<X> + 'a>>

guid_law: Option<Arc<dyn GuidanceLaw<X> + 'a>>

decrement_mass: bool

Implementations

impl<'a, X: SpacecraftExt> BaseSpacecraftDynamics<'a, X>

pub fn from_guidance_law( orbital_dyn: OrbitalDynamics<'a>, guid_law: Arc<dyn GuidanceLaw<X> + 'a> ) -> Self

Initialize a Spacecraft with a set of orbital dynamics and a propulsion subsystem. By default, the mass of the vehicle will be decremented as propellant is consummed.

pub fn from_guidance_law_no_decr( orbital_dyn: OrbitalDynamics<'a>, guid_law: Arc<dyn GuidanceLaw<X> + 'a> ) -> Self

Initialize a Spacecraft with a set of orbital dynamics and a propulsion subsystem. Will not decrement the fuel mass as propellant is consummed.

pub fn new(orbital_dyn: OrbitalDynamics<'a>) -> Self

Initialize a Spacecraft with a set of orbital dynamics and with SRP enabled.

pub fn from_model( orbital_dyn: OrbitalDynamics<'a>, force_model: Arc<dyn ForceModel<X> + 'a> ) -> Self

Initialize new spacecraft dynamics with the provided orbital mechanics and with the provided force model.

pub fn from_models( orbital_dyn: OrbitalDynamics<'a>, force_models: Vec<Arc<dyn ForceModel<X> + 'a>> ) -> Self

Initialize new spacecraft dynamics with a vector of force models.

pub fn add_model(&mut self, force_model: Arc<dyn ForceModel<X> + 'a>)

Add a model to the currently defined spacecraft dynamics

pub fn with_model(self, force_model: Arc<dyn ForceModel<X> + 'a>) -> Self

Clone these dynamics and add a model to the currently defined orbital dynamics

pub fn guidance_achieved( &self, state: &BaseSpacecraft<X> ) -> Result<bool, NyxError>

A shortcut to spacecraft.guid_law if a guidance law is defined for these dynamics

pub fn with_guidance_law(&self, guid_law: Arc<dyn GuidanceLaw<X> + 'a>) -> Self

Clone these spacecraft dynamics and update the control to the one provided.

pub fn with_guidance_law_no_decr( &self, guid_law: Arc<dyn GuidanceLaw<X> + 'a> ) -> Self

Clone these spacecraft dynamics and update the control to the one provided.

pub fn without_guidance_law(&self) -> Self

Clone these spacecraft dynamics and remove any control model

Trait Implementations

impl<'a, X: Clone + SpacecraftExt> Clone for BaseSpacecraftDynamics<'a, X>

fn clone(&self) -> BaseSpacecraftDynamics<'a, X>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, X: SpacecraftExt> Display for BaseSpacecraftDynamics<'a, X>

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

Formats the value using the given formatter.

impl<'a, X: SpacecraftExt> Dynamics for BaseSpacecraftDynamics<'a, X>

type HyperdualSize = Const<9>

The state of the associated hyperdual state, almost always StateType + U1

type StateType = BaseSpacecraft<X>

fn finally( &self, next_state: Self::StateType ) -> Result<Self::StateType, NyxError>

Optionally performs some final changes after each successful integration of the equations of motion. For example, this can be used to update the Guidance mode. NOTE: This function is also called just prior to very first integration step in order to update the initial state if needed.

fn eom( &self, delta_t: f64, state: &OVector<f64, Const<90>>, ctx: &Self::StateType ) -> Result<OVector<f64, Const<90>>, NyxError>

Defines the equations of motion for these dynamics, or a combination of provided dynamics. The time delta_t is in seconds PAST the context epoch. The state vector is the state which changes for every intermediate step of the integration. The state context is the state of what is being propagated, it should allow rebuilding a new state context from the provided state vector.

fn dual_eom( &self, delta_t_s: f64, ctx: &Self::StateType ) -> Result<(OVector<f64, Const<9>>, OMatrix<f64, Const<9>, Const<9>>), NyxError>

Defines the equations of motion for Dual numbers for these dynamics. All dynamics need to allow for automatic differentiation. However, if differentiation is not supported, then the dynamics should prevent initialization with a context which has an STM defined.