Commit 68007cd4 authored by Delaigue Olivier's avatar Delaigue Olivier
Browse files

v1.2.12.15 DOC: inputs and outputs lists re-indented in many docs

parent 05ad4571
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.2.12.14
Version: 1.2.12.15
Date: 2019-04-01
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
......
......@@ -13,7 +13,7 @@ output:
### 1.2.12.14 Release Notes (2019-04-01)
### 1.2.12.15 Release Notes (2019-04-01)
......
......@@ -48,11 +48,11 @@ CreateIniStates(FUN_MOD, InputsModel,
\value{
[list] object of class \code{IniStates} containing the initial model internal states; it always includes the following:
\tabular{ll}{
\emph{$Store } \tab [numeric] list of store levels (\emph{$Prod}, \emph{$Rout} and \emph{$Exp}) \cr
\emph{$UH } \tab [numeric] list of unit hydrographs levels (\emph{$UH1} and \emph{$UH2}) \cr
\emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (\emph{$G} and \emph{$eTG})
}
\tabular{ll}{
\emph{$Store } \tab [numeric] list of store levels (\emph{$Prod}, \emph{$Rout} and \emph{$Exp}) \cr
\emph{$UH } \tab [numeric] list of unit hydrographs levels (\emph{$UH1} and \emph{$UH2}) \cr
\emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (\emph{$G} and \emph{$eTG})
}
}
......@@ -140,4 +140,3 @@ Olivier Delaigue
\seealso{
\code{\link{CreateRunOptions}}
}
......@@ -48,8 +48,8 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PrecipScale = TRUE, PotEvap = NULL,
\emph{$DatesR } \tab [POSIXlt] vector of dates \cr
\emph{$Precip } \tab [numeric] time series of total precipitation (catchment average) [mm/time step] \cr
\emph{$PotEvap } \tab [numeric] time series of potential evapotranspiration (catchment average) [mm/time step], \cr\tab defined if FUN_MOD includes GR4H, GR4J, GR5J, GR6J, GR2M or GR1A \cr \cr
\emph{$LayerPrecip } \tab [list] list of time series of precipitation (layer average) [mm/time step], \cr\tab defined if \code{FUN_MOD} includes CemaNeige \cr \cr
\emph{$LayerTempMean } \tab [list] list of time series of mean air temperature (layer average) [°C], \cr\tab defined if \code{FUN_MOD} includes CemaNeige \cr \cr
\emph{$LayerPrecip } \tab [list] list of time series of precipitation (layer average) [mm/time step], \cr\tab defined if \code{FUN_MOD} includes CemaNeige \cr \cr
\emph{$LayerTempMean } \tab [list] list of time series of mean air temperature (layer average) [°C], \cr\tab defined if \code{FUN_MOD} includes CemaNeige \cr \cr
\emph{$LayerFracSolidPrecip} \tab [list] list of time series of solid precipitation fraction (layer average) [-], \cr\tab defined if \code{FUN_MOD} includes CemaNeige \cr \cr
}
}
......
......@@ -39,12 +39,12 @@ DataAltiExtrapolation_Valery(DatesR, Precip, PrecipScale = TRUE,
\value{
list containing the extrapolated series of precip. and air temp. on each elevation layer
\tabular{ll}{
\emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm/d] \cr
\emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [°C] \cr
\emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [°C] \cr
\emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [°C] \cr
\emph{$LayerFracSolidPrecip} \tab [list] list of time series of daily solid precip. fract. (layer average) [-] \cr
\emph{$ZLayers } \tab [numeric] vector of median elevation for each layer \cr
\emph{$LayerPrecip } \tab [list] list of time series of daily precipitation (layer average) [mm/d] \cr
\emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [°C] \cr
\emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [°C] \cr
\emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [°C] \cr
\emph{$LayerFracSolidPrecip} \tab [list] list of time series of daily solid precip. fract. (layer average) [-] \cr
\emph{$ZLayers } \tab [numeric] vector of median elevation for each layer \cr
}
}
......
......@@ -11,9 +11,9 @@
\format{Data frame of parameters containing four numeric vectors
\itemize{
\item {GR4J X1} {production store capacity [mm]}
\item {GR4J X2} {intercatchment exchange coefficient [mm/d]}
\item {GR4J X3} {routing store capacity [mm]}
\item {GR4J X1} {production store capacity [mm]}
\item {GR4J X2} {intercatchment exchange coefficient [mm/d]}
\item {GR4J X3} {routing store capacity [mm]}
\item {GR4J X4u} {unajusted unit hydrograph time constant [d]}
}}
......
......@@ -34,41 +34,41 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/d] \cr
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gthreshold } \tab [numeric] series of melt threshold [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Glocalmax } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/d] \cr
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gthreshold } \tab [numeric] series of melt threshold [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Glocalmax } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -36,41 +36,41 @@ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall def
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap} \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Ps filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=PN-PS+PERC [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QRExp } \tab [numeric] series of exponential store outflow (QRExp) [mm/d] \cr
\emph{$Exp } \tab [numeric] series of exponential store level (negative) [mm] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gthreshold } \tab [numeric] series of melt threshold [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Glocalmax } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap} \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Ps filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=PN-PS+PERC [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QRExp } \tab [numeric] series of exponential store outflow (QRExp) [mm/d] \cr
\emph{$Exp } \tab [numeric] series of exponential store level (negative) [mm] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
\emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$ThermalState } \tab [numeric] series of snow pack thermal state [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gratio } \tab [numeric] series of Gratio [0-1] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PotMelt } \tab [numeric] series of potential snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Temp } \tab [numeric] series of air temperature [°C] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Gthreshold } \tab [numeric] series of melt threshold [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Glocalmax } \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -27,14 +27,14 @@ GR1A X1 \tab model parameter [-] \cr
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/y] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/y] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/y] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (NULL) [-] \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/y] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/y] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/y] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (NULL) [-] \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -28,21 +28,21 @@ GR2M X2 \tab groundwater exchange coefficient [-] \cr
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/month] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/month] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/month] \cr
\emph{$Pn } \tab [numeric] series of net rainfall (P1) [mm/month] \cr
\emph{$Perc } \tab [numeric] series of percolation (P2) [mm/month] \cr
\emph{$PR } \tab [numeric] series of PR=Pn+Perc (P3) [mm/month] \cr
\emph{$Exch } \tab [numeric] series of potential exchange between catchments [mm/month] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/month] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (production store level and routing store level) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/month] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/month] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/month] \cr
\emph{$Pn } \tab [numeric] series of net rainfall (P1) [mm/month] \cr
\emph{$Perc } \tab [numeric] series of percolation (P2) [mm/month] \cr
\emph{$PR } \tab [numeric] series of PR=Pn+Perc (P3) [mm/month] \cr
\emph{$Exch } \tab [numeric] series of potential exchange between catchments [mm/month] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/month] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (production store level and routing store level) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -19,36 +19,36 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
\tabular{ll}{
GR4H X1 \tab production store capacity [mm] \cr
GR4H X2 \tab groundwater exchange coefficient [mm/h] \cr
GR4H X3 \tab routing store capacity [mm] \cr
GR4H X4 \tab unit hydrograph time constant [h] \cr
}}
\tabular{ll}{
GR4H X1 \tab production store capacity [mm] \cr
GR4H X2 \tab groundwater exchange coefficient [mm/h] \cr
GR4H X3 \tab routing store capacity [mm] \cr
GR4H X4 \tab unit hydrograph time constant [h] \cr
}}
}
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\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{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/h] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/h] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/h] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/h] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/h] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/h] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/h] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
\tabular{ll}{
\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{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/h] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/h] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/h] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/h] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/h] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/h] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/h] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/h] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/h] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -19,38 +19,38 @@ RunModel_GR4J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 4 parameters
\tabular{ll}{
GR4J X1 \tab production store capacity [mm] \cr
GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR4J X3 \tab routing store capacity [mm] \cr
GR4J X4 \tab unit hydrograph time constant [d] \cr
}}
\tabular{ll}{
GR4J X1 \tab production store capacity [mm] \cr
GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR4J X3 \tab routing store capacity [mm] \cr
GR4J X4 \tab unit hydrograph time constant [d] \cr
}}
}
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -19,41 +19,41 @@ RunModel_GR5J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 5 parameters
\tabular{ll}{
GR5J X1 \tab production store capacity [mm] \cr
GR5J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR5J X3 \tab routing store capacity [mm] \cr
GR5J X4 \tab unit hydrograph time constant [d] \cr
GR5J X5 \tab intercatchment exchange threshold [-] \cr
}}
\tabular{ll}{
GR5J X1 \tab production store capacity [mm] \cr
GR5J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR5J X3 \tab routing store capacity [mm] \cr
GR5J X4 \tab unit hydrograph time constant [d] \cr
GR5J X5 \tab intercatchment exchange threshold [-] \cr
}}
}
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of simulated discharge [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
......@@ -19,44 +19,44 @@ RunModel_GR6J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 6 parameters
\tabular{ll}{
GR6J X1 \tab production store capacity [mm] \cr
GR6J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR6J X3 \tab routing store capacity [mm] \cr
GR6J X4 \tab unit hydrograph time constant [d] \cr
GR6J X5 \tab intercatchment exchange threshold [-] \cr
GR6J X6 \tab coefficient for emptying exponential store [mm] \cr
}}
\tabular{ll}{
GR6J X1 \tab production store capacity [mm] \cr
GR6J X2 \tab intercatchment exchange coefficient [mm/d] \cr
GR6J X3 \tab routing store capacity [mm] \cr
GR6J X4 \tab unit hydrograph time constant [d] \cr
GR6J X5 \tab intercatchment exchange threshold [-] \cr
GR6J X6 \tab coefficient for emptying exponential store [mm] \cr
}}
}
\value{
[list] list containing the function outputs organised as follows:
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QRExp } \tab [numeric] series of exponential store outflow (QRExp) [mm/d] \cr
\emph{$Exp } \tab [numeric] series of exponential store level (negative) [mm] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
\tabular{ll}{
\emph{$DatesR } \tab [POSIXlt] series of dates \cr
\emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] \cr
\emph{$Precip } \tab [numeric] series of input total precipitation [mm/d] \cr
\emph{$Prod } \tab [numeric] series of production store level [mm] \cr
\emph{$Pn } \tab [numeric] series of net rainfall [mm/d] \cr
\emph{$Ps } \tab [numeric] series of the part of Pn filling the production store [mm/d] \cr
\emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/d] \cr
\emph{$Perc } \tab [numeric] series of percolation (PERC) [mm/d] \cr
\emph{$PR } \tab [numeric] series of PR=Pn-Ps+Perc [mm/d] \cr
\emph{$Q9 } \tab [numeric] series of UH1 outflow (Q9) [mm/d] \cr
\emph{$Q1 } \tab [numeric] series of UH2 outflow (Q1) [mm/d] \cr
\emph{$Rout } \tab [numeric] series of routing store level [mm] \cr
\emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/d] \cr
\emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d] \cr
\emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d] \cr
\emph{$AExch } \tab [numeric] series of actual exchange between catchments (1+2) [mm/d] \cr
\emph{$QR } \tab [numeric] series of routing store outflow (QR) [mm/d] \cr
\emph{$QRExp } \tab [numeric] series of exponential store outflow (QRExp) [mm/d] \cr
\emph{$Exp } \tab [numeric] series of exponential store level (negative) [mm] \cr
\emph{$QD } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d] \cr
\emph{$Qsim } \tab [numeric] series of Qsim [mm/d] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
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