Mercurial > repos > public > sbplib_julia
comparison 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 |
comparison
equal
deleted
inserted
replaced
1328:f00a205ae347 | 1329:e94ddef5e72f |
---|---|
1 """ | 1 """ |
2 boundary_restriction(g, closure_stencil::Stencil, boundary) | 2 boundary_restriction(g, stencil_set::StencilSet, boundary) |
3 boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary) | |
4 boundary_restriction(g::EquidistantGrid, stencil_set::StencilSet, boundary) | |
3 | 5 |
4 Creates boundary restriction operators `e` as `LazyTensor`s on `boundary` | 6 Creates boundary restriction operators `e` as `LazyTensor`s on `boundary` |
5 | 7 |
6 `e` is the restriction of a grid function to `boundary` using a `Stencil` `closure_stencil`. | 8 `e` is the restriction of a grid function to `boundary` using the 'e' stencil |
7 `e'` is the prolongation of a grid function on `boundary` to the whole grid using the same `closure_stencil`. | 9 in the guven stencil set. `e'` is the prolongation of a grid function on |
8 On a one-dimensional grid, `e` is a `BoundaryOperator`. On a multi-dimensional grid, `e` is the inflation of | 10 `boundary` to the whole grid using the same stencil. On a one-dimensional |
9 a `BoundaryOperator`. | 11 grid, `e` is a `BoundaryOperator`. On a multi-dimensional grid, `e` is the |
12 inflation of a `BoundaryOperator`. | |
10 | 13 |
11 See also: [`BoundaryOperator`](@ref), [`LazyTensors.inflate`](@ref). | 14 See also: [`BoundaryOperator`](@ref), [`LazyTensors.inflate`](@ref). |
12 """ | 15 """ |
13 #TODO: Check docstring | 16 function boundary_restriction end |
17 | |
14 function boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary) | 18 function boundary_restriction(g::TensorGrid, stencil_set::StencilSet, boundary::TensorGridBoundary) |
15 op = boundary_restriction(g.grids[grid_id(boundary)], stencil_set, boundary_id(boundary)) | 19 op = boundary_restriction(g.grids[grid_id(boundary)], stencil_set, boundary_id(boundary)) |
16 return LazyTensors.inflate(op, size(g), grid_id(boundary)) | 20 return LazyTensors.inflate(op, size(g), grid_id(boundary)) |
17 end | 21 end |
18 | 22 |