Click or drag to resize

RainBarrel Class

Rain Barrels are containers that collect roof runoff during storm events and can either release or re-use the rain water during dry periods.
Inheritance Hierarchy
SystemObject
  DHI.Mike1D.RainfallRunoffModule.LIDRainBarrel

Namespace:  DHI.Mike1D.RainfallRunoffModule.LID
Assembly:  DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
Copy
public class RainBarrel : IStormwaterLID, IStormwaterLIDFlowStat

The RainBarrel type exposes the following members.

Constructors
  NameDescription
Public methodRainBarrel
Initializes a new instance of the RainBarrel class
Top
Properties
  NameDescription
Public propertyBarrelArea
Area of (all) barrels handled by this instance.
Public propertyFlowStat
Flow statistics and mass balance
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]

Public propertyInitialSaturation
Initial saturation fraction.

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

Default value: 0. Unit: [fraction].

Public propertyName
Name of the LID
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.

Public propertyRunoff
Current runoff from LID [m3/s]
Public propertyStorage
Storage of barrel
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:

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.

Top
Methods
  NameDescription
Public methodAddInflow
Add inflow (run-on from catchment to LID)
Public methodApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)
No effect, rain barrels does not accept any boundaries
Public methodApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)
No effect, rain barrels does not accept any boundaries
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFinish
Finalize
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initialize LID ///
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPerformTimeStep
Take time step
Public methodPrepare
Prepare LID
Public methodPrepareForTimeStep
Take time step
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validate LID ///
Top
Fields
  NameDescription
Protected field_flowStat
Flow statistics and mass balance
Protected field_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.

Top
Extension Methods
  NameDescription
Public Extension MethodSetSoilMoisture
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.)
Public Extension MethodSetStorageDepth
Set storage depth of lid, independent of type.

If lid does not have a storage layer, an exception is thrown

(Defined by LIDExtension.)
Public Extension MethodSetSurfaceDepth
Set surface depth of lid, independent of type.

If lid does not have a surface layer, an exception is thrown

(Defined by LIDExtension.)
Public Extension MethodSoilMoisture
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.)
Public Extension MethodStorageDepth
Get storage depth of lid, independent of type.

If lid does not have a storage layer, an exception is thrown

(Defined by LIDExtension.)
Public Extension MethodSurfaceDepth
Get surface depth of lid, independent of type.

If lid does not have a surface layer, an exception is thrown

(Defined by LIDExtension.)
Top
See Also