remove extra get_field functions

Author: juliasloan25

NEWS.md

@@ -6,7 +6,13 @@ ClimaCoupler.jl Release Notes
 
 ### ClimaCoupler features
 
-### Coupler fields surface variable names all use `_sfc` PR[#1195](https://github.com/CliMA/ClimaCoupler.jl/pull/1195)
+#### Remove extra `get_field` functions PR[#1203](https://github.com/CliMA/ClimaCoupler.jl/pull/1203)
+Removes the `get_field` functions for `air_density` for all models, which
+were unused except for the `BucketSimulation` method, which is replaced by a
+function call to `extrapolate_ρ_to_sfc`. Also removes the `get_field` function
+for `ClimaAtmosSimulation` `air_temperature`, which was unused.
+
+#### 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`.
 

docs/src/interfacer.md

@@ -73,7 +73,6 @@ for the following properties:
 | Coupler name      | Description | Units |
 |-------------------|-------------|-------|
 | `air_density`       | air density of the atmosphere | kg m^-3 |
-| `air_temperature`   | air temperature at the surface of the atmosphere | K |
 | `energy`            | globally integrated energy | J |
 | `height_int`        | height at the first internal model level | m |
 | `height_sfc`        | height at the surface (only required when using `PartitionedStateFluxes`) | m |
@@ -120,7 +119,6 @@ for the following properties:
 
 | Coupler name      | Description | Units |
 |-------------------|-------------|-------|
-| `air_density`       | surface air density | kg m^-3 |
 | `area_fraction`     | fraction of the simulation grid surface area this model covers | |
 | `beta`              | factor that scales evaporation based on its estimated level of saturation | |
 | `roughness_buoyancy` | aerodynamic roughness length for buoyancy | m |
