Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/volumeops/derivatives/second_derivative.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 |
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/derivatives/second_derivative.jl Tue May 02 20:14:39 2023 +0200 +++ b/src/SbpOperators/volumeops/derivatives/second_derivative.jl Tue May 02 22:09:33 2023 +0200 @@ -1,11 +1,10 @@ """ - second_derivative(g::EquidistantGrid, inner_stencil, closure_stencils, direction) + second_derivative(g::EquidistantGrid, stencil_set, direction) Creates the second-derivative operator `D2` as a `LazyTensor` -`D2` approximates the second-derivative d²/dξ² on `g` along the coordinate dimension specified by -`direction`, using the stencil `inner_stencil` in the interior and a set of stencils `closure_stencils` -for the points in the closure regions. +`D2` approximates the second-derivative d²/dξ² on `g` along the coordinate +dimension specified by `direction`. See also: [`VolumeOperator`](@ref), [`LazyTensors.inflate`](@ref). """ @@ -17,7 +16,8 @@ """ second_derivative(g, stencil_set) -Creates a `second_derivative` operator on a 1D `g` given a `stencil_set`. +Creates a `second_derivative` operator on a 1D `g` given a `stencil_set`. Uses +the `D2` stencil in the stencil set. """ function second_derivative(g::EquidistantGrid, stencil_set::StencilSet) inner_stencil = parse_stencil(stencil_set["D2"]["inner_stencil"]) @@ -28,7 +28,8 @@ """ second_derivative(g, inner_stencil, closure_stencils) -Creates a `second_derivative` operator on a 1D `g` given `inner_stencil` and `closure_stencils`. +Creates a `second_derivative` operator on a 1D `g` given `inner_stencil` and +`closure_stencils`. """ function second_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils) h⁻¹ = inverse_spacing(g)