set_routing.wateres: Routing of reservoir yield setting

View source: R/variables.R

set_routingR Documentation

Routing of reservoir yield setting

Description

Sets method and parameters used for routing of reservoir yield.

Usage

set_routing(reser, method, settings)

## S3 method for class 'wateres'
set_routing(reser, method = "none", settings = NULL)

Arguments

reser

A wateres object.

method

One of “none” (no routing), “lag” (a simple shift of yield in time) or “linear_reservoir” (transformation in linear reservoir).

settings

A list of routing parameters specific for each method: for “lag” one parameter named lag_time defining time lag in minutes, for “linear_reservoir” two parameters named storage_coeff defining coefficient of the linear reservoir in minutes and initial_storage defining storage (in m3) in the linear reservoir at the beginning of routing; the initial storage is 0 by default.

Details

The routing settings are implemented as attributes of the wateres object.

Value

A modified wateres object with the routing method and settings added as its attribute.

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)
reser = set_routing(reser, "lag", list(lag_time = 88000))
resul = calc_series(reser, yield = 0.17)

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