SummariseBudget: Summarize MODFLOW Water Budget

Description

This is a utility function for https://water.usgs.gov/ogw/modflow/. It summarizes volumetric flow rates by boundary condition types. That is, it splits the MODFLOW water-budget data into subsets, computes summary statistics for each, and returns the result in a summary table.

Usage

SummariseBudget(budget, desc = c("wells", "drains", "river leakage"))

Arguments

budget

character or list. Either a description of the path to the MODFLOW Budget File or the returned results from a call to the ReadModflowBinary function.

desc

character. Vector of MODFLOW package identifiers. Data of this package type is included in the summary table.

Value

Returns a data.frame object with the following variables:

desc: MODFLOW package identifier
kper: stress period
kstp: time step
id: location identifier
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: tandard deviation of the volumetric flow rate.
flow.dir: flow direction where "in" and "out" indicate water entering and leaving the groundwater system, respectively.

Details

The budget[[i]]$d data table component must contain a numeric id field. Subsets are grouped by the MODFLOW package identifier (desc), stress period (kper), time step (kstp), and location identifier (id).

Examples

Run this code

## Not run: ------------------------------------
#   d <- SummariseBudget("modflow.bud")
## ---------------------------------------------