StormwaterInlet Properties |
The StormwaterInlet type exposes the following members.
Name | Description | |
---|---|---|
Blockage |
Blockage is the ratio of flow in the inlet that is blocked by debris.
| |
dDischargedDownStreamWaterLevel |
Calculated Discharge derivative with DownStreamWaterLevel. Downstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) | |
dDischargedUpStreamWaterLevel |
Calculated Discharge derivative with UpStreamWaterLevel. Upstream is relative to the direction of chainage.
The value is calculated by SetWaterLevels.
Unit: [m^2/s]
(Inherited from Structure.) | |
DepthQRelation |
Table of Q values in the inlet as a function of depth in the source node.
| |
Discharge |
Calculated Discharge. The value is calculated by SetWaterLevels.
Unit: [m^3/s]
(Inherited from Structure.) | |
DownstreamWaterLevel |
Downstream water level.Downstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
ExtensionData |
Property used by (de)serializer, when it can not find proper target for
a data field. Support of forward compatible data contracts.
(Inherited from Structure.) | |
FlowArea |
Flow area through structure. Used by most (but not all) structures.
(Inherited from Structure.) | |
FlowFactor |
The discharge (and discharge derivatives) are scaled by the flow factor.
(Inherited from Structure.) | |
Freeboard |
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 |
Height of the inlet when it functions as an orifice.
| |
ID |
Structure ID
(Inherited from Structure.) | |
IDInUserUnit |
Used to get a consistent description of the structure. The ID comes in user units. Used e.g. when
reporting errors, warnings and hints.
(Inherited from Structure.) | |
Implicit |
Flag to control if the structure is implicit or explicit. If the structure is explicit
(Implicit == false) then the derivatives of the dicharge are always zero.
Default value: true
(Inherited from Structure.) | |
InvertLevel |
Invert level of the inlet.
| |
InvertLevelDownstream |
Invert level down stream
(Overrides StructureInvertLevelDownstream.) | |
InvertLevelUpstream |
Invert level up stream
(Overrides StructureInvertLevelUpstream.) | |
Length |
Length of the structure.
Unit: [m]
Default value: 0m
(Inherited from Structure.) | |
Location |
Location property.
(Inherited from Structure.) | |
NumberOfInlets |
Number of inlets. The flow through the Stormwater Inlet structure is the flow through a single inlet
multiplied by the number of inlets.
Default: 1.
| |
OnGradeInlet |
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.
| |
QqRelations |
List of Q values in the inlet as a function of q in the source pipe.
| |
RunTimeDiagnostics |
The getter is used to get a list of errors.
(Inherited from Structure.) | |
SideStructureBank |
Bank side that side-structure is located on
(Inherited from Structure.)If side structure contains reservoir, and has the Coordinate set, this is not used (and should be set to Undefined). | |
SideStructureReservoir |
Reservoir at end of side structure. Null if not side structure, or no reservoir is defined
(Inherited from Structure.) | |
Slopes |
List of slopes in the source pipe. These slopes are matching the values in the QqRelations.
| |
SourceDischargeGetter |
Getter for the discharge through the source node.
| |
StructureType |
Type of structure
(Inherited from Structure.) | |
TopoID |
String used to identified cross sections
(Inherited from Structure.) | |
Type |
Structure type, unique for each structure.
(Overrides StructureType.) | |
UpstreamWaterLevel |
Upstream water level. Upstream refers to the direction of chainage. The water level is set by use of
SetWaterLevels
Unit: [m]
(Inherited from Structure.) | |
UserDefinedSlope |
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 |
Width of the inlet when it functions as an orifice
|