pub struct DopplerParams { /* private fields */ }Expand description
Doppler broadening parameters.
Implementations§
Source§impl DopplerParams
impl DopplerParams
Sourcepub fn new(temperature_k: f64, awr: f64) -> Result<Self, DopplerParamsError>
pub fn new(temperature_k: f64, awr: f64) -> Result<Self, DopplerParamsError>
Create validated Doppler parameters.
§Errors
Returns DopplerParamsError::InvalidAwr if awr <= 0.0 or is NaN.
Returns DopplerParamsError::NonFiniteTemperature if temperature_k
is NaN or infinity.
Returns DopplerParamsError::NegativeTemperature if temperature_k < 0.0.
Zero temperature is allowed — it means “no broadening”.
Sourcepub fn temperature_k(&self) -> f64
pub fn temperature_k(&self) -> f64
Returns the effective sample temperature in Kelvin.
Sourcepub fn u(&self) -> f64
pub fn u(&self) -> f64
Velocity-space Doppler width u = √(k_B·T / AWR).
This is the standard deviation of the Gaussian kernel in √eV units.
Sourcepub fn doppler_width(&self, energy_ev: f64) -> f64
pub fn doppler_width(&self, energy_ev: f64) -> f64
Energy-dependent Doppler width Δ_D(E) = √(4·k_B·T·E / AWR).
This is the width that SAMMY reports in the .lpt file.
Trait Implementations§
Source§impl Clone for DopplerParams
impl Clone for DopplerParams
Source§fn clone(&self) -> DopplerParams
fn clone(&self) -> DopplerParams
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for DopplerParams
impl Debug for DopplerParams
impl Copy for DopplerParams
Auto Trait Implementations§
impl Freeze for DopplerParams
impl RefUnwindSafe for DopplerParams
impl Send for DopplerParams
impl Sync for DopplerParams
impl Unpin for DopplerParams
impl UnwindSafe for DopplerParams
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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