Struct Environment

#[non_exhaustive]
#[repr(C)]
pub struct Environment {
    pub sound_speed: f32,
}

Available on crate features derive and environment only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sound_speed: f32

Implementations

impl Environment

pub fn new() -> Self

Creates a new environment with the default sound speed (340m/s).

pub fn set_sound_speed_from_temp(&mut self, t: f32)

Sets the sound speed of envs from the temperature.

This is equivalent to Self::set_sound_speed_from_temp_with(t, 1.4, 8.314_463, 28.9647e-3).

pub fn set_sound_speed_from_temp_with(&mut self, t: f32, k: f32, r: f32, m: f32)

Sets the sound speed of envs from the temperature t, heat capacity ratio k, gas constant r, and molar mass m [kg/mol].

pub const fn wavelength(&self) -> f32

Gets the wavelength of the ultrasound.

pub const fn wavenumber(&self) -> f32

Gets the wavenumber of the ultrasound.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl Default for Environment

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Environment

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Environment

impl StructuralPartialEq for Environment