CliMA / SeawaterPolynomials.jl

Polynomials for efficiently computing the density of seawater
https://clima.github.io/SeawaterPolynomials.jl/dev
MIT License
14 stars 3 forks source link

`Θ₀` missing in `:SimplestRealistic`? #34

Closed navidcy closed 6 months ago

navidcy commented 6 months ago

Equation (17) by Roquet et al. (2015) mentions ρ' = R₁₀₀ Sᴬ + R₀₁₀ (Θ - Θ₀) - R₀₂₀ Θ² - R₀₁₁ Θ Z while the docstring does not include the Θ₀ term:

https://github.com/CliMA/SeawaterPolynomials.jl/blob/79045e7d140cde5ba21c86a5b7afe287108c2a21/src/SecondOrderSeawaterPolynomials.jl#L110-L112

Is it only a docstring problem? cc @glwagner

jbisits commented 6 months ago

After expanding equation (17) in Roquet et al. (2015) the Θ₀ term becomes part of the R₀₀₀ coeffcient in the polynomial form for seawater density (equation (6) in Roquet et al. (2015)). Because it has no effect on ocean dynamics it was removed. There is a discussion relating to this here.

navidcy commented 6 months ago

Should we add a remark in the docstring?

jbisits commented 6 months ago

Should we add a remark in the docstring?

That is a good idea! I can get to it tomorrow if you like?

navidcy commented 6 months ago

That'd be great