RunModel_CemaNeigeGR6J.Rd 10.5 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_CemaNeigeGR6J}
\alias{RunModel_CemaNeigeGR6J}
6
7


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


Delaigue Olivier's avatar
Delaigue Olivier committed
11
\usage{
12
RunModel_CemaNeigeGR6J(InputsModel, RunOptions, Param, IsHyst = FALSE)
Delaigue Olivier's avatar
Delaigue Olivier committed
13
}
14
15


Delaigue Olivier's avatar
Delaigue Olivier committed
16
17
18
19
20
\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}

21
\item{Param}{[numeric] vector of 8 (or 10 parameters if \code{IsHyst = TRUE})
22
\tabular{ll}{                                                                  
23
24
25
26
27
28
29
30
31
32
GR6J X1      \tab production store capacity [mm]                                          \cr
GR6J X2      \tab intercatchment exchange coefficient [mm/d]                              \cr
GR6J X3      \tab routing store capacity [mm]                                             \cr
GR6J X4      \tab unit hydrograph time constant [d]                                       \cr
GR6J X5      \tab intercatchment exchange threshold [-]                                   \cr
GR6J X6      \tab coefficient for emptying exponential store [mm]                         \cr
CemaNeige X1 \tab weighting coefficient for snow pack thermal state [-]                   \cr
CemaNeige X2 \tab degree-day melt coefficient [mm/°C/d]                                   \cr
CemaNeige X3 \tab (optional) accumulation threshold [mm] (needed if \code{IsHyst = TRUE}) \cr
CemaNeige X4 \tab (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if \code{IsHyst = TRUE})\cr
Delaigue Olivier's avatar
Delaigue Olivier committed
33
}}
34
\item{IsHyst}{[boolean] boolean indicating if the hysteresis version of CemaNeige is used. See details}
Delaigue Olivier's avatar
Delaigue Olivier committed
35
}
36
37


Delaigue Olivier's avatar
Delaigue Olivier committed
38
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
39
40
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
         \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
         \emph{$Prod   }          \tab [numeric] series of production store level [mm]                                       \cr
         \emph{$Pn     }          \tab [numeric] series of net rainfall [mm/d]                         			                 \cr
         \emph{$Ps     }          \tab [numeric] series of the part of Ps filling the production store [mm/d]                \cr
         \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
         \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
         \emph{$Exch   }          \tab [numeric] series of potential semi-exchange between catchments [mm/d]                 \cr
         \emph{$AExch1 }          \tab [numeric] series of actual exchange between catchments for branch 1 [mm/d]            \cr
         \emph{$AExch2 }          \tab [numeric] series of actual exchange between catchments for branch 2 [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
         \emph{$QRExp  }          \tab [numeric] series of exponential store outflow (QRExp) [mm/d]                          \cr
         \emph{$Exp    }          \tab [numeric] series of exponential store level (negative) [mm]                           \cr
         \emph{$QD     }          \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d]                   \cr
         \emph{$Qsim   }          \tab [numeric] series of Qsim [mm/d]                                                       \cr
         \emph{$CemaNeigeLayers}   \tab [list] list of CemaNeige outputs (1 list per layer)                                  \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Pliq         }   \tab [numeric] series of liquid precip. [mm/d]                    \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Psol         }   \tab [numeric] series of solid precip. [mm/d]                     \cr
         \emph{$CemaNeigeLayers[[iLayer]]$SnowPack     }   \tab [numeric] series of snow pack [mm]                           \cr
         \emph{$CemaNeigeLayers[[iLayer]]$ThermalState }   \tab [numeric] series of snow pack thermal state [°C]             \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Gratio       }   \tab [numeric] series of Gratio [0-1]                             \cr
         \emph{$CemaNeigeLayers[[iLayer]]$PotMelt      }   \tab [numeric] series of potential snow melt [mm/d]               \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Melt         }   \tab [numeric] series of actual snow melt [mm/d]                  \cr
         \emph{$CemaNeigeLayers[[iLayer]]$PliqAndMelt  }   \tab [numeric] series of liquid precip. + actual snow melt [mm/d] \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Temp         }   \tab [numeric] series of air temperature [°C]                     \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Gthreshold   }   \tab [numeric] series of melt threshold [mm]                      \cr
         \emph{$CemaNeigeLayers[[iLayer]]$Glocalmax    }   \tab [numeric] series of local melt threshold for hysteresis [mm] \cr
74
         \emph{$StateEnd}                                  \tab [numeric] states at the end of the run: \cr\tab store & unit hydrographs levels [mm], CemaNeige states [mm & °C], \cr\tab see \code{\link{CreateIniStates}} for more details \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
