summary.wateres: Water reservoir summary

In tgmwri/wateres: Characteristics and Simulations for Water Reservoirs

Water reservoir summary

Description

Calculates characteristics of the reservoir.

Usage

## S3 method for class 'wateres'
summary(object, reliability = "max",
  get_series = FALSE, ...)

Arguments

object	A wateres object.
reliability	A vector of reliability values passed to the sry.wateres function.
get_series	Whether time series of reservoir balance variables for the given reliabilites will be returned.
...	Further arguments passed to the sry.wateres function (as storage, yield, prob_type or upper_limit).

Details

The maximum yield or the minimum storage is calculated by using the sry.wateres function for given storage or yield and reliability.

To calculate reliability for given storage and yield without any optimization, provide all the three arguments: storage, reliability (will be ignored) and yield.

An error occurs if the range given by upper_limit does not contain value of the given reliability or if an invalid reliability value or probability type is given.

Value

A data table of reservoir characteristics:

storage	reservoir storage in m3, given or the minimum storage calculated for given reliability and yield
reliability	given or calculated reliability
yield	the maximum yield (m3.s-1), given or calculated for given reliability and potential storage
alpha	level of development - ratio of yield to the mean annual flow
m	standardized net inflow - a measure of resilience calculated as (1 - alpha) / (standard deviation of annual flows / mean annual flow)
resilience	resilience calculated as number of continuous sequences of failures / total number of time steps with failures, NA for no failure
vulnerability	vulnerability (in m3) calculated as mean of monthly deficit volumes that represent maximum deficit of each failure period
dimless_vulner	dimensionless vulnerability, vulnerability value divided by yield value in volume units

If the get_series argument is TRUE, a list is returned instead. The list consists of:

chars	the table of characteristics described above
series	a list of time series of water reservoir variables for the given reliabilities; list names are identical with the values of the reliability argument

References

Thomas A. McMahon, Adebayo J. Adeloye, Sen-Lin Zhou (2006): Understanding performance measures of reservoirs, Journal of Hydrology 324, 359–382.

See Also

sry.wateres used for optimization of the yield or storage for given reliability and for calculation of reliability

Examples

reser = data.frame(
    Q = c(0.078, 0.065, 0.168, 0.711, 0.154, 0.107, 0.068, 0.057, 0.07, 0.485, 0.252, 0.236,
          0.498, 0.248, 0.547, 0.197, 0.283, 0.191, 0.104, 0.067, 0.046, 0.161, 0.16, 0.094),
    DTM = seq(as.Date("2000-01-01"), by = "months", length.out = 24))
reser = as.wateres(reser, storage = 14.4e6, area = 754e3)
summary(reser, reliability = 1)
summary(reser, reliability = 0.95)

tgmwri/wateres documentation built on Feb. 13, 2024, 10:25 p.m.