Mercurial > repos > public > sbplib_julia

changeset 506:c2f991b819fc feature/quadrature_as_outer_product

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update docs
author Vidar Stiernström <vidar.stiernstrom@it.uu.se>
date Sat, 07 Nov 2020 13:28:38 +0100
parents 26485066394a
children 576c6d1acc28
files src/SbpOperators/quadrature/diagonal_quadrature.jl src/SbpOperators/quadrature/inverse_diagonal_quadrature.jl
diffstat 2 files changed, 22 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/src/SbpOperators/quadrature/diagonal_quadrature.jl	Sat Nov 07 13:12:21 2020 +0100
+++ b/src/SbpOperators/quadrature/diagonal_quadrature.jl	Sat Nov 07 13:28:38 2020 +0100
@@ -2,7 +2,7 @@
 diagonal_quadrature(g,quadrature_closure)
 
 Constructs the diagonal quadrature operator `H` on a grid of `Dim` dimensions as
-a `TensorMapping`. The one-dimensional operator is a DiagonalQuadrature, while
+a `TensorMapping`. The one-dimensional operator is a `DiagonalQuadrature`, while
 the multi-dimensional operator is the outer-product of the
 one-dimensional operators in each coordinate direction.
 """
@@ -16,9 +16,10 @@
 export diagonal_quadrature
 
 """
-    DiagonalQuadrature{Dim,T<:Real,N,M,K} <: TensorMapping{T,Dim,Dim}
+    DiagonalQuadrature{T,M} <: TensorMapping{T,1,1}
 
-Implements the diagonal quadrature operator `H` of Dim dimension as a TensorMapping
+Implements the one-dimensional diagonal quadrature operator as a `TensorMapping
+TODO: Elaborate on properties
 """
 struct DiagonalQuadrature{T,M} <: TensorMapping{T,1,1}
     h::T
@@ -27,6 +28,12 @@
 end
 export DiagonalQuadrature
 
+"""
+    DiagonalQuadrature(g, quadrature_closure)
+
+Constructs the `DiagonalQuadrature` defined by the `EquidistantGrid` `g` and
+closure stencil `quadrature_closure`.
+"""
 function DiagonalQuadrature(g::EquidistantGrid{1}, quadrature_closure)
     return DiagonalQuadrature(spacing(g)[1], quadrature_closure, size(g))
 end
@@ -60,5 +67,9 @@
 
 LazyTensors.apply_transpose(H::DiagonalQuadrature{T}, v::AbstractVector{T}, I::Index) where T = LazyTensors.apply(H,v,I)
 
+"""
+    closuresize(H)
+Returns the size of the closure stencil of a DiagonalQuadrature `H`.
+"""
 closuresize(H::DiagonalQuadrature{T,M}) where {T,M} = M
 export closuresize
--- a/src/SbpOperators/quadrature/inverse_diagonal_quadrature.jl	Sat Nov 07 13:12:21 2020 +0100
+++ b/src/SbpOperators/quadrature/inverse_diagonal_quadrature.jl	Sat Nov 07 13:28:38 2020 +0100
@@ -1,7 +1,7 @@
 """
 inverse_diagonal_quadrature(g,quadrature_closure)
 
-Constructs the diagonal quadrature inverse operator `Qi` on a grid of `Dim` dimensions as
+Constructs the diagonal quadrature inverse operator `Hi` on a grid of `Dim` dimensions as
 a `TensorMapping`. The one-dimensional operator is a InverseDiagonalQuadrature, while
 the multi-dimensional operator is the outer-product of the one-dimensional operators
 in each coordinate direction.
@@ -17,9 +17,10 @@
 
 
 """
-    InverseDiagonalQuadrature{Dim,T<:Real,M} <: TensorMapping{T,1,1}
+    InverseDiagonalQuadrature{T,M} <: TensorMapping{T,1,1}
 
-Implements the inverse diagonal inner product operator `Hi` of as a 1D TensorOperator
+Implements the one-dimensional inverse diagonal quadrature operator as a `TensorMapping
+TODO: Elaborate on properties
 """
 struct InverseDiagonalQuadrature{T<:Real,M} <: TensorMapping{T,1,1}
     h_inv::T
@@ -59,6 +60,9 @@
 
 LazyTensors.apply_transpose(Hi::InverseDiagonalQuadrature{T}, v::AbstractVector{T}, I::Index) where T = LazyTensors.apply(Hi,v,I)
 
-
+"""
+    closuresize(H)
+Returns the size of the closure stencil of a InverseDiagonalQuadrature `Hi`.
+"""
 closuresize(Hi::InverseDiagonalQuadrature{T,M}) where {T,M} =  M
 export closuresize