Click or drag to resize

ICatchmentLinearReservoirData Properties

The ICatchmentLinearReservoirData 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 propertyEffectiveAreaFraction
Effective area (fraction of full area) of the catchement used by the Dutch model Unit: [-]
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

(Inherited from ICatchmentUrbanData.)
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
(Inherited from ICatchmentUrbanData.)
Public propertyImperviousArea
Impervious area for the French model.

For an urban catchment it is also used as a factor which defines the part of the catchment considered to contribute to the runoff.

Unit: [-]

Public propertyInfiltration
True if the infiltration process is inlcuded. Default: False
Public propertyInfiltrationAfterRain
True if infiltration shall occur also after rain Default: True
(Inherited from ICatchmentUrbanData.)
Public propertyInitialLossMax
Maximum value of initial loss magasin depth Unit: [m]
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]

(Inherited from ICatchmentUrbanData.)
Public propertyLagTime
Lag time is the reciprocal equivalent of the linear reservoir time constant used in model FR Unit: [s] default: 300
Public propertyLength
Length of the catchment used in the Lag time calculation if Lagtime is not given by the user. Unit: [m] Default: 10
Public propertyModel
Model type.

NL model corresponds to C1 FR model corresponds to C2

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 propertyReductionFactor
Hydrological reduction coefficient. The runoff reduction factor, accounts for water losses caused by e.g evapo-transpiration, imperfect imperviousness, etc. on the contributing area. Unit: [-]
Public propertySlope
Slope of the catchment used in the Lag time calculation if Lagtime is not given by the user. Unit: [-] Default: 0.001
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]
(Inherited from ICatchmentUrbanData.)
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 propertyTimeConstant
The linear reservoir Time constant used in model NL Unit: [1/s] Default: 3e-3
Public propertyTimeStep
Time step used during the simulation by the catchment model
(Inherited from ICatchmentData.)
Public propertyUrbanCatchment
Flag defining if the catchment is an urban or a rural catchment. If value is undefined, it is automatically determined.

When automatically determined, a catchment is urban when it is French (FR) and has an ImperviousArea factor larger than or equal to 0.2

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.
(Inherited from ICatchmentUrbanData.)
Top
See Also