RunModel_CemaNeigeGR5J.Rd 10.3 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_CemaNeigeGR5J}
\alias{RunModel_CemaNeigeGR5J}
6
7


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


Delaigue Olivier's avatar
Delaigue Olivier committed
11
\usage{
12
RunModel_CemaNeigeGR5J(InputsModel, RunOptions, Param)
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 7 (or 9 parameters if \code{IsHyst = TRUE})
Delaigue Olivier's avatar
Delaigue Olivier committed
22
\tabular{ll}{                                                                      
23
24
25
26
27
28
29
30
31
GR5J X1      \tab production store capacity [mm]                                          \cr
GR5J X2      \tab intercatchment exchange coefficient [mm/d]                              \cr
GR5J X3      \tab routing store capacity [mm]                                             \cr
GR5J X4      \tab unit hydrograph time constant [d]                                       \cr
GR5J X5      \tab intercatchment exchange threshold [-]                                   \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
32
33
}}
}
34
35


Delaigue Olivier's avatar
Delaigue Olivier committed
36
\value{
Delaigue Olivier's avatar
Delaigue Olivier committed
37
38
[list] list containing the function outputs organised as follows:                                         
         \tabular{ll}{                                                                                         
Delaigue Olivier's avatar
Delaigue Olivier committed
39
40
41
         \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
42
         \emph{$Prod    }          \tab [numeric] series of production store level [mm]                        \cr
43
         \emph{$Pn      }          \tab [numeric] series of net rainfall [mm/d]                         			  \cr
44
         \emph{$Ps      }          \tab [numeric] series of the part of Pn filling the production store [mm/d]        \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
45
46
         \emph{$AE      }          \tab [numeric] series of actual evapotranspiration [mm/d]                          \cr
         \emph{$Perc    }          \tab [numeric] series of percolation (PERC) [mm/d]                                 \cr
47
         \emph{$PR      }          \tab [numeric] series of PR=Pn-Ps+Perc [mm/d]                                      \cr
48
49
50
         \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
51
         \emph{$Exch    }          \tab [numeric] series of potential semi-exchange between catchments [mm/d]         \cr
52
53
         \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
Delaigue Olivier's avatar
Delaigue Olivier committed
54
55
         \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
56
         \emph{$QD      }          \tab [numeric] series of direct flow from UH2 after exchange (QD) [mm/d]           \cr
57
         \emph{$Qsim    }          \tab [numeric] series of simulated discharge [mm/d]                                               \cr
58
         \emph{$CemaNeigeLayers}   \tab [list] list of CemaNeige outputs (1 list per layer)                           \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
59
60
61
         \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
62
         \emph{$CemaNeigeLayers[[iLayer]]$ThermalState }   \tab [numeric] series of snow pack thermal state [°C]                 \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
63
64
65
66
         \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
67
         \emph{$CemaNeigeLayers[[iLayer]]$Temp         }   \tab [numeric] series of air temperature [°C] \cr
68
69
         \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
70
         \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
71
         }                                                                                                     
Delaigue Olivier's avatar
Delaigue Olivier committed
72
73
         (refer to the provided references or to the package source code for further details on these model outputs)
}
74
75


Delaigue Olivier's avatar
Delaigue Olivier committed
76
77
78
\description{
Function which performs a single run for the CemaNeige-GR5J daily lumped model.
}
79
80


Delaigue Olivier's avatar
Delaigue Olivier committed
81
\details{
82
The choice of the CemaNeige version is explained in \code{\link{CreateRunOptions}}. \cr
83
For further details on the model, see the references section. \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
84
85
For further details on the argument structures and initialisation options, see \code{\link{CreateRunOptions}}.
}
86
87


Delaigue Olivier's avatar
Delaigue Olivier committed
88
\examples{
89
library(airGR)
unknown's avatar
unknown committed
90
91

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
92
93
94
data(L0123002)

## preparation of the InputsModel object
95
96
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_CemaNeigeGR5J, DatesR = BasinObs$DatesR, 
                                 Precip = BasinObs$P, PotEvap = BasinObs$E, TempMean = BasinObs$T, 
97
                                 ZInputs = median(BasinInfo$HypsoData),
98
                                 HypsoData = BasinInfo$HypsoData, NLayers = 5)
Delaigue Olivier's avatar
Delaigue Olivier committed
99
100

## run period selection
101
102
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
103
104

## preparation of the RunOptions object
105
106
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR5J, InputsModel = InputsModel, 
                               IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
107
108

## simulation
109
110
111
Param <- c(179.139, -0.100, 203.815, 1.174, 2.478, 0.977, 2.774)
OutputsModel <- RunModel_CemaNeigeGR5J(InputsModel = InputsModel,
                                       RunOptions = RunOptions, Param = Param)
Delaigue Olivier's avatar
Delaigue Olivier committed
112
113

## results preview
114
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
115
116

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


## simulation with the Linear Hysteresis
123
124
125
## preparation of the RunOptions object
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR5J, InputsModel = InputsModel, 
                               IndPeriod_Run = Ind_Run, IsHyst = TRUE)
126
127
Param <- c(179.139, -0.100, 203.815, 1.174, 2.478, 0.977, 2.774, 100, 0.4)
OutputsModel <- RunModel_CemaNeigeGR5J(InputsModel = InputsModel,
128
                                       RunOptions = RunOptions, Param = Param)
129
130
131
132
133
134
135
136

## 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)
Delaigue Olivier's avatar
Delaigue Olivier committed
137
}
138
139


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


Delaigue Olivier's avatar
Delaigue Olivier committed
145
\references{
146
147
Le Moine, N. (2008),
      Le bassin versant de surface vu par le souterrain : une voie d'amélioration des performances 
Delaigue Olivier's avatar
Delaigue Olivier committed
148
      et du réalisme des modèles pluie-débit ?, PhD thesis (french), UPMC, Paris, France. \cr
149
Pushpalatha, R., C. Perrin, N. Le Moine, T. Mathevet and V. Andréassian (2011), 
Delaigue Olivier's avatar
Delaigue Olivier committed
150
      A downward structural sensitivity analysis of hydrological models to improve low-flow simulation, 
Delaigue Olivier's avatar
Delaigue Olivier committed
151
      Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
152
153
154
155
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
156
      "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine? 
Delaigue Olivier's avatar
Delaigue Olivier committed
157
      Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
158
Valéry, A., V. Andréassian and C. Perrin (2014), 
Delaigue Olivier's avatar
Delaigue Olivier committed
159
      "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? 
Delaigue Olivier's avatar
Delaigue Olivier committed
160
161
      Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
162
163


Delaigue Olivier's avatar
Delaigue Olivier committed
164
\seealso{
165
\code{\link{RunModel_CemaNeige}}, \code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{RunModel_CemaNeigeGR6J}}, \code{\link{RunModel_GR5J}},
166
         \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}, \code{\link{CreateIniStates}}.
Delaigue Olivier's avatar
Delaigue Olivier committed
167
168
}