read.RIV: Read river (RIV) package file

In CJBarry/Rflow: Tools for analysing and writing input and output files for USGS MODFLOW

Description

Reads information from a MODFLOW RIV package file. The RIV package specifies a head dependent flux boundary condition that includes a conductance term. The flux is calculated by:

Q_{RIV} = \frac{h_{mb} - h_{RIV}}{Cond}

where h_{mb} is the river bottom elevation or the model head for the cell, whichever is higher

Usage

read.RIV(filename, nSP, FREE = TRUE)

Arguments

filename	character string; the package file to read
nSP	integer [1] or DIS.MFpackage object; number of stress periods or corresponding DIS package from which this can be read
FREE	logical [1]; if TRUE, read assuming free format; normally FREE = TRUE is okay even if the file is in fixed format, providing entries have a space between them

Value

object of class RIV.MFpackage:
$header (1-row data.frame):
..$MXACTB (int): the maximum number of RIV boundary cells in any stress period
..$IRIVCB (int): unit number to which to save flow to RIV cells
$spheaders (data.frame with nSP rows):
..$ITMP (int): number of active RIV cells in each stress period or, if <1, signals to reuse information from previous stress period
..$NP (int): number of parameters active in each stress period (not that parameter-defined boundaries are not currently supported in read.RIV)
$data (data.table):
..$L (int): layer
..$R (int): row
..$C (int): column
..$Stage (double): head at boundary above model datum (h_{RIV})
..$Cond (double): conductance of boundary (units length^2/time)
..$Rbot (double): river bottom elevation; the difference between Stage and Rbot determines the maximum drainage of the river into the aquifer, although there is no limit to flow in the other direction
..$...: any auxiliary variables that are included in the file but which don't play a role in the MODFLOW simulation

Examples

fnms <- system.file(c("rflow_mf_demo.dis",
                      "rflow_mf_demo.riv"), package = "Rflow")

# get model information from DIS package file
dis <- read.DIS(fnms[1L])

riv <- read.RIV(fnms[2L], dis)
# or, if you already know how many stress periods there are
riv <- read.RIV(fnms[2L], 15L)

class(riv)
str(riv)

CJBarry/Rflow documentation built on June 16, 2019, 12:35 p.m.