rmt_as_list: Generic to convert objects to rmt_list

Description Usage Arguments Details Value Examples

View source: R/utils.R

Description

Generic to convert objects to rmt_list

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
rmt_as_list(...)

## S3 method for class 'wel'
rmt_as_list(wel, cwel, kper, ...)

## S3 method for class 'drn'
rmt_as_list(drn, cdrn, kper, ...)

## S3 method for class 'chd'
rmt_as_list(chd, cchd, kper, ...)

## S3 method for class 'riv'
rmt_as_list(riv, criv, kper, ...)

## S3 method for class 'ghb'
rmt_as_list(ghb, cghb, kper, ...)

Arguments

...

additional numeric vectors containing concentrations (one value for each feature) or column names. One vector/name for each species > 1 (in order).

wel

RMODFLOW wel object

cwel

concentrations in the wells for species 1. A value must be supplied for every well. Alternatively, a character can be entered referencing a column in the wel data set to use.

kper

numeric vector with the stress period numbers during which the list is active.

drn

RMODFLOW drn object

cdrn

concentrations in the drains for species 1. A value must be supplied for every drain. Alternatively, a character can be entered referencing a column in the drn data set to use.

chd

RMODFLOW chd object

cchd

concentrations in the constant-head cells for species 1. A value must be supplied for every constant-head cell. Alternatively, a character can be entered referencing a column in the chd data set to use.

riv

RMODFLOW riv object

criv

concentrations in the river cells for species 1. A value must be supplied for every river cell. Alternatively, a character can be entered referencing a column in the riv data set to use.

ghb

RMODFLOW ghb object

cghb

concentrations in the general-head boundary cells for species 1. A value must be supplied for every general-head boundary cell. Alternatively, a character can be entered referencing a column in the ghb data set to use.

Details

kper should be one of the stress periods defined in the flow model unless only one stress period is present in the flow model.

Value

a rmt_list object

a rmt_list object

a rmt_list object

a rmt_list object

a rmt_list object

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
library(RMODFLOW)
m <- rmf_read(rmf_example_file('example-model.nam'), verbose = FALSE)
rmt_as_list(m$wel, 6.5, kper = 1)

m$wel$data$chloride <- 6.5
rmt_as_list(m$wel, 'chloride', kper = 1)
# 3 species
cchd1 <- rnorm(nrow(m$chd$data), 70, 50)
rmt_as_list(m$chd, cchd1, kper = c(2, 3), cchd1 * 2, cchd1 / 2)

# stress periods should be the same when flow object has more than 1 stress period
## Not run: 
rmt_as_list(m$chd, cchd1, kper = c(2, 3))

## End(Not run)

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