if disabling the storage by setting Storage.Height to zero,
this effectively models the Rain Garden LID type.
The infiltration to outer soil is in this case the percolation,
Perc.
public class BioRetentionCell : LIDBase,
IStormwaterLIDSurface, IStormwaterLIDSoil, IStormwaterLIDStorage| BioRetentionCell | Initializes a new instance of the BioRetentionCell class |
| 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. (Inherited from LIDBase) |
| Areas |
A list specifying part of LID area on catchment surfaces.
(Inherited from LIDBase) |
| 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. (Inherited from LIDBase) |
| Connections |
A list specifying connection to other LIDs where the water needs to be transferred.
(Inherited from LIDBase) |
| Evaporation |
Evaporation in the LID at the current time step
Unit: [m/s]
(Inherited from LIDBaseOffers) |
| FlowStat | Flow statistics and mass balance (Inherited from LIDBase) |
| 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] (Inherited from LIDBase) |
| HasStorage | Boolean indicating if storage is present (Height is positive) |
| Infiltration |
Infiltration in the LID at the current time step
Unit: [m/s]
(Inherited from LIDBaseOffers) |
| InitialSaturation |
Initial saturation fraction.
For storage, this fraction is used to calculate the initial storage depth. Default value: 0. Unit: [fraction]. (Inherited from LIDBase) |
| Name |
Name of the LID
(Inherited from LIDBase) |
| NumberOfUnits |
Number of LID units handled by this LID instance
(Inherited from LIDBase) |
| ReportPath |
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) |
| Runoff |
Runoff from LID at the current time step
Unit: [m3/s]
(Inherited from LIDBase) |
| Soil | Soil parameters |
| Storage | Storage parameters |
| Surface | Surface parameters |
| 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. (Inherited from LIDBase) |
| Width |
Width of a single unit
Used for routing calculations (Inherited from LIDBase) |
| AddInflow |
Add inflow (run-on from catchment to LID)
(Inherited from LIDBase) |
| AddToOffers |
Add LID offers to provided lists of offers and offer delegates.
(Overrides LIDBaseOffersAddToOffers(IListIQuantity, IListFuncDouble)) |
| ApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource) |
Apply a boundary to this catchment
(Inherited from LIDBase) |
| ApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource) |
Apply a boundary to this catchment
(Inherited from LIDBase) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Finish |
Finish simulations
(Inherited from LIDBase) |
| GetEvapRates |
Computes evaporation rate from layer.
(Inherited from LIDBase) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initialize LID
(Inherited from LIDBase) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| PerformTimeStep(DateTime, DateTime) |
Take time step and calculate the rain rate and potential evaporation rate from boundaries
(Inherited from LIDBase) |
| PerformTimeStep(DateTime, DateTime, Double, Double) |
Take time step with provided rain rate and evaporation rate
(Overrides LIDBasePerformTimeStep(DateTime, DateTime, Double, Double)) |
| Prepare |
Prepare LID
(Overrides LIDBasePrepare(RRParameters, DateTime, DateTime, IDiagnostics)) |
| PrepareForNewReportFile(IDiagnostics) |
Check report file directory and delete existing file, if present.
(Inherited from LIDBase) |
| PrepareForTimeStep |
Take time step
(Overrides LIDBasePrepareForTimeStep) |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
(Overrides LIDBaseReadState(ModelStateReader)) |
| SetInputParameters | Set input parameters (Inherited from LIDBase) |
| StateUpdated |
When state has been updated, this method can be called to update derived/computational variables
(Overrides LIDBaseStateUpdated) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Validate |
Validate LID
(Overrides LIDBaseValidate(IDiagnostics)) |
| WriteState |
Write current state of module
(Overrides LIDBaseWriteState(ModelStateWriter)) |
| _boundarySourceEvaporation | Boundary for evaporation (Inherited from LIDBase) |
| _boundarySourceRainfall | Boundary for rainfall (Inherited from LIDBase) |
| _evapPot | Potential evaporation rate [m/s], from boundary (Inherited from LIDBase) |
| _flowStat | Flow statistics and mass balance (Inherited from LIDBase) |
| _inflow | Inflow [m3/s] (Inherited from LIDBase) |
| _initialSaturation |
Initial saturation fraction.
For storage, this fraction is used to calculate the initial storage depth. Default value: 0. Unit: [fraction]. (Inherited from LIDBase) |
| _rainRate | Rain rate [m/s], from boundary (Inherited from LIDBase) |
| _reportPath |
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) |
| _reportWriter | Result file writer (Inherited from LIDBase) |
| _runoff |
Runoff from LID at the current time step
Unit: [m3/s]
(Inherited from LIDBase) |