Merge pull request #1195 from CliMA/js/cleanup

juliasloan25 · web-flow · commit 78ddd141c8c7 · 2025-02-14T19:58:05.000-05:00
various cleanup
diff --git a/NEWS.md b/NEWS.md
@@ -6,6 +6,10 @@ ClimaCoupler.jl Release Notes
 
 ### ClimaCoupler features
 
+### Coupler fields surface variable names all use `_sfc` PR[#1195](https://github.com/CliMA/ClimaCoupler.jl/pull/1195)
+`T_S`, `z0m_S`, and `z0b_S` are renamed to `T_sfc`, `z0m_sfc`, and `z0b_sfc`.
+This makes them consistent with the other surface fields, e.g. `ρ_sfc` and `q_sfc`.
+
 #### Driver function `setup_and_run` added PR[#1178](https://github.com/CliMA/ClimaCoupler.jl/pull/1178)
 A new function `setup_and_run` is added, which takes in a path to a config file,
 and contains all the code to initialize component models and run the simulation.
diff --git a/docs/src/interfacer.md b/docs/src/interfacer.md
@@ -106,7 +106,7 @@ following properties:
 | `surface_temperature` | temperature over the combined surface space | K |
 | `turbulent_fluxes` | turbulent fluxes (note: only required when using `PartitionedStateFluxes` option - see our `FluxCalculator` module docs for more information) | W m^-2 |
 
-- `calculate_surface_air_density(atmos_sim::Interfacer.AtmosModelSimulation, T_S::ClimaCore.Fields.Field)`:
+- `calculate_surface_air_density(atmos_sim::Interfacer.AtmosModelSimulation, T_sfc::ClimaCore.Fields.Field)`:
 A function to return the air density of the atmosphere simulation
 extrapolated to the surface, with units of [kg m^-3].
 
diff --git a/experiments/ClimaEarth/components/atmosphere/climaatmos.jl b/experiments/ClimaEarth/components/atmosphere/climaatmos.jl
@@ -16,9 +16,8 @@ include("climaatmos_extra_diags.jl")
 ###
 ### Functions required by ClimaCoupler.jl for an AtmosModelSimulation
 ###
-struct ClimaAtmosSimulation{P, Y, D, I} <: Interfacer.AtmosModelSimulation
+struct ClimaAtmosSimulation{P, D, I} <: Interfacer.AtmosModelSimulation
     params::P
-    Y_init::Y
     domain::D
     integrator::I
 end
@@ -69,7 +68,7 @@ function ClimaAtmosSimulation(atmos_config)
         @. ᶠradiation_flux = CC.Geometry.WVector(FT(0))
     end
 
-    sim = ClimaAtmosSimulation(integrator.p.params, Y, spaces, integrator)
+    sim = ClimaAtmosSimulation(integrator.p.params, spaces, integrator)
 
     # DSS state to ensure we have continuous fields
     dss_state!(sim)
