R/InFlux_by_PoolIndex.R

In SoilR: Models of Soil Organic Matter Decomposition

#' Constructor from an ordered pair of PoolIndex (integer like) objects 
#' 
#' @param func A function f(X,t) where X is a vector of the state variables. 
#' @param destinationIndex index of destination pool
#' This form is required internally by the solvers and supported for backward compatibility with earlier versions of SoilR.
#' Note that the function func given in this form can not be transformed to a different ordering of state variables, since the location of a state variable in the vector argument depends on a specific order and will be 'hardcoded' into your function. 
#' See \code{\link{InFlux_by_PoolName}} for the new, more powerful interface which allows subsequent reordering of the state variables by using the names of the state variables as formal arguments for \code{func}. In this case SoilR can infer (and later adapt) the
#' vector argument form needed for the solvers.
setMethod(
  f="InFlux_by_PoolIndex",
  signature=c(
    func='function'
    ,destinationIndex='numeric'
  )
  ,def=function(func,destinationIndex){
    new(
        'InFlux_by_PoolIndex'
        ,destinationIndex=PoolIndex(destinationIndex)
        ,func=func
    )
  }
)