Set: Nodes | swmmx Documentation

Setter Reference: Nodes

Rendered from 12_all_set_functions.ipynb.

Nodes

`node`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.node.coordinate(value, ids=None)`	user	coordinates	One coordinate pair per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.node.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.node.depth(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.dry_weather_flow(value, ids=None)`	ref/mixed	table	One structured `table` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.node.external_inflow(value, ids=None)`	ref/mixed	table	One structured `table` value per selected ID	Writable reference; target IDs are validated where possible
`m.set.node.flooding(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.head(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.initial_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.invert_elevation(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.lateral_inflow(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.max_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.overflow(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.pollutant_concentration(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.ponded_area(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.surcharge_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.tag(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.node.total_inflow(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter
`m.set.node.treatment(value, ids=None)`	user	expression/table	One structured `expression/table` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.node.type(value, ids=None)`	derived	enum	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.node.volume(value, ids=None)`	result	float	Read-only; setter raises `ReadOnlyParameterError`	Read-only `result` parameter

Copy-ready call list:

m.set.node.coordinate(value, ids=None)
m.set.node.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.depth(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.dry_weather_flow(value, ids=None)
m.set.node.external_inflow(value, ids=None)
m.set.node.flooding(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.head(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.id(value, ids=None)
m.set.node.initial_depth(value, ids=None)
m.set.node.invert_elevation(value, ids=None)
m.set.node.lateral_inflow(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.max_depth(value, ids=None)
m.set.node.overflow(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.pollutant_concentration(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.ponded_area(value, ids=None)
m.set.node.surcharge_depth(value, ids=None)
m.set.node.tag(value, ids=None)
m.set.node.total_inflow(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.treatment(value, ids=None)
m.set.node.type(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.node.volume(value, ids=None)  # read-only: raises ReadOnlyParameterError

`junction`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.junction.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.junction.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.junction.initial_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.junction.invert_elevation(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.junction.max_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.junction.ponded_area(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.junction.surcharge_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.junction.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.junction.id(value, ids=None)
m.set.junction.initial_depth(value, ids=None)
m.set.junction.invert_elevation(value, ids=None)
m.set.junction.max_depth(value, ids=None)
m.set.junction.ponded_area(value, ids=None)
m.set.junction.surcharge_depth(value, ids=None)

`outfall`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.outfall.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.outfall.fixed_stage(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.outfall.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.outfall.invert_elevation(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.outfall.route_to(value, ids=None)`	ref	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.outfall.tidal_curve(value, ids=None)`	ref	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.outfall.tide_gate(value, ids=None)`	user	bool	`bool` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.outfall.time_series(value, ids=None)`	ref	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.outfall.type(value, ids=None)`	user	enum	`enum` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.outfall.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.outfall.fixed_stage(value, ids=None)
m.set.outfall.id(value, ids=None)
m.set.outfall.invert_elevation(value, ids=None)
m.set.outfall.route_to(value, ids=None)
m.set.outfall.tidal_curve(value, ids=None)
m.set.outfall.tide_gate(value, ids=None)
m.set.outfall.time_series(value, ids=None)
m.set.outfall.type(value, ids=None)

`flow_divider`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.flow_divider.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.flow_divider.cutoff_flow(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.diversion_curve(value, ids=None)`	ref	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.flow_divider.diverted_link(value, ids=None)`	ref	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.flow_divider.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.initial_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.invert_elevation(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.max_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.ponded_area(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.surcharge_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.type(value, ids=None)`	user	enum	`enum` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.weir_coefficient(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.flow_divider.weir_height(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.flow_divider.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.flow_divider.cutoff_flow(value, ids=None)
m.set.flow_divider.diversion_curve(value, ids=None)
m.set.flow_divider.diverted_link(value, ids=None)
m.set.flow_divider.id(value, ids=None)
m.set.flow_divider.initial_depth(value, ids=None)
m.set.flow_divider.invert_elevation(value, ids=None)
m.set.flow_divider.max_depth(value, ids=None)
m.set.flow_divider.ponded_area(value, ids=None)
m.set.flow_divider.surcharge_depth(value, ids=None)
m.set.flow_divider.type(value, ids=None)
m.set.flow_divider.weir_coefficient(value, ids=None)
m.set.flow_divider.weir_height(value, ids=None)

`storage_unit`

Kind: Object collection

Setter	Source	Declared type	Value input	Behavior
`m.set.storage_unit.area(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.area_coefficient(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.area_constant(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.area_exponent(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.count(value, ids=None)`	derived	integer	Read-only; setter raises `ReadOnlyParameterError`	Read-only `derived` parameter
`m.set.storage_unit.evaporation_factor(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.id(value, ids=None)`	user	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.initial_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.invert_elevation(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.max_depth(value, ids=None)`	user	float	`float` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.seepage_loss(value, ids=None)`	user	float/table	One structured `float/table` value per selected ID	Writable; scalar inputs broadcast across selected IDs
`m.set.storage_unit.storage_curve(value, ids=None)`	ref	str	`str` scalar, or 1D vector/Series matching selected IDs	Writable reference; target IDs are validated where possible
`m.set.storage_unit.storage_curve_type(value, ids=None)`	user	enum	`enum` scalar, or 1D vector/Series matching selected IDs	Writable; scalar inputs broadcast across selected IDs

Copy-ready call list:

m.set.storage_unit.area(value, ids=None)
m.set.storage_unit.area_coefficient(value, ids=None)
m.set.storage_unit.area_constant(value, ids=None)
m.set.storage_unit.area_exponent(value, ids=None)
m.set.storage_unit.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.storage_unit.evaporation_factor(value, ids=None)
m.set.storage_unit.id(value, ids=None)
m.set.storage_unit.initial_depth(value, ids=None)
m.set.storage_unit.invert_elevation(value, ids=None)
m.set.storage_unit.max_depth(value, ids=None)
m.set.storage_unit.seepage_loss(value, ids=None)
m.set.storage_unit.storage_curve(value, ids=None)
m.set.storage_unit.storage_curve_type(value, ids=None)