R/mw_conc_filters.R

In KeesVanImmerzeel/mipwelcona: Calculate The Development Of Concentrations Of Solvents In Pumped Groundwater

#' Calculate concentrations (mixed) of selected filters at times as specified in table created with \code{\link{mw_conc_streamlines}}
#'
#' @param fltr_nrs Well filter numbers (numeric vector).
#' @inheritParams .mw_conc_fltr
#' @inheritParams .nearest_well_fltr
#' @return Dataframe with the following variables (columns):
#' * Q: Extraction (m3/day; negative is extraction; positive is infiltration) (numeric)
#' * TIME: Time, days (numeric)
#' * CONC: Concentration (numeric)
#' @examples
#' fname <- system.file("extdata","well_filters.ipf",package="mipwelcona")
#' well_fltrs <- mw_read_well_filters(fname)
#' sl_fltr_table <- mw_example_sl_fltr_table()
#' conc_streamlines <- mw_example_conc_streamlines()
#' sl_fltr_table <- mw_example_sl_fltr_table()
#' conc <- mw_conc_filters( fltr_nrs=c(1,2), well_fltrs, sl_fltr_table, conc_streamlines )
#' head(conc)
#' @export
mw_conc_filters <-
  function(fltr_nrs,
           well_fltrs,
           sl_fltr_table,
           conc_streamlines) {
    well_fltrs %<>%  dplyr::filter(FLTR_NR %in% fltr_nrs) %>% dplyr::select(c(FLTR_NR, Q_FLTR))
    if (nrow(well_fltrs) < 1) {
      return(NA)
    }
    conc <-
      apply(fltr_nrs %>% as.array(),
            1,
            .mw_conc_fltr,
            sl_fltr_table,
            conc_streamlines)
    conc %<>% na.omit.list() # Remove results when no concentrations are available
    if (length(conc) == 0) {
      return(NA)
    }
    conc %<>%
      data.table::rbindlist() %>%
      dplyr::left_join(well_fltrs, by = "FLTR_NR") %>%
      dplyr::group_by(TIME) %>%
      dplyr::summarise(CONC = weighted.mean(CONC, Q_FLTR), .groups =
                         "drop") %>%
      dplyr::mutate(Q = sum(well_fltrs$Q_FLTR)) %>%
      dplyr::relocate(Q)
    return(conc)
  }