Struct SolverState

Source

pub struct SolverState {
    pub flows: Vec<f64>,
    pub heads: Vec<f64>,
    pub demands: Vec<f64>,
    pub emitter_flows: Vec<f64>,
    pub demand_flows: Vec<f64>,
    pub statuses: Vec<LinkStatus>,
    pub settings: Vec<f64>,
    pub resistances: Vec<f64>,
    pub topology_version: u32,
    pub properties_version: u32,
}

Expand description

The solver state is the initial/final state of the solver for a single step

Fields§

§flows: Vec<f64>§heads: Vec<f64>§demands: Vec<f64>§emitter_flows: Vec<f64>§demand_flows: Vec<f64>§statuses: Vec<LinkStatus>§settings: Vec<f64>§resistances: Vec<f64>§topology_version: u32

version of the topology of the network on which the state was created

§properties_version: u32

version of the properties of the network on which the state was created

Implementations§

Source §

impl SolverState

Source

pub fn new_with_initial_values(network: &Network) -> Self

Create a new solver state with the initial values for the flows, heads, demands and statuses and calculate resistances

Source

pub fn apply_patterns(&mut self, network: &Network, time: usize)

Applies demand and head patterns to the state at the given time. TODO: Add support for multiple patterns

Source

pub fn apply_controls(&mut self, network: &Network, time: usize)

Applies controls to the state at the given time.

Source

pub fn update_tanks(&mut self, network: &Network, timestep: usize)

Updates the tank levels for the given time step.

Source

pub fn update_with_network_changes(&mut self, network: &mut Network)

Updates the state with the changes to the network.

Trait Implementations§

Source §

impl Clone for SolverState

Source §

fn clone(&self) -> SolverState

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 SolverState

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for SolverState

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, 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 §