Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/boundaryops/boundary_restriction.jl @ 1329:e94ddef5e72f refactor/grids
Clean up documentation for changed types in SbpOperatorClean up documentation for changed types in SbpOperatorss
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Tue, 02 May 2023 22:09:33 +0200 |
parents | 1cc45207817e |
children | 08f06bfacd5c |
line wrap: on
line diff
--- a/src/SbpOperators/boundaryops/boundary_restriction.jl Tue May 02 20:14:39 2023 +0200 +++ b/src/SbpOperators/boundaryops/boundary_restriction.jl Tue May 02 22:09:33 2023 +0200 @@ -1,16 +1,20 @@ """ - boundary_restriction(g, closure_stencil::Stencil, boundary) + boundary_restriction(g, stencil_set::StencilSet, boundary) + boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary) + boundary_restriction(g::EquidistantGrid, stencil_set::StencilSet, boundary) Creates boundary restriction operators `e` as `LazyTensor`s on `boundary` -`e` is the restriction of a grid function to `boundary` using a `Stencil` `closure_stencil`. -`e'` is the prolongation of a grid function on `boundary` to the whole grid using the same `closure_stencil`. -On a one-dimensional grid, `e` is a `BoundaryOperator`. On a multi-dimensional grid, `e` is the inflation of -a `BoundaryOperator`. +`e` is the restriction of a grid function to `boundary` using the 'e' stencil +in the guven stencil set. `e'` is the prolongation of a grid function on +`boundary` to the whole grid using the same stencil. On a one-dimensional +grid, `e` is a `BoundaryOperator`. On a multi-dimensional grid, `e` is the +inflation of a `BoundaryOperator`. See also: [`BoundaryOperator`](@ref), [`LazyTensors.inflate`](@ref). """ -#TODO: Check docstring +function boundary_restriction end + function boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary) op = boundary_restriction(g.grids[grid_id(boundary)], stencil_set, boundary_id(boundary)) return LazyTensors.inflate(op, size(g), grid_id(boundary))