Links

To change what a link is, use its typed settings Live View. To control it or read what it is doing, use the link itself. Runtime controls, forcing, quality, current results, snapshots, and statistics live there.

from swmmrs import Simulation
from swmmrs.objects import CircularCrossSection, Conduit, Pump

with Simulation("model.inp", "model.rpt") as simulation:
    conduit = simulation.links["C-1"]
    if isinstance(conduit, Conduit):
        conduit.settings.update(
            length=350.0,
            roughness=0.013,
            cross_section=CircularCrossSection(diameter=2.0),
        )

    pump = simulation.links["PUMP-1"]
    if isinstance(pump, Pump):
        pump.settings.use_curve(simulation.curves["PUMP-CURVE"])

    # Runtime controls stay on the link, not its stable settings view.
    pump.target_setting = 0.75

Look for an attached inlet on the link that owns it. The optional link.inlet provides access; there is no global simulation.inlets collection. link.inlet.settings exposes read-only count, local geometry, and the reusable design from simulation.inlet_designs. Persistent percent_clogged and flow_limit controls remain top-level on the inlet, while capture/backflow values are runtime results. See Inspect model definitions for more detail.

from swmmrs import Simulation

with Simulation("model.inp", "model.rpt") as simulation:
    link = simulation.links["C-1"]
    inlet = link.inlet
    if inlet is not None:
        print(inlet.settings.count, inlet.settings.design.id)
        print(inlet.settings.local_depression, inlet.settings.local_width)

        inlet.update(percent_clogged=15.0, flow_limit=2.0)

    simulation.start()
    while simulation.step() is not None:
        if inlet is not None:
            print(inlet.captured_flow, inlet.backflow)

    flows = simulation.links.snapshot(["C-1"])
    statistics = simulation.links.statistics()

pollut_quality, reactor concentration, and total pollutant load are immutable current-result mappings. override_pollutant_concentrations({...}) atomically queues nonnegative concentrations for the next quality-routing step only. external_pollutant_mass_flux is a persistent live mutable mapping with atomic item assignment and sparse update(). Deletion resets one configured pollutant to zero, clear() resets all configured pollutants, and whole-property assignment is unsupported.

from swmmrs import Simulation

with Simulation("model.inp", "model.rpt") as simulation:
    link = simulation.links["C-1"]
    flux = link.external_pollutant_mass_flux
    flux.update({"TSS": 1.5, "Lead": 0.05})
    del flux["Lead"]  # Reset one pollutant to zero.

    simulation.start()
    link.override_pollutant_concentrations({"TSS": 80.0})
    simulation.step()
    print(dict(link.pollut_quality))
    print(dict(link.reactor_pollutant_concentration))

    flux.clear()  # Reset all configured pollutant fluxes to zero.

Typed, generation-bound views over configured SWMM project objects.

All view instances retain the simulation and project generation that created them. They validate that identity before accessing native state, so retained views cannot silently address a subsequently reopened project.

CLASS	DESCRIPTION
`LinkCollection`	Provide link lookup and aligned hydraulic, quality, and statistics snapshots.
`Link`	Expose link identity, stable settings, runtime controls, and current results.
`LinkSettings`	Expose stable common-link settings through one atomic owner.
`Conduit`	Expose a conduit link with stable settings and current hydraulics.
`ConduitSettings`	Expose stable conduit settings and cross-section replacement.
`CircularCrossSection`	Store a circular conduit cross-section in project length units.
`StandardCrossSection`	Store a standard SWMM cross-section declaration.
`CustomCrossSection`	Store a custom-shape cross-section relationship and full depth.
`IrregularCrossSection`	Store an irregular-transect cross-section relationship.
`StreetCrossSection`	Store a street cross-section relationship.
`Pump`	Expose a pump link with stable settings and current hydraulics.
`PumpSettings`	Expose stable pump settings and explicit operating-mode transitions.
`Orifice`	Expose an orifice link with stable settings and current hydraulics.
`OrificeSettings`	Expose stable orifice settings.
`Weir`	Expose a weir link with stable settings and current hydraulics.
`WeirSettings`	Expose stable weir settings.
`Outlet`	Expose an outlet link with stable settings and current hydraulics.
`OutletSettings`	Expose stable outlet-rating settings.
`FunctionalOutletRating`	Store a functional outlet rating in project units.
`TabularOutletRating`	Store a curve-driven outlet rating.
`Inlet`	Expose persistent controls and current results for one link-local inlet.
`InletSettings`	Expose the stable read-only placement settings of one link-local inlet.
`InletDesign`	Expose a generation-bound inlet-design definition.

LinkCollection


              flowchart TD
              swmmrs.objects.LinkCollection[LinkCollection]
              swmmrs.objects._collections._Collection[_Collection]

                              swmmrs.objects._collections._Collection --> swmmrs.objects.LinkCollection
                


              click swmmrs.objects.LinkCollection href "" "swmmrs.objects.LinkCollection"
              click swmmrs.objects._collections._Collection href "" "swmmrs.objects._collections._Collection"

Provide link lookup and aligned hydraulic, quality, and statistics snapshots.

METHOD	DESCRIPTION
`__contains__`	Return whether a case-insensitive object ID is configured.
`__getitem__`	Return a link view by case-insensitive configured ID.
`__iter__`	Return an iterator over object IDs in configured project order.
`__len__`	Return the number of configured objects in this collection.
`by_index`	Return a link view by its zero-based configured position.
`quality_snapshot`	Copy current link quality in canonical or requested order.
`snapshot`	Copy current link hydraulics in canonical or requested order.
`statistics`	Copy cumulative link statistics in canonical or requested order.

contains

__contains__(key: object) -> bool

Return whether a case-insensitive object ID is configured.

PARAMETER	DESCRIPTION
`key`	Candidate object ID. TYPE: `object`

RETURNS	DESCRIPTION
`bool`	`True` when `key` identifies a configured object; otherwise `False`.

getitem

__getitem__(key: str | int) -> Link

Return a link view by case-insensitive configured ID.

iter

__iter__() -> Iterator[str]

Return an iterator over object IDs in configured project order.

len

__len__() -> int

Return the number of configured objects in this collection.

by_index

by_index(index: int) -> Link

Return a link view by its zero-based configured position.

quality_snapshot

quality_snapshot(ids: str | int | Iterable[str | int] | None = None) -> LinkQualitySnapshot

Copy current link quality in canonical or requested order.

snapshot

snapshot(ids: str | int | Iterable[str | int] | None = None) -> LinkSnapshot

Copy current link hydraulics in canonical or requested order.

statistics

statistics(ids: str | int | Iterable[str | int] | None = None) -> LinkStatisticsSnapshot

Copy cumulative link statistics in canonical or requested order.

Link


              flowchart TD
              swmmrs.objects.Link[Link]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._base._LiveView --> swmmrs.objects.Link
                


              click swmmrs.objects.Link href "" "swmmrs.objects.Link"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose link identity, stable settings, runtime controls, and current results.

METHOD	DESCRIPTION
`override_pollutant_concentrations`	Atomically override concentrations for the next quality step. Lifecycle: `RUNNING`.

ATTRIBUTE	DESCRIPTION
`capacity`	Return native subtype capacity fraction or current setting. TYPE: `float`
`depth`	Return current depth in project length units. TYPE: `float`
`downstream_surface_area`	Return current downstream surface area in project area units. TYPE: `float`
`external_pollutant_mass_flux`	Return canonical persistent mass fluxes as a live mutable mapping. TYPE: `MutableMapping[str, float]`
`flow`	Return signed current flow in project flow units. TYPE: `float`
`flow_limit`	Flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`froude_number`	Return the current dimensionless Froude number. TYPE: `float`
`inlet`	Return this link's generation-bound inlet placement, when configured. TYPE: `Inlet \| None`
`kind`	Return the configured link subtype. TYPE: `LinkKind`
`pollut_quality`	Return immutable current concentrations by canonical pollutant ID. TYPE: `Mapping[str, float]`
`pollutant_total_load`	Return current total routed loads in reporting units. TYPE: `Mapping[str, float]`
`reactor_pollutant_concentration`	Return current pre-override reactor concentrations. TYPE: `Mapping[str, float]`
`setting`	Return the current setting or pump speed factor. TYPE: `float`
`settings`	Return stable common-link settings. TYPE: `LinkSettings`
`statistics`	Return immutable cumulative common-link statistics. TYPE: `LinkStatistics`
`target_setting`	Target setting or pump speed. Setter lifecycle: `RUNNING`. TYPE: `float`
`time_closed`	Return current continuously-closed duration. TYPE: `timedelta`
`time_open`	Return current continuously-open duration. TYPE: `timedelta`
`upstream_surface_area`	Return current upstream surface area in project area units. TYPE: `float`
`velocity`	Return current velocity in project length units per second. TYPE: `float`
`volume`	Return current volume in project volume units. TYPE: `float`

