rmf_create_parameter.rmf_3d_array: Concise function for creating a 3D-array parameter.
In rogiersbart/RMODFLOW: Pre- and post-processing of MODFLOW files

rmf_create_parameter.rmf_3d_array

R Documentation

Concise function for creating a 3D-array parameter.

Description

Create a list of MODFLOW flow parameters from a 3D-array.

Usage

## S3 method for class 'rmf_3d_array'
rmf_create_parameter(
  array,
  parnam,
  parval = 1,
  layer = 1:dim(array)[3],
  partyp,
  mltnam = parnam,
  instnam = NULL
)

Arguments

`array`	a `rmf_3d_array` object
`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
`layer`	integer vector denoting the layer indices represented by the parameter. Defaults to `seq(1, dim(array)[3])`
`partyp`	character specifying the type of flow parameter. Allowed values are `HK, HANI, VK, VANI, SS, SY and VKCB`.
`mltnam`	character vector specifying the name of the resulting multiplier array.
`instnam`	optional character specying the instance name of the parameter is to be time-varying; defaults to NULL

Details

This function will only set the multiplier arrays for all layers of the 3D array. The user must make sure that this multiplier array is written to a separate MLT file when running a MODFLOW simulation. This function is intended to be used when no multiplier and/or zone arrays are specified for a parameter. Only flow parameters can be created with this function. A singly partyp is appointed to all layers.