fix method and add a couple tests (#1160)

Author: kmdeck

src/ClimaLand.jl

@@ -54,6 +54,18 @@ abstract type AbstractLandModel{FT} <: AbstractModel{FT} end
 
 ClimaLand.name(::AbstractLandModel) = :land
 
+"""
+    get_domain(model::AbstractLandModel)
+
+Return the ClimaLand domain of the model - for integrated models,
+this is the soil domain (e.g., Column, SphericalShell) since this
+includes both the surface and subsurface.
+
+If your model does not have a soil component, you will need to define
+a more specific method.
+"""
+get_domain(model::ClimaLand.AbstractLandModel) = model.soil.domain
+
 """
     Domains.coordinates(model::AbstractLandModel)
 

src/shared_utilities/models.jl

@@ -25,7 +25,7 @@ export AbstractModel,
     total_liq_water_vol_per_area!,
     total_energy_per_area!
 
-import ClimaComms
+import ClimaComms: context, device
 import .Domains: coordinates
 ## Default methods for all models - to be in a seperate module at some point.
 """
@@ -460,21 +460,23 @@ this is the soil domain (e.g., Column, SphericalShell).
 get_domain(model::ClimaLand.AbstractModel) = model.domain
 
 function ClimaComms.context(model::AbstractModel)
-    if :domain ∈ propertynames(model)
-        return ClimaComms.context(get_domain(model))
-    else
+    try
+        domain = get_domain(model)
+        return ClimaComms.context(domain)
+    catch
         error(
-            "Your model does not contain a domain. If this is intended, you will need a new method of ClimaComms.context.",
+            "Your model does not have a get_domain() method. If this is intended, you will need a new method of ClimaComms.context.",
         )
     end
 end
 
 function ClimaComms.device(model::AbstractModel)
-    if :domain ∈ propertynames(model)
-        return ClimaComms.device(get_domain(model))
-    else
+    try
+        domain = get_domain(model)
+        return ClimaComms.device(domain)
+    catch
         error(
-            "Your model does not contain a domain. If this is intended, you will need a new method of ClimaComms.device.",
+            "Your model does not have a get_domain() method. If this is intended, you will need a new method of ClimaComms.device.",
         )
     end
 end

test/integrated/full_land.jl

@@ -63,7 +63,9 @@ land = global_land_model(
     context = context,
     domain = domain,
 );
-
+@test domain == ClimaLand.get_domain(land)
+@test ClimaComms.context(land) == ClimaComms.context()
+@test ClimaComms.device(land) == ClimaComms.device()
 @test ClimaLand.land_components(land) == (:soil, :snow, :soilco2, :canopy)
 
 @testset "Total energy and water" begin

test/integrated/soil_energy_hydrology_biogeochemistry.jl

@@ -111,8 +111,8 @@ for FT in (Float32, Float64)
             soil_args = soil_args,
             soilco2_args = soilco2_args,
         )
-        @test_throws ErrorException ClimaComms.context(model)
-        @test_throws ErrorException ClimaComms.device(model)
+        @test ClimaComms.context(model) == ClimaComms.context()
+        @test ClimaComms.device(model) == ClimaComms.device()
 
         @test model.soilco2.drivers.met.ν == model.soil.parameters.ν
         @test model.soilco2.drivers.met isa ClimaLand.PrognosticMet

test/shared_utilities/domains.jl

@@ -70,6 +70,8 @@ FT = Float32
         npoly_sphere,
         (; surface = shell.space.surface),
     )
+    @test ClimaComms.context(shell) == ClimaComms.context()
+    @test ClimaComms.device(shell) == ClimaComms.device()
     shell_stretch = SphericalShell(;
         radius = radius,
         depth = FT(1.0),
@@ -109,6 +111,8 @@ FT = Float32
         zlim = zlim,
         nelements = nelements,
     )
+    @test ClimaComms.context(box) == ClimaComms.context()
+    @test ClimaComms.device(box) == ClimaComms.device()
     @test box.fields.depth == zlim[2] - zlim[1]
     @test box.fields.z ==
           ClimaCore.Fields.coordinate_field(box.space.subsurface).z
@@ -165,6 +169,8 @@ FT = Float32
         nelements = nelements[1:2],
         periodic = (true, true),
     )
+    @test ClimaComms.context(xy_plane) == ClimaComms.context()
+    @test ClimaComms.device(xy_plane) == ClimaComms.device()
     plane_coords = coordinates(xy_plane).surface
     @test eltype(plane_coords) == ClimaCore.Geometry.XYPoint{FT}
     @test typeof(plane_coords) <: ClimaCore.Fields.Field
@@ -264,6 +270,8 @@ FT = Float32
     # Column
 
     z_column = Column(; zlim = zlim, nelements = nelements[3])
+    @test ClimaComms.context(z_column) == ClimaComms.context()
+    @test ClimaComms.device(z_column) == ClimaComms.device()
     @test z_column.fields.z ==
           ClimaCore.Fields.coordinate_field(z_column.space.subsurface).z
     @test z_column.fields.depth == zlim[2] - zlim[1]
@@ -310,6 +318,8 @@ end
 @testset "Point Domain, FT = $FT" begin
     zmin = FT(1.0)
     point = Point(; z_sfc = zmin)
+    @test ClimaComms.context(point) == ClimaComms.context()
+    @test ClimaComms.device(point) == ClimaComms.device()
     @test point.z_sfc == zmin
     point_space = point.space.surface
     @test point_space isa ClimaCore.Spaces.PointSpace

test/standalone/Snow/snow.jl

@@ -48,6 +48,8 @@ import ClimaLand.Parameters as LP
         domain = domain,
         boundary_conditions = ClimaLand.Snow.AtmosDrivenSnowBC(atmos, rad),
     )
+    @test ClimaComms.context(model) == ClimaComms.context()
+    @test ClimaComms.device(model) == ClimaComms.device()
     drivers = ClimaLand.get_drivers(model)
     @test drivers == (atmos, rad)
     Y, p, coords = ClimaLand.initialize(model)

test/standalone/Soil/climate_drivers.jl

@@ -114,6 +114,8 @@ for FT in (Float32, Float64)
                 boundary_conditions = boundary_fluxes,
                 sources = (),
             )
+            @test ClimaComms.context(model) == ClimaComms.context()
+            @test ClimaComms.device(model) == ClimaComms.device()
             drivers = ClimaLand.get_drivers(model)
             @test drivers == (atmos, radiation)
             Y, p, coords = initialize(model)

test/standalone/Vegetation/canopy_model.jl

@@ -220,6 +220,8 @@ import ClimaParams
                     soil_driver,
                 ),
             )
+            @test ClimaComms.context(canopy) == ClimaComms.context()
+            @test ClimaComms.device(canopy) == ClimaComms.device()
             drivers = ClimaLand.get_drivers(canopy)
             @test drivers == (atmos, radiation)
             Y, p, coords = ClimaLand.initialize(canopy)