capacity `property`

capacity: float

Return native subtype capacity fraction or current setting.

depth `property`

depth: float

Return current depth in project length units.

downstream_surface_area `property`

downstream_surface_area: float

Return current downstream surface area in project area units.

external_pollutant_mass_flux `property`

external_pollutant_mass_flux: MutableMapping[str, float]

Return canonical persistent mass fluxes as a live mutable mapping.

Item assignment and update() are atomic sparse mutations. Deletion resets one configured pollutant to zero; clear() atomically resets every pollutant. Nonzero values require a non-dummy conduit; other link types accept only an all-zero candidate. Mutation lifecycle: OPEN, RUNNING, ENDED.

flow `property`

flow: float

Return signed current flow in project flow units.

flow_limit `property` `writable`

flow_limit: float

Flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

froude_number `property`

froude_number: float

Return the current dimensionless Froude number.

inlet `property`

inlet: Inlet | None

Return this link's generation-bound inlet placement, when configured.

kind `property`

kind: LinkKind

Return the configured link subtype.

pollut_quality `property`

pollut_quality: Mapping[str, float]

Return immutable current concentrations by canonical pollutant ID.

pollutant_total_load `property`

pollutant_total_load: Mapping[str, float]

Return current total routed loads in reporting units.

reactor_pollutant_concentration `property`

reactor_pollutant_concentration: Mapping[str, float]

Return current pre-override reactor concentrations.

setting `property`

setting: float

Return the current setting or pump speed factor.

settings `property`

settings: LinkSettings

Return stable common-link settings.

statistics `property`

statistics: LinkStatistics

Return immutable cumulative common-link statistics.

target_setting `property` `writable`

target_setting: float

Target setting or pump speed. Setter lifecycle: RUNNING.

time_closed `property`

time_closed: timedelta

Return current continuously-closed duration.

time_open `property`

time_open: timedelta

Return current continuously-open duration.

upstream_surface_area `property`

upstream_surface_area: float

Return current upstream surface area in project area units.

velocity `property`

velocity: float

Return current velocity in project length units per second.

volume `property`

volume: float

Return current volume in project volume units.

override_pollutant_concentrations

override_pollutant_concentrations(values: Mapping[str, float] | Iterable[tuple[str | int, float]]) -> None

Atomically override concentrations for the next quality step. Lifecycle: RUNNING.

LinkSettings

Expose stable common-link settings through one atomic owner.

METHOD	DESCRIPTION
`update`	Atomically update supplied stable link settings.

ATTRIBUTE	DESCRIPTION
`average_loss_coefficient`	Return the dimensionless average loss coefficient. TYPE: `float`
`flow_direction`	Return the configured numeric orientation sign. TYPE: `Literal[-1, 1]`
`full_depth`	Return full depth in project length units. TYPE: `float`
`full_flow`	Return full flow in project flow units. TYPE: `float`
`has_flap_gate`	Return whether the link has a flap gate. TYPE: `bool`
`included_in_report`	Return whether detailed output includes this link. TYPE: `bool`
`initial_flow`	Return initial flow in project flow units. TYPE: `float`
`inlet_loss_coefficient`	Return the dimensionless inlet loss coefficient. TYPE: `float`
`inlet_node`	Return the generation-bound upstream node relationship. TYPE: `Node`
`inlet_offset`	Return inlet offset in project length units. TYPE: `float`
`outlet_loss_coefficient`	Return the dimensionless outlet loss coefficient. TYPE: `float`
`outlet_node`	Return the generation-bound downstream node relationship. TYPE: `Node`
`outlet_offset`	Return outlet offset in project length units. TYPE: `float`
`seepage_rate`	Return seepage rate in project rainfall units. TYPE: `float`
`tag`	Return the metadata tag. TYPE: `str`

average_loss_coefficient `property` `writable`

average_loss_coefficient: float

Return the dimensionless average loss coefficient.

flow_direction `property`

flow_direction: Literal[-1, 1]

Return the configured numeric orientation sign.

full_depth `property`

full_depth: float

Return full depth in project length units.

full_flow `property`

full_flow: float

Return full flow in project flow units.

has_flap_gate `property` `writable`

has_flap_gate: bool

Return whether the link has a flap gate.

included_in_report `property` `writable`

included_in_report: bool

Return whether detailed output includes this link.

initial_flow `property` `writable`

initial_flow: float

Return initial flow in project flow units.

inlet_loss_coefficient `property` `writable`

inlet_loss_coefficient: float

Return the dimensionless inlet loss coefficient.

inlet_node `property` `writable`

inlet_node: Node

Return the generation-bound upstream node relationship.

inlet_offset `property` `writable`

inlet_offset: float

Return inlet offset in project length units.

outlet_loss_coefficient `property` `writable`

outlet_loss_coefficient: float

Return the dimensionless outlet loss coefficient.

outlet_node `property` `writable`

outlet_node: Node

Return the generation-bound downstream node relationship.

outlet_offset `property` `writable`

outlet_offset: float

Return outlet offset in project length units.

seepage_rate `property` `writable`

seepage_rate: float

Return seepage rate in project rainfall units.

tag `property` `writable`

tag: str

Return the metadata tag.

update

update(**changes: object) -> None

Atomically update supplied stable link settings.

Conduit


              flowchart TD
              swmmrs.objects.Conduit[Conduit]
              swmmrs.objects._links.Link[Link]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._links.Link --> swmmrs.objects.Conduit
                                swmmrs.objects._base._LiveView --> swmmrs.objects._links.Link
                



              click swmmrs.objects.Conduit href "" "swmmrs.objects.Conduit"
              click swmmrs.objects._links.Link href "" "swmmrs.objects._links.Link"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose a conduit link with stable settings and current hydraulics.

METHOD	DESCRIPTION
`override_pollutant_concentrations`	Atomically override concentrations for the next quality step. Lifecycle: `RUNNING`.

ATTRIBUTE	DESCRIPTION
`capacity`	Return native subtype capacity fraction or current setting. TYPE: `float`
`depth`	Return current depth in project length units. TYPE: `float`
`downstream_surface_area`	Return current downstream surface area in project area units. TYPE: `float`
`external_pollutant_mass_flux`	Return canonical persistent mass fluxes as a live mutable mapping. TYPE: `MutableMapping[str, float]`
`flow`	Return signed current flow in project flow units. TYPE: `float`
`flow_limit`	Flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`froude_number`	Return the current dimensionless Froude number. TYPE: `float`
`inlet`	Return this link's generation-bound inlet placement, when configured. TYPE: `Inlet \| None`
`kind`	Return the configured link subtype. TYPE: `LinkKind`
`pollut_quality`	Return immutable current concentrations by canonical pollutant ID. TYPE: `Mapping[str, float]`
`pollutant_total_load`	Return current total routed loads in reporting units. TYPE: `Mapping[str, float]`
`reactor_pollutant_concentration`	Return current pre-override reactor concentrations. TYPE: `Mapping[str, float]`
`setting`	Return the current setting or pump speed factor. TYPE: `float`
`settings`	Return stable conduit settings. TYPE: `ConduitSettings`
`statistics`	Return immutable cumulative common-link statistics. TYPE: `LinkStatistics`
`target_setting`	Target setting or pump speed. Setter lifecycle: `RUNNING`. TYPE: `float`
`time_closed`	Return current continuously-closed duration. TYPE: `timedelta`
`time_open`	Return current continuously-open duration. TYPE: `timedelta`
`top_width`	Return current conduit top width in project length units. TYPE: `float`
`upstream_surface_area`	Return current upstream surface area in project area units. TYPE: `float`
`velocity`	Return current velocity in project length units per second. TYPE: `float`
`volume`	Return current volume in project volume units. TYPE: `float`

