From f0309255ab72d6ae6b7831873ed3827cd86d9875 Mon Sep 17 00:00:00 2001
From: Delaigue Olivier <olivier.delaigue@irstea.fr>
Date: Tue, 12 Jan 2021 18:53:23 +0100
Subject: [PATCH] v1.6.9.18 docs(man): add variables names as model diagrams in
the value section Refs #85
---
DESCRIPTION | 2 +-
NEWS.md | 2 +-
man/RunModel_CemaNeige.Rd | 48 ++++++++---------
man/RunModel_CemaNeigeGR4H.Rd | 88 +++++++++++++++----------------
man/RunModel_CemaNeigeGR4J.Rd | 88 +++++++++++++++----------------
man/RunModel_CemaNeigeGR5H.Rd | 94 ++++++++++++++++-----------------
man/RunModel_CemaNeigeGR5J.Rd | 90 ++++++++++++++++----------------
man/RunModel_CemaNeigeGR6J.Rd | 98 +++++++++++++++++------------------
man/RunModel_GR1A.Rd | 12 ++---
man/RunModel_GR2M.Rd | 40 +++++++-------
man/RunModel_GR4H.Rd | 44 ++++++++--------
man/RunModel_GR4J.Rd | 32 ++++++------
man/RunModel_GR5H.Rd | 50 +++++++++---------
man/RunModel_GR5J.Rd | 46 ++++++++--------
man/RunModel_GR6J.Rd | 50 +++++++++---------
15 files changed, 392 insertions(+), 392 deletions(-)
diff --git a/DESCRIPTION b/DESCRIPTION
index 970f30f8..e314d33c 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -1,7 +1,7 @@
Package: airGR
Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
-Version: 1.6.9.17
+Version: 1.6.9.18
Date: 2021-01-12
Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl"), comment = c(ORCID = "0000-0002-1503-6204")),
diff --git a/NEWS.md b/NEWS.md
index 208096a1..05213d45 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -2,7 +2,7 @@
-### 1.6.9.17 Release Notes (2021-01-12)
+### 1.6.9.18 Release Notes (2021-01-12)
#### New features
diff --git a/man/RunModel_CemaNeige.Rd b/man/RunModel_CemaNeige.Rd
index ff338511..2fc511d5 100644
--- a/man/RunModel_CemaNeige.Rd
+++ b/man/RunModel_CemaNeige.Rd
@@ -24,34 +24,34 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 2 (or 4 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
-\tabular{ll}{
-CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-day melt coefficient [mm/°C/time step] \cr
-CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
-CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
-}}
+ \tabular{ll}{
+ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
+ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/time step] \cr
+ CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
+ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
- \tabular{ll}{
- \emph{$DatesR} \tab [POSIXlt] series of dates \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/time step] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/time step] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [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/time step] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/time step] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/time step] \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: 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)
+[list] containing the function outputs organised as follows:
+ \tabular{ll}{
+ \emph{$DatesR } \tab [POSIXlt] series of dates \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/time step] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/time step] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [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/time step] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/time step] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/time step] \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: CemaNeige states [mm & °C]. 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.
}
diff --git a/man/RunModel_CemaNeigeGR4H.Rd b/man/RunModel_CemaNeigeGR4H.Rd
index e95db8f6..7dbe5222 100644
--- a/man/RunModel_CemaNeigeGR4H.Rd
+++ b/man/RunModel_CemaNeigeGR4H.Rd
@@ -24,56 +24,56 @@ RunModel_CemaNeigeGR4H(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 6 (or 8 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
-\tabular{ll}{
-GR4H X1 \tab production store capacity [mm] \cr
-GR4H X2 \tab intercatchment exchange coefficient [mm/h] \cr
-GR4H X3 \tab routing store capacity [mm] \cr
-GR4H X4 \tab unit hydrograph time constant [h] \cr
-CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-hour melt coefficient [mm/°C/h] \cr
-CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
-CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
-}}
+ \tabular{ll}{
+ GR4H X1 \tab production store capacity [mm] \cr
+ GR4H X2 \tab intercatchment exchange coefficient [mm/h] \cr
+ GR4H X3 \tab routing store capacity [mm] \cr
+ GR4H X4 \tab unit hydrograph time constant [h] \cr
+ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
+ CemaNeige X2 \tab degree-hour melt coefficient [mm/°C/h] \cr
+ CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
+ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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{$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
- \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{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
- \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [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{$CemaNeigeLayers} \tab [list] list of CemaNeige outputs (1 list per layer) \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent)[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/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/h] \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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/h] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/h] \cr
+ \emph{$Prod } \tab [numeric] series of production store level [mm] (S) \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/h] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [mm/h] \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 (Pr) [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 (R1) [mm] \cr
+ \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
+ \emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
+ \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h] \cr
+ \emph{$AExch } \tab [numeric] series of actual exchange between catchments (AExch1+AExch2) [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 (Q) [mm/h] \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/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent)[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/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/h] \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: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. 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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
diff --git a/man/RunModel_CemaNeigeGR4J.Rd b/man/RunModel_CemaNeigeGR4J.Rd
index 27e32588..fcc1cbd5 100644
--- a/man/RunModel_CemaNeigeGR4J.Rd
+++ b/man/RunModel_CemaNeigeGR4J.Rd
@@ -24,56 +24,56 @@ RunModel_CemaNeigeGR4J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 6 (or 8 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
-\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
-CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
-CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
-CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \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
+ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
+ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
+ CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
+ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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 (snow water equivalent) [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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] (E) \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/d] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/d] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [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 (Pr) [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 (R1) [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 (Q) [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 (snow water equivalent) [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: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. 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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
diff --git a/man/RunModel_CemaNeigeGR5H.Rd b/man/RunModel_CemaNeigeGR5H.Rd
index 5500f132..88ab4c2e 100644
--- a/man/RunModel_CemaNeigeGR5H.Rd
+++ b/man/RunModel_CemaNeigeGR5H.Rd
@@ -24,59 +24,59 @@ RunModel_CemaNeigeGR5H(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 7 (or 9 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
-\tabular{ll}{
-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
-CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-hour melt coefficient [mm/°C/h] \cr
-CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
-CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
-}}
+ \tabular{ll}{
+ 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
+ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
+ CemaNeige X2 \tab degree-hour melt coefficient [mm/°C/h] \cr
+ CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
+ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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{$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
- \emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/h] \cr
- \emph{$EI } \tab [numeric] series of evapotranspiration from rainfall neutralisation or interception store [mm/h] \cr
- \emph{$ES } \tab [numeric] series of evapotranspiration from production store [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 UH outflow going into branch 9 (Q9) [mm/h] \cr
- \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (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{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
- \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [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 UH after exchange (QD) [mm/h] \cr
- \emph{$Qsim } \tab [numeric] series of simulated discharge [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [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/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/h] \cr
- \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/h] \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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/h] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/h] \cr
+ \emph{$Interc } \tab [numeric] series of interception store level (I) [mm] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/h] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [mm/h] \cr
+ \emph{$AE } \tab [numeric] series of actual evapotranspiration (Ei+Es) [mm/h] \cr
+ \emph{$EI } \tab [numeric] series of evapotranspiration from rainfall neutralisation or interception store (Ei) [mm/h] \cr
+ \emph{$ES } \tab [numeric] series of evapotranspiration from production store (Es) [mm/h] \cr
+ \emph{$Perc } \tab [numeric] series of percolation (Perc) [mm/h] \cr
+ \emph{$PR } \tab [numeric] series of Pr=Pn-Ps+Perc (Pr) [mm/h] \cr
+ \emph{$Q9 } \tab [numeric] series of UH outflow going into branch 9 (Q9) [mm/h] \cr
+ \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (Q1) [mm/h] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level (R1) [mm] \cr
+ \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
+ \emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
+ \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h] \cr
+ \emph{$AExch } \tab [numeric] series of actual exchange between catchments (AExch1+AExch2) [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 UH after exchange (Qd) [mm/h] \cr
+ \emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Pliq } \tab [numeric] series of liquid precip. [mm/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Psol } \tab [numeric] series of solid precip. [mm/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$SnowPack } \tab [numeric] series of snow pack (snow water equivalent) [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/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm/h] \cr
+ \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm/h] \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: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. 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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
diff --git a/man/RunModel_CemaNeigeGR5J.Rd b/man/RunModel_CemaNeigeGR5J.Rd
index fa3b5bfb..4f2b77c5 100644
--- a/man/RunModel_CemaNeigeGR5J.Rd
+++ b/man/RunModel_CemaNeigeGR5J.Rd
@@ -24,57 +24,57 @@ RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 7 (or 9 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
-\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
-CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
-CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
-CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \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
+ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
+ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
+ CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
+ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE}) \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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 UH outflow going into branch 9 (Q9) [mm/d] \cr
- \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (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 UH 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 (snow water equivalent) [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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/d] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/d] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/d] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [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 (Pr) [mm/d] \cr
+ \emph{$Q9 } \tab [numeric] series of UH outflow going into branch 9 (Q9) [mm/d] \cr
+ \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (Q1) [mm/d] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level (R1) [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 (AExch1+AExch2) [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 UH after exchange (Qd) [mm/d] \cr
+ \emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [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 (snow water equivalent) [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: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. 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)
+Refer to the provided references or to the package source code for further details on these model outputs
}
diff --git a/man/RunModel_CemaNeigeGR6J.Rd b/man/RunModel_CemaNeigeGR6J.Rd
index 7480ecf9..65e9635d 100644
--- a/man/RunModel_CemaNeigeGR6J.Rd
+++ b/man/RunModel_CemaNeigeGR6J.Rd
@@ -24,60 +24,60 @@ RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 8 (or 10 parameters if \code{IsHyst = TRUE}, see \code{\link{CreateRunOptions}} for details)
-\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 exponential store depletion coefficient [mm] \cr
-CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
-CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
-CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
-CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE})\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 exponential store depletion coefficient [mm] \cr
+ CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
+ CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
+ CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
+ CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE})\cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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 (snow water equivalent) [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)
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/d] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/d] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/d] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [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 (Pr) [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 (R1) [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 (AExch1+AExch2) [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) (R2) [mm] \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 (Q) [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 (snow water equivalent) [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: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. 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
}
diff --git a/man/RunModel_GR1A.Rd b/man/RunModel_GR1A.Rd
index 8bb42dac..56b2bce2 100644
--- a/man/RunModel_GR1A.Rd
+++ b/man/RunModel_GR1A.Rd
@@ -24,14 +24,14 @@ RunModel_GR1A(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 1 parameter
-\tabular{ll}{
-GR1A X1 \tab model parameter [-] \cr
-}}
+ \tabular{ll}{
+ GR1A X1 \tab model parameter [-] \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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
@@ -39,12 +39,12 @@ GR1A X1 \tab model parameter [-] \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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
\details{
-For further details on the model, see the references section.
+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}}.
}
diff --git a/man/RunModel_GR2M.Rd b/man/RunModel_GR2M.Rd
index a7031885..6f62fdb9 100644
--- a/man/RunModel_GR2M.Rd
+++ b/man/RunModel_GR2M.Rd
@@ -24,36 +24,36 @@ RunModel_GR2M(InputsModel, RunOptions, Param)
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
\item{Param}{[numeric] vector of 2 parameters
-\tabular{ll}{
-GR2M X1 \tab production store capacity [mm] \cr
-GR2M X2 \tab groundwater exchange coefficient [-] \cr
-}}
+ \tabular{ll}{
+ GR2M X1 \tab production store capacity [mm] \cr
+ GR2M X2 \tab groundwater exchange coefficient [-] \cr
+ }}
}
\value{
-[list] list containing the function outputs organised as follows:
+[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{$Ps } \tab [numeric] series of part of P filling the production store [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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/month] (E) \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation [mm/month] (P) \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{$Ps } \tab [numeric] series of part of P filling the production store [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{$AExch } \tab [numeric] series of actual exchange between catchments [mm/month] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level (R1) [mm] \cr
+ \emph{$Qsim } \tab [numeric] series of simulated discharge [mm/month] (Q) \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (production store level and routing store level) [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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
\details{
-For further details on the model, see the references section.
+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}}.
\cr
\cr
diff --git a/man/RunModel_GR4H.Rd b/man/RunModel_GR4H.Rd
index f76d9a3d..7f2b2885 100644
--- a/man/RunModel_GR4H.Rd
+++ b/man/RunModel_GR4H.Rd
@@ -34,30 +34,30 @@ RunModel_GR4H(InputsModel, RunOptions, Param)
\value{
-[list] list containing the function outputs organised as follows:
+[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{$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
- \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{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h]\cr
- \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/h] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/h] \cr
+ \emph{$Prod } \tab [numeric] series of production store level [mm] (S) \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/h] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [mm/h \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 (Pr) [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 (R1) [mm] \cr
+ \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
+ \emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
+ \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h] \cr
+ \emph{$AExch } \tab [numeric] series of actual exchange between catchments (AExch1+AExch2) [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 (Q) [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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
diff --git a/man/RunModel_GR4J.Rd b/man/RunModel_GR4J.Rd
index 750ac9c1..0536238b 100644
--- a/man/RunModel_GR4J.Rd
+++ b/man/RunModel_GR4J.Rd
@@ -34,35 +34,35 @@ RunModel_GR4J(InputsModel, RunOptions, Param)
\value{
-[list] list containing the function outputs organised as follows:
+[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{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/d] (E) \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/d] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/d] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [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{$Perc } \tab [numeric] series of percolation (Perc) [mm/d] \cr
+ \emph{$PR } \tab [numeric] series of Pr=Pn-Ps+Perc (Pr) [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{$Rout } \tab [numeric] series of routing store level (R1) [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)
+ \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 (Q) [mm/d] \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.
}
\details{
-For further details on the model, see the references section.
+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}}.
\cr
\cr
diff --git a/man/RunModel_GR5H.Rd b/man/RunModel_GR5H.Rd
index 622043c4..6b96eba6 100644
--- a/man/RunModel_GR5H.Rd
+++ b/man/RunModel_GR5H.Rd
@@ -35,33 +35,33 @@ RunModel_GR5H(InputsModel, RunOptions, Param)
\value{
-[list] list containing the function outputs organised as follows:
+[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{$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
- \emph{$AE } \tab [numeric] series of actual evapotranspiration [mm/h] \cr
- \emph{$EI } \tab [numeric] series of evapotranspiration from rainfall neutralisation or interception store [mm/h] \cr
- \emph{$ES } \tab [numeric] series of evapotranspiration from production store [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 UH outflow going into branch 9 (Q9) [mm/h] \cr
- \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (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{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
- \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [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 UH 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, UH levels) [mm], see \code{\link{CreateIniStates}} for more details \cr
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/h] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/h] \cr
+ \emph{$Interc } \tab [numeric] series of interception store level (I) [mm] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/h] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [mm/h] \cr
+ \emph{$AE } \tab [numeric] series of actual evapotranspiration (Ei+Es) [mm/h] \cr
+ \emph{$EI } \tab [numeric] series of evapotranspiration from rainfall neutralisation or interception store (Ei) [mm/h] \cr
+ \emph{$ES } \tab [numeric] series of evapotranspiration from production store (Es) [mm/h] \cr
+ \emph{$Perc } \tab [numeric] series of percolation (Perc) [mm/h] \cr
+ \emph{$PR } \tab [numeric] series of Pr=Pn-Ps+Perc (Pr) [mm/h] \cr
+ \emph{$Q9 } \tab [numeric] series of UH outflow going into branch 9 (Q9) [mm/h] \cr
+ \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (Q1) [mm/h] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level (R1) [mm] \cr
+ \emph{$Exch } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
+ \emph{$AExch1 } \tab [numeric] series of actual exchange between catchments for branch 1 [mm/h] \cr
+ \emph{$AExch2 } \tab [numeric] series of actual exchange between catchments for branch 2 [mm/h] \cr
+ \emph{$AExch } \tab [numeric] series of actual exchange between catchments (AExch1+AExch2) [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 UH after exchange (Qd) [mm/h] \cr
+ \emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/h] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH 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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
diff --git a/man/RunModel_GR5J.Rd b/man/RunModel_GR5J.Rd
index 5fb0a2c3..227d8618 100644
--- a/man/RunModel_GR5J.Rd
+++ b/man/RunModel_GR5J.Rd
@@ -35,35 +35,35 @@ RunModel_GR5J(InputsModel, RunOptions, Param)
\value{
-[list] list containing the function outputs organised as follows:
+[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 UH outflow going into branch 9 (Q9) [mm/d] \cr
- \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (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 UH 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, UH levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/d] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/d] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/d] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [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 (Pr) [mm/d] \cr
+ \emph{$Q9 } \tab [numeric] series of UH outflow going into branch 9 (Q9) [mm/d] \cr
+ \emph{$Q1 } \tab [numeric] series of UH outflow going into branch 1 (Q1) [mm/d] \cr
+ \emph{$Rout } \tab [numeric] series of routing store level (R1) [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 (AExch1+AExch2) [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 UH after exchange (Qd) [mm/d] \cr
+ \emph{$Qsim } \tab [numeric] series of simulated discharge (Q) [mm/d] \cr
+ \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH 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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
\details{
-For further details on the model, see the references section.
+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}}.
\cr
\cr
diff --git a/man/RunModel_GR6J.Rd b/man/RunModel_GR6J.Rd
index 6d8545aa..7a1849b5 100644
--- a/man/RunModel_GR6J.Rd
+++ b/man/RunModel_GR6J.Rd
@@ -36,37 +36,37 @@ RunModel_GR6J(InputsModel, RunOptions, Param)
\value{
-[list] list containing the function outputs organised as follows:
+[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
+ \emph{$DatesR } \tab [POSIXlt] series of dates \cr
+ \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration (E) [mm/d] \cr
+ \emph{$Precip } \tab [numeric] series of input total precipitation (P) [mm/d] \cr
+ \emph{$Prod } \tab [numeric] series of production store level (S) [mm] \cr
+ \emph{$Pn } \tab [numeric] series of net rainfall (Pn) [mm/d] \cr
+ \emph{$Ps } \tab [numeric] series of the part of Pn filling the production store (Ps) [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 (Pr) [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 (R1) [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 (AExch1+AExch2) [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) (R2) [mm] \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 (Q) [mm/d] \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)
+Refer to the provided references or to the package source code for further details on these model outputs.
}
\details{
-For further details on the model, see the references section.
+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}}.
\cr
\cr
--
GitLab