Enum DopplerError 

#[non_exhaustive]
pub enum DopplerError {
    LengthMismatch {
        energies: usize,
        cross_sections: usize,
    },
    InvalidEnergy {
        index: usize,
        value: f64,
    },
    UnsortedEnergies {
        index: usize,
        previous: f64,
        current: f64,
    },
}

Errors from Doppler broadening computation (not parameter construction).

Marked #[non_exhaustive] because this enum is publicly exported from nereids-physics and may grow new validation variants over time (e.g. if future contracts add bounds on AWR/energy combinations). Without the attribute, adding a variant would be a SemVer-breaking change for any downstream crate that exhaustively matches on DopplerError.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

LengthMismatch

Energy and cross-section arrays have different lengths.

Fields

energies: usize

Number of energy points.

cross_sections: usize

Number of cross-section values.

InvalidEnergy

An energy value is non-finite (NaN/±∞) or non-positive (≤ 0).

The FGM velocity transform computes v = √E, so non-positive or non-finite energies produce NaN velocities that silently propagate through the convolution. Per-point guards in the convolution loop rely on v < FLOOR comparisons which evaluate to false for NaN (see “NaN bypasses guards” project convention), so the function would return wrong outputs rather than erroring. The contract is “every energy is finite and strictly positive.”

Fields

index: usize

Position in the energy array where the bad value was found.

value: f64

The offending energy value.

UnsortedEnergies

The energy grid is not strictly increasing at index.

doppler_broaden uses partition_point over the extended velocity grid (built from energies via v = √E), which has an unspecified return value on an unsorted slice and therefore would silently produce garbage indices in release builds. The contract is “energies are strictly ascending”; duplicate points are also rejected.

Fields

index: usize

Position where the strict-ascending invariant was first violated.

previous: f64

The previous (smaller-index) energy value.

current: f64

The current (larger-index) energy value that broke the invariant.

Trait Implementations

impl Debug for DopplerError

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

Formats the value using the given formatter.

impl Display for DopplerError

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

Formats the value using the given formatter.

impl Error for DopplerError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<DopplerError> for TransmissionError

fn from(e: DopplerError) -> Self

Converts to this type from the input type.