capacity `property`

capacity: float

Return native subtype capacity fraction or current setting.

depth `property`

depth: float

Return current depth in project length units.

downstream_surface_area `property`

downstream_surface_area: float

Return current downstream surface area in project area units.

external_pollutant_mass_flux `property`

external_pollutant_mass_flux: MutableMapping[str, float]

Return canonical persistent mass fluxes as a live mutable mapping.

Item assignment and update() are atomic sparse mutations. Deletion resets one configured pollutant to zero; clear() atomically resets every pollutant. Nonzero values require a non-dummy conduit; other link types accept only an all-zero candidate. Mutation lifecycle: OPEN, RUNNING, ENDED.

flow `property`

flow: float

Return signed current flow in project flow units.

flow_limit `property` `writable`

flow_limit: float

Flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

froude_number `property`

froude_number: float

Return the current dimensionless Froude number.

inlet `property`

inlet: Inlet | None

Return this link's generation-bound inlet placement, when configured.

kind `property`

kind: LinkKind

Return the configured link subtype.

pollut_quality `property`

pollut_quality: Mapping[str, float]

Return immutable current concentrations by canonical pollutant ID.

pollutant_total_load `property`

pollutant_total_load: Mapping[str, float]

Return current total routed loads in reporting units.

reactor_pollutant_concentration `property`

reactor_pollutant_concentration: Mapping[str, float]

Return current pre-override reactor concentrations.

setting `property`

setting: float

Return the current setting or pump speed factor.

settings `property`

settings: ConduitSettings

Return stable conduit settings.

statistics `property`

statistics: LinkStatistics

Return immutable cumulative common-link statistics.

target_setting `property` `writable`

target_setting: float

Target setting or pump speed. Setter lifecycle: RUNNING.

time_closed `property`

time_closed: timedelta

Return current continuously-closed duration.

time_open `property`

time_open: timedelta

Return current continuously-open duration.

top_width `property`

top_width: float

Return current conduit top width in project length units.

upstream_surface_area `property`

upstream_surface_area: float

Return current upstream surface area in project area units.

velocity `property`

velocity: float

Return current velocity in project length units per second.

volume `property`

volume: float

Return current volume in project volume units.

override_pollutant_concentrations

override_pollutant_concentrations(values: Mapping[str, float] | Iterable[tuple[str | int, float]]) -> None

Atomically override concentrations for the next quality step. Lifecycle: RUNNING.

ConduitSettings


              flowchart TD
              swmmrs.objects.ConduitSettings[ConduitSettings]
              swmmrs.objects._links.LinkSettings[LinkSettings]

                              swmmrs.objects._links.LinkSettings --> swmmrs.objects.ConduitSettings
                


              click swmmrs.objects.ConduitSettings href "" "swmmrs.objects.ConduitSettings"
              click swmmrs.objects._links.LinkSettings href "" "swmmrs.objects._links.LinkSettings"

Expose stable conduit settings and cross-section replacement.

METHOD	DESCRIPTION
`update`	Atomically update supplied stable link settings.

ATTRIBUTE	DESCRIPTION
`average_loss_coefficient`	Return the dimensionless average loss coefficient. TYPE: `float`
`barrels`	Return the positive number of identical conduit barrels. TYPE: `int`
`cross_section`	Return the complete typed cross-section declaration, when retained. TYPE: `_CrossSection \| None`
`flow_direction`	Return the configured numeric orientation sign. TYPE: `Literal[-1, 1]`
`full_depth`	Return full depth in project length units. TYPE: `float`
`full_flow`	Return full flow in project flow units. TYPE: `float`
`has_flap_gate`	Return whether the link has a flap gate. TYPE: `bool`
`included_in_report`	Return whether detailed output includes this link. TYPE: `bool`
`initial_flow`	Return initial flow in project flow units. TYPE: `float`
`inlet_loss_coefficient`	Return the dimensionless inlet loss coefficient. TYPE: `float`
`inlet_node`	Return the generation-bound upstream node relationship. TYPE: `Node`
`inlet_offset`	Return inlet offset in project length units. TYPE: `float`
`length`	Return conduit length in project length units. TYPE: `float`
`outlet_loss_coefficient`	Return the dimensionless outlet loss coefficient. TYPE: `float`
`outlet_node`	Return the generation-bound downstream node relationship. TYPE: `Node`
`outlet_offset`	Return outlet offset in project length units. TYPE: `float`
`roughness`	Return conduit Manning roughness. TYPE: `float`
`seepage_rate`	Return seepage rate in project rainfall units. TYPE: `float`
`slope`	Return conduit slope as a fraction. TYPE: `float`
`tag`	Return the metadata tag. TYPE: `str`

average_loss_coefficient `property` `writable`

average_loss_coefficient: float

Return the dimensionless average loss coefficient.

barrels `property` `writable`

barrels: int

Return the positive number of identical conduit barrels.

cross_section `property` `writable`

cross_section: _CrossSection | None

Return the complete typed cross-section declaration, when retained.

flow_direction `property`

flow_direction: Literal[-1, 1]

Return the configured numeric orientation sign.

full_depth `property`

full_depth: float

Return full depth in project length units.

full_flow `property`

full_flow: float

Return full flow in project flow units.

has_flap_gate `property` `writable`

has_flap_gate: bool

Return whether the link has a flap gate.

included_in_report `property` `writable`

included_in_report: bool

Return whether detailed output includes this link.

initial_flow `property` `writable`

initial_flow: float

Return initial flow in project flow units.

inlet_loss_coefficient `property` `writable`

inlet_loss_coefficient: float

Return the dimensionless inlet loss coefficient.

inlet_node `property` `writable`

inlet_node: Node

Return the generation-bound upstream node relationship.

inlet_offset `property` `writable`

inlet_offset: float

Return inlet offset in project length units.

length `property` `writable`

length: float

Return conduit length in project length units.

outlet_loss_coefficient `property` `writable`

outlet_loss_coefficient: float

Return the dimensionless outlet loss coefficient.

outlet_node `property` `writable`

outlet_node: Node

Return the generation-bound downstream node relationship.

outlet_offset `property` `writable`

outlet_offset: float

Return outlet offset in project length units.

roughness `property` `writable`

roughness: float

Return conduit Manning roughness.

seepage_rate `property` `writable`

seepage_rate: float

Return seepage rate in project rainfall units.

slope `property`

slope: float

Return conduit slope as a fraction.

tag `property` `writable`

tag: str

Return the metadata tag.

update

update(**changes: object) -> None

Atomically update supplied stable link settings.

CircularCrossSection

Store a circular conduit cross-section in project length units.

StandardCrossSection

Store a standard SWMM cross-section declaration.

Geometry follows SWMM's four XSECTION parameters. Dimensional entries use project length units; side counts, side slopes, power exponents, catalog size codes, force-main roughness/C-factors, and unused entries do not.

CustomCrossSection

Store a custom-shape cross-section relationship and full depth.

IrregularCrossSection

Store an irregular-transect cross-section relationship.

StreetCrossSection

Store a street cross-section relationship.

Pump


              flowchart TD
              swmmrs.objects.Pump[Pump]
              swmmrs.objects._links.Link[Link]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._links.Link --> swmmrs.objects.Pump
                                swmmrs.objects._base._LiveView --> swmmrs.objects._links.Link
                



              click swmmrs.objects.Pump href "" "swmmrs.objects.Pump"
              click swmmrs.objects._links.Link href "" "swmmrs.objects._links.Link"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose a pump link with stable settings and current hydraulics.

METHOD	DESCRIPTION
`override_pollutant_concentrations`	Atomically override concentrations for the next quality step. Lifecycle: `RUNNING`.

