R/immigrationFunction.R

In stagePop: Modelling the Population Dynamics of a Stage-Structured Species in Continuous Time

#' Immigration Function
#'
#' Return the rate of immigration (amount per unit time)
#'
#' @aliases immigrationFunc immigrationFunction
#'
#' @param stage (integer). The numbered life stage for which to return an immigration rate.
#' @param x Vector of state variables within the DDE solver. To access a variable use:
#' x$speciesName['stageName',strainNumber]
#' e.g. for species 'Bacteria', stage 'reproductive', strain 2 use
#' x$Bacteria['reproductive',2]
#' If there is only one stage and strain in species 'Food', for example, use
#' x$Food[1,1]
#' @param time (scalar). The current time point in the DDE solver.
#' @param species (integer). The numbered species for which to return an immigration rate.
#' @param strain (integer). The numbered strain for which to return an immigration rate.
#' @return Immigration rate (amount per unit time) for the strain, stage, species and time specified.
immigrationFuncDefault <- function(stage,x,time,species,strain){
    return(0)
}