rmt_create_gcg: Create an 'RMT3DMS' gcg object

Description Usage Arguments Details Value See Also Examples

View source: R/package-gcg.R

Description

rmt_create_gcg creates an RMT3DMS dsp object.

Usage

1
2
3
4
5
6
7
8
9
rmt_create_gcg(
  mxiter = 1,
  iter1 = 50,
  isolve = 3,
  ncrs = 0,
  accl = 1,
  cclose = 1e-06,
  iprgcg = 0
)

Arguments

mxiter

maximum number of outer iterations. See details. Defaults to 1.

iter1

maximum number of inner iterations. Defaults to 50.

isolve

type of preconditioner: 1 = Jacobi, 2 = SSOR, 3 = Modified Incomplete Cholesky (MIC; default).

ncrs

integer controlling treatment of dispersion tensor cross-terms. If 0 (default), lump all dispersion cross-terms to RHS. If 1, includes full dispersion tensor.

accl

relaxtion factor for the SSOR preconditioner. Defaults to 1.

cclose

Convergence criteration in relative concentration. Defaults to 1e-6.

iprgcg

interval for printing maximum concentration. changes of each iteration. Defaults to 0 (only print at end of stress-period).

Details

mxiter should be higher than 1 when nonlinear sorption isotherm is included or when drycell = TRUE is used in btn.

Value

an object of class gcg

See Also

rmt_read_gcg, rmt_write_gcg

Examples

1
2
rmt_create_gcg()
rmt_create_gcg(mxiter = 20, ncrs = 1, cclose = 1e-5, iprgcg = 1)

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