readHDS.arr: Read Head Save array

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

Description

Read Head Save array

Usage

readHDS.arr(file, conc = FALSE, time.only = FALSE, time.bn = 4L,
  hd.bn = 4L, show.help = TRUE, nf.to.NA = FALSE, nf.val = 999,
  CRs = list("all", "all"), lays = "all", sp_ts = "all")

Arguments

file	character; file name of head save array
conc	logical; is the file in fact an unformatted concentration file (MT3D output)?
time.only	logical; only read the model time information and discard the head data
time.bn	integer, 4 or 8; how many bytes do the time records occupy (generally 4)?
hd.bn	integer, 4 or 8; how many bytes to the head records occupy (generally 4)?
show.help	logical; show what is being read and print message describing output?
nf.to.NA	logical; convert no flow cells to NA
nf.val	logical; if nf.to.NA, what head value indicates a no flow cell?
CRs	length-2 list; elements are either "all" (default) or vectors of column/ row indices which are requested
lays	either "all" (default) or integer vector of requested layers
sp_ts	either "all", a length-2 integer vector or a 2-column matrix; which stress period-time step references to return

Value

a list with one or two elements:
$Head: num [NCOL, NROW, NLAY, NTS]; head values, only if time.only = FALSE $time: num [NTS]; time at end of each time step, relative to model start

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