thAquifer: Temperheic Aquifer, Boundary, and Units objects
In FluvialLandscapeLab/temperheic:

Description Usage Arguments Details Value

The temperheic package relies on three different S3 objects: thAquifer, thBoundary, and thUnits. The "th" prefix is short for "temperheic". A thAquifer object contains user-specified and derived aquifer properties. A thBoundary object contains user-specified and derived values that describe a time varying temperature boudary as a cosine function. A thUnits object describes the units of measure used to specify thAquifer and thBoundary objects.

NOTE THAT THE USER IS RESPONSIBLE FOR ENSURING THAT THE UNITS OF ALL ARGUMENTS PASSED TO TEMPERHEIC PACKAGE FUNCTIONS ARE CONSISTENT. See Details (below) for more information on units.

thAquifer(porosity, thermCond_sed, thermCond_h2o, spHeat_sed, spHeat_h2o,
  density_sed, density_h2o, specificUnits = thUnits())

thBoundary(mean, amplitude, phase, period, specificUnits = thUnits())

thUnits(L = "m", M = "kg", t = "s", T = "degC", E = "kJ")

`porosity`	Porosity (L3 L-3) of the aquifer; ratio of water volume to unit aquifer volume under saturated conditions.
`thermCond_sed`	Thermal conductivity (E t-1 L-1 T-1) of the sediment.
`thermCond_h2o`	Thermal conductivity (E t-1 L-1 T-1) of water.
`spHeat_sed`	Specific heat (E M-1 T-1) of the sediment.
`spHeat_h2o`	Specific heat (E M-1 T-1) of water.
`density_sed`	Density (M L-3) of sediment.
`density_h2o`	Density (M L-3) of water.
`specificUnits`	A `thUnits` object generated by calling `thUnits()`. Specifies the units of length (L), mass (M), time (t), temperature (T), and energy (E) used in the numeric arguments. A `thUnits` object is used only to label the values provided by the user, in hopes of helping the user avoid errors. The `temperheic` package makes no conversions. The user must ensure that all arguments passed to `thAquifer()` and `thBoundary()` have units consistent with `specificUnits`.
`L`	A chararcter string label for units of length. Default is 'm' for meters.
`M`	A chararcter string label for units of mass. Default is 'kg' for kilograms.
`t`	A chararcter string label for units of time. Default is 's' for seconds.
`T`	A chararcter string label for units of temperature. Default is "degC" for degrees celsius.
`E`	A chararcter string label for units of Energy. Default is "kJ" for kilojoules.
`hydCond`	Hydraulic conductivity (L t-1) (either vertical or horizontal) of the aquifer.
`dispersivity`	Dispersivity (L) of the aquifer, appropriate for the the scale of the flow path observed (see Gelher 20XX). ## needs to be updated according to Bons et al., 2015
`headGrad`	Average head gradient (L L-1) in the same dimension (vertical or horizonal) for the aquifer.

thAquifer objects include values for the arguments provided by the user (see 'Arguments', above), along with the following derived values:

darcyFlux Darcy Flux (L t-1) is flux rate of water through the aquifer along the hydrologic gradient. Calculated as: hydCond*headGrad.
density_bulk Density of the bulk medium (M L-3) is the average density of water and sediment, weighted by porosity. Calculated as: density_sed*(1-porosity)+density_h2o*porosity.
spHeat_bulk Specific heat of the bulk medium (E M-1 T-1) is the average specific heat of water and sediments, weighted by porosity. Calculated as: spHeat_sed*(1-porosity)+spHeat_h2o*porosity.
velocity_h2o Water velocity (L T-1) is the aerial averaged rate of water movement along the hydrologic gradient in the aquifer. Calculated as: darcyFlux/porosity.
darcyFlux_heat Heat velocity (L T-1) is the aerially averaged rate of heat movement along the hydraulic gradient in the aquifer. Calculated as: darcyFlux_h2o*(volHeatCap_h2o/volHeatCap_bulk) Note that the temperheic package represents 1D movement of water and heat, so that heat gradients and hydrologic gradients are always aligned.
volHeatCap_h2o, volHeatCap_sed The volumetric heat capacity of of water, and of sediment [E L-3 T-1] are calcuated from the corresponding values for specific heat and density: spHeat_<x>*density_<x>.
volHeatCap_bulk The volumentric heat capacity of the bulk medium [E L-3 T-1] is calcuated as the porosity-weighted average of volumetric heat capacity of water and sediment: volHeatCap_sed*(1-porosity)+volHeatCap_h2o*porosity.

thBoundary objects include values for the arguments provided by the user (see 'Arguments', above), along with the following derived value:

frequency Frequency (t-1) of the temperature signal at the boundary. Calculated as: 1/period.

thUnits objects include unit labels for the parameter values stored in thAquifer and thBoundary objects. Labels for units of length (L), mass (M), time (t), temperature (T), and Energy (E) are specified when creating a thUnits object. The thUnits object can be stored in a variable and subsequently passed to thAquifer() and thBoundary(). Note that the thUnits object is used ONLY to create lables for thAquifer and thBoundary values. No attempt is made to convert to common units. The user is responsible for ensuring that the units of all values in thAquifer and thBoundary objects agree with the unit labels displayed when the object is printed.

thAquifer() returns a S3 object of class thAquifer which includes all specified and derived parameters for the aquifer

thBoundary returns an S3 object of class thBoundary, which includes the specified and derived parameters describing a temperature signal at the aquifer boundary.

thUnits() return an S3 object of class thUnits, which includes specific units of length, mass, time, temperature, and energy. The values in a thUnits object are used to create unit labels for thAquifer and thBoundary parameter values.

FluvialLandscapeLab/temperheic documentation built on Dec. 14, 2019, 5:47 p.m.