A stormwater LID is a small scale hydrologic structure, that can store, detain, infiltrate (and/or similar) water close to where the water origin from.
The stormwater LID is attached to a catchment. It can overtake some of the catchment area (TotalCollectingArea and Area).
public interface IStormwaterLID| Area |
Area of LID.
This is the area used for rain and evaporation, i.e. if set to 0.5 times the catchment area, then half of the rain falls on the catchment and half of the rain on the LIDs directly. The sum of all Area for all LIDs within a single catchment must be less than the area of the catchment they belong to. For some LIDs (e.g. rain barrel), this area is zero. |
| Areas | A list specifying part of LID area on catchment surfaces. |
| CollectingAreas |
A list specifying LID collecting areas on catchment surfaces.
When entry with the same SurfaceID is also present in Areas then the entry in this list correspond to additional collecting area, which will define collecting surface. This effectively gives that the sum of all collecting areas may be smaller than TotalCollectingArea. |
| Connections | A list specifying connection to other LIDs where the water needs to be transferred. |
| Evaporation | Evaporation in the LID at the current time step Unit: [m/s] |
| FlowStat | Flow statistics and mass balance |
| FractionOfLIDFlowToRoute |
Fraction of runoff flow from the LIDs that are routed by the catchment.
The remainder will be added directly to the catchment runoff (not routed).
The different catchment types may treat this differently. Default value: 1. Unit: [fraction] |
| Infiltration | Infiltration in the LID at the current time step Unit: [m/s] |
| Name | Name of the LID |
| Runoff | Runoff from LID at the current time step Unit: [m3/s] |
| TotalCollectingArea |
Total collecting area is the area from which water is routed through the LIDS,
either because rain is falling directly on the LIDs (Area) or
when catchment rain (after losses) is routed to the LIDs.
This area is used by the catchment to figure out how much water should be
routed to the LIDs, effectively splitting the catchment area in 3 parts:
The TotalCollectingArea cannot be smaller than Area. The sum of all TotalCollectingArea for all LIDs within a single catchment must be less than the area of the catchment they belong to. |
| AddInflow | Add inflow (run-on from catchment to LID) |
| AddToOffers | Add LID offers to provided lists of offers and offer delegates. |
| ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) | Apply a boundary to this catchment |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) | Apply a boundary to this catchment |
| Finish | Finish simulations |
| Initialize | Initialize LID |
| PerformTimeStep(DateTime, DateTime) | Take time step and calculate the rain rate and potential evaporation rate from boundaries |
| PerformTimeStep(DateTime, DateTime, Double, Double) | Take time step with provided rain rate and evaporation rate |
| Prepare | Prepare LID |
| PrepareForTimeStep | Take time step |
| Validate | Validate LID |
| SetSoilMoisture |
Set soil/pavement moisture of lid, independent of type.
If lid does not have a soil/pavement layer, an exception is thrown (Defined by LIDExtension) |
| SetStorageDepth |
Set storage depth of lid, independent of type.
If lid does not have a storage layer, an exception is thrown (Defined by LIDExtension) |
| SetSurfaceDepth |
Set surface depth of lid, independent of type.
If lid does not have a surface layer, an exception is thrown (Defined by LIDExtension) |
| SoilMoisture |
Get soil/pavement moisture of lid, independent of type.
If lid does not have a soil/pavement layer, an exception is thrown (Defined by LIDExtension) |
| StorageDepth |
Get storage depth of lid, independent of type.
If lid does not have a storage layer, an exception is thrown (Defined by LIDExtension) |
| SurfaceDepth |
Get surface depth of lid, independent of type.
If lid does not have a surface layer, an exception is thrown (Defined by LIDExtension) |
| ValidateConnections |
Validate LID surface connections and total routing fraction
(Defined by LIDExtension) |