rmt_plot.ucn: Plot a MT3D ucn file object

Description Usage Arguments Details Value

View source: R/plot.R

Description

Plot a MT3D ucn file object

Usage

1
2
## S3 method for class 'ucn'
rmt_plot(ucn, btn, i = NULL, j = NULL, k = NULL, l = NULL, ntrans = NULL, ...)

Arguments

ucn

RMT3DMS ucn object as returned from rmt_read_ucn

btn

RMT3DMS btn object

i

row number to plot

j

column number to plot

k

layer number to plot

l

time step number to plot (index for 4th dimension); defaults to plotting the final time step. See details.

ntrans

integer specifying the transport time step to plot. See details.

...

additional parameters passed to rmt_plot.rmf_4d_array

Details

There are two ways to specify which time step to plot: The l argument can be specified which represents the dimension index. This can be smaller than the total number of transport time steps since output may not be written for all steps. The second option is to specify ntrans which is the total transport time step number. Since output at every time step is not always written, a specified ntrans value might not be available in the array.

If no output is written for the specified time step, as controlled by the btn object, an error is thrown.

Value

ggplot2 object or layer


rogiersbart/RMT3DMS documentation built on Oct. 16, 2021, 9:45 a.m.