Struct CentralBody

Source

pub struct CentralBody<R>where
    R: Real + Div<Output = R>,{
    pub gm: R,
    pub equatorial_radius_m: R,
    pub j2: R,
}

Expand description

Parameters describing a central gravitating body for weak-field GM recovery.

J2 (the dimensionless quadrupole moment) is only meaningful relative to a reference equatorial radius — the two travel together by construction, so they live in a single struct rather than scattered top-level constants.

gm is included for forward modeling and reference, even though solve_gm_analytical_kernel is what solves for this value.

Fields§

§gm: R

Body-centric gravitational parameter (m³/s²).

§equatorial_radius_m: R

Equatorial reference radius (m) — the radius J2 is referenced to.

§j2: R

Dimensionless J2 oblateness coefficient.

Implementations§

Source §

impl CentralBody<f64>

Source

pub const EARTH_JGM3: CentralBody<f64>

Earth, JGM-3 J2 with WGS-84 equatorial radius.

Source §

impl<R> CentralBody<R>
where R: Real + Div<Output = R>,

Source

pub fn new(gm: R, equatorial_radius_m: R, j2: R) -> CentralBody<R>

Trait Implementations§

Source §

impl<R> Clone for CentralBody<R>
where R: Clone + Real + Div<Output = R>,

Source §

fn clone(&self) -> CentralBody<R>

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<R> Copy for CentralBody<R>
where R: Copy + Real + Div<Output = R>,

Source §

impl<R> Debug for CentralBody<R>
where R: Debug + Real + Div<Output = R>,

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<R> PartialEq for CentralBody<R>
where R: PartialEq + Real + Div<Output = R>,

Source §

fn eq(&self, other: &CentralBody<R>) -> bool

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

Source §

impl<R> StructuralPartialEq for CentralBody<R>
where R: PartialEq + Real + Div<Output = R>,

Auto Trait Implementations§

§

impl<R> UnwindSafe for CentralBody<R>
where R: UnwindSafe,

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 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> MaybeParallel for T
where T: Send + Sync + ?Sized,

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> 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 for T
where U: Into<T>,

Source §

type Error = !

The type returned in the event of a conversion error.

Source §

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

Source §

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

Source §

type Error = >::Error

The type returned in the event of a conversion error.

Source §

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

Performs the conversion.

Struct CentralBody Copy item path

Fields§

Implementations§

impl CentralBody<f64>

pub const EARTH_JGM3: CentralBody<f64>

impl<R> CentralBody<R>where R: Real + Div<Output = R>,

pub fn new(gm: R, equatorial_radius_m: R, j2: R) -> CentralBody<R>

Trait Implementations§

impl<R> Clone for CentralBody<R>where R: Clone + Real + Div<Output = R>,

fn clone(&self) -> CentralBody<R>

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

impl<R> Copy for CentralBody<R>where R: Copy + Real + Div<Output = R>,

impl<R> Debug for CentralBody<R>where R: Debug + Real + Div<Output = R>,

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

impl<R> PartialEq for CentralBody<R>where R: PartialEq + Real + Div<Output = R>,

fn eq(&self, other: &CentralBody<R>) -> bool

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

impl<R> StructuralPartialEq for CentralBody<R>where R: PartialEq + Real + Div<Output = R>,

Auto Trait Implementations§

impl<R> Freeze for CentralBody<R>where R: Freeze,

impl<R> RefUnwindSafe for CentralBody<R>where R: RefUnwindSafe,

impl<R> Send for CentralBody<R>where R: Send,

impl<R> Sync for CentralBody<R>where R: Sync,

impl<R> Unpin for CentralBody<R>where R: Unpin,

impl<R> UnsafeUnpin for CentralBody<R>where R: UnsafeUnpin,

impl<R> UnwindSafe for CentralBody<R>where R: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> IntoEither for T

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

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

impl<T> MaybeParallel for Twhere T: Send + Sync + ?Sized,

impl<T> Pointable for T

const ALIGN: usize

type Init = T

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

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

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

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = !

fn try_from(value: U) -> Result<T, !>

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

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

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

Struct CentralBody

impl<R> CentralBody<R>
where R: Real + Div<Output = R>,

impl<R> Clone for CentralBody<R>
where R: Clone + Real + Div<Output = R>,

impl<R> Copy for CentralBody<R>
where R: Copy + Real + Div<Output = R>,

impl<R> Debug for CentralBody<R>
where R: Debug + Real + Div<Output = R>,

impl<R> PartialEq for CentralBody<R>
where R: PartialEq + Real + Div<Output = R>,

impl<R> StructuralPartialEq for CentralBody<R>
where R: PartialEq + Real + Div<Output = R>,

impl<R> Freeze for CentralBody<R>
where R: Freeze,

impl<R> RefUnwindSafe for CentralBody<R>
where R: RefUnwindSafe,

impl<R> Send for CentralBody<R>
where R: Send,

impl<R> Sync for CentralBody<R>
where R: Sync,

impl<R> Unpin for CentralBody<R>
where R: Unpin,

impl<R> UnsafeUnpin for CentralBody<R>
where R: UnsafeUnpin,

impl<R> UnwindSafe for CentralBody<R>
where R: UnwindSafe,

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

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

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

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

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

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

impl<T> MaybeParallel for T
where T: Send + Sync + ?Sized,

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

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

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