Add vapor static energy function

Author: tapios

Project.toml

@@ -1,7 +1,7 @@
 name = "Thermodynamics"
 uuid = "b60c26fb-14c3-4610-9d3e-2d17fe7ff00c"
 authors = ["Climate Modeling Alliance"]
-version = "0.15.0"
+version = "0.15.1"
 
 [deps]
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"

docs/src/API.md

@@ -87,6 +87,7 @@ liquid_specific_humidity
 mixing_ratios
 moist_static_energy
 dry_static_energy
+vapor_static_energy
 virtual_dry_static_energy
 q_vap_from_RH_liquid
 q_vap_saturation

src/air_energies.jl

@@ -14,6 +14,7 @@ export specific_enthalpy_liquid
 export specific_enthalpy_ice
 export total_specific_enthalpy
 export dry_static_energy
+export vapor_static_energy
 export virtual_dry_static_energy
 
 """
@@ -336,3 +337,19 @@ The dry static energy, given
 @inline function dry_static_energy(param_set::APS, T, e_pot)
     return specific_enthalpy_dry(param_set, T) + e_pot
 end
+
+"""
+    vapor_static_energy(param_set, T, e_pot)
+
+The `dry` static energy of water vapor, `cp_v * (T - T_0) + e_pot`, given
+
+ - `param_set` an `AbstractParameterSet`, see the [`Thermodynamics`](@ref) for more details
+ - `T` temperature
+ - `e_pot` gravitational potential energy per unit mass (geopotential)
+
+"""
+@inline function vapor_static_energy(param_set::APS, T, e_pot)
+    cp_v = TP.cp_v(param_set)
+    T_0 = TP.T_0(param_set)
+    return cp_v * (T - T_0) + e_pot
+end