Change defaults of structured interpolation methods, originally modified with [ed0996d - Deprecate factory builders for structured interpolation methods]

wdeconinck · wdeconinck · commit 3cdb7a43a713 · 2025-06-25T11:48:22.000+02:00
diff --git a/src/atlas/interpolation/method/structured/Cubic2D.cc b/src/atlas/interpolation/method/structured/Cubic2D.cc
@@ -20,11 +20,10 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<Cubic2D> __builder0("structured-cubic");
-MethodBuilder<Cubic2D> __builder1("structured-bicubic", FactoryDeprecated("Please use structured-cubic"));
-MethodBuilder<Cubic2D> __builder2("structured-cubic2D", FactoryDeprecated("Please use structured-cubic"));
-MethodBuilder<Cubic2D> __builder3("cubic2D", FactoryDeprecated("Please use structured-cubic"));
-MethodBuilder<Cubic2D> __builder4("bicubic", FactoryDeprecated("Please use structured-cubic"));
+MethodBuilder<Cubic2D> __builder1("structured-bicubic");
+MethodBuilder<Cubic2D> __builder2("structured-cubic2D", FactoryDeprecated("Please use structured-bicubic"));
+MethodBuilder<Cubic2D> __builder3("cubic2D", FactoryDeprecated("Please use structured-bicubic"));
+MethodBuilder<Cubic2D> __builder4("bicubic", FactoryDeprecated("Please use structured-bicubic"));
 
 }  // namespace
 
diff --git a/src/atlas/interpolation/method/structured/Cubic3D.cc b/src/atlas/interpolation/method/structured/Cubic3D.cc
@@ -20,11 +20,10 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<Cubic3D> __builder0("structured-3d-cubic");
-MethodBuilder<Cubic3D> __builder1("structured-tricubic", FactoryDeprecated("Please use structured-3d-cubic"));
-MethodBuilder<Cubic3D> __builder2("structured-cubic3D", FactoryDeprecated("Please use structured-3d-cubic"));
-MethodBuilder<Cubic3D> __builder3("cubic3D", FactoryDeprecated("Please use structured-3d-cubic"));
-MethodBuilder<Cubic3D> __builder4("tricubic", FactoryDeprecated("Please use structured-3d-cubic"));
+MethodBuilder<Cubic3D> __builder1("structured-tricubic");
+MethodBuilder<Cubic3D> __builder2("structured-bicubic3D", FactoryDeprecated("Please use structured-tricubic"));
+MethodBuilder<Cubic3D> __builder3("cubic3D", FactoryDeprecated("Please use structured-tricubic"));
+MethodBuilder<Cubic3D> __builder4("tricubic", FactoryDeprecated("Please use structured-tricubic"));
 
 }  // namespace
 
diff --git a/src/atlas/interpolation/method/structured/Linear2D.cc b/src/atlas/interpolation/method/structured/Linear2D.cc
@@ -20,11 +20,10 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<Linear2D> __builder0("structured-linear");
-MethodBuilder<Linear2D> __builder1("structured-bilinear", FactoryDeprecated("Please use structured-linear"));
-MethodBuilder<Linear2D> __builder2("structured-linear2D", FactoryDeprecated("Please use structured-linear"));
-MethodBuilder<Linear2D> __builder3("linear2D", FactoryDeprecated("Please use structured-linear"));
-MethodBuilder<Linear2D> __builder4("bilinear", FactoryDeprecated("Please use structured-linear"));
+MethodBuilder<Linear2D> __builder1("structured-bilinear");
+MethodBuilder<Linear2D> __builder2("structured-linear2D", FactoryDeprecated("Please use structured-bilinear"));
+MethodBuilder<Linear2D> __builder3("linear2D", FactoryDeprecated("Please use structured-bilinear"));
+MethodBuilder<Linear2D> __builder4("bilinear", FactoryDeprecated("Please use structured-bilinear"));
 
 }  // namespace
 
