rmt_create_btn: Create a 'RMT3DMS' btn object
In rogiersbart/RMT3DMS: Pre- and post-processing of MT3DMS & MT3D-USGS files

Description Usage Arguments Value See Also Examples

rmt_create_btn creates a RMT3DMS btn object.

rmt_create_btn(
  nlay = 3,
  nrow = 10,
  ncol = 10,
  nper = 1,
  ncomp = 1,
  mcomp = ncomp,
  tunit = "s",
  lunit = "m",
  munit = "g",
  trnop = c(rep(TRUE, 5), rep(FALSE, 5)),
  laycon = rep(1, nlay),
  delr = 100,
  delc = 100,
  htop = 0,
  dz = 10,
  prsity = 0.3,
  icbund = 1,
  sconc = as.list(rep(0, ncomp)),
  cinact = -888,
  thkmin = 0.01,
  ifmtcn = 0,
  ifmtnp = 0,
  ifmtrf = 0,
  ifmtdp = 0,
  savucn = TRUE,
  nprs = -1,
  timprs = NULL,
  obs = NULL,
  nprobs = 1,
  chkmas = TRUE,
  nprmas = 1,
  perlen = rep(1, nper),
  nstp = rep(1, nper),
  tsmult = rep(1, nper),
  ssflag = rep(FALSE, nper),
  tslngh = lapply(seq_len(nper), function(i) rep(1, nstp[i])),
  dt0 = rep(0, nper),
  mxstrn = rep(50, nper),
  ttsmult = rep(1, nper),
  ttsmax = rep(0, nper),
  modflowstylearrays = FALSE,
  drycell = FALSE,
  legacy99storage = FALSE,
  ftlprint = FALSE,
  nowetdryprint = FALSE,
  omitdrycellbudget = FALSE,
  altwtsorb = FALSE,
  prj = NULL
)

