Forked from HYCAR-Hydro / airGR
Source project has a limited visibility.
CreateIniStates.Rd 2.45 KiB
\encoding{UTF-8}
\name{CreateIniStates}
\alias{CreateIniStates}
\title{Creation of the IniStates object possible required to the CreateRunOptions functions}
\usage{
CreateIniStates(FUN_MOD, InputsModel,
  ProdStore = 0.3, RoutStore = 0.5, ExpStore = NULL,
  UH1 = NULL, UH2 = NULL,
  GCemaNeigeLayers = NULL, eTGCemaNeigeLayers = NULL,
  verbose = TRUE)
\arguments{
\item{FUN_MOD}{[function] hydrological model function (e.g. RunModel_GR4J, RunModel_CemaNeigeGR4J)}
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
\item{ProdStore}{[numeric]}
\item{RoutStore}{[numeric]}
\item{ExpStore}{[numeric]}
\item{UH1}{[numeric]}
\item{UH2}{[numeric]}
\item{GCemaNeigeLayers}{[numeric]}
\item{eTGCemaNeigeLayers}{[numeric]}
\item{verbose}{(optional) [boolean] boolean indicating if the function is run in verbose mode or not, \code{default = TRUE}}
\value{
[list] object of class \emph{IniStates} containing the initial model internal states; it includes the following:
         \itemize{
         \item{Store          }{}
         \item{UH             }{}
         \item{CemaNeigeLayers}{}
\description{
Creation of the IniStates object required to XXXX
\details{
XXXX
\examples{
library(airGR)
## loading catchment data
data(L0123001)
## preparation of the InputsModel object
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR, 
7172737475767778798081828384858687888990919293949596979899100101102
Precip = BasinObs$P, PotEvap = BasinObs$E) ## run period selection Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y \%H:\%M")=="01/01/1990 00:00"), which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y \%H:\%M")=="31/12/1999 00:00")) ## preparation of the IniStates object IniStates <- CreateIniStates(FUN_MOD = RunModel_GR4J, InputsModel = InputsModel, ProdStore = 0.1, RoutStore = 0.6, ExpStore = NULL, UH1 = c(0.52, 0.54, 0.15, rep(0, 17)), UH2 = c(0.057, 0.042, 0.015, 0.005, rep(0, 36)), GCemaNeigeLayers = NULL, eTGCemaNeigeLayers = NULL) str(IniStates) ## preparation of the RunOptions object RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR4J, InputsModel = InputsModel, IndPeriod_Run = Ind_Run, IniStates = IniStates) } \author{ Olivier Delaigue } \seealso{ \code{\link{CreateRunOptions}} }