convolution: Convolution of net rainfall with unit hydrograph

Description Usage Arguments Value Examples

View source: R/convolution.R

Description

Simulate the discharge by a convolution between the unit hydrograph and the net rainfall.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
convolution(Rn, ...)

## Default S3 method:
convolution(Rn, uh, continuous = FALSE, ...)

## S3 method for class 'units'
convolution(Rn, uh, ...)

## S3 method for class 'transfR'
convolution(
  Rn,
  Rcol = "RnSim",
  Qcol = "Qsim",
  save_donor = FALSE,
  verbose = TRUE,
  ...
)

Arguments

Rn

net rainfall vector or an object of class transfR

...

further arguments passed to or from other methods

uh

unit hydrograph vector

continuous

boolean indicating if, when one time step might be influenced by past or future rainfall (according to the time span of the unit hydrograph), no simulated value is provided

Rcol

name of the space-time attribute for the discharge simulation in the transfR object

Qcol

name of the space-time attribute for the net rainfall in the transfR object

save_donor

boolean indicating if additional discharge simulations should be computed using the net rainfall of each individual donor catchment instead of just the weighted average net rainfall. This requires that save_donor was TRUE when using mixr

verbose

boolean indicating if information messages should be written to the console

Value

An object of the same class of Rn. If Rn is a transfR object, the same transfR object incremented by the new computed attributes.

Examples

1
2
3
4
5
6
data(Oudon)
icatch <- 1
uc <- velocity(hl = Oudon$hl[[icatch]])
uh <- uh(hl = Oudon$hl[[icatch]], uc = uc, deltat = units::set_units(1,"h"))$prob
Rn <- units::set_units(c(1,5,2),"mm/h")
Qsim <- convolution(Rn = Rn, uh = uh)

transfR documentation built on Sept. 8, 2021, 9:08 a.m.