BioRetentionCell Class

Bio-retention Cells are depressions that comprise vegetation grown in an engineered soil mixture sited above a gravel drainage bed. They offer storage, infiltration and evaporation of both direct rainfall and runoff captured from surrounding areas. Rain gardens, street planters, and green roofs are all different types of bio-retention cells.

if disabling the storage by setting

Copy

Storage.Height

to zero, this effectively models the Rain Garden LID type. The infiltration to outer soil is in this case the percolation, Perc.

Inheritance Hierarchy

SystemObject
DHI.Mike1D.RainfallRunoffModule.LIDLIDBase
DHI.Mike1D.RainfallRunoffModule.LIDBioRetentionCell

Namespace: DHI.Mike1D.RainfallRunoffModule.LID
Assembly: DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 19.0.0.0 (11.1.1.1111)

Syntax

C++

Copy

public class BioRetentionCell : LIDBase, 
	IStormwaterLID, IStormwaterLIDSurface, IStormwaterLIDSoil, IStormwaterLIDStorage

Public Class BioRetentionCell
	Inherits LIDBase
	Implements IStormwaterLID, IStormwaterLIDSurface, IStormwaterLIDSoil, IStormwaterLIDStorage

public ref class BioRetentionCell : public LIDBase, 
	IStormwaterLID, IStormwaterLIDSurface, IStormwaterLIDSoil, IStormwaterLIDStorage

The BioRetentionCell type exposes the following members.

Constructors

	Name	Description
	BioRetentionCell	Initializes a new instance of the BioRetentionCell class

Top

Properties

	Name	Description
	Area	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.)
	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)
	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/Id of 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	(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: Copy 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.)
	Width	Width of a single unit Used for routing calculations (Inherited from LIDBase.)

Top

Methods

	Name	Description
	AddInflow	Add inflow (run-on from catchment to LID) (Inherited from LIDBase.)
	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	(Inherited from LIDBase.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformTimeStep	Take time step
	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
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Validate	Validate LID ///

Top

Fields

	Name	Description
	_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.)
	_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 [m3/s] (Inherited from LIDBase.)

Top

Extension Methods

	Name	Description
	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.)

Top

Reference

DHI.Mike1D.RainfallRunoffModule.LID Namespace