CatchmentAbstractUrban Class

Constructor for abstract urban class

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

Evaporation boundary

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.

Get and set the central point of the catchment

A Component Source provides info on concentration of various components.

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.

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

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

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]

True if the Integrated Horton method is used in the calculation for infiltration. Default: False

Load per inhabitant. Unit: [-]

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.

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: [-]

Runoff.

Unit: [m3/s]

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

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 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.

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

Apply snow module if activated, and update _actRainDepth.

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 on catchment. TODO: Consider moving this to individual catchments to increase performance (avoid using _stateVariables). TODO: Consider moving this out of Catchments class and into seperate class, for generic handling of all catchments

Update the yearly statistics.

Called at end of every time step.

Create offers, populating _offers and _offerDelegates

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.

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, especially time

Remove boundaries applied in previous runs

This procedure is the one actually calculating the new 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.

Transfer current state to state N. First thing to do when starting a timestep.

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 that the catchment is set up correctly

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

Actual evaporation Unit: [m/s]

Actual evaporation at time N, Unit: [m/s]

Actual infiltration, loss. Unit: [m/s]

Infiltration at time N. Unit: [m/s]

Actual rain depth. Unit: [m]

Actual rain intensity. Unit: [m/s]

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

True if infiltration shall occur also after rain, used in Horton infiltration depth calculation from INI file Default: True

Evaporation boundary source

Rainfall boundary source

Temperature boundary source

True if the snow module is activated.

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

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

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

Global dry depth limit from INI file in Kinematic wave: used when InfiltrationAfterRain == true Default: 1e-6 Unit: [m]

Maximum value of InitialLossStorageDepth Unit: [m] Default:

Initial loss recover rate Unit: [m/s] Default: 5e-5 m/h = 1.2 mm/day

Initial loss storage depth. Unit: [m]

Initial loss storage depth at time N. Unit: [m]

Loss, other than infiltration which goes into _actInfiltration (in another unit). Unit [m3/s]

Loss at time N. Unit: [m/s]

Maximum flow

Minimum flow

Proteced MinTime

List of delegates, matching list of _offers

List of datatypes offered in GetValue

Potential evaporation Unit: [m/s]

Potential evaporation at time N. Unit: [m/s]

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

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

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

Runoff. Unit: [m3/s]

Runoff at time N. Unit: [m3/s]

Diagnostics instance for a Catchment. Used during runtime.

Snow storage Unit: [m]

Snow storage at time N. Unit: [m]

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

List of Lids

Temperature that must be applied during the calculation time step. Note: the temperature is given in degres Celcius, which is not SI unit! unit: [degCelcius]

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