rmt_create: Create an 'RMT3DMS' mt3dms object

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

Description

rmt_create creates an RMT3DMS mt3dms object from rmt_package objects

Usage

rmt_create(
  ...,
  recreate_nam = FALSE,
  ftl,
  ftl_free = NULL,
  print = FALSE,
  basename = NULL,
  reset_timprs = FALSE
)

Arguments

...	(list of) RMT3DMS objects of class rmt_package to be included in the mt3dms object. If a nam object is not provided, it is added automatically.
recreate_nam	logical; if a nam object is supplied, should it be recreated from scratch ? Defaults to FALSE
ftl	path to the flow-transport link file in the nam object; typically '.ftl'. Only used when a nam object is not supplied or when recreate_nam = TRUE.
ftl_free	logical; is the flow-transport link file in the nam object written in free (formatted) format (TRUE) or binary (unformatted) (FALSE)? if NULL (default), it is guessed from reading ftl. Only used when a nam object is not supplied or when recreate_nam = TRUE.
basename	character specifying the basename of the files if the nam object is (re)created. The default (NULL) sets input basenames to 'input' and output to 'output'.
reset_timprs	logical, when a tob object is present, should the observed times be added to btn$timprs in order to write output at correct times? Defaults to FALSE. Note that this also resets btn$nprs

Value

a mt3dms object which is a list containing all MT3DMS/MT3D-USGS packages

See Also

rmt_read, rmt_write

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)

rmt_create(btn, adv, gcg, nam)
rmt_create(btn, adv, gcg, nam, recreate_nam = TRUE, basename = 'ex1')
rmt_create(btn, adv, gcg, ftl = 'output.ftl', ftl_free = FALSE)

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