Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/boundaryops/boundary_operator.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 | 4684c7f1c4cb |
line wrap: on
line diff
--- a/src/SbpOperators/boundaryops/boundary_operator.jl Tue May 02 20:14:39 2023 +0200 +++ b/src/SbpOperators/boundaryops/boundary_operator.jl Tue May 02 22:09:33 2023 +0200 @@ -3,9 +3,10 @@ Implements the boundary operator `op` for 1D as a `LazyTensor` -`op` is the restriction of a grid function to the boundary using some closure `Stencil{T,N}`. -The boundary to restrict to is determined by `R`. -`op'` is the prolongation of a zero dimensional array to the whole grid using the same closure stencil. +`op` is the restriction of a grid function to the boundary using some closure +`Stencil{T,N}`. The boundary to restrict to is determined by `R`. `op'` is the +prolongation of a zero dimensional array to the whole grid using the same +closure stencil. """ struct BoundaryOperator{T,R<:Region,N} <: LazyTensor{T,0,1} stencil::Stencil{T,N} @@ -15,8 +16,9 @@ """ BoundaryOperator(grid::EquidistantGrid, closure_stencil, region) -Constructs the BoundaryOperator with stencil `closure_stencil` for a `EquidistantGrid` `grid`, restricting to -to the boundary specified by `region`. +Constructs the BoundaryOperator with stencil `closure_stencil` for a +`EquidistantGrid` `grid`, restricting to to the boundary specified by +`region`. """ function BoundaryOperator(grid::EquidistantGrid, closure_stencil::Stencil{T,N}, region::Region) where {T,N} return BoundaryOperator{T,typeof(region),N}(closure_stencil,size(grid)[1])