Mercurial > repos > public > sbplib_julia
changeset 1948:dd77b45ee1ac feature/grids/manifolds
Add some docstrings
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 07 Feb 2025 22:37:55 +0100 |
| parents | 76c6bde84656 |
| children | 6c1bb9bdb092 00cac08777b1 |
| files | src/Grids/manifolds.jl |
| diffstat | 1 files changed, 22 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/Grids/manifolds.jl Fri Feb 07 22:11:13 2025 +0100 +++ b/src/Grids/manifolds.jl Fri Feb 07 22:37:55 2025 +0100 @@ -54,10 +54,16 @@ """ connections(::Atlas) -TBD: What exactly should this return? +Collection of pairs of multiblock boundary identifiers. """ function connections end + +""" + CartesianAtlas{D,C<:Chart,AT<:AbstractArray{C,D}} <: Atlas + +An atlas where the charts are arranged and connected like an array. +""" struct CartesianAtlas{D,C<:Chart,AT<:AbstractArray{C,D}} <: Atlas charts::AT end @@ -86,6 +92,11 @@ return c end +""" + boundary_identifiers(a::CartesianAtlas) + +All non-connected boundaries of the charts of `a`. +""" function boundary_identifiers(a::CartesianAtlas) bs = MultiBlockBoundary[] @@ -106,6 +117,11 @@ end +""" + UnstructuredAtlas{C<:Chart, CN<:Tuple{MultiBlockBoundary,MultiBlockBoundary}, ...} <: Atlas + +An atlas with connections determined by a vector `MultiBlockBoundary` pairs. +""" struct UnstructuredAtlas{C<:Chart, CN<:Tuple{MultiBlockBoundary,MultiBlockBoundary}, CV<:AbstractVector{C}, CNV<:AbstractVector{CN}} <: Atlas charts::CV connections::CNV @@ -114,6 +130,11 @@ charts(a::UnstructuredAtlas) = a.charts connections(a::UnstructuredAtlas) = a.connections +""" + boundary_identifiers(a::UnstructuredAtlas) + +All non-connected boundaries of the charts of `a`. +""" function boundary_identifiers(a::UnstructuredAtlas) bs = MultiBlockBoundary[]