RunModel_GR1A.Rd 4.06 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
% Please edit documentation in R/RunModel_GR1A.R
\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}

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

43
44
## 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
45
46
TimeFormat      <- "daily"
NewTimeFormat   <- "yearly"
47
ConvertFun      <- c("sum", "sum", "mean", "sum")
Delaigue Olivier's avatar
Delaigue Olivier committed
48
YearFirstMonth  <- 09;
49
50
51
NewTabSeries    <- SeriesAggreg(TabSeries = TabSeries, TimeFormat = TimeFormat, 
                                NewTimeFormat = NewTimeFormat, ConvertFun = ConvertFun, 
                                YearFirstMonth = YearFirstMonth)
Delaigue Olivier's avatar
Delaigue Olivier committed
52
BasinObs        <- NewTabSeries
53
names(BasinObs) <- c("DatesR", "P", "E", "T", "Qmm")
Delaigue Olivier's avatar
Delaigue Olivier committed
54
55

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

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

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

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

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

## efficiency criterion: Nash-Sutcliffe Efficiency
75
76
77
78
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
79
80
81

}
\author{
82
Laurent Coron, Claude Michel (March 2015)
Delaigue Olivier's avatar
Delaigue Olivier committed
83
84
}
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
85
Mouelhi S. (2003), 
Delaigue Olivier's avatar
Delaigue Olivier committed
86
87
88
89
      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
}