Click or drag to resize

ICatchmentUHMData Properties

The ICatchmentUHMData 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 propertyAlamedaStreamSlope
Stream Slope used for the Alameda SUH calculations Unit: [-]
Public propertyAlamedaWatershedFactor
Watershed Coefficient is the Basin factor used for the Alameda SUH calculations Unit: [-]
Public propertyArea
Total area of catchment
(Inherited from ICatchmentData.)
Public propertyAreaReductionFactor
Area reduction fator Unit: [-]
Public propertyBaseFlow
Base flow Unit: [m3/s]
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 propertyConstantLoss
Constant loss Unit: [m/s]
Public propertyCurveNumber
Curve number Unit: [-]
Public propertyEndTime Obsolete.
End time of catchment simulation - the latest time for which the catchment can return data
(Inherited from ICatchmentData.)
Public propertyHydrograph
User defined hydrograph.

Enabled when HydrographType is UserDefined.

Set to null to use instead the HydrographTsFile and HydrographTsItemNumber

Public propertyHydrographTsFile
User defined hydrograph time series file.

Enabled when HydrographType is UserDefined and Hydrograph is null.

Public propertyHydrographTsFileName Obsolete.
User defined hydrograph time series filename.

Enabled when HydrographType is UserDefined and Hydrograph is null.

Public propertyHydrographTsItemNumber
Item to use in HydrographTsFile Note: this index is 1-based
Public propertyHydrographType
Public propertyInitialAbstractionDepth
Initial abstraction depth Unit: [m]
Public propertyInitialAMC
Antecedant Moisture Conditions Unit: [-]
Public propertyInitialLoss
Initial loss Unit: [m]
Public propertyLagTime
Lag time Unit: [s]
Public propertyLagTimeCurveNumber
Curve number used in the lag time calculations Unit: [-]
Public propertyLagTimeType
Lag time calculation type
Public propertyLength
For the SUH the length represents the length of the main stream from the outlet to the dicide Unit: [m]
Public propertyLengthToCentroid
Represents the length of main stream from the outlet to a point nearest the watershed centroid. Used in the calculations of the SUH lag time Unit: [-]
Public propertyLossModel
Loss model type
Public propertyMaxNumberOfCells
Maximum number of cells in hydrograph routing. To disable maximum, set to zero. A sound value is 200-400.

If the maximum is enforced, the advanced routing method will be used. The advanced routing is a higher order advection scheme, AdvectiveTransport.

The advanced routing/advection scheme is computationally somewhat more expensive than the simple routing, so the number of advanced routing cells will be half of MaxNumberOfCells.

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 propertyPeakingCoefficient
Peaking coefficient used by SUH standard hydrograph model Unit: [-]
Public propertyPersons
Number of person equivalent in the catchment, used with catchment discharge source boundary
(Inherited from ICatchmentData.)
Public propertyRunoffCoefficient
Runoff coefficient used in proportional loss method Unit: [-]
Public propertySlope
Slope of the catchment Unit: [-]
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 propertyWatershedCoefficient
Watershed Coefficient is the Basin factor used for the standard SUH calculations Unit: [-]
Top
See Also