diff src/SbpOperators/volumeops/derivatives/first_derivative.jl @ 990:b6238afd3bb0 feature/stencil_set_type

Add methods for creating derivative operators in 1D from stencil sets without providing directions
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Fri, 18 Mar 2022 13:02:46 +0100
parents 7bf3121c6864
children 99d1f5651d0b
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/derivatives/first_derivative.jl	Thu Mar 17 21:31:20 2022 +0100
+++ b/src/SbpOperators/volumeops/derivatives/first_derivative.jl	Fri Mar 18 13:02:46 2022 +0100
@@ -16,11 +16,18 @@
     h_inv = inverse_spacing(grid)[direction]
     return SbpOperators.volume_operator(grid, scale(inner_stencil,h_inv), scale.(closure_stencils,h_inv), odd, direction)
 end
-first_derivative(grid::EquidistantGrid{1}, inner_stencil::Stencil, closure_stencils) = first_derivative(grid,inner_stencil,closure_stencils,1)
 
 
 """
-    first_derivative(grid, stencil_set, direction)
+    first_derivative(grid, inner_stencil, closure_stencils)
+
+Creates a `first_derivative` operator on a 1D `grid` given `inner_stencil` and `closure_stencils`.
+"""
+first_derivative(grid::EquidistantGrid{1}, inner_stencil::Stencil, closure_stencils) = first_derivative(grid, inner_stencil, closure_stencils, 1)
+
+
+"""
+    first_derivative(grid, stencil_set::StencilSet, direction)
 
 Creates a `first_derivative` operator on `grid` along coordinate dimension `direction` given a `stencil_set`.
 """
@@ -30,6 +37,10 @@
     first_derivative(grid,inner_stencil,closure_stencils,direction);
 end
 
-# TODO: Not possible to remove ::Stencil from first_derivative(grid::EquidistantGrid{1},...) due to type deduction failing. 
-# Is this due to the type ambuguity of StencilSet? Possible to address in some other way? 
-# If not, should we drop ::StencilSet from the method above (it is not required)?
\ No newline at end of file
+
+"""
+    first_derivative(grid, stencil_set)
+
+Creates a `first_derivative` operator on a 1D `grid` given a `stencil_set`.
+"""
+first_derivative(grid::EquidistantGrid{1}, stencil_set) = first_derivative(grid, stencil_set, 1)