Click or drag to resize

LIDBase Class

Base class for LID classes, holding commom parameters and functionality.
Inheritance Hierarchy

Namespace:  DHI.Mike1D.RainfallRunoffModule.LID
Assembly:  DHI.Mike1D.RainfallRunoffModule (in DHI.Mike1D.RainfallRunoffModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public abstract class LIDBase : IStormwaterLIDFlowStat

The LIDBase type exposes the following members.

Constructors
  NameDescription
Protected methodLIDBase
Initializes a new instance of the LIDBase class
Top
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.

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/Id of LID
Public propertyNumberOfUnits
Number of LID units handled by this LID instance
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
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.

Public propertyWidth
Width of a single unit

Used for routing calculations

Top
Methods
  NameDescription
Public methodAddInflow
Add inflow (run-on from catchment to LID)
Public methodApplyBoundary(CatchmentSourceBoundaryTypes, IBoundarySource)
Apply a boundary to this catchment
Public methodApplyBoundary(GlobalSourceBoundaryTypes, GlobalGeoLocatedSource)
Apply a boundary to this catchment
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
Finish simulations
Protected methodGetEvapRates
Computes evaporation rate from layer.
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
Public methodStatic memberLimit
Limit val between minValue and maxValue
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare
Protected methodPrepareForNewReportFile(IDiagnostics)
Check report file directory and delete existing file, if present.
Public methodStatic memberPrepareForNewReportFile(IDiagnostics, IFilePath, String)
Check report file directory and delete existing file, if present.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Protected field_boundarySourceEvaporation
Boundary for evaporation
Protected field_boundarySourceRainfall
Boundary for rainfall
Protected field_evapPot
Potential evaporation rate [m/s], from boundary
Protected field_flowStat
Flow statistics and mass balance
Protected field_inflow
Inflow [m3/s]
Protected field_initialSaturation
Initial saturation fraction.

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

Default value: 0. Unit: [fraction].

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.

Protected field_reportWriter
Result file writer
Protected field_runoff
Runoff from LID [m3/s]
Public fieldStatic memberMperSecToMmperHour
Conversion factor from m/s to mm/hour
Top
See Also