RunModel_GR6J.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_GR6J}
\alias{RunModel_GR6J}
6
7


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


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


Delaigue Olivier's avatar
Delaigue Olivier committed
16
17
18
19
20
21
\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}

\item{Param}{[numeric] vector of 6 parameters
22
23
24
25
26
27
28
\tabular{ll}{                                                            
GR6J X1      \tab production store capacity [mm]                  \cr
GR6J X2      \tab intercatchment exchange coefficient [mm/d]      \cr
GR6J X3      \tab routing store capacity [mm]                     \cr
GR6J X4      \tab unit hydrograph time constant [d]               \cr
GR6J X5      \tab intercatchment exchange threshold [-]           \cr
GR6J X6      \tab coefficient for emptying exponential store [mm] \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
29
30
}}
}
31
32


Delaigue Olivier's avatar
Delaigue Olivier committed
33
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
34
35
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
Delaigue Olivier's avatar
Delaigue Olivier committed
36
37
38
         \emph{$DatesR  }          \tab [POSIXlt] series of dates                                                     \cr
         \emph{$PotEvap }          \tab [numeric] series of input potential evapotranspiration [mm/d]                 \cr
         \emph{$Precip  }          \tab [numeric] series of input total precipitation [mm/d]                          \cr
39
40
         \emph{$Prod    }          \tab [numeric] series of production store level [mm]                               \cr
         \emph{$Pn      }          \tab [numeric] series of net rainfall [mm/d]                         			        \cr
41
         \emph{$Ps      }          \tab [numeric] series of the part of Pn filling the production store [mm/d]        \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
42
43
         \emph{$AE      }          \tab [numeric] series of actual evapotranspiration [mm/d]                          \cr
         \emph{$Perc    }          \tab [numeric] series of percolation (PERC) [mm/d]                                 \cr
44
         \emph{$PR      }          \tab [numeric] series of PR=Pn-Ps+Perc [mm/d]                                      \cr
45
46
         \emph{$Q9      }          \tab [numeric] series of UH1 outflow (Q9) [mm/d]                                   \cr
         \emph{$Q1      }          \tab [numeric] series of UH2 outflow (Q1) [mm/d]                                   \cr
47
         \emph{$Rout    }          \tab [numeric] series of routing store level [mm]                                  \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
48
         \emph{$Exch    }          \tab [numeric] series of potential semi-exchange between catchments [mm/d]         \cr
49
50
         \emph{$AExch1  }          \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d]    \cr
         \emph{$AExch2  }          \tab [numeric] series of actual exchange between catchments for branch 2 [mm/d]    \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
51
52
         \emph{$AExch   }          \tab [numeric] series of actual exchange between catchments (1+2) [mm/d]           \cr
         \emph{$QR      }          \tab [numeric] series of routing store outflow (QR) [mm/d]                         \cr
53
54
         \emph{$QRExp   }          \tab [numeric] series of exponential store outflow (QRExp) [mm/d]                  \cr
         \emph{$Exp     }          \tab [numeric] series of exponential store level (negative) [mm]                   \cr
55
         \emph{$QD      }          \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d]           \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
56
         \emph{$Qsim    }          \tab [numeric] series of Qsim [mm/d]                                               \cr
57
         \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
58
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
59
60
         (refer to the provided references or to the package source code for further details on these model outputs)
}
61
62


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


Delaigue Olivier's avatar
Delaigue Olivier committed
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
73
74
\cr
\cr
\if{html}{\figure{diagramGR6J-EN.png}{options: width="60\%" alt="Figure: diagramGR6J-EN.png"}}
\if{latex}{\figure{diagramGR6J-EN.pdf}{options: width=6cm}}
Delaigue Olivier's avatar
Delaigue Olivier committed
75
}
76
77


Delaigue Olivier's avatar
Delaigue Olivier committed
78
\examples{
79
library(airGR)
unknown's avatar
unknown committed
80
81

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
82
83
84
data(L0123001)

## preparation of the InputsModel object
85
86
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR6J, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
87
88

## run period selection
89
90
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y")=="01/01/1990"), 
               which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y")=="31/12/1999"))
Delaigue Olivier's avatar
Delaigue Olivier committed
91
92

## preparation of the RunOptions object
93
94
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR6J,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
95
96

## simulation
97
98
Param <- c(242.257, 0.637, 53.517, 2.218, 0.424, 4.759)
OutputsModel <- RunModel_GR6J(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
99
100

## results preview
101
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
102
103

## efficiency criterion: Nash-Sutcliffe Efficiency
104
105
106
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
107
}
108
109


Delaigue Olivier's avatar
Delaigue Olivier committed
110
\author{
111
Laurent Coron, Claude Michel, Charles Perrin, Raji Pushpalatha, Nicolas Le Moine
Delaigue Olivier's avatar
Delaigue Olivier committed
112
}
113
114


Delaigue Olivier's avatar
Delaigue Olivier committed
115
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
116
117
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011), 
      A downward structural sensitivity analysis of hydrological models to improve low-flow simulation, 
Delaigue Olivier's avatar
Delaigue Olivier committed
118
119
      Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
}
120
121


Delaigue Olivier's avatar
Delaigue Olivier committed
122
123
\seealso{
\code{\link{RunModel_GR4J}}, \code{\link{RunModel_GR5J}}, \code{\link{RunModel_CemaNeigeGR6J}},
124
         \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
Delaigue Olivier's avatar
Delaigue Olivier committed
125
126
}