Mercurial > repos > public > sbplib_julia

diff src/Grids/tensor_grid.jl @ 1338:5604676d8426 refactor/grids

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs in tensor_grid.jl
author Jonatan Werpers <jonatan@werpers.com>
date Thu, 04 May 2023 08:39:00 +0200
parents f265799bc2b6
children 08f06bfacd5c
line wrap: on
line diff
--- a/src/Grids/tensor_grid.jl	Thu May 04 08:38:48 2023 +0200
+++ b/src/Grids/tensor_grid.jl	Thu May 04 08:39:00 2023 +0200
@@ -1,8 +1,9 @@
 """
     TensorGrid{T,D} <: Grid{T,D}
 
-* Only supports HasShape grids at the moment
-# TODO:
+A grid constructed as the tensor product of other grids.
+
+Currently only supports grids with the `HasShape`-trait.
 """
 struct TensorGrid{T,D,GT<:NTuple{N,Grid} where N} <: Grid{T,D}
     grids::GT
@@ -47,7 +48,9 @@
 
 """
     TensorGridBoundary{N, BID} <: BoundaryIdentifier
-# TODO:
+
+A boundary identifier for a tensor grid. `N` Specifies which grid in the
+tensor product and `BID` which boundary on that grid.
 """
 struct TensorGridBoundary{N, BID} <: BoundaryIdentifier end
 grid_id(::TensorGridBoundary{N, BID}) where {N, BID} = N