RunModel_GR1A.Rd 3.92 KB
Newer Older
Delaigue Olivier's avatar
Delaigue Olivier committed
1
2
3
4
5
6
7
8
9
10
11
12
\encoding{UTF-8}
\name{RunModel_GR1A}
\alias{RunModel_GR1A}
\title{Run with the GR1A hydrological model}
\usage{
RunModel_GR1A(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}

13
\item{Param}{[numeric] vector of 1 parameter
Delaigue Olivier's avatar
Delaigue Olivier committed
14
\tabular{ll}{                                                                      
15
GR1A X1      \tab model parameter [-] \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
16
17
18
}}
}
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
19
20
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
21
22
23
         \emph{$DatesR  }          \tab [POSIXlt] series of dates                                                     \cr
         \emph{$PotEvap }          \tab [numeric] series of input potential evapotranspiration [mm/y]                 \cr
         \emph{$Precip  }          \tab [numeric] series of input total precipitation [mm/y]                          \cr
24
         \emph{$Qsim    }          \tab [numeric] series of simulated discharge [mm/y]                                               \cr
25
         \emph{$StateEnd}          \tab [numeric] states at the end of the run (NULL) [-] \cr         
Delaigue Olivier's avatar
Delaigue Olivier committed
26
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
27
28
29
         (refer to the provided references or to the package source code for further details on these model outputs)
}
\description{
30
Function which performs a single run for the GR1A annual lumped model over the test period.
Delaigue Olivier's avatar
Delaigue Olivier committed
31
32
33
34
35
36
}
\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{
37
library(airGR)
unknown's avatar
unknown committed
38
39

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
40
41
data(L0123001)

42
43
## conversion of example data from daily to yearly time step
TabSeries       <- data.frame(BasinObs$DatesR, BasinObs$P, BasinObs$E, BasinObs$T, BasinObs$Qmm)
Delaigue Olivier's avatar
Delaigue Olivier committed
44
45
TimeFormat      <- "daily"
NewTimeFormat   <- "yearly"
46
ConvertFun      <- c("sum", "sum", "mean", "sum")
Delaigue Olivier's avatar
Delaigue Olivier committed
47
YearFirstMonth  <- 09;
48
49
50
NewTabSeries    <- SeriesAggreg(TabSeries = TabSeries, TimeFormat = TimeFormat, 
                                NewTimeFormat = NewTimeFormat, ConvertFun = ConvertFun, 
                                YearFirstMonth = YearFirstMonth)
Delaigue Olivier's avatar
Delaigue Olivier committed
51
BasinObs        <- NewTabSeries
52
names(BasinObs) <- c("DatesR", "P", "E", "T", "Qmm")
Delaigue Olivier's avatar
Delaigue Olivier committed
53
54

## preparation of the InputsModel object
55
56
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR1A, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)
Delaigue Olivier's avatar
Delaigue Olivier committed
57
58

## run period selection
59
60
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y")=="1990"), 
               which(format(BasinObs$DatesR, format = "\%Y")=="1999"))
Delaigue Olivier's avatar
Delaigue Olivier committed
61
62

## preparation of the RunOptions object
63
64
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR1A,
                               InputsModel = InputsModel, IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
65
66
67

## simulation
Param <- c(0.840)
68
OutputsModel <- RunModel_GR1A(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
69
70

## results preview
71
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
72
73

## efficiency criterion: Nash-Sutcliffe Efficiency
74
75
76
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
77
78
}
\author{
79
Laurent Coron, Claude Michel
Delaigue Olivier's avatar
Delaigue Olivier committed
80
81
}
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
82
Mouelhi S. (2003), 
Delaigue Olivier's avatar
Delaigue Olivier committed
83
84
85
      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
}
86
\seealso{
87
\code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
88
}
Delaigue Olivier's avatar
Delaigue Olivier committed
89