rmf_create_parameter.rmf_list: Create a List Data input parameter

View source: R/utils.R

rmf_create_parameter.rmf_listR Documentation

Create a List Data input parameter

Description

Create a parameter for List Data input used in MODFLOW boundary condition packages.

Usage

## S3 method for class 'rmf_list'
rmf_create_parameter(
  rmf_list,
  parnam,
  parval = 1,
  instnam = NULL,
  kper = attr(rmf_list, "kper")
)

Arguments

rmf_list

a rmf_list object

parnam

character specifying the name of the parameter

parval

numeric specifying the value of the parameter which is used to multiply the flux controlling variable in the data.frame. Defaults to 1.0

instnam

optional character specying the instance name of the parameter is to be time-varying; defaults to NULL

Details

the variable in the data.frame which is multiplied differs between boundary condition packages. if the parameter is to be time-varying, a separate parameter should be created for each instance with a unique instnam but with the same name

Value

an object of class rmf_parameter and rmf_list

See Also

rmf_create_list


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