Mercurial > repos > public > sbplib_julia

annotate src/Grids/grid.jl @ 1342:c0c1189c5f2e refactor/grids

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clean up grid_refactor.md
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 12 May 2023 15:50:09 +0200
parents f265799bc2b6
children fa3695f634de
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
ed3ea0630825 Add some docs for Grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1330
diff changeset
17 allow flexible handling of special types of grids like multiblock-grids, or
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
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
25 """
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
26 coordinate_size(grid)
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
27
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
28 The lenght of the coordinate vector for the given grid.
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
29 """
1333
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
30 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
31 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
32
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
33 """
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
34 component_type(grid)
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
35
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
36 The type of the components of the coordinate vector.
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
37 """
1333
79a2193da5c1 Implement coordinate_size() and component_type() types
Jonatan Werpers <jonatan@werpers.com>
parents: 1332
diff changeset
38 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
39 component_type(g::Grid) = component_type(typeof(g))
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
40
1264
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
41 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
42 refine(g::Grid, r)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
43
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
44 `g` refined by the factor `r`.
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
45
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
46 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
47 """
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
48 function refine end
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 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
51 coarsen(g::Grid, r)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
52
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
53 `g` coarsened by the factor `r`.
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
54
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
55 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
56 """
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
57 function coarsen end
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
58
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
59 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
60 boundary_identifiers(g::Grid)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
61
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
62 Identifiers for all the boundaries of `g`.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
63 """
1233
3924c1f6ec6d Fix empty function defs
Jonatan Werpers <jonatan@werpers.com>
parents: 1222
diff changeset
64 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
65
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
66 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
67 boundary_grid(g::Grid, bid::BoundaryIdentifier)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
68
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
69 The grid for the specified boundary.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
70 """
1233
3924c1f6ec6d Fix empty function defs
Jonatan Werpers <jonatan@werpers.com>
parents: 1222
diff changeset
71 function boundary_grid end
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
72 # 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
73
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
74
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
75 # TODO: Make sure that all grids implement all of the above.
51
614b56a017b9 Split grid.jl into AbstractGrid.jl and EquidistantGrid.jl
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents:
diff changeset
76
1116
c2d7e940639e Rename AbstractGrid to Grid and clean up Grids module
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1115
diff changeset
77
1269
20f42cf0800c Add test for Grid and make them pass. Start implementing eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1266
diff changeset
78 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
79 eval_on(g::Grid, f)
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
80
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
81 Lazy evaluation `f` on the grid. `f` can either be on the form `f(x,y,...)`
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
82 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
83 coordinate vector.
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
84
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
85 TODO: Mention map(f,g) if you want a concrete array
1269
20f42cf0800c Add test for Grid and make them pass. Start implementing eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1266
diff changeset
86 """
20f42cf0800c Add test for Grid and make them pass. Start implementing eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1266
diff changeset
87 eval_on(g::Grid, f) = eval_on(g, f, Base.IteratorSize(g)) # TBD: Borde f vara först som i alla map, sum, och dylikt
1273
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
88 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
89 if hasmethod(f, (Any,))
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
90 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
91 else
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
92 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
93 end
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
94 end
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
95
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
96 _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
97 _ncomponents(T::Type{<:SVector}) = length(T)