75
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
76
77
         (refer to the provided references or to the package source code for further details on these model outputs)
}
78
79


Delaigue Olivier's avatar
Delaigue Olivier committed
80
81
82
\description{
Function which performs a single run for the CemaNeige-GR6J daily lumped model.
}
83
84


Delaigue Olivier's avatar
Delaigue Olivier committed
85
\details{
86
87
The use of the \code{IsHyst} argument is explained in \code{\link{RunModel_CemaNeigeGR4J}}. \cr
For further details on the model, see the references section. \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
88
89
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
}
90
91


Delaigue Olivier's avatar
Delaigue Olivier committed
92
\examples{
93
library(airGR)
unknown's avatar
unknown committed
94
95

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
96
97
98
data(L0123002)

## preparation of the InputsModel object
99
100
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_CemaNeigeGR6J, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E, TempMean = BasinObs$T, 
101
                                 ZInputs = median(BasinInfo$HypsoData),
102
                                 HypsoData = BasinInfo$HypsoData, NLayers = 5)
Delaigue Olivier's avatar
Delaigue Olivier committed
103
104

## run period selection
105
106
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y")=="01/01/1990"), 
               which(format(BasinObs$DatesR, format = "\%d/\%m/\%Y")=="31/12/1999"))
Delaigue Olivier's avatar
Delaigue Olivier committed
107
108

## preparation of the RunOptions object
109
110
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR6J, InputsModel = InputsModel, 
                               IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
111
112

## simulation
113
114
115
Param <- c(116.482, 0.500, 72.733, 1.224, 0.278, 30.333, 0.977, 2.776)
OutputsModel <- RunModel_CemaNeigeGR6J(InputsModel = InputsModel,
                                       RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
116
117

## results preview
118
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
119
120

## efficiency criterion: Nash-Sutcliffe Efficiency
121
InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, 
122
                                RunOptions = RunOptions, obs = BasinObs$Qmm[Ind_Run], varObs = "Q")
123
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
124
125


126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

## simulation with the Linear Hysteresis
Param <- c(116.482, 0.500, 72.733, 1.224, 0.278, 30.333, 0.977, 2.774, 100, 0.4)
OutputsModel <- RunModel_CemaNeigeGR6J(InputsModel = InputsModel,
                                       RunOptions = RunOptions, Param = Param, IsHyst = TRUE)

## results preview
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])

## efficiency criterion: Nash-Sutcliffe Efficiency
InputsCrit  <- CreateInputsCrit(FUN_CRIT = ErrorCrit_NSE, InputsModel = InputsModel, 
                                RunOptions = RunOptions, obs = BasinObs$Qmm[Ind_Run], varObs = "Q")
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)
}

141

Delaigue Olivier's avatar
Delaigue Olivier committed
142
\author{
143
Laurent Coron, Audrey Valéry, Claude Michel, Charles Perrin, Raji Pushpalatha, Nicolas Le Moine, Vazken Andréassian, Olivier Delaigue
Delaigue Olivier's avatar
Delaigue Olivier committed
144
}
145
146


Delaigue Olivier's avatar
Delaigue Olivier committed
147
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
148
149
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011), 
      A downward structural sensitivity analysis of hydrological models to improve low-flow simulation, 
Delaigue Olivier's avatar
Delaigue Olivier committed
150
      Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
151
152
153
154
Riboust, P., G. Thirel, N. Le Moine and P. Ribstein (2019), 
      Revisiting a simple degree-day model for integrating satellite data: implementation of SWE-SCA hystereses.
      Journal of Hydrology and Hydromechanics, doi:10.2478/johh-2018-0004, 67, 1, 70–81. \cr
Valéry, A., V. Andréassian and C. Perrin (2014), 
Delaigue Olivier's avatar
Delaigue Olivier committed
155
      "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine? 
Delaigue Olivier's avatar
Delaigue Olivier committed
156
      Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
157
Valéry, A., V. Andréassian and C. Perrin (2014), 
Delaigue Olivier's avatar
Delaigue Olivier committed
158
      "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? 
Delaigue Olivier's avatar
Delaigue Olivier committed
159
160
      Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
161
162


Delaigue Olivier's avatar
Delaigue Olivier committed
163
\seealso{
164
\code{\link{RunModel_CemaNeige}}, \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{RunModel_CemaNeigeGR5J}}, \code{\link{RunModel_GR6J}},
Delaigue Olivier's avatar
Delaigue Olivier committed
165
166
167
         \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
}