sbplib_julia: src/Grids/EquidistantGrid.jl comparison

comparison src/Grids/EquidistantGrid.jl @ 911:a378ab959b6f

Merge feature/equidistant_grid/refine

author	Jonatan Werpers <jonatan@werpers.com>
date	Tue, 15 Feb 2022 15:14:28 +0100
parents	b900fea1c057
children	9b40aeac4269 5b3d4a8ec3ab

comparison

equal deleted inserted replaced

-:9a2776352c2a
+:a378ab959b6f
+export EquidistantGrid
+export spacing
+export inverse_spacing
+export restrict
+export boundary_identifiers
+export boundary_grid
+export refine
+export coarsen
 """
-EquidistantGrid(size::NTuple{Dim, Int}, limit_lower::NTuple{Dim, T}, limit_upper::NTuple{Dim, T})
+EquidistantGrid{Dim,T<:Real} <: AbstractGrid
-	EquidistantGrid{T}()
-`EquidistantGrid` is a grid with equidistant grid spacing per coordinat direction.
+`Dim`-dimensional equidistant grid with coordinates of type `T`.
-`EquidistantGrid(size, limit_lower, limit_upper)` construct the grid with the
-domain defined by the two points P1, and P2 given by `limit_lower` and
-`limit_upper`. The length of the domain sides are given by the components of
-(P2-P1). E.g for a 2D grid with P1=(-1,0) and P2=(1,2) the domain is defined
-as (-1,1)x(0,2). The side lengths of the grid are not allowed to be negative.
-The number of equidistantly spaced points in each coordinate direction are given
-by `size`.
-`EquidistantGrid{T}()` constructs a 0-dimensional grid.
 """
 struct EquidistantGrid{Dim,T<:Real} <: AbstractGrid
 size::NTuple{Dim, Int}
 limit_lower::NTuple{Dim, T}
 limit_upper::NTuple{Dim, T}
-# General constructor
+function EquidistantGrid{Dim,T}(size::NTuple{Dim, Int}, limit_lower::NTuple{Dim, T}, limit_upper::NTuple{Dim, T}) where {Dim,T}
-function EquidistantGrid(size::NTuple{Dim, Int}, limit_lower::NTuple{Dim, T}, limit_upper::NTuple{Dim, T}) where Dim where T
 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
-	# Specialized constructor for 0-dimensional grid
+"""
-	EquidistantGrid{T}() where T = new{0,T}((),(),())
+EquidistantGrid(size, limit_lower, limit_upper)
+Construct an equidistant grid with corners at the coordinates `limit_lower` and
+`limit_upper`.
+The length of the domain sides are given by the components of
+`limit_upper-limit_lower`. E.g for a 2D grid with `limit_lower=(-1,0)` and `limit_upper=(1,2)` the domain is defined
+as `(-1,1)x(0,2)`. The side lengths of the grid are not allowed to be negative.
+The number of equidistantly spaced points in each coordinate direction are given
+by the tuple `size`.
+"""
+function EquidistantGrid(size, limit_lower, limit_upper)
+return EquidistantGrid{length(size), eltype(limit_lower)}(size, limit_lower, limit_upper)
 end
-export EquidistantGrid
+"""
+EquidistantGrid{T}()
+Constructs a 0-dimensional grid.
+"""
+EquidistantGrid{T}() where T = EquidistantGrid{0,T}((),(),()) # Convenience constructor for 0-dim grid
 """
 EquidistantGrid(size::Int, limit_lower::T, limit_upper::T)
 Convenience constructor for 1D grids.
 dimension(grid::EquidistantGrid{Dim}) where Dim = Dim
 """
 spacing(grid::EquidistantGrid)
-The spacing between the grid points of the grid.
+The spacing between grid points.
 """
 spacing(grid::EquidistantGrid) = (grid.limit_upper.-grid.limit_lower)./(grid.size.-1)
-export spacing
 """
 inverse_spacing(grid::EquidistantGrid)
-The reciprocal of the spacing between the grid points of the grid.
+The reciprocal of the spacing between grid points.
 """
 inverse_spacing(grid::EquidistantGrid) = 1 ./ spacing(grid)
-export inverse_spacing
 """
 points(grid::EquidistantGrid)
 The point of the grid as an array of tuples with the same dimension as the grid.
 end
 """
 restrict(::EquidistantGrid, dim)
-Pick out given dimensions from the grid and return a grid for them
+Pick out given dimensions from the grid and return a grid for them.
 """
 function restrict(grid::EquidistantGrid, dim)
 size = grid.size[dim]
 limit_lower = grid.limit_lower[dim]
 limit_upper = grid.limit_upper[dim]
 return EquidistantGrid(size, limit_lower, limit_upper)
 end
-export restrict
 """
 boundary_identifiers(::EquidistantGrid)
 Returns a tuple containing the boundary identifiers for the grid, stored as
 	 CartesianBoundary(1,Upper),
 	 CartesianBoundary(2,Lower),
 	 ...)
 """
 boundary_identifiers(g::EquidistantGrid) = (((ntuple(i->(CartesianBoundary{i,Lower}(),CartesianBoundary{i,Upper}()),dimension(g)))...)...,)
-export boundary_identifiers
 """
 boundary_grid(grid::EquidistantGrid,id::CartesianBoundary)
 	boundary_grid(::EquidistantGrid{1},::CartesianBoundary{1})
 	if orth_dims == dims
 		throw(DomainError("boundary identifier not matching grid"))
 	end
 return restrict(grid,orth_dims)
 end
-export boundary_grid
 boundary_grid(::EquidistantGrid{1,T},::CartesianBoundary{1}) where T = EquidistantGrid{T}()
+"""
+refine(grid::EquidistantGrid, r::Int)
+Refines `grid` by a factor `r`. The factor is applied to the number of
+intervals which is 1 less than the size of the grid.
+See also: [`coarsen`](@ref)
+"""
+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)
+end
+"""
+coarsen(grid::EquidistantGrid, r::Int)
+Coarsens `grid` by a factor `r`. The factor is applied to the number of
+intervals which is 1 less than the size of the grid. If the number of
+intervals are not divisible by `r` an error is raised.
+See also: [`refine`](@ref)
+"""
+function coarsen(grid::EquidistantGrid, r::Int)
+sz = size(grid)
+if !all(n -> (n % r == 0), sz.-1)
+throw(DomainError(r, "Size minus 1 must be divisible by the ratio."))
+end
+new_sz = (sz .- 1).÷r .+ 1
+return EquidistantGrid{dimension(grid), eltype(grid)}(new_sz, grid.limit_lower, grid.limit_upper)
+end

Mercurial > repos > public > sbplib_julia

comparison src/Grids/EquidistantGrid.jl @ 911:a378ab959b6f