kitagawa (version 3.1.2)

wrsp-methods: Generic methods for objects with class 'wrsp'.

Description

An object with class 'wrsp' is a list containing the response information, and the mechanical, hydraulic, and material properties used to generate the response for a sealed well.

Usage

# S3 method for wrsp
as.data.frame(x, ...)
data.frame.wrsp(x, ...)
# S3 method for wrsp
print(x, n = 3, ...)
# S3 method for wrsp
summary(object, ...)
# S3 method for summary.wrsp
print(x, ...)
# S3 method for wrsp
lines(x, series = c("amp", "phs"), ...)
# S3 method for wrsp
points(x, series = c("amp", "phs"), pch = "+", ...)
# S3 method for wrsp
plot(
  x,
  xlims = c(-3, 1),
  ylims = list(amp = NULL, phs = 185 * c(-1, 1)),
  logamp = TRUE,
  ...
)
kitplot(x, ...)
# S3 method for wrsp
kitplot(
  x,
  xlims = c(-3, 1),
  ylims = list(amp = NULL, phs = 185 * c(-1, 1)),
  logamp = TRUE,
  ...
)

Arguments

x

'wrsp' object

...

optional arguments

n

numeric; the number of head and tail to print

object

'wrsp' object

series

character; the series to plot (amplitude or phase)

pch

point character, as in par

xlims

limits for x-axis (applies to both amp and phs frames)

ylims

optional list of limits for y-axis (i.e., list(amp=c(..),phs=c(...)))

logamp

logical; should the amplitude be in log10 units

Author

A. J. Barbour <[e-mail]>

Details

The response information is a matrix with frequency, complex response [\(\omega\), \(Z_\alpha (\omega)\)] where the units of \(\omega\) will be as they were input. The amplitude of \(Z\) is in meters per strain, and the phase is in radians.

kitplot was previously a standalone function, but is now simply a reference to plot.wrsp.

See Also

well_response

kitagawa-package

Other PlotUtilities: logticks()

Examples

W <- well_response(1:10, T.=1, S.=1, Vw.=1, Rs.=1, Ku.=1, B.=1)
str(W)
print(W)
print(summary(W))
#
# Plot the response
plot(rnorm(10), xlim=c(-1,11), ylim=c(-2,2))
lines(W)
lines(W, "phs", col="red")
points(W)
points(W, "phs")
#
Wdf <- as.data.frame(W)
plot(Mod(wellresp) ~ omega, Wdf) # amplitude
plot(Arg(wellresp) ~ omega, Wdf) # phase
#
# or use the builtin method plot.wrsp
plot(W)
# change limits:
plot(W, xlims=c(-1,1), ylims=list(amp=c(5,8), phs=185*c(-1,1)))