rmt_write: Write a MT3DMS model

In rogiersbart/RMT3DMS: Pre- and post-processing of MT3DMS & MT3D-USGS files

Description

rmt_write writes all input packages in a RMT3DMS mt3dms object to a directory

Usage

rmt_write(
  mt3dms,
  file = {    
    cat("Please select nam file to overwrite or provide new filename ...\n")    
    file.choose() },
  exclude = NULL,
  suppress = FALSE,
  verbose = TRUE,
  iprn = -1
)

Arguments

mt3dms	RMT3DMS mt3dms object
file	filename of the name file to write
exclude	character vector with packages names to exclude from the simulation. Defaults to NULL
suppress	logical; remove non-supported (and thus not written) packages in the NAME file ? Defaults to FALSE
verbose	logical; should information on writing files be printed to the console ? Defaults to TRUE.
iprn	format code for printing arrays in the listing file; defaults to -1 (no printing)

Details

All arrays use IREAD 0 or 103 (constant/free) unless mt3dms$btn$modflowstylearrays = TRUE in which case free-format headers INTERNAL or CONSTANT are used. All packages will be written according to the filenames (fname) defined in the nam object. To prevent any files being overwritten, it is best to write to an empty directory.

Value

NULL

See Also

rmt_create, rmt_read

Examples

btn <- rmt_create_btn()
adv <- rmt_create_adv()
gcg <- rmt_create_gcg()
nam <- rmt_create_nam(btn, adv, gcg, ftl = 'output.ftl', ftl_free = TRUE)

m <- rmt_create(btn, adv, gcg, nam)
f <- tempfile()

rmt_write(m, f, verbose = FALSE)

f2 <- tempfile()
## Not run: 
rmt_write(m, f2, exclude = 'dsp')

## End(Not run)

rogiersbart/RMT3DMS documentation built on Oct. 16, 2021, 9:45 a.m.