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]

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

Apply a boundary to this catchment

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

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 the lag time for the available types: CatchmentUHMLagTimeTypes

Calculate statistics.

Called at end of each time step, by PerformTimeStep

Convert the dimensionless hydrograph (as returned from GetHydrograph(Double, Double, IDiagnostics)) to contain actual times, based on lagtime etc.

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

Destructor

Finalizes the time step for the catchment.

Serves as the default hash function.

Get/create dimensionless hydrograph.

The actualLagTime is updated when using the SUH hydrograph types.

Get the type of boundary required by this catchment

This procedure initialises the SCS dimensionless hydrograph, scales it and stores unit hydrograph values with the time step

Info on the SCS dimentionless hydrograph to be found in: Soil Conservation Service. U.S. Department of Agriculture. Washington D.C. (1972): SCS National Engineering Handbook, Section 4, Hydrology.

Generates a SCS triangular hydrograph.

Snyder Unit Hydrograph as described in reference: "Applied hydrology" ven Te Chow et al. (McGraw Hill) pp. 224-228

Gets the Type of the current instance.

Get the user defined hydrograph. This method loads data from time series.

Get or create a RRYearlyStat object for the specified year.

Initialize Rainfall Runoff model. Sets up static data.

Initializes the cathcment plugins.

Creates a shallow copy of the current Object.

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

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.

Prepares the catchment for the time step.

Prepares the cathcment plugins.

Prepare boundary source.

Prepare state for new simulation.

Write current state of plugins

Read state and apply to module. Returns true if state was successfully read.

Reset the catchment and set the current time.

Remove boundaries applied in previous runs

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

This procedure is the one actually calculating the new time step.

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 getter for the specified data quantity

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()

Updates check point time.

Updates the routing for the catchment.

Updates the storage for the catchment.

Update time, setting _timeNew to _timeOld + _effectiveTimeStep. This method will assue that _timeNew does not go beyond _endTime, by modifying _effectiveTimeStep. Before calling UpdateTime, be sure that _effectiveTimeStep is set.

Updates the present time if it is greater than the check point time.

Validate the UHM runoff model

Validate all LIDs in catchment

Get value setter for the specified data quantity

Volume of water stored in catchment after previous time step.

Volume of water stored in catchment after previous time step.

Write current state of plugins

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

The most recent check point time.

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.

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 flow

Minimum flow

Proteced MinTime

List of delegates, matching list of _offers

List of datatypes offered in GetValue

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

Total runoff from catchment at present time step. Unit: [m^3/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

Losses in [m3/s]

Net rainfall in [m/s]

Total infiltration in [m/s]

Total Runoff in [m3/s]. It includes also AdditionalFlow.

List of Lids

Variable holding information on the latest calculated 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 calculated time

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

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

Volume on ground added after UpdateStorage

Volume on ground after routing

Volume on ground before routing

Dictionary of statistics as a function of year

List of catchment plugins