Mercurial > repos > public > sbplib_julia
comparison src/SbpOperators/volumeops/laplace/laplace.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 | 356ec6a72974 |
children | 08f06bfacd5c |
comparison
equal
deleted
inserted
replaced
1328:f00a205ae347 | 1329:e94ddef5e72f |
---|---|
1 """ | 1 """ |
2 Laplace{T, Dim, TM} <: LazyTensor{T, Dim, Dim} | 2 Laplace{T, Dim, TM} <: LazyTensor{T, Dim, Dim} |
3 | 3 |
4 Implements the Laplace operator, approximating ∑d²/xᵢ² , i = 1,...,`Dim` as a | 4 The Laplace operator, approximating ∑d²/xᵢ² , i = 1,...,`Dim` as a |
5 `LazyTensor`. Additionally `Laplace` stores the `StencilSet` | 5 `LazyTensor`. |
6 used to construct the `LazyTensor`. | |
7 """ | 6 """ |
8 struct Laplace{T, Dim, TM<:LazyTensor{T, Dim, Dim}} <: LazyTensor{T, Dim, Dim} | 7 struct Laplace{T, Dim, TM<:LazyTensor{T, Dim, Dim}} <: LazyTensor{T, Dim, Dim} |
9 D::TM # Difference operator | 8 D::TM # Difference operator |
10 stencil_set::StencilSet # Stencil set of the operator | 9 stencil_set::StencilSet # Stencil set of the operator |
11 end | 10 end |
30 # Base.show(io::IO, L::Laplace) = ... | 29 # Base.show(io::IO, L::Laplace) = ... |
31 | 30 |
32 """ | 31 """ |
33 laplace(g::Grid, stencil_set) | 32 laplace(g::Grid, stencil_set) |
34 | 33 |
35 Creates the Laplace operator operator `Δ` as a `LazyTensor` on the given grid | 34 Creates the Laplace operator operator `Δ` as a `LazyTensor` on the given grid. |
36 | 35 |
37 `Δ` approximates the Laplace operator ∑d²/xᵢ² , i = 1,...,`Dim` on `g`. The | 36 `Δ` approximates the Laplace operator ∑d²/xᵢ² , i = 1,...,`Dim` on `g`. The |
38 approximation depends on the type of grid and the stencil set. | 37 approximation depends on the type of grid and the stencil set. |
39 | 38 |
40 See also: [`second_derivative`](@ref). | 39 See also: [`second_derivative`](@ref). |