R/aquatic-trace.R

In exDE: Extensible Differential Equations for Mosquito-Borne Pathogen Modeling

# specialized methods for the aquatic mosquito trace model

#' @title Number of newly emerging adults from each larval habitat
#' @description Implements [F_alpha] for the trace (forced emergence) model.
#' @inheritParams F_alpha
#' @return a [numeric] vector of length `nHabitats`
#' @export
F_alpha.trace <- function(t, y, pars) {
  pars$Lpar$Lambda
}

#' @title Derivatives for aquatic stage mosquitoes
#' @description Implements [dLdt] for the trace (forced emergence) model.
#' @inheritParams dLdt
#' @return a [numeric] vector
#' @export
dLdt.trace <- function(t, y, pars, eta) {
  numeric(0)
}

#' @title Add indices for aquatic stage mosquitoes to parameter list
#' @description Implements [make_index_L] for trace (forced emergence) model.
#' @inheritParams make_index_L
#' @return the modified parameter [list]
#' @export
make_index_L.trace <- function(pars) {
  pars$L_ix <- integer(0)
  return(pars)
}

#' @title Make parameters for trace aquatic mosquito model
#' @param pars an [environment]
#' @param Lambda vector of emergence rates from each aquatic habitat
#' @return a [list] with class `trace`.
#' @export
make_parameters_L_trace <- function(pars, Lambda) {
  stopifnot(is.numeric(Lambda))
  stopifnot(is.environment(pars))
  Lpar <- list()
  class(Lpar) <- 'trace'
  Lpar$Lambda <- Lambda
  pars$Lpar <- Lpar
}