readUCN.arr: Read Unformatted Concentration File

Description Usage Arguments Value

Description

Read Unformatted Concentration File

Usage

1
2
3
readUCN.arr(file, time.only = F, time.bn = 4L, conc.bn = 4L,
  show.help = T, nf.to.NA = T, nf.val = -1, lays = "all",
  sp_ts_tts = "all")

Arguments

file

character string

time.only

logical [1]; if TRUE, then only return the time at the end of each time step

time.bn

integer [1]; number of bytes in a time record (generally 4)

conc.bn

integer [1]; number of bytes in an array record (generally 4)

show.help

logical [1]; show progress markers and explanatory notes?

nf.to.NA

logical [1]; convert inactive cells to NA?

nf.val

numeric [1]; value denoting inactive cells (commonly -1)

lays

"all" or integer []; return all layers, or else a subset

sp_ts_tts

"all", character strings [] or integer matrix [, 3]; return all transport time steps, or a subset of <stress period_time step_transport time step>s

Value

either a list with two elements (with time.only = FALSE):
$Concentration: num [NCOL, NROW, NLAY, NTTS]
$time: num [NTTS]; time at end of transport time steps, relative to model start
or just the time values


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