Merge pull request #287 from CliMA/ts/DSE

Add DSE function

Author: szy21

.github/workflows/invalidations.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
     - uses: julia-actions/setup-julia@v1
       with:
-        version: '1'
+        version: '1.11'
     - uses: actions/checkout@v4
     - uses: julia-actions/julia-buildpkg@v1
     - uses: julia-actions/julia-invalidations@v1

docs/src/API.md

@@ -86,6 +86,7 @@ liquid_ice_pottemp_sat
 liquid_specific_humidity
 mixing_ratios
 moist_static_energy
+dry_static_energy
 virtual_dry_static_energy
 q_vap_from_RH_liquid
 q_vap_saturation

src/air_energies.jl

@@ -13,6 +13,7 @@ export specific_enthalpy_vapor
 export specific_enthalpy_liquid
 export specific_enthalpy_ice
 export total_specific_enthalpy
+export dry_static_energy
 export virtual_dry_static_energy
 
 """
@@ -205,6 +206,7 @@ When `q` is not provided, the results are for dry air.
     return e_int + R_m * T
 end
 
+
 """
     specific_enthalpy_sat(param_set, T, ρ, q_tot, phase_type)
 
@@ -320,3 +322,17 @@ The total specific enthalpy, given
 @inline function total_specific_enthalpy(e_tot, R_m, T)
     return e_tot + R_m * T
 end
+
+"""
+    dry_static_energy(param_set, T, e_pot)
+
+The dry static energy, 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 dry_static_energy(param_set::APS, T, e_pot)
+    return specific_enthalpy_dry(param_set, T) + e_pot
+end