ATTRIBUTE	DESCRIPTION
`capacity`	Return native subtype capacity fraction or current setting. TYPE: `float`
`depth`	Return current depth in project length units. TYPE: `float`
`downstream_surface_area`	Return current downstream surface area in project area units. TYPE: `float`
`external_pollutant_mass_flux`	Return canonical persistent mass fluxes as a live mutable mapping. TYPE: `MutableMapping[str, float]`
`flow`	Return signed current flow in project flow units. TYPE: `float`
`flow_limit`	Flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`froude_number`	Return the current dimensionless Froude number. TYPE: `float`
`inlet`	Return this link's generation-bound inlet placement, when configured. TYPE: `Inlet \| None`
`kind`	Return the configured link subtype. TYPE: `LinkKind`
`pollut_quality`	Return immutable current concentrations by canonical pollutant ID. TYPE: `Mapping[str, float]`
`pollutant_total_load`	Return current total routed loads in reporting units. TYPE: `Mapping[str, float]`
`pump_statistics`	Return immutable cumulative pump statistics. TYPE: `PumpStatistics`
`reactor_pollutant_concentration`	Return current pre-override reactor concentrations. TYPE: `Mapping[str, float]`
`setting`	Return the current setting or pump speed factor. TYPE: `float`
`settings`	Return stable pump settings. TYPE: `PumpSettings`
`statistics`	Return immutable cumulative common-link statistics. TYPE: `LinkStatistics`
`target_setting`	Target setting or pump speed. Setter lifecycle: `RUNNING`. TYPE: `float`
`time_closed`	Return current continuously-closed duration. TYPE: `timedelta`
`time_open`	Return current continuously-open duration. TYPE: `timedelta`
`upstream_surface_area`	Return current upstream surface area in project area units. TYPE: `float`
`velocity`	Return current velocity in project length units per second. TYPE: `float`
`volume`	Return current volume in project volume units. TYPE: `float`

capacity `property`

capacity: float

Return native subtype capacity fraction or current setting.

depth `property`

depth: float

Return current depth in project length units.

downstream_surface_area `property`

downstream_surface_area: float

Return current downstream surface area in project area units.

external_pollutant_mass_flux `property`

external_pollutant_mass_flux: MutableMapping[str, float]

Return canonical persistent mass fluxes as a live mutable mapping.

Item assignment and update() are atomic sparse mutations. Deletion resets one configured pollutant to zero; clear() atomically resets every pollutant. Nonzero values require a non-dummy conduit; other link types accept only an all-zero candidate. Mutation lifecycle: OPEN, RUNNING, ENDED.

flow `property`

flow: float

Return signed current flow in project flow units.

flow_limit `property` `writable`

flow_limit: float

Flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

froude_number `property`

froude_number: float

Return the current dimensionless Froude number.

inlet `property`

inlet: Inlet | None

Return this link's generation-bound inlet placement, when configured.

kind `property`

kind: LinkKind

Return the configured link subtype.

pollut_quality `property`

pollut_quality: Mapping[str, float]

Return immutable current concentrations by canonical pollutant ID.

pollutant_total_load `property`

pollutant_total_load: Mapping[str, float]

Return current total routed loads in reporting units.

pump_statistics `property`

pump_statistics: PumpStatistics

Return immutable cumulative pump statistics.

reactor_pollutant_concentration `property`

reactor_pollutant_concentration: Mapping[str, float]

Return current pre-override reactor concentrations.

setting `property`

setting: float

Return the current setting or pump speed factor.

settings `property`

settings: PumpSettings

Return stable pump settings.

statistics `property`

statistics: LinkStatistics

Return immutable cumulative common-link statistics.

target_setting `property` `writable`

target_setting: float

Target setting or pump speed. Setter lifecycle: RUNNING.

time_closed `property`

time_closed: timedelta

Return current continuously-closed duration.

time_open `property`

time_open: timedelta

Return current continuously-open duration.

upstream_surface_area `property`

upstream_surface_area: float

Return current upstream surface area in project area units.

velocity `property`

velocity: float

Return current velocity in project length units per second.

volume `property`

volume: float

Return current volume in project volume units.

override_pollutant_concentrations

override_pollutant_concentrations(values: Mapping[str, float] | Iterable[tuple[str | int, float]]) -> None

Atomically override concentrations for the next quality step. Lifecycle: RUNNING.

PumpSettings


              flowchart TD
              swmmrs.objects.PumpSettings[PumpSettings]
              swmmrs.objects._links.LinkSettings[LinkSettings]

                              swmmrs.objects._links.LinkSettings --> swmmrs.objects.PumpSettings
                


              click swmmrs.objects.PumpSettings href "" "swmmrs.objects.PumpSettings"
              click swmmrs.objects._links.LinkSettings href "" "swmmrs.objects._links.LinkSettings"

Expose stable pump settings and explicit operating-mode transitions.

METHOD	DESCRIPTION
`update`	Atomically update supplied stable link settings.
`use_curve`	Switch to curve-driven operation while preserving scalar settings.
`use_ideal`	Switch to ideal operation while preserving scalar settings.

ATTRIBUTE	DESCRIPTION
`average_loss_coefficient`	Return the dimensionless average loss coefficient. TYPE: `float`
`curve`	Return the pump curve, or `None` while operating as an ideal pump. TYPE: `Curve \| None`
`flow_direction`	Return the configured numeric orientation sign. TYPE: `Literal[-1, 1]`
`full_depth`	Return full depth in project length units. TYPE: `float`
`full_flow`	Return full flow in project flow units. TYPE: `float`
`has_flap_gate`	Return whether the link has a flap gate. TYPE: `bool`
`included_in_report`	Return whether detailed output includes this link. TYPE: `bool`
`initial_flow`	Return initial flow in project flow units. TYPE: `float`
`initial_setting`	Return the initial dimensionless pump speed setting. TYPE: `float`
`inlet_loss_coefficient`	Return the dimensionless inlet loss coefficient. TYPE: `float`
`inlet_node`	Return the generation-bound upstream node relationship. TYPE: `Node`
`inlet_offset`	Return inlet offset in project length units. TYPE: `float`
`outlet_loss_coefficient`	Return the dimensionless outlet loss coefficient. TYPE: `float`
`outlet_node`	Return the generation-bound downstream node relationship. TYPE: `Node`
`outlet_offset`	Return outlet offset in project length units. TYPE: `float`
`seepage_rate`	Return seepage rate in project rainfall units. TYPE: `float`
`shutoff_depth`	Return pump shutoff depth in project length units. TYPE: `float`
`startup_depth`	Return pump startup depth in project length units. TYPE: `float`
`tag`	Return the metadata tag. TYPE: `str`

average_loss_coefficient `property` `writable`

average_loss_coefficient: float

Return the dimensionless average loss coefficient.

curve `property`

curve: Curve | None

Return the pump curve, or None while operating as an ideal pump.

flow_direction `property`

flow_direction: Literal[-1, 1]

Return the configured numeric orientation sign.

full_depth `property`

full_depth: float

Return full depth in project length units.

full_flow `property`

full_flow: float

Return full flow in project flow units.

has_flap_gate `property` `writable`

has_flap_gate: bool

Return whether the link has a flap gate.

included_in_report `property` `writable`

included_in_report: bool

Return whether detailed output includes this link.

initial_flow `property` `writable`

initial_flow: float

Return initial flow in project flow units.

initial_setting `property` `writable`

initial_setting: float

Return the initial dimensionless pump speed setting.

inlet_loss_coefficient `property` `writable`

inlet_loss_coefficient: float

Return the dimensionless inlet loss coefficient.

inlet_node `property` `writable`

inlet_node: Node

Return the generation-bound upstream node relationship.

inlet_offset `property` `writable`

inlet_offset: float

Return inlet offset in project length units.

outlet_loss_coefficient `property` `writable`

outlet_loss_coefficient: float

Return the dimensionless outlet loss coefficient.

outlet_node `property` `writable`

outlet_node: Node

Return the generation-bound downstream node relationship.

outlet_offset `property` `writable`

outlet_offset: float

Return outlet offset in project length units.

seepage_rate `property` `writable`

seepage_rate: float

Return seepage rate in project rainfall units.

shutoff_depth `property` `writable`

shutoff_depth: float

Return pump shutoff depth in project length units.

startup_depth `property` `writable`

startup_depth: float

Return pump startup depth in project length units.

tag `property` `writable`

tag: str

Return the metadata tag.

update

update(**changes: object) -> None

Atomically update supplied stable link settings.

use_curve

use_curve(curve: Curve) -> None

