RunModel_GR4H.Rd 5.05 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_GR4H}
\alias{RunModel_GR4H}
6
7


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


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


Delaigue Olivier's avatar
Delaigue Olivier committed
31
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
32
33
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
         \emph{$DatesR  } \tab [POSIXlt] series of dates                                             \cr
         \emph{$PotEvap } \tab [numeric] series of input potential evapotranspiration [mm/h]         \cr
         \emph{$Precip  } \tab [numeric] series of input total precipitation [mm/h]                  \cr
         \emph{$Prod    } \tab [numeric] series of production store level [mm]                       \cr
         \emph{$AE      } \tab [numeric] series of actual evapotranspiration [mm/h]                  \cr
         \emph{$Perc    } \tab [numeric] series of percolation (PERC) [mm/h]                         \cr
         \emph{$PR      } \tab [numeric] series of PR=Pn-Ps+Perc [mm/h]                              \cr
         \emph{$Q9      } \tab [numeric] series of UH1 outflow (Q9) [mm/h]                           \cr
         \emph{$Q1      } \tab [numeric] series of UH2 outflow (Q1) [mm/h]                           \cr
         \emph{$Rout    } \tab [numeric] series of routing store level [mm]                          \cr
         \emph{$Exch    } \tab [numeric] series of potential semi-exchange between catchments [mm/h] \cr
         \emph{$AExch   } \tab [numeric] series of actual exchange between catchments (1+2) [mm/h]   \cr
         \emph{$QR      } \tab [numeric] series of routing store outflow (QR) [mm/h]                 \cr
         \emph{$QD      } \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/h]   \cr
         \emph{$Qsim    } \tab [numeric] series of simulated discharge [mm/h]                        \cr
         \emph{$StateEnd} \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm], see \code{\link{CreateIniStates}} for more details \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
50
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
51
52
         (refer to the provided references or to the package source code for further details on these model outputs)
}
53
54


Delaigue Olivier's avatar
Delaigue Olivier committed
55
56
57
\description{
Function which performs a single run for the GR4H hourly lumped model.
}
58
59


Delaigue Olivier's avatar
Delaigue Olivier committed
60
61
62
63
\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}}.
}
64
65


Delaigue Olivier's avatar
Delaigue Olivier committed
66
\examples{
unknown's avatar
unknown committed
67
68
library(airGR)

Delaigue Olivier's avatar
Delaigue Olivier committed
69
70
71
72
## load of catchment data
data(L0123003)

## preparation of the InputsModel object
73
74
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4H, DatesR = BasinObs$DatesR,
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
75
76

## run period selection
77
78
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y \%H:\%M")=="01/03/2004 00:00"),
               which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y \%H:\%M")=="31/12/2008 23:00"))
Delaigue Olivier's avatar
Delaigue Olivier committed
79
80

## preparation of the RunOptions object
81
82
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR4H,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
83
84

## simulation
85
86
Param <- c(521.113, -2.918, 218.009, 4.124)
OutputsModel <- RunModel_GR4H(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
87
88

## results preview
89
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
90
91

## efficiency criterion: Nash-Sutcliffe Efficiency
92
InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel,
93
                                RunOptions = RunOptions, obs = BasinObs$Qmm[Ind_Run], varObs = "Q")
94
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
Delaigue Olivier's avatar
Delaigue Olivier committed
95
}
96
97


Delaigue Olivier's avatar
Delaigue Olivier committed
98
\author{
99
Laurent Coron, Charles Perrin, Thibaut Mathevet
Delaigue Olivier's avatar
Delaigue Olivier committed
100
}
101
102


Delaigue Olivier's avatar
Delaigue Olivier committed
103
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
104
105
Mathevet, T. (2005), 
      Quels modèles pluie-débit globaux pour le pas de temps horaire ? Développement empirique et comparaison de modèles sur un large échantillon de bassins versants, 
106
107
108
      PhD thesis (in French), ENGREF - Cemagref (Antony), Paris, France. \cr 
Le Moine, N. (2008), Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances
      et du réalisme des modèles pluie-débit ?, PhD thesis (french), UPMC, Paris, France. \cr      
Delaigue Olivier's avatar
Delaigue Olivier committed
109
}
110
111


Delaigue Olivier's avatar
Delaigue Olivier committed
112
113
\seealso{
\code{\link{RunModel_GR4J}},
114
         \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
Delaigue Olivier's avatar
Delaigue Olivier committed
115
116
}