Adds flow controls to an 'HS' object

Source: R/add_control.R

Adds flow control timeseries to a HS object. Control conditions should cover the entire timeseries in HS.

add_control(HS, timeseries, unit, riverIDs, control, type)

Arguments

HS

An HS object.
timeseries

a data frame with observations.
unit

The unit of values in timeseries. Should be convertible to cubic meters per second.
riverIDs

A vector of riverID of the river segments of the columns in obs.
control

Type of control, see details.
type

Whether the control should apply to runoff input, or to discharge output.

Value

Returns the HS object with added list column control_ts and control_type.

Details

Available control schemes are

  • set: set input flow at a river segment (override routing). Useful e.g. for boundary conditions or dams.

  • add: increase runoff at a river segment.

  • subtract: lower runoff at a river segment.

  • multiply: modify runoff.