Mercurial > repos > public > sbplib_julia

annotate src/Grids/grid.jl @ 1956:b0fcb29e3620 feature/grids/multiblock_boundaries

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge default
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 11 Feb 2025 08:54:18 +0100
parents 863385aae454
children 03894fd7b132
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
1513
d7bc11053951 Fix spelling mistakes
Jonatan Werpers <jonatan@werpers.com>
parents: 1471
diff changeset
30 The length 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 """
1512
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
36 component_type(gf)
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
37
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
38 The type of the components of the elements of `gf`. I.e if `gf` is a vector
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
39 valued grid function, `component_view(gf)` is the element type of the vectors
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
40 at each grid point.
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
41
1512
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
42 # Examples
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
43 ```julia-repl
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
44 julia> component_type([[1,2], [2,3], [3,4]])
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
45 Int64
7476877c0b0e Improve docstring for component_view
Jonatan Werpers <jonatan@werpers.com>
parents: 1510
diff changeset
46 ```
1334
47e309eac131 Add docs for coordinate_size and component_type
Jonatan Werpers <jonatan@werpers.com>
parents: 1333
diff changeset
47 """
1510
606975cdb1f3 Allow component_type to accept more types of inputs
Jonatan Werpers <jonatan@werpers.com>
parents: 1471
diff changeset
48 component_type(T::Type) = eltype(eltype(T))
606975cdb1f3 Allow component_type to accept more types of inputs
Jonatan Werpers <jonatan@werpers.com>
parents: 1471
diff changeset
49 component_type(t) = component_type(typeof(t))
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
50
1521
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
51 """
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
52 componentview(gf, component_index...)
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
53
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
54 A view of `gf` with only the components specified by `component_index...`.
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
55
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
56 # Examples
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
57 ```julia-repl
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
58 julia> componentview([[1,2], [2,3], [3,4]],2)
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
59 3-element ArrayComponentView{Int64, Vector{Int64}, 1, Vector{Vector{Int64}}, Tuple{Int64}}:
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
60 2
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
61 3
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
62 4
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
63 ```
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
64 """
1476
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
65 componentview(gf, component_index...) = ArrayComponentView(gf, component_index)
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
66
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
67 struct ArrayComponentView{CT,T,D,AT <: AbstractArray{T,D}, IT} <: AbstractArray{CT,D}
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
68 v::AT
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
69 component_index::IT
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
70
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
71 function ArrayComponentView(v, component_index)
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
72 CT = typeof(first(v)[component_index...])
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
73 return new{CT, eltype(v), ndims(v), typeof(v), typeof(component_index)}(v,component_index)
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
74 end
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
75 end
1474
276c38a48aac Start implementing componentview
Jonatan Werpers <jonatan@werpers.com>
parents: 1471
diff changeset
76
1624
888e4092e2ed Add missing type annotation in src/Grids/grid.jl for ArrayComponentView
Jonatan Werpers <jonatan@werpers.com>
parents: 1604
diff changeset
77 Base.size(cv::ArrayComponentView) = size(cv.v)
1476
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
78 Base.getindex(cv::ArrayComponentView, i::Int) = cv.v[i][cv.component_index...]
1517
7ee7df7d9b61 Remove review comments
Jonatan Werpers <jonatan@werpers.com>
parents: 1516
diff changeset
79 Base.getindex(cv::ArrayComponentView, I::Vararg{Int}) = cv.v[I...][cv.component_index...]
1476
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
80 IndexStyle(::Type{<:ArrayComponentView{<:Any,<:Any,AT}}) where AT = IndexStyle(AT)
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
81
1521
2fa325f08b66 Add docstring for `componentview`
Jonatan Werpers <jonatan@werpers.com>
parents: 1518
diff changeset
82 # TODO: Implement `setindex!`?
1476
62f9d0387a2a Introduce a view type and implement sliced indexing for the components.
Jonatan Werpers <jonatan@werpers.com>
parents: 1475
diff changeset
83 # TODO: Implement a more general ComponentView that can handle non-AbstractArrays.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
84
1646
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
85
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
86 """
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
87 min_spacing(g::Grid)
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
88
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
89 The smallest distance between any pair of grid points in `g`.
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
90 """
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
91 function min_spacing end
5f348cc5598e Add min_spacing function for grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1624
diff changeset
92
1264
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
93 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
94 refine(g::Grid, r)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
95
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
96 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
97
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
98 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
99 """
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
100 function refine end
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
101
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
102 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
103 coarsen(g::Grid, r)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
104
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
105 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
106
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
107 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
108 """
7a67935d3f3a grid.jl: Fix function defs and add todos for documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1262
diff changeset
109 function coarsen end
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
110
212
aa17d4d9d09e Export some functions from AbstractGrid and move documentation to docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 211
diff changeset
111 """
1672
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
112 BoundaryIdentifier
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
113
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
114 An identifier for a boundary of a grid.
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
115 """
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
116 abstract type BoundaryIdentifier end
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
117
3714a391545a Make the boundary identifiers for EquidistantGrid subtype BoundaryIdentifer
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1646
diff changeset
118 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
119 boundary_identifiers(g::Grid)
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
120
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
121 Identifiers for all the boundaries of `g`.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
122 """
1233
3924c1f6ec6d Fix empty function defs
Jonatan Werpers <jonatan@werpers.com>
parents: 1222
diff changeset
123 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
124
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
125 """
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
126 boundary_grid(g::Grid, id::BoundaryIdentifier)
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
127
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
128 The grid for the boundary specified by `id`.
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
129 """
1233
3924c1f6ec6d Fix empty function defs
Jonatan Werpers <jonatan@werpers.com>
parents: 1222
diff changeset
130 function boundary_grid end
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
131 # 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
132
1269
20f42cf0800c Add test for Grid and make them pass. Start implementing eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1266
diff changeset
133 """
1466
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
134 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
135
1471
a863aef1f799 Fix review comment about docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1470
diff changeset
136 A collection of indices corresponding to the boundary with given id. For grids
a863aef1f799 Fix review comment about docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1470
diff changeset
137 with Cartesian indexing these collections will be tuples with elements of type
a863aef1f799 Fix review comment about docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1470
diff changeset
138 ``Union{Int,Colon}``.
a863aef1f799 Fix review comment about docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1470
diff changeset
139
a863aef1f799 Fix review comment about docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1470
diff changeset
140 When implementing this method it is expected that the returned collection can
a863aef1f799 Fix review comment about docstring
Jonatan Werpers <jonatan@werpers.com>
parents: 1470
diff changeset
141 be used to index grid functions to obtain grid functions on the boundary grid.
1466
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
142 """
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
143 function boundary_indices end
de4e15924d26 Move def of boundary_indices, remove some new lines
Jonatan Werpers <jonatan@werpers.com>
parents: 1461
diff changeset
144
1595
611ae2308aa1 Add orthogonal_grid
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1528
diff changeset
145 """
1330
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
146 eval_on(g::Grid, f)
1222
5f677cd6f0b6 Start refactoring
Jonatan Werpers <jonatan@werpers.com>
parents: 1128
diff changeset
147
1397
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
148 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
149 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
150 coordinate vector.
5f05a708d730 grid.l: More documentation
Jonatan Werpers <jonatan@werpers.com>
parents: 1324
diff changeset
151
1347
08f06bfacd5c Fix typos and formatting of documentation
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1344
diff changeset
152 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
153 """
1343
fa3695f634de More clean up of todos and notes
Jonatan Werpers <jonatan@werpers.com>
parents: 1342
diff changeset
154 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
155 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
156 if hasmethod(f, (Any,))
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
157 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
158 else
1528
d641798539c2 Update notes on changes to `eval_on` and multiblock grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1521
diff changeset
159 # TBD This branch can be removed if we accept the trade off that we define f with the syntax f((x,y)) instead if we don't want to handle the vector in the body of f. (Add an example in the docs)
d641798539c2 Update notes on changes to `eval_on` and multiblock grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1521
diff changeset
160 # Also see Notes.md
1273
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
161 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
162 end
7fab13c07412 Allow multi-argument functions in eval_on
Jonatan Werpers <jonatan@werpers.com>
parents: 1272
diff changeset
163 end
1402
2d9eb2d07802 Fix formatting and delete stray "`"
Jonatan Werpers <jonatan@werpers.com>
parents: 1401
diff changeset
164
1397
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
165 """
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
166 eval_on(g::Grid, f::Number)
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
167
1402
2d9eb2d07802 Fix formatting and delete stray "`"
Jonatan Werpers <jonatan@werpers.com>
parents: 1401
diff changeset
168 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
169 """
86026367a9ff Support evaluating scalars on grids
Vidar Stiernström <vidar.stiernstrom@it.uu.se>
parents: 1347
diff changeset
170 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
171
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
172 _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
173 _ncomponents(T::Type{<:SVector}) = length(T)
1461
455e6b4c8b02 Add a function declaration for boundary_indices
Jonatan Werpers <jonatan@werpers.com>
parents: 1407
diff changeset
174
455e6b4c8b02 Add a function declaration for boundary_indices
Jonatan Werpers <jonatan@werpers.com>
parents: 1407
diff changeset
175