RunModel_CemaNeigeGR4J: Run with the CemaNeigeGR4J hydrological model

View source: R/RunModel_CemaNeigeGR4J.R

RunModel_CemaNeigeGR4JR Documentation

Run with the CemaNeigeGR4J hydrological model

Description

Function which performs a single run for the CemaNeige-GR4J daily lumped model over the test period.

Usage

RunModel_CemaNeigeGR4J(InputsModel, RunOptions, Param)

Arguments

InputsModel

[object of class InputsModel] see CreateInputsModel for details

RunOptions

[object of class RunOptions] see CreateRunOptions for details

Param

[numeric] vector of 6 (or 8 parameters if IsHyst = TRUE, see CreateRunOptions for details)

GR4J X1 production store capacity [mm]
GR4J X2 intercatchment exchange coefficient [mm/d]
GR4J X3 routing store capacity [mm]
GR4J X4 unit hydrograph time constant [d]
CemaNeige X1 weighting coefficient for snow pack thermal state [-]
CemaNeige X2 degree-day melt coefficient [mm/°C/d]
CemaNeige X3 (optional) accumulation threshold [mm] (needed if IsHyst = TRUE)
CemaNeige X4 (optional) percentage (between 0 and 1) of annual snowfall defining the melt threshold [-] (needed if IsHyst = TRUE)

Details

The choice of the CemaNeige version is explained in CreateRunOptions.
For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see CreateRunOptions.

See RunModel_GR4J to look at the diagram of the hydrological model.

Value

[list] containing the function outputs organised as follows:

$DatesR [POSIXlt] series of dates
$PotEvap [numeric] series of input potential evapotranspiration [mm/d] (E)
$Precip [numeric] series of input total precipitation (P) [mm/d]
$Prod [numeric] series of production store level (S) [mm]
$Pn [numeric] series of net rainfall (Pn) [mm/d]
$Ps [numeric] series of the part of Pn filling the production store (Ps) [mm/d]
$AE [numeric] series of actual evapotranspiration [mm/d]
$Perc [numeric] series of percolation (Perc) [mm/d]
$PR [numeric] series of Pr=Pn-Ps+Perc (Pr) [mm/d]
$Q9 [numeric] series of UH1 outflow (Q9) [mm/d]
$Q1 [numeric] series of UH2 outflow (Q1) [mm/d]
$Rout [numeric] series of routing store level (R1) [mm]
$Exch [numeric] series of potential semi-exchange between catchments [mm/d]
$AExch1 [numeric] series of actual exchange between catchments for branch 1 [mm/d]
$AExch2 [numeric] series of actual exchange between catchments for branch 2 [mm/d]
$AExch [numeric] series of actual exchange between catchments (1+2) [mm/d]
$QR [numeric] series of routing store outflow (Qr) [mm/d]
$QD [numeric] series of direct flow from UH2 after exchange (Qd) [mm/d]
$Qsim [numeric] series of simulated discharge (Q) [mm/d]
$CemaNeigeLayers [list] list of CemaNeige outputs (1 list per layer)
$CemaNeigeLayers[[iLayer]]$Pliq [numeric] series of liquid precip. [mm/d]
$CemaNeigeLayers[[iLayer]]$Psol [numeric] series of solid precip. [mm/d]
$CemaNeigeLayers[[iLayer]]$SnowPack [numeric] series of snow pack (snow water equivalent) [mm]
$CemaNeigeLayers[[iLayer]]$ThermalState [numeric] series of snow pack thermal state [°C]
$CemaNeigeLayers[[iLayer]]$Gratio [numeric] series of Gratio [0-1]
$CemaNeigeLayers[[iLayer]]$PotMelt [numeric] series of potential snow melt [mm/d]
$CemaNeigeLayers[[iLayer]]$Melt [numeric] series of actual snow melt [mm/d]
$CemaNeigeLayers[[iLayer]]$PliqAndMelt [numeric] series of liquid precip. + actual snow melt [mm/d]
$CemaNeigeLayers[[iLayer]]$Temp [numeric] series of air temperature [°C]
$CemaNeigeLayers[[iLayer]]$Gthreshold [numeric] series of melt threshold [mm]
$CemaNeigeLayers[[iLayer]]$Glocalmax [numeric] series of local melt threshold for hysteresis [mm]
RunOptions$WarmUpQsim [numeric] series of simulated discharge (Q) on the warm-up period [mm/d]
RunOptions$Param [numeric] parameter set parameter set used by the model
$StateEnd [numeric] states at the end of the run: store & unit hydrographs levels [mm], CemaNeige states [mm & °C]. See CreateIniStates for more details

