RunModel_CemaNeigeGR6J.Rd 8.6 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
21
\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}

\item{Param}{[numeric] vector of 8 parameters
22
23
24
25
26
27
28
29
30
\tabular{ll}{                                                                  
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
Delaigue Olivier's avatar
Delaigue Olivier committed
31
}}
32
\item{IsHyst}{}
Delaigue Olivier's avatar
Delaigue Olivier committed
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}{                                                                                         
39
40
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
         \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
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-GR6J daily lumped model.
}
79
80


Delaigue Olivier's avatar
Delaigue Olivier committed
81
82
83
84
85
\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{
86
library(airGR)
unknown's avatar
unknown committed
87
88

## loading catchment data
Delaigue Olivier's avatar
Delaigue Olivier committed
89
90
91
data(L0123002)

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

## run period selection
98
99
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
100
101

## preparation of the RunOptions object
102
103
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR6J, InputsModel = InputsModel, 
                               IndPeriod_Run = Ind_Run)
Delaigue Olivier's avatar
Delaigue Olivier committed
104
105

## simulation
106
107
108
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
109
110

## results preview
111
plot(OutputsModel, Qobs = BasinObs$Qmm[Ind_Run])
Delaigue Olivier's avatar
Delaigue Olivier committed
112
113

## efficiency criterion: Nash-Sutcliffe Efficiency
114
115
116
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
117
}
118
119


Delaigue Olivier's avatar
Delaigue Olivier committed
120
\author{
121
Laurent Coron, Audrey Valéry, Claude Michel, Charles Perrin, Raji Pushpalatha, Nicolas Le Moine, Vazken Andréassian
Delaigue Olivier's avatar
Delaigue Olivier committed
122
}
123
124


Delaigue Olivier's avatar
Delaigue Olivier committed
125
\references{
Delaigue Olivier's avatar
Delaigue Olivier committed
126
127
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
128
      Journal of Hydrology, 411(1-2), 66-76, doi:10.1016/j.jhydrol.2011.09.034. \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
129
130
  Valéry, A., V. Andréassian and C. Perrin (2014), 
      "As simple as possible but not simpler": what is useful in a temperature-based snow-accounting routine? 
Delaigue Olivier's avatar
Delaigue Olivier committed
131
      Part 1 - Comparison of six snow accounting routines on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.059. \cr
Delaigue Olivier's avatar
Delaigue Olivier committed
132
133
  Valéry, A., V. Andréassian and C. Perrin (2014), 
      "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? 
Delaigue Olivier's avatar
Delaigue Olivier committed
134
135
      Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments, Journal of Hydrology, doi:10.1016/j.jhydrol.2014.04.058.
}
136
137


Delaigue Olivier's avatar
Delaigue Olivier committed
138
139
140
141
142
\seealso{
\code{\link{RunModel_CemaNeigeGR4J}}, \code{\link{RunModel_CemaNeigeGR5J}}, \code{\link{RunModel_GR6J}},
         \code{\link{CreateInputsModel}}, \code{\link{CreateRunOptions}}.
}