IStormwaterInlet Properties

Blockage is the ratio of flow in the inlet that is blocked by debris.

Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage. Unit: [m^2/s]

Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage. Unit: [m^2/s]

Table of Q values in the inlet as a function of depth in the source node.

Calculated Discharge Unit: [m^3/s]

Downstream water level.Downstream refers to the direction of chainge. The water level is set by use of SetWaterLevels Unit: [m]

The discharge (and discharge derivatives) are scaled by the flow factor.

Freeboard is the distance between the invert level of the inlet to the maximum downstream water level. If the downstream water level exceeds the inlet level minus the freeboard, then the inlet functions as an orifice instead of a storm water inlet.

Height of the inlet when it functions as an orifice.

Name of the structure.

Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when reporting errors, warnings and hints.

Flag to control if the structure is implicit or explicit. If the structure is explicit (Implicit == false) then the derivatives of the discharge are always zero. Default value: true

Invert level of the inlet.

Invert level down stream The invert level is the level where water starts flowing in to the structure from the downstream side. It does not necessarily flow through the structure.

Invert level up stream. The invert level is the level where water starts flowing in to the structure from the upstream side. It does not necessarily flow through the structure.

Length of the structure. Unit: [m]

Location of structure.

Number of inlets. The flow through the Stormwater Inlet structure is the flow through a single inlet multiplied by the number of inlets.

When true then the stormwater inlet is of the OnGrade type where inlet discharge is a function of the upstream discharge and the slope of the upstream reaches. If false, then the inlet discharge is a function of the upstream water level.

List of Q values in the inlet as a function of q in the source pipe.

The getter is used to get a list of errors. OBSOLETE

Bank side that side-structure is located on

If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined).

Reservoir at end of side structure. Null if not side structure, or no reservoir is defined

List of slopes in the source pipe. These slopes are matching the values in the QqRelations.

Type of structure

TopoID used when structure is searching for neighboring cross sections in the reach.

Structure type, unique for each type of structure.

Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of SetWaterLevels Unit: [m]

If UserDefinedSlope is set, then this value is used for the slope of the source pipe instead of the actual slope from the network geometry.

Set to MinValue to disable the use of it.

Width of the inlet when it functions as an orifice