R/flux.R

In jsta/sparrow: SPARROW tools

#' Get phosphorus flux
#'
#' Get phosphorus flux given upstream and downstream nodes as well as
#'  incremental and total load data.
#'
#' @param id_upstream integer vector
#' @param id_focal integer vector
#' @param id_downstream integer vector
#' @param p_inc data.frame
#' @param p_upstream data.frame
#'
#' @return data.frame
#' @export
#'
get_p_flux <- function(id_upstream, id_focal, id_downstream, p_inc, p_upstream){

  lk_inc  <- sum(p_inc[p_inc$id %in%
                        id_focal,]$MappedValueIncrementalLoadkgyear)
  # lk_up   <- sum(p_upstream[p_upstream$id %in%
  #                     c(id_upstream, id_focal),]$MappedValueTotalLoadkgyear)
  lk_up   <- sum(p_upstream[p_upstream$id %in%
                      c(id_upstream),]$MappedValueTotalLoadkgyear)
  lk_down <- sum(p_upstream[p_upstream$id %in%
                        id_downstream,]$MappedValueTotalLoadkgyear)

  data.frame(loading = lk_inc + lk_up, outflow = lk_down)
}

#' Get hydro flux
#'
#' Get water flux given upstream and downstream nodes.
#'
#' @param id_upstream integer vector
#' @param id_downstream integer vector
#' @param p_flow data.frame
#'
#' @return data.frame
#' @export
#'
get_hydro_flux <- function(id_upstream, id_downstream, p_flow){

  lk_up   <- sum(p_flow[p_flow$id %in%
                              id_upstream,]$Streamflowftsec)
  lk_down <- sum(p_flow[p_flow$id %in%
                              id_downstream,]$Streamflowftsec)

  data.frame(inflow = lk_up, outflow = lk_down)
}