@@ -170,7 +168,6 @@ which is extended by `SurfaceStub`
 in the `surface_stub.jl` file, with
 the cache variables specified as:
 ```
-get_field(sim::AbstractSurfaceStub, ::Val{:air_density}) = sim.cache.ρ_sfc
 get_field(sim::AbstractSurfaceStub, ::Val{:area_fraction}) = sim.cache.area_fraction
 get_field(sim::AbstractSurfaceStub, ::Val{:beta}) = sim.cache.beta
 get_field(sim::AbstractSurfaceStub, ::Val{:energy}) = nothing

experiments/ClimaEarth/components/atmosphere/climaatmos.jl

@@ -170,10 +170,6 @@ moisture_flux(::Union{CA.EquilMoistModel, CA.NonEquilMoistModel}, integrator) =
 ρq_tot(::Union{CA.EquilMoistModel, CA.NonEquilMoistModel}, integrator) = integrator.u.c.ρq_tot
 
 # extensions required by the Interfacer
-Interfacer.get_field(sim::ClimaAtmosSimulation, ::Val{:air_density}) =
-    TD.air_density.(thermo_params, sim.integrator.p.precomputed.ᶜts)
-Interfacer.get_field(sim::ClimaAtmosSimulation, ::Val{:air_temperature}) =
-    TD.air_temperature.(thermo_params, sim.integrator.p.precomputed.ᶜts)
 Interfacer.get_field(sim::ClimaAtmosSimulation, ::Val{:liquid_precipitation}) =
     surface_rain_flux(sim.integrator.p.atmos.moisture_model, sim.integrator)
 Interfacer.get_field(sim::ClimaAtmosSimulation, ::Val{:radiative_energy_flux_sfc}) =

experiments/ClimaEarth/components/land/climaland_bucket.jl

@@ -229,7 +229,6 @@ function BucketSimulation(
 end
 
 # extensions required by Interfacer
-Interfacer.get_field(sim::BucketSimulation, ::Val{:air_density}) = sim.integrator.p.bucket.ρ_sfc
 Interfacer.get_field(sim::BucketSimulation, ::Val{:area_fraction}) = sim.area_fraction
 Interfacer.get_field(sim::BucketSimulation, ::Val{:beta}) =
     CL.surface_evaporative_scaling(sim.model, sim.integrator.u, sim.integrator.p)
@@ -323,7 +322,7 @@ function FluxCalculator.surface_thermo_state(
     # Note that the surface air density, ρ_sfc, is computed using the atmospheric state at the first level and making ideal gas
     # and hydrostatic balance assumptions. The land model does not compute the surface air density so this is
     # a reasonable stand-in.
-    ρ_sfc = Interfacer.get_field(sim, Val(:air_density))
+    ρ_sfc = FluxCalculator.extrapolate_ρ_to_sfc.(thermo_params, thermo_state_int, T_sfc) # ideally the # calculate elsewhere, here just getter...
     q_sfc = Interfacer.get_field(sim, Val(:surface_humidity)) # already calculated in rhs! (cache)
     @. TD.PhaseEquil_ρTq.(thermo_params, ρ_sfc, T_sfc, q_sfc)
 end

experiments/ClimaEarth/components/ocean/eisenman_seaice.jl

@@ -92,7 +92,6 @@ function EisenmanIceSimulation(
 end
 
 # extensions required by Interfacer
-Interfacer.get_field(sim::EisenmanIceSimulation, ::Val{:air_density}) = sim.integrator.p.Ya.ρ_sfc
 Interfacer.get_field(sim::EisenmanIceSimulation, ::Val{:area_fraction}) = sim.integrator.p.area_fraction
 Interfacer.get_field(sim::EisenmanIceSimulation, ::Val{:beta}) = convert(eltype(sim.integrator.u), 1.0)
 Interfacer.get_field(sim::EisenmanIceSimulation, ::Val{:roughness_buoyancy}) =

experiments/ClimaEarth/components/ocean/prescr_seaice.jl

@@ -154,7 +154,6 @@ function PrescribedIceSimulation(
 end
 
 # extensions required by Interfacer
-Interfacer.get_field(sim::PrescribedIceSimulation, ::Val{:air_density}) = sim.integrator.p.ρ_sfc
 Interfacer.get_field(sim::PrescribedIceSimulation, ::Val{:area_fraction}) = sim.integrator.p.area_fraction
 Interfacer.get_field(sim::PrescribedIceSimulation, ::Val{:beta}) = convert(eltype(sim.integrator.u), 1.0)
 Interfacer.get_field(sim::PrescribedIceSimulation, ::Val{:roughness_buoyancy}) = sim.integrator.p.params.z0b

experiments/ClimaEarth/components/ocean/slab_ocean.jl

@@ -107,7 +107,6 @@ function SlabOceanSimulation(
 end
 
 # extensions required by Interfacer
-Interfacer.get_field(sim::SlabOceanSimulation, ::Val{:air_density}) = sim.integrator.p.ρ_sfc
 Interfacer.get_field(sim::SlabOceanSimulation, ::Val{:area_fraction}) = sim.integrator.p.area_fraction
 Interfacer.get_field(sim::SlabOceanSimulation, ::Val{:beta}) = convert(eltype(sim.integrator.u), 1.0)
 Interfacer.get_field(sim::SlabOceanSimulation, ::Val{:roughness_buoyancy}) = sim.integrator.p.params.z0b

experiments/ClimaEarth/test/component_model_tests/prescr_ocean_tests.jl

@@ -63,7 +63,6 @@ end
     @test !isnothing(sim.cache.SST_timevaryinginput)
 
     # Test `Interfacer.get_field` function
-    @test Interfacer.get_field(sim, Val(:air_density)) == sim.cache.ρ_sfc
     @test Interfacer.get_field(sim, Val(:area_fraction)) == sim.cache.area_fraction
     @test Interfacer.get_field(sim, Val(:beta)) == sim.cache.beta
     @test Interfacer.get_field(sim, Val(:roughness_buoyancy)) == sim.cache.z0b

experiments/ClimaEarth/user_io/debug_plots.jl

@@ -230,8 +230,7 @@ Interfacer.get_field(sim::BucketSimulation, ::Val{:W}) = sim.integrator.u.bucket
 
 # currently selected plot fields
 plot_field_names(sim::Interfacer.SurfaceModelSimulation) = (:area_fraction, :surface_temperature, :surface_humidity)
-plot_field_names(sim::BucketSimulation) =
-    (:area_fraction, :surface_temperature, :surface_humidity, :air_density, :σS, :Ws, :W)
+plot_field_names(sim::BucketSimulation) = (:area_fraction, :surface_temperature, :surface_humidity, :σS, :Ws, :W)
 plot_field_names(sim::ClimaAtmosSimulation) = (:w, :ρq_tot, :ρe_tot, :liquid_precipitation, :snow_precipitation)
 
 

src/Interfacer.jl

@@ -119,8 +119,6 @@ an atmosphere component model.
 get_field(
     sim::AtmosModelSimulation,
     val::Union{
-        Val{:air_density},
-        Val{:air_temperature},
         Val{:energy},
         Val{:height_int},
         Val{:height_sfc},
@@ -146,7 +144,6 @@ a surface component model.
 get_field(
     sim::SurfaceModelSimulation,
     val::Union{
-        Val{:air_density},
         Val{:area_fraction},
         Val{:beta},
         Val{:roughness_buoyancy},