Switch to curve-driven operation while preserving scalar settings.

use_ideal

use_ideal() -> None

Switch to ideal operation while preserving scalar settings.

Orifice


              flowchart TD
              swmmrs.objects.Orifice[Orifice]
              swmmrs.objects._links.Link[Link]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._links.Link --> swmmrs.objects.Orifice
                                swmmrs.objects._base._LiveView --> swmmrs.objects._links.Link
                



              click swmmrs.objects.Orifice href "" "swmmrs.objects.Orifice"
              click swmmrs.objects._links.Link href "" "swmmrs.objects._links.Link"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose an orifice link with stable settings and current hydraulics.

METHOD	DESCRIPTION
`override_pollutant_concentrations`	Atomically override concentrations for the next quality step. Lifecycle: `RUNNING`.

ATTRIBUTE	DESCRIPTION
`capacity`	Return native subtype capacity fraction or current setting. TYPE: `float`
`depth`	Return current depth in project length units. TYPE: `float`
`downstream_surface_area`	Return current downstream surface area in project area units. TYPE: `float`
`external_pollutant_mass_flux`	Return canonical persistent mass fluxes as a live mutable mapping. TYPE: `MutableMapping[str, float]`
`flow`	Return signed current flow in project flow units. TYPE: `float`
`flow_limit`	Flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`froude_number`	Return the current dimensionless Froude number. TYPE: `float`
`inlet`	Return this link's generation-bound inlet placement, when configured. TYPE: `Inlet \| None`
`kind`	Return the configured link subtype. TYPE: `LinkKind`
`pollut_quality`	Return immutable current concentrations by canonical pollutant ID. TYPE: `Mapping[str, float]`
`pollutant_total_load`	Return current total routed loads in reporting units. TYPE: `Mapping[str, float]`
`reactor_pollutant_concentration`	Return current pre-override reactor concentrations. TYPE: `Mapping[str, float]`
`setting`	Return the current setting or pump speed factor. TYPE: `float`
`settings`	Return stable orifice settings. TYPE: `OrificeSettings`
`statistics`	Return immutable cumulative common-link statistics. TYPE: `LinkStatistics`
`target_setting`	Target setting or pump speed. Setter lifecycle: `RUNNING`. TYPE: `float`
`time_closed`	Return current continuously-closed duration. TYPE: `timedelta`
`time_open`	Return current continuously-open duration. TYPE: `timedelta`
`upstream_surface_area`	Return current upstream surface area in project area units. TYPE: `float`
`velocity`	Return current velocity in project length units per second. TYPE: `float`
`volume`	Return current volume in project volume units. TYPE: `float`

capacity `property`

capacity: float

Return native subtype capacity fraction or current setting.

depth `property`

depth: float

Return current depth in project length units.

downstream_surface_area `property`

downstream_surface_area: float

Return current downstream surface area in project area units.

external_pollutant_mass_flux `property`

external_pollutant_mass_flux: MutableMapping[str, float]

Return canonical persistent mass fluxes as a live mutable mapping.

Item assignment and update() are atomic sparse mutations. Deletion resets one configured pollutant to zero; clear() atomically resets every pollutant. Nonzero values require a non-dummy conduit; other link types accept only an all-zero candidate. Mutation lifecycle: OPEN, RUNNING, ENDED.

flow `property`

flow: float

Return signed current flow in project flow units.

flow_limit `property` `writable`

flow_limit: float

Flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

froude_number `property`

froude_number: float

Return the current dimensionless Froude number.

inlet `property`

inlet: Inlet | None

Return this link's generation-bound inlet placement, when configured.

kind `property`

kind: LinkKind

Return the configured link subtype.

pollut_quality `property`

pollut_quality: Mapping[str, float]

Return immutable current concentrations by canonical pollutant ID.

pollutant_total_load `property`

pollutant_total_load: Mapping[str, float]

Return current total routed loads in reporting units.

reactor_pollutant_concentration `property`

reactor_pollutant_concentration: Mapping[str, float]

Return current pre-override reactor concentrations.

setting `property`

setting: float

Return the current setting or pump speed factor.

settings `property`

settings: OrificeSettings

Return stable orifice settings.

statistics `property`

statistics: LinkStatistics

Return immutable cumulative common-link statistics.

target_setting `property` `writable`

target_setting: float

Target setting or pump speed. Setter lifecycle: RUNNING.

time_closed `property`

time_closed: timedelta

Return current continuously-closed duration.

time_open `property`

time_open: timedelta

Return current continuously-open duration.

upstream_surface_area `property`

upstream_surface_area: float

Return current upstream surface area in project area units.

velocity `property`

velocity: float

Return current velocity in project length units per second.

volume `property`

volume: float

Return current volume in project volume units.

override_pollutant_concentrations

override_pollutant_concentrations(values: Mapping[str, float] | Iterable[tuple[str | int, float]]) -> None

Atomically override concentrations for the next quality step. Lifecycle: RUNNING.

OrificeSettings


              flowchart TD
              swmmrs.objects.OrificeSettings[OrificeSettings]
              swmmrs.objects._links.LinkSettings[LinkSettings]

                              swmmrs.objects._links.LinkSettings --> swmmrs.objects.OrificeSettings
                


              click swmmrs.objects.OrificeSettings href "" "swmmrs.objects.OrificeSettings"
              click swmmrs.objects._links.LinkSettings href "" "swmmrs.objects._links.LinkSettings"

Expose stable orifice settings.

METHOD	DESCRIPTION
`update`	Atomically update supplied stable link settings.

ATTRIBUTE	DESCRIPTION
`average_loss_coefficient`	Return the dimensionless average loss coefficient. TYPE: `float`
`discharge_coefficient`	Return the dimensionless orifice discharge coefficient. TYPE: `float`
`flow_direction`	Return the configured numeric orientation sign. TYPE: `Literal[-1, 1]`
`full_depth`	Return full depth in project length units. TYPE: `float`
`full_flow`	Return full flow in project flow units. TYPE: `float`
`has_flap_gate`	Return whether the link has a flap gate. TYPE: `bool`
`included_in_report`	Return whether detailed output includes this link. TYPE: `bool`
`initial_flow`	Return initial flow in project flow units. TYPE: `float`
`inlet_loss_coefficient`	Return the dimensionless inlet loss coefficient. TYPE: `float`
`inlet_node`	Return the generation-bound upstream node relationship. TYPE: `Node`
`inlet_offset`	Return inlet offset in project length units. TYPE: `float`
`kind`	Return the orifice orientation. TYPE: `OrificeKind`
`opening_time_hours`	Return the hours required to fully open or close the orifice. TYPE: `float`
`outlet_loss_coefficient`	Return the dimensionless outlet loss coefficient. TYPE: `float`
`outlet_node`	Return the generation-bound downstream node relationship. TYPE: `Node`
`outlet_offset`	Return outlet offset in project length units. TYPE: `float`
`seepage_rate`	Return seepage rate in project rainfall units. TYPE: `float`
`tag`	Return the metadata tag. TYPE: `str`

average_loss_coefficient `property` `writable`

average_loss_coefficient: float

Return the dimensionless average loss coefficient.

discharge_coefficient `property` `writable`

discharge_coefficient: float

Return the dimensionless orifice discharge coefficient.

flow_direction `property`

flow_direction: Literal[-1, 1]

Return the configured numeric orientation sign.

full_depth `property`

full_depth: float

Return full depth in project length units.

full_flow `property`

full_flow: float

Return full flow in project flow units.

has_flap_gate `property` `writable`

has_flap_gate: bool

Return whether the link has a flap gate.

included_in_report `property` `writable`

included_in_report: bool

Return whether detailed output includes this link.

initial_flow `property` `writable`

initial_flow: float

Return initial flow in project flow units.

inlet_loss_coefficient `property` `writable`

inlet_loss_coefficient: float

Return the dimensionless inlet loss coefficient.

inlet_node `property` `writable`

inlet_node: Node

Return the generation-bound upstream node relationship.

inlet_offset `property` `writable`

inlet_offset: float

Return inlet offset in project length units.

kind `property` `writable`

kind: OrificeKind

Return the orifice orientation.

opening_time_hours `property` `writable`

opening_time_hours: float

Return the hours required to fully open or close the orifice.

