annotate src/Grids/curvilinear_grid.jl @ 1451:2e08f3444354 feature/grids/curvilinear

Implement boundary_identifiers, and a wishful implementation of boundary_grid
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 23 Nov 2023 16:08:47 +0100
parents 647c8b18b84f
children 58b8da9c7e56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1433
1656228095b5 Add TBD
Jonatan Werpers <jonatan@werpers.com>
parents: 1432
diff changeset
1 # TBD: Rename to MappedGrid?
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
2 struct CurvilinearGrid{T,D, GT<:Grid{<:Any,D}, CT<:AbstractArray{T,D}, JT<:AbstractArray{<:AbstractArray{<:Any, 2}, D}} <: Grid{T,D}
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
3 logicalgrid::GT
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
4 physicalcoordinates::CT
1431
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1430
diff changeset
5 jacobian::JT
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
6 end
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
7
1431
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1430
diff changeset
8 jacobian(g::CurvilinearGrid) = g.jacobian
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1430
diff changeset
9 logicalgrid(g::CurvilinearGrid) = g.logicalgrid
6adf31ba6cfd Add `jacobian` and `logicalgrid`
Jonatan Werpers <jonatan@werpers.com>
parents: 1430
diff changeset
10
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
11
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
12 # Indexing interface
1432
64b60b42d367 Implement indexing interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
13 Base.getindex(g::CurvilinearGrid, I::Vararg{Int}) = g.physicalcoordinates[I...]
64b60b42d367 Implement indexing interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
14 Base.eachindex(g::CurvilinearGrid) = eachindex(g.logicalgrid)
64b60b42d367 Implement indexing interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
15
64b60b42d367 Implement indexing interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
16 Base.firstindex(g::CurvilinearGrid, d) = firstindex(g.logicalgrid, d)
64b60b42d367 Implement indexing interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1431
diff changeset
17 Base.lastindex(g::CurvilinearGrid, d) = lastindex(g.logicalgrid, d)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
18
1450
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
19 # Iteration interface
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
20
1450
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
21 Base.iterate(g::CurvilinearGrid) = iterate(g.physicalcoordinates)
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
22 Base.iterate(g::CurvilinearGrid, state) = iterate(g.physicalcoordinates, state)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
23
1450
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
24 Base.IteratorSize(::Type{<:CurvilinearGrid{<:Any, D}}) where D = Base.HasShape{D}()
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
25 Base.length(g::CurvilinearGrid) = length(g.logicalgrid)
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
26 Base.size(g::CurvilinearGrid) = size(g.logicalgrid)
647c8b18b84f Implement iterator interface
Jonatan Werpers <jonatan@werpers.com>
parents: 1449
diff changeset
27 Base.size(g::CurvilinearGrid, d) = size(g.logicalgrid, d)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
28
1451
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
29 boundary_identifiers(g::CurvilinearGrid) = boundary_identifiers(g.logicalgrid)
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
30
1451
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
31 function boundary_grid(g::CurvilinearGrid, id::TensorGridBoundary)
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
32 b_indices = boundary_indices(g.logicalgrid, id)
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
33 return CurvilinearGrid(
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
34 boundary_grid(g.logicalgrid, id),
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
35 g.physicalcoordinates[b_indices],
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
36 g.jacobian[b_indices],
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
37 )
2e08f3444354 Implement boundary_identifiers, and a wishful implementation of boundary_grid
Jonatan Werpers <jonatan@werpers.com>
parents: 1450
diff changeset
38 end
1430
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
39
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
40
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
41
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
42 # Do we add a convenience function `curvilinear_grid`? It could help with
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
43 # creating the logical grid, evaluating functions and possibly calculating the
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
44 # entries in the jacobian.
9fc3c1af33e5 Add testsets and a few tests
Jonatan Werpers <jonatan@werpers.com>
parents: 1426
diff changeset
45