RunModel_GR2M.Rd 4.34 KB
Newer Older
Delaigue Olivier's avatar
Delaigue Olivier committed
1
\encoding{UTF-8}
2
3


Delaigue Olivier's avatar
Delaigue Olivier committed
4
5
\name{RunModel_GR2M}
\alias{RunModel_GR2M}
6
7


Delaigue Olivier's avatar
Delaigue Olivier committed
8
\title{Run with the GR2M hydrological model}
9
10


Delaigue Olivier's avatar
Delaigue Olivier committed
11
12
13
\usage{
RunModel_GR2M(InputsModel, RunOptions, Param)
}
14
15


Delaigue Olivier's avatar
Delaigue Olivier committed
16
17
18
19
20
\arguments{
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}

\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}

21
\item{Param}{[numeric] vector of 2 parameters
Delaigue Olivier's avatar
Delaigue Olivier committed
22
\tabular{ll}{                                                                      
Delaigue Olivier's avatar
Delaigue Olivier committed
23
GR2M X1      \tab production store capacity [mm]                 \cr
24
GR2M X2      \tab groundwater exchange coefficient [-]    \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
25
26
}}
}
27
28


Delaigue Olivier's avatar
Delaigue Olivier committed
29
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
30
31
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
32
33
34
         \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
35
         \emph{$Qsim    }          \tab [numeric] series of simulated discharge [mm/month]                                                \cr
36
         \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
Delaigue Olivier's avatar
Delaigue Olivier committed
37
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
38
39
         (refer to the provided references or to the package source code for further details on these model outputs)
}
40
41


Delaigue Olivier's avatar
Delaigue Olivier committed
42
\description{
43
Function which performs a single run for the GR2M monthly lumped model over the test period.
Delaigue Olivier's avatar
Delaigue Olivier committed
44
}
45
46


Delaigue Olivier's avatar
Delaigue Olivier committed
47
48
49
50
\details{
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
}
51
52


Delaigue Olivier's avatar
Delaigue Olivier committed
53
\examples{
54
library(airGR)
unknown's avatar
unknown committed
55
56

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
57
58
data(L0123001)

59
60
## conversion of example data from daily to monthly time step
TabSeries       <- data.frame(BasinObs$DatesR, BasinObs$P, BasinObs$E, BasinObs$T, BasinObs$Qmm)
Delaigue Olivier's avatar
Delaigue Olivier committed
61
62
TimeFormat      <- "daily"
NewTimeFormat   <- "monthly"
63
64
65
ConvertFun      <- c("sum", "sum", "mean", "sum")
NewTabSeries    <- SeriesAggreg(TabSeries = TabSeries, TimeFormat = TimeFormat, 
                                NewTimeFormat = NewTimeFormat, ConvertFun = ConvertFun)
Delaigue Olivier's avatar
Delaigue Olivier committed
66
BasinObs        <- NewTabSeries
67
names(BasinObs) <- c("DatesR", "P", "E", "T", "Qmm")
Delaigue Olivier's avatar
Delaigue Olivier committed
68
69

## preparation of the InputsModel object
70
71
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR2M, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
72
73

## run period selection
74
75
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%m/\%Y")=="01/1990"), 
               which(format(BasinObs$DatesR, format = "\%m/\%Y")=="12/1999"))
Delaigue Olivier's avatar
Delaigue Olivier committed
76
77

## preparation of the RunOptions object
78
79
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR2M,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
80
81

## simulation
82
83
Param <- c(265.072, 1.040)
OutputsModel <- RunModel_GR2M(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
84
85

## results preview
86
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
87
88

## efficiency criterion: Nash-Sutcliffe Efficiency
89
90
91
InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, 
                                RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
Delaigue Olivier's avatar
Delaigue Olivier committed
92
}
93
94


Delaigue Olivier's avatar
Delaigue Olivier committed
95
\author{
96
Laurent Coron, Claude Michel, Safouane Mouelhi
Delaigue Olivier's avatar
Delaigue Olivier committed
97
}
98
99


Delaigue Olivier's avatar
Delaigue Olivier committed
100
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
101
Mouelhi S. (2003), 
Delaigue Olivier's avatar
Delaigue Olivier committed
102
103
104
105
106
107
      Vers une chaîne cohérente de modèles pluie-débit conceptuels globaux aux pas de temps pluriannuel, annuel, mensuel et journalier,
      PhD thesis (in French), ENGREF, Cemagref Antony, France. \cr
  Mouelhi, S., C. Michel, C. Perrin and V. Andréassian (2006),
      Stepwise development of a two-parameter monthly water balance model,
      Journal of Hydrology, 318(1-4), 200-214, doi:10.1016/j.jhydrol.2005.06.014.
}
108
109


110
\seealso{
111
\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
112
}