Commit f80159d2 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.4.3.11 DOC: text revision in RunModelGR5H doc #13

parent 461a2c6d
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.4.3.10
Version: 1.4.3.11
Date: 2019-12-16
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -2,7 +2,7 @@
### 1.4.3.10 Release Notes (2019-12-16)
### 1.4.3.11 Release Notes (2019-12-16)
#### New features
......
......@@ -20,11 +20,11 @@ RunModel_GR5H(InputsModel, RunOptions, Param)
\item{Param}{[numeric] vector of 5 parameters
\tabular{ll}{
GR5H X1 \tab production store capacity [mm] \cr
GR5H X2 \tab groundwater exchange coefficient [mm/h] \cr
GR5H X3 \tab routing store capacity [mm] \cr
GR5H X4 \tab unit hydrograph time constant [h] \cr
GR5H X5 \tab intercatchment exchange threshold [-] \cr
GR5H X1 \tab production store capacity [mm] \cr
GR5H X2 \tab intercatchment exchange coefficient [mm/h] \cr
GR5H X3 \tab routing store capacity [mm] \cr
GR5H X4 \tab unit hydrograph time constant [h] \cr
GR5H X5 \tab intercatchment exchange threshold [-] \cr
}}
}
......@@ -35,7 +35,7 @@ RunModel_GR5H(InputsModel, RunOptions, Param)
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/h] \cr
\emph{Interc } \tab [numeric] series of interception store level [mm] \cr
\emph{$Interc } \tab [numeric] series of interception store level [mm] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/h] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/h] \cr
......@@ -66,7 +66,9 @@ Function which performs a single run for the GR5H hourly lumped model.
\details{
For further details on the model, see the references section.
It is advised to run the GR5H model with an interception store (see Ficchi et al. (2019)) as it improves the consistency of the model fluxes and provides better performance. To do so, the \code{\link{Imax}} functions allows to estimates the maximal capacity of the interception store, which can then be given to \code{\link{CreateRunOptions}}. \cr
For further details on the model, see the references section. \cr
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
}
......@@ -85,8 +87,12 @@ InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR5H, DatesR = BasinObs$Date
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2004-03-01 00:00"),
which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d \%H:\%M")=="2008-12-31 23:00"))
## Imax computation
Imax <- Imax(InputsModel = InputsModel, IndPeriod_Run = Ind_Run,
TestedValues = seq(from = 0.1, to = 3, by = 1))
## preparation of the RunOptions object
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR5H,
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR5H, Imax = Imax,
InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
## simulation
......@@ -121,9 +127,8 @@ Ficchi, A., C. Perrin and V. Andréassian (2019).
\seealso{
\code{\link{RunModel_CemaNeigeGR5H}},
\code{\link{RunModel_GR5J}}, \code{\link{RunModel_GR4H}},
\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}},
\code{\link{CreateIniStates}}, \code{\link{Imax}}.
\code{\link{CreateIniStates}}, \code{\link{Imax}, \code{\link{RunModel_CemaNeigeGR5J}}.
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment