Struct Time Step Control &nbsp; Copy item path

pub fn compute_cfl_dt(&self, max_velocity: f64, dx: f64) -> f64

Compute the CFL-limited time step: dt = CFL * dx / max_velocity.

The result is clamped to [min_time_step, max_time_step]. If max_velocity is zero or non-finite, max_time_step is returned (no advective limit).

pub fn compute_cfl_dt_from_field(&self, dx: f64) -> f64

Compute the CFL-limited time step using the velocity field (or sound speed fallback) stored on the CflCondition.

This is the field-driven overload of compute_cfl_dt: it derives max_velocity from CflCondition::max_velocity() instead of requiring it as a parameter. When neither a velocity field nor a sound speed is set, max_velocity() returns 0.0 and max_time_step is returned.

pub fn compute_diffusion_dt(&self, diffusion_coeff: f64, dx: f64) -> f64

Compute the diffusive CFL-limited time step: dt_diff = CFL * dx^2 / (2 * diffusion_coeff).

The result is clamped to [min_time_step, max_time_step]. Returns 0.0 for a zero (or non-finite) diffusion coefficient, clamped to the minimum bound so callers always receive a usable dt.

pub fn compute_combined_dt( &self, max_velocity: f64, diffusion_coeff: f64, dx: f64, ) -> f64

Compute the combined advective + diffusive CFL limit and return the most restrictive (minimum) of the two, clamped to [min_time_step, max_time_step].

pub fn update_dt(&mut self, max_velocity: f64, dx: f64) -> f64

Compute a new adaptive time step using the CFL condition, apply the safety factor and increase/decrease limits, update the internal current_time_step, and return the new dt.

Auto Trait Implementations§

impl Freeze for TimeStepControl

impl RefUnwindSafe for TimeStepControl

impl Send for TimeStepControl

impl Sync for TimeStepControl

impl Unpin for TimeStepControl

impl UnsafeUnpin for TimeStepControl

impl UnwindSafe for TimeStepControl

Blanket Implementations§

impl<S, A> Aggregate<Result<S, Error>> for A
where A: Aggregate<S>,

fn from_shares<T>(iter: T) -> Result<A, Error>
where T: IntoIterator<Item = Result<S, Error>>,

Aggregate shares in an MPC protocol.

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

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

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