Enum StopReason 

#[non_exhaustive]
pub enum StopReason {
    EnergyDecay {
        ratio_db: f64,
    },
    MaxTimesteps,
    Aborted,
    Diverged,
}

Why Engine::run_until stopped.

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.

EnergyDecay

The excitation was over and W/W_max fell below the threshold; ratio_db = 10·log10(W/W_max) at the deciding check (-∞ if W ≤ 0).

Fields

ratio_db: f64

Energy ratio at the deciding check [dB].

MaxTimesteps

max_timesteps steps were run.

Aborted

The progress callback returned ControlFlow::Break.

Diverged

The energy became NaN or infinite (unstable setup, e.g. an operator that adds energy without bound).

Trait Implementations

impl Clone for StopReason

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StopReason

impl Debug for StopReason

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

Formats the value using the given formatter.

impl PartialEq for StopReason

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StopReason