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]

Get and set the list of coordinates of the catchment

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.

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 Component Source provides info on concentration of various components.

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.

End time of catchment data - the latest time for which the catchment can return data

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 time series filename.

Item to use in HydrographTsFileName 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

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.

Catchment model ID. Unique id.

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

Runoff.

Unit: [m3/s]

This is a computational variable. Setting this has no effect (apart from when writing initial conditions to result file)

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

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

Return dictionary of runoff as a function of year