Mercurial > repos > public > sbplib_julia
annotate src/Grids/equidistant_grid.jl @ 1335:cca45af5e724 refactor/grids
Some docs for EquidistantGrid
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Wed, 03 May 2023 15:49:37 +0200 |
| parents | ed3ea0630825 |
| children | 760a4a1ec4b7 |
| rev | line source |
|---|---|
|
1247
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
1 """ |
|
1331
ed3ea0630825
Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1282
diff
changeset
|
2 EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1} |
|
ed3ea0630825
Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents:
1282
diff
changeset
|
3 |
|
1335
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
4 A one-dimensional equidistant grid. Most users are expected to use |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
5 [`equidistant_grid`](@ref) for constructing equidistant grids. |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
6 |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
7 See also: [`equidistant_grid`](@ref) |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
8 |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
9 |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
10 ## Note |
|
cca45af5e724
Some docs for EquidistantGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1331
diff
changeset
|
11 The type of range used for the points can likely impact performance. |
|
1247
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
12 """ |
|
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
|
13 struct EquidistantGrid{T,R<:AbstractRange{T}} <: Grid{T,1} |
| 1222 | 14 points::R |
| 15 end | |
|
75
93c833019857
Make EquidistantGrid more concrete
Jonatan Werpers <jonatan@werpers.com>
parents:
74
diff
changeset
|
16 |
| 1222 | 17 Base.eachindex(g::EquidistantGrid) = eachindex(g.points) |
| 18 | |
|
1255
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
19 # Indexing interface |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
20 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
|
21 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
|
22 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
|
23 |
|
1255
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
24 # Iteration interface |
|
1989d432731a
Implement the interfaces for iteration and indexing on EquidistantGrid. Make collect() work
Jonatan Werpers <jonatan@werpers.com>
parents:
1253
diff
changeset
|
25 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
|
26 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
|
27 |
|
1262
5e28ae42caf2
Clean up IteratorSize and eltype for EquidistantGrid, Grid, and ZeroDimGrid
Jonatan Werpers <jonatan@werpers.com>
parents:
1259
diff
changeset
|
28 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
|
29 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
|
30 Base.size(g::EquidistantGrid) = size(g.points) |
| 1222 | 31 |
| 32 | |
|
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
|
33 """ |
| 1222 | 34 spacing(grid::EquidistantGrid) |
| 35 | |
| 36 The spacing between grid points. | |
| 37 """ | |
| 38 spacing(g::EquidistantGrid) = step(g.points) | |
| 39 | |
|
51
614b56a017b9
Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff
changeset
|
40 |
| 1222 | 41 """ |
| 42 inverse_spacing(grid::EquidistantGrid) | |
| 43 | |
| 44 The reciprocal of the spacing between grid points. | |
| 45 """ | |
| 46 inverse_spacing(g::EquidistantGrid) = 1/step(g.points) | |
| 47 | |
| 48 | |
| 49 boundary_identifiers(::EquidistantGrid) = (Lower(), Upper()) | |
| 50 boundary_grid(g::EquidistantGrid, id::Lower) = ZeroDimGrid(g[begin]) | |
| 51 boundary_grid(g::EquidistantGrid, id::Upper) = ZeroDimGrid(g[end]) | |
| 52 | |
| 53 | |
| 54 """ | |
| 55 refine(g::EquidistantGrid, r::Int) | |
| 56 | |
| 57 Refines `grid` by a factor `r`. The factor is applied to the number of | |
| 58 intervals which is 1 less than the size of the grid. | |
| 59 | |
| 60 See also: [`coarsen`](@ref) | |
| 61 """ | |
| 62 function refine(g::EquidistantGrid, r::Int) | |
| 63 new_sz = (length(g) - 1)*r + 1 | |
| 64 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
|
65 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
|
66 |
|
909
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
67 """ |
| 1222 | 68 coarsen(grid::EquidistantGrid, r::Int) |
| 69 | |
| 70 Coarsens `grid` by a factor `r`. The factor is applied to the number of | |
| 71 intervals which is 1 less than the size of the grid. If the number of | |
| 72 intervals are not divisible by `r` an error is raised. | |
| 73 | |
| 74 See also: [`refine`](@ref) | |
| 75 """ | |
| 76 function coarsen(g::EquidistantGrid, r::Int) | |
| 77 if (length(g)-1)%r != 0 | |
| 78 throw(DomainError(r, "Size minus 1 must be divisible by the ratio.")) | |
| 79 end | |
| 80 | |
| 81 new_sz = (length(g) - 1)÷r + 1 | |
| 82 | |
| 1249 | 83 return EquidistantGrid(change_length(g.points, new_sz)) |
| 1222 | 84 end |
| 85 | |
| 86 | |
| 87 """ | |
| 88 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
|
89 |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
90 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
|
91 `limit_upper`. |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
92 |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
93 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
|
94 `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
|
95 `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
|
96 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
|
97 |
|
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
98 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
|
99 by the tuple `size`. |
|
1247
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
100 |
|
2abec782cf5b
Add todo for EquidistantGrid docs, improve equidistant_grid docs
Jonatan Werpers <jonatan@werpers.com>
parents:
1222
diff
changeset
|
101 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
|
102 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
|
103 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
|
104 behaviours. |
|
909
b900fea1c057
Clean up the docs a bit
Jonatan Werpers <jonatan@werpers.com>
parents:
908
diff
changeset
|
105 """ |
| 1222 | 106 function equidistant_grid(size::Dims, limit_lower, limit_upper) |
|
1282
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
107 gs = map(equidistant_grid, size, limit_lower, limit_upper) |
| 1222 | 108 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
|
109 end |
|
658
26b0eb83aea4
Add function for getting boundary identifiers from equidistant grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
406
diff
changeset
|
110 |
|
1113
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
111 """ |
| 1222 | 112 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
|
113 |
| 1222 | 114 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
|
115 """ |
| 1222 | 116 function equidistant_grid(size::Int, limit_lower::T, limit_upper::T) where T |
|
1282
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
117 if any(size .<= 0) |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
118 throw(DomainError("size must be postive")) |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
119 end |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
120 |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
121 if any(limit_upper.-limit_lower .<= 0) |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
122 throw(DomainError("side length must be postive")) |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
123 end |
|
11b08b242e48
Make equdistant_grid return an EquidistantGrid for the 1d Case
Jonatan Werpers <jonatan@werpers.com>
parents:
1280
diff
changeset
|
124 return EquidistantGrid(range(limit_lower, limit_upper, length=size)) # TBD: Should it use LinRange instead? |
|
1113
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
125 end |
|
4e4c5011140d
Add functions orthogonal_dims and boundary_size
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
1111
diff
changeset
|
126 |
|
1280
17d435c08773
Add missing exports and alias TensorGridBoundary to CartesianBoundary
Jonatan Werpers <jonatan@werpers.com>
parents:
1279
diff
changeset
|
127 CartesianBoundary{D,BID} = TensorGridBoundary{D,BID} # TBD: What should we do about the naming of this boundary? |
|
1111
5b3d4a8ec3ab
Change to using filter for picking out orthogonal dimensions
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
909
diff
changeset
|
128 |
|
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
|
129 |
|
1d3e29ffc6c6
Add support for 0-dimensional grid, and add method boundary_grid
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
661
diff
changeset
|
130 """ |
| 1222 | 131 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
|
132 |
| 1222 | 133 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
|
134 """ |
|
1250
40ca0af6e480
Add methods to change_length and fix incorrect function declaration
Jonatan Werpers <jonatan@werpers.com>
parents:
1249
diff
changeset
|
135 function change_length end |
| 908 | 136 |
|
1250
40ca0af6e480
Add methods to change_length and fix incorrect function declaration
Jonatan Werpers <jonatan@werpers.com>
parents:
1249
diff
changeset
|
137 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
|
138 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
|
139 change_length(r::StepRangeLen, n) = range(r[begin], r[end], n) |
| 1222 | 140 change_length(r::LinRange, n) = LinRange(r[begin], r[end], n) |