`nlay`	number of layers; defaults to 3
`nrow`	number of rows; defaults to 10
`ncol`	number of columns; defaults to 10
`nper`	number of stress-periods in the flow model; defaults to 1
`ncomp`	total number of chemical species in the simulation; defaults to 1
`mcomp`	total number of mobile species; defaults to `ncomp`
`tunit`	character; time unit. Only for identification purposes. Defaults to 's'.
`lunit`	character; length unit. Only for identification purposes. Defaults to 'm'.
`munit`	character: mass unit. Only for identification purposes. Defaults to 'mg'.
`trnop`	logicals denoting which packages are active. Not used by MT3DMS > 4.50 or by MT3D-USGS. Defaults to setting adv, dsp, ssm, rct & gcg active.
`laycon`	vector indicating type of model layer: confined (0) or convertible (not 0; default for all layers).
`delr`	vector of cell widths along rows; defaults to 100 for all columns
`delc`	vector of cell widths along columns; defaults to 100 for all rows
`htop`	matrix with the top elevation of layer 1; defaults to 0 for all cells
`dz`	3D array with the thicknesses of each cell. Defaults to 10 for all cells.
`prsity`	3D array with the (effective or mobile) porosity values for each cell. Defaults to 0.3 for all cells.
`icbund`	3D array with integer values for each cell specifying if solute transport is active (1), inactive (0) or if the cell is a constant-concentration (-1). Defaults to 1 for all cells.
`sconc`	list with `ncomp` 3D arrays specifying the starting concentrations in each cell for each species. Defaults to 0 for all cells for all species.
`cinact`	value for indicating an inactive concentration cell (icbund = 0). Defaults to -888.
`thkmin`	decimal fraction of layer thickness below which the cell is considered inactive. Defaults to 0.01. If negative, the absolute value is used.
`ifmtcn`	flag and printing code to determine if calculated concentration should be printed to the standard output text file. Defaults to 0 (no printing).
`ifmtnp`	flag and printing code to determine if number of particles in each cell should be printed to the standard output text file. Defaults to 0 (no printing).
`ifmtrf`	flag and printing code to determine if the model-calculated retardation factor should be printed to the standard output text file. Defaults to 0 (no printing).
`ifmtdp`	flag and printing code to determine if the model-calculated distance-weighted dispersion coefficient should be printed to the standard output text file. Defaults to 0 (no printing).
`savucn`	logical determining if concentration solution should be saved in default unformatted (binary) file named MT3Dnnn.UCN where nnn is the species index number. Defaults to TRUE.
`nprs`	frequency of output. Ignored if `timprs` is supplied. If positive, `timpr` must be supplied. If negative, output is printed or saved whenever the number of transport steps is an even multiple of `nprs`. If zero, only print or save at the end of the simulation. Defaults to -1.
`timprs`	vector with user-defined printing/saving times. Defaults to NULL.
`obs`	optional data.frame with k, i and j columns indicating the cells for which species' concentrations will be saved in MT3Dnnn.OBS files (nnn indicating species index). Defaults to NULL.
`nprobs`	integer indicating how frequently concentrations at `obs` observation points should be saved. Concentrations are saved every `nprobs` step. Defaults to 1.
`chkmas`	logical indicating whether a one-line summary of the mass balance should be saved to a default MT3Dnnn.MAS file where nnn is the species index. Defaults to TRUE.
`nprmas`	frequency of saving the mass budget information to MT3Dnnn.MAS. Information is saved every `nprmas` step. Defaults to 1.
`perlen`	vector of flow model stress-period lengths. Defaults to 1 for every stress-period.
`nstp`	vector of flow model stress-period time steps. Defaults to 1 for every stress-period.
`tsmult`	vector of successive flow model time step length multipliers. Defaults to 1 for every stress-period.
`ssflag`	logical vector of length `nper` indicating if the steady-state transport option should be used. Defaults to FALSE for every stress-period.
`tslngh`	list of length `nper` with time step length vectors. Defaults to 1 for every time step length. Only used when `tsmult > 0` for the current stress-period.
`dt0`	vector of length `nper` of initial transport step sizes within each flow time step. If zero (default) and the GCG solver is active, a model-calculated value based on the Courant number in the Advection package is used.
`mxstrn`	vector of length `nper` with the maximum number of transport steps allowed within one flow time step. Defaults to 50 for every stress-period.
`ttsmult`	vector of length `nper` with transport step size multipliers within a single flow time step. Defaults to 1 for every stress-period.
`ttsmax`	vector of length `nper`with maximum allowed transport step size when `ttsmult > 1`. Defaults to 0 for every stress-period (no limit).
`modflowstylearrays`	logical; should MODFLOW-style arrays and array headers be used. Defaults to FALSE. MT3D-USGS only.
`drycell`	logical; should mass transfer through dry cells be enabled when dry cells remain active in the flow simulation (e.g. with MODFLOW-NWT). Only available when mixelm = 0 or -1 in the Advection package. Defaults to FALSE. MT3D-USGS only.
`legacy99storage`	logical; should MT3DMS flow storage computations be used. Defaults to FALSE. MT3D-USGS only.
`ftlprint`	logical; should the contents of the flow-transport link file be printed to the standard output text file. Defaults to FALSE. MT3D-USGS only.
`nowetdryprint`	logical; should printing of messages related to drying and re-wetting of model cells to the standard output text file be disabled? Defaults to FALSE. MT3D-USGS only.
`omitdrycellbudget`	logical; should the printing of the mass budget of dry cells be disabled? Defaults to FALSE. MT3D-USGS only.
`altwtsorb`	logical; use an alternative formulation to simulate adsorbed mass. Defaults to FALSE. MT3D-USGS only.
`prj`	`RMODFLOW` prj object. Defaults to NULL.

an object of class btn

rmt_read_btn, rmt_write_btn

rmt_create_btn()
prsity <- array(rep(c(0.1, 0.01, 0.3), each = 100), dim = c(10, 10, 3))
rmt_create_btn(nper = 3, prsity = prsity)

# multi-species; sconc for species 1 is from rnorm, sconc for species 2 = 0.2
sconc1 <- rmt_create_array(rnorm(100, 0.1, sd = 0.01), dim = c(10, 10, 3))
rmt_create_btn(ncomp = 2, prsity = prsity, sconc = list(sconc1, 0.2))