R/flank_rate_of_spread.r

In nrcan-cfs-fire/cffdrs: Canadian Forest Fire Danger Rating System

#' Flank Fire Rate of Spread Calculator
#'
#' @description Calculate the Flank Fire Spread Rate.
#'
#' All variables names are laid out in the same manner as Forestry Canada
#' Fire Danger Group (FCFDG) (1992). Development and Structure of the
#' Canadian Forest Fire Behavior Prediction System." Technical Report
#' ST-X-3, Forestry Canada, Ottawa, Ontario.
#'
#' @param ROS  Fire Rate of Spread (m/min)
#' @param BROS Back Fire Rate of Spread (m/min)
#' @param LB   Length to breadth ratio
#'
#' @return FROS Flank Fire Spread Rate (m/min) value
#'
#' @noRd

flank_rate_of_spread <- function(ROS, BROS, LB) {
  # Eq. 89 (FCFDG 1992)
  FROS <- (ROS + BROS) / LB / 2
  return(FROS)
}

.FROScalc <- function(...) {
  .Deprecated("flank_rate_of_spread")
  return(flank_rate_of_spread(...))
}