changeset 1104:c0ab81e4c39c refactor/sbpoperators/inflation

Update docs
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 20 May 2022 11:30:46 +0200
parents 157a78959e5d
children 0ba4609605d4
files src/SbpOperators/boundaryops/boundary_restriction.jl src/SbpOperators/boundaryops/normal_derivative.jl src/SbpOperators/volumeops/derivatives/first_derivative.jl src/SbpOperators/volumeops/derivatives/second_derivative.jl
diffstat 4 files changed, 8 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/SbpOperators/boundaryops/boundary_restriction.jl	Tue May 10 20:34:20 2022 +0200
+++ b/src/SbpOperators/boundaryops/boundary_restriction.jl	Fri May 20 11:30:46 2022 +0200
@@ -8,7 +8,7 @@
 On a one-dimensional `grid`, `e` is a `BoundaryOperator`. On a multi-dimensional `grid`, `e` is the inflation of
 a `BoundaryOperator`.
 
-See also: [`boundary_operator`](@ref).
+See also: [`BoundaryOperator`](@ref), [`LazyTensors.inflate`](@ref).
 """
 function boundary_restriction(grid, closure_stencil, boundary)
     converted_stencil = convert(Stencil{eltype(grid)}, closure_stencil)
--- a/src/SbpOperators/boundaryops/normal_derivative.jl	Tue May 10 20:34:20 2022 +0200
+++ b/src/SbpOperators/boundaryops/normal_derivative.jl	Fri May 20 11:30:46 2022 +0200
@@ -8,7 +8,7 @@
 On a one-dimensional `grid`, `d` is a `BoundaryOperator`. On a multi-dimensional `grid`, `d` is the inflation of
 a `BoundaryOperator`.
 
-See also: [`boundary_operator`](@ref).
+See also: [`BoundaryOperator`](@ref), [`LazyTensors.inflate`](@ref).
 """
 function normal_derivative(grid, closure_stencil, boundary)
     direction = dim(boundary)
--- a/src/SbpOperators/volumeops/derivatives/first_derivative.jl	Tue May 10 20:34:20 2022 +0200
+++ b/src/SbpOperators/volumeops/derivatives/first_derivative.jl	Fri May 20 11:30:46 2022 +0200
@@ -7,10 +7,10 @@
 `direction`, using the stencil `inner_stencil` in the interior and a set of stencils `closure_stencils`
 for the points in the closure regions.
 
-On a one-dimensional `grid`, `D1` is a `VolumeOperator`. On a multi-dimensional `grid`, `D1` is the outer product of the
-one-dimensional operator with the `IdentityTensor`s in orthogonal coordinate dirrections.
+On a one-dimensional `grid`, `D1` is a `VolumeOperator`. On a multi-dimensional `grid`, `D1` is the inflation of
+a `VolumeOperator`.
 
-See also: [`volume_operator`](@ref).
+See also: [`VolumeOperator`](@ref), [`LazyTensors.inflate`](@ref).
 """
 function first_derivative(grid::EquidistantGrid, inner_stencil, closure_stencils, direction)
     h_inv = inverse_spacing(grid)[direction]
--- a/src/SbpOperators/volumeops/derivatives/second_derivative.jl	Tue May 10 20:34:20 2022 +0200
+++ b/src/SbpOperators/volumeops/derivatives/second_derivative.jl	Fri May 20 11:30:46 2022 +0200
@@ -7,10 +7,10 @@
 `direction`, using the stencil `inner_stencil` in the interior and a set of stencils `closure_stencils`
 for the points in the closure regions.
 
-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 `IdentityTensor`s in orthogonal coordinate dirrections.
+On a one-dimensional `grid`, `D2` is a `VolumeOperator`. On a multi-dimensional `grid`, `D2` is the inflation of
+a `VolumeOperator`.
 
-See also: [`volume_operator`](@ref).
+See also: [`VolumeOperator`](@ref), [`LazyTensors.inflate`](@ref).
 """
 function second_derivative(grid::EquidistantGrid, inner_stencil, closure_stencils, direction)
     h_inv = inverse_spacing(grid)[direction]