R/irs-null.R

Defines functions setup_irs_null IRS_EffectSizes.null IRS_Effects.null SprayHouses.null

Documented in IRS_EffectSizes.null IRS_Effects.null setup_irs_null SprayHouses.null

# specialized methods for the null model of IRS
# generic methods for IRS

#' @title Do mass house spraying (IRS)
#' @description This method dispatches on the type of `pars$IRS`.
#' @param t current simulation time
#' @param pars a [list]
#' @return a [list]
#' @export
SprayHouses.null <- function(t, pars) {pars}

#' @title Model the effects of IRS
#' @description This method dispatches on the type of `pars$IRS`.
#' @param t current simulation time
#' @param pars a [list]
#' @return a [list]
#' @export
IRS_Effects.null <- function(t, pars){pars}

#' @title Model IRS effect sizes
#' @description This method dispatches on the type of `pars$IRS`.
#' @param t current simulation time
#' @param pars a [list]
#' @return a [list]
#' @export
IRS_EffectSizes.null <- function(t, pars){pars}

#' @title Make parameters for the null model of IRS (do nothing)
#' @param pars a [list]
#' @return a [list]
#' @export
setup_irs_null <- function(pars) {
  IRS <- list()
  class(IRS) <- 'null'
  pars$IRS <- IRS
  return(pars)
}
dd-harp/MicroMoB documentation built on June 6, 2024, 4:43 p.m.