RunModel_GR2M.Rd 6.24 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}{                                                                      
23
24
GR2M X1 \tab production store capacity [mm]        \cr
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
           \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{$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
         }                                                                                                     
         (refer to the provided references or to the package source code for further details on these model outputs)
}


\value{
[list] 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{$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 (res. levels, UH1 levels, UH2 levels) [mm], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
57
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
58
59
         (refer to the provided references or to the package source code for further details on these model outputs)
}
60
61


Delaigue Olivier's avatar
Delaigue Olivier committed
62
\description{
63
Function which performs a single run for the GR2M monthly lumped model over the test period.
Delaigue Olivier's avatar
Delaigue Olivier committed
64
}
65
66


Delaigue Olivier's avatar
Delaigue Olivier committed
67
68
69
70
\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}}.
}
71
72


Delaigue Olivier's avatar
Delaigue Olivier committed
73
\examples{
74
library(airGR)
unknown's avatar
unknown committed
75
76

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
77
78
data(L0123001)

79
80
## 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
81
82
TimeFormat      <- "daily"
NewTimeFormat   <- "monthly"
83
84
85
ConvertFun      <- c("sum", "sum", "mean", "sum")
NewTabSeries    <- SeriesAggreg(TabSeries = TabSeries, TimeFormat = TimeFormat, 
                                NewTimeFormat = NewTimeFormat, ConvertFun = ConvertFun)
Delaigue Olivier's avatar
Delaigue Olivier committed
86
BasinObs        <- NewTabSeries
87
names(BasinObs) <- c("DatesR", "P", "E", "T", "Qmm")
Delaigue Olivier's avatar
Delaigue Olivier committed
88
89

## preparation of the InputsModel object
90
91
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR2M, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
92
93

## run period selection
94
95
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
96
97

## preparation of the RunOptions object
98
99
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR2M,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
100
101

## simulation
102
103
Param <- c(265.072, 1.040)
OutputsModel <- RunModel_GR2M(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
104
105

## results preview
106
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
107
108

## efficiency criterion: Nash-Sutcliffe Efficiency
109
110
111
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
112
}
113
114


Delaigue Olivier's avatar
Delaigue Olivier committed
115
\author{
116
Laurent Coron, Claude Michel, Safouane Mouelhi
Delaigue Olivier's avatar
Delaigue Olivier committed
117
}
118
119


Delaigue Olivier's avatar
Delaigue Olivier committed
120
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
121
Mouelhi S. (2003), 
Delaigue Olivier's avatar
Delaigue Olivier committed
122
123
124
125
126
127
      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.
}
128
129


130
\seealso{
131
\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
132
}