annotate src/Grids/mapped_grid.jl @ 1863:516eaabf1169 refactor/grids/iterable_boundary_indices

Merge default
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 22 Jan 2025 09:00:40 +0100
parents 85f8855473ab a57cd6fa4ecb
children edee7d677efb f93ba5832146
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
1 """
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
2 MappedGrid{T,D} <: Grid{T,D}
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
3
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
4 A grid defined by a coordinate mapping from a logical grid to some physical
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
5 coordinates. The physical coordinates and the Jacobian are stored as grid
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
6 functions corresponding to the logical grid.
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
7
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
8 See also: [`logical_grid`](@ref), [`jacobian`](@ref), [`metric_tensor`](@ref).
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
9 """
1773
08e52f442872 Replace AbstractArray{<:Any,2} with AbstractMatrix{<:Any}
Jonatan Werpers <jonatan@werpers.com>
parents: 1768
diff changeset
10 struct MappedGrid{T,D, GT<:Grid{<:Any,D}, CT<:AbstractArray{T,D}, JT<:AbstractArray{<:AbstractMatrix{<:Any}, D}} <: Grid{T,D}
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
11 logical_grid::GT
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
12 physicalcoordinates::CT
1505
63101a1cd0e6 Remove some comments
Jonatan Werpers <jonatan@werpers.com>
parents: 1504
diff changeset
13 jacobian::JT
1743
49bd573ab07f Implement checking of sizes for inputs to MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1741
diff changeset
14
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
15 """
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
16 MappedGrid(logical_grid, physicalcoordinates, jacobian)
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
17
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
18 A MappedGrid with the given physical coordinates and jacobian.
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
19 """
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
20 function MappedGrid(logical_grid::GT, physicalcoordinates::CT, jacobian::JT) where {T,D, GT<:Grid{<:Any,D}, CT<:AbstractArray{T,D}, JT<:AbstractArray{<:AbstractMatrix{<:Any}, D}}
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
21 if !(size(logical_grid) == size(physicalcoordinates) == size(jacobian))
1743
49bd573ab07f Implement checking of sizes for inputs to MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1741
diff changeset
22 throw(ArgumentError("Sizes must match"))
49bd573ab07f Implement checking of sizes for inputs to MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1741
diff changeset
23 end
49bd573ab07f Implement checking of sizes for inputs to MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1741
diff changeset
24
1744
c38eead8be17 Add checks for the size of the jacobian
Jonatan Werpers <jonatan@werpers.com>
parents: 1743
diff changeset
25 if size(first(jacobian)) != (length(first(physicalcoordinates)),D)
c38eead8be17 Add checks for the size of the jacobian
Jonatan Werpers <jonatan@werpers.com>
parents: 1743
diff changeset
26 throw(ArgumentError("The size of the jacobian must match the dimensions of the grid and coordinates"))
c38eead8be17 Add checks for the size of the jacobian
Jonatan Werpers <jonatan@werpers.com>
parents: 1743
diff changeset
27 end
c38eead8be17 Add checks for the size of the jacobian
Jonatan Werpers <jonatan@werpers.com>
parents: 1743
diff changeset
28
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
29 return new{T,D,GT,CT,JT}(logical_grid, physicalcoordinates, jacobian)
1743
49bd573ab07f Implement checking of sizes for inputs to MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1741
diff changeset
30 end
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
31 end
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
32
1705
4870fc3faa25 Add tests for equallity of mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1704
diff changeset
33 function Base.:(==)(a::MappedGrid, b::MappedGrid)
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
34 same_logical_grid = logical_grid(a) == logical_grid(b)
1705
4870fc3faa25 Add tests for equallity of mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1704
diff changeset
35 same_coordinates = collect(a) == collect(b)
4870fc3faa25 Add tests for equallity of mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1704
diff changeset
36 same_jacobian = jacobian(a) == jacobian(b)
4870fc3faa25 Add tests for equallity of mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1704
diff changeset
37
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
38 return same_logical_grid && same_coordinates && same_jacobian
1705
4870fc3faa25 Add tests for equallity of mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1704
diff changeset
39 end
4870fc3faa25 Add tests for equallity of mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1704
diff changeset
40
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
41 """
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
42 logical_grid(g::MappedGrid)
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
43
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
44 The logical grid of `g`.
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
45 """
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
46 logical_grid(g::MappedGrid) = g.logical_grid
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
47
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
48 """
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
49 jacobian(g::MappedGrid)
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
50
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
51 The Jacobian matrix of `g` as a grid function.
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
52 """
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
53 jacobian(g::MappedGrid) = g.jacobian
1431
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1430
diff changeset
54
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
55
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
56 # Indexing interface
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
57 Base.getindex(g::MappedGrid, I::Vararg{Int}) = g.physicalcoordinates[I...]
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
58 Base.eachindex(g::MappedGrid) = eachindex(g.logical_grid)
1432
64b60b42d367 Implement indexing interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
59
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
60 Base.firstindex(g::MappedGrid, d) = firstindex(g.logical_grid, d)
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
61 Base.lastindex(g::MappedGrid, d) = lastindex(g.logical_grid, d)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
62
1450
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
63 # Iteration interface
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
64 Base.iterate(g::MappedGrid) = iterate(g.physicalcoordinates)
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
65 Base.iterate(g::MappedGrid, state) = iterate(g.physicalcoordinates, state)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
66
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
67 Base.IteratorSize(::Type{<:MappedGrid{<:Any, D}}) where D = Base.HasShape{D}()
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
68 Base.length(g::MappedGrid) = length(g.logical_grid)
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
69 Base.size(g::MappedGrid) = size(g.logical_grid)
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
70 Base.size(g::MappedGrid, d) = size(g.logical_grid, d)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
71
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
72 boundary_identifiers(g::MappedGrid) = boundary_identifiers(g.logical_grid)
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
73 boundary_indices(g::MappedGrid, id::TensorGridBoundary) = boundary_indices(g.logical_grid, id)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
74
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
75 function boundary_grid(g::MappedGrid, id::TensorGridBoundary)
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
76 b_indices = boundary_indices(g.logical_grid, id)
1503
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
77
1504
976f5784d7b9 Spelling
Jonatan Werpers <jonatan@werpers.com>
parents: 1503
diff changeset
78 # Calculate indices of needed jacobian components
1503
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
79 D = ndims(g)
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
80 all_indices = SVector{D}(1:D)
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
81 free_variable_indices = deleteat(all_indices, grid_id(id))
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
82 jacobian_components = (:, free_variable_indices)
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
83
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
84 # Create grid function for boundary grid jacobian
1832
85f8855473ab Update implementation of MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
85 boundary_jacobian = componentview((@view g.jacobian[b_indices]) , jacobian_components...)
85f8855473ab Update implementation of MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
86 boundary_physicalcoordinates = @view g.physicalcoordinates[b_indices]
1503
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
87
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
88 return MappedGrid(
1774
035af82f559a Rename logicalgrid to logical_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1773
diff changeset
89 boundary_grid(g.logical_grid, id),
1503
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
90 boundary_physicalcoordinates,
704a84eef8b6 Add tests for boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1502
diff changeset
91 boundary_jacobian,
1451
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
92 )
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
93 end
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
94
1821
a57cd6fa4ecb Add todo
Jonatan Werpers <jonatan@werpers.com>
parents: 1820
diff changeset
95 # TODO: Make sure all methods of `mapped_grid` are implemented correctly and tested.
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
96 """
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
97 mapped_grid(x, J, size::Vararg{Int})
1527
69790e9d1652 Remove tests for refine and coarsen
Jonatan Werpers <jonatan@werpers.com>
parents: 1506
diff changeset
98
1792
08710ebe940d Update docstring
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1787
diff changeset
99 A `MappedGrid` with a default logical grid on the D-dimensional unit hyper
1817
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
100 box [0,1]ᴰ. `x` and `J` are functions to be evaluated on the logical grid
1792
08710ebe940d Update docstring
Vidar Stiernström <vidar.stiernstrom@gmail.com>
parents: 1787
diff changeset
101 and `size` determines the size of the logical grid.
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
102 """
1706
11640aa3e348 Add method and refactor mapped_grid()
Jonatan Werpers <jonatan@werpers.com>
parents: 1705
diff changeset
103 function mapped_grid(x, J, size::Vararg{Int})
1502
a2dc80396808 Add functions `curvilinear_grid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1501
diff changeset
104 D = length(size)
1820
bddcae938ded Some clean up
Jonatan Werpers <jonatan@werpers.com>
parents: 1817
diff changeset
105 lg = equidistant_grid(ntuple(i->0., D), ntuple(i->1., D), size...) # TODO: Clean this up with ParamaterSpace once feature/grids/manifolds is merged
1817
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
106 return mapped_grid(x, J, lg)
1706
11640aa3e348 Add method and refactor mapped_grid()
Jonatan Werpers <jonatan@werpers.com>
parents: 1705
diff changeset
107 end
11640aa3e348 Add method and refactor mapped_grid()
Jonatan Werpers <jonatan@werpers.com>
parents: 1705
diff changeset
108
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
109 """
1817
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
110 mapped_grid(x, J, lg::Grid)
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
111
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
112 A `MappedGrid` with logical grid `lg`. Physical coordinates and Jacobian are
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
113 determined by the functions `x` and `J`.
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
114 """
1817
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
115 function mapped_grid(x, J, lg::Grid)
1506
535f32316637 Rename from curvilinear to mapped
Jonatan Werpers <jonatan@werpers.com>
parents: 1505
diff changeset
116 return MappedGrid(
1502
a2dc80396808 Add functions `curvilinear_grid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1501
diff changeset
117 lg,
a2dc80396808 Add functions `curvilinear_grid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1501
diff changeset
118 map(x,lg),
a2dc80396808 Add functions `curvilinear_grid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1501
diff changeset
119 map(J,lg),
a2dc80396808 Add functions `curvilinear_grid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1501
diff changeset
120 )
a2dc80396808 Add functions `curvilinear_grid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1501
diff changeset
121 end
1560
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1527
diff changeset
122
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
123 """
1820
bddcae938ded Some clean up
Jonatan Werpers <jonatan@werpers.com>
parents: 1817
diff changeset
124 mapped_grid(x, J, parameterspace, size)
1817
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
125
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
126 A `MappedGrid` with logical grid `lg`. Physical coordinates and Jacobian are
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
127 determined by the functions `x` and `J`.
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
128 """
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
129 function mapped_grid(x, J, parameterspace, size::Vararg{Int})
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
130 lg = equidistant_grid(parameterspace, size...)
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
131 return mapped_grid(x, J, lg)
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
132 end
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
133
d91a9f47380f Resolve ambiguity of mapped_grid and improve its signature
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
134 """
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
135 metric_tensor(g::MappedGrid)
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
136
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
137 The metric tensor of `g` as a grid function.
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
138 """
1682
4ce9cb21220c Fix naming of metrix tensor functions
Jonatan Werpers <jonatan@werpers.com>
parents: 1681
diff changeset
139 function metric_tensor(g::MappedGrid)
1560
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1527
diff changeset
140 return map(jacobian(g)) do ∂x∂ξ
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1527
diff changeset
141 ∂x∂ξ'*∂x∂ξ
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1527
diff changeset
142 end
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1527
diff changeset
143 end
5d32ecb98db8 Add functions for jacobian_determiant, geometric_tensor, geometric_tensor_inverse
Jonatan Werpers <jonatan@werpers.com>
parents: 1527
diff changeset
144
1684
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
145 function min_spacing(g::MappedGrid{T,1} where T)
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
146 n, = size(g)
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
147
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
148 ms = Inf
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
149 for i ∈ 1:n-1
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
150 ms = min(ms, norm(g[i+1]-g[i]))
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
151 end
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
152
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
153 return ms
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
154 end
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
155
1688
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
156 function min_spacing(g::MappedGrid{T,2} where T)
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
157 n, m = size(g)
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
158
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
159 ms = Inf
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
160 for i ∈ 1:n-1, j ∈ 1:m-1 # loop over each cell of the grid
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
161
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
162 ms = min(
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
163 ms,
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
164 norm(g[i+1,j]-g[i,j]),
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
165 norm(g[i,j+1]-g[i,j]),
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
166
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
167 norm(g[i+1,j]-g[i+1,j+1]),
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
168 norm(g[i,j+1]-g[i+1,j+1]),
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
169
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
170 norm(g[i+1,j+1]-g[i,j]),
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
171 norm(g[i+1,j]-g[i,j+1]),
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
172 )
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
173 # NOTE: This could be optimized to avoid checking all interior edges twice.
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
174 end
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
175
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
176 return ms
72776d3d5fd6 Add min_spacing for 2D mapped grids
Jonatan Werpers <jonatan@werpers.com>
parents: 1684
diff changeset
177 end
1684
22a9992471be Add min_spacing for mapped 1d grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1682
diff changeset
178
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
179 """
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
180 normal(g::MappedGrid, boundary)
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
181
1746
44faa334adc6 Add docs
Jonatan Werpers <jonatan@werpers.com>
parents: 1745
diff changeset
182 The outward pointing normal as a grid function on the corresponding boundary grid.
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
183 """
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
184 function normal(g::MappedGrid, boundary)
1832
85f8855473ab Update implementation of MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
185 return map(boundary_indices(g, boundary)) do I
85f8855473ab Update implementation of MappedGrid
Jonatan Werpers <jonatan@werpers.com>
parents: 1806
diff changeset
186 normal(g, boundary, Tuple(I)...)
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
187 end
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
188 end
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
189
1805
0c705f0bb3a9 Add docstring for normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1803
diff changeset
190 """
0c705f0bb3a9 Add docstring for normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1803
diff changeset
191 normal(g::MappedGrid, boundary, i...)
0c705f0bb3a9 Add docstring for normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1803
diff changeset
192
0c705f0bb3a9 Add docstring for normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1803
diff changeset
193 The outward pointing normal to the specified boundary in grid point `i`.
0c705f0bb3a9 Add docstring for normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1803
diff changeset
194 """
1799
8583f6379bd8 Fix signature of normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1798
diff changeset
195 function normal(g::MappedGrid, boundary, i...)
1798
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
196 σ = _boundary_sign(component_type(g), boundary)
1799
8583f6379bd8 Fix signature of normal(g,b,i...)
Jonatan Werpers <jonatan@werpers.com>
parents: 1798
diff changeset
197 ∂ξ∂x = inv(jacobian(g)[i...])
1798
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
198
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
199 k = grid_id(boundary)
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
200 return σ*∂ξ∂x[k,:]/norm(∂ξ∂x[k,:])
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
201 end
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
202
25dbb1c02ddc Add function for getting the normal in a given boundary point
Jonatan Werpers <jonatan@werpers.com>
parents: 1796
diff changeset
203
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
204 function _boundary_sign(T, boundary)
1736
863385aae454 Merge default
Jonatan Werpers <jonatan@werpers.com>
parents: 1706
diff changeset
205 if boundary_id(boundary) == UpperBoundary()
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
206 return one(T)
1736
863385aae454 Merge default
Jonatan Werpers <jonatan@werpers.com>
parents: 1706
diff changeset
207 elseif boundary_id(boundary) == LowerBoundary()
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
208 return -one(T)
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
209 else
1736
863385aae454 Merge default
Jonatan Werpers <jonatan@werpers.com>
parents: 1706
diff changeset
210 throw(ArgumentError("The boundary identifier must be either `LowerBoundary()` or `UpperBoundary()`"))
1659
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
211 end
3bbcd496e021 Add function for computing the normal at the boundary of a mapped grid as a grid function
Jonatan Werpers <jonatan@werpers.com>
parents: 1645
diff changeset
212 end