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

Mise à jour de la documentation (retrait de l'en-tête Roxygen)

parent b98b572a
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BasinData.R
\docType{data}
\encoding{UTF-8}
\name{BasinInfo}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BasinData.R
\docType{data}
\encoding{UTF-8}
\name{BasinObs}
......@@ -8,7 +6,7 @@
\format{Data frame named 'BasinObs' containing
\itemize{
\item one POSIXlt vector: time series dates in the POSIXlt format
\item five numeric vectors: time series of catchment average precipitation [mm/time step], catchment average air temperature [degC], catchment average potential evapotranspiration [mm/time step], outlet discharge [l/s], outlet discharge [mm/time step]
\item five numeric vectors: time series of catchment average precipitation [mm/time step], catchment average air temperature [°C], catchment average potential evapotranspiration [mm/time step], outlet discharge [l/s], outlet discharge [mm/time step]
}}
\description{
R-object containing the times series of precipitation, temperature, potential evapotranspiration and discharges. \cr
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Calibration.R
\encoding{UTF-8}
\name{Calibration}
\alias{Calibration}
......@@ -7,7 +5,7 @@
\usage{
Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
FUN_CRIT, FUN_CALIB = Calibration_Michel, FUN_TRANSFO = NULL,
quiet = FALSE)
verbose = TRUE)
}
\arguments{
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
......@@ -26,7 +24,7 @@ Calibration(InputsModel, RunOptions, InputsCrit, CalibOptions, FUN_MOD,
\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] see \code{\link{Calibration_Michel}}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Calibration_Michel.R
\encoding{UTF-8}
\name{Calibration_Michel}
\alias{Calibration_Michel}
\title{Calibration algorithm optimises the error criterion selected as objective function using the Irstea-HBAN procedure described by C. Michel}
\usage{
Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, quiet = FALSE)
FUN_MOD, FUN_CRIT, FUN_TRANSFO = NULL, verbose = TRUE)
}
\arguments{
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
......@@ -23,7 +21,7 @@ Calibration_Michel(InputsModel, RunOptions, InputsCrit, CalibOptions,
\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package FUN_TRANSFO is automatically defined}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] list containing the function outputs organised as follows:
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateCalibOptions.R
\encoding{UTF-8}
\name{CreateCalibOptions}
\alias{CreateCalibOptions}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateInputsCrit.R
\encoding{UTF-8}
\name{CreateInputsCrit}
\alias{CreateInputsCrit}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateInputsModel.R
\encoding{UTF-8}
\name{CreateInputsModel}
\alias{CreateInputsModel}
......@@ -7,7 +5,7 @@
\usage{
CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
TempMin = NULL, TempMax = NULL, ZInputs = NULL, HypsoData = NULL,
NLayers = 5, quiet = FALSE)
NLayers = 5, verbose = TRUE)
}
\arguments{
\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)}
......@@ -18,11 +16,11 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
\item{PotEvap}{[numeric] time series of potential evapotranspiration (catchment average) [mm], required to create the GR model inputs}
\item{TempMean}{(optional) [numeric] time series of mean air temperature [degC], required to create the CemaNeige module inputs}
\item{TempMean}{(optional) [numeric] time series of mean air temperature [°C], required to create the CemaNeige module inputs}
\item{TempMin}{(optional) [numeric] time series of min air temperature [degC], possibly used to create the CemaNeige module inputs}
\item{TempMin}{(optional) [numeric] time series of min air temperature [°C], possibly used to create the CemaNeige module inputs}
\item{TempMax}{(optional) [numeric] time series of max air temperature [degC], possibly used to create the CemaNeige module inputs}
\item{TempMax}{(optional) [numeric] time series of max air temperature [°C], possibly used to create the CemaNeige module inputs}
\item{ZInputs}{(optional) [numeric] real giving the mean elevation of the Precip and Temp series (before extrapolation) [m]}
......@@ -30,7 +28,7 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
\item{NLayers}{(optional) [numeric] integer giving the number of elevation layers requested [-], required to create the GR model inputs, default=5}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] object of class \emph{InputsModel} containing the data required to evaluate the model outputs; it can include the following:
......@@ -39,7 +37,7 @@ CreateInputsModel(FUN_MOD, DatesR, Precip, PotEvap = NULL, TempMean = NULL,
\emph{$Precip } \tab [numeric] time series of total precipitation (catchment average) [mm] \cr
\emph{$PotEvap } \tab [numeric] time series of potential evapotranspiration (catchment average) [mm], \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], \cr\tab defined if FUN_MOD includes CemaNeige \cr \cr
\emph{$LayerTempMean } \tab [list] list of time series of mean air temperature (layer average) [degC], \cr\tab defined if 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 FUN_MOD includes CemaNeige \cr \cr
\emph{$LayerFracSolidPrecip} \tab [list] list of time series of solid precipitation fraction (layer average) [-], \cr\tab defined if FUN_MOD includes CemaNeige \cr \cr
}
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CreateRunOptions.R
\encoding{UTF-8}
\name{CreateRunOptions}
\alias{CreateRunOptions}
......@@ -8,7 +6,7 @@
CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
IniStates = NULL, IniResLevels = NULL, Outputs_Cal = NULL,
Outputs_Sim = "all", RunSnowModule = TRUE, MeanAnSolidPrecip = NULL,
quiet = FALSE)
verbose = TRUE)
}
\arguments{
\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)}
......@@ -24,7 +22,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
\item{IniResLevels}{(optional) [numeric] vector of initial filling rates for production and routing stores (2 values between 0 and 1) [-]}
\item{Outputs_Cal}{(optional) [character] vector giving the outputs needed for the calibration \cr (e.g. c("Qsim")), the fewer outputs
the fastest the calibration}
the faster the calibration}
\item{Outputs_Sim}{(optional) [character] vector giving the requested outputs \cr (e.g. c("DatesR","Qsim","SnowPack")), default="all"}
......@@ -32,7 +30,7 @@ CreateRunOptions(FUN_MOD, InputsModel, IndPeriod_WarmUp = NULL, IndPeriod_Run,
\item{MeanAnSolidPrecip}{(optional) [numeric] vector giving the annual mean of average solid precipitation for each layer (computed from InputsModel if not defined) [mm/y]}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] object of class \emph{RunOptions} containing the data required to evaluate the model outputs; it can include the following:
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/DataAltiExtrapolation_Valery.R
\encoding{UTF-8}
\name{DataAltiExtrapolation_Valery}
\alias{DataAltiExtrapolation_Valery}
\title{Altitudinal extrapolation of precipitation and temperature series described by A. Valéry}
\usage{
DataAltiExtrapolation_Valery(DatesR, Precip, TempMean, TempMin = NULL,
TempMax = NULL, ZInputs, HypsoData, NLayers, quiet = FALSE)
TempMax = NULL, ZInputs, HypsoData, NLayers, verbose = TRUE)
}
\arguments{
\item{DatesR}{[POSIXlt] vector of dates}
\item{Precip}{[numeric] time series of daily total precipitation (catchment average) [mm]}
\item{TempMean}{[numeric] time series of daily mean air temperature [degC]}
\item{TempMean}{[numeric] time series of daily mean air temperature [°C]}
\item{TempMin}{(optional) [numeric] time series of daily min air temperature [degC]}
\item{TempMin}{(optional) [numeric] time series of daily min air temperature [°C]}
\item{TempMax}{(optional) [numeric] time series of daily max air temperature [degC]}
\item{TempMax}{(optional) [numeric] time series of daily max air temperature [°C]}
\item{ZInputs}{[numeric] real giving the mean elevation of the Precip and Temp series (before extrapolation) [m]}
......@@ -25,15 +23,15 @@ DataAltiExtrapolation_Valery(DatesR, Precip, TempMean, TempMin = NULL,
\item{NLayers}{[numeric] integer giving the number of elevation layers requested [-]}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=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] \cr
\emph{$LayerTempMean } \tab [list] list of time series of daily mean air temperature (layer average) [degC] \cr
\emph{$LayerTempMin } \tab [list] list of time series of daily min air temperature (layer average) [degC] \cr
\emph{$LayerTempMax } \tab [list] list of time series of daily max air temperature (layer average) [degC] \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
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit.R
\encoding{UTF-8}
\name{ErrorCrit}
\alias{ErrorCrit}
\title{Error criterion using the provided function}
\usage{
ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, quiet = FALSE)
ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, verbose = TRUE)
}
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
......@@ -14,7 +12,7 @@ ErrorCrit(InputsCrit, OutputsModel, FUN_CRIT, quiet = FALSE)
\item{FUN_CRIT}{[function] error criterion function (e.g. ErrorCrit_RMSE, ErrorCrit_NSE)}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] list containing the function outputs, see \code{\link{ErrorCrit_RMSE}} or \code{\link{ErrorCrit_NSE}} for details
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_KGE.R
\encoding{UTF-8}
\name{ErrorCrit_KGE}
\alias{ErrorCrit_KGE}
\title{Error criterion based on the KGE formula}
\usage{
ErrorCrit_KGE(InputsCrit, OutputsModel, quiet = FALSE)
ErrorCrit_KGE(InputsCrit, OutputsModel, verbose = TRUE)
}
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
\item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] list containing the function outputs organised as follows:
......@@ -20,7 +18,7 @@ ErrorCrit_KGE(InputsCrit, OutputsModel, quiet = FALSE)
\emph{$CritValue } \tab [numeric] value of the criterion \cr
\emph{$CritName } \tab [character] name of the criterion \cr
\emph{$SubCritValues } \tab [numeric] values of the sub-criteria \cr
\emph{$SubCritNames } \tab [character] names of the sub-criteria \cr
\emph{$SubCritNames } \tab [character] names of the components of the criterion \cr
\emph{$CritBestValue } \tab [numeric] theoretical best criterion value \cr
\emph{$Multiplier } \tab [numeric] integer indicating whether the criterion is indeed an error (+1) or an efficiency (-1) \cr
\emph{$Ind_notcomputed} \tab [numeric] indices of the time steps where InputsCrit$BoolCrit=FALSE or no data is available \cr
......@@ -31,8 +29,7 @@ Function which computes an error criterion based on the KGE formula proposed by
}
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised (Multiplier=-1 for KGE).
}
\examples{
## see example of the ErrorCrit function
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_KGE2.R
\encoding{UTF-8}
\name{ErrorCrit_KGE2}
\alias{ErrorCrit_KGE2}
\title{Error criterion based on the KGE' formula}
\usage{
ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE)
ErrorCrit_KGE2(InputsCrit, OutputsModel, verbose = TRUE)
}
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
\item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] list containing the function outputs organised as follows:
......@@ -20,7 +18,7 @@ ErrorCrit_KGE2(InputsCrit, OutputsModel, quiet = FALSE)
\emph{$CritValue } \tab [numeric] value of the criterion \cr
\emph{$CritName } \tab [character] name of the criterion \cr
\emph{$SubCritValues } \tab [numeric] values of the sub-criteria \cr
\emph{$SubCritNames } \tab [character] names of the sub-criteria \cr
\emph{$SubCritNames } \tab [character] names of the components of the criterion \cr
\emph{$CritBestValue } \tab [numeric] theoretical best criterion value \cr
\emph{$Multiplier } \tab [numeric] integer indicating whether the criterion is indeed an error (+1) or an efficiency (-1) \cr
\emph{$Ind_notcomputed} \tab [numeric] indices of the time steps where InputsCrit$BoolCrit=FALSE or no data is available \cr
......@@ -31,8 +29,7 @@ Function which computes an error criterion based on the KGE' formula proposed by
}
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised (Multiplier=-1 for KGE2).
}
\examples{
## see example of the ErrorCrit function
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_NSE.R
\encoding{UTF-8}
\name{ErrorCrit_NSE}
\alias{ErrorCrit_NSE}
\title{Error criterion based on the NSE formula}
\usage{
ErrorCrit_NSE(InputsCrit, OutputsModel, quiet = FALSE)
ErrorCrit_NSE(InputsCrit, OutputsModel, verbose = TRUE)
}
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
\item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] list containing the function outputs organised as follows:
......@@ -30,7 +28,7 @@ Function which computes an error criterion based on the NSE formula proposed by
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
(Multiplier=-1 for NSE).
}
\examples{
## see example of the ErrorCrit function
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ErrorCrit_RMSE.R
\encoding{UTF-8}
\name{ErrorCrit_RMSE}
\alias{ErrorCrit_RMSE}
\title{Error criterion based on the RMSE}
\usage{
ErrorCrit_RMSE(InputsCrit, OutputsModel, quiet = FALSE)
ErrorCrit_RMSE(InputsCrit, OutputsModel, verbose = TRUE)
}
\arguments{
\item{InputsCrit}{[object of class \emph{InputsCrit}] see \code{\link{CreateInputsCrit}} for details}
\item{OutputsModel}{[object of class \emph{OutputsModel}] see \code{\link{RunModel_GR4J}} or \code{\link{RunModel_CemaNeigeGR4J}} for details}
\item{quiet}{(optional) [boolean] boolean indicating if the function is run in quiet mode or not, default=FALSE}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, default=TRUE}
}
\value{
[list] list containing the function outputs organised as follows:
......@@ -30,7 +28,7 @@ Function which computes an error criterion based on the root mean square error (
\details{
In addition to the criterion value, the function outputs include a multiplier (-1 or +1) which allows
the use of the function for model calibration: the product CritValue*Multiplier is the criterion to be minimised
(e.g. Multiplier=+1 for RMSE, Multiplier=-1 for NSE).
(Multiplier=+1 for RMSE).
}
\examples{
## see example of the ErrorCrit function
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/PEdaily_Oudin.R
\encoding{UTF-8}
\name{PEdaily_Oudin}
\alias{PEdaily_Oudin}
......@@ -10,7 +8,7 @@ PEdaily_Oudin(JD, Temp, LatRad)
\arguments{
\item{JD}{[numeric] time series of julian day [-]}
\item{Temp}{[numeric] time series of daily mean air temperature [degC]}
\item{Temp}{[numeric] time series of daily mean air temperature [°C]}
\item{LatRad}{[numeric] latitude of measurement for the temperature series [rad]}
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel.R
\encoding{UTF-8}
\name{RunModel}
\alias{RunModel}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeige.R
\encoding{UTF-8}
\name{RunModel_CemaNeige}
\alias{RunModel_CemaNeige}
......@@ -15,7 +13,7 @@ RunModel_CemaNeige(InputsModel, RunOptions, Param)
\item{Param}{[numeric] vector of 2 parameters
\tabular{ll}{
CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
}}
}
\value{
......@@ -26,12 +24,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\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 [degC] \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] \cr
\emph{$CemaNeigeLayers[[iLayer]]$Melt } \tab [numeric] series of actual snow melt [mm] \cr
\emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt } \tab [numeric] series of liquid precip. + actual snow melt [mm] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & degC] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: CemaNeige states [mm & °C] \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR4J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR4J}
\alias{RunModel_CemaNeigeGR4J}
......@@ -19,7 +17,7 @@ GR4J X2 \tab intercatchment exchange coefficient [mm/d]
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/degC/d] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
}}
}
\value{
......@@ -44,12 +42,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\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 [degC] \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{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & UH levels [mm], CemaNeige states [mm & degC] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR5J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR5J}
\alias{RunModel_CemaNeigeGR5J}
......@@ -20,7 +18,7 @@ GR5J X3 \tab routing store capacity [mm]
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/degC/d] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
}}
}
\value{
......@@ -45,12 +43,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\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 [degC] \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{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & UH levels [mm], CemaNeige states [mm & degC] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \cr
}
(refer to the provided references or to the package source code for further details on these model outputs)
}
......
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/RunModel_CemaNeigeGR6J.R
\encoding{UTF-8}
\name{RunModel_CemaNeigeGR6J}
\alias{RunModel_CemaNeigeGR6J}
......@@ -21,7 +19,7 @@ GR6J X4 \tab unit hydrograph time constant [d]
GR6J X5 \tab intercatchment exchange threshold [-] \cr
GR6J X6 \tab coefficient for emptying exponential store [mm] \cr
CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d] \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d] \cr
}}
}
\value{
......@@ -48,12 +46,12 @@ CemaNeige X2 \tab degree-day melt coefficient [mm/degC/d]
\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 [degC] \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{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab res. & UH levels [mm], CemaNeige states [mm & degC] \cr
\emph{$StateEnd} \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C] \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