R/INTERCEPTION.R

In LuckyKanLei/EDHM: Editable distributed hydrological model

#' INTERCEPTION caculate
#' @param InData indata list, use SNOWIntercept(runMode = "VIEW") view the variables and theirs structures
#' @param ... paramlist, in this R packege ParamAll dataset there are alredy most parameters,
#' @return INTERCEPTION
#' @export
INTERCEPTION <- function(InData, ...) UseMethod("INTERCEPTION", InData)

#' INTERCEPTION whith Gash methond
#' @references Gash J H C. An analytical model of rainfall interception by forests[J]. Quarterly Journal of the Royal Meteorological Society, 1978(105):43-55.
#' @param InData 4-list of:
#' \itemize{
#' \item Volum,
#' \item CanopyStorageCapacity,
#' \item RainfallDuringSaturation,
#' \item Evaporation
#' }
#' @param Param 1-list of:
#' \itemize{
#' \item paCoefficientFreeThroughfall
#' }
#' @param ... other Parmeters
#' @return INTERCEPTION
#' @export INTERCEPTION.Gash
#' @export
INTERCEPTION.Gash <- function(InData, Param, ...){
  CanopyStorageCapacity <- InData$Canopy$StorageCapacity - InData$Intercept$Interception
  RainfallDuringSaturation <- InData$Prec$Precipitation
  Evaporation <- InData$Evatrans$EvaporationCanopy

  paCoefficientFreeThroughfall <- Param$CoefficientFreeThroughfall

  NecessaryToSaturateCanopy <- (-1 * RainfallDuringSaturation *
                                  CanopyStorageCapacity / (Evaporation + DBL_EPSILON)) *
    log(1 - Evaporation / (RainfallDuringSaturation *
                             (1 - paCoefficientFreeThroughfall) + DBL_EPSILON))
  returnTem <- minVector(RainfallDuringSaturation,
                         maxVector(CanopyStorageCapacity, NecessaryToSaturateCanopy))
  returnTem[is.na(returnTem)] <- 0.0
  return(list(Intercept = list(Interception = InData$Intercept$Interception + returnTem - Evaporation),
              Prec = list(Precipitation = RainfallDuringSaturation - returnTem)))
}