mftime: Time Step and Stress Period timings

In CJBarry/Rflow: Tools for analysing and writing input and output files for USGS MODFLOW

Description

Get the time values of the time step or stress period divides from a DIS package or a MODFLOW NetCDF data set. Stress periods define periods of different boundary condition stresses. Stress periods are divided into multiple time steps in order to describe the transient response accurately.

Usage

mftstime(data, absolute = FALSE, t0)

mfsptime(data, absolute = FALSE, t0)

Arguments

data	DIS.MFpackage or NetCDF object; mfsptime does not yet support NetCDF
absolute	logical [1]; TRUE if the absolute time values should be returned. The default is FALSE.
t0	numeric [1]; If data is a DIS package and absolute = TRUE, then the value of t at the start of the model must be given. Not needed with NetCDFs because this information is stored in the NetCDF output generated from Rflow.

Value

mftstime:
numeric [NTS + 1], where NTS is the number of time steps; the time values at the time step transitions, including the start and end times of the model

mfsptime:
numeric [NPER + 1], where NPER is the number of stress periods; the time values at the stress period transitions, including the start and end times of the model

Examples

# using DIS.MFpackage
dis <- read.DIS(system.file("rflow_mf_demo.dis",
                            package = "Rflow"))

mftstime(dis)
mfsptime(dis)

# - with a made-up start time for demonstration purposes
mftstime(dis, TRUE, 1000)
mfsptime(dis, TRUE, 1000)

# using a NetCDF
mfdata <- RNetCDF::open.nc({
  system.file("rflow_mf_demo.nc", package = "Rflow")
})

mftstime(mfdata)

# - the start time is in fact 0 for the demo, so this will show no
#    difference
mftstime(mfdata, TRUE)

# - if t0 is given with a NetCDF, a warning is given to avoid
#    ambiguity
## Not run: mftstime(mfdata, TRUE, 1000)

CJBarry/Rflow documentation built on June 16, 2019, 12:35 p.m.