R/TransfoParam_GR5J.R

In airGR: Suite of GR Hydrological Models for Precipitation-Runoff Modelling

TransfoParam_GR5J <- function(ParamIn, Direction) {


  ## number of model parameters
  NParam <- 5L


  ## check arguments
  isVecParamIn <- is.vector(ParamIn)
  if (isVecParamIn) {
    ParamIn <- matrix(ParamIn, nrow = 1)
  }
  if (!inherits(ParamIn, "matrix")) {
    stop("'ParamIn' must be of class 'matrix'")
  }
  if (!inherits(Direction, "character") | length(Direction) != 1 | any(!Direction %in% c("RT", "TR"))) {
    stop("'Direction' must be a character vector of length 1 equal to 'RT' or 'TR'")
  }
  if (ncol(ParamIn) != NParam) {
    stop(sprintf("the GR5J model requires %i parameters", NParam))
  }


  ## transformation
  if (Direction == "TR") {
    ParamOut <- ParamIn
    ParamOut[, 1] <- exp(ParamIn[, 1])                         ### GR5J X1 (production store capacity)
    ParamOut[, 2] <- sinh(ParamIn[, 2])                        ### GR5J X2 (groundwater exchange coefficient 1)
    ParamOut[, 3] <- exp(ParamIn[, 3])                         ### GR5J X3 (routing store capacity)
    ParamOut[, 4] <- 20 + 19.5 * (ParamIn[, 4] - 9.99) / 19.98 ### GR5J X4 (unit hydrograph time constant)
    ParamOut[, 5] <- (ParamIn[, 5] + 9.99) / 19.98             ### GR5J X5 (groundwater exchange coefficient 2)
  }
  if (Direction == "RT") {
    ParamOut <- ParamIn
    ParamOut[, 1] <- log(ParamIn[, 1])                         ### GR5J X1 (production store capacity)
    ParamOut[, 2] <- asinh(ParamIn[, 2])                       ### GR5J X2 (groundwater exchange coefficient 1)
    ParamOut[, 3] <- log(ParamIn[, 3])                         ### GR5J X3 (routing store capacity)
    ParamOut[, 4] <- 9.99 + 19.98 * (ParamIn[, 4] - 20) / 19.5 ### GR5J X4 (unit hydrograph time constant)
    ParamOut[, 5] <- ParamIn[, 5] * 19.98 - 9.99               ### GR5J X5 (groundwater exchange coefficient 2)
  }


  ## check output
  if (isVecParamIn) {
    ParamOut <- as.vector(ParamOut)
  }

  return(ParamOut)

}