SummariseBudget: Summarize MODFLOW Water Budget

Description

This is a utility function for MODFLOW-based models, the U.S. Geological Survey's three-dimensional finite-difference groundwater model. It summarizes volumetric flow rates by boundary condition types. That is, it splits the MODFLOW cell-by-cell flow data into subsets, computes summary statistics for each, and returns a resulting summary table.

Usage

SummariseBudget(budget, desc, id = NULL)

Arguments

budget

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

desc

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

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

Value

Returns a 'data.frame' object 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.

Examples

Run this code

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

# }