outlet_loss_coefficient `property` `writable`

outlet_loss_coefficient: float

Return the dimensionless outlet loss coefficient.

outlet_node `property` `writable`

outlet_node: Node

Return the generation-bound downstream node relationship.

outlet_offset `property` `writable`

outlet_offset: float

Return outlet offset in project length units.

seepage_rate `property` `writable`

seepage_rate: float

Return seepage rate in project rainfall units.

tag `property` `writable`

tag: str

Return the metadata tag.

update

update(**changes: object) -> None

Atomically update supplied stable link settings.

Weir


              flowchart TD
              swmmrs.objects.Weir[Weir]
              swmmrs.objects._links.Link[Link]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._links.Link --> swmmrs.objects.Weir
                                swmmrs.objects._base._LiveView --> swmmrs.objects._links.Link
                



              click swmmrs.objects.Weir href "" "swmmrs.objects.Weir"
              click swmmrs.objects._links.Link href "" "swmmrs.objects._links.Link"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose a weir link with stable settings and current hydraulics.

METHOD	DESCRIPTION
`override_pollutant_concentrations`	Atomically override concentrations for the next quality step. Lifecycle: `RUNNING`.

ATTRIBUTE	DESCRIPTION
`capacity`	Return native subtype capacity fraction or current setting. TYPE: `float`
`depth`	Return current depth in project length units. TYPE: `float`
`downstream_surface_area`	Return current downstream surface area in project area units. TYPE: `float`
`external_pollutant_mass_flux`	Return canonical persistent mass fluxes as a live mutable mapping. TYPE: `MutableMapping[str, float]`
`flow`	Return signed current flow in project flow units. TYPE: `float`
`flow_limit`	Flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`froude_number`	Return the current dimensionless Froude number. TYPE: `float`
`inlet`	Return this link's generation-bound inlet placement, when configured. TYPE: `Inlet \| None`
`kind`	Return the configured link subtype. TYPE: `LinkKind`
`pollut_quality`	Return immutable current concentrations by canonical pollutant ID. TYPE: `Mapping[str, float]`
`pollutant_total_load`	Return current total routed loads in reporting units. TYPE: `Mapping[str, float]`
`reactor_pollutant_concentration`	Return current pre-override reactor concentrations. TYPE: `Mapping[str, float]`
`setting`	Return the current setting or pump speed factor. TYPE: `float`
`settings`	Return stable weir settings. TYPE: `WeirSettings`
`statistics`	Return immutable cumulative common-link statistics. TYPE: `LinkStatistics`
`target_setting`	Target setting or pump speed. Setter lifecycle: `RUNNING`. TYPE: `float`
`time_closed`	Return current continuously-closed duration. TYPE: `timedelta`
`time_open`	Return current continuously-open duration. TYPE: `timedelta`
`upstream_surface_area`	Return current upstream surface area in project area units. TYPE: `float`
`velocity`	Return current velocity in project length units per second. TYPE: `float`
`volume`	Return current volume in project volume units. TYPE: `float`

capacity `property`

capacity: float

Return native subtype capacity fraction or current setting.

depth `property`

depth: float

Return current depth in project length units.

downstream_surface_area `property`

downstream_surface_area: float

Return current downstream surface area in project area units.

external_pollutant_mass_flux `property`

external_pollutant_mass_flux: MutableMapping[str, float]

Return canonical persistent mass fluxes as a live mutable mapping.

Item assignment and update() are atomic sparse mutations. Deletion resets one configured pollutant to zero; clear() atomically resets every pollutant. Nonzero values require a non-dummy conduit; other link types accept only an all-zero candidate. Mutation lifecycle: OPEN, RUNNING, ENDED.

flow `property`

flow: float

Return signed current flow in project flow units.

flow_limit `property` `writable`

flow_limit: float

Flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

froude_number `property`

froude_number: float

Return the current dimensionless Froude number.

inlet `property`

inlet: Inlet | None

Return this link's generation-bound inlet placement, when configured.

kind `property`

kind: LinkKind

Return the configured link subtype.

pollut_quality `property`

pollut_quality: Mapping[str, float]

Return immutable current concentrations by canonical pollutant ID.

pollutant_total_load `property`

pollutant_total_load: Mapping[str, float]

Return current total routed loads in reporting units.

reactor_pollutant_concentration `property`

reactor_pollutant_concentration: Mapping[str, float]

Return current pre-override reactor concentrations.

setting `property`

setting: float

Return the current setting or pump speed factor.

settings `property`

settings: WeirSettings

Return stable weir settings.

statistics `property`

statistics: LinkStatistics

Return immutable cumulative common-link statistics.

target_setting `property` `writable`

target_setting: float

Target setting or pump speed. Setter lifecycle: RUNNING.

time_closed `property`

time_closed: timedelta

Return current continuously-closed duration.

time_open `property`

time_open: timedelta

Return current continuously-open duration.

upstream_surface_area `property`

upstream_surface_area: float

Return current upstream surface area in project area units.

velocity `property`

velocity: float

Return current velocity in project length units per second.

volume `property`

volume: float

Return current volume in project volume units.

override_pollutant_concentrations

override_pollutant_concentrations(values: Mapping[str, float] | Iterable[tuple[str | int, float]]) -> None

Atomically override concentrations for the next quality step. Lifecycle: RUNNING.

WeirSettings


              flowchart TD
              swmmrs.objects.WeirSettings[WeirSettings]
              swmmrs.objects._links.LinkSettings[LinkSettings]

                              swmmrs.objects._links.LinkSettings --> swmmrs.objects.WeirSettings
                


              click swmmrs.objects.WeirSettings href "" "swmmrs.objects.WeirSettings"
              click swmmrs.objects._links.LinkSettings href "" "swmmrs.objects._links.LinkSettings"

Expose stable weir settings.

METHOD	DESCRIPTION
`update`	Atomically update supplied stable link settings.

ATTRIBUTE	DESCRIPTION
`average_loss_coefficient`	Return the dimensionless average loss coefficient. TYPE: `float`
`can_surcharge`	Return whether the weir may surcharge. TYPE: `bool`
`coefficient_curve`	Return the optional weir coefficient-curve relationship. TYPE: `Curve \| None`
`discharge_coefficient`	Return the primary weir discharge coefficient. TYPE: `float`
`end_contractions`	Return the number of weir end contractions. TYPE: `float`
`end_discharge_coefficient`	Return the weir end-section discharge coefficient. TYPE: `float`
`flow_direction`	Return the configured numeric orientation sign. TYPE: `Literal[-1, 1]`
`full_depth`	Return full depth in project length units. TYPE: `float`
`full_flow`	Return full flow in project flow units. TYPE: `float`
`has_flap_gate`	Return whether the link has a flap gate. TYPE: `bool`
`included_in_report`	Return whether detailed output includes this link. TYPE: `bool`
`initial_flow`	Return initial flow in project flow units. TYPE: `float`
`inlet_loss_coefficient`	Return the dimensionless inlet loss coefficient. TYPE: `float`
`inlet_node`	Return the generation-bound upstream node relationship. TYPE: `Node`
`inlet_offset`	Return inlet offset in project length units. TYPE: `float`
`kind`	Return the weir geometry and flow family. TYPE: `WeirKind`
`outlet_loss_coefficient`	Return the dimensionless outlet loss coefficient. TYPE: `float`
`outlet_node`	Return the generation-bound downstream node relationship. TYPE: `Node`
`outlet_offset`	Return outlet offset in project length units. TYPE: `float`
`roadway_surface`	Return the roadway-weir surface material. TYPE: `RoadSurface`
`roadway_width`	Return roadway width in project length units. TYPE: `float`
`seepage_rate`	Return seepage rate in project rainfall units. TYPE: `float`
`tag`	Return the metadata tag. TYPE: `str`

average_loss_coefficient `property` `writable`

average_loss_coefficient: float

Return the dimensionless average loss coefficient.

can_surcharge `property` `writable`

can_surcharge: bool

Return whether the weir may surcharge.

coefficient_curve `property` `writable`

coefficient_curve: Curve | None

Return the optional weir coefficient-curve relationship.

discharge_coefficient `property` `writable`

discharge_coefficient: float

Return the primary weir discharge coefficient.

