Enum ExitReason

Source

pub enum ExitReason {
    TimeLimitReached,
    SteadyState,
    EnergyDrift,
    MassLoss,
    CasimirDrift,
    CflViolation,
    WallClockLimit,
    FirstCausticFormed,
    VirialRelaxed,
    UserDefined,
}

Expand description

Reason why the simulation terminated.

Variants§

§

TimeLimitReached

Reached user-specified t_final.

§

SteadyState

‖∂f/∂t‖ < ε_steady: distribution function has stopped evolving.

§

EnergyDrift

|E(t)−E(0)|/|E(0)| > ε_energy: energy conservation violated.

§

MassLoss

M(t)/M(0) < ε_mass: too much mass has left the domain.

§

CasimirDrift

|C₂(t)−C₂(0)|/C₂(0) > ε_casimir: numerical diffusion detected.

§

CflViolation

Adaptive Δt has dropped below Δt_min.

§

WallClockLimit

Wall-clock runtime exceeded limit.

§

FirstCausticFormed

First caustic formed: max stream count exceeded 1.

§

VirialRelaxed

Virial ratio stabilised at 1.0 ± ε: violent relaxation complete.

§

UserDefined

User-defined predicate returned true.

Trait Implementations§

Source §

impl Clone for ExitReason

Source §

fn clone(&self) -> ExitReason

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for ExitReason

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ExitReason

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> ByRef<T> for T

Source §

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source §

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

impl<T> Instrument for T

Source §

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Source §

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into 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> IntoEither for T

Source §

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 more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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

Source §