foreach_tracer -> foreach_gs_tracer

Author: charleskawczynski

src/parameterized_tendencies/les_sgs_models/smagorinsky_lilly.jl

@@ -107,7 +107,7 @@ function horizontal_smagorinsky_lilly_tendency!(Yₜ, Y, p, t, ::SmagorinskyLill
     @. Yₜ.c.ρe_tot += wdivₕ(Y.c.ρ * ᶜD_smag * gradₕ(ᶜh_tot))
 
     ## Tracer diffusion and associated mass changes
-    foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+    foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
         ᶜχ = @. lazy(specific(ᶜρχ, Y.c.ρ))
         ᶜρχₜ_diffusion = @. lazy(wdivₕ(Y.c.ρ * ᶜD_smag * gradₕ(ᶜχ)))
         @. ᶜρχₜ += ᶜρχₜ_diffusion
@@ -161,7 +161,7 @@ function vertical_smagorinsky_lilly_tendency!(Yₜ, Y, p, t, ::SmagorinskyLilly)
         bottom = Operators.SetValue(C3(FT(0))),
     )
 
-    foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+    foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
         ᶜ∇ᵥρD∇χₜ = @. lazy(ᶜdivᵥ_ρχ(-(ᶠρ * ᶠD_smag * ᶠgradᵥ(specific(ᶜρχ, Y.c.ρ)))))
         @. ᶜρχₜ -= ᶜ∇ᵥρD∇χₜ
         # Rain and snow does not affect the mass

src/prognostic_equations/advection.jl

@@ -213,7 +213,7 @@ NVTX.@annotate function explicit_vertical_advection_tendency!(Yₜ, Y, p, t)
     ᶜρ = Y.c.ρ
 
     # Full vertical advection of passive tracers (like liq, rai, etc) ...
-    foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+    foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
         if !(ρχ_name in (@name(ρe_tot), @name(ρq_tot)))
             ᶜχ = @. lazy(specific(ᶜρχ, Y.c.ρ))
             vtt = vertical_transport(ᶜρ, ᶠu³, ᶜχ, float(dt), tracer_upwinding)

src/prognostic_equations/remaining_tendency.jl

@@ -166,7 +166,7 @@ NVTX.@annotate function additional_tendency!(Yₜ, Y, p, t)
     @. Yₜ.c.ρe_tot += vst_ρe_tot
 
     # TODO: can we write this out explicitly?
-    foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+    foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
         ᶜχ = @. lazy(specific(ᶜρχ, Y.c.ρ))
         vst_tracer = viscous_sponge_tendency_tracer(ᶜρ, ᶜχ, viscous_sponge)
         @. ᶜρχₜ += vst_tracer

src/prognostic_equations/surface_flux.jl

@@ -115,7 +115,7 @@ function surface_flux_tendency!(Yₜ, Y, p, t)
     btt = boundary_tendency_scalar(ᶜh_tot, sfc_conditions.ρ_flux_h_tot)
     @. Yₜ.c.ρe_tot -= btt
     ρ_flux_χ = p.scratch.sfc_temp_C3
-    foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+    foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
         ᶜχ = @. lazy(specific(ᶜρχ, Y.c.ρ))
         if ρχ_name == @name(ρq_tot)
             @. ρ_flux_χ = sfc_conditions.ρ_flux_q_tot

src/prognostic_equations/vertical_diffusion_boundary_layer.jl

@@ -100,7 +100,7 @@ function vertical_diffusion_boundary_layer_tendency!(
         top = Operators.SetValue(C3(0)),
         bottom = Operators.SetValue(C3(0)),
     )
-    foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+    foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
         if ρχ_name in (@name(ρq_rai), @name(ρq_sno), @name(ρn_rai))
             @. ᶜK_h_scaled = α_vert_diff_tracer * ᶜK_h
         else

src/utils/variable_manipulations.jl

@@ -73,7 +73,7 @@ tracer_names(field) =
     end
 
 """
-    foreach_tracer(f::F, Yₜ, Y) where {F}
+    foreach_gs_tracer(f::F, Yₜ, Y) where {F}
 
 Applies a given function `f` to each grid-scale scalar variable (except `ρ` and  `ρe_tot`)
 in the state `Y` and its corresponding tendency `Yₜ`.
@@ -94,7 +94,7 @@ Arguments:
 # Example
 
 ```julia
-foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
+foreach_gs_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
     # Apply some operation, e.g., a sponge layer
     @. ᶜρχₜ += some_sponge_function(ᶜρχ)
     if ρχ_name == @name(ρq_tot)
@@ -103,7 +103,7 @@ foreach_tracer(Yₜ, Y) do ᶜρχₜ, ᶜρχ, ρχ_name
 end
 ```
 """
-foreach_tracer(f::F, Yₜ, Y) where {F} =
+foreach_gs_tracer(f::F, Yₜ, Y) where {F} =
     unrolled_foreach(tracer_names(Y.c)) do scalar_name
         ᶜρχₜ = MatrixFields.get_field(Yₜ.c, scalar_name)
         ᶜρχ = MatrixFields.get_field(Y.c, scalar_name)