Mercurial > repos > public > sbplib_julia
comparison src/Grids/grid.jl @ 1470:07882e390ff5 feature/grids/boundary_indicies
REVIEW: Suggest change to docstring
| author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
|---|---|
| date | Thu, 30 Nov 2023 16:45:08 +0100 |
| parents | de4e15924d26 |
| children | a863aef1f799 |
comparison
equal
deleted
inserted
replaced
| 1469:54ae92803b0b | 1470:07882e390ff5 |
|---|---|
| 71 The grid for the boundary specified by `id`. | 71 The grid for the boundary specified by `id`. |
| 72 """ | 72 """ |
| 73 function boundary_grid end | 73 function boundary_grid end |
| 74 # TBD: Can we implement a version here that accepts multiple ids and grouped boundaries? Maybe we need multiblock stuff? | 74 # TBD: Can we implement a version here that accepts multiple ids and grouped boundaries? Maybe we need multiblock stuff? |
| 75 | 75 |
| 76 # REVIEW: I suggest removing the sentence "The collection should be usable ...". I think it is redudant and also somewhat confusing | |
| 77 # in that wording "obtain grid functions" makes it sound like new grid functions are allocated from the indexing. | |
| 76 """ | 78 """ |
| 77 boundary_indices(g::Grid, id::BoundaryIdentifier) | 79 boundary_indices(g::Grid, id::BoundaryIdentifier) |
| 78 | 80 |
| 79 A collection of indices corresponding to the boundary with given id. The | 81 A collection of indices corresponding to the boundary with given id. The |
| 80 collection should be usable to index grid functions on the grid to obtain grid | 82 collection should be usable to index grid functions on the grid to obtain grid |