inst/dev/old/prepareSimulationFiles.R

In rte-antares-rpackage/antaresFlowbased: Run FlowBased Simulations on Antares

#' Prepare files needed for a single simulation run. Write playlist and FB
#'
#' @param ts \code{data.frame} of dayType and simulation
#' @param secondMember \code{data.frame} of second members
#' @param scenarios \code{data.frame} of scenarios
#' @param simNumber \code{numeric} number of simulation must be in scenarios
#' @param opts \code{list} of simulation parameters returned by the function \link{setSimulationPath}. Defaut to \code{antaresRead::simOptions()}
#' @param verbose \code{numeric} show log in console. Defaut to 1
#' \itemize{
#'  \item{0}{ : No log}
#'  \item{1}{ : Short log}
#'  \item{2}{ : Long log}
#'}
#'
#' @examples
#'
#' \dontrun{
#'
#'  path <- "D:/exemple_test"
#'  antaresRead::setSimulationPath(path, 0)
#'
#'  secondMember <- data.table::fread(paste0(opts$studyPath,"/user/flowbased/second_member.txt"))
#'  ts <- data.table::fread(paste0(opts$studyPath,"/user/flowbased/ts.txt"))
#'  scenarios <- data.table::fread(paste0(opts$studyPath,"/user/flowbased/scenario.txt"))
#'
#'  prepareSimulationFiles(opts = opts, ts = ts, secondMember = secondMember,
#'    scenarios = scenarios, simNumber = 54)
#' }
#'
#' @import data.table
#'
#' @noRd
prepareSimulationFiles <- function(ts, secondMember, scenarios, simNumber,
                                   opts = antaresRead::simOptions(), verbose = 1){

  #Creation of bindingconstraints chronicles
  clim <- data.table::data.table(Id_day = unlist(ts[,.SD, .SDcols = colnames(ts)==simNumber]))
  clim[,OrderN := 1:nrow(clim)]
  allFB <- merge(secondMember, clim, by = "Id_day", allow.cartesian = TRUE)
  setorderv(allFB, c("OrderN", "Id_hour", "Name"))
  allFB$OrderN <- NULL
  #Write of bindingconstraints
  upFb <- try(
    sapply(unique(allFB$Name),
           .writeFb,
           patch = paste0(opts$studyPath, "/input/bindingconstraints"),
           data = allFB) %>>%
      invisible(), silent = TRUE)
  .errorTest(upFb, verbose, "Update of bindingconstraints")

  #Write of playList
  scenarioTP <- which(scenarios$simulation == simNumber)-1
  upPl <- try(updateGeneralSettingIni(opts, scenarioTP), silent = TRUE)
  .errorTest(upPl, verbose, "Update of playlist")

}

#' Write FB files
#'
#' @param nameFb \code{character} name of FB file
#' @param patch \code{character} patch
#' @param data \code{data.frame} data
#'
#' @noRd
.writeFb <- function(nameFb, patch, data){
  #adding 24 hours (0 : bisextile)
  data <- c(data[Name == nameFb]$vect_b, rep(0,24))
  data <- cbind(data, 0, 0)
  write.table(data, file = paste0(patch, "/", nameFb, "_fb.txt"), sep = "\t",
              row.names = FALSE, col.names = FALSE)
}