changeset 774:d8c0916853fc refactor/sbp_operators_method_signatures

Remove unneeded type parameter and rewirte documentation for volume_operator
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 17 Jul 2021 10:23:59 +0200
parents 86bb3606b215
children 1d166e7a9deb b6c0963100cd
files src/SbpOperators/volumeops/volume_operator.jl
diffstat 1 files changed, 8 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/volume_operator.jl	Thu Jul 15 23:25:12 2021 +0200
+++ b/src/SbpOperators/volumeops/volume_operator.jl	Sat Jul 17 10:23:59 2021 +0200
@@ -1,14 +1,14 @@
 """
-    volume_operator(grid,inner_stencil,closure_stencils,parity,direction)
+    volume_operator(grid, inner_stencil, closure_stencils, parity, direction)
+
 Creates a volume operator on a `Dim`-dimensional grid acting along the
-specified coordinate `direction`. The action of the operator is determined by the
-stencils `inner_stencil` and `closure_stencils`.
-When `Dim=1`, the corresponding `VolumeOperator` tensor mapping is returned.
-When `Dim>1`, the `VolumeOperator` `op` is inflated by the outer product
-of `IdentityMappings` in orthogonal coordinate directions, e.g for `Dim=3`,
-the boundary restriction operator in the y-direction direction is `Ix⊗op⊗Iz`.
+specified coordinate `direction`. The action of the operator is determined by
+the stencils `inner_stencil` and `closure_stencils`. When `Dim=1`, the
+corresponding `VolumeOperator` tensor mapping is returned. When `Dim>1`, the
+returned operator is the appropriate outer product of a one-dimensional
+operators and `IdentityMapping`s, e.g for `Dim=2`, `I⊗op⊗I`.
 """
-function volume_operator(grid::EquidistantGrid{Dim,T}, inner_stencil, closure_stencils, parity, direction) where {Dim,T,M}
+function volume_operator(grid::EquidistantGrid{Dim,T}, inner_stencil, closure_stencils, parity, direction) where {Dim,T}
     #TODO: Check that direction <= Dim?
 
     # Create 1D volume operator in along coordinate direction