diff --git a/src/atlas/interpolation/method/structured/Linear3D.cc b/src/atlas/interpolation/method/structured/Linear3D.cc
@@ -20,11 +20,10 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<Linear3D> __builder0("structured-3d-linear");
-MethodBuilder<Linear3D> __builder1("structured-trilinear", FactoryDeprecated("Please use structured-3d-linear"));
-MethodBuilder<Linear3D> __builder2("structured-linear3D", FactoryDeprecated("Please use structured-3d-linear"));
-MethodBuilder<Linear3D> __builder3("linear3D", FactoryDeprecated("Please use structured-3d-linear"));
-MethodBuilder<Linear3D> __builder4("trilinear", FactoryDeprecated("Please use structured-3d-linear"));
+MethodBuilder<Linear3D> __builder1("structured-trilinear");
+MethodBuilder<Linear3D> __builder2("structured-linear3D", FactoryDeprecated("Please use structured-trilinear"));
+MethodBuilder<Linear3D> __builder3("linear3D", FactoryDeprecated("Please use structured-trilinear"));
+MethodBuilder<Linear3D> __builder4("trilinear", FactoryDeprecated("Please use structured-trilinear"));
 
 }  // namespace
 
diff --git a/src/atlas/interpolation/method/structured/QuasiCubic2D.cc b/src/atlas/interpolation/method/structured/QuasiCubic2D.cc
@@ -20,11 +20,10 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<QuasiCubic2D> __builder0("structured-quasicubic");
-MethodBuilder<QuasiCubic2D> __builder1("structured-biquasicubic", FactoryDeprecated("Please use structured-quasicubic"));
-MethodBuilder<QuasiCubic2D> __builder2("structured-quasicubic2D", FactoryDeprecated("Please use structured-quasicubic"));
-MethodBuilder<QuasiCubic2D> __builder3("quasicubic2D", FactoryDeprecated("Please use structured-quasicubic"));
-MethodBuilder<QuasiCubic2D> __builder4("biquasicubic", FactoryDeprecated("Please use structured-quasicubic"));
+MethodBuilder<QuasiCubic2D> __builder1("structured-biquasicubic");
+MethodBuilder<QuasiCubic2D> __builder2("structured-quasicubic2D", FactoryDeprecated("Please use structured-biquasicubic"));
+MethodBuilder<QuasiCubic2D> __builder3("quasicubic2D", FactoryDeprecated("Please use structured-biquasicubic"));
+MethodBuilder<QuasiCubic2D> __builder4("biquasicubic", FactoryDeprecated("Please use structured-biquasicubic"));
 
 }  // namespace
 
diff --git a/src/atlas/interpolation/method/structured/QuasiCubic3D.cc b/src/atlas/interpolation/method/structured/QuasiCubic3D.cc
@@ -20,11 +20,10 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<QuasiCubic3D> __builder0("structured-3d-quasicubic");
-MethodBuilder<QuasiCubic3D> __builder1("structured-triquasicubic", FactoryDeprecated("Please use structured-3d-quasicubic"));
-MethodBuilder<QuasiCubic3D> __builder2("structured-quasicubic3D", FactoryDeprecated("Please use structured-3d-quasicubic"));
-MethodBuilder<QuasiCubic3D> __builder3("quasicubic3D", FactoryDeprecated("Please use structured-3d-quasicubic"));
-MethodBuilder<QuasiCubic3D> __builder4("triquasicubic", FactoryDeprecated("Please use structured-3d-quasicubic"));
+MethodBuilder<QuasiCubic3D> __builder1("structured-triquasicubic");
+MethodBuilder<QuasiCubic3D> __builder2("structured-quasicubic3D", FactoryDeprecated("Please use structured-triquasicubic"));
+MethodBuilder<QuasiCubic3D> __builder3("quasicubic3D", FactoryDeprecated("Please use structured-triquasicubic"));
+MethodBuilder<QuasiCubic3D> __builder4("triquasicubic", FactoryDeprecated("Please use structured-triquasicubic"));
 
 }  // namespace
 
