Refactor of spacings and correction of spacings-connected bugs

src/Grids/nodes_and_spacings.jl

@@ -178,17 +178,6 @@ function φspacings end
 destantiate(::Face)   = Face
 destantiate(::Center) = Center
 
-spacings_function(::Val{:x}) = xspacings
-spacings_function(::Val{:y}) = yspacings
-spacings_function(::Val{:z}) = zspacings
-spacings_function(::Val{:λ}) = λspacings
-spacings_function(::Val{:φ}) = φspacings
-
-function minimum_spacing(s, grid, ℓx, ℓy, ℓz)
-    spacings = spacings_function(s)
-    return minimum(spacings(grid, ℓx, ℓy, ℓz))
-end
-
 """
     minimum_xspacing(grid, ℓx, ℓy, ℓz)
 

src/ImmersedBoundaries/immersed_boundary_nodes.jl

@@ -64,6 +64,28 @@ rname(ibg::IBG) = rname(ibg.underlying_grid)
 @inline fractional_y_index(x, locs, grid::ImmersedBoundaryGrid) = fractional_y_index(x, locs, grid.underlying_grid)
 @inline fractional_z_index(x, locs, grid::ImmersedBoundaryGrid) = fractional_z_index(x, locs, grid.underlying_grid)
 
-xspacings(ibg::ImmersedBoundaryGrid, ℓ...) = xspacings(ibg.underlying_grid, ℓ...)
-yspacings(ibg::ImmersedBoundaryGrid, ℓ...) = yspacings(ibg.underlying_grid, ℓ...)
-zspacings(ibg::ImmersedBoundaryGrid, ℓ...) = zspacings(ibg.underlying_grid, ℓ...)
+#####
+##### Grid-specific grid spacings
+#####
+
+const RGIBG{F, X, Y, Z} = ImmersedBoundaryGrid{F, X, Y, Z, <:RectilinearGrid}
+const LLIBG{F, X, Y, Z} = ImmersedBoundaryGrid{F, X, Y, Z, <:LatitudeLongitudeGrid}
+const OSIBG{F, X, Y, Z} = ImmersedBoundaryGrid{F, X, Y, Z, <:OrthogonalSphericalShellGrid}
+
+@inline xspacings(grid::RGIBG, ℓx) = xspacings(grid, ℓx, nothing, nothing)
+@inline yspacings(grid::RGIBG, ℓy) = yspacings(grid, nothing, ℓy, nothing)
+@inline zspacings(grid::RGIBG, ℓz) = zspacings(grid, nothing, nothing, ℓz)
+
+@inline xspacings(grid::LLIBG, ℓx, ℓy) = xspacings(grid, ℓx, ℓy, nothing)
+@inline yspacings(grid::LLIBG, ℓx, ℓy) = yspacings(grid, ℓx, ℓy, nothing)
+@inline zspacings(grid::LLIBG, ℓz)     = zspacings(grid, nothing, nothing, ℓz)
+
+@inline xspacings(grid::OSIBG, ℓx, ℓy) = xspacings(grid, ℓx, ℓy, nothing)
+@inline yspacings(grid::OSIBG, ℓx, ℓy) = yspacings(grid, ℓx, ℓy, nothing)
+@inline zspacings(grid::OSIBG, ℓz)     = zspacings(grid, nothing, nothing, ℓz)
+
+@inline λspacings(grid::LLIBG, ℓx) = λspacings(grid, ℓx, nothing, nothing)
+@inline φspacings(grid::LLIBG, ℓy) = φspacings(grid, nothing, ℓy, nothing)
+
+@inline λspacings(grid::OSIBG, ℓx, ℓy) = λspacings(grid, ℓx, ℓy, nothing)
+@inline φspacings(grid::OSIBG, ℓx, ℓy) = φspacings(grid, ℓx, ℓy, nothing)

src/ImmersedBoundaries/immersed_grid_metrics.jl

@@ -10,7 +10,7 @@ import Oceananigans.Operators: Δzᵃᵃᶠ, Δzᵃᵃᶜ, intrinsic_vector, ext
 # For non "full-cell" immersed boundaries, grid metric functions
 # must be extended for the specific immersed boundary grid in question.
 
-for LX in (:ᶜ, :ᶠ), LY in (:ᶜ, :ᶠ), LZ in (:ᶜ, :ᶠ)
+for LX in (:ᶜ, :ᶠ, :ᵃ), LY in (:ᶜ, :ᶠ, :ᵃ), LZ in (:ᶜ, :ᶠ, :ᵃ)
     for dir in (:x, :y, :z), operator in (:Δ, :A)
 
         metric = Symbol(operator, dir, LX, LY, LZ)

src/ImmersedBoundaries/partial_cell_bottom.jl

@@ -202,3 +202,10 @@ YFlatPCBIBG = ImmersedBoundaryGrid{<:Any, <:Any, <:Flat, <:Any, <:Any, <:Partial
 @inline Δzᶜᶠᶠ(i, j, k, ibg::YFlatPCBIBG) = Δzᶜᶜᶠ(i, j, k, ibg)
 @inline Δzᶠᶠᶜ(i, j, k, ibg::XFlatPCBIBG) = Δzᶜᶠᶜ(i, j, k, ibg)
 @inline Δzᶠᶠᶜ(i, j, k, ibg::YFlatPCBIBG) = Δzᶠᶜᶜ(i, j, k, ibg)
+
+# Make sure a PartialCellBottom grid cannot use :ᵃ for the z-spacings 
+# in the z-direction
+for LX in (:ᶜ, :ᶠ, :ᵃ), LY in (:ᶜ, :ᶠ, :ᵃ)
+    metric = Symbol(operator, dir, LX, LY, :ᵃ)
+    @eval @inline $metric(i, j, k, ibg::PCBIBG) = throw(ArgumentError("PartialCellBottom grids cannot use `:ᵃ` for spacings in the z-direction"))
+end

src/MultiRegion/multi_region_grid.jl

@@ -3,7 +3,7 @@ using Oceananigans.ImmersedBoundaries: GridFittedBottom, PartialCellBottom, Grid
 
 import Oceananigans.Grids: architecture, size, new_data, halo_size
 import Oceananigans.Grids: with_halo, on_architecture
-import Oceananigans.Grids: minimum_spacing, destantiate
+import Oceananigans.Grids: destantiate
 import Oceananigans.Grids: minimum_xspacing, minimum_yspacing, minimum_zspacing
 import Oceananigans.Models.HydrostaticFreeSurfaceModels: default_free_surface
 import Oceananigans.DistributedComputations: reconstruct_global_grid
@@ -39,9 +39,6 @@ const MultiRegionGrids = Union{MultiRegionGrid, ImmersedMultiRegionGrid}
 @inline Base.lastindex(mrg::MultiRegionGrids) = length(mrg)
 number_of_regions(mrg::MultiRegionGrids) = lastindex(mrg)
 
-minimum_spacing(dir, grid::MultiRegionGrid, ℓx, ℓy, ℓz) =
-    minimum(minimum_spacing(dir, grid[r], ℓx, ℓy, ℓz) for r in 1:number_of_regions(grid))
-
 minimum_xspacing(grid::MultiRegionGrid, ℓx, ℓy, ℓz) =
     minimum(minimum_xspacing(grid[r], ℓx, ℓy, ℓz) for r in 1:number_of_regions(grid))
 

test/test_grids.jl

@@ -660,6 +660,11 @@ function test_lat_lon_xyzλφ_node_nodes(FT, arch)
     @test minimum_yspacing(grid) / grid.radius ≈ FT(π/6)
     @test minimum_zspacing(grid) ≈ 5
 
+    grid = ImmersedBoundaryGrid(grid, GridFittedBottom((x, y) -> y < 20 && y > -20))
+
+    @test minimum_xspacing(grid, Face(), Face(), Face()) / grid.radius ≈ π/6 * cosd(15)
+    @test minimum_xspacing(grid) / grid.radius ≈ π/6 * cosd(15)
+
     return nothing
 end