rmt_create_dsp: Create an 'RMT3DMS' dsp object

Description Usage Arguments Value See Also Examples

View source: R/package-dsp.R

Description

rmt_create_dsp creates an RMT3DMS dsp object.

Usage

1
2
3
4
5
6
7
8
9
rmt_create_dsp(
  btn,
  al = 10,
  trpt = 0.1,
  trpv = 0.01,
  dmcoef = 0,
  multidiffusion = FALSE,
  nocross = FALSE
)

Arguments

btn

RMT3DMS btn object

al

3D array with longitudinal dispersivities. Defaults to 10 for every cell.

trpt

1D vector with ratios of horizontal transverse to longitudinal dispersivities (TH/TL) for every layer. Defaults to 0.1 for every layer.

trpv

1D vector with ratios of vertical transverse to longitudinal dispersivities (TV/TL) for every layer. Defaults to 0.01 for every layer.

dmcoef

either a 1D (nlay) (multidiffusion = FALSE) or a list of length btn$mcomp with 3D (multidiffusion = TRUE) array with the effective molecular diffusion coefficients. Defaults to 0 for all layers or cells (i.e. diffusion is neglected).

multidiffusion

logical; if TRUE, dmcoef can be specified for each species, for each cell. Defaults to FALSE.

nocross

logical; should cross-dispersion be disabled? Defaults to FALSE. MT3D-USGS only.

Value

an object of class dsp

See Also

rmt_read_dsp, rmt_write_dsp

Examples

1
2
3
btn <- rmt_create_btn(ncomp = 3)
rmt_create_dsp(btn)
rmt_create_dsp(btn, dmcoef = list(0, 0.1, 0.2), multidiffusion = TRUE)

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