Mercurial > repos > public > sbplib_julia
changeset 1471:a863aef1f799 feature/grids/boundary_indicies
Fix review comment about docstring
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 01 Dec 2023 10:46:22 +0100 |
| parents | 07882e390ff5 |
| children | 46a6d83e7c0c |
| files | src/Grids/grid.jl |
| diffstat | 1 files changed, 6 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/src/Grids/grid.jl Thu Nov 30 16:45:08 2023 +0100 +++ b/src/Grids/grid.jl Fri Dec 01 10:46:22 2023 +0100 @@ -73,14 +73,15 @@ function boundary_grid end # TBD: Can we implement a version here that accepts multiple ids and grouped boundaries? Maybe we need multiblock stuff? -# REVIEW: I suggest removing the sentence "The collection should be usable ...". I think it is redudant and also somewhat confusing -# in that wording "obtain grid functions" makes it sound like new grid functions are allocated from the indexing. """ boundary_indices(g::Grid, id::BoundaryIdentifier) -A collection of indices corresponding to the boundary with given id. The -collection should be usable to index grid functions on the grid to obtain grid -functions on the boundary grid. +A collection of indices corresponding to the boundary with given id. For grids +with Cartesian indexing these collections will be tuples with elements of type +``Union{Int,Colon}``. + +When implementing this method it is expected that the returned collection can +be used to index grid functions to obtain grid functions on the boundary grid. """ function boundary_indices end