Skip to main content

CflCondition

Struct CflCondition 

Source
pub struct CflCondition {
    pub dx: f64,
    pub dt: f64,
    pub speed: f64,
    pub diffusivity: f64,
}
Expand description

Stability criterion checker for explicit finite-difference schemes.

The Courant–Friedrichs–Lewy (CFL) number must satisfy ν ≤ 1 (advection) or α ≤ 0.5 (diffusion) for stability of explicit schemes.

Fields§

§dx: f64

Grid spacing Δx.

§dt: f64

Time step Δt.

§speed: f64

Wave / advection speed (m/s).

§diffusivity: f64

Diffusion coefficient (m²/s).

Implementations§

Source§

impl CflCondition

Source

pub fn new(dx: f64, dt: f64, speed: f64, diffusivity: f64) -> Self

Construct a new CflCondition.

Source

pub fn advective_cfl(&self) -> f64

Advective CFL number c·Δt/Δx. Must be ≤ 1 for explicit upwind/leapfrog.

Source

pub fn diffusive_cfl(&self) -> f64

Diffusive CFL number α·Δt/Δx². Must be ≤ 0.5 for explicit FTCS.

Source

pub fn is_advection_stable(&self) -> bool

Returns true if the advective CFL condition is satisfied (≤ 1).

Source

pub fn is_diffusion_stable(&self) -> bool

Returns true if the diffusive CFL condition is satisfied (≤ 0.5).

Trait Implementations§

Source§

impl Clone for CflCondition

Source§

fn clone(&self) -> CflCondition

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CflCondition

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.