Generalize dispatch to OrthoRegularGrid (#1079)

* Update definition of grid methods

* Apply suggestions

* Apply suggestions

* Apply suggestions from code review

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Update src/domains/meshes/cartesiangrid.jl

* Apply suggestions

* Format

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

* Apply suggestions

* Format

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Júlio Hoffimann <[email protected]>

Author: 3 people

src/boundingboxes.jl

@@ -69,7 +69,7 @@ end
 
 boundingbox(t::Torus) = _pboxes(pointify(t))
 
-boundingbox(g::CartesianGrid) = Box(extrema(g)...)
+boundingbox(g::OrthoRegularGrid) = Box(extrema(g)...)
 
 boundingbox(g::RectilinearGrid) = Box(extrema(g)...)
 

src/centroid.jl

@@ -65,7 +65,7 @@ centroid(d::Domain, ind::Int) = centroid(d[ind])
 
 centroid(d::SubDomain, ind::Int) = centroid(parent(d), parentindices(d)[ind])
 
-function centroid(g::RegularGrid{<:𝔼,<:CartesianOrProjected}, ind::Int)
+function centroid(g::OrthoRegularGrid, ind::Int)
   ijk = elem2cart(topology(g), ind)
   vertex(g, ijk) + Vec(spacing(g) ./ 2)
 end

src/coarsening/regular.jl

@@ -20,9 +20,9 @@ end
 
 RegularCoarsening(factors::Vararg{Int,N}) where {N} = RegularCoarsening(factors)
 
-function coarsen(grid::CartesianGrid, method::RegularCoarsening)
+function coarsen(grid::OrthoRegularGrid, method::RegularCoarsening)
   factors = fitdims(method.factors, paramdim(grid))
-  CartesianGrid(minimum(grid), maximum(grid), dims=size(grid) .÷ factors)
+  RegularGrid(minimum(grid), maximum(grid), dims=size(grid) .÷ factors)
 end
 
 function coarsen(grid::RectilinearGrid, method::RegularCoarsening)

src/domains/meshes.jl

@@ -246,3 +246,6 @@ include("meshes/rectilineargrid.jl")
 include("meshes/structuredgrid.jl")
 include("meshes/simplemesh.jl")
 include("meshes/transformedmesh.jl")
+
+# alias for dispatch purposes
+const OrthoRegularGrid{M<:𝔼,C<:Union{Cartesian,Projected}} = RegularGrid{M,C}

src/indices.jl

@@ -13,7 +13,7 @@ Return the indices of the elements of the `domain` that intersect with the `geom
 """
 indices(domain::Domain, geometry::Geometry) = findall(intersects(geometry), domain)
 
-function indices(grid::CartesianGrid, point::Point)
+function indices(grid::OrthoRegularGrid, point::Point)
   point ∉ grid && return Int[]
 
   # grid properties
@@ -31,7 +31,7 @@ function indices(grid::CartesianGrid, point::Point)
   [LinearIndices(dims)[coords...]]
 end
 
-function indices(grid::CartesianGrid, chain::Chain)
+function indices(grid::OrthoRegularGrid, chain::Chain)
   dims = size(grid)
   mask = falses(dims)
 
@@ -43,7 +43,7 @@ function indices(grid::CartesianGrid, chain::Chain)
   LinearIndices(dims)[mask]
 end
 
-function indices(grid::CartesianGrid, poly::Polygon)
+function indices(grid::OrthoRegularGrid, poly::Polygon)
   dims = size(grid)
   mask = zeros(Int, dims)
   cpoly = poly ∩ boundingbox(grid)
@@ -56,15 +56,15 @@ function indices(grid::CartesianGrid, poly::Polygon)
   LinearIndices(dims)[mask .> 0]
 end
 
-function indices(grid::CartesianGrid, box::Box)
+function indices(grid::OrthoRegularGrid, box::Box)
   # cartesian range
   range = cartesianrange(grid, box)
 
   # convert to linear indices
   LinearIndices(size(grid))[range] |> vec
 end
 
-indices(grid::CartesianGrid, multi::Multi) = mapreduce(geom -> indices(grid, geom), vcat, parent(multi)) |> unique
+indices(grid::OrthoRegularGrid, multi::Multi) = mapreduce(geom -> indices(grid, geom), vcat, parent(multi)) |> unique
 
 function indices(grid::RectilinearGrid, box::Box)
   # cartesian range
@@ -89,7 +89,7 @@ _manifoldrange(::Type{<:𝔼}, grid::Grid, box::Box) = _euclideanrange(grid, box
 
 _manifoldrange(::Type{<:🌐}, grid::Grid, box::Box) = _geodesicrange(grid, box)
 
-function _euclideanrange(grid::CartesianGrid, box::Box)
+function _euclideanrange(grid::OrthoRegularGrid, box::Box)
   # grid properties
   or = minimum(grid)
   sp = spacing(grid)

src/refinement/regular.jl

@@ -20,9 +20,9 @@ end
 
 RegularRefinement(factors::Vararg{Int,N}) where {N} = RegularRefinement(factors)
 
-function refine(grid::CartesianGrid, method::RegularRefinement)
+function refine(grid::OrthoRegularGrid, method::RegularRefinement)
   factors = fitdims(method.factors, paramdim(grid))
-  CartesianGrid(minimum(grid), maximum(grid), dims=size(grid) .* factors)
+  RegularGrid(minimum(grid), maximum(grid), dims=size(grid) .* factors)
 end
 
 function refine(grid::RectilinearGrid, method::RegularRefinement)

src/sampling/regular.jl

@@ -87,6 +87,6 @@ extrapoints(c::FrustumSurface, sz) = (bottom(c)(0, 0), top(c)(0, 0))
 # SPECIAL CASES
 # --------------
 
-function sample(rng::AbstractRNG, grid::CartesianGrid, method::RegularSampling)
+function sample(rng::AbstractRNG, grid::OrthoRegularGrid, method::RegularSampling)
   sample(rng, boundingbox(grid), method)
 end