inlmisc (version 0.5.5)

SummariseBudget: Summarize MODFLOW Water Budget

Description

Summarize MODFLOW volumetric flow rates by boundary condition types. Cell-by-cell flow data is split into subsets, summary statistics computed for each subset, and a summary table returned.

Usage

SummariseBudget(budget, desc = NULL, id = NULL)

Arguments

budget

'character' string or 'list'. Either the path to a MODFLOW cell-by-cell budget file or the object returned from the ReadModflowBinary function.

desc

'character' vector. Data-type descriptors, such as c("wells", "drains"). If missing, all data types are summarized.

id

'character' string. Name of auxiliary variable, a variable of additional values associated with each cell saved using the "AUXILIARY" output option.

Value

A 'data.table' with the following variables:

desc

description of data type, such as "wells".

kper

stress period

kstp

time step

id

auxiliary variable name

delt

length of the current time step.

pertim

time in the stress period.

totim

total elapsed time

count

number of cells in each subset.

flow.sum

total volumetric flow rate

flow.mean

mean volumetric flow rate

flow.median

median volumetric flow rate

flow.sd

standard deviation of volumetric flow rate.

flow.dir

flow direction where "in" and "out" indicate water entering and leaving the groundwater system, respectively.

Details

Subsets are grouped by data type (desc), stress period (kper), time step (kstp), and optional auxiliary variable. Data in the MODFLOW cell-by-cell budget file must be saved using the "COMPACT BUDGET" output option.

See Also

ReadModflowBinary

Examples

# NOT RUN {
path <- system.file("extdata", "ex.bud", package = "inlmisc")
out <- SummariseBudget(path, desc = "river leakage", id = "iface")
print(out)

# }