CatchmentTimeArea Properties

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

Parameter that allows or not to advance the time during dry period.

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

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

Evaporation boundary

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 CatchmentTimeAreaCell sorted from downstream to upstream.

State is contained inside each CatchmentTimeAreaCell

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.

Concentration time used to defined the number of cells of this catchment. Unit: [s]

Current time of catchment

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.

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

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. Unit: [m] Default: 1e-6

The impervious area is a factor which defines the part of the catchment considered to contribute to the runoff. Unit: [-]

True if infiltration shall occur also after rain Default: True

Maximum value of InitialLossStorageDepth Unit: [m]

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.

Unit: [m/s] Default: 0.00005 [m/hour] = 1.2 [mm/day]

Initial loss storage depth.

State variable (not for all derived catchment models)

Unit: [m]

Load per inhabitant. Unit: [-]

Maximum runoff flow

The Time Area method to be used: TimeAreaCurve corresponds to 1 TimeAreaFunction corresponds to 2

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.

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

Hydrological reduction coeeficient. The runoff reduction factor, accounts for water losses caused by e.g evapo-transpiration, imperfect imperviousness, etc. on the contributing area. Unit: [-]

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

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

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]

Snow storage

State variable

Only applicable when UseSnowModule is set.

Unit: [m]

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

List of Lids

Time Area curve coefficient, used by TA function

Time area curve, user defined, must be specified in case TimeAreaCurveType is UserDefined.

The curve is dimensionless, time (X) values between 0 and 1 and area (Y) values between 0 and 1.

Time area curve type.

If set to UserDefined, the actual curve must be specified in the TimeAreaCurve table. All other values indicate predefined curves.

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

True if the snow module is activated. If True, a temperature time series has to be provided for the catchment.

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

Return dictionary of runoff as a function of year

Dictionary of statistics as a function of year