Mercurial > repos > public > sbplib_julia

annotate src/Grids/grid.jl @ 1470:07882e390ff5 feature/grids/boundary_indicies

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
REVIEW: Suggest change to docstring
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Thu, 30 Nov 2023 16:45:08 +0100
parents de4e15924d26
children a863aef1f799
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
1 """
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: 1256
diff changeset
2 Grid{T,D}
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
3
1331
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
4 A grid with coordinates of type `T`, e.g. `SVector{3,Float64}`, and dimension
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
5 `D`. The grid can be embedded in a higher dimension in which case the number
1336
52087a6c0682 Mention grids as grid functions
Jonatan Werpers <jonatan@werpers.com>
parents: 1334
diff changeset
6 of indices and the number of components of the coordinate vectors will be
1331
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
7 different.
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
8
1336
52087a6c0682 Mention grids as grid functions
Jonatan Werpers <jonatan@werpers.com>
parents: 1334
diff changeset
9 All grids are expected to behave as a grid function for the coordinates.
52087a6c0682 Mention grids as grid functions
Jonatan Werpers <jonatan@werpers.com>
parents: 1334
diff changeset
10
1331
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
11 `Grids` is top level abstract type for grids. A grid should implement Julia's interfaces for
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
12 indexing and iteration.
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
13
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
14 ## Note
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
15
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
16 Importantly a grid does not have to be an `AbstractArray`. The reason is to
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
17 allow flexible handling of special types of grids like multi-block grids, or
1331
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
18 grids with special indexing.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
19 """
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: 1256
diff changeset
20 abstract type Grid{T,D} end
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
21
1262
5e28ae42caf2 Clean up IteratorSize and eltype for EquidistantGrid, Grid, and ZeroDimGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1257
diff changeset
22 Base.ndims(::Grid{T,D}) where {T,D} = D
5e28ae42caf2 Clean up IteratorSize and eltype for EquidistantGrid, Grid, and ZeroDimGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1257
diff changeset
23 Base.eltype(::Type{<:Grid{T}}) where T = T
1333
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
24
1386
4d628c83987e Add method `getindex(::Grid,::CartesianIndex)` with a default implementation
Jonatan Werpers <jonatan@werpers.com>
parents: 1347
diff changeset
25 Base.getindex(g::Grid, I::CartesianIndex) = g[Tuple(I)...]
4d628c83987e Add method `getindex(::Grid,::CartesianIndex)` with a default implementation
Jonatan Werpers <jonatan@werpers.com>
parents: 1347
diff changeset
26
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
27 """
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
28 coordinate_size(g)
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
29
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
30 The lenght of the coordinate vector of `Grid` `g`.
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
31 """
1333
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
32 coordinate_size(::Type{<:Grid{T}}) where T = _ncomponents(T)
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
33 coordinate_size(g::Grid) = coordinate_size(typeof(g)) # TBD: Name of this function?!
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
34
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
35 """
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
36 component_type(g)
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
37
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
38 The type of the components of the coordinate vector of `Grid` `g`.
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
39 """
1333
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
40 component_type(::Type{<:Grid{T}}) where T = eltype(T)
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
41 component_type(g::Grid) = component_type(typeof(g))
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
42
1264
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
43 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
44 refine(g::Grid, r)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
45
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
46 The grid where `g` is refined by the factor `r`.
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
47
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
48 See also: [`coarsen`](@ref).
1264
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
49 """
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
50 function refine end
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
51
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
52 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
53 coarsen(g::Grid, r)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
54
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
55 The grid where `g` is coarsened by the factor `r`.
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
56
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
57 See also: [`refine`](@ref).
1264
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
58 """
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
59 function coarsen end
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
60
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
61 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
62 boundary_identifiers(g::Grid)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
63
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
64 Identifiers for all the boundaries of `g`.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
65 """
1233
3924c1f6ec6d Fix empty function defs
Jonatan Werpers <jonatan@werpers.com>
parents: 1222
diff changeset
66 function boundary_identifiers end
1264
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
67
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
68 """
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
69 boundary_grid(g::Grid, id::BoundaryIdentifier)
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
70
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
71 The grid for the boundary specified by `id`.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
72 """
1233
3924c1f6ec6d Fix empty function defs
Jonatan Werpers <jonatan@werpers.com>
parents: 1222
diff changeset
73 function boundary_grid end
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
74 # TBD: Can we implement a version here that accepts multiple ids and grouped boundaries? Maybe we need multiblock stuff?
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
75
1470
07882e390ff5 REVIEW: Suggest change to docstring
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1466
diff changeset
76 # REVIEW: I suggest removing the sentence "The collection should be usable ...". I think it is redudant and also somewhat confusing
07882e390ff5 REVIEW: Suggest change to docstring
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1466
diff changeset
77 # in that wording "obtain grid functions" makes it sound like new grid functions are allocated from the indexing.
1269
20f42cf0800c Add test for Grid and make them pass. Start implementing eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1266
diff changeset
78 """
1466
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
79 boundary_indices(g::Grid, id::BoundaryIdentifier)
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
80
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
81 A collection of indices corresponding to the boundary with given id. The
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
82 collection should be usable to index grid functions on the grid to obtain grid
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
83 functions on the boundary grid.
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
84 """
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
85 function boundary_indices end
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
86
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
87 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
88 eval_on(g::Grid, f)
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
89
1397
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
90 Lazy evaluation of `f` on the grid. `f` can either be on the form `f(x,y,...)`
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
91 with each coordinate as an argument, or on the form `f(x̄)` taking a
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
92 coordinate vector.
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
93
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
94 For concrete array grid functions `map(f,g)` can be used instead.
1269
20f42cf0800c Add test for Grid and make them pass. Start implementing eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1266
diff changeset
95 """
1343
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
96 eval_on(g::Grid, f) = eval_on(g, f, Base.IteratorSize(g))
1273
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
97 function eval_on(g::Grid, f, ::Base.HasShape)
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
98 if hasmethod(f, (Any,))
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
99 return LazyTensors.LazyFunctionArray((I...)->f(g[I...]), size(g))
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
100 else
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
101 return LazyTensors.LazyFunctionArray((I...)->f(g[I...]...), size(g))
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
102 end
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
103 end
1402
2d9eb2d07802 Fix formatting and delete stray "`"
Jonatan Werpers <jonatan@werpers.com>
parents: 1401
diff changeset
104
1397
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
105 """
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
106 eval_on(g::Grid, f::Number)
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
107
1402
2d9eb2d07802 Fix formatting and delete stray "`"
Jonatan Werpers <jonatan@werpers.com>
parents: 1401
diff changeset
108 Lazy evaluation of a scalar `f` on the grid.
1397
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
109 """
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
110 eval_on(g::Grid, f::Number) = return LazyTensors.LazyConstantArray(f, size(g))
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
111
1270
dcbac783e4c1 Factor out functions for getting the type and number of components in a type
Jonatan Werpers <jonatan@werpers.com>
parents: 1269
diff changeset
112 _ncomponents(::Type{<:Number}) = 1
dcbac783e4c1 Factor out functions for getting the type and number of components in a type
Jonatan Werpers <jonatan@werpers.com>
parents: 1269
diff changeset
113 _ncomponents(T::Type{<:SVector}) = length(T)
1461
455e6b4c8b02 Add a function declaration for boundary_indices
Jonatan Werpers <jonatan@werpers.com>
parents: 1407
diff changeset
114
455e6b4c8b02 Add a function declaration for boundary_indices
Jonatan Werpers <jonatan@werpers.com>
parents: 1407
diff changeset
115