Getter Reference: Nodes
Rendered from 11_all_get_functions.ipynb.
Nodes
node
Kind: Object collection
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.node.coordinate(ids=None, format=None) | user | coordinates | pair/list | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.count(ids=None, format=None) | derived | integer | single | int scalar count |
m.get.node.depth(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.dry_weather_flow(ids=None, format=None) | ref/mixed | table | list/table | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.external_inflow(ids=None, format=None) | ref/mixed | table | list/table | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.flooding(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.head(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.id(ids=None, format=None) | user | str | single | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.initial_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.invert_elevation(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.lateral_inflow(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.max_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.overflow(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.pollutant_concentration(ids=None, format=None) | result | float | time series × node × pollutant | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.ponded_area(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.surcharge_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.tag(ids=None, format=None) | user | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.total_inflow(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
m.get.node.treatment(ids=None, format=None) | user | expression/table | list/table | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.type(ids=None, format=None) | derived | enum | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.node.volume(ids=None, format=None) | result | float | time series × node | Time series; NumPy by default, or timestamp-indexed DataFrame with format='df' |
Copy-ready call list:
m.get.node.coordinate(ids=None, format=None)
m.get.node.count(ids=None, format=None)
m.get.node.depth(ids=None, format=None)
m.get.node.dry_weather_flow(ids=None, format=None)
m.get.node.external_inflow(ids=None, format=None)
m.get.node.flooding(ids=None, format=None)
m.get.node.head(ids=None, format=None)
m.get.node.id(ids=None, format=None)
m.get.node.initial_depth(ids=None, format=None)
m.get.node.invert_elevation(ids=None, format=None)
m.get.node.lateral_inflow(ids=None, format=None)
m.get.node.max_depth(ids=None, format=None)
m.get.node.overflow(ids=None, format=None)
m.get.node.pollutant_concentration(ids=None, format=None)
m.get.node.ponded_area(ids=None, format=None)
m.get.node.surcharge_depth(ids=None, format=None)
m.get.node.tag(ids=None, format=None)
m.get.node.total_inflow(ids=None, format=None)
m.get.node.treatment(ids=None, format=None)
m.get.node.type(ids=None, format=None)
m.get.node.volume(ids=None, format=None)junction
Kind: Object collection
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.junction.count(ids=None, format=None) | derived | integer | single | int scalar count |
m.get.junction.id(ids=None, format=None) | user | str | single | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.junction.initial_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.junction.invert_elevation(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.junction.max_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.junction.ponded_area(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.junction.surcharge_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
Copy-ready call list:
m.get.junction.count(ids=None, format=None)
m.get.junction.id(ids=None, format=None)
m.get.junction.initial_depth(ids=None, format=None)
m.get.junction.invert_elevation(ids=None, format=None)
m.get.junction.max_depth(ids=None, format=None)
m.get.junction.ponded_area(ids=None, format=None)
m.get.junction.surcharge_depth(ids=None, format=None)outfall
Kind: Object collection
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.outfall.count(ids=None, format=None) | derived | integer | single | int scalar count |
m.get.outfall.fixed_stage(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.id(ids=None, format=None) | user | str | single | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.invert_elevation(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.route_to(ids=None, format=None) | ref | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.tidal_curve(ids=None, format=None) | ref | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.tide_gate(ids=None, format=None) | user | bool | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.time_series(ids=None, format=None) | ref | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.outfall.type(ids=None, format=None) | user | enum | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
Copy-ready call list:
m.get.outfall.count(ids=None, format=None)
m.get.outfall.fixed_stage(ids=None, format=None)
m.get.outfall.id(ids=None, format=None)
m.get.outfall.invert_elevation(ids=None, format=None)
m.get.outfall.route_to(ids=None, format=None)
m.get.outfall.tidal_curve(ids=None, format=None)
m.get.outfall.tide_gate(ids=None, format=None)
m.get.outfall.time_series(ids=None, format=None)
m.get.outfall.type(ids=None, format=None)flow_divider
Kind: Object collection
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.flow_divider.count(ids=None, format=None) | derived | integer | single | int scalar count |
m.get.flow_divider.cutoff_flow(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.diversion_curve(ids=None, format=None) | ref | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.diverted_link(ids=None, format=None) | ref | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.id(ids=None, format=None) | user | str | single | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.initial_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.invert_elevation(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.max_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.ponded_area(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.surcharge_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.type(ids=None, format=None) | user | enum | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.weir_coefficient(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.flow_divider.weir_height(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
Copy-ready call list:
m.get.flow_divider.count(ids=None, format=None)
m.get.flow_divider.cutoff_flow(ids=None, format=None)
m.get.flow_divider.diversion_curve(ids=None, format=None)
m.get.flow_divider.diverted_link(ids=None, format=None)
m.get.flow_divider.id(ids=None, format=None)
m.get.flow_divider.initial_depth(ids=None, format=None)
m.get.flow_divider.invert_elevation(ids=None, format=None)
m.get.flow_divider.max_depth(ids=None, format=None)
m.get.flow_divider.ponded_area(ids=None, format=None)
m.get.flow_divider.surcharge_depth(ids=None, format=None)
m.get.flow_divider.type(ids=None, format=None)
m.get.flow_divider.weir_coefficient(ids=None, format=None)
m.get.flow_divider.weir_height(ids=None, format=None)storage_unit
Kind: Object collection
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.storage_unit.area(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.area_coefficient(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.area_constant(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.area_exponent(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.count(ids=None, format=None) | derived | integer | single | int scalar count |
m.get.storage_unit.evaporation_factor(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.id(ids=None, format=None) | user | str | single | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.initial_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.invert_elevation(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.max_depth(ids=None, format=None) | user | float | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.seepage_loss(ids=None, format=None) | user | float/table | series/table | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.storage_curve(ids=None, format=None) | ref | str | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
m.get.storage_unit.storage_curve_type(ids=None, format=None) | user | enum | series by ID | One ID → scalar/structured value; many/all IDs → NumPy array or one-row DataFrame |
Copy-ready call list:
m.get.storage_unit.area(ids=None, format=None)
m.get.storage_unit.area_coefficient(ids=None, format=None)
m.get.storage_unit.area_constant(ids=None, format=None)
m.get.storage_unit.area_exponent(ids=None, format=None)
m.get.storage_unit.count(ids=None, format=None)
m.get.storage_unit.evaporation_factor(ids=None, format=None)
m.get.storage_unit.id(ids=None, format=None)
m.get.storage_unit.initial_depth(ids=None, format=None)
m.get.storage_unit.invert_elevation(ids=None, format=None)
m.get.storage_unit.max_depth(ids=None, format=None)
m.get.storage_unit.seepage_loss(ids=None, format=None)
m.get.storage_unit.storage_curve(ids=None, format=None)
m.get.storage_unit.storage_curve_type(ids=None, format=None)