@@ -191,7 +190,7 @@ function Interfacer.update_field!(sim::ClimaAtmosSimulation, ::Val{:surface_temp
     # note that this field is also being updated internally by the surface thermo state in ClimaAtmos
     # if turbulent fluxes are calculated, to ensure consistency. In case the turbulent fluxes are not
     # calculated, we update the field here.
-    sim.integrator.p.radiation.rrtmgp_model.surface_temperature .= CC.Fields.field2array(csf.T_S)
+    sim.integrator.p.radiation.rrtmgp_model.surface_temperature .= CC.Fields.field2array(csf.T_sfc)
 end
 # extensions required by FluxCalculator (partitioned fluxes)
 Interfacer.get_field(sim::ClimaAtmosSimulation, ::Val{:height_int}) =
@@ -259,31 +258,28 @@ function FieldExchanger.update_sim!(atmos_sim::ClimaAtmosSimulation, csf, turbul
     p = atmos_sim.integrator.p
     t = atmos_sim.integrator.t
 
-    !isempty(atmos_sim.integrator.p.radiation) &&
-        !(p.atmos.insolation isa CA.IdealizedInsolation) &&
-        CA.set_insolation_variables!(u, p, t, p.atmos.insolation)
-
+    # Perform radiation-specific updates
     if hasradiation(atmos_sim.integrator)
+        !(p.atmos.insolation isa CA.IdealizedInsolation) && CA.set_insolation_variables!(u, p, t, p.atmos.insolation)
         Interfacer.update_field!(atmos_sim, Val(:surface_direct_albedo), csf.surface_direct_albedo)
         Interfacer.update_field!(atmos_sim, Val(:surface_diffuse_albedo), csf.surface_diffuse_albedo)
+        Interfacer.update_field!(atmos_sim, Val(:surface_temperature), csf)
     end
 
-    !isempty(atmos_sim.integrator.p.radiation) && Interfacer.update_field!(atmos_sim, Val(:surface_temperature), csf)
-
     if turbulent_fluxes isa FluxCalculator.PartitionedStateFluxes
         Interfacer.update_field!(atmos_sim, Val(:turbulent_fluxes), csf)
     end
 end
 
 """
-    FluxCalculator.calculate_surface_air_density(atmos_sim::ClimaAtmosSimulation, T_S::CC.Fields.Field)
+    FluxCalculator.calculate_surface_air_density(atmos_sim::ClimaAtmosSimulation, T_sfc::CC.Fields.Field)
 
 Extension for this function to calculate surface density.
 """
-function FluxCalculator.calculate_surface_air_density(atmos_sim::ClimaAtmosSimulation, T_S::CC.Fields.Field)
+function FluxCalculator.calculate_surface_air_density(atmos_sim::ClimaAtmosSimulation, T_sfc::CC.Fields.Field)
     thermo_params = get_thermo_params(atmos_sim)
     ts_int = Interfacer.get_field(atmos_sim, Val(:thermo_state_int))
-    FluxCalculator.extrapolate_ρ_to_sfc.(Ref(thermo_params), ts_int, Utilities.swap_space!(axes(ts_int.ρ), T_S))
+    FluxCalculator.extrapolate_ρ_to_sfc.(Ref(thermo_params), ts_int, Utilities.swap_space!(axes(ts_int.ρ), T_sfc))
 end
 
 # FluxCalculator.get_surface_params required by FluxCalculator (partitioned fluxes)
@@ -416,9 +412,9 @@ Returns a new `p` with the updated surface conditions.
 """
 function get_new_cache(atmos_sim::ClimaAtmosSimulation, csf)
     if hasmoisture(atmos_sim.integrator)
-        csf_sfc = (csf.T_S, csf.z0m_S, csf.z0b_S, csf.beta, csf.q_sfc)
+        csf_sfc = (csf.T_sfc, csf.z0m_sfc, csf.z0b_sfc, csf.beta, csf.q_sfc)
     else
-        csf_sfc = (csf.T_S, csf.z0m_S, csf.z0b_S, csf.beta)
+        csf_sfc = (csf.T_sfc, csf.z0m_sfc, csf.z0b_sfc, csf.beta)
     end
 
     p = atmos_sim.integrator.p
@@ -442,8 +438,8 @@ trigger flux calculation during Atmos `Interfacer.step!`. We only want to trigge
 timestep from ClimaCoupler.
 
 For debigging atmos, we can set the following atmos defaults:
- csf.z0m_S .= 1.0e-5
- csf.z0b_S .= 1.0e-5
+ csf.z0m_sfc .= 1.0e-5
+ csf.z0b_sfc .= 1.0e-5
  csf.beta .= 1
  csf = merge(csf, (;q_sfc = nothing))
 """
diff --git a/experiments/ClimaEarth/components/land/climaland_bucket.jl b/experiments/ClimaEarth/components/land/climaland_bucket.jl
@@ -15,13 +15,12 @@ using NCDatasets
 ### Functions required by ClimaCoupler.jl for a SurfaceModelSimulation
 ###
 """
-    BucketSimulation{M, Y, D, I}
+    BucketSimulation{M, D, I}
 
 The bucket model simulation object.
 """
-struct BucketSimulation{M, Y, D, I, A} <: Interfacer.LandModelSimulation
+struct BucketSimulation{M, D, I, A} <: Interfacer.LandModelSimulation
     model::M
-    Y_init::Y
     domain::D
     integrator::I
     area_fraction::A
@@ -222,7 +221,7 @@ function BucketSimulation(
         callback = SciMLBase.CallbackSet(diag_cb),
     )
 
-    sim = BucketSimulation(model, Y, (; domain = domain, soil_depth = d_soil), integrator, area_fraction)
+    sim = BucketSimulation(model, (; domain = domain, soil_depth = d_soil), integrator, area_fraction)
 
     # DSS state to ensure we have continuous fields
     dss_state!(sim)
diff --git a/experiments/ClimaEarth/components/ocean/eisenman_seaice.jl b/experiments/ClimaEarth/components/ocean/eisenman_seaice.jl
@@ -7,17 +7,16 @@ import ClimaCoupler: Checkpointer, FluxCalculator, Interfacer, Utilities
 ### Functions required by ClimaCoupler.jl for a SurfaceModelSimulation
 ###
 """
-    EisenmanIceSimulation{P, Y, D, I}
+    EisenmanIceSimulation{P, D, I}
 
 Thermodynamic 0-layer, based on the Semtner 1976 model and later refined by
 Eisenmen 2009 and Zhang et al 2021.
 
 Note that Eisenman sea ice assumes gray radiation, no snow coverage, and
 PartitionedStateFluxes for the surface flux calculation.
 """
-struct EisenmanIceSimulation{P, Y, D, I} <: Interfacer.SeaIceModelSimulation
+struct EisenmanIceSimulation{P, D, I} <: Interfacer.SeaIceModelSimulation
     params_ice::P
-    Y_init::Y
     domain::D
     integrator::I
 end
@@ -83,7 +82,7 @@ function EisenmanIceSimulation(
     problem = SciMLBase.ODEProblem(ode_function, Y, Float64.(tspan), cache)
     integrator = SciMLBase.init(problem, ode_algo, dt = Float64(dt), saveat = Float64.(saveat), adaptive = false)
 
-    sim = EisenmanIceSimulation(params, Y, space, integrator)
+    sim = EisenmanIceSimulation(params, space, integrator)
     return sim
 end
 
diff --git a/experiments/ClimaEarth/components/ocean/prescr_seaice.jl b/experiments/ClimaEarth/components/ocean/prescr_seaice.jl
@@ -11,7 +11,7 @@ import ClimaCoupler: Checkpointer, FluxCalculator, Interfacer, Utilities
 ### Functions required by ClimaCoupler.jl for a SurfaceModelSimulation
 ###
 """
-    PrescribedIceSimulation{P, Y, D, I}
+    PrescribedIceSimulation{P, D, I}
 
 Ice concentration is prescribed, and we solve the following energy equation:
 
@@ -27,9 +27,8 @@ Ice concentration is prescribed, and we solve the following energy equation:
 
 In the current version, the sea ice has a prescribed thickness.
 """
-struct PrescribedIceSimulation{P, Y, D, I} <: Interfacer.SeaIceModelSimulation
+struct PrescribedIceSimulation{P, D, I} <: Interfacer.SeaIceModelSimulation
     params::P
-    Y_init::Y
     domain::D
     integrator::I
 end
@@ -143,7 +142,7 @@ function PrescribedIceSimulation(
     problem = SciMLBase.ODEProblem(ode_function, Y, Float64.(tspan), (; cache..., params = params))
     integrator = SciMLBase.init(problem, ode_algo, dt = Float64(dt), saveat = Float64.(saveat), adaptive = false)
 
-    sim = PrescribedIceSimulation(params, Y, space, integrator)
+    sim = PrescribedIceSimulation(params, space, integrator)
 
     # DSS state to ensure we have continuous fields
     dss_state!(sim)
diff --git a/experiments/ClimaEarth/components/ocean/slab_ocean.jl b/experiments/ClimaEarth/components/ocean/slab_ocean.jl
@@ -7,16 +7,15 @@ import ClimaCoupler: Checkpointer, FluxCalculator, Interfacer, Utilities
 ### Functions required by ClimaCoupler.jl for a SurfaceModelSimulation
 ###
 """
-    SlabOceanSimulation{P, Y, D, I}
+    SlabOceanSimulation{P, D, I}
 
 Equation:
 
     (h * ρ * c) dTdt = -(F_turb_energy + F_radiative)
 
 """
-struct SlabOceanSimulation{P, Y, D, I} <: Interfacer.OceanModelSimulation
+struct SlabOceanSimulation{P, D, I} <: Interfacer.OceanModelSimulation
     params::P
-    Y_init::Y
     domain::D
     integrator::I
 end
@@ -96,7 +95,7 @@ function SlabOceanSimulation(
     problem = SciMLBase.ODEProblem(ode_function, Y, Float64.(tspan), cache)
     integrator = SciMLBase.init(problem, ode_algo, dt = Float64(dt), saveat = Float64.(saveat), adaptive = false)
 
-    sim = SlabOceanSimulation(params, Y, space, integrator)
+    sim = SlabOceanSimulation(params, space, integrator)
 
     # DSS state to ensure we have continuous fields
     dss_state!(sim)
diff --git a/experiments/ClimaEarth/run_cloudless_aquaplanet.jl b/experiments/ClimaEarth/run_cloudless_aquaplanet.jl
@@ -173,9 +173,9 @@ ocean_sim = SlabOceanSimulation(
 
 ## coupler exchange fields
 coupler_field_names = (
-    :T_S,
-    :z0m_S,
-    :z0b_S,
+    :T_sfc,
+    :z0m_sfc,
+    :z0b_sfc,
     :ρ_sfc,
     :q_sfc,
     :surface_direct_albedo,
diff --git a/experiments/ClimaEarth/run_cloudy_aquaplanet.jl b/experiments/ClimaEarth/run_cloudy_aquaplanet.jl
@@ -196,9 +196,9 @@ ocean_sim = SlabOceanSimulation(
 
 ## coupler exchange fields
 coupler_field_names = (
-    :T_S,
-    :z0m_S,
-    :z0b_S,
+    :T_sfc,
+    :z0m_sfc,
+    :z0b_sfc,
     :ρ_sfc,
     :q_sfc,
     :surface_direct_albedo,
diff --git a/experiments/ClimaEarth/run_cloudy_slabplanet.jl b/experiments/ClimaEarth/run_cloudy_slabplanet.jl
@@ -240,9 +240,9 @@ ocean_sim = SlabOceanSimulation(
 
 ## coupler exchange fields
 coupler_field_names = (
-    :T_S,
-    :z0m_S,
-    :z0b_S,
+    :T_sfc,
+    :z0m_sfc,
+    :z0b_sfc,
     :ρ_sfc,
     :q_sfc,
     :surface_direct_albedo,
diff --git a/experiments/ClimaEarth/run_dry_held_suarez.jl b/experiments/ClimaEarth/run_dry_held_suarez.jl
@@ -142,9 +142,9 @@ boundary_space = ClimaCore.Spaces.horizontal_space(atmos_sim.domain.face_space)
 
 ## coupler exchange fields
 coupler_field_names = (
-    :T_S,
-    :z0m_S,
-    :z0b_S,
+    :T_sfc,
+    :z0m_sfc,
+    :z0b_sfc,
     :ρ_sfc,
     :q_sfc,
     :surface_direct_albedo,
diff --git a/experiments/ClimaEarth/run_moist_held_suarez.jl b/experiments/ClimaEarth/run_moist_held_suarez.jl
@@ -178,9 +178,9 @@ ocean_sim = Interfacer.SurfaceStub((;
 
 ## coupler exchange fields
 coupler_field_names = (
-    :T_S,
-    :z0m_S,
-    :z0b_S,
+    :T_sfc,
+    :z0m_sfc,
+    :z0b_sfc,
     :ρ_sfc,
     :q_sfc,
     :surface_direct_albedo,
diff --git a/experiments/ClimaEarth/setup_run.jl b/experiments/ClimaEarth/setup_run.jl
@@ -25,6 +25,7 @@ import DelimitedFiles
 # ## ClimaESM packages
 import ClimaAtmos as CA
 import ClimaComms
+@static pkgversion(ClimaComms) >= v"0.6" && ClimaComms.@import_required_backends
 import ClimaCore as CC
 
 # ## Coupler specific imports
@@ -457,9 +458,9 @@ function setup_and_run(config_file = joinpath(pkgdir(ClimaCoupler), "config/ci_c
 
     ## coupler exchange fields
     coupler_field_names = (
-        :T_S,
-        :z0m_S,
-        :z0b_S,
+        :T_sfc,
+        :z0m_sfc,
+        :z0b_sfc,
         :ρ_sfc,
         :q_sfc,
         :surface_direct_albedo,
diff --git a/experiments/ClimaEarth/test/component_model_tests/climaatmos_tests.jl b/experiments/ClimaEarth/test/component_model_tests/climaatmos_tests.jl
@@ -16,7 +16,7 @@ for FT in (Float32, Float64)
             u = (; state_field1 = CC.Fields.ones(boundary_space), state_field2 = CC.Fields.zeros(boundary_space)),
             p = (; cache_field = CC.Fields.zeros(boundary_space)),
         )
-        sim = ClimaAtmosSimulation(nothing, nothing, nothing, integrator)
+        sim = ClimaAtmosSimulation(nothing, nothing, integrator)
 
         # make field non-constant to check the impact of the dss step
         coords_lat = CC.Fields.coordinate_field(sim.integrator.u.state_field2).lat
diff --git a/experiments/ClimaEarth/test/component_model_tests/prescr_seaice_tests.jl b/experiments/ClimaEarth/test/component_model_tests/prescr_seaice_tests.jl
@@ -100,7 +100,7 @@ for FT in (Float32, Float64)
         )
         p = (; cache_field = CC.Fields.zeros(boundary_space), dss_buffer = CC.Spaces.create_dss_buffer(u))
         integrator = (; u, p)
-        sim = PrescribedIceSimulation(nothing, nothing, nothing, integrator)
+        sim = PrescribedIceSimulation(nothing, nothing, integrator)
 
         # make field non-constant to check the impact of the dss step
         coords_lat = CC.Fields.coordinate_field(sim.integrator.u.state_field2).lat
diff --git a/experiments/ClimaEarth/test/component_model_tests/slab_ocean_tests.jl b/experiments/ClimaEarth/test/component_model_tests/slab_ocean_tests.jl
@@ -21,7 +21,7 @@ for FT in (Float32, Float64)
         )
         p = (; cache_field = CC.Fields.zeros(boundary_space), dss_buffer = CC.Spaces.create_dss_buffer(u))
         integrator = (; u, p)
-        sim = SlabOceanSimulation(nothing, nothing, nothing, integrator)
+        sim = SlabOceanSimulation(nothing, nothing, integrator)
 
         # make field non-constant to check the impact of the dss step
         coords_lat = CC.Fields.coordinate_field(sim.integrator.u.state_field2).lat
diff --git a/experiments/ClimaEarth/test/debug_plots_tests.jl b/experiments/ClimaEarth/test/debug_plots_tests.jl
@@ -2,6 +2,8 @@
 import Test: @test, @testset, @test_logs
 import ClimaCore as CC
 import ClimaCoupler: Interfacer
+import ClimaComms
+@static pkgversion(ClimaComms) >= v"0.6" && ClimaComms.@import_required_backends
 
 include("TestHelper.jl")
 import .TestHelper
@@ -43,12 +45,12 @@ plot_field_names(sim::Interfacer.SurfaceStub) = (:stub_field,)
         :F_turb_ρτyz,
         :P_liq,
         :P_snow,
-        :T_S,
+        :T_sfc,
         :ρ_sfc,
         :q_sfc,
         :beta,
-        :z0b_S,
-        :z0m_S,
+        :z0b_sfc,
+        :z0m_sfc,
         :radiative_energy_flux_toa,
     )
     atmos_names = (:atmos_field,)
diff --git a/experiments/ClimaEarth/user_io/debug_plots.jl b/experiments/ClimaEarth/user_io/debug_plots.jl
@@ -1,6 +1,4 @@
 import Printf
-import ClimaComms
-@static pkgversion(ClimaComms) >= v"0.6" && ClimaComms.@import_required_backends
 import ClimaCore as CC
 import Makie
 import ClimaCoreMakie
@@ -115,12 +113,12 @@ function debug(cs_fields::NamedTuple, dir, cs_fields_ref = nothing)
         :F_turb_ρτyz,
         :P_liq,
         :P_snow,
-        :T_S,
+        :T_sfc,
         :ρ_sfc,
         :q_sfc,
         :beta,
-        :z0b_S,
-        :z0m_S,
+        :z0b_sfc,
+        :z0m_sfc,
         :radiative_energy_flux_toa,
     )
     fig = Makie.Figure(size = (1500, 800))
diff --git a/src/FieldExchanger.jl b/src/FieldExchanger.jl
diff --git a/src/FluxCalculator.jl b/src/FluxCalculator.jl
diff --git a/test/field_exchanger_tests.jl b/test/field_exchanger_tests.jl
diff --git a/test/flux_calculator_tests.jl b/test/flux_calculator_tests.jl
