sic_inputs.R

#' Get PAR filename for a given scenario in a SIC project
#'
#' @inheritParams sic_run_export
#'
#' @return A [character] with the path of the PAR file
#' @noRd
#'
sic_get_par_filename <- function(cfg, scenario) {
  x <- read_xml(cfg$project$path)
  xPath <- sprintf("/Reseau/Flu[@nScenario=%d]/NomFicPar", scenario)
  file <- x %>% xml_find_first(xPath) %>% xml_text
  return(file.path(dirname(cfg$project$path), file))
}

#' Write a PAR file for SIC simulation
#'
#' Write inputs  in a PAR file respectively to \url{https://sic.g-eau.fr/Format-of-the-par-file}.
#'
#' @inheritParams sic_run_mesh
#'
#' @return Nothing.
#' @export
#'
#' @examples
#' \dontrun{
#' # Setting the model configuration
#' cfg <- cfg_tmp_project()
#'
#' # How to impose an hydrograph at the upstream offtake of the model?
#' # Define the location of the upstream boundary condition to set
#' locations <- SicLocations(list(Nd = 1, Pr = 1, car = "Q"))
#' # Define its time series
#' sicInputs <- SicInput(data.frame(t = c(0, 3600, 7200), # time in seconds
#'                                 v = c(5, 20, 5)),     # flows
#'                       locations = locations)
#' # Write the parameters in the PAR file
#' sic_write_par(cfg, 1, sicInputs)
#' }
sic_write_par <- function(cfg, scenario, sicInputs) {

  if (is.null(attr(cfg, "config"))) {
    stop("`cfg` should be created with `loadConfig()`")
  }
  stopifnot(is.numeric(scenario),
            length(scenario) == 1,
            inherits(sicInputs, "SicInput") || inherits(sicInputs, "SicInputs"))
  if (inherits(sicInputs, "SicInput")) sicInputs <- merge(sicInputs)

  sParFileName = sic_get_par_filename(cfg, scenario)

  df = data.frame(C1 = "// PAR file for SIC",
                  C2 = "automatically generated by rsic2",
                  C3 = "",
                  stringsAsFactors = FALSE)
  i = 0
  for (input in sicInputs) {
    i = i + 1
    # Localisation
    if (is.null(input$locations)) {
      dfLoc <- NULL
    } else {
      dfLoc <- data.frame(C1 = paste0("L", i), C2 = input$locations, C3 = "", stringsAsFactors = FALSE)
    }
    if (is.data.frame(input$data)) {
      dfHeader <- data.frame(C1 = paste0("X", i), C2 = "LOI", C3 = ifelse(input$interpolated, "R", "E"))
      dfData <- cbind(rep(paste0("X", i), nrow(input$data)), input$data)
      names(dfData) <- names(df)
      dfData <- rbind(dfHeader, dfData)
    } else {
      dfData <- data.frame(C1 = paste0("X", i), C2 = input$data, C3 = "")