rmf_plot.cbc: Plot a flux component of a cell-by-cell budget object

In rogiersbart/RMODFLOW: Pre- and post-processing of MODFLOW files

Plot a flux component of a cell-by-cell budget object

Description

Plot a flux component of a cell-by-cell budget object

Usage

## S3 method for class 'cbc'
rmf_plot(
  cbc,
  dis,
  i = NULL,
  j = NULL,
  k = NULL,
  l = NULL,
  flux = NULL,
  type = "fill",
  kper = NULL,
  kstp = NULL,
  active_only = FALSE,
  hed = NULL,
  porosity = NULL,
  ...
)

Arguments

cbc	a RMODFLOW cell-by-cell budget object
dis	a RMODFLOW dis object
i	row number to plot
j	column number to plot
k	layer number to plot
l	time step number to plot; defaults to plotting the final time step. See details.
flux	character denoting which flux to plot. See details.
type	plot type: 'fill' (default), 'factor', 'grid', 'contour' or 'vector'
kper	integer specifying the stress-period. Use in conjunction with kstp. See details.
kstp	integer specifying the time step of kper. Use in conjunction with kper. See details.
active_only	logical; indicating if only the active cells should be plotted for list-directed components of the cbc object. Non-active cells are set to NA. Defaults to FALSE.
hed	optional hed object for only plotting the saturated part of the grid; possibly subsetted with time step number. Also used in rmf_convert_cbc_to_darcy when flux = 'darcy' and type = 'vector'.
porosity	optional 3d array with porosity values passed to rmf_convert_cbc_to_darcy when flux = 'darcy' and type = 'vector'.
...	additional parameters passed to rmf_plot.rmf_4d_array or rmf_plot.rmf_list

Details

Flux can be 'constant_head', 'storage', 'flow_right_face', 'flow_front_face', 'flow_lower_face', 'wells', 'river_leakage', 'recharge', 'drains', 'head_dep_bounds' or any other description as written by MODFLOW. Additionally, flux can be 'darcy', in which case Darcy fluxes are computed by rmf_convert_cbc_to_darcy and the magnitude is plotted. If type = 'vector', the x, y and z components are used to determine the direction of the arrows.

There are two ways to specify which time step to plot. The l argument can be specified which represents the total time step number. The other option is to specify both kper & kstp which specify the stress-period and corresponding time step in that stress-period. A negative kstp will plot the final time step of the stress-period.

If no output is written for the specified time step, as controlled by the Output Control file in MODFLOW, an error is thrown.

Value

ggplot2 object or layer

rogiersbart/RMODFLOW documentation built on Jan. 14, 2023, 4:21 a.m.