CatchmentUHM Properties

Accumulated rain since start of simulation. Used for loss calculations.

State variable.

Unit: [m]

Additional constant flow added to the total runoff Unit: [m3/s] Default: 0

Stream Slope used for the Alameda SUH calculations Unit: [-]

Watershed Coefficient is the Basin factor used for the Alameda SUH calculations Unit: [-]

Antecedant Moisture Condition number. Used by the SCSLoss method.

State variable.

Total area of catchment Type: Catchment area Unit: [m2] Default: 1e8 (100 km2)

Full area of catchment Type: Catchment area Unit: [km2] Default: 100

Area reduction fator Unit: [-]

Base flow Unit: [m3/s]

Rainfall boundary source

Get and set the list of coordinates of the catchment

A overall data interface for cathcment data, containing data properties that are common for all catchments.

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.

List of CatchmentUHMCell sorted from downstream to upstream.

The first cell will discharge in the coming time step, the second cell in two time steps, etc. So each cell is one timestep further from discharging. The time offset for a cell is the number (index+1) of the cell in this list times the time step size.

State is contained inside each CatchmentUHMCell

Created during prepare

Get and set the central point of the catchment

A set of check points in time that must be hit by the catchments.

Constant loss Unit: [m/s]

Current time of catchment

Curve number Unit: [-]

Rain within 24 hours, reset every 24 hours. Used for loss calculations

State variable. Only applicable for the SCS loss models

Unit: [m]

Effective area. The effective area is the area that collects water. Can be smaller than total area, eg for Linear Reservoir or when LIDs are present.

Time step used in the simulation, it may change. It is set initially in Prepare to TimeStep, and can be updated by individual catchment models when required, i.e. it may differ from TimeStep.

Return the end time of the catchment simulation. This is set during prepare, and the catchment must make sure not to run beyond this time.

Excess rain within 24 hours, reset every 24 hours. Used for loss calculations

State variable. Only applicable for the SCS loss models

Unit: [m]

User defined hydrograph.

Enabled when HydrographType is UserDefined.

Set to null to use instead the HydrographTsFile and HydrographTsItemNumber

User defined hydrograph time series filename.

User defined hydrograph time series filename.

Item to use in HydrographTsFile Note: this index is 1-based

Define the type of hydrograph to be used for this catchment CatchmentUHMHydrographTypes

Initial abstraction depth Unit: [m]

Antecedant Moisture Conditions Unit: [-]

Initial loss Unit: [m]

Lag time Unit: [s]

Curve number used in the lag time calculations Unit: [-]

Lag time calculation type

For the SUH the length represents the length of the main stream from the outlet to the dicide Unit: [m]

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: [-]

Loss model type

Maximum runoff flow

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.

Minimum runoff flow

Minimum time the catchment should be able to provide values. The catchment will cache or recalculate values from MinTime to EndTime. MinTime must be updated ("dragged behind" time of calculation) from the caller to allow the catchment to discard cached values.

A overall data interface for cathcment data, containing data properties that are common for all catchments.

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.

Observed data. Used for creating calibration plots and for auto-calibration reference data.

Peaking coefficient used by SUH standard hydrograph model Unit: [-]

Number of person equivalent in the catchment, used with catchment discharge source boundary

Total runoff from catchment at present time step. Unit: [m^3/s]

Runoff coefficient used in proportional loss method Unit: [-]

Get the Diagnostics instance for a Catchment. Used during runtime.

Slope of the catchment Unit: [-]

Start time of catchment data - the earliest time for which the catchment can return data

List of Lids

Time of minimum runoff flow

Time of maximum runoff flow

Time step used by the catchment model

Total volume of additional inflow

Total infiltration into this catchment (integrated over time)

Total rainfall on this catchment (integrated over time)

Total runoff from this catchment (integrated over time)

Set the TSBuffer to use in this catchment

Flag telling if initial conditions is taken from a hotstart file Default: false

Volume of water added to catchment after a time step. This water will be eventually routed.

Watershed Coefficient is the Basin factor used for the standard SUH calculations Unit: [-]

Return dictionary of runoff as a function of year

Dictionary of statistics as a function of year