Skip to main content

DemandReliabilitySummary

Struct DemandReliabilitySummary 

Source
pub struct DemandReliabilitySummary {
    pub node_count: usize,
    pub period_count: usize,
    pub required_volume: f64,
    pub delivered_volume: f64,
    pub unmet_volume: f64,
    pub surplus_volume: f64,
    pub deficit_periods: usize,
    pub max_node_deficit_rate: f64,
}
Expand description

Network-level demand-reliability summary aggregated across all junctions.

Volumes are in m³ (internal SI units).

Fields§

§node_count: usize

Number of junctions included in the analysis.

§period_count: usize

Number of reporting periods in the simulation.

§required_volume: f64

Total required demand volume across all junctions and periods (m³).

§delivered_volume: f64

Total delivered demand volume across all junctions and periods (m³).

§unmet_volume: f64

Total unmet demand volume across all junctions and periods (m³).

§surplus_volume: f64

Total surplus delivered volume across all junctions and periods (m³).

§deficit_periods: usize

Total number of (junction, period) pairs with a deficit.

§max_node_deficit_rate: f64

Highest max_deficit_rate observed across all junctions (m³/s).

Implementations§

Source§

impl DemandReliabilitySummary

Source

pub fn served_volume(&self) -> f64

Network-wide served volume: max(required − unmet, 0) (m³).

Source

pub fn reliability_ratio(&self) -> f64

Network-wide reliability ratio in [0, 1] (1.0 when required ≤ 0).

Trait Implementations§

Source§

impl Clone for DemandReliabilitySummary

Source§

fn clone(&self) -> DemandReliabilitySummary

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 DemandReliabilitySummary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for DemandReliabilitySummary

Source§

fn default() -> DemandReliabilitySummary

Returns the “default value” for a type. 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> 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.