Execute a MT3DMS or MT3D-USGS model

These functions execute MT3DMS or MT3D-USGS models.

rmt_execute(...)

# S3 method for character
rmt_execute(
  path,
  code = "mt3d-usgs",
  ui = NULL,
  convergence = "Program completed",
  bits = "single",
  form = "b"
)

# S3 method for mt3dms
rmt_execute(
  mt3dms,
  code = "mt3d-usgs",
  ui = NULL,
  convergence = "Program completed",
  bits = "single",
  form = "b"
)

Arguments

path	Path to the NAM file. Typically with extension `.nam`.
code	Name of the MT3D variant to use, or path to the executable.
ui	If NULL (default), MT3D output is shown in the R console. If `"none"`, the output is suppressed.
convergence	Character. The message in the terminal output used to check for convergence.
bits	Character. Can be "single" (ie. 32 bits) or "double" (i.e. 64 bits). Specifies if 32 or 64 bit executable are used for the MT3D-USGS executable.
form	Character. Can be 's' or 'b' (default). Specifies which MT3DMS executable is used, which depends on the value of FORM in the 'filespec.inc' file during compilation. The default 'b' (for binary) should work with FTL files generated by MODFLOW-2000 and newer versions. A value of 's' (for unformatted) should work with FTL files generated by MODFLOW-88 or 96.
mt3dms	mt3dms object

Value

Invisible list with elapsed run time, a logical indicating normal termination, and the stdout output, when done for an on disk model. Full `mt3dms` object including all results otherwise (in memory model).

See also

[rmt_install()] for external code installation