This interface contains data and parameters for setting up a catchment model, and represents as such only setup data. Computational variables and methods are not included in this interface. It can be used to explore data and parameters required when setting up the catchment model.
public interface ICatchmentUrbanData : ICatchmentData,
ICatchmentWithSurfaces| AdditionalFlow |
Additional constant flow added to the total runoff
Unit: [m3/s]
Default: 0
(Inherited from ICatchmentData) |
| Area |
Total area of catchment
(Inherited from ICatchmentData) |
| CatchmentGeometry |
Geometry of the catchment. This is a list of coordinates defining a closed polygon as
the extent of the catchment.
(Inherited from ICatchmentData) |
| CatchmentName |
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) |
| CenterPoint |
The central point of the catchment. Used for e.g. finding the
rain time series closest to this catchment.
(Inherited from ICatchmentData) |
| EndTime |
End time of catchment simulation - the latest time for which the catchment can return data
(Inherited from ICatchmentData) |
| EvaporationFromTimeSeries |
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 |
| GlobalDryDepthLimit | 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 |
| InfiltrationAfterRain | True if infiltration shall occur also after rain Default: True |
| InitialLossRecoveryRate |
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] |
| ModelId |
Catchment model ID. Unique id.
(Inherited from ICatchmentData) |
| Name |
Catchment model ID. Unique id.
(Inherited from ICatchmentData) |
| ObservedData |
Observed data. Used for creating calibration plots and for auto-calibration reference data.
(Inherited from ICatchmentData) |
| Persons |
Number of person equivalent in the catchment,
used with catchment discharge source boundary
(Inherited from ICatchmentData) |
| SnowMeltCoefficient | 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] |
| StartTime |
Start time of catchment simulation - the earliest time for which the catchment can return data
(Inherited from ICatchmentData) |
| StatisticsType |
Periodic statistics type for catchments
(Inherited from ICatchmentData) |
| StormWaterLIDs |
StormWater LIDs connected to catchment
(Inherited from ICatchmentData) |
| Surfaces |
Actual computational surfaces.
Typically the same list as SurfacesData. However, after processing may contain more surfaces than in SurfacesData. (Inherited from ICatchmentWithSurfaces) |
| SurfacesData |
List of custom catchment surfaces.
If this list is empty the default surfaces are used. (Inherited from ICatchmentWithSurfaces) |
| TimeStep |
Time step used during the simulation by the catchment model
(Inherited from ICatchmentData) |
| UseHotStartFile |
Flag telling if initial conditions is taken from a hotstart file
Default: false
(Inherited from ICatchmentData) |
| UseSnowModule | True if the snow module is activated. If True, a temperature time series has to be provided for the catchment. |