Add error handling to Regridders.regrid

Author: ph-kev

ext/InterpolationsRegridderExt.jl

@@ -7,6 +7,7 @@ import ClimaCore.Fields: Adapt
 import ClimaCore.Fields: ClimaComms
 
 import ClimaUtilities.Regridders
+import ClimaUtilities.Utils: unwrap
 
 struct InterpolationsRegridder{
     SPACE <: ClimaCore.Spaces.AbstractSpace,
@@ -119,6 +120,14 @@ Regrid the given data as defined on the given dimensions to the `target_space` i
 This function is allocating.
 """
 function Regridders.regrid(regridder::InterpolationsRegridder, data, dimensions)
+    num_data_dims = ndims(data)
+    num_dims = length(dimensions)
+    num_space_dims = unwrap(regridder.num_space_dims)
+    ((num_space_dims != num_data_dims) || (num_space_dims != num_dims)) &&
+        error(
+            "Number of dimensions of data ($num_data_dims) does not match the dimension of the space ($num_space_dims) or the number of dimensions passed in ($num_dims)",
+        )
+
     FT = ClimaCore.Spaces.undertype(regridder.target_space)
     dimensions_FT = ntuple(
         i ->

test/data_handling.jl

@@ -144,13 +144,10 @@ ClimaComms.init(context)
         target_space;
         regridder_type = :InterpolationsRegridder,
         file_reader_kwargs = (; preprocess_func = (data) -> 0.0 * data),
-        regridder_kwargs = (;
-            extrapolation_bc = (Intp.Flat(), Intp.Flat(), Intp.Flat())
-        ),
+        regridder_kwargs = (; extrapolation_bc = (Intp.Flat(), Intp.Flat())),
     )
 
-    @test data_handler.regridder.extrapolation_bc ==
-          (Intp.Flat(), Intp.Flat(), Intp.Flat())
+    @test data_handler.regridder.extrapolation_bc == (Intp.Flat(), Intp.Flat())
     field = DataHandling.regridded_snapshot(data_handler)
     @test extrema(field) == (0.0, 0.0)
 end

test/regridders.jl

@@ -129,6 +129,21 @@ end
     @test regridded_lat_reversed == regridded_lat
     @test regridded_lon_reversed == regridded_lon
     @test regridded_z_reversed == regridded_z
+
+    # Error handling
+    data = [1.0, 2.0, 3.0, 4.0]
+    @test_throws ErrorException Regridders.regrid(
+        reg_hv_reversed,
+        data,
+        dimensions3D_reversed,
+    )
+
+    dimensions = ([1.0, 2.0, 3.0],)
+    @test_throws ErrorException Regridders.regrid(
+        reg_hv_reversed,
+        data_z3D_reversed,
+        dimensions,
+    )
 end
 
 @testset "InterpolationsRegridder" begin