Mercurial > repos > public > sbplib_julia
annotate src/Grids/manifolds.jl @ 1948:dd77b45ee1ac feature/grids/manifolds
Add some docstrings
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Fri, 07 Feb 2025 22:37:55 +0100 |
parents | c63116e2ec8e |
children | 3fb5b03162ee |
rev | line source |
---|---|
1558 | 1 """ |
1581
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
2 Chart{D} |
1558 | 3 |
4 A parametrized description of a manifold or part of a manifold. | |
5 """ | |
1581
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
6 struct Chart{D, PST<:ParameterSpace{D}, MT} |
1564
35fe4375b35f
Export things and fix ConcreteChart and Simplex
Jonatan Werpers <jonatan@werpers.com>
parents:
1558
diff
changeset
|
7 mapping::MT |
1558 | 8 parameterspace::PST |
9 end | |
10 | |
1781
a73838c9ef94
Let Chart implement Base.ndims instead of domain_dim
Jonatan Werpers <jonatan@werpers.com>
parents:
1780
diff
changeset
|
11 Base.ndims(::Chart{D}) where D = D |
1581
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
12 (c::Chart)(ξ) = c.mapping(ξ) |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
13 parameterspace(c::Chart) = c.parameterspace |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
14 |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
15 """ |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
16 jacobian(c::Chart, ξ) |
1558 | 17 |
1581
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
18 The jacobian of the mapping evaluated at `ξ`. This defers to the |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
19 implementation of `jacobian` for the mapping itself. If no implementation is |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
20 available one can easily be specified for either the mapping function or the |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
21 chart itself. |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
22 ```julia |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
23 c = Chart(f, ps) |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
24 jacobian(f::typeof(f), ξ) = f′(ξ) |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
25 ``` |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
26 or |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
27 ```julia |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
28 c = Chart(f, ps) |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
29 jacobian(c::typeof(c),ξ) = f′(ξ) |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
30 ``` |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
31 which will both allow calling `jacobian(c,ξ)`. |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
32 """ |
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
33 jacobian(c::Chart, ξ) = jacobian(c.mapping, ξ) |
1644
e213bd857f3f
Add some todos and tbds
Jonatan Werpers <jonatan@werpers.com>
parents:
1625
diff
changeset
|
34 # TBD: Can we register a error hint for when jacobian is called with a function that doesn't have a registered jacobian? |
1581
f77c5309dd2b
Rename ConcreteChart to Chart and remove the abstarct chart type
Jonatan Werpers <jonatan@werpers.com>
parents:
1580
diff
changeset
|
35 |
1946
c63116e2ec8e
Make boundaries() a method of boundary_identifiers
Jonatan Werpers <jonatan@werpers.com>
parents:
1945
diff
changeset
|
36 boundary_identifiers(c::Chart) = boundary_identifiers(parameterspace(c)) |
1558 | 37 |
1644
e213bd857f3f
Add some todos and tbds
Jonatan Werpers <jonatan@werpers.com>
parents:
1625
diff
changeset
|
38 |
1558 | 39 """ |
40 Atlas | |
41 | |
42 A collection of charts and their connections. | |
1844
1987347752ef
Add stub for connections(::Atlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1782
diff
changeset
|
43 Should implement methods for `charts` and `connections`. |
1558 | 44 """ |
45 abstract type Atlas end | |
46 | |
47 """ | |
48 charts(::Atlas) | |
49 | |
50 The colloction of charts in the atlas. | |
51 """ | |
52 function charts end | |
53 | |
54 """ | |
1844
1987347752ef
Add stub for connections(::Atlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1782
diff
changeset
|
55 connections(::Atlas) |
1558 | 56 |
1948 | 57 Collection of pairs of multiblock boundary identifiers. |
1558 | 58 """ |
1844
1987347752ef
Add stub for connections(::Atlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1782
diff
changeset
|
59 function connections end |
1558 | 60 |
1948 | 61 |
62 """ | |
63 CartesianAtlas{D,C<:Chart,AT<:AbstractArray{C,D}} <: Atlas | |
64 | |
65 An atlas where the charts are arranged and connected like an array. | |
66 """ | |
1932
ac63820222f8
Make field types of CartesianAtlas concrete
Jonatan Werpers <jonatan@werpers.com>
parents:
1931
diff
changeset
|
67 struct CartesianAtlas{D,C<:Chart,AT<:AbstractArray{C,D}} <: Atlas |
ac63820222f8
Make field types of CartesianAtlas concrete
Jonatan Werpers <jonatan@werpers.com>
parents:
1931
diff
changeset
|
68 charts::AT |
1558 | 69 end |
70 | |
71 charts(a::CartesianAtlas) = a.charts | |
1919
71d218593cac
Add implementation for size to CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1914
diff
changeset
|
72 |
1920
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
73 function connections(a::CartesianAtlas) |
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
74 c = Tuple{MultiBlockBoundary, MultiBlockBoundary}[] |
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
75 |
1928
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
76 for d ∈ 1:ndims(charts(a)) |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
77 Is = eachslice(CartesianIndices(charts(a)); dims=d) |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
78 for i ∈ 1:length(Is)-1 # For each interface between slices |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
79 for jk ∈ eachindex(Is[i]) # For each block in slice |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
80 Iᵢⱼₖ = Tuple(Is[i][jk]) |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
81 Iᵢ₊₁ⱼₖ = Tuple(Is[i+1][jk]) |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
82 push!(c, |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
83 ( |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
84 MultiBlockBoundary{Iᵢⱼₖ, CartesianBoundary{d,UpperBoundary}}(), |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
85 MultiBlockBoundary{Iᵢ₊₁ⱼₖ, CartesianBoundary{d,LowerBoundary}}(), |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
86 ) |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
87 ) |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
88 end |
96b3e9c516fe
Make cartesian atlas work for any dimension
Jonatan Werpers <jonatan@werpers.com>
parents:
1927
diff
changeset
|
89 end |
1920
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
90 end |
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
91 |
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
92 return c |
ae83c91286a2
Implement connections for CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1919
diff
changeset
|
93 end |
1558 | 94 |
1948 | 95 """ |
96 boundary_identifiers(a::CartesianAtlas) | |
97 | |
98 All non-connected boundaries of the charts of `a`. | |
99 """ | |
1946
c63116e2ec8e
Make boundaries() a method of boundary_identifiers
Jonatan Werpers <jonatan@werpers.com>
parents:
1945
diff
changeset
|
100 function boundary_identifiers(a::CartesianAtlas) |
1940
1bd0e23499da
Change variable name in boundaries(::CartesianAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1937
diff
changeset
|
101 bs = MultiBlockBoundary[] |
1934
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
102 |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
103 for d ∈ 1:ndims(charts(a)) |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
104 Is = eachslice(CartesianIndices(charts(a)); dims=d) |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
105 |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
106 for (i,b) ∈ ((1,LowerBoundary),(length(Is),UpperBoundary)) # For first and last slice |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
107 for jk ∈ eachindex(Is[i]) # For each block in slice |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
108 Iᵢⱼₖ = Tuple(Is[i][jk]) |
1940
1bd0e23499da
Change variable name in boundaries(::CartesianAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1937
diff
changeset
|
109 push!(bs, |
1934
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
110 MultiBlockBoundary{Iᵢⱼₖ, CartesianBoundary{d,b}}(), |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
111 ) |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
112 end |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
113 end |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
114 end |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
115 |
1940
1bd0e23499da
Change variable name in boundaries(::CartesianAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1937
diff
changeset
|
116 return bs |
1934
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
117 end |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
118 |
1b012e2d5db1
Add function for getting boundaries from CartesianAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1932
diff
changeset
|
119 |
1948 | 120 """ |
121 UnstructuredAtlas{C<:Chart, CN<:Tuple{MultiBlockBoundary,MultiBlockBoundary}, ...} <: Atlas | |
122 | |
123 An atlas with connections determined by a vector `MultiBlockBoundary` pairs. | |
124 """ | |
1937
755fc0907e99
Add tetss for construcors and getters for UnstructuredAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1936
diff
changeset
|
125 struct UnstructuredAtlas{C<:Chart, CN<:Tuple{MultiBlockBoundary,MultiBlockBoundary}, CV<:AbstractVector{C}, CNV<:AbstractVector{CN}} <: Atlas |
755fc0907e99
Add tetss for construcors and getters for UnstructuredAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1936
diff
changeset
|
126 charts::CV |
755fc0907e99
Add tetss for construcors and getters for UnstructuredAtlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1936
diff
changeset
|
127 connections::CNV |
1558 | 128 end |
129 | |
130 charts(a::UnstructuredAtlas) = a.charts | |
1931
bb2c708d724d
Implement connections for unstructured atlas
Jonatan Werpers <jonatan@werpers.com>
parents:
1929
diff
changeset
|
131 connections(a::UnstructuredAtlas) = a.connections |
1936
a7c9d04b57e0
Stub out boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1934
diff
changeset
|
132 |
1948 | 133 """ |
134 boundary_identifiers(a::UnstructuredAtlas) | |
135 | |
136 All non-connected boundaries of the charts of `a`. | |
137 """ | |
1946
c63116e2ec8e
Make boundaries() a method of boundary_identifiers
Jonatan Werpers <jonatan@werpers.com>
parents:
1945
diff
changeset
|
138 function boundary_identifiers(a::UnstructuredAtlas) |
1941
1e3089197397
Add tests for boundaries(::UnstructuredAtlas). Attempt implementation but more Charts functionality is needed
Jonatan Werpers <jonatan@werpers.com>
parents:
1940
diff
changeset
|
139 bs = MultiBlockBoundary[] |
1e3089197397
Add tests for boundaries(::UnstructuredAtlas). Attempt implementation but more Charts functionality is needed
Jonatan Werpers <jonatan@werpers.com>
parents:
1940
diff
changeset
|
140 |
1945
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
141 for (i,c) ∈ enumerate(charts(a)) |
1946
c63116e2ec8e
Make boundaries() a method of boundary_identifiers
Jonatan Werpers <jonatan@werpers.com>
parents:
1945
diff
changeset
|
142 for b ∈ boundary_identifiers(c) |
1945
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
143 mbb = MultiBlockBoundary{i,typeof(b)}() |
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
144 |
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
145 if !any(cn->mbb∈cn, connections(a)) |
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
146 push!(bs, mbb) |
1941
1e3089197397
Add tests for boundaries(::UnstructuredAtlas). Attempt implementation but more Charts functionality is needed
Jonatan Werpers <jonatan@werpers.com>
parents:
1940
diff
changeset
|
147 end |
1e3089197397
Add tests for boundaries(::UnstructuredAtlas). Attempt implementation but more Charts functionality is needed
Jonatan Werpers <jonatan@werpers.com>
parents:
1940
diff
changeset
|
148 end |
1e3089197397
Add tests for boundaries(::UnstructuredAtlas). Attempt implementation but more Charts functionality is needed
Jonatan Werpers <jonatan@werpers.com>
parents:
1940
diff
changeset
|
149 end |
1945
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
150 |
19efb9dacfff
Fix boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1944
diff
changeset
|
151 return bs |
1936
a7c9d04b57e0
Stub out boundaries(::UnstructuredAtlas)
Jonatan Werpers <jonatan@werpers.com>
parents:
1934
diff
changeset
|
152 end |