RunModel_GR4J: Run with the GR4J hydrological model

View source: R/RunModel_GR4J.R

RunModel_GR4JR Documentation

Run with the GR4J hydrological model


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


RunModel_GR4J(InputsModel, RunOptions, Param)



[object of class InputsModel] see CreateInputsModel for details


[object of class RunOptions] see CreateRunOptions for details


[numeric] vector of 4 parameters

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]


For further details on the model, see the references section.
For further details on the argument structures and initialisation options, see CreateRunOptions.

Figure: diagramGR4J-EN.png


[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]
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 (res. levels, UH1 levels, UH2 levels) [mm]. See CreateIniStates for more details

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


Laurent Coron, Claude Michel, Charles Perrin, Olivier Delaigue


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, doi: 10.1016/S0022-1694(03)00225-7.

See Also

RunModel_GR5J, RunModel_GR6J, RunModel_CemaNeigeGR4J, CreateInputsModel, CreateRunOptions, CreateIniStates.



## loading catchment data

## preparation of the InputsModel object
InputsModel <- CreateInputsModel(FUN_MOD = RunModel_GR4J, DatesR = BasinObs$DatesR,
                                 Precip = BasinObs$P, PotEvap = BasinObs$E)

## 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"))

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

## simulation
Param <- c(X1 = 257.238, X2 = 1.012, X3 = 88.235, X4 = 2.208)
OutputsModel <- RunModel_GR4J(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 March 18, 2022, 6:47 p.m.