evaluate_instant_routing: Evaluates applicability of instantaneous flow routing

View source: R/evaluate_instant_routing.R

evaluate_instant_routingR Documentation

Evaluates applicability of instantaneous flow routing

Description

Function to evaluate whether instantaneous flow routing may be used for a certain river network and a specified timestep length.

Usage

evaluate_instant_routing(HS, timestep, velocity = 1, verbose = FALSE)

Arguments

HS

a HS object obtained passed through river_network.

timestep

Timestep length in seconds.

velocity

Constant flow velocity in meters per second.

verbose

Whether or not print progress indicators.

Value

A vector of the collected stats, or the input HS with a specified column storing the vector.


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