CatchmentState Properties

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

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

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

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.

Get and set the central point of the catchment

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

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.

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.

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

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

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

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.

Return dictionary of runoff as a function of year

Dictionary of statistics as a function of year