Create an array parameter

Create a parameter from multiplier and/or zone arrays used in MODFLOW boundary condition packages and flow packages

# S3 method for default
rmf_create_parameter(
  dis,
  kper = NULL,
  layer = NULL,
  parnam,
  parval = 1,
  mltnam = "NONE",
  zonnam = "ALL",
  iz = NULL,
  partyp = NULL,
  mlt = NULL,
  zon = NULL,
  instnam = NULL,
  hgunam = NULL
)

Arguments

dis	RMODFLOW dis object. Used to dimension the final array.
kper	integer vector with the stress period numbers during which the parameter is active. Specifying kper indicates that this parameter represent boundary condition information.
layer	integer vector denoting the layer indices represented by the parameter. Specifying layer indicates that this parameter represent flow package information; the partyp argument should be set as well. Multiple instances of the same layer index are allowed.
parnam	character specifying the name of the parameter
parval	numeric specifying the value of the parameter which is used to multiply values in the array. Defaults to 1.0
mltnam	character vector; specifying the names of multiplier arrays that are used to build the parameter. The keyword "NONE" indicates no multiplier array is present.
zonnam	character vector; specifying the names of zone arrays that are used to build the parameter. The keyword "ALL" indicates no multiplier array is present.
iz	list where each element is a numeric vector with the zone numbers for the corresponding zone array. Only read when the corresponding zonnam is not "ALL".
partyp	character specifying the type of flow parameter. Allowed values are HK, HANI, VK, VANI, SS, SY, VKCB for lpf and SYTP for huf. Not used when layer is NULL.
mlt	RMODFLOW mlt object which holds the multiplier arrays specified in mltnam
zon	RMODFLOW zon object which holds the zone arrays specified in zonnam
instnam	optional character specying the instance name if the parameter is to be time-varying; defaults to NULL
hgunam	character vector specifying the name(s) of the hydrogeological unit(s) if the parameter represents a huf parameter; defaults to NULL. See details.

Value

an rmf_2d_array object of class rmf_parameter

Details

A boundary-condition parameter is created by setting the kper argument. A flow parameter is created by setting the layer and partyp arguments. If the boundary-condition parameter is to be time-varying, a separate parameter should be created for each instance with a unique instnam but with the same name Typically, an array parameter is build from a single multiplier and/or zone array combination. However, multiple combinations can be used. If mltnam is "NONE" and zonnam is "ALL", parval applies to all cells in the array and mlt and zon are not read. If hgunam is specified, layer can not be specified.

See also

rmf_create_array