changeset 406:c377fc37c04b test/equidistantgrid

Clean up EquidistantGrid and tests after deciding that side lengths must be positive.
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Tue, 13 Oct 2020 17:16:28 +0200
parents 16dc5b19843d
children b7734413003d
files src/Grids/EquidistantGrid.jl test/testGrids.jl
diffstat 2 files changed, 39 insertions(+), 30 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/EquidistantGrid.jl	Sat Oct 10 20:05:39 2020 +0200
+++ b/src/Grids/EquidistantGrid.jl	Tue Oct 13 17:16:28 2020 +0200
@@ -1,11 +1,12 @@
-# EquidistantGrid is a grid with equidistant grid spacing per coordinat
-# direction. The domain is defined through the two points P1 = x̄₁, P2 = x̄₂
-# by the exterior product of the vectors obtained by projecting (x̄₂-x̄₁) onto
-# the coordinate directions. E.g for a 2D grid with x̄₁=(-1,0) and x̄₂=(1,2)
-# the domain is defined as (-1,1)x(0,2).
+"""
+    EquidistantGrid(size::NTuple{Dim, Int}, limit_lower::NTuple{Dim, T}, limit_upper::NTuple{Dim, T}
 
-export EquidistantGrid
-
+EquidistantGrid is a grid with equidistant grid spacing per coordinat direction.
+The domain is defined through the two points P1 = x̄₁, P2 = x̄₂ by the exterior
+product of the vectors obtained by projecting (x̄₂-x̄₁) onto the coordinate
+directions. E.g for a 2D grid with x̄₁=(-1,0) and x̄₂=(1,2) the domain is defined
+as (-1,1)x(0,2). The side lengths of the grid are not allowed to be negative
+"""
 struct EquidistantGrid{Dim,T<:Real} <: AbstractGrid
     size::NTuple{Dim, Int}
     limit_lower::NTuple{Dim, T}
@@ -13,13 +14,23 @@
 
     # General constructor
     function EquidistantGrid(size::NTuple{Dim, Int}, limit_lower::NTuple{Dim, T}, limit_upper::NTuple{Dim, T}) where Dim where T
-        all(size.>0) || throw(DomainError("size must be postive"))
-        # TODO: Is it reasonable to restrict side lengths to be positive?
-        all(limit_upper.-limit_lower .> 0) || throw(DomainError("side lengths must be postive"))
+        if any(size .<= 0)
+            throw(DomainError("all components of size must be postive"))
+        end
+        if any(limit_upper.-limit_lower .<= 0)
+            throw(DomainError("all side lengths must be postive"))
+        end
         return new{Dim,T}(size, limit_lower, limit_upper)
     end
 end
+export EquidistantGrid
 
+
+"""
+    EquidistantGrid(size::Int, limit_lower::T, limit_upper::T)
+
+Convenience constructor for 1D grids.
+"""
 function EquidistantGrid(size::Int, limit_lower::T, limit_upper::T) where T
 	return EquidistantGrid((size,),(limit_lower,),(limit_upper,))
 end
@@ -30,10 +41,11 @@
 
 Base.size(g::EquidistantGrid) = g.size
 
-# Returns the number of dimensions of an EquidistantGrid.
-#
-# @Input: grid - an EquidistantGrid
-# @Return: dimension - The dimension of the grid
+"""
+    dimension(grid::EquidistantGrid)
+
+The dimension of the grid.
+"""
 function dimension(grid::EquidistantGrid)
     return length(grid.size)
 end
@@ -44,26 +56,27 @@
 
 The spacing between the grid points of the grid.
 """
-# TODO: If we restrict side lenghts to be positive, then we should remove the abs here.
-spacing(grid::EquidistantGrid) = abs.(grid.limit_upper.-grid.limit_lower)./(grid.size.-1)
+spacing(grid::EquidistantGrid) = (grid.limit_upper.-grid.limit_lower)./(grid.size.-1)
 export spacing
 
 """
-    spacing(grid::EquidistantGrid)
+    inverse_spacing(grid::EquidistantGrid)
 
 The reciprocal of the spacing between the grid points of the grid.
 """
 inverse_spacing(grid::EquidistantGrid) = 1 ./ spacing(grid)
 export inverse_spacing
 
-# Computes the points of an EquidistantGrid as an array of tuples with
-# the same dimension as the grid.
-#
-# @Input: grid - an EquidistantGrid
-# @Return: points - the points of the grid.
-# TODO: Does not work if side lengths are allowed to be negative.
+"""
+    points(grid::EquidistantGrid)
+
+The point of the grid as an array of tuples with the same dimension as the grid.
+The points are stored as [(x1,y1), (x1,y2), … (x1,yn);
+						  (x2,y1), (x2,y2), … (x2,yn);
+						  	⋮		 ⋮            ⋮
+						  (xm,y1), (xm,y2), … (xm,yn)]
+"""
 function points(grid::EquidistantGrid)
-    # TODO: Make this return an abstract array?
     indices = Tuple.(CartesianIndices(grid.size))
     h = spacing(grid)
     return broadcast(I -> grid.limit_lower .+ (I.-1).*h, indices)
--- a/test/testGrids.jl	Sat Oct 10 20:05:39 2020 +0200
+++ b/test/testGrids.jl	Tue Oct 13 17:16:28 2020 +0200
@@ -9,7 +9,7 @@
     # constuctor
     @test_throws DomainError EquidistantGrid(0,0.0,1.0)
     @test_throws DomainError EquidistantGrid(1,1.0,1.0)
-    @test_throws DomainError EquidistantGrid(1,1.0,-1.0) # TODO: Remove if we allow side lengths to be negative.
+    @test_throws DomainError EquidistantGrid(1,1.0,-1.0)
     @test EquidistantGrid(4,0.0,1.0) == EquidistantGrid((4,),(0.0,),(1.0,))
 
     # size
@@ -23,14 +23,10 @@
     # spacing
     @test [spacing(EquidistantGrid(4,0.0,1.0))...] ≈ [(1. /3,)...] atol=5e-13
     @test [spacing(EquidistantGrid((5,3), (0.0,-1.0), (2.0,1.0)))...] ≈ [(0.5, 1.)...] atol=5e-13
-    # TODO: Include below if we allow side lengths to be negative.
-    #@test [spacing(EquidistantGrid((5,3), (0.0,1.0), (-1.0,-2.0)))...] ≈ [(0.25, 1.5)...] atol=5e-13
 
     # inverse_spacing
     @test [inverse_spacing(EquidistantGrid(4,0.0,1.0))...] ≈ [(3.,)...] atol=5e-13
     @test [inverse_spacing(EquidistantGrid((5,3), (0.0,-1.0), (2.0,1.0)))...] ≈ [(2, 1.)...] atol=5e-13
-    # TODO: Include below if we allow side lengths to be negative.
-    #@test [inverse_spacing(EquidistantGrid((5,3), (0.0,1.0), (-1.0,-2.0)))...] ≈ [(4., 2. /3)...] atol=5e-13
 
     # points
     g = EquidistantGrid((5,3), (-1.0,0.0), (0.0,7.11))
@@ -42,7 +38,7 @@
          (0.,0.)       (0.,7.11/2)    (0.,7.11)]
     approxequal = true;
     for i ∈ eachindex(gp)
-        approxequal=approxequal*all(isapprox.(gp[i],p[i], atol=5e-13));
+        approxequal=approxequal&&all(isapprox.(gp[i],p[i], atol=5e-13));
     end
     @test approxequal == true