Mercurial > repos > public > sbplib_julia
comparison src/Grids/grid.jl @ 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 | 276c38a48aac 606975cdb1f3 d7bc11053951 |
comparison
equal
deleted
inserted
replaced
| 1470:07882e390ff5 | 1471:a863aef1f799 |
|---|---|
| 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. | |
| 78 """ | 76 """ |
| 79 boundary_indices(g::Grid, id::BoundaryIdentifier) | 77 boundary_indices(g::Grid, id::BoundaryIdentifier) |
| 80 | 78 |
| 81 A collection of indices corresponding to the boundary with given id. The | 79 A collection of indices corresponding to the boundary with given id. For grids |
| 82 collection should be usable to index grid functions on the grid to obtain grid | 80 with Cartesian indexing these collections will be tuples with elements of type |
| 83 functions on the boundary grid. | 81 ``Union{Int,Colon}``. |
| 82 | |
| 83 When implementing this method it is expected that the returned collection can | |
| 84 be used to index grid functions to obtain grid functions on the boundary grid. | |
| 84 """ | 85 """ |
| 85 function boundary_indices end | 86 function boundary_indices end |
| 86 | 87 |
| 87 """ | 88 """ |
| 88 eval_on(g::Grid, f) | 89 eval_on(g::Grid, f) |