changeset 1115:6530fceef37c feature/grids

Rename dimension to dim
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 15 Jul 2022 09:41:58 +0200
parents fc57804c9bf4
children c2d7e940639e
files src/Grids/AbstractGrid.jl src/Grids/EquidistantGrid.jl src/SbpOperators/volumeops/laplace/laplace.jl test/Grids/EquidistantGrid_test.jl
diffstat 4 files changed, 13 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/AbstractGrid.jl	Fri Jul 15 09:38:08 2022 +0200
+++ b/src/Grids/AbstractGrid.jl	Fri Jul 15 09:41:58 2022 +0200
@@ -2,15 +2,15 @@
      AbstractGrid
 
 Should implement
-    dimension(grid::AbstractGrid)
+    dim(grid::AbstractGrid)
     points(grid::AbstractGrid)
 
 """
 abstract type AbstractGrid end
 export AbstractGrid
-function dimension end
+function dim end # TODO: Rename to Base.ndims instead? That's the name used for arrays.
 function points end
-export dimension, points
+export dim, points
 
 """
     evalOn(g::AbstractGrid, f::Function)
@@ -29,5 +29,5 @@
 
 A range containing the dimensions of the grid
 """
-dims(grid::AbstractGrid) = 1:dimension(grid)
+dims(grid::AbstractGrid) = 1:dim(grid)
 export dims
\ No newline at end of file
--- a/src/Grids/EquidistantGrid.jl	Fri Jul 15 09:38:08 2022 +0200
+++ b/src/Grids/EquidistantGrid.jl	Fri Jul 15 09:41:58 2022 +0200
@@ -70,11 +70,11 @@
 Base.size(g::EquidistantGrid) = g.size
 
 """
-    dimension(grid::EquidistantGrid)
+    dim(grid::EquidistantGrid)
 
 The dimension of the grid.
 """
-dimension(grid::EquidistantGrid{Dim}) where Dim = Dim
+dim(::EquidistantGrid{Dim}) where Dim = Dim
 
 """
     spacing(grid::EquidistantGrid)
@@ -141,7 +141,7 @@
 	 CartesianBoundary(2,Lower),
 	 ...)
 """
-boundary_identifiers(g::EquidistantGrid) = (((ntuple(i->(CartesianBoundary{i,Lower}(),CartesianBoundary{i,Upper}()),dimension(g)))...)...,)
+boundary_identifiers(g::EquidistantGrid) = (((ntuple(i->(CartesianBoundary{i,Lower}(),CartesianBoundary{i,Upper}()),dim(g)))...)...,)
 
 
 """
@@ -180,7 +180,7 @@
 function refine(grid::EquidistantGrid, r::Int)
     sz = size(grid)
     new_sz = (sz .- 1).*r .+ 1
-    return EquidistantGrid{dimension(grid), eltype(grid)}(new_sz, grid.limit_lower, grid.limit_upper)
+    return EquidistantGrid{dim(grid), eltype(grid)}(new_sz, grid.limit_lower, grid.limit_upper)
 end
 
 """
@@ -201,5 +201,5 @@
 
     new_sz = (sz .- 1).÷r .+ 1
 
-    return EquidistantGrid{dimension(grid), eltype(grid)}(new_sz, grid.limit_lower, grid.limit_upper)
+    return EquidistantGrid{dim(grid), eltype(grid)}(new_sz, grid.limit_lower, grid.limit_upper)
 end
--- a/src/SbpOperators/volumeops/laplace/laplace.jl	Fri Jul 15 09:38:08 2022 +0200
+++ b/src/SbpOperators/volumeops/laplace/laplace.jl	Fri Jul 15 09:41:58 2022 +0200
@@ -48,7 +48,7 @@
 """
 function laplace(grid::EquidistantGrid, inner_stencil, closure_stencils)
     Δ = second_derivative(grid, inner_stencil, closure_stencils, 1)
-    for d = 2:dimension(grid)
+    for d = 2:dim(grid)
         Δ += second_derivative(grid, inner_stencil, closure_stencils, d)
     end
     return Δ
--- a/test/Grids/EquidistantGrid_test.jl	Fri Jul 15 09:38:08 2022 +0200
+++ b/test/Grids/EquidistantGrid_test.jl	Fri Jul 15 09:41:58 2022 +0200
@@ -19,9 +19,9 @@
         @test size(EquidistantGrid((5,3), (0.0,0.0), (2.0,1.0))) == (5,3)
     end
 
-    # dimension
-    @test dimension(EquidistantGrid(4,0.0,1.0)) == 1
-    @test dimension(EquidistantGrid((5,3), (0.0,0.0), (2.0,1.0))) == 2
+    # dim
+    @test dim(EquidistantGrid(4,0.0,1.0)) == 1
+    @test dim(EquidistantGrid((5,3), (0.0,0.0), (2.0,1.0))) == 2
 
     # spacing
     @test [spacing(EquidistantGrid(4,0.0,1.0))...] ≈ [(1. /3,)...] atol=5e-13