comparison src/SbpOperators/volumeops/volume_operator.jl @ 778:b6c0963100cd refactor/sbp_operators_method_signatures

Fix mistakes in the fix of the documentation
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 17 Jul 2021 18:14:02 +0200
parents d8c0916853fc
children a4d7ca5de3c6
comparison
equal deleted inserted replaced
774:d8c0916853fc 778:b6c0963100cd
4 Creates a volume operator on a `Dim`-dimensional grid acting along the 4 Creates a volume operator on a `Dim`-dimensional grid acting along the
5 specified coordinate `direction`. The action of the operator is determined by 5 specified coordinate `direction`. The action of the operator is determined by
6 the stencils `inner_stencil` and `closure_stencils`. When `Dim=1`, the 6 the stencils `inner_stencil` and `closure_stencils`. When `Dim=1`, the
7 corresponding `VolumeOperator` tensor mapping is returned. When `Dim>1`, the 7 corresponding `VolumeOperator` tensor mapping is returned. When `Dim>1`, the
8 returned operator is the appropriate outer product of a one-dimensional 8 returned operator is the appropriate outer product of a one-dimensional
9 operators and `IdentityMapping`s, e.g for `Dim=2`, `I⊗op⊗I`. 9 operators and `IdentityMapping`s, e.g for `Dim=3` the volume operator in the
10 y-direction is `I⊗op⊗I`.
10 """ 11 """
11 function volume_operator(grid::EquidistantGrid{Dim,T}, inner_stencil, closure_stencils, parity, direction) where {Dim,T} 12 function volume_operator(grid::EquidistantGrid{Dim,T}, inner_stencil, closure_stencils, parity, direction) where {Dim,T}
12 #TODO: Check that direction <= Dim? 13 #TODO: Check that direction <= Dim?
13 14
14 # Create 1D volume operator in along coordinate direction 15 # Create 1D volume operator in along coordinate direction