Mercurial > repos > public > sbplib_julia
annotate src/Grids/equidistant_grid.jl @ 1279:1157f889bf50 refactor/grids
Clear out some TBDs
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Sun, 26 Feb 2023 21:20:52 +0100 |
| parents | 75a65db29be1 |
| children | 17d435c08773 |
| rev | line source |
|---|---|
|
1247
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
1 """ |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
2 # TODO: |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
3 """ |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
4 #TODO: Document recomendations for type of range. (LinRange is faster?) |
|
1257
198ccda331a6
Remove range dim as a type paratmeter on Grid as it is already encoded in T if available
Jonatan Werpers <jonatan@werpers.com>
parents:
1255
diff
changeset
|
5 struct EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1} |
| 1222 | 6 points::R |
| 7 end | |
|
75
93c833019857
Make EquidistantGrid more concrete
Jonatan Werpers <jonatan@werpers.com>
parents:
74
diff
changeset
|
8 |
| 1222 | 9 Base.eachindex(g::EquidistantGrid) = eachindex(g.points) |
| 10 | |
|
1255
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
11 # Indexing interface |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
12 Base.getindex(g::EquidistantGrid, i) = g.points[i] |
|
1253
ff8f335c32d1
Fix indexing with begin and end for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1250
diff
changeset
|
13 Base.firstindex(g::EquidistantGrid) = firstindex(g.points) |
|
ff8f335c32d1
Fix indexing with begin and end for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1250
diff
changeset
|
14 Base.lastindex(g::EquidistantGrid) = lastindex(g.points) |
|
ff8f335c32d1
Fix indexing with begin and end for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1250
diff
changeset
|
15 |
|
1255
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
16 # Iteration interface |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
17 Base.iterate(g::EquidistantGrid) = iterate(g.points) |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
18 Base.iterate(g::EquidistantGrid, state) = iterate(g.points, state) |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
19 |
|
1262
5e28ae42caf2
Clean up IteratorSize and eltype for EquidistantGrid, Grid, and ZeroDimGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1259
diff
changeset
|
20 Base.IteratorSize(::Type{<:EquidistantGrid}) = Base.HasShape{1}() |
|
1255
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
21 Base.length(g::EquidistantGrid) = length(g.points) |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
22 Base.size(g::EquidistantGrid) = size(g.points) |
| 1222 | 23 |
| 24 | |
|
406
c377fc37c04b
Clean up EquidistantGrid and tests after deciding that side lengths must be positive.
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
405
diff
changeset
|
25 """ |
| 1222 | 26 spacing(grid::EquidistantGrid) |
| 27 | |
| 28 The spacing between grid points. | |
| 29 """ | |
| 30 spacing(g::EquidistantGrid) = step(g.points) | |
| 31 | |
|
51
614b56a017b9
Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
32 |
| 1222 | 33 """ |
| 34 inverse_spacing(grid::EquidistantGrid) | |
| 35 | |
| 36 The reciprocal of the spacing between grid points. | |
| 37 """ | |
| 38 inverse_spacing(g::EquidistantGrid) = 1/step(g.points) | |
| 39 | |
| 40 | |
| 41 boundary_identifiers(::EquidistantGrid) = (Lower(), Upper()) | |
| 42 boundary_grid(g::EquidistantGrid, id::Lower) = ZeroDimGrid(g[begin]) | |
| 43 boundary_grid(g::EquidistantGrid, id::Upper) = ZeroDimGrid(g[end]) | |
| 44 | |
| 45 | |
| 46 """ | |
| 47 refine(g::EquidistantGrid, r::Int) | |
| 48 | |
| 49 Refines `grid` by a factor `r`. The factor is applied to the number of | |
| 50 intervals which is 1 less than the size of the grid. | |
| 51 | |
| 52 See also: [`coarsen`](@ref) | |
| 53 """ | |
| 54 function refine(g::EquidistantGrid, r::Int) | |
| 55 new_sz = (length(g) - 1)*r + 1 | |
| 56 return EquidistantGrid(change_length(g.points, new_sz)) | |
|
877
dd2ab001a7b6
Implement refine function, move exports to the top of the file, change location of constuctors.
Jonatan Werpers <jonatan@werpers.com>
parents:
688
diff
changeset
|
57 end |
|
680
1d3e29ffc6c6
Add support for 0-dimensional grid, and add method boundary_grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
661
diff
changeset
|
58 |
|
909
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
59 """ |
| 1222 | 60 coarsen(grid::EquidistantGrid, r::Int) |
| 61 | |
| 62 Coarsens `grid` by a factor `r`. The factor is applied to the number of | |
| 63 intervals which is 1 less than the size of the grid. If the number of | |
| 64 intervals are not divisible by `r` an error is raised. | |
| 65 | |
| 66 See also: [`refine`](@ref) | |
| 67 """ | |
| 68 function coarsen(g::EquidistantGrid, r::Int) | |
| 69 if (length(g)-1)%r != 0 | |
| 70 throw(DomainError(r, "Size minus 1 must be divisible by the ratio.")) | |
| 71 end | |
| 72 | |
| 73 new_sz = (length(g) - 1)÷r + 1 | |
| 74 | |
| 1249 | 75 return EquidistantGrid(change_length(g.points, new_sz)) |
| 1222 | 76 end |
| 77 | |
| 78 | |
| 79 """ | |
| 80 equidistant_grid(size::Dims, limit_lower, limit_upper) | |
|
909
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
81 |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
82 Construct an equidistant grid with corners at the coordinates `limit_lower` and |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
83 `limit_upper`. |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
84 |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
85 The length of the domain sides are given by the components of |
|
1247
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
86 `limit_upper-limit_lower`. E.g for a 2D grid with `limit_lower=(-1,0)` and |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
87 `limit_upper=(1,2)` the domain is defined as `(-1,1)x(0,2)`. The side lengths |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
88 of the grid are not allowed to be negative. |
|
909
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
89 |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
90 The number of equidistantly spaced points in each coordinate direction are given |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
91 by the tuple `size`. |
|
1247
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
92 |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
93 Note: If `limit_lower` and `limit_upper` are integers and `size` would allow a |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
94 completely integer grid, `equidistant_grid` will still return a floating point |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
95 grid. This simlifies the implementation and avoids certain surprise |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
96 behaviours. |
|
909
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
97 """ |
| 1222 | 98 function equidistant_grid(size::Dims, limit_lower, limit_upper) |
|
1248
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
99 if any(size .<= 0) |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
100 throw(DomainError("all components of size must be postive")) |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
101 end |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
102 |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
103 if any(limit_upper.-limit_lower .<= 0) |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
104 throw(DomainError("all side lengths must be postive")) |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
105 end |
|
a5f2372d0e87
Add argument checking to equdistant_grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1247
diff
changeset
|
106 |
| 1222 | 107 gs = map(size, limit_lower, limit_upper) do s,l,u |
| 108 EquidistantGrid(range(l, u, length=s)) # TBD: Should it use LinRange instead? | |
| 109 end | |
|
381
dacbcba33d7d
Refactor EquidistantGrid to not store spacing or inverse spacing
Jonatan Werpers <jonatan@werpers.com>
parents:
358
diff
changeset
|
110 |
| 1222 | 111 return TensorGrid(gs...) |
|
352
a18bd337a280
Add function for getting a one dimensional grid for a given dimension from a equidistant grid
Jonatan Werpers <jonatan@werpers.com>
parents:
333
diff
changeset
|
112 end |
|
658
26b0eb83aea4
Add function for getting boundary identifiers from equidistant grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
406
diff
changeset
|
113 |
|
1116
c2d7e940639e
Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1115
diff
changeset
|
114 |
|
1113
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
115 """ |
| 1222 | 116 equidistant_grid(size::Int, limit_lower::T, limit_upper::T) |
|
1113
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
117 |
| 1222 | 118 Constructs a 1D equidistant grid. |
|
1113
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
119 """ |
| 1222 | 120 function equidistant_grid(size::Int, limit_lower::T, limit_upper::T) where T |
| 121 return equidistant_grid((size,),(limit_lower,),(limit_upper,)) | |
|
1113
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
122 end |
|
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
123 |
|
1111
5b3d4a8ec3ab
Change to using filter for picking out orthogonal dimensions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
909
diff
changeset
|
124 |
|
680
1d3e29ffc6c6
Add support for 0-dimensional grid, and add method boundary_grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
661
diff
changeset
|
125 |
|
1d3e29ffc6c6
Add support for 0-dimensional grid, and add method boundary_grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
661
diff
changeset
|
126 """ |
| 1222 | 127 change_length(::AbstractRange, n) |
|
680
1d3e29ffc6c6
Add support for 0-dimensional grid, and add method boundary_grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
661
diff
changeset
|
128 |
| 1222 | 129 Change the length of a range to `n`, keeping the same start and stop. |
|
877
dd2ab001a7b6
Implement refine function, move exports to the top of the file, change location of constuctors.
Jonatan Werpers <jonatan@werpers.com>
parents:
688
diff
changeset
|
130 """ |
|
1250
40ca0af6e480
Add methods to change_length and fix incorrect function declaration
Jonatan Werpers <jonatan@werpers.com>
parents:
1249
diff
changeset
|
131 function change_length end |
| 908 | 132 |
|
1250
40ca0af6e480
Add methods to change_length and fix incorrect function declaration
Jonatan Werpers <jonatan@werpers.com>
parents:
1249
diff
changeset
|
133 change_length(r::UnitRange, n) = StepRange{Int,Int}(range(r[begin], r[end], n)) |
|
40ca0af6e480
Add methods to change_length and fix incorrect function declaration
Jonatan Werpers <jonatan@werpers.com>
parents:
1249
diff
changeset
|
134 change_length(r::StepRange, n) = StepRange{Int,Int}(range(r[begin], r[end], n)) |
|
40ca0af6e480
Add methods to change_length and fix incorrect function declaration
Jonatan Werpers <jonatan@werpers.com>
parents:
1249
diff
changeset
|
135 change_length(r::StepRangeLen, n) = range(r[begin], r[end], n) |
| 1222 | 136 change_length(r::LinRange, n) = LinRange(r[begin], r[end], n) |