Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/volumeops/derivatives/first_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/first_derivative.jl Tue May 02 20:14:39 2023 +0200 +++ b/src/SbpOperators/volumeops/derivatives/first_derivative.jl Tue May 02 22:09:33 2023 +0200 @@ -1,12 +1,16 @@ +""" + first_derivative(g, ..., [direction]) + +The first-derivative operator `D1` as a `LazyTensor` on the given grid. + +`D1` approximates the first-derivative d/dξ on `g` along the coordinate +dimension specified by `direction`. +""" +function first_derivative end + """ first_derivative(g::TensorGrid, stencil_set, direction) -Creates the first-derivative operator `D1` as a `LazyTensor` - -`D1` approximates the first-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. - See also: [`VolumeOperator`](@ref), [`LazyTensors.inflate`](@ref). """ function first_derivative(g::TensorGrid, stencil_set, direction) @@ -17,7 +21,8 @@ """ first_derivative(g::EquidistantGrid, stencil_set) -Creates a `first_derivative` operator on a `EquidistantGrid` given a `StencilSet`. +The first derivative operator on a `EquidistantGrid` given a +`StencilSet`. Uses the `D1` stencil in the stencil set. """ function first_derivative(g::EquidistantGrid, stencil_set::StencilSet) inner_stencil = parse_stencil(stencil_set["D1"]["inner_stencil"]) @@ -28,7 +33,8 @@ """ first_derivative(g::EquidistantGrid, inner_stencil, closure_stencils) -Creates a `first_derivative` operator on a `EquidistantGrid` given an `inner_stencil` and a`closure_stencils`. +The first derivative operator on a `EquidistantGrid` given an +`inner_stencil` and a`closure_stencils`. """ function first_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils) h⁻¹ = inverse_spacing(g)