end_contractions `property` `writable`

end_contractions: float

Return the number of weir end contractions.

end_discharge_coefficient `property` `writable`

end_discharge_coefficient: float

Return the weir end-section discharge coefficient.

flow_direction `property`

flow_direction: Literal[-1, 1]

Return the configured numeric orientation sign.

full_depth `property`

full_depth: float

Return full depth in project length units.

full_flow `property`

full_flow: float

Return full flow in project flow units.

has_flap_gate `property` `writable`

has_flap_gate: bool

Return whether the link has a flap gate.

included_in_report `property` `writable`

included_in_report: bool

Return whether detailed output includes this link.

initial_flow `property` `writable`

initial_flow: float

Return initial flow in project flow units.

inlet_loss_coefficient `property` `writable`

inlet_loss_coefficient: float

Return the dimensionless inlet loss coefficient.

inlet_node `property` `writable`

inlet_node: Node

Return the generation-bound upstream node relationship.

inlet_offset `property` `writable`

inlet_offset: float

Return inlet offset in project length units.

kind `property` `writable`

kind: WeirKind

Return the weir geometry and flow family.

outlet_loss_coefficient `property` `writable`

outlet_loss_coefficient: float

Return the dimensionless outlet loss coefficient.

outlet_node `property` `writable`

outlet_node: Node

Return the generation-bound downstream node relationship.

outlet_offset `property` `writable`

outlet_offset: float

Return outlet offset in project length units.

roadway_surface `property` `writable`

roadway_surface: RoadSurface

Return the roadway-weir surface material.

roadway_width `property` `writable`

roadway_width: float

Return roadway width in project length units.

seepage_rate `property` `writable`

seepage_rate: float

Return seepage rate in project rainfall units.

tag `property` `writable`

tag: str

Return the metadata tag.

update

update(**changes: object) -> None

Atomically update supplied stable link settings.

Outlet


              flowchart TD
              swmmrs.objects.Outlet[Outlet]
              swmmrs.objects._links.Link[Link]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._links.Link --> swmmrs.objects.Outlet
                                swmmrs.objects._base._LiveView --> swmmrs.objects._links.Link
                



              click swmmrs.objects.Outlet href "" "swmmrs.objects.Outlet"
              click swmmrs.objects._links.Link href "" "swmmrs.objects._links.Link"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose an outlet link with stable settings and current hydraulics.

METHOD	DESCRIPTION
`override_pollutant_concentrations`	Atomically override concentrations for the next quality step. Lifecycle: `RUNNING`.

ATTRIBUTE	DESCRIPTION
`capacity`	Return native subtype capacity fraction or current setting. TYPE: `float`
`depth`	Return current depth in project length units. TYPE: `float`
`downstream_surface_area`	Return current downstream surface area in project area units. TYPE: `float`
`external_pollutant_mass_flux`	Return canonical persistent mass fluxes as a live mutable mapping. TYPE: `MutableMapping[str, float]`
`flow`	Return signed current flow in project flow units. TYPE: `float`
`flow_limit`	Flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`froude_number`	Return the current dimensionless Froude number. TYPE: `float`
`inlet`	Return this link's generation-bound inlet placement, when configured. TYPE: `Inlet \| None`
`kind`	Return the configured link subtype. TYPE: `LinkKind`
`pollut_quality`	Return immutable current concentrations by canonical pollutant ID. TYPE: `Mapping[str, float]`
`pollutant_total_load`	Return current total routed loads in reporting units. TYPE: `Mapping[str, float]`
`reactor_pollutant_concentration`	Return current pre-override reactor concentrations. TYPE: `Mapping[str, float]`
`setting`	Return the current setting or pump speed factor. TYPE: `float`
`settings`	Return stable outlet settings. TYPE: `OutletSettings`
`statistics`	Return immutable cumulative common-link statistics. TYPE: `LinkStatistics`
`target_setting`	Target setting or pump speed. Setter lifecycle: `RUNNING`. TYPE: `float`
`time_closed`	Return current continuously-closed duration. TYPE: `timedelta`
`time_open`	Return current continuously-open duration. TYPE: `timedelta`
`upstream_surface_area`	Return current upstream surface area in project area units. TYPE: `float`
`velocity`	Return current velocity in project length units per second. TYPE: `float`
`volume`	Return current volume in project volume units. TYPE: `float`

capacity `property`

capacity: float

Return native subtype capacity fraction or current setting.

depth `property`

depth: float

Return current depth in project length units.

downstream_surface_area `property`

downstream_surface_area: float

Return current downstream surface area in project area units.

external_pollutant_mass_flux `property`

external_pollutant_mass_flux: MutableMapping[str, float]

Return canonical persistent mass fluxes as a live mutable mapping.

Item assignment and update() are atomic sparse mutations. Deletion resets one configured pollutant to zero; clear() atomically resets every pollutant. Nonzero values require a non-dummy conduit; other link types accept only an all-zero candidate. Mutation lifecycle: OPEN, RUNNING, ENDED.

flow `property`

flow: float

Return signed current flow in project flow units.

flow_limit `property` `writable`

flow_limit: float

Flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

froude_number `property`

froude_number: float

Return the current dimensionless Froude number.

inlet `property`

inlet: Inlet | None

Return this link's generation-bound inlet placement, when configured.

kind `property`

kind: LinkKind

Return the configured link subtype.

pollut_quality `property`

pollut_quality: Mapping[str, float]

Return immutable current concentrations by canonical pollutant ID.

pollutant_total_load `property`

pollutant_total_load: Mapping[str, float]

Return current total routed loads in reporting units.

reactor_pollutant_concentration `property`

reactor_pollutant_concentration: Mapping[str, float]

Return current pre-override reactor concentrations.

setting `property`

setting: float

Return the current setting or pump speed factor.

settings `property`

settings: OutletSettings

Return stable outlet settings.

statistics `property`

statistics: LinkStatistics

Return immutable cumulative common-link statistics.

target_setting `property` `writable`

target_setting: float

Target setting or pump speed. Setter lifecycle: RUNNING.

time_closed `property`

time_closed: timedelta

Return current continuously-closed duration.

time_open `property`

time_open: timedelta

Return current continuously-open duration.

upstream_surface_area `property`

upstream_surface_area: float

Return current upstream surface area in project area units.

velocity `property`

velocity: float

Return current velocity in project length units per second.

volume `property`

volume: float

Return current volume in project volume units.

override_pollutant_concentrations

override_pollutant_concentrations(values: Mapping[str, float] | Iterable[tuple[str | int, float]]) -> None

Atomically override concentrations for the next quality step. Lifecycle: RUNNING.

OutletSettings


              flowchart TD
              swmmrs.objects.OutletSettings[OutletSettings]
              swmmrs.objects._links.LinkSettings[LinkSettings]

                              swmmrs.objects._links.LinkSettings --> swmmrs.objects.OutletSettings
                


              click swmmrs.objects.OutletSettings href "" "swmmrs.objects.OutletSettings"
              click swmmrs.objects._links.LinkSettings href "" "swmmrs.objects._links.LinkSettings"

Expose stable outlet-rating settings.

METHOD	DESCRIPTION
`update`	Atomically update supplied stable link settings.

ATTRIBUTE	DESCRIPTION
`average_loss_coefficient`	Return the dimensionless average loss coefficient. TYPE: `float`
`flow_direction`	Return the configured numeric orientation sign. TYPE: `Literal[-1, 1]`
`full_depth`	Return full depth in project length units. TYPE: `float`
`full_flow`	Return full flow in project flow units. TYPE: `float`
`has_flap_gate`	Return whether the link has a flap gate. TYPE: `bool`
`included_in_report`	Return whether detailed output includes this link. TYPE: `bool`
`initial_flow`	Return initial flow in project flow units. TYPE: `float`
`inlet_loss_coefficient`	Return the dimensionless inlet loss coefficient. TYPE: `float`
`inlet_node`	Return the generation-bound upstream node relationship. TYPE: `Node`
`inlet_offset`	Return inlet offset in project length units. TYPE: `float`
`outlet_loss_coefficient`	Return the dimensionless outlet loss coefficient. TYPE: `float`
`outlet_node`	Return the generation-bound downstream node relationship. TYPE: `Node`
`outlet_offset`	Return outlet offset in project length units. TYPE: `float`
`rating`	Return the complete functional or tabular outlet rating. TYPE: `_OutletRating`
`seepage_rate`	Return seepage rate in project rainfall units. TYPE: `float`
`tag`	Return the metadata tag. TYPE: `str`

