R/calpuff_10_wdep_params.R

In rich-iannone/PuffR: A set of tools to help with CALPUFF dispersion modelling.

#' Set the CALPUFF parameters for wet deposition
#' @description This function validates and writes CALPUFF parameters for wet deposition.
#' @param calpuff_inp the absolute path and filename for the working CALPUFF input file.
#' @param species_names a vector list of species for which wet deposition parameters will be supplied.
#' @param species_scaveng_coeff_liquid_precip a vector list of scavenging coefficients from liquid precipitation (in 1/s units) each of the species provided in the 'species_names' object.
#' @param species_scaveng_coeff_frozen_precip a vector list of scavenging coefficients from frozen precipitation (in 1/s units) each of the species provided in the 'species_names' object.
#' @export calpuff_10_wdep_params

calpuff_10_wdep_params <- function(calpuff_inp = "calpuff_template.txt",
                                   species_names = NULL,
                                   species_scaveng_coeff_liquid_precip = NULL,
                                   species_scaveng_coeff_frozen_precip = NULL){
  
  # Generate default list of values for the scavenging coefficients when wet
  # deposition occurs via either liquid or frozen precipitation for a large number
  # of chemical species
  default_params_wdep <- list(so2 = c(0.000030, 0),
                              so4 = c(0.000100, 0.000030),
                              no = c(0.000029, 0),
                              no2 = c(0.000510, 0),
                              hno3 = c(0.000060, 0),
                              no3 = c(0.000100, 0.000030),
                              pm25 = c(0.000100, 0.000030),
                              pm10 = c(0.000100, 0.000030))
  
  # Read in the working calpuff.inp file as a character vector
  calpuff_inp_working <- readLines(calpuff_inp, warn = FALSE)
  
}