comparison src/Grids/tensor_grid.jl @ 1347:08f06bfacd5c refactor/grids

Fix typos and formatting of documentation
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Thu, 18 May 2023 22:53:31 +0200
parents 5604676d8426
children 42ecd4b3e215
comparison
equal deleted inserted replaced
1345:c2012db881cb 1347:08f06bfacd5c
55 struct TensorGridBoundary{N, BID} <: BoundaryIdentifier end 55 struct TensorGridBoundary{N, BID} <: BoundaryIdentifier end
56 grid_id(::TensorGridBoundary{N, BID}) where {N, BID} = N 56 grid_id(::TensorGridBoundary{N, BID}) where {N, BID} = N
57 boundary_id(::TensorGridBoundary{N, BID}) where {N, BID} = BID() 57 boundary_id(::TensorGridBoundary{N, BID}) where {N, BID} = BID()
58 58
59 """ 59 """
60 boundary_identifiers(::TensorGrid) 60 boundary_identifiers(g::TensorGrid)
61 61
62 Returns a tuple containing the boundary identifiers for the grid. 62 Returns a tuple containing the boundary identifiers of `g`.
63 """ 63 """
64 function boundary_identifiers(g::TensorGrid) 64 function boundary_identifiers(g::TensorGrid)
65 per_grid = map(eachindex(g.grids)) do i 65 per_grid = map(eachindex(g.grids)) do i
66 return map(bid -> TensorGridBoundary{i, typeof(bid)}(), boundary_identifiers(g.grids[i])) 66 return map(bid -> TensorGridBoundary{i, typeof(bid)}(), boundary_identifiers(g.grids[i]))
67 end 67 end
68 return LazyTensors.concatenate_tuples(per_grid...) 68 return LazyTensors.concatenate_tuples(per_grid...)
69 end 69 end
70 70
71 71
72 """ 72 """
73 boundary_grid(grid::TensorGrid, id::TensorGridBoundary) 73 boundary_grid(g::TensorGrid, id::TensorGridBoundary)
74 74
75 The grid for the boundary specified by `id`. 75 The grid for the boundary of `g` specified by `id`.
76 """ 76 """
77 function boundary_grid(g::TensorGrid, bid::TensorGridBoundary) 77 function boundary_grid(g::TensorGrid, id::TensorGridBoundary)
78 local_boundary_grid = boundary_grid(g.grids[grid_id(bid)], boundary_id(bid)) 78 local_boundary_grid = boundary_grid(g.grids[grid_id(id)], boundary_id(id))
79 new_grids = Base.setindex(g.grids, local_boundary_grid, grid_id(bid)) 79 new_grids = Base.setindex(g.grids, local_boundary_grid, grid_id(id))
80 return TensorGrid(new_grids...) 80 return TensorGrid(new_grids...)
81 end 81 end
82 82
83 83
84 function combined_coordinate_vector_type(coordinate_types...) 84 function combined_coordinate_vector_type(coordinate_types...)