rmf_create_pcg: Create an 'RMODFLOW' pcg object

In rogiersbart/RMODFLOW: Pre- and post-processing of MODFLOW files

Create an RMODFLOW pcg object

Description

rmf_create_pcg creates an RMODFLOW pcg object.

Usage

rmf_create_pcg(
  mxiter = 20,
  iter1 = 30,
  npcond = 1,
  ihcofadd = 0,
  hclose = 0.001,
  rclose = 0.001,
  relax = 1,
  nbpol = 1,
  iprpcg = 1,
  mutpcg = 0,
  damppcg = 1,
  damppcgt = 1
)

Arguments

mxiter	maximum number of outer iterations; defaults to 20
iter1	number of inner iterations; defaults to 30
npcond	flag to select matrix conditioning method (1: Modified Incomplete Cholesky (default); 2: Polynomial)
ihcofadd	flag that determines what happens to an active cell that is surrounded by dry cells; defaults to 0
hclose	head change criterion for convergence (length); defaults to 0.001
rclose	residual criterion for convergence (cubic length per time); defaults to 0.001
relax	relaxation parameter used with npcond == 1; defaults to 1
nbpol	used when npcond == 2; should equal 2 for maximum eigenvalue of 2; else the estimate is calculated; defaults to 1
iprpcg	printout interval for pcg; defaults to 1
mutpcg	flag controlling printing information from the solver; defaults to 0
damppcg	damping factor
damppcgt	damping factor for transient stress periods; optional; only read when damppcg is negative

Value

Object of class pcg

See Also

rmf_read_pcg, rmf_write_pcg and http://water.usgs.gov/nrp/gwsoftware/modflow2000/MFDOC/index.html?pcg.htm

rogiersbart/RMODFLOW documentation built on Jan. 14, 2023, 4:21 a.m.