average_loss_coefficient `property` `writable`

average_loss_coefficient: float

Return the dimensionless average loss coefficient.

flow_direction `property`

flow_direction: Literal[-1, 1]

Return the configured numeric orientation sign.

full_depth `property`

full_depth: float

Return full depth in project length units.

full_flow `property`

full_flow: float

Return full flow in project flow units.

has_flap_gate `property` `writable`

has_flap_gate: bool

Return whether the link has a flap gate.

included_in_report `property` `writable`

included_in_report: bool

Return whether detailed output includes this link.

initial_flow `property` `writable`

initial_flow: float

Return initial flow in project flow units.

inlet_loss_coefficient `property` `writable`

inlet_loss_coefficient: float

Return the dimensionless inlet loss coefficient.

inlet_node `property` `writable`

inlet_node: Node

Return the generation-bound upstream node relationship.

inlet_offset `property` `writable`

inlet_offset: float

Return inlet offset in project length units.

outlet_loss_coefficient `property` `writable`

outlet_loss_coefficient: float

Return the dimensionless outlet loss coefficient.

outlet_node `property` `writable`

outlet_node: Node

Return the generation-bound downstream node relationship.

outlet_offset `property` `writable`

outlet_offset: float

Return outlet offset in project length units.

rating `property` `writable`

rating: _OutletRating

Return the complete functional or tabular outlet rating.

seepage_rate `property` `writable`

seepage_rate: float

Return seepage rate in project rainfall units.

tag `property` `writable`

tag: str

Return the metadata tag.

update

update(**changes: object) -> None

Atomically update supplied stable link settings.

FunctionalOutletRating

Store a functional outlet rating in project units.

TabularOutletRating

Store a curve-driven outlet rating.

Inlet

Expose persistent controls and current results for one link-local inlet.

METHOD	DESCRIPTION
`update`	Atomically update supplied persistent inlet controls.

ATTRIBUTE	DESCRIPTION
`backflow`	Return current backflow in project flow units. TYPE: `float`
`backflow_ratio`	Return the current dimensionless inlet backflow ratio. TYPE: `float`
`captured_flow`	Return current captured flow in project flow units. TYPE: `float`
`flow_factor`	Return the current dimensionless capture flow factor. TYPE: `float`
`flow_limit`	Per-inlet flow limit. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`percent_clogged`	Inlet clogging percentage. Setter lifecycle: `OPEN`, `RUNNING`, `ENDED`. TYPE: `float`
`settings`	Return stable read-only inlet placement settings. TYPE: `InletSettings`

backflow `property`

backflow: float

Return current backflow in project flow units.

backflow_ratio `property`

backflow_ratio: float

Return the current dimensionless inlet backflow ratio.

captured_flow `property`

captured_flow: float

Return current captured flow in project flow units.

flow_factor `property`

flow_factor: float

Return the current dimensionless capture flow factor.

flow_limit `property` `writable`

flow_limit: float

Per-inlet flow limit. Setter lifecycle: OPEN, RUNNING, ENDED.

percent_clogged `property` `writable`

percent_clogged: float

Inlet clogging percentage. Setter lifecycle: OPEN, RUNNING, ENDED.

settings `property`

settings: InletSettings

Return stable read-only inlet placement settings.

update

update(**changes: object) -> None

Atomically update supplied persistent inlet controls.

InletSettings

Expose the stable read-only placement settings of one link-local inlet.

ATTRIBUTE	DESCRIPTION
`count`	Return the positive number of identical inlet structures. TYPE: `int`
`design`	Return the generation-bound inlet-design relationship. TYPE: `InletDesign`
`local_depression`	Return local depression depth in project length units. TYPE: `float`
`local_width`	Return local depression width in project length units. TYPE: `float`

count `property`

count: int

Return the positive number of identical inlet structures.

design `property`

design: InletDesign

Return the generation-bound inlet-design relationship.

local_depression `property`

local_depression: float

Return local depression depth in project length units.

local_width `property`

local_width: float

Return local depression width in project length units.

InletDesign


              flowchart TD
              swmmrs.objects.InletDesign[InletDesign]
              swmmrs.objects._base._LiveView[_LiveView]

                              swmmrs.objects._base._LiveView --> swmmrs.objects.InletDesign
                


              click swmmrs.objects.InletDesign href "" "swmmrs.objects.InletDesign"
              click swmmrs.objects._base._LiveView href "" "swmmrs.objects._base._LiveView"

Expose a generation-bound inlet-design definition.

Links

LinkCollection

__contains__

key

__getitem__

__iter__

__len__

by_index

quality_snapshot

snapshot

statistics

Link

capacity property

depth property

downstream_surface_area property

external_pollutant_mass_flux property

flow property

flow_limit property writable

froude_number property

inlet property

kind property

pollut_quality property

pollutant_total_load property

reactor_pollutant_concentration property

setting property

settings property

statistics property

target_setting property writable

time_closed property

time_open property

upstream_surface_area property

velocity property

volume property

override_pollutant_concentrations

LinkSettings

average_loss_coefficient property writable

flow_direction property

full_depth property

full_flow property

has_flap_gate property writable

included_in_report property writable

initial_flow property writable

inlet_loss_coefficient property writable

inlet_node property writable

inlet_offset property writable

outlet_loss_coefficient property writable

outlet_node property writable

outlet_offset property writable

seepage_rate property writable

tag property writable

update

Conduit

capacity property

depth property

downstream_surface_area property

external_pollutant_mass_flux property

flow property

flow_limit property writable

froude_number property

inlet property

kind property

pollut_quality property

pollutant_total_load property

reactor_pollutant_concentration property

setting property

settings property

statistics property

target_setting property writable

time_closed property

time_open property

top_width property

upstream_surface_area property

velocity property

volume property

override_pollutant_concentrations

ConduitSettings

average_loss_coefficient property writable

barrels property writable

cross_section property writable

flow_direction property

contains

`key`

getitem

iter

len

capacity `property`

depth `property`

downstream_surface_area `property`

external_pollutant_mass_flux `property`

flow `property`

flow_limit `property` `writable`

froude_number `property`

inlet `property`

kind `property`

pollut_quality `property`

pollutant_total_load `property`

reactor_pollutant_concentration `property`

setting `property`

settings `property`

statistics `property`

target_setting `property` `writable`

time_closed `property`

time_open `property`

upstream_surface_area `property`

velocity `property`

volume `property`

average_loss_coefficient `property` `writable`

flow_direction `property`

full_depth `property`

full_flow `property`

has_flap_gate `property` `writable`

included_in_report `property` `writable`

initial_flow `property` `writable`

inlet_loss_coefficient `property` `writable`

inlet_node `property` `writable`

inlet_offset `property` `writable`

outlet_loss_coefficient `property` `writable`

outlet_node `property` `writable`

outlet_offset `property` `writable`

seepage_rate `property` `writable`

tag `property` `writable`

capacity `property`

depth `property`

downstream_surface_area `property`

external_pollutant_mass_flux `property`

flow `property`

flow_limit `property` `writable`

froude_number `property`

inlet `property`

kind `property`

pollut_quality `property`

pollutant_total_load `property`

reactor_pollutant_concentration `property`

setting `property`

settings `property`

statistics `property`

target_setting `property` `writable`

time_closed `property`

time_open `property`

top_width `property`

upstream_surface_area `property`

velocity `property`

volume `property`

average_loss_coefficient `property` `writable`

barrels `property` `writable`

cross_section `property` `writable`

flow_direction `property`

full_depth `property`

full_flow `property`

has_flap_gate `property` `writable`

included_in_report `property` `writable`

initial_flow `property` `writable`

inlet_loss_coefficient `property` `writable`

inlet_node `property` `writable`

inlet_offset `property` `writable`

length `property` `writable`

outlet_loss_coefficient `property` `writable`

outlet_node `property` `writable`

outlet_offset `property` `writable`

roughness `property` `writable`