sim_utils.R

#===== run_simulation =====


#'run_simulation
#'@description Calls OGS6 object validator functions, exports all necessary
#' files and starts OpenGeoSys6
#'@param ogs6_obj OGS6: Simulation object
#'@param iter_n number: Number of iterations (for simulation chains)
#'@param output_to_log_file flag: Should output be written to a log file?
#'@export
run_simulation <- function(ogs6_obj, iter_n = 1, output_to_log_file = TRUE) {

    assertthat::assert_that(inherits(ogs6_obj, "OGS6"))
    assertthat::assert_that(assertthat::is.number(iter_n),
                            iter_n > 0, iter_n < 500)
    assertthat::assert_that(assertthat::is.flag(output_to_log_file))

    #Call all validators
    validate_all(ogs6_obj)

    #Export the simulation files
    export_gml(ogs6_obj)
    export_prj(ogs6_obj)

    #Construct the system call
    ogs6_call <- paste0(ogs6_obj$ogs_bin_path,
                        "ogs.exe ",
                        ogs6_obj$sim_path,
                        ogs6_obj$sim_name,
                        ".prj -o ",
                        ogs6_obj$sim_path)

    system_call <- ogs6_call

    #Direct simulation output to log file
    if(output_to_log_file){

        # Create logfile directory
        logfile_dir <- paste0(ogs6$sim_path, "logfiles/")

        if(!dir.exists(logfile_dir)){
            dir.create(logfile_dir)
        }else{
            warning("Logfile directory already exists", call. = FALSE)
        }

        for(i in seq_len(iter_n)){

            logfile_path <- paste0(logfile_dir,
                                   ogs6_obj$sim_name,
                                   "_log_", iter_n, ".txt")

            #Call OGS6
            system(command = paste("R CMD BATCH --no-echo",
                                   script_path,
                                   logfile_path))

            # read_in_output(ogs6_obj)
        }

        #Write to file...
    }

    #Run simulations (and read in output as input)
    for(i in seq_len(iter_n)){

        #Call OGS6
        system(command = ogs6_call)

        # read_in_output(ogs6_obj)
    }

    closeAllConnections()
}


#===== VALIDATION UTILITY =====


#'validate_all
#'@description Validates all necessary parameters
#'@param ogs6_obj A OGS6 class object
validate_all <- function(ogs6_obj) {

    if(!ogs6_obj$get_status()){
        stop("There are some components missing from your OGS6 object.",
             call. = FALSE)
    }

    if(is.null(ogs6_obj$gml)){
        if(length(ogs6_obj$meshes) < 2){
            stop(paste("If you don't want to specify a gml object, you must",
                       "have multiple meshes. You can define more by calling",
                       "generate_structured_mesh()."), call. = FALSE)
        }
    }else if(length(ogs6_obj$meshes) != 1){
        stop(paste("If you want to specify a gml object, there may only be",
                   "one mesh (one vtk file)."), call. = FALSE)
    }

    #...
}


#===== CHAINING UTILITY (WIP) =====


#'read_in_output
#'@description After a OGS6 simulation was run, reads in the generated .vtu
#' files as new input for
#' the .prj file
#'@param ogs6_obj A OGS6 class object
read_in_output <- function(ogs6_obj) {

    #....WIP
}