Click or drag to resize

BioRetentionCell Properties

The BioRetentionCell type exposes the following members.

Properties
  NameDescription
Public propertyArea
Area covered by LID. Accumulated for all LID units handled by this instance.

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.

(Inherited from LIDBase.)
Public propertyFlowStat
Flow statistics and mass balance
(Inherited from LIDBase.)
Public propertyFractionOfLIDFlowToRoute
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]

(Inherited from LIDBase.)
Public propertyHasStorage
Boolean indicating if storage is present (Height is positive)
Public propertyInitialSaturation
Initial saturation fraction.

For storage, this fraction is used to calculate the initial storage depth.

Default value: 0. Unit: [fraction].

(Inherited from LIDBase.)
Public propertyName
Name/Id of LID
(Inherited from LIDBase.)
Public propertyNumberOfUnits
Number of LID units handled by this LID instance
(Inherited from LIDBase.)
Public propertyReportPath
Path and name for report file.

If null or empty, no report file is created.

Use only for testing and validating model - file can become quite big.

(Inherited from LIDBase.)
Public propertyRunoff (Inherited from LIDBase.)
Public propertySoil
Soil parameters
Public propertyStorage
Storage parameters
Public propertySurface
Surface parameters
Public propertyTotalCollectingArea
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:

catchment-No-LID-Area       = ICatchment.Area - sum(IStormwaterLID.TotalCollectingArea)
catchment-Route-To-LID-Area = sum(IStormwaterLID.TotalCollectingArea - IStormwaterLID.Area)
LID-area                    = sum(IStormwaterLID.Area)
The sum of all 3 contributions is the area of the catchment.

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.

(Inherited from LIDBase.)
Public propertyWidth
Width of a single unit

Used for routing calculations

(Inherited from LIDBase.)
Top
See Also