RunModel_GR4J.Rd 5.32 KB
Newer Older
Delaigue Olivier's avatar
Delaigue Olivier committed
1
% Generated by roxygen2: do not edit by hand
Delaigue Olivier's avatar
Delaigue Olivier committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
% Please edit documentation in R/RunModel_GR4J.R
\encoding{UTF-8}
\name{RunModel_GR4J}
\alias{RunModel_GR4J}
\title{Run with the GR4J hydrological model}
\usage{
RunModel_GR4J(InputsModel, RunOptions, Param)
}
\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
16
\tabular{ll}{                                                                      
Delaigue Olivier's avatar
Delaigue Olivier committed
17
18
19
20
21
22
23
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
}}
}
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
24
25
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
Delaigue Olivier's avatar
Delaigue Olivier committed
26
27
28
         \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
29
         \emph{$Prod    }          \tab [numeric] series of production store level [mm]                        \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
30
31
32
         \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
33
34
35
         \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
Delaigue Olivier's avatar
Delaigue Olivier committed
36
37
38
         \emph{$Exch    }          \tab [numeric] series of potential semi-exchange between catchments [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
39
         \emph{$QD      }          \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d]           \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
40
         \emph{$Qsim    }          \tab [numeric] series of Qsim [mm/d]                                               \cr
41
         \emph{$StateEnd}          \tab [numeric] states at the end of the run (res. levels, UH1 levels, UH2 levels) [mm] \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
42
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
43
44
45
         (refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
46
Function which performs a single run for the GR4J daily lumped model over the test period.
Delaigue Olivier's avatar
Delaigue Olivier committed
47
48
49
50
51
52
}
\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}}.
}
\examples{
53
54
## loading catchment data
library(airGR)
Delaigue Olivier's avatar
Delaigue Olivier committed
55
56
57
data(L0123001)

## preparation of the InputsModel object
58
59
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
60
61

## run period selection
62
63
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y \%H:\%M")=="01/01/1990 00:00"), 
               which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y \%H:\%M")=="31/12/1999 00:00"))
Delaigue Olivier's avatar
Delaigue Olivier committed
64
65

## preparation of the RunOptions object
66
67
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR4J,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
68
69

## simulation
70
71
Param <- c(257.238, 1.012, 88.235, 2.208)
OutputsModel <- RunModel_GR4J(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
72
73

## results preview
74
plot_OutputsModel(OutputsModel = OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
75
76

## efficiency criterion: Nash-Sutcliffe Efficiency
77
78
79
80
InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, 
                                RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
cat(paste("  Crit  ", OutputsCrit$CritName, "  ", round(OutputsCrit$CritValue, 4), "\\n", sep = ""))
Delaigue Olivier's avatar
Delaigue Olivier committed
81
82
83

}
\author{
84
Laurent Coron, Claude Michel, Charles Perrin (December 2013)
Delaigue Olivier's avatar
Delaigue Olivier committed
85
86
}
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
87
88
Perrin, C., C. Michel and V. Andréassian (2003), 
      Improvement of a parsimonious model for streamflow simulation, 
Delaigue Olivier's avatar
Delaigue Olivier committed
89
90
91
92
93
94
95
      Journal of Hydrology, 279(1-4), 275-289, doi:10.1016/S0022-1694(03)00225-7.
}
\seealso{
\code{\link{RunModel_GR5J}}, \code{\link{RunModel_GR6J}}, \code{\link{RunModel_CemaNeigeGR4J}},
         \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
}