This interface contains data and parameters for setting up a UHM model, CatchmentUHM, and is as such a data interface only. Computational variables are not included in this interface. It can be used to explore data and parameters required when setting up the UHM model.
The UHM catchment is based on a unit hydrograph, defined as e.g. Hydrograph, where the time and flow are both dimensionless. The time is scaled such that the peak of the hydrograph matches the lagtime (see LagTimeType), and the flow is scaled to assure no mass loss.
public interface ICatchmentUHMData : ICatchmentData| AdditionalFlow |
Additional constant flow added to the total runoff
Unit: [m3/s]
Default: 0
(Inherited from ICatchmentData) |
| AlamedaStreamSlope | Stream Slope used for the Alameda SUH calculations Unit: [-] |
| AlamedaWatershedFactor | Watershed Coefficient is the Basin factor used for the Alameda SUH calculations Unit: [-] |
| Area |
Total area of catchment
(Inherited from ICatchmentData) |
| AreaReductionFactor | Area reduction fator Unit: [-] |
| BaseFlow | Base flow Unit: [m3/s] |
| 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) |
| ConstantLoss | Constant loss Unit: [m/s] |
| CurveNumber | Curve number Unit: [-] |
| EndTime |
End time of catchment simulation - the latest time for which the catchment can return data
(Inherited from ICatchmentData) |
| Hydrograph |
User defined hydrograph.
Enabled when HydrographType is UserDefined. Set to null to use instead the HydrographTsFile and HydrographTsItemNumber |
| HydrographTsFile |
User defined hydrograph time series file.
Enabled when HydrographType is UserDefined and Hydrograph is null. |
| HydrographTsFileName |
User defined hydrograph time series filename.
Enabled when HydrographType is UserDefined and Hydrograph is null. |
| HydrographTsItemNumber | Item to use in HydrographTsFile Note: this index is 1-based |
| HydrographType | Define the type of hydrograph to be used for this catchment CatchmentUHMHydrographTypes |
| InitialAbstractionDepth | Initial abstraction depth Unit: [m] |
| InitialAMC | Antecedant Moisture Conditions Unit: [-] |
| InitialLoss | Initial loss Unit: [m] |
| LagTime | Lag time Unit: [s] |
| LagTimeCurveNumber | Curve number used in the lag time calculations Unit: [-] |
| LagTimeType | Lag time calculation type |
| Length | For the SUH the length represents the length of the main stream from the outlet to the dicide Unit: [m] |
| LengthToCentroid | 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: [-] |
| LossModel | Loss model type |
| MaxNumberOfCells |
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. |
| 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) |
| PeakingCoefficient | Peaking coefficient used by SUH standard hydrograph model Unit: [-] |
| Persons |
Number of person equivalent in the catchment,
used with catchment discharge source boundary
(Inherited from ICatchmentData) |
| RunoffCoefficient | Runoff coefficient used in proportional loss method Unit: [-] |
| Slope | Slope of the catchment Unit: [-] |
| 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) |
| 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) |
| WatershedCoefficient | Watershed Coefficient is the Basin factor used for the standard SUH calculations Unit: [-] |