Click or drag to resize

ICatchmentUrbanData Properties

The ICatchmentUrbanData type exposes the following members.

Properties
  NameDescription
Public propertyAdditionalFlow
Additional constant flow added to the total runoff Unit: [m3/s] Default: 0
(Inherited from ICatchmentData.)
Public propertyArea
Total area of catchment
(Inherited from ICatchmentData.)
Public propertyCatchmentGeometry
Geometry of the catchment. This is a list of coordinates defining a closed polygon as the extent of the catchment.
(Inherited from ICatchmentData.)
Public propertyCatchmentName
Catchment name

The name is not unique, there may be several catchment models for one catchment, however all catchments with the same name should/must share the same catchment geometry.

(Inherited from ICatchmentData.)
Public propertyCenterPoint
The central point of the catchment. Used for e.g. finding the rain time series closest to this catchment.
(Inherited from ICatchmentData.)
Public propertyEndTime Obsolete.
End time of catchment simulation - the latest time for which the catchment can return data
(Inherited from ICatchmentData.)
Public propertyEvaporationFromTimeSeries
True if evaporation is enabled, and an evaporation boundary has been defined.

If set to false the initial recover rate is used during dry periods. Default: False

Public propertyGlobalDryDepthLimit
Dry depth used for switching Horton's mode between dry and wet in Kinematic Wave model: when InfiltrationAfterRain == true In this case the switching to regeneration of infiltration capacity is controlled by a low limit of the water depth on the surface. (from ini file) Unit: [m] Default: 1e-6
Public propertyInfiltrationAfterRain
True if infiltration shall occur also after rain Default: True
Public propertyInitialLossRecoveryRate
Recovery rate for initial loss capacity. The initial loss capacity is regenerated in dry periods by a linear recovery rate.

Used as constant evaporation, when evaporation is not defined explicitly. If evaporation is defined explicitly (see EvaporationFromTimeSeries), this is neglected.

For some catchment models it is only applied under dry conditions.

Unit: [m/s] Default: 0.00005 [m/hour]

Public propertyModelId
Catchment model ID. Unique id.
(Inherited from ICatchmentData.)
Public propertyName Obsolete.
Catchment model ID. Unique id.
(Inherited from ICatchmentData.)
Public propertyObservedData
Observed data. Used for creating calibration plots and for auto-calibration reference data.
(Inherited from ICatchmentData.)
Public propertyPersons
Number of person equivalent in the catchment, used with catchment discharge source boundary
(Inherited from ICatchmentData.)
Public propertySnowMeltCoefficient
Snow melt coefficient. Note: the snow melt coefficient is not in SI unit, because the temperature is assumed to be in degres Celcius. Unit: [m/degCelcius/s]
Public propertyStartTime Obsolete.
Start time of catchment simulation - the earliest time for which the catchment can return data
(Inherited from ICatchmentData.)
Public propertyStormWaterLIDs
StormWater LIDs connected to catchment
(Inherited from ICatchmentData.)
Public propertyTimeStep
Time step used during the simulation by the catchment model
(Inherited from ICatchmentData.)
Public propertyUseHotStartFile
Flag telling if initial conditions is taken from a hotstart file Default: false
(Inherited from ICatchmentData.)
Public propertyUseSnowModule
True if the snow module is activated. If True, a temperature time series has to be provided for the catchment.
Top
See Also