RunModel_Lag.Rd

\encoding{UTF-8}


\name{RunModel_Lag}
\alias{RunModel_Lag}


\title{Run with the Lag model}


\description{
Function which performs a single run for the Lag model over the test period.
}


\usage{
RunModel_Lag(InputsModel, RunOptions, Param)
}


\arguments{
\item{InputsModel}{[object of class \emph{InputsModel}] created with SD model inputs, see \code{\link{CreateInputsModel}} for details. The object should also contain a key \emph{OutputsModel} of class \code{\link{CreateInputsModel}} coming from the simulation of the downstream subcatchment runoff.}

\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}

\item{Param}{[numeric] vector of 1 parameter
  \tabular{ll}{
    Lag \tab Mean flow velocity [m/s]
  }}
}


\value{
[list] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details.

The list value contains an extra item named \code{QsimDown} which is a copy of \code{InputsModel$OutputsModel$Qsim}, a numeric series of simulated discharge [mm/time step] related to the runoff contribution of the downstream sub-catchment.
}


\examples{
#####################################################################
## Simulation of a reservoir with a purpose of low-flow mitigation ##
#####################################################################

## Preparation of the InputsModel object

# loading package and catchment data
library(airGR)
data(L0123001)

# The reservoir withdraws 1 m3/s when it's possible considering the flow observed in the basin
Qupstream <- matrix(- unlist(lapply(BasinObs$Qls / 1000 - 1, function(x) {
  min(1, max(0,x, na.rm = TRUE))
})), ncol = 1)

# Except between July and September when the reservoir releases 3 m3/s for low-flow mitigation
month <- as.numeric(format(BasinObs$DatesR,"\%m"))
Qupstream[month >= 7 & month <= 9] <- 3
# Conversion in m3/day
Qupstream <- Qupstream * 86400

# The reservoir is not an upstream subcachment: its areas is NA
BasinAreas <- c(NA, BasinInfo$BasinArea)

# Delay time between the reservoir and the catchment outlet is 2 days and the distance is 150 km
LengthHydro <- 150000

InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR,
                                 Precip = BasinObs$P, PotEvap = BasinObs$E,
                                 Qupstream = Qupstream, LengthHydro = LengthHydro,