Learn R Programming

gsw (version 1.0-5)

gsw_pot_enthalpy_ice_freezing: Potential Enthalpy of Ice at Freezing Point

Description

Potential Enthalpy of Ice at Freezing Point

Usage

gsw_pot_enthalpy_ice_freezing(SA, p, saturation_fraction = 1)

Arguments

SA

Absolute Salinity [ g/kg ]

p

sea pressure [dbar], i.e. absolute pressure [dbar] minus 10.1325 dbar

saturation_fraction

fraction of air in water [unitless]

Value

potential enthalpy [ J/kg ]

Bugs

1. The C source underlying this function lacks an argument, saturation_fraction, which is present in the Matlab source, and so that argument is ignored here.

2. The R code does not reproduce the check values stated at http://www.teos-10.org/pubs/gsw/html/gsw_pot_enthalpy_ice_freezing.html. Those values are incorporated in the test provided in “Examples”, so that test is not performed during build tests. See https://github.com/TEOS-10/GSW-R/issues/27.

Details

The present R function works with a wrapper to a C function contained within the GSW-C system (Version 3.05-4 dated 2017-08-07, available at https://github.com/TEOS-10/GSW-C, as git commit '5b4d959e54031f9e972f3e863f63e67fa4f5bfec'), which stems from the GSW-Fortran system (https://github.com/TEOS-10/GSW-Fortran) which in turn stems from the GSW-Matlab system (https://github.com/TEOS-10/GSW-Matlab). Consult http://www.teos-10.org to learn more about these software systems, their authorships, and the science behind it all.

References

http://www.teos-10.org/pubs/gsw/html/gsw_pot_enthalpy_ice_freezing.html

See Also

Other things related to enthalpy: gsw_CT_from_enthalpy, gsw_dynamic_enthalpy, gsw_enthalpy_CT_exact, gsw_enthalpy_diff, gsw_enthalpy_first_derivatives_CT_exact, gsw_enthalpy_first_derivatives, gsw_enthalpy_ice, gsw_enthalpy_t_exact, gsw_enthalpy, gsw_frazil_properties_potential_poly, gsw_frazil_properties_potential, gsw_pot_enthalpy_from_pt_ice_poly, gsw_pot_enthalpy_from_pt_ice, gsw_pot_enthalpy_ice_freezing_poly, gsw_pt_from_pot_enthalpy_ice_poly, gsw_pt_from_pot_enthalpy_ice, gsw_specvol_first_derivatives_wrt_enthalpy, gsw_specvol_first_derivatives

Examples

Run this code
# NOT RUN {
SA <- c(34.7118, 34.8915, 35.0256, 34.8472, 34.7366, 34.7324)
p <- c(      10,      50,     125,     250,     600,    1000)
saturation_fraction = 1
e <- gsw_pot_enthalpy_ice_freezing(SA, p, saturation_fraction)
# }
# NOT RUN {
expect_equal(e/1e5, c(-3.373409558967978, -3.374434164002012, -3.376117536928847,
                    -3.378453698871986, -3.385497832886802, -3.393768587631489))
# }

Run the code above in your browser using DataLab