ConvertDischarge {HYPEtools}R Documentation

Calculate Specific runoff from volumetric discharge and vice versa

Description

ConvertDischarge converts volumetric discharge to specific discharge (unit area discharge) and vice versa.

Usage

ConvertDischarge(q, area, from = "m3s", to = "mmd")

Arguments

q

An object of type numeric, containing volumetric or specific discharge values, typically HYPE variables COUT or ROUT.

area

An object of type numeric, containing a catchment area in m^2.

from

Character string keyword, giving the current unit of q. Either a specific discharge, one of:

"mmy" (mm y^{-1})

"mmd" (mm d^{-1})

"mmh" (mm h^{-1}),

or a volumetric discharge, one of:

"m3s" (m^3 s^{-1})

"ls" (l s^{-1}).

to

Character string keyword, see from. Conversion will not work between units within volumetric or specific discharge groups.

Details

ConvertDischarge is a simple conversion function, most likely to be used in combination with apply or related functions.

Value

ConvertDischarge returns a numeric object of the same type as provided in argument q.

Examples

ConvertDischarge(6, 400000000)
ConvertDischarge(c(1.1, 1.2, 1.9, 2.8, 2, 1.5, 1.3, 1.2, 1.15, 1.1), 
                 from = "mmd", to = "ls", area = 1.2e6)

[Package HYPEtools version 1.6.2 Index]