Enum ElementRole 

pub enum ElementRole {
    Conveyance,
    Boundary,
    Control,
}

What an element kind does in the network, as distinct from what it is geometrically (spec §4.3).

This exists because it is the distinction an application must draw to present an unsimulated model at all: before any results exist there is nothing to colour by, and a network drawn in one uniform tone tells a reader nothing. ElementClass cannot answer it — a pump and a pipe are both Polyline, a reservoir and a junction both Point — and kind cannot either without the application naming kinds it should not know.

Carries no presentation. An application decides what a boundary looks like; this layer decides only which kinds are boundaries.

Optional on ElementKind: some kinds have no role in the flow network, and the absence is information rather than a gap to be defaulted away.

Variants

Conveyance

Carries flow without imposing a boundary or a control on it — a junction, a pipe, a conduit. The bulk of any model.

Boundary

Where the model meets what it does not simulate: a fixed head or stage, a storage volume, an outfall. Flow enters or leaves here.

Control

Acts on the flow rather than merely passing it — a pump, a valve, a weir, an orifice, a flow divider.

Trait Implementations

impl Clone for ElementRole

fn clone(&self) -> ElementRole

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ElementRole

impl Debug for ElementRole

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElementRole

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ElementRole

impl PartialEq for ElementRole

fn eq(&self, other: &ElementRole) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ElementRole

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ElementRole