Skip to main content

ForceModelComponents

Struct ForceModelComponents 

Source
pub struct ForceModelComponents {
    pub two_body_mu_km3_s2: Option<f64>,
    pub zonal: Option<ZonalGravity>,
    pub spherical_harmonic: Option<SphericalHarmonicGravityConfig>,
    pub third_body: Option<ThirdBodyGravity>,
    pub solar_radiation_pressure: Option<SolarRadiationPressure>,
    pub earth_radiation_pressure: Option<EarthRadiationPressure>,
    pub relativity: Option<SchwarzschildRelativity>,
}
Expand description

Additive force components for ForceModelKind::Composite.

Fields§

§two_body_mu_km3_s2: Option<f64>

Optional central two-body gravitational parameter, km^3/s^2.

§zonal: Option<ZonalGravity>

Optional zonal gravity perturbation.

§spherical_harmonic: Option<SphericalHarmonicGravityConfig>

Optional embedded EGM96 spherical-harmonic perturbation.

§third_body: Option<ThirdBodyGravity>

Optional Sun and Moon third-body perturbation.

§solar_radiation_pressure: Option<SolarRadiationPressure>

Optional cannonball solar radiation pressure perturbation.

§earth_radiation_pressure: Option<EarthRadiationPressure>

Optional cannonball Earth albedo and infrared radiation pressure perturbation.

§relativity: Option<SchwarzschildRelativity>

Optional geocentric Schwarzschild relativistic correction.

Implementations§

Source§

impl ForceModelComponents

Source

pub const EMPTY: Self

No force components.

Source

pub fn earth_two_body() -> Self

Canonical Earth two-body central gravity.

Source

pub fn earth_phase_a( solar_radiation_pressure: Option<SolarRadiationPressure>, ) -> Self

Canonical Earth Phase A force set, with optional spacecraft SRP parameters.

Source

pub fn earth_phase_b( max_degree: u16, max_order: u16, solar_radiation_pressure: Option<SolarRadiationPressure>, ) -> Result<Self, PropagationError>

Canonical Earth Phase B force set with embedded EGM96 harmonics.

Source

pub fn with_two_body_mu(self, mu_km3_s2: f64) -> Self

Set or replace central two-body gravity.

Source

pub fn with_zonal(self, zonal: ZonalGravity) -> Self

Set or replace zonal gravity.

Source

pub fn with_spherical_harmonic( self, gravity: SphericalHarmonicGravityConfig, ) -> Self

Set or replace embedded EGM96 spherical-harmonic gravity.

Source

pub fn with_third_body(self, third_body: ThirdBodyGravity) -> Self

Set or replace third-body gravity.

Source

pub fn with_solar_radiation_pressure(self, srp: SolarRadiationPressure) -> Self

Set or replace solar radiation pressure.

Source

pub fn with_earth_radiation_pressure( self, pressure: EarthRadiationPressure, ) -> Self

Set or replace Earth albedo and infrared radiation pressure.

Source

pub fn with_relativity(self, relativity: SchwarzschildRelativity) -> Self

Set or replace relativity.

Trait Implementations§

Source§

impl Clone for ForceModelComponents

Source§

fn clone(&self) -> ForceModelComponents

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ForceModelComponents

Source§

impl Debug for ForceModelComponents

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ForceModelComponents

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for ForceModelComponents

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ForceModelComponents

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.