Mercurial > repos > public > sbplib_julia
changeset 798:997d6e641bf0 operator_storage_array_of_table
Fix docs for inner_product and inverse_inner_product
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Sun, 25 Jul 2021 15:10:51 +0200 |
parents | 92fafe5980dd |
children | 24df68453890 |
files | src/SbpOperators/volumeops/inner_products/inner_product.jl src/SbpOperators/volumeops/inner_products/inverse_inner_product.jl |
diffstat | 2 files changed, 18 insertions(+), 20 deletions(-) [+] |
line wrap: on
line diff
--- a/src/SbpOperators/volumeops/inner_products/inner_product.jl Sun Jul 25 14:58:50 2021 +0200 +++ b/src/SbpOperators/volumeops/inner_products/inner_product.jl Sun Jul 25 15:10:51 2021 +0200 @@ -1,21 +1,17 @@ -# TODO:refactor to take a tuple instead. Convert the tuple to stencil for now. Could probably be refactored using a diagonal operator later. -# How would a block-ip be built? A method on inner_product taking a stencil collection for the closure which then returns a different type of tensormapping +""" + inner_product(grid::EquidistantGrid, interior_weight, closure_weights) -""" - inner_product(grid::EquidistantGrid, closure_stencils, inner_stencil) - -Creates the discrete inner product operator `H` as a `TensorMapping` on an equidistant -grid, defined as `(u,v) = u'Hv` for grid functions `u,v`. +Creates the discrete inner product operator `H` as a `TensorMapping` on an +equidistant grid, defined as `(u,v) = u'Hv` for grid functions `u,v`. -`inner_product(grid::EquidistantGrid, closure_stencils, inner_stencil)` creates -`H` on `grid` the using a set of stencils `closure_stencils` for the points in -the closure regions and the stencil and `inner_stencil` in the interior. +`inner_product` creates `H` on `grid` using the `interior_weight` for the +interior points and the `closure_weights` for the points close to the +boundary. -On a 1-dimensional `grid`, `H` is a `VolumeOperator`. On a N-dimensional -`grid`, `H` is the outer product of the 1-dimensional inner product operators in -each coordinate direction. Also see the documentation of -`SbpOperators.volume_operator(...)` for more details. On a 0-dimensional `grid`, -`H` is a 0-dimensional `IdentityMapping`. +On a 1-dimensional grid, `H` is a `ConstantInteriorScalingOperator`. On a +N-dimensional grid, `H` is the outer product of the 1-dimensional inner +product operators for each coordinate direction. Also see the documentation of +On a 0-dimensional grid, `H` is a 0-dimensional `IdentityMapping`. """ function inner_product(grid::EquidistantGrid, interior_weight, closure_weights) Hs = ()
--- a/src/SbpOperators/volumeops/inner_products/inverse_inner_product.jl Sun Jul 25 14:58:50 2021 +0200 +++ b/src/SbpOperators/volumeops/inner_products/inverse_inner_product.jl Sun Jul 25 15:10:51 2021 +0200 @@ -1,12 +1,14 @@ """ inverse_inner_product(grid::EquidistantGrid, interior_weight, closure_weights) -Constructs the inverse inner product operator `H⁻¹` as a `TensorMapping` using the weights of `H`, `interior_weight`, `closure_weights`. `H⁻¹` is inverse of the inner product operator `H`. The weights are the +Constructs the inverse inner product operator `H⁻¹` as a `TensorMapping` using +the weights of `H`, `interior_weight`, `closure_weights`. `H⁻¹` is inverse of +the inner product operator `H`. The weights are the -On a 1-dimensional grid, `H⁻¹` is a `ConstantInteriorScalingOperator`. On an N-dimensional -grid, `H⁻¹` is the outer product of the 1-dimensional inverse inner product -operators for each coordinate direction. On a 0-dimensional `grid`, -`H⁻¹` is a 0-dimensional `IdentityMapping`. +On a 1-dimensional grid, `H⁻¹` is a `ConstantInteriorScalingOperator`. On an +N-dimensional grid, `H⁻¹` is the outer product of the 1-dimensional inverse +inner product operators for each coordinate direction. On a 0-dimensional +`grid`, `H⁻¹` is a 0-dimensional `IdentityMapping`. """ function inverse_inner_product(grid::EquidistantGrid, interior_weight, closure_weights) H⁻¹s = ()