Add diagnostics output for NOGW tendencies

Enable diagnostics for non-orographic gravity wave (NOGW) by extending YAML configurations and adding relevant outputs.

Author: ray-chew

config/model_configs/single_column_nonorographic_gravity_wave.yml

@@ -4,5 +4,9 @@ t_end: "1500secs"
 config: "column"
 hyperdiff: false
 dt: "400secs"
+output_default_diagnostics: true
 disable_surface_flux_tendency: true
 non_orographic_gravity_wave: true
+# diagnostics:
+#   - short_name: [ta, rhoa]
+#     period: 400secs

config/model_configs/sphere_nonorographic_gravity_wave.yml

@@ -1,4 +1,8 @@
-t_end: "1500secs"
-dt: "400secs"
+t_end: "48hours"
+dt: "450secs"
 disable_surface_flux_tendency: true
 non_orographic_gravity_wave: true
+dt_nogw: "450secs"
+diagnostics:
+  - short_name: [ta, thetaa, ua, va, wa, zg, utendnogw, vtendnogw]
+    period: 1hours

src/diagnostics/Diagnostics.jl

@@ -41,6 +41,10 @@ import ..EDOnlyEDMFX
 import ..PrognosticEDMFX
 import ..DiagnosticEDMFX
 
+# gravitywave_models
+import ..NonOrographyGravityWave
+import ..OrographicGravityWave
+
 # surface_model
 import ..PrognosticSurfaceTemperature
 

src/diagnostics/diagnostic.jl

@@ -98,7 +98,9 @@ include("core_diagnostics.jl")
 include("radiation_diagnostics.jl")
 include("edmfx_diagnostics.jl")
 include("tracer_diagnostics.jl")
+include("gravitywave_diagnostics.jl")
 include("conservation_diagnostics.jl")
 
+
 # Default diagnostics and higher level interfaces
 include("default_diagnostics.jl")

src/diagnostics/gravitywave_diagnostics.jl

@@ -0,0 +1,76 @@
+# This file is included in diagnostics.jl
+
+# Gravity-wave related diagnostics
+
+###
+# Eastward Non-Orographic Gravity-Wave Tendency 
+###
+compute_utendnogw!(out, state, cache, time) =
+    compute_utendnogw!(out, state, cache, time, cache.atmos.non_orographic_gravity_wave)
+compute_utendnogw!(_, _, _, _, non_orographic_gravity_wave::T) where {T} =
+    error_diagnostic_variable("utendnogw", non_orographic_gravity_wave)
+
+function compute_utendnogw!(
+    out,
+    state,
+    cache,
+    time,
+    ::T,
+) where {T <: NonOrographyGravityWave}
+    if isnothing(out)
+        # u_waveforcing is not a field:
+        # return Fields.array2field(
+        #     cache.non_orographic_gravity_wave.u_waveforcing,
+        #     axes(state.c),
+        # )
+        return copy(cache.non_orographic_gravity_wave.u_waveforcing)
+    else
+        out .= cache.non_orographic_gravity_wave.u_waveforcing
+    end
+end
+
+add_diagnostic_variable!(
+    short_name = "utendnogw",
+    long_name = "Eastward Acceleration Due to Non-Orographic Gravity Wave Drag",
+    standard_name = "tendency_of_eastward_wind_due_to_nonorographic_gravity_wave_drag",
+    units = "m s-2",
+    comments = "Eastward Acceleration Due to Non-Orographic Gravity Wave Drag",
+    compute! = compute_utendnogw!,
+)
+
+
+###
+# Northward Non-Orographic Gravity-Wave Tendency 
+###
+compute_vtendnogw!(out, state, cache, time) =
+    compute_vtendnogw!(out, state, cache, time, cache.atmos.non_orographic_gravity_wave)
+compute_vtendnogw!(_, _, _, _, non_orographic_gravity_wave::T) where {T} =
+    error_diagnostic_variable("vtendnogw", non_orographic_gravity_wave)
+
+function compute_vtendnogw!(
+    out,
+    state,
+    cache,
+    time,
+    ::T,
+) where {T <: NonOrographyGravityWave}
+    if isnothing(out)
+        # v_waveforcing is not a Field:
+        # return Fields.array2field(
+        #     cache.non_orographic_gravity_wave.v_waveforcing,
+        #     axes(state.c),
+        # )
+        return copy(cache.non_orographic_gravity_wave.v_waveforcing)
+    else
+        out .= cache.non_orographic_gravity_wave.v_waveforcing
+    end
+end
+
+add_diagnostic_variable!(
+    short_name = "vtendnogw",
+    long_name = "Northward Acceleration Due to Non-Orographic Gravity Wave Drag",
+    standard_name = "tendency_of_northward_wind_due_to_nonorographic_gravity_wave_drag",
+    units = "m s-2",
+    comments = "Northward Acceleration Due to Non-Orographic Gravity Wave Drag",
+    compute! = compute_vtendnogw!,
+)