Skip to main content

HeightOffset

Struct HeightOffset 

Source
pub struct HeightOffset<F> { /* private fields */ }
Expand description

Reads a field at a shifted height, so a field and its caller can use different height datums: wind(t, p) is the inner field’s wind at p.y + offset_m, with time and the horizontal position unchanged.

offset_m is the height of the caller’s y = 0 in the field’s datum. Convert in one place only: wrapping twice, or also shifting a profile’s levels, moves every wind by the offset again. The usual cases:

  • y is height above sea level, as in rockets-engine: a LogProfile or EkmanProfile, which measure height from the ground, takes - the ground elevation. A sounding ProfileField in metres above sea level needs no wrapper there.
  • y = 0 is the ground at elevation E: a sea-level sounding ProfileField takes +E.
  • this crate’s TrajectorySolver, whose y = 0 is the level muzzle_height is measured from and whose ground runs along the line of sight: its ground_threshold check and its built-in boundary-layer shear (see crate::wind_shear) both take the shot-frame y as the height. So a LogProfile or EkmanProfile takes the bore’s real height above the ground minus muzzle_height on a level or an inclined shot alike: 0 when muzzle_height is that real height, the real height when muzzle_height is left at 0, as BallisticInputs::default() leaves it. Sea level stays level, so a sea-level sounding takes + the AtmosphericConditions::altitude on a level shot, where the solver’s own air puts y = 0. On an inclined shot (shooting angle θ) no constant offset fits: read the sounding at the altitude the solver’s air uses, altitude + x·sin θ + y·cos θ. Fields return winds in level axes; rotate them into the shot frame before comparing them with solver output.

Elevations are those of the place the positions are, not of the station that measured a sounding.

Implementations§

Source§

impl<F> HeightOffset<F>

Source

pub fn new(field: F, offset_m: f64) -> Result<HeightOffset<F>, WindFieldError>

Wrap field so it is read offset_m metres higher. The offset must be finite.

Source

pub fn field(&self) -> &F

The wrapped field.

Source

pub fn offset_m(&self) -> f64

The height added to every query, metres.

Source

pub fn into_inner(self) -> F

Unwrap the field.

Trait Implementations§

Source§

impl<F> Clone for HeightOffset<F>
where F: Clone,

Source§

fn clone(&self) -> HeightOffset<F>

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<F> Copy for HeightOffset<F>
where F: Copy,

Source§

impl<F> Debug for HeightOffset<F>
where F: Debug,

Source§

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

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

impl<F> PartialEq for HeightOffset<F>
where F: PartialEq,

Source§

fn eq(&self, other: &HeightOffset<F>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<F> StructuralPartialEq for HeightOffset<F>
where F: PartialEq,

Source§

impl<F> WindField for HeightOffset<F>
where F: WindField,

Source§

fn wind( &self, time_s: f64, position_m: Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>, ) -> Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>

World-frame air velocity (m/s) at a time and position.

Auto Trait Implementations§

§

impl<F> Freeze for HeightOffset<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for HeightOffset<F>
where F: RefUnwindSafe,

§

impl<F> Send for HeightOffset<F>
where F: Send,

§

impl<F> Sync for HeightOffset<F>
where F: Sync,

§

impl<F> Unpin for HeightOffset<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for HeightOffset<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for HeightOffset<F>
where F: 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<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> 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 = !

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