rmt_create_nam: Create an 'RMT3DMS' nam object

Description Usage Arguments Details Value See Also Examples

View source: R/package-nam.R

Description

rmt_create_nam creates an RMT3DMS nam object.

Usage

1
2
3
4
5
6
7
rmt_create_nam(
  ...,
  ftl = {     cat("Please select corresponding ftl file ...\n")     file.choose() },
  ftl_free = NULL,
  print = FALSE,
  basename = NULL
)

Arguments

...

RMT3DMS objects to be included in the nam file

ftl

path to the flow-transport link file; typically '.ftl'

ftl_free

logical; is the flow-transport link file written in free (formatted) format (TRUE) or binary (unformatted) (FALSE)? if NULL (default), it is guessed from reading ftl

print

logical; should the contents of the flow-transport link file be printed to the listing file? Defaults to FALSE.

basename

character specifying the basename of the files. The default (NULL) sets input basenames to 'input' and output to 'output'.

Details

If a RMT3DMS nam object is present, it is recreated. It is advised to place the ftl file in the same directory as the transport model input files. The path the flow-transport link file is normalized in rmt_write_nam.

Value

Object of class mt3d_nam

See Also

rmt_read_nam, rmt_write_nam

Examples

1
2
3
4
btn <- rmt_create_btn()
adv <- rmt_create_adv()
gcg <- rmt_create_gcg()
rmt_create_nam(btn, adv, gcg, ftl = 'output.ftl', ftl_free = TRUE)

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