Mercurial > repos > public > sbplib_julia
changeset 936:22c80fb36400 feature/laplace_opset
Fix docs and add some references
| author | Vidar Stiernström <vidar.stiernstrom@it.uu.se> |
|---|---|
| date | Fri, 25 Feb 2022 17:20:40 +0100 |
| parents | 079024db8226 |
| children | 38d1752a9aff |
| files | src/SbpOperators/boundaryops/boundary_restriction.jl src/SbpOperators/boundaryops/normal_derivative.jl src/SbpOperators/volumeops/derivatives/second_derivative.jl src/SbpOperators/volumeops/inner_products/inner_product.jl src/SbpOperators/volumeops/inner_products/inverse_inner_product.jl src/SbpOperators/volumeops/laplace/laplace.jl |
| diffstat | 6 files changed, 9 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/src/SbpOperators/boundaryops/boundary_restriction.jl Fri Feb 25 16:57:06 2022 +0100 +++ b/src/SbpOperators/boundaryops/boundary_restriction.jl Fri Feb 25 17:20:40 2022 +0100 @@ -4,9 +4,9 @@ Creates boundary restriction operators `e` as `TensorMapping`s on `boundary` `e` is the restriction of a grid function to `boundary` using a `Stencil` `closure_stencil`. -`e'` is the prolongation of a grid function on `boundary`` to the whole grid using the same `closure_stencil`. +`e'` is the prolongation of a grid function on `boundary` to the whole grid using the same `closure_stencil`. On a one-dimensional `grid`, `e` is a `BoundaryOperator`. On a multi-dimensional `grid`, `e` is the inflation of -a `BoundaryOperator`. See also [`SbpOperators.boundary_operator`](@ref). +a `BoundaryOperator`. See also [`boundary_operator`](@ref). """ function boundary_restriction(grid, closure_stencil::Stencil, boundary) converted_stencil = convert(Stencil{eltype(grid)}, closure_stencil)
--- a/src/SbpOperators/boundaryops/normal_derivative.jl Fri Feb 25 16:57:06 2022 +0100 +++ b/src/SbpOperators/boundaryops/normal_derivative.jl Fri Feb 25 17:20:40 2022 +0100 @@ -6,7 +6,7 @@ `d` computes the normal derivative of a grid function on `boundary` a `Stencil` `closure_stencil`. `d'` is the prolongation of the normal derivative of a grid function to the whole grid using the same `closure_stencil`. On a one-dimensional `grid`, `d` is a `BoundaryOperator`. On a multi-dimensional `grid`, `d` is the inflation of -a `BoundaryOperator`. See also [`SbpOperators.boundary_operator`](@ref). +a `BoundaryOperator`. See also [`boundary_operator`](@ref). """ function normal_derivative(grid, closure_stencil::Stencil, boundary) direction = dim(boundary)
--- a/src/SbpOperators/volumeops/derivatives/second_derivative.jl Fri Feb 25 16:57:06 2022 +0100 +++ b/src/SbpOperators/volumeops/derivatives/second_derivative.jl Fri Feb 25 17:20:40 2022 +0100 @@ -9,7 +9,7 @@ On a one-dimensional `grid`, `D2` is a `VolumeOperator`. On a multi-dimensional `grid`, `D2` is the outer product of the one-dimensional operator with the `IdentityMapping`s in orthogonal coordinate dirrections. -Also see the documentation of `SbpOperators.volume_operator(...)` for more details. +See also [`volume_operator`](@ref). """ function second_derivative(grid::EquidistantGrid, inner_stencil, closure_stencils, direction) h_inv = inverse_spacing(grid)[direction]
--- a/src/SbpOperators/volumeops/inner_products/inner_product.jl Fri Feb 25 16:57:06 2022 +0100 +++ b/src/SbpOperators/volumeops/inner_products/inner_product.jl Fri Feb 25 17:20:40 2022 +0100 @@ -12,6 +12,7 @@ N-dimensional grid, `H` is the outer product of the 1-dimensional inner product operators for each coordinate direction. On a 0-dimensional grid, `H` is a 0-dimensional `IdentityMapping`. +See also [`ConstantInteriorScalingOperator`](@ref). """ function inner_product(grid::EquidistantGrid, interior_weight, closure_weights) Hs = ()
--- a/src/SbpOperators/volumeops/inner_products/inverse_inner_product.jl Fri Feb 25 16:57:06 2022 +0100 +++ b/src/SbpOperators/volumeops/inner_products/inverse_inner_product.jl Fri Feb 25 17:20:40 2022 +0100 @@ -8,7 +8,8 @@ On a 1-dimensional grid, `H⁻¹` is a `ConstantInteriorScalingOperator`. On an N-dimensional grid, `H⁻¹` is the outer product of the 1-dimensional inverse inner product operators for each coordinate direction. On a 0-dimensional -`grid`, `H⁻¹` is a 0-dimensional `IdentityMapping`. +`grid`, `H⁻¹` is a 0-dimensional `IdentityMapping`. +See also [`ConstantInteriorScalingOperator`](@ref). """ function inverse_inner_product(grid::EquidistantGrid, interior_weight, closure_weights) H⁻¹s = ()
--- a/src/SbpOperators/volumeops/laplace/laplace.jl Fri Feb 25 16:57:06 2022 +0100 +++ b/src/SbpOperators/volumeops/laplace/laplace.jl Fri Feb 25 17:20:40 2022 +0100 @@ -11,9 +11,9 @@ end """ - `Laplace(grid::Equidistant, stencil_set)` + Laplace(grid::Equidistant, stencil_set) -Creates the `Laplace`` operator `Δ` on `grid` given a parsed TOML +Creates the `Laplace` operator `Δ` on `grid` given a parsed TOML `stencil_set`. See also [`laplace`](@ref). """ function Laplace(grid::EquidistantGrid, stencil_set)