Refer to the provided references or to the package source code for further details on these model outputs.

Author(s)

Laurent Coron, Claude Michel, Charles Perrin, Audrey Valéry, Vazken Andréassian, Olivier Delaigue, Guillaume Thirel

References

Perrin, C., Michel, C. and Andréassian, V. (2003). Improvement of a parsimonious model for streamflow simulation. Journal of Hydrology, 279(1-4), 275-289, \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/S0022-1694(03)00225-7")}.

Riboust, P., Thirel, G., Le Moine, N. and Ribstein, P. (2019). Revisiting a simple degree-day model for integrating satellite data: Implementation of SWE-SCA hystereses. Journal of Hydrology and Hydromechanics, 67(1), 70–81, \Sexpr[results=rd]{tools:::Rd_expr_doi("10.2478/johh-2018-0004")}.

Valéry, A., Andréassian, V. and Perrin, C. (2014). "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? Part 1 - Comparison of six snow accounting routines on 380 catchments. Journal of Hydrology, 517(0), 1166-1175, \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.jhydrol.2014.04.059")}.

Valéry, A., Andréassian, V. and Perrin, C. (2014). "As simple as possible but not simpler": What is useful in a temperature-based snow-accounting routine? Part 2 - Sensitivity analysis of the Cemaneige snow accounting routine on 380 catchments. Journal of Hydrology, 517(0), 1176-1187, \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1016/j.jhydrol.2014.04.058")}.

See Also

RunModel_CemaNeige, RunModel_CemaNeigeGR5J, RunModel_CemaNeigeGR6J, RunModel_GR4J, CreateInputsModel, CreateRunOptions, CreateIniStates.

Examples

library(airGR)

## loading catchment data
data(L0123002)

## preparation of the InputsModel object
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_CemaNeigeGR4J, DatesR = BasinObs$DatesR,
                                 Precip = BasinObs$P, PotEvap = BasinObs$E, TempMean = BasinObs$T,
                                 ZInputs = median(BasinInfo$HypsoData),
                                 HypsoData = BasinInfo$HypsoData, NLayers = 5)

## run period selection
Ind_Run <- seq(which(format(BasinObs$DatesR, format = "%Y-%m-%d")=="1990-01-01"),
               which(format(BasinObs$DatesR, format = "%Y-%m-%d")=="1999-12-31"))


## --- original version of CemaNeige

## preparation of the RunOptions object
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR4J, InputsModel = InputsModel,
                               IndPeriod_Run = Ind_Run)

## simulation
Param <- c(X1 = 408.774, X2 = 2.646, X3 = 131.264, X4 = 1.174,
           CNX1 = 0.962, CNX2 = 2.249)
OutputsModel <- RunModel_CemaNeigeGR4J(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, Obs = BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)


## --- version of CemaNeige with the Linear Hysteresis

## preparation of the RunOptions object
RunOptions <- CreateRunOptions(FUN_MOD = RunModel_CemaNeigeGR4J, InputsModel = InputsModel,
                               IndPeriod_Run = Ind_Run, IsHyst = TRUE)

## simulation
Param <- c(X1 = 408.774, X2 = 2.646, X3 = 131.264, X4 = 1.174,
           CNX1 = 0.962, CNX2 = 2.249, CNX3 = 100, CNX4 = 0.4)
OutputsModel <- RunModel_CemaNeigeGR4J(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, Obs = BasinObs$Qmm[Ind_Run])
OutputsCrit <- ErrorCrit_NSE(InputsCrit = InputsCrit, OutputsModel = OutputsModel)

airGR documentation built on Oct. 26, 2023, 9:07 a.m.