Pipe parameters¶
Pipe parameters determine the physical properties of the outlet pipe and the effluent water masses. The properties may vary with time.
It is required to supply either a complete set of explicit parameters
(pipe.time, pipe.flow, pipe.dens,
pipe.diam, pipe.depth and pipe.decline) or the
name of an external file containing the parameters (pipe.csv.file
or pipe.nc.file).
- pipe.time¶
- Type:
array
- Units:
s
Time since simulation start.
- pipe.dens¶
- Type:
array
- Units:
kg / m³
Mass density of effluent wastewater. One entry for each
pipe.timevalue. Alternatively: Supply bothpipe.tempandpipe.salt, in which case the density is computed using the UNESCO seawater equation of state (Jackett and Mcdougall, 1995).
- pipe.temp¶
- Type:
array
- Units:
degrees Celcius
Temperature of effluent wastewater. One entry for each
pipe.timevalue. Either supply bothpipe.tempandpipe.salt, or supply values forpipe.dens.
- pipe.salt¶
- Type:
array
- Units:
kg / m³
Salinity of effluent wastewater. One entry for each
pipe.timevalue. Either supply bothpipe.tempandpipe.salt, or supply values forpipe.dens.
- pipe.decline¶
- Type:
array
- Units:
degrees
Direction of pipe outlet (positive is downwards). One entry for each
pipe.timevalue.
- pipe.csv.file¶
- Type:
string
Read pipe parameters from the specified text file. The file must have one column (with header) for each pipe parameter. Columns must be comma-separated. Lines starting with
#are treated as comments, and whitespace is ignored.
- pipe.nc.file¶
- Type:
string
Read pipe parameters from the specified netCDF4 file. The file must have one variable for each pipe parameter, indexed by the time coordinate.
Bibliography¶
Jackett, D. R., and Mcdougall, T. J. (1995). Minimal Adjustment of Hydrographic Profiles to Achieve Static Stability. Journal of Atmospheric and Oceanic Technology 12(2): 381–89. doi:10.1175/1520-0426(1995)012<0381:MAOHPT>2.0.CO;2.