Mercurial > repos > public > sbplib_julia
diff src/SbpOperators/volumeops/derivatives/first_derivative.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 |
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/derivatives/first_derivative.jl Mon May 15 22:54:32 2023 +0200 +++ b/src/SbpOperators/volumeops/derivatives/first_derivative.jl Thu May 18 22:53:31 2023 +0200 @@ -1,7 +1,7 @@ """ first_derivative(g, ..., [direction]) -The first-derivative operator `D1` as a `LazyTensor` on the given grid. +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`. @@ -19,10 +19,10 @@ end """ - first_derivative(g::EquidistantGrid, stencil_set) + first_derivative(g::EquidistantGrid, stencil_set::StencilSet) -The first derivative operator on a `EquidistantGrid` given a -`StencilSet`. Uses the `D1` stencil in the stencil set. +The first derivative operator on an `EquidistantGrid`. +Uses the `D1` stencil in `stencil_set`. """ function first_derivative(g::EquidistantGrid, stencil_set::StencilSet) inner_stencil = parse_stencil(stencil_set["D1"]["inner_stencil"]) @@ -31,10 +31,10 @@ end """ - first_derivative(g::EquidistantGrid, inner_stencil, closure_stencils) + first_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils) -The first derivative operator on a `EquidistantGrid` given an -`inner_stencil` and a`closure_stencils`. +The first derivative operator on an `EquidistantGrid` given an +`inner_stencil` and `closure_stencils`. """ function first_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils) h⁻¹ = inverse_spacing(g)