Mercurial > repos > public > sbplib_julia

annotate grid.jl @ 23:9031fe054f2c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Return the unsigned distances from grid.spacings(). Add comments
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Tue, 08 Jan 2019 11:17:20 +0100
parents f2dc3e09fffc
children 32a53cbee6c5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
1 module grid
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
2
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
3 abstract type Grid end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
4
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
5 function numberOfDimensions(grid::Grid)
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
6 error("Not implemented for abstact type Grid")
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
7 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
8
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
9 function numberOfPoints(grid::Grid)
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
10 error("Not implemented for abstact type Grid")
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
11 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
12
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
13 function points(grid::Grid)
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
14 error("Not implemented for abstact type Grid")
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
15 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
16
22
f2dc3e09fffc Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 21
diff changeset
17 # TODO: Should this be here?
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
18 abstract type BoundaryId end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
19
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
20 # EquidistantGrid is a grid with equidisant grid spacing per coordinat
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
21 # direction. The domain is defined through the two points P1 = x̄₁, P2 = x̄₂
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
22 # by the exterior product of the vectors obtained by projecting (x̄₂-x̄₁) onto
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
23 # the coordinate directions. E.g for a 2D grid with x̄₁=(-1,0) and x̄₂=(1,2)
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
24 # the domain is defined as (-1,1)x(0,2).
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
25 struct EquidistantGrid <: Grid
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
26 numberOfPointsPerDim::Tuple # First coordinate direction stored first, then
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
27 # second, then third.
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
28 limits::NTuple{2,Tuple} # Stores the two points which defines the range of
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
29 # the e.g (-1,0) and (1,2) for a domain of size
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
30 # (-1,1)x(0,2)
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
31
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
32 # General constructor
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
33 function EquidistantGrid(nPointsPerDim::Tuple, lims::NTuple{2,Tuple})
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
34 @assert length(nPointsPerDim) > 0
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
35 @assert count(x -> x > 0, nPointsPerDim) == length(nPointsPerDim)
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
36 @assert length(lims[1]) == length(nPointsPerDim)
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
37 @assert length(lims[2]) == length(nPointsPerDim)
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
38 # TODO: Assert that the same values are not passed in both lims[1] and lims[2]
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
39 # i.e the domain length is positive for all dimensions
19
af8469bc1cb3 Implement function returning points of grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 16
diff changeset
40 return new(nPointsPerDim, lims)
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
41 end
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
42 # 1D constructor which can be called as EquidistantGrid(m, (xl,xr))
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
43 function EquidistantGrid(nPointsPerDim::Integer, lims::NTuple{2,Integer})
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
44 return EquidistantGrid((nPointsPerDim,), ((lims[1],),(lims[2],)))
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
45 end
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
46
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
47 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
48
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
49 # Returns the number of dimensions of an EquidistantGrid.
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
50 #
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
51 # @Input: grid - an EquidistantGrid
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
52 # @Return: numberOfPoints - The number of dimensions
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
53 function numberOfDimensions(grid::EquidistantGrid)
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
54 return length(grid.numberOfPointsPerDim)
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
55 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
56
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
57 # Computes the total number of points of an EquidistantGrid.
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
58 #
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
59 # @Input: grid - an EquidistantGrid
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
60 # @Return: numberOfPoints - The total number of points
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
61 function numberOfPoints(grid::EquidistantGrid)
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
62 numberOfPoints = grid.numberOfPointsPerDim[1];
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
63 for i = 2:length(grid.numberOfPointsPerDim);
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
64 numberOfPoints = numberOfPoints*grid.numberOfPointsPerDim[i]
19
af8469bc1cb3 Implement function returning points of grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 16
diff changeset
65 end
af8469bc1cb3 Implement function returning points of grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 16
diff changeset
66 return numberOfPoints
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
67 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
68
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
69 # Computes the grid spacing of an EquidistantGrid, i.e the unsigned distance
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
70 # between two points for each coordinate direction.
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
71 #
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
72 # @Input: grid - an EquidistantGrid
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
73 # @Return: h̄ - Grid spacing for each coordinate direction stored in a tuple.
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
74 function spacings(grid::EquidistantGrid)
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
75 h̄ = Vector{Real}(undef, numberOfDimensions(grid))
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
76 for i ∈ eachindex(h̄)
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
77 h̄[i] = abs(grid.limits[2][i]-grid.limits[1][i])/(grid.numberOfPointsPerDim[i]-1)
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
78 end
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
79 return Tuple(h̄)
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
80 end
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
81
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
82 # Computes the points of an EquidistantGrid as a vector of tuples. The vector is ordered
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
83 # such that points in the first coordinate direction varies first, then the second
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
84 # and lastely the third (if applicable)
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
85 #
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
86 # @Input: grid - an EquidistantGrid
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
87 # @Return: points - the points of the grid.
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
88 function points(grid::EquidistantGrid)
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
89 # Compute signed grid spacings
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
90 dx̄ = Vector{Real}(undef, numberOfDimensions(grid))
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
91 for i ∈ eachindex(dx̄)
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
92 dx̄[i] = (grid.limits[2][i]-grid.limits[1][i])/(grid.numberOfPointsPerDim[i]-1)
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
93 end
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
94 dx̄ = Tuple(dx̄)
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
95
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
96 nPoints = numberOfPoints(grid)
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
97 points = Vector{NTuple{numberOfDimensions(grid),Real}}(undef, nPoints)
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
98 # Compute the points based on their Cartesian indices and the signed
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
99 # grid spacings
21
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
100 cartesianIndices = CartesianIndices(grid.numberOfPointsPerDim)
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
101 for i ∈ 1:nPoints
2dbdd00eaea0 Implement function returing the points of a EquidistantGrid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 19
diff changeset
102 ci = Tuple(cartesianIndices[i]) .-1
23
9031fe054f2c Return the unsigned distances from grid.spacings(). Add comments
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 22
diff changeset
103 points[i] = grid.limits[1] .+ dx̄.*ci
19
af8469bc1cb3 Implement function returning points of grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 16
diff changeset
104 end
16
c61af27cb67a Fix compile errors
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 15
diff changeset
105 return points
14
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
106 end
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
107
b11b67c02d1a Started implementing grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 0
diff changeset
108 end