Setter Reference: Hydraulic Geometry and Water Quality

Rendered from 12_all_set_functions.ipynb.

Inlets and hydraulic geometry

street

Kind: Object collection

Copy-ready call list:

Copym.set.street.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.street.cross_slope(value, ids=None)
m.set.street.crown_width(value, ids=None)
m.set.street.curb_height(value, ids=None)
m.set.street.depression_storage(value, ids=None)
m.set.street.gutter_slope(value, ids=None)
m.set.street.gutter_width(value, ids=None)
m.set.street.id(value, ids=None)
m.set.street.roughness(value, ids=None)
m.set.street.spread(value, ids=None)  # read-only: raises ReadOnlyParameterError

inlet

Kind: Object collection

Copy-ready call list:

Copym.set.inlet.captured_flow(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.inlet.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.inlet.curb_height(value, ids=None)
m.set.inlet.curb_length(value, ids=None)
m.set.inlet.grate_length(value, ids=None)
m.set.inlet.grate_type(value, ids=None)
m.set.inlet.grate_width(value, ids=None)
m.set.inlet.id(value, ids=None)
m.set.inlet.slotted_length(value, ids=None)
m.set.inlet.slotted_width(value, ids=None)
m.set.inlet.type(value, ids=None)

inlet_usage

Kind: Object collection

Copy-ready call list:

Copym.set.inlet_usage.clogging_factor(value, ids=None)
m.set.inlet_usage.conduit(value, ids=None)
m.set.inlet_usage.flow_restriction(value, ids=None)
m.set.inlet_usage.inlet(value, ids=None)
m.set.inlet_usage.node(value, ids=None)
m.set.inlet_usage.number(value, ids=None)

transect

Kind: Object collection

Copy-ready call list:

Copym.set.transect.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.transect.elevations(value, ids=None)
m.set.transect.id(value, ids=None)
m.set.transect.left_bank(value, ids=None)
m.set.transect.modifiers(value, ids=None)
m.set.transect.right_bank(value, ids=None)
m.set.transect.roughness_channel(value, ids=None)
m.set.transect.roughness_left(value, ids=None)
m.set.transect.roughness_right(value, ids=None)
m.set.transect.stations(value, ids=None)

Water quality

pollutant

Kind: Object collection

Copy-ready call list:

Copym.set.pollutant.co_pollutant(value, ids=None)
m.set.pollutant.co_pollutant_fraction(value, ids=None)
m.set.pollutant.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.pollutant.decay_coefficient(value, ids=None)
m.set.pollutant.dry_weather_flow_concentration(value, ids=None)
m.set.pollutant.groundwater_concentration(value, ids=None)
m.set.pollutant.id(value, ids=None)
m.set.pollutant.initial_concentration(value, ids=None)
m.set.pollutant.rain_concentration(value, ids=None)
m.set.pollutant.rdii_concentration(value, ids=None)
m.set.pollutant.snow_only(value, ids=None)
m.set.pollutant.units(value, ids=None)

land_use

Kind: Object collection

Copy-ready call list:

Copym.set.land_use.count(value, ids=None)  # read-only: raises ReadOnlyParameterError
m.set.land_use.id(value, ids=None)
m.set.land_use.last_swept(value, ids=None)
m.set.land_use.sweeping_availability(value, ids=None)
m.set.land_use.sweeping_interval(value, ids=None)

coverage

Kind: Object collection

Copy-ready call list:

Copym.set.coverage.land_use(value, ids=None)
m.set.coverage.percent(value, ids=None)
m.set.coverage.subcatchment(value, ids=None)

loading

Kind: Object collection

Copy-ready call list:

Copym.set.loading.initial_buildup(value, ids=None)
m.set.loading.pollutant(value, ids=None)
m.set.loading.subcatchment(value, ids=None)

buildup

Kind: Object collection

Copy-ready call list:

Copym.set.buildup.function(value, ids=None)
m.set.buildup.land_use(value, ids=None)
m.set.buildup.maximum_buildup(value, ids=None)
m.set.buildup.normalizer(value, ids=None)
m.set.buildup.pollutant(value, ids=None)
m.set.buildup.power(value, ids=None)
m.set.buildup.rate_constant(value, ids=None)

washoff

Kind: Object collection

Copy-ready call list:

Copym.set.washoff.bmp_efficiency(value, ids=None)
m.set.washoff.cleaning_efficiency(value, ids=None)
m.set.washoff.coefficient(value, ids=None)
m.set.washoff.exponent(value, ids=None)
m.set.washoff.function(value, ids=None)
m.set.washoff.land_use(value, ids=None)
m.set.washoff.pollutant(value, ids=None)

treatment

Kind: Object collection

Copy-ready call list:

Copym.set.treatment.expression(value, ids=None)
m.set.treatment.node(value, ids=None)
m.set.treatment.pollutant(value, ids=None)