R/weather.R

In dd-harp/MicroMoB: Discrete Time Systems for Robust Analytics for Malaria Policy (RAMP), and Transmission Dynamics and Control of Mosquito-Borne Pathogens Transmission

# generic methods for exogenous forcing by weather

#' @title Methods for exogenous variables describing weather
#' @description This method dispatches on the type of `pars$WEATHER`.
#' @param t current simulation time
#' @param pars a [list]
#' @return [list]
#' @export
Weather <- function(t, pars) {
  UseMethod("Weather", pars$WEATHER)
}

#' @title Methods for exogenous variables describing weather
#' @description Implements [Weather] for the null model (no variables)
#' @inheritParams Weather
#' @return [list]
#' @export
Weather.null <- function(t, pars) {
  return(pars)
}

#' @title Set up the null model for weather
#' @param pars a [list]
#' @return [list]
#' @export
setup_weather_null <- function(pars) {
  WEATHER <- list()
  class(WEATHER) <- 'null'
  pars$WEATHER <- WEATHER
  return(pars)
}

#' @title Methods for exogenous variables describing weather
#' @description Implements exogenous forcing by [Weather]
#' @inheritParams Weather
#' @return [list]
#' @export
Weather.forced <- function(t, pars) {
  pars = Temperature(t, pars)
  pars = Rainfall(t, pars)
  pars = Relative_Humidity(t, pars)
  return(pars)
}

#' @title Set up the forced model for weather
#' @param pars a [list]
#' @return [list]
#' @export
setup_weather_forced <- function(pars) {
  pars = check_abiotic(pars)
  WEATHER <- list()
  class(WEATHER) <- 'forced'
  pars$WEATHER <- WEATHER
  pars = setup_temperature_null(pars)
  pars = setup_rainfall_null(pars)
  pars = setup_relative_humidity_null(pars)
  return(pars)
}

#' @title Methods for exogenous variables describing temperature
#' @description This method dispatches on the type of `pars$TEMPERATURE`.
#' @param t current simulation time
#' @param pars a [list]
#' @return [list]
#' @export
Temperature <- function(t, pars) {
  UseMethod("Temperature", pars$TEMPERATURE)
}

#' @title Methods for exogenous variables describing temperature
#' @description Implements [Temperature] for the null model (no variables)
#' @inheritParams Temperature
#' @return [list]
#' @export
Temperature.null <- function(t, pars) {
  return(pars)
}

#' @title Set up the null model for temperature
#' @param pars a [list]
#' @return [list]
#' @export
setup_temperature_null <- function(pars) {
  TEMPERATURE <- list()
  class(TEMPERATURE) <- 'null'
  pars$TEMPERATURE <- TEMPERATURE
  return(pars)
}

#' @title Set up the null model for RAINFALL
#' @param pars a [list]
#' @return [list]
#' @export
setup_rainfall_null <- function(pars) {
  RAINFALL <- list()
  class(RAINFALL) <- 'null'
  pars$RAINFALL <- RAINFALL
  return(pars)
}

#' @title Methods for exogenous variables describing rainfall
#' @description This method dispatches on the type of `pars$RAINFALL`.
#' @param t current simulation time
#' @param pars a [list]
#' @return [list]
#' @export
Rainfall <- function(t, pars) {
  UseMethod("Rainfall", pars$RAINFALL)
}

#' @title Methods for exogenous variables describing rainfall
#' @description Implements [Rainfall] for the null model (no variables)
#' @inheritParams Rainfall
#' @return [list]
#' @export
Rainfall.null <- function(t, pars) {
  return(pars)
}

#' @title Set up the null model for HUMIDITY
#' @param pars a [list]
#' @return [list]
#' @export
setup_relative_humidity_null <- function(pars) {
  HUMIDITY <- list()
  class(HUMIDITY) <- 'null'
  pars$HUMIDITY <- HUMIDITY
  return(pars)
}

#' @title Methods for exogenous variables describing relative humidity
#' @description This method dispatches on the type of `pars$HUMIDITY`.
#' @param t current simulation time
#' @param pars a [list]
#' @return [list]
#' @export
Relative_Humidity <- function(t, pars) {
  UseMethod("Relative_Humidity", pars$HUMIDITY)
}

#' @title Methods for exogenous variables describing relative humidity
#' @description Implements [Relative_Humidity] for the null model (no variables)
#' @inheritParams Relative_Humidity
#' @return [list]
#' @export
Relative_Humidity.null <- function(t, pars) {
  return(pars)
}