R/update_link_capacities.R

In rte-antares-rpackage/antaresXpansion: Antares Expansion Planning Tool

#' update link capacities with new value of x$installed_capacities
#' 
#' \code{read_candidates} is a function which read the investments candidates
#' of the expansion planning problem and their characteristics. The information on
#' the candidates is usually stored in the file antaresStudyPath/user/expansion/candidates.ini.
#' 
#' @param current_it_n
#'   current iteration number
#' @param candidates
#'   list of investment candidates, as returned by
#'   \code{\link{read_candidates}}
#' @param exp_options
#'   list of benders decomposition options, as returned by
#'   \code{\link{read_options}}.
#' @param x
#'   benders data structure
#' @param opts
#'   list of simulation parameters returned by the function
#'   \code{antaresRead::setSimulationPath}
#'
#' @return 
#' Returns a list containing the different investment candidates. 
#' 
#' @noRd
#' 
update_link_capacities <- function(x, current_it_n, candidates, exp_options, opts)
{
  
  links_with_candidates <- sapply(candidates, FUN = function(c){c$link})

  for(l in links_with_candidates)
  {
    id_list <- which(links_with_candidates == l)
    new_capacity_direct <- candidates[[id_list[1]]]$already_installed_capacity*candidates[[id_list[1]]]$already_installed_link_profile
    new_capacity_indirect <- candidates[[id_list[1]]]$already_installed_capacity*candidates[[id_list[1]]]$already_installed_link_profile_indirect
    
    for(id in id_list)
    {
      new_capacity_direct <-  new_capacity_direct + get_capacity_profile(get_capacity(x$invested_capacities, candidate = candidates[[id]]$name, it = current_it_n),
                                                                         candidates[[id]]$link_profile, exp_options$uc_type)
        
    
      new_capacity_indirect <- new_capacity_indirect + get_capacity_profile(get_capacity(x$invested_capacities, candidate = candidates[[id]]$name, it = current_it_n),
                                                                            candidates[[id]]$link_profile_indirect, exp_options$uc_type)
    }
    
    if(candidates[[id_list[1]]]$has_link_profile_indirect)
    { 
      new_capacity_direct[new_capacity_direct < 1 ] <- 1
      new_capacity_indirect[new_capacity_indirect < 1 ] <- 1
    }
    
    # update study
    update_link(l, "direct_capacity", new_capacity_direct , opts)
    update_link(l, "indirect_capacity", new_capacity_indirect, opts)
  }
}