Skip to contents

ogs6_run_simulation

ogs6_run_simulation.Rd

Wrapper function that calls ogs6_export_sim_files(), ogs6_call_ogs6() and ogs6_read_output_files().

Usage

ogs6_run_simulation(
  ogs6_obj,
  write_logfile = TRUE,
  ogs6_bin_path,
  overwrite = T,
  copy_ext_files = F,
  verbose = F,
  singularity_opts
)

Arguments

ogs6_obj

OGS6: Simulation object

write_logfile

flag: Should output be written to a logfile? If FALSE, output will be written to console. If TRUE, logfile directory will be created in ogs6$sim_path directory

ogs6_bin_path

string: Optional: OpenGeoSys 6 executable path. Defaults to options("r2ogs6.default_ogs6_bin_path")

overwrite

flag: Should existing files be overwritten?

copy_ext_files

flag: Should external files that are references in the ogs6_obj be be copied to ogs6_obj$sim_path?

verbose

flag

singularity_opts

string: Optional: Options to singularity exec command. Defaults to options("r2ogs6.singularity_opts")