CatchmentUHM Class

Contructor of the UHM rainfall runoff model.

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

Apply a boundary to this catchment

Apply a boundary to this catchment

Apply boundary to LID's in catchment

Apply boundary to LID's in catchment

Return true if boundaries of the specified type are additive; the contributions of two discharge boundaries add up, while two temperature boundaries do not.

Calculate statistics.

Called at end of each time step, by PerformTimeStep

Calculate and update yearly statistics, YearlyRunoff.

Called at end of each time step, in PerformTimeStep

Determines whether the specified object is equal to the current object.

Destructor

Serves as a hash function for a particular type.

Get the type of boundary required by this catchment

Gets the Type of the current instance.

This procedure initializes all the state variables declared for the catchment.

Initialize Rainfall Runoff model. Sets up static data.

Creates a shallow copy of the current Object.

This procedure forwards the calculation with one time step.

Prepare Rainfall Runoff model. Sets up dynamic data so that the model is ready for first time step.

Prepare boundary source.

Prepare state for new simulation.

Remove boundaries applied in previous runs

When state has been updated, this method can be called to update derived/computational variables

Take an UHM rainfall runoff time step

List of data types that is accepted and can be used in SetValue

List of data types that is offered and can be used in GetValue

Return the time of next update. Used for PostTimeStepEvent event in Catchments. If a catchment uses variable timesteps, then this function must be overridden!!

Get value setter for the specified data quantity

Get value setter for the specified data quantity

Get value setter for the specified data quantity

Get value setter for the specified data type

Returns a string that represents the current object.

This routine stores the calculated variables in variables ready for export. The values in these state variable corresponds to the values written to the result file. All discharge variables are subject to a unit conversion. During the calculation discharges are calculated using the unit mm/hour and must therefor be converted into m3/s.

Trigger the PostTimeStepEvent, called at end of a time step.

The type of catchment: NAM, Urban A etc

Update internal state of catchment to time Time()

Validate the UHM runoff model

Validate all LIDs in catchment

Volume of water stored in catchment after previous TakeTimeStep()

Volume of water stored in catchment after previous TakeTimeStep()

Event that is triggered every time the catchment has finished a new time step

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

Additional constant flow at start of time step

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

Evaporation boundary source

Rainfall boundary source

Temperature boundary source

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

Protected end time of catchment data - the latest time for which the catchment can return data

Maximum flow

Minimum flow

Proteced MinTime

List of datatypes offered in GetValue

Rainfall that must be applied during the calculation time step measured in m/s. unit: [m/s]

Diagnostics instance for a Catchment. Used during runtime.

Protected start time of catchment data - the earliest time for which the catchment can return data

State variables in catchment

List of Lids

Variable holding information on the latest calulated time

Last time the state of this catchment was updated (Update(DateTime) was called)

Time of maximum flow

Time of minimum flow

Variable holding information on the latest calulated time

Time step used in the simulation, or initial time step if the time step can change.

Fraction of time between prev time and current time for the last call to Update(DateTime). This should be updated everytime _timeOfLastUpdate is updated.

Total volume of additional inflow

Total volume of loss

Total volume of rain

Total volume of runoff

TSBuffer to use when accessing time series objects Set in Catchments.Add(). If not set, then the inheritors must create a TSBuffer before using it.

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

Dictionary of runoff as a function of year