diff src/SbpOperators/volumeops/derivatives/second_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/second_derivative.jl	Mon May 15 22:54:32 2023 +0200
+++ b/src/SbpOperators/volumeops/derivatives/second_derivative.jl	Thu May 18 22:53:31 2023 +0200
@@ -1,7 +1,7 @@
 """
     second_derivative(g::EquidistantGrid, stencil_set, direction)
 
-Creates the second-derivative operator `D2` as a `LazyTensor`
+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`.
@@ -14,10 +14,10 @@
 end
 
 """
-    second_derivative(g, stencil_set)
+    second_derivative(g::EquidistantGrid, stencil_set::::StencilSet)
 
-Creates a `second_derivative` operator on a 1D `g` given a `stencil_set`. Uses
-the `D2` stencil in the stencil set.
+The second derivative operator on an `EquidistantGrid`. 
+Uses the `D2` stencil in `stencil_set`.
 """
 function second_derivative(g::EquidistantGrid, stencil_set::StencilSet)
     inner_stencil = parse_stencil(stencil_set["D2"]["inner_stencil"])
@@ -26,9 +26,9 @@
 end
 
 """
-    second_derivative(g, inner_stencil, closure_stencils)
+    second_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils)
 
-Creates a `second_derivative` operator on a 1D `g` given `inner_stencil` and
+The second derivative operator on an `EquidistantGrid`, given `inner_stencil` and
 `closure_stencils`.
 """
 function second_derivative(g::EquidistantGrid, inner_stencil::Stencil, closure_stencils)