Mercurial > repos > public > sbplib_julia
changeset 1095:2be39d485221 feature/dissipation_operators
Docs for stencil_operator_distinct_closures
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Tue, 10 May 2022 20:49:44 +0200 |
| parents | 672610322206 |
| children | 9f0121e465a5 |
| files | src/SbpOperators/volumeops/stencil_operator_distinct_closures.jl |
| diffstat | 1 files changed, 8 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/stencil_operator_distinct_closures.jl Tue May 10 20:41:35 2022 +0200 +++ b/src/SbpOperators/volumeops/stencil_operator_distinct_closures.jl Tue May 10 20:49:44 2022 +0200 @@ -1,4 +1,10 @@ -# REVIEW: Add documentation +""" + stencil_operator_distinct_closures(grid::EquidistantGrid, inner_stencil, lower_closure, upper_closure, direction) + +Creates a multi-dimensional `StencilOperatorDistinctClosures` acting on grid functions of `grid`. + +See also: [`StencilOperatorDistinctClosures`](@ref) +""" function stencil_operator_distinct_closures(grid::EquidistantGrid, inner_stencil, lower_closure, upper_closure, direction) op = StencilOperatorDistinctClosures(restrict(grid, direction), inner_stencil, lower_closure, upper_closure) return LazyTensors.inflate(op, size(grid), direction) @@ -15,7 +21,7 @@ closures is useful for representing operators with skewed stencils like upwind operators. -See also: [`VolumeOperator`](@ref) +See also: [`VolumeOperator`](@ref), [`stencil_operator_distinct_closures`](@ref) """ struct StencilOperatorDistinctClosures{T,K,N,M,LC<:NTuple{N,Stencil{T,L}} where L, UC<:NTuple{M,Stencil{T,L}} where L} <: LazyTensor{T,1,1} inner_stencil::Stencil{T,K}