Struct Network 

pub struct Network {

    pub title: Vec<String>,
    pub options: SimulationOptions,
    pub patterns: Vec<Pattern>,
    pub curves: Vec<Curve>,
    pub nodes: Vec<Node>,
    pub links: Vec<Link>,
    pub controls: Vec<SimpleControl>,
    pub rules: Vec<Rule>,
    pub pattern_index: HashMap<String, usize>,
    pub report: ReportOptions,
    pub coordinates: HashMap<String, (f64, f64)>,
    pub vertices: HashMap<String, Vec<(f64, f64)>>,
    pub node_tags: HashMap<String, String>,
    pub link_tags: HashMap<String, String>,
}

The complete network data model (§2). Populated once at load time.

Nodes and links are stored in Vecs; their base.index fields are 1-based, so vec[i] has base.index == i + 1.

Fields

title: Vec<String>

Up to 3 title lines from the [TITLE] section (for binary output prolog).

options: SimulationOptions

Simulation parameters from [OPTIONS] and [TIMES] sections.

patterns: Vec<Pattern>

All patterns from the [PATTERNS] section.

curves: Vec<Curve>

All curves from the [CURVES] section.

nodes: Vec<Node>

All nodes (junctions, reservoirs, tanks).

links: Vec<Link>

All links (pipes, pumps, valves).

controls: Vec<SimpleControl>

Simple controls from the [CONTROLS] section.

rules: Vec<Rule>

Rule-based controls from the [RULES] section.

pattern_index: HashMap<String, usize>

Index mapping pattern ID → position in patterns. Built once at load time via Network::build_pattern_index so hot-path lookups are O(1).

report: ReportOptions

Report formatting options from the [REPORT] INP section.

coordinates: HashMap<String, (f64, f64)>

Node coordinates from the [COORDINATES] INP section: node ID → (x, y).

vertices: HashMap<String, Vec<(f64, f64)>>

Link vertex points from the [VERTICES] INP section: link ID → [(x, y), …].

node_tags: HashMap<String, String>

Node tags from the [TAGS] INP section: node ID → tag string.

link_tags: HashMap<String, String>

Link tags from the [TAGS] INP section: link ID → tag string.

Implementations

impl Network

pub fn build_pattern_index(&mut self)

Populates pattern_index from the current patterns vec. Must be called once after construction (before any simulation work).

pub fn pattern_by_id(&self, id: &str) -> Option<&Pattern>

O(1) pattern lookup by ID. Returns None if the ID does not exist.

impl Network

pub fn compute_favad(&self) -> FavadCoeffs

Computes per-junction FAVAD resistance coefficients (§2.10).

For each pipe, the $K_1$ and $K_2$ FAVAD coefficients are split between its two end nodes according to whether the opposite end is a junction or a fixed-grade node (reservoir or tank). Only junctions accumulate FAVAD coefficients; reservoirs and tanks are skipped.

Returns a FavadCoeffs whose c_fa and c_va vectors are indexed by the 0-based position of each node in self.nodes; non-junction entries are always 0.

impl Network

pub fn validate(&self) -> Result<(), Vec<ValidationError>>

Validates the network against all topology and referential-integrity constraints.

Returns Ok(()) if every constraint is satisfied. Returns Err(errors) with every violation found — never stops at the first error, so the caller can report all problems at once. An invalid network must not be used for simulation.

The following constraints must all hold:

1. Every node index referenced by a link exists in the node table.
2. Every curve, pattern, or node ID referenced by any object exists in the corresponding table.
3. No link connects a node to itself (from_node ≠ to_node).
4. The network contains at least one fixed-grade node (reservoir or tank). Every junction is reachable from at least one fixed-grade node via the link graph.
5. For each tank: min_level ≤ init_level ≤ max_level.
6. All PUMP_HEAD curves are strictly decreasing in y.
7. All curves have strictly increasing x-values.
8. All patterns have at least one factor.
9. Every rule action that references a link references a valid link index.
10. wall_order is 0 or 1; no other value is valid.

Violations of any of the above are fatal — the simulation must not proceed.

Trait Implementations

impl Clone for Network

fn clone(&self) -> Network

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Network

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

Formats the value using the given formatter.