Struct CflCondition 

pub struct CflCondition {
    pub cfl_number: f64,
    pub velocity_field: Option<Vec<f64>>,
    pub sound_speed: Option<f64>,
    pub diffusion_coefficient: Option<f64>,
}

CFL conditions

Fields

cfl_number: f64

velocity_field: Option<Vec<f64>>

sound_speed: Option<f64>

diffusion_coefficient: Option<f64>

Implementations

impl CflCondition

pub fn new() -> Self

pub fn set_velocity_field(&mut self, velocities: Vec<f64>)

Set the velocity field used for CFL advective time-step estimation.

pub fn set_sound_speed(&mut self, speed: f64)

Set the sound speed used as a fallback wave speed when no velocity field is populated.

pub fn set_diffusion_coefficient(&mut self, coeff: f64)

Set the diffusion coefficient used for the diffusive CFL limit.

pub fn max_velocity(&self) -> f64

Return the maximum absolute velocity from the velocity field.

Falls back to sound_speed when no velocity field is present, and to 0.0 when neither is set. Non-finite entries in the velocity field are ignored.

pub fn get_velocity_field(&self) -> Option<&Vec<f64>>

Accessor for the velocity field, if populated.

Trait Implementations

impl Clone for CflCondition

fn clone(&self) -> CflCondition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CflCondition

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

Formats the value using the given formatter.