R/mHM_readnml.R

In JBrenn/mHMr: pre- and post-prossesing for mHM

#' Read mHM simulation namelist.
#' 
#' \code{mHM_readnml} reads mHM simulation namelists, e.g. mhm.nml.
#' 
#' @param simpath path to mHM simulation folder, where namelist is located.
#' @param namelist name of namelist.
#' @return list of mHM namelist entries.
#' @examples
#' nml <- mHM_readnml(simpath="your/path")
#' 
#' @author Johannes Brenner \email{johannes.brenner@ufz.de}
#' 
#' @references
#' 
#' @seealso \code{\link{chr2vec}}
#' 
#' @keywords
#' 
#' @export mHM_readnml

mHM_readnml <- function(simpath, namelist)
{
  nml_lines <- readr::read_lines(file = file.path(simpath, namelist))
  
  # remove empty lines and out-commented ones
  nml_lines <- nml_lines[-which(grepl("!",substr(nml_lines,1,1)))]
  nml_lines <- nml_lines[-which(nchar(substr(nml_lines,1,1))<1)]
  
  # namelist names and start
  nml_namelists_start <- which(grepl("&",substr(nml_lines,1,1)))
  #nml_namelists_end   <- which(grepl("/",substr(nml_lines,1,1)))
  nml_names <- sapply(nml_namelists_start, FUN = function(x) substr(nml_lines[x],2,nchar(nml_lines[x])))
  
  forloop <- c(nml_namelists_start,length(nml_lines)+1)
  # read out namelist values
  nml <- list()
  for (i in 1:(length(forloop)-1))
  {
    #block i
    block_i <- nml_lines[(forloop[i]+1):((forloop[i+1])-2)]
    nml[[nml_names[i]]] <- sapply(X = block_i, FUN = chr2vec, USE.NAMES = F)
  }
  
  return(nml)
}