Mercurial > repos > public > sbplib_julia

comparison src/SbpOperators/boundaryops/boundary_operator.jl @ 1329:e94ddef5e72f refactor/grids

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
1328:f00a205ae347 1329:e94ddef5e72f
1 """ 1 """
2 BoundaryOperator{T,R,N} <: LazyTensor{T,0,1} 2 BoundaryOperator{T,R,N} <: LazyTensor{T,0,1}
3 3
4 Implements the boundary operator `op` for 1D as a `LazyTensor` 4 Implements the boundary operator `op` for 1D as a `LazyTensor`
5 5
6 `op` is the restriction of a grid function to the boundary using some closure `Stencil{T,N}`. 6 `op` is the restriction of a grid function to the boundary using some closure
7 The boundary to restrict to is determined by `R`. 7 `Stencil{T,N}`. The boundary to restrict to is determined by `R`. `op'` is the
8 `op'` is the prolongation of a zero dimensional array to the whole grid using the same closure stencil. 8 prolongation of a zero dimensional array to the whole grid using the same
9 closure stencil.
9 """ 10 """
10 struct BoundaryOperator{T,R<:Region,N} <: LazyTensor{T,0,1} 11 struct BoundaryOperator{T,R<:Region,N} <: LazyTensor{T,0,1}
11 stencil::Stencil{T,N} 12 stencil::Stencil{T,N}
12 size::Int 13 size::Int
13 end 14 end
14 15
15 """ 16 """
16 BoundaryOperator(grid::EquidistantGrid, closure_stencil, region) 17 BoundaryOperator(grid::EquidistantGrid, closure_stencil, region)
17 18
18 Constructs the BoundaryOperator with stencil `closure_stencil` for a `EquidistantGrid` `grid`, restricting to 19 Constructs the BoundaryOperator with stencil `closure_stencil` for a
19 to the boundary specified by `region`. 20 `EquidistantGrid` `grid`, restricting to to the boundary specified by
21 `region`.
20 """ 22 """
21 function BoundaryOperator(grid::EquidistantGrid, closure_stencil::Stencil{T,N}, region::Region) where {T,N} 23 function BoundaryOperator(grid::EquidistantGrid, closure_stencil::Stencil{T,N}, region::Region) where {T,N}
22 return BoundaryOperator{T,typeof(region),N}(closure_stencil,size(grid)[1]) 24 return BoundaryOperator{T,typeof(region),N}(closure_stencil,size(grid)[1])
23 end 25 end
24 26