Commit e70b9ae3 authored by unknown's avatar unknown
Browse files

v1.0.9.6 CreateIniStates documentation updated

parent d7cefc68
Package: airGR Package: airGR
Type: Package Type: Package
Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling Title: Suite of GR Hydrological Models for Precipitation-Runoff Modelling
Version: 1.0.9.5 Version: 1.0.9.6
Date: 2017-06-26 Date: 2017-06-26
Authors@R: c( Authors@R: c(
person("Laurent", "Coron", role = c("aut", "trl")), person("Laurent", "Coron", role = c("aut", "trl")),
......
...@@ -42,24 +42,24 @@ CreateIniStates(FUN_MOD, InputsModel, ...@@ -42,24 +42,24 @@ CreateIniStates(FUN_MOD, InputsModel,
\value{ \value{
[list] object of class \code{IniStates} containing the initial model internal states; it includes the following: [list] object of class \code{IniStates} containing the initial model internal states; it always includes the following:
\tabular{ll}{ \tabular{ll}{
\emph{$Store } \tab [numeric] list of store levels (always \emph{$Prod}, \emph{$Rout} and \emph{$Exp}) \cr \emph{$Store } \tab [numeric] list of store levels (\emph{$Prod}, \emph{$Rout} and \emph{$Exp}) \cr
\emph{$UH } \tab [numeric] list of unit hydrographs levels (always \emph{$UH1} and \emph{$UH2} \cr \emph{$UH } \tab [numeric] list of unit hydrographs levels (\emph{$UH1} and \emph{$UH2}) \cr
\emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (always \emph{$G} and \emph{$eTG}) \emph{$CemaNeigeLayers} \tab [numeric] list of CemaNeige variables (\emph{$G} and \emph{$eTG})
} }
} }
\description{ \description{
Creation of the IniStates object possibly required by the CreateRunOptions functions Creation of the \code{IniStates} object possibly required by the \code{\link{CreateRunOptions}} functions
} }
\details{ \details{
20 floats are required for UH1 and 40 floats are required for UH2 (repectivly 20*24 and 40*24 for the daily model GR4H). \cr 20 numeric values are required for UH1 and 40 numeric values are required for UH2 if GR4J, GR5J or GR6J are used (respectivly 20*24 and 40*24 for the daily model GR4H). \cr
NLayers floats are required for GCemaNeigeLayers and eTGCemaNeigeLayers. \cr GCemaNeigeLayers and eTGCemaNeigeLayers require each numeric values as many as given in \code{\link{CreateInputsModel}} with the NLayersargument. \cr
The structure of the object of class \code{IniStates} returned is always the exactly same for all models(except for the unit hydrographs more longer with GR4H), even some states don't exist (e.g. \emph{$UH$UH1} for GR2M). \cr The structure of the object of class \code{IniStates} returned is always exactly the same for all models (except for the unit hydrographs levels that contain more values with GR4H), even if some states do nt exist (e.g. \emph{$UH$UH1} for GR2M). \cr
If CemaNeige is not used , \emph{$CemaNeigeLayers$G} and \emph{$CemaNeigeLayers$eTG} are set to \code{NA}. \cr If CemaNeige is not used, \emph{$CemaNeigeLayers$G} and \emph{$CemaNeigeLayers$eTG} are set to \code{NA}. \cr
Nota: the \code{StateEnd} objects from the outputs of \code{RunModel*} functions already respect the format given by the \code{CreateIniStates} function. Nota: the \code{StateEnd} objects from the outputs of \code{RunModel*} functions already respect the format given by the \code{CreateIniStates} function.
} }
......
...@@ -73,7 +73,7 @@ The actual length of this warm-up might be shorter depending on data availabilit ...@@ -73,7 +73,7 @@ The actual length of this warm-up might be shorter depending on data availabilit
\itemize{ \itemize{
\item \code{IndPeriod_WarmUp} can be used to specify the indices of the warm-up period (within the time series prepared in InputsModel). \cr \item \code{IndPeriod_WarmUp} can be used to specify the indices of the warm-up period (within the time series prepared in InputsModel). \cr
- remark 1: for most common cases, indices corresponding to one or several years preceding \code{IndPeriod_Run} are used (e.g. \code{IndPeriod_WarmUp = 1000:1365} and \code{IndPeriod_Run = 1366:5000)}. \cr - remark 1: for most common cases, indices corresponding to one or several years preceding \code{IndPeriod_Run} are used (e.g. \code{IndPeriod_WarmUp = 1000:1365} and \code{IndPeriod_Run = 1366:5000)}. \cr
However, it is also possible to perform a long-term initialisation if other indices than the warm-up ones are set in \code{IndPeriod_WarmUp} (e.g. \code{IndPeriod_WarmUp <- c(1:5000 , 1:5000 , 1:5000 , 1000:1365)}). \cr However, it is also possible to perform a long-term initialisation if other indices than the warm-up ones are set in \code{IndPeriod_WarmUp} (e.g. \code{IndPeriod_WarmUp <- c(1:5000, 1:5000, 1:5000, 1000:1365)}). \cr
- remark 2: it is also possible to completely disable the warm-up period when using \code{IndPeriod_WarmUp = 0L}. This is necessary if you want \code{IniStates} and / or \code{IniResLevels} to be the actual initial values of the model variables from your simulation (e.g. to perform a forecast form a given initial state). - remark 2: it is also possible to completely disable the warm-up period when using \code{IndPeriod_WarmUp = 0L}. This is necessary if you want \code{IniStates} and / or \code{IniResLevels} to be the actual initial values of the model variables from your simulation (e.g. to perform a forecast form a given initial state).
\item \code{IniStates} and \code{IniResLevels} can be used to specify the initial model states. \cr \item \code{IniStates} and \code{IniResLevels} can be used to specify the initial model states. \cr
......
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