diff --git a/src/atlas/interpolation/method/structured/RegionalLinear2D.cc b/src/atlas/interpolation/method/structured/RegionalLinear2D.cc
@@ -22,8 +22,8 @@ namespace {
 
 using util::FactoryDeprecated;
 
-MethodBuilder<RegionalLinear2D> __builder0("regional-linear");
-MethodBuilder<RegionalLinear2D> __builder1("regional-linear-2d", FactoryDeprecated("Please use regional-linear"));
+MethodBuilder<RegionalLinear2D> __builder0("regional-bilinear");
+MethodBuilder<RegionalLinear2D> __builder1("regional-linear-2d", FactoryDeprecated("Please use regional-bilinear"));
 
 }
 
diff --git a/src/sandbox/interpolation/atlas-parallel-structured-interpolation.cc b/src/sandbox/interpolation/atlas-parallel-structured-interpolation.cc
@@ -71,16 +71,16 @@ static Config processed_config(const eckit::Configuration& _config) {
     }
     std::string scheme_str = _config.getString("method", "linear");
     if (scheme_str == "linear") {
-        config.set("type", "structured-linear");
+        config.set("type", "structured-bilinear");
         config.set("halo", 1);
         // The stencil does not require any halo, but we set it to 1 for pole treatment!
     }
     if (scheme_str == "cubic") {
-        config.set("type", "structured-cubic");
+        config.set("type", "structured-bicubic");
         config.set("halo", 2);
     }
     if (scheme_str == "quasicubic") {
-        config.set("type", "structured-quasicubic");
+        config.set("type", "structured-biquasicubic");
         config.set("halo", 2);
     }
     config.set("name", scheme_str);
diff --git a/src/tests/interpolation/test_interpolation_binning.cc b/src/tests/interpolation/test_interpolation_binning.cc
@@ -179,7 +179,7 @@ CASE("rigridding from high to low resolution; grid type: O") {
 
 
   const auto scheme = util::Config("type", "binning") |
-                      util::Config("scheme", option::type("structured-linear"));
+                      util::Config("scheme", option::type("structured-bilinear"));
 
   Interpolation regrid_high2low(scheme, ncfs_s, ncfs_t);
 
diff --git a/src/tests/interpolation/test_interpolation_cubic_prototype.cc b/src/tests/interpolation/test_interpolation_cubic_prototype.cc
@@ -330,7 +330,7 @@ CASE("test 3d cubic interpolation") {
 
     SECTION("official version") {
         auto matrix_free = Config("matrix_free", true);
-        Interpolation interpolation(option::type("structured-3d-cubic") | matrix_free, fs, departure_points);
+        Interpolation interpolation(option::type("structured-tricubic") | matrix_free, fs, departure_points);
 
         Field output = Field("output", make_datatype<double>(), make_shape(departure_points.size()));
         interpolation.execute(input, output);
@@ -367,7 +367,7 @@ CASE("test 3d cubic interpolation") {
                 }
             }
         }
-        Interpolation interpolation(option::type("structured-3d-cubic") | matrix_free, fs, dp_field);
+        Interpolation interpolation(option::type("structured-tricubic") | matrix_free, fs, dp_field);
 
         Field output = fs.createField<double>();
         interpolation.execute(input, output);
diff --git a/src/tests/interpolation/test_interpolation_global_matrix.cc b/src/tests/interpolation/test_interpolation_global_matrix.cc
@@ -246,11 +246,11 @@ using SparseMatrixStorage = atlas::linalg::SparseMatrixStorage;
 
     auto test_matrix_assemble_distribute = [&](const Grid& input_grid, const Grid& output_grid) {
         int mpi_root = 0;
-        do_assemble_distribute_matrix("structured-linear", input_grid, output_grid, mpi_root);
+        do_assemble_distribute_matrix("structured-bilinear", input_grid, output_grid, mpi_root);
 
         mpi_root = mpi::size() - 1;
         std::vector<std::string> interpolators;
-        interpolators.insert(interpolators.end(), {"structured-linear", "structured-cubic", "structured-quasicubic"});
+        interpolators.insert(interpolators.end(), {"structured-bilinear", "structured-bicubic", "structured-biquasicubic"});
         interpolators.insert(interpolators.end(), {"nearest-neighbour", "k-nearest-neighbours", "conservative-spherical-polygon", "finite-element", "unstructured-bilinear-lonlat"});
         for (auto scheme_str : interpolators) {
             do_assemble_distribute_matrix(scheme_str, input_grid, output_grid, mpi_root);
diff --git a/src/tests/interpolation/test_interpolation_spherical_vector.cc b/src/tests/interpolation/test_interpolation_spherical_vector.cc
@@ -131,10 +131,10 @@ struct InterpSchemeFixtures {
         option::type("cubedsphere-bilinear") | Config("adjoint", true);
     static const auto finiteElement =
         option::type("finite-element") | Config("adjoint", true);
-    static const auto structuredLinear = option::type("structured-linear") |
+    static const auto structuredLinear = option::type("structured-bilinear") |
                                          option::halo(1) |
                                          Config("adjoint", true);
-    static const auto structuredCubic = option::type("structured-cubic") |
+    static const auto structuredCubic = option::type("structured-bicubic") |
                                         option::halo(2) |
                                         Config("adjoint", true);
     static const auto sphericalVector =
diff --git a/src/tests/interpolation/test_interpolation_structured2D.cc b/src/tests/interpolation/test_interpolation_structured2D.cc
@@ -38,16 +38,16 @@ static Config scheme() {
     Config scheme;
     std::string scheme_str = eckit::Resource<std::string>("--scheme", "linear");
     if (scheme_str == "linear") {
-        scheme.set("type", "structured-linear");
+        scheme.set("type", "structured-bilinear");
         scheme.set("halo", 1);
         // The stencil does not require any halo, but we set it to 1 for pole treatment!
     }
     if (scheme_str == "cubic") {
-        scheme.set("type", "structured-cubic");
+        scheme.set("type", "structured-bicubic");
         scheme.set("halo", 2);
     }
     if (scheme_str == "quasicubic") {
-        scheme.set("type", "structured-quasicubic");
+        scheme.set("type", "structured-biquasicubic");
         scheme.set("halo", 2);
     }
     scheme.set("name", scheme_str);
diff --git a/src/tests/interpolation/test_interpolation_structured2D_regional.cc b/src/tests/interpolation/test_interpolation_structured2D_regional.cc
@@ -100,7 +100,7 @@ CASE("test_interpolation_structured2D_regional_1d") {
     StructuredColumns sourceFs(sourceGrid, option::halo(1));
     StructuredColumns targetFs(targetGrid, option::halo(1));
 
-    Interpolation interpolation(Config("type", "regional-linear"), sourceFs, targetFs);
+    Interpolation interpolation(Config("type", "regional-bilinear"), sourceFs, targetFs);
 
     auto sourceField = sourceFs.createField<double>(Config("name", "source"));
     auto targetField = targetFs.createField<double>(Config("name", "target"));
@@ -157,7 +157,7 @@ CASE("test_interpolation_structured2D_regional_2d") {
     StructuredColumns sourceFs(sourceGrid, option::halo(1) | option::levels(nlevs));
     StructuredColumns targetFs(targetGrid, option::halo(1) | option::levels(nlevs));
 
-    Interpolation interpolation(Config("type", "regional-linear"), sourceFs, targetFs);
+    Interpolation interpolation(Config("type", "regional-bilinear"), sourceFs, targetFs);
 
     auto sourceField = sourceFs.createField<double>(Config("name", "source"));
     auto targetField = targetFs.createField<double>(Config("name", "target"));
diff --git a/src/tests/interpolation/test_interpolation_structured2D_to_points.cc b/src/tests/interpolation/test_interpolation_structured2D_to_points.cc
@@ -109,36 +109,36 @@ void do_test( std::string type, int input_halo, bool matrix_free, bool expect_fa
     interpolation.execute(fields_source, fields_target);
 }
 
-CASE("test structured-linear, halo 2, with matrix") {
-    EXPECT_NO_THROW( do_test("structured-linear",2,false,false) );
+CASE("test structured-bilinear, halo 2, with matrix") {
+    EXPECT_NO_THROW( do_test("structured-bilinear",2,false,false) );
 }
 
-CASE("test structured-linear, halo 2, without matrix") {
-    EXPECT_NO_THROW( do_test("structured-linear",2,true,false) );
+CASE("test structured-bilinear, halo 2, without matrix") {
+    EXPECT_NO_THROW( do_test("structured-bilinear",2,true,false) );
 }
 
-CASE("test structured-linear, halo 2, with matrix, expected failure") {
-    EXPECT_THROWS_AS( do_test("structured-linear",2,false,true), eckit::Exception );
+CASE("test structured-bilinear, halo 2, with matrix, expected failure") {
+    EXPECT_THROWS_AS( do_test("structured-bilinear",2,false,true), eckit::Exception );
 }
 
-CASE("test structured-linear, halo 2, without matrix, expected failure") {
-    EXPECT_THROWS_AS( do_test("structured-linear",2,false,true), eckit::Exception );
+CASE("test structured-bilinear, halo 2, without matrix, expected failure") {
+    EXPECT_THROWS_AS( do_test("structured-bilinear",2,false,true), eckit::Exception );
 }
 
-CASE("test structured-linear, halo 1, with matrix, expected failure") {
-    EXPECT_THROWS_AS( do_test("structured-linear",1,false,false), eckit::Exception );
+CASE("test structured-bilinear, halo 1, with matrix, expected failure") {
+    EXPECT_THROWS_AS( do_test("structured-bilinear",1,false,false), eckit::Exception );
 }
 
-CASE("test structured-linear, halo 1, without matrix, expected failure") {
-    EXPECT_THROWS_AS( do_test("structured-linear",1,true,false), eckit::Exception );
+CASE("test structured-bilinear, halo 1, without matrix, expected failure") {
+    EXPECT_THROWS_AS( do_test("structured-bilinear",1,true,false), eckit::Exception );
 }
 
-CASE("test structured-cubic, halo 3, with matrix") {
-    EXPECT_NO_THROW( do_test("structured-cubic",3,false,false) );
+CASE("test structured-bicubic, halo 3, with matrix") {
+    EXPECT_NO_THROW( do_test("structured-bicubic",3,false,false) );
 }
 
-CASE("test structured-cubic, halo 2, with matrix") {
-    EXPECT_THROWS_AS( do_test("structured-cubic",2,false,false), eckit::Exception );
+CASE("test structured-bicubic, halo 2, with matrix") {
+    EXPECT_THROWS_AS( do_test("structured-bicubic",2,false,false), eckit::Exception );
 }
 
 
diff --git a/src/tests/interpolation/test_interpolation_structured2D_to_unstructured.cc b/src/tests/interpolation/test_interpolation_structured2D_to_unstructured.cc
@@ -127,7 +127,7 @@ CASE("test_match") {
 
     FunctionSpace output_fs = output_functionspace_match();
 
-    Interpolation interpolation(option::type("structured-linear"), input_fs, output_fs);
+    Interpolation interpolation(option::type("structured-bilinear"), input_fs, output_fs);
 
     FieldSet fields_source = create_source_fields(input_fs, nb_fields, nb_levels);
     FieldSet fields_target = create_target_fields(output_fs, nb_fields, nb_levels);
@@ -149,7 +149,7 @@ CASE("test_nomatch") {
 
     if (false)  // expected to throw
     {
-        Interpolation interpolation(option::type("structured-linear"), input_fs, output_fs);
+        Interpolation interpolation(option::type("structured-bilinear"), input_fs, output_fs);
 
         FieldSet fields_source = create_source_fields(input_fs, nb_fields, nb_levels);
         FieldSet fields_target = create_target_fields(output_fs, nb_fields, nb_levels);
@@ -173,7 +173,7 @@ CASE("test_nomatch 2") {
 
     if (false)  // expected to throw
     {
-        Interpolation interpolation(option::type("structured-linear"), input_fs, output_fs);
+        Interpolation interpolation(option::type("structured-bilinear"), input_fs, output_fs);
 
         FieldSet fields_source = create_source_fields(input_fs, nb_fields, nb_levels);
         FieldSet fields_target = create_target_fields(output_fs, nb_fields, nb_levels);
diff --git a/src/tests/mesh/test_cubedsphere_meshgen.cc b/src/tests/mesh/test_cubedsphere_meshgen.cc
@@ -349,7 +349,7 @@ CASE("cubedsphere_dual_mesh_test") {
             targetFunctionSpace.createField<double>(util::Config("name", "targetField") | util::Config("levels", 5));
 
         // Perform interpolation.
-        auto scheme = util::Config("type", "structured-linear") | util::Config("halo", 1);
+        auto scheme = util::Config("type", "structured-bilinear") | util::Config("halo", 1);
         auto interp = Interpolation(scheme, sourceFunctionSpace, targetFunctionSpace);
         interp.execute(sourceField, targetField);
         targetField.haloExchange();

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@ namespace {`
`22`	`22`
`23`	`23`	`using util::FactoryDeprecated;`
`24`	`24`
`25`		`-MethodBuilder<RegionalLinear2D> __builder0("regional-linear");`
`26`		`-MethodBuilder<RegionalLinear2D> __builder1("regional-linear-2d", FactoryDeprecated("Please use regional-linear"));`
	`25`	`+MethodBuilder<RegionalLinear2D> __builder0("regional-bilinear");`
	`26`	`+MethodBuilder<RegionalLinear2D> __builder1("regional-linear-2d", FactoryDeprecated("Please use regional-bilinear"));`
`27`	`27`
`28`	`28`	`}`
`29`	`29`
Original file line number	Diff line number	Diff line change
`@@ -71,16 +71,16 @@ static Config processed_config(const eckit::Configuration& _config) {`
`71`	`71`	`}`
`72`	`72`	`std::string scheme_str = _config.getString("method", "linear");`
`73`	`73`	`if (scheme_str == "linear") {`
`74`		`- config.set("type", "structured-linear");`
	`74`	`+ config.set("type", "structured-bilinear");`
`75`	`75`	`config.set("halo", 1);`
`76`	`76`	`// The stencil does not require any halo, but we set it to 1 for pole treatment!`
`77`	`77`	`}`
`78`	`78`	`if (scheme_str == "cubic") {`
`79`		`- config.set("type", "structured-cubic");`
	`79`	`+ config.set("type", "structured-bicubic");`
`80`	`80`	`config.set("halo", 2);`
`81`	`81`	`}`
`82`	`82`	`if (scheme_str == "quasicubic") {`
`83`		`- config.set("type", "structured-quasicubic");`
	`83`	`+ config.set("type", "structured-biquasicubic");`
`84`	`84`	`config.set("halo", 2);`
`85`	`85`	`}`
`86`	`86`	`config.set("name", scheme_str);`
Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ CASE("test 3d cubic interpolation") {`
`330`	`330`
`331`	`331`	`SECTION("official version") {`
`332`	`332`	`auto matrix_free = Config("matrix_free", true);`
`333`		`- Interpolation interpolation(option::type("structured-3d-cubic") \| matrix_free, fs, departure_points);`
	`333`	`+ Interpolation interpolation(option::type("structured-tricubic") \| matrix_free, fs, departure_points);`
`334`	`334`
`335`	`335`	`Field output = Field("output", make_datatype<double>(), make_shape(departure_points.size()));`
`336`	`336`	`interpolation.execute(input, output);`
`@@ -367,7 +367,7 @@ CASE("test 3d cubic interpolation") {`
`367`	`367`	`}`
`368`	`368`	`}`
`369`	`369`	`}`
`370`		`- Interpolation interpolation(option::type("structured-3d-cubic") \| matrix_free, fs, dp_field);`
	`370`	`+ Interpolation interpolation(option::type("structured-tricubic") \| matrix_free, fs, dp_field);`
`371`	`371`
`372`	`372`	`Field output = fs.createField<double>();`
`373`	`373`	`interpolation.execute(input, output);`