accumulate_runoff: Apply river routing

View source: R/accumulate_runoff.R

accumulate_runoffR Documentation

Apply river routing

Description

Apply river routing using any of the provided methods. The function takes HS object with runoff timeseries as an input. See details.

Usage

accumulate_runoff(
  HS,
  routing_method = c("instant", "constant"),
  ...,
  verbose = FALSE
)

Arguments

HS

A 'HS' object obtained by interpolate_runoff

routing_method

Character string specifying the method to be used.

...

Arguments passed to the routing algorithm, and to river_network, if it has not been run already.

verbose

Whether or not to print progress information. Defaults to FALSE.

Details

There are currently two routing algorithms implemented: 'instant'aneous flow, where all runoff is routed through the entire river network at every timestep. There is no lag in instantaneous routing, which means it may not be reasonable for large river networks. 'constant' velocity river routing routes runoff down the river network with a constant, user specified velocity. See further details from the documentation of each method:

  • accumulate_runoff_instant

  • accumulate_runoff_constant

Value

Returns the input object HS) with an added list column discharge_ts containing routed discharge estimates for each river segment.


mkkallio/hydrostreamer documentation built on Oct. 14, 2023, 9:38 p.m.