R/unmanaged_land_leaf.R

In JGCRI/gcamland: GCAM Land Allocation Module

# unmanaged_land_leaf.R

#' UnmanagedLandLeaf
#'
#' @details Initialize an Class called UnmanagedLandLeaf
#' @param aName Leaf name
#' @param aFinalCalPeriod Final calibration period
#' @field mName Leaf name
#' @field mFinalCalPeriod Final calibration period
#' @field mLandAllocation Land allocation for this leaf
#' @field mShare Share of land allocated to this leaf
#' @field mShareWeight Share weight of this leaf
#' @field mProfitRate Profit rate of this leaf
#' @field mIsNewTech Flag indicating leaf is a new technology (no calibration data)
#'
#' @return New, initialized UnmanagedLandLeaf
#' @author KVC October 2017
UnmanagedLandLeaf <- function(aName, aFinalCalPeriod) {
  self <- new.env(parent=emptyenv())
  self$mName <- aName
  self$mFinalCalPeriod <- aFinalCalPeriod
  self$mLandAllocation = list()
  self$mShare = list()
  self$mShareWeight = list()
  self$mProfitRate = list()
  self$mIsNewTech = FALSE
  greet = function() {
    cat(paste0("Hello, I am a UnmanagedLandLeaf named ", self$mName, ".\n"))
  }

  class(self) <- c("UnmanagedLandLeaf", class(self))
  self
}

#' UnmanagedLandLeaf_initCalc
#'
#' @param aUnmanagedLandLeaf Unmanaged land leaf
#' @param aPeriod Current time period
#' @details Initial calculations needed for the unmanagedland leaf.
#' @author KVC September 2017
UnmanagedLandLeaf_initCalc <- function(aUnmanagedLandLeaf, aPeriod) {
  if (aPeriod > 1) {
    UnmanagedLandLeaf_setUnmanagedLandProfitRate(aUnmanagedLandLeaf, aUnmanagedLandLeaf$mProfitRate[[1]], aPeriod)

    # Copy share weights forward
    if (length(aUnmanagedLandLeaf$mShareWeight) < aPeriod) {
      aUnmanagedLandLeaf$mShareWeight[aPeriod] <- aUnmanagedLandLeaf$mShareWeight[[aPeriod - 1]];
    }
  }
}


#' UnmanagedLandLeaf_setUnmanagedLandProfitRate
#'
#' @param aUnmanagedLandLeaf Leaf to set profit rate for
#' @param aAverageProfitRate Average profit rate
#' @param aPeriod Time period
#' @details This method adjusts the profit rate of an unmanaged land leaf
#'          to account for the carbon value of land if the ag subsidy is
#'          is active and a carbon price exists.
#' @author KVC October 2017
UnmanagedLandLeaf_setUnmanagedLandProfitRate <- function(aUnmanagedLandLeaf, aAverageProfitRate, aPeriod) {
  # TODO: Decide whether to implement this
  # Adjust profit rate for land expnasion costs if applicable
  # if ( mIsLandExpansionCost ) {
  # subtract off expansion cost from profit rate
  # expansionCost = marketplace->getPrice( mLandExpansionCostName, aRegionName, aPeriod );
  # adjustedProfitRate = adjustedProfitRate - expansionCost;
  # }

  # TODO: Implement carbon subsidy so we can do UCT
  # mProfitRate[ aPeriod ] = max( adjustedProfitRate + getCarbonSubsidy( aRegionName, aPeriod ), 0.0 );

  aUnmanagedLandLeaf$mProfitRate[aPeriod] <- aAverageProfitRate
}