readCBB.arr: Read Cell-By-Cell Budget Array

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

Description

Read Cell-By-Cell Budget Array

Usage

readCBB.arr(file, flux.bn = 4L, show.help = TRUE, nf.to.NA = F, hds,
  CRLs = list("all", "all", "all"), sp_ts = "all", artys = "all")

Arguments

file	character string; file name to read
flux.bn	integer [1]; number of bytes occupied by a flow array element (generally 4)
show.help	logical [1]; display progress markers and help message at the end?
nf.to.NA	logical [1]; make cells for no-flow cells into NA? (requires a head array to be given to hds; can be slow)
hds	list, as would be output from readHDS.arr
CRLs	list [3]; each element should either by "all" or a subset of columns (first element), rows (second element) or layers (third element) to return a sub-array
sp_ts	character strings [] or integer matrix [, 2]; either "all" or a set of <stress period _ time step>s to read
artys	character strings []; "all" or output array types to read (e.g. "FlowRightFace", "RiverLeakage")

Value

5D numeric array [NCOL, NROW, NLAY, NTS, NARTY]. The fourth and fifth dimensions are given appropriately formatted dimnames, such that specific output types may be subsetted by name.

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