vs2di.run: Run VS2dh model

Description Usage Arguments Value Examples

View source: R/vs2dhRunModel.R

Description

Run VS2dh model

Usage

1
2
3
4
5
6
vs2di.run(engine = "vs2dh",
  engineDirectoryWin = this_extdata_file("engine/win"),
  engineDirectoryLinux = this_extdata_file("engine/linux"),
  model.path = this_extdata_file("vs2dh_example/tutorial2"),
  returnOutput = TRUE, showWarnings = TRUE, openTargetDir = FALSE,
  dbg = TRUE)

Arguments

engine

model engine 'vs2dh' (for flow & heat modelling) or 'vs2dt' (for flow & solute transport) (Default: "vs2dh")

engineDirectoryWin

default directory on Windows OS containing vs2dh3_3.exe and vs2dt3_3.exe (Default: system.file("extdata/engine/win", package = "kwb.vs2dh"))

engineDirectoryLinux

default directory on Linux OS containing vs2dh3_3.exe and vs2dt3_3.exe (Default: system.file("extdata/engine/linux", package = "kwb.vs2dh"))

model.path

full path to folder containing vs2dh.dat (default: system.file("extdata", "vs2dh_example/tutorial2", package = "kwb.vs2dh"))

returnOutput

if TRUE model output files variables.out, balance.out and obsPoints.out are imported into R completely; vs2dh.out (only warnings imported)

showWarnings

if TRUE print warning messages during simulation on screen (default: TRUE)

openTargetDir

If TRUE path containing model files will be opened in explorer (Default: FALSE)

dbg

if true text output on screen on model run progress

Value

Run VS2dh model and saves model output files in folder model.path. If returnOutput is TRUE the output is imported in R object

Examples

1
2
3
### Running model with default model.path and engine.path: 
model.path <- system.file("extdata", "vs2dh_example/tutorial2", package = "kwb.vs2dh")
res <- vs2di.run(model.path = model.path)

KWB-R/kwb.vs2dh documentation built on Sept. 10, 2019, 12:20 p.m.