RunModel_GR4J.Rd 5.6 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_GR4J}
\alias{RunModel_GR4J}
6
7


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


Delaigue Olivier's avatar
Delaigue Olivier committed
11
12
13
\usage{
RunModel_GR4J(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 4 parameters
22
23
24
25
26
27
  \tabular{ll}{                                                                      
    GR4J X1 \tab production store capacity [mm]             \cr
    GR4J X2 \tab intercatchment exchange coefficient [mm/d] \cr
    GR4J X3 \tab routing store capacity [mm]                \cr
    GR4J X4 \tab unit hydrograph time constant [d]          \cr
  }}
Delaigue Olivier's avatar
Delaigue Olivier committed
28
}
29
30


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


Delaigue Olivier's avatar
Delaigue Olivier committed
59
\description{
60
Function which performs a single run for the GR4J daily lumped model over the test period.
Delaigue Olivier's avatar
Delaigue Olivier committed
61
}
62
63


Delaigue Olivier's avatar
Delaigue Olivier committed
64
65
66
\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}}.
67
68
69
70
\cr
\cr
\if{html}{\figure{diagramGR4J-EN.png}{options: width="60\%" alt="Figure: diagramGR4J-EN.png"}}
\if{latex}{\figure{diagramGR4J-EN.pdf}{options: width=6cm}}
Delaigue Olivier's avatar
Delaigue Olivier committed
71
}
72
73


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

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

## preparation of the InputsModel object
81
82
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
83
84

## run period selection
85
86
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d")=="1990-01-01"), 
               which(format(BasinObs$DatesR, format = "\%Y-\%m-\%d")=="1999-12-31"))
Delaigue Olivier's avatar
Delaigue Olivier committed
87
88

## preparation of the RunOptions object
89
90
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR4J,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
91
92

## simulation
93
94
95
Param <- c(X1 = 257.238, X2 = 1.012, X3 = 88.235, X4 = 2.208)
OutputsModel <- RunModel_GR4J(InputsModel = InputsModel,
                              RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
96
97

## results preview
98
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
99
100

## efficiency criterion: Nash-Sutcliffe Efficiency
101
InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, 
102
                                RunOptions = RunOptions, Obs = BasinObs$Qmm[Ind_Run])
103
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
Delaigue Olivier's avatar
Delaigue Olivier committed
104
}
105
106


Delaigue Olivier's avatar
Delaigue Olivier committed
107
\author{
108
Laurent Coron, Claude Michel, Charles Perrin, Olivier Delaigue
Delaigue Olivier's avatar
Delaigue Olivier committed
109
}
110
111


Delaigue Olivier's avatar
Delaigue Olivier committed
112
\references{
113
114
Perrin, C., C. Michel and V. Andréassian (2003). 
  Improvement of a parsimonious model for streamflow simulation. 
115
  Journal of Hydrology, 279(1-4), 275-289. doi: 10.1016/S0022-1694(03)00225-7.
Delaigue Olivier's avatar
Delaigue Olivier committed
116
}
117
118


Delaigue Olivier's avatar
Delaigue Olivier committed
119
120
\seealso{
\code{\link{RunModel_GR5J}}, \code{\link{RunModel_GR6J}}, \code{\link{RunModel_CemaNeigeGR4J}},
121
\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
Delaigue Olivier's avatar
Delaigue Olivier committed
122
123
}