Skip to content
GitLab
Select Git revision
  • master default
Find file BlameHistoryPermalink
RunModel_GR1A.Rd 3.92 KiB
1 
\encoding{UTF-8}
2
3
4 
\name{RunModel_GR1A}
5 
\alias{RunModel_GR1A}
6
7
8 
\title{Run with the GR1A hydrological model}
9
10
11 
\usage{
12 
RunModel_GR1A(InputsModel, RunOptions, Param)
13 
}
14
15
16 
\arguments{
17 
\item{InputsModel}{[object of class \emph{InputsModel}] see \code{\link{CreateInputsModel}} for details}
18
19 
\item{RunOptions}{[object of class \emph{RunOptions}] see \code{\link{CreateRunOptions}} for details}
20
21 
\item{Param}{[numeric] vector of 1 parameter
22 
\tabular{ll}{
23 
GR1A X1      \tab model parameter [-] \cr
24 
}}
25 
}
26
27
28 
\value{
29 
[list] list containing the function outputs organised as follows:
30 
         \tabular{ll}{
31 
         \emph{$DatesR  }          \tab [POSIXlt] series of dates                                                     \cr
32 
         \emph{$PotEvap }          \tab [numeric] series of input potential evapotranspiration [mm/y]                 \cr
33 
         \emph{$Precip  }          \tab [numeric] series of input total precipitation [mm/y]                          \cr
34 
         \emph{$Qsim    }          \tab [numeric] series of simulated discharge [mm/y]                                \cr
35 
         \emph{$StateEnd}          \tab [numeric] states at the end of the run (NULL) [-] \cr
36 
         }
37 
         (refer to the provided references or to the package source code for further details on these model outputs)
38 
}
39
40
41 
\description{
42 
Function which performs a single run for the GR1A annual lumped model over the test period.
43 
}
44
45
46 
\details{
47 
For further details on the model, see the references section.
48 
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
49 
}
50
51
52 
\examples{
53 
library(airGR)
54
55 
## loading catchment data
56 
data(L0123001)
57
58 
## conversion of example data from daily to yearly time step
59 
TabSeries       <- data.frame(BasinObs$DatesR, BasinObs$P, BasinObs$E, BasinObs$T, BasinObs$Qmm)
60 
TimeFormat      <- "daily"
61 
NewTimeFormat   <- "yearly"
62 
ConvertFun      <- c("sum", "sum", "mean", "sum")
63 
YearFirstMonth  <- 09;
64 
NewTabSeries    <- SeriesAggreg(TabSeries = TabSeries, TimeFormat = TimeFormat,
65 
                                NewTimeFormat = NewTimeFormat, ConvertFun = ConvertFun,
66 
                                YearFirstMonth = YearFirstMonth)
67 
BasinObs        <- NewTabSeries
68 
names(BasinObs) <- c("DatesR", "P", "E", "T", "Qmm")
69
70 
## preparation of the InputsModel object
7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR1A, DatesR = BasinObs$DatesR, Precip = BasinObs$P, PotEvap = BasinObs$E) ## run period selection Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%Y")=="1990"), which(format(BasinObs$DatesR, format = "\%Y")=="1999")) ## preparation of the RunOptions object RunOptions <- CreateRunOptions(FUN_MOD = RunModel_GR1A, InputsModel = InputsModel, IndPeriod_Run = Ind_Run) ## simulation Param <- c(0.840) OutputsModel <- RunModel_GR1A(InputsModel = InputsModel, RunOptions = RunOptions, Param = Param) ## results preview plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run]) ## efficiency criterion: Nash-Sutcliffe Efficiency InputsCrit <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, RunOptions = RunOptions, Qobs = BasinObs$Qmm[Ind_Run]) OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel) } \author{ Laurent Coron, Claude Michel } \references{ Mouelhi S. (2003), 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 } \seealso{ \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}. }