Skip to content

Commit 68ae5db

Browse files
authored
Fix typo in saturation specific humidity formula in Docs (#55)
* fix typo in qᵛ⁺ formula in docs * empty line * tweak docstrings
1 parent 6769fc1 commit 68ae5db

File tree

3 files changed

+18
-5
lines changed

3 files changed

+18
-5
lines changed

docs/src/thermodynamics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,10 +318,10 @@ fig
318318
The saturation specific humidity is
319319

320320
```math
321-
qᵛ⁺ ≡ \frac{ρᵛ⁺}{ρ} = \frac{pᵛ⁺}{Rᵐ T} .
321+
qᵛ⁺ ≡ \frac{ρᵛ⁺}{ρ} = \frac{pᵛ⁺}{ρ Rᵐ T} .
322322
```
323323

324-
This is what it looks like:
324+
and this is what it looks like:
325325

326326
```@example
327327
using Breeze

src/Thermodynamics/Thermodynamics.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ include("atmosphere_thermodynamics.jl")
88
include("vapor_saturation.jl")
99
include("reference_states.jl")
1010

11-
end # module
11+
end # module

src/Thermodynamics/vapor_saturation.jl

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""
22
saturation_vapor_pressure(T, thermo, phase::CondensedPhase)
33
4-
Compute the saturation vapor pressure ``pᵛ⁺`` over a liquid surface by integrating
5-
the Clausius-Clapeyron relation,
4+
Compute the saturation vapor pressure ``pᵛ⁺`` over a fluid surface at
5+
`phase` (i.e., liquid or solid) from the Clausius-Clapeyron relation,
66
77
```math
88
dpᵛ⁺ / dT = pᵛ⁺ ℒᵛ(T) / (Rᵛ T^2)
@@ -35,6 +35,19 @@ pᵛ⁺(T) = pᵗʳ \\left ( \\frac{T}{Tᵗʳ} \\right )^{Δcᵖ / Rᵛ} \\exp \
3535
end
3636

3737
# Over a liquid surface
38+
"""
39+
saturation_specific_humidity(T, ρ, thermo, condensed_phase::CondensedPhase)
40+
41+
Compute the saturation specific humidity for a gas at temperature `T`, total
42+
density `ρ`, `thermo`dynamics, and `condensed_phase` via:
43+
44+
```math
45+
qᵛ⁺ = pᵛ⁺ / (ρ Rᵛ T)
46+
```
47+
48+
where ``pᵛ⁺`` is the [`saturation_vapor_pressure`](@ref), and ``Rᵛ`` is the specific gas
49+
constant for water vapor.
50+
"""
3851
@inline function saturation_specific_humidity(T, ρ, thermo, condensed_phase::CondensedPhase)
3952
p★ = saturation_vapor_pressure(T, thermo, condensed_phase)
4053
Rᵛ = vapor_gas_constant(thermo)

0 commit comments

Comments
 (0)