Mercurial > repos > public > sbplib_julia
comparison src/SbpOperators/volumeops/laplace/laplace.jl @ 1347:08f06bfacd5c refactor/grids
Fix typos and formatting of documentation
| author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
|---|---|
| date | Thu, 18 May 2023 22:53:31 +0200 |
| parents | e94ddef5e72f |
| children | bdcdbd4ea9cd efa994405c38 |
comparison
equal
deleted
inserted
replaced
| 1345:c2012db881cb | 1347:08f06bfacd5c |
|---|---|
| 8 D::TM # Difference operator | 8 D::TM # Difference operator |
| 9 stencil_set::StencilSet # Stencil set of the operator | 9 stencil_set::StencilSet # Stencil set of the operator |
| 10 end | 10 end |
| 11 | 11 |
| 12 """ | 12 """ |
| 13 Laplace(grid::Equidistant, stencil_set) | 13 Laplace(g::Grid, stencil_set::StencilSet) |
| 14 | 14 |
| 15 Creates the `Laplace` operator `Δ` on `grid` given a `stencil_set`. | 15 Creates the `Laplace` operator `Δ` on `g` given `stencil_set`. |
| 16 | 16 |
| 17 See also [`laplace`](@ref). | 17 See also [`laplace`](@ref). |
| 18 """ | 18 """ |
| 19 function Laplace(g::Grid, stencil_set::StencilSet) | 19 function Laplace(g::Grid, stencil_set::StencilSet) |
| 20 Δ = laplace(g, stencil_set) | 20 Δ = laplace(g, stencil_set) |
| 29 # Base.show(io::IO, L::Laplace) = ... | 29 # Base.show(io::IO, L::Laplace) = ... |
| 30 | 30 |
| 31 """ | 31 """ |
| 32 laplace(g::Grid, stencil_set) | 32 laplace(g::Grid, stencil_set) |
| 33 | 33 |
| 34 Creates the Laplace operator operator `Δ` as a `LazyTensor` on the given grid. | 34 Creates the Laplace operator operator `Δ` as a `LazyTensor` on `g`. |
| 35 | 35 |
| 36 `Δ` 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 |
| 37 approximation depends on the type of grid and the stencil set. | 37 approximation depends on the type of grid and the stencil set. |
| 38 | 38 |
| 39 See also: [`second_derivative`](@ref). | 39 See also: [`second_derivative`](@ref). |
