Mercurial > repos > public > sbplib_julia
changeset 1746:44faa334adc6 feature/grids/curvilinear
Add docs
author | Jonatan Werpers <jonatan@werpers.com> |
---|---|
date | Wed, 11 Sep 2024 14:41:14 +0200 |
parents | 2f7974367cd3 |
children | e719c6dadba6 |
files | src/Grids/mapped_grid.jl |
diffstat | 1 files changed, 55 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
diff -r 2f7974367cd3 -r 44faa334adc6 src/Grids/mapped_grid.jl --- a/src/Grids/mapped_grid.jl Wed Sep 11 14:11:11 2024 +0200 +++ b/src/Grids/mapped_grid.jl Wed Sep 11 14:41:14 2024 +0200 @@ -1,8 +1,22 @@ +""" + MappedGrid{T,D} <: Grid{T,D} + +A grid defined by a coordinate mapping from a logical grid to some physical +coordinates. The physical coordinates and the Jacobian are stored as grid +functions corresponding to the logical grid. + +See also: [`logicalgrid`](@ref), [`jacobian`](@ref), [`metric_tensor`](@ref). +""" struct MappedGrid{T,D, GT<:Grid{<:Any,D}, CT<:AbstractArray{T,D}, JT<:AbstractArray{<:AbstractArray{<:Any, 2}, D}} <: Grid{T,D} logicalgrid::GT physicalcoordinates::CT jacobian::JT + """ + MappedGrid(logicalgrid, physicalcoordinates, jacobian) + + A MappedGrid with the given physical coordinates and jacobian. + """ function MappedGrid(logicalgrid::GT, physicalcoordinates::CT, jacobian::JT) where {T,D, GT<:Grid{<:Any,D}, CT<:AbstractArray{T,D}, JT<:AbstractArray{<:AbstractArray{<:Any, 2}, D}} if !(size(logicalgrid) == size(physicalcoordinates) == size(jacobian)) throw(ArgumentError("Sizes must match")) @@ -26,8 +40,19 @@ return same_logicalgrid && same_coordinates && same_jacobian end +""" + logicalgrid(g::MappedGrid) + +The logical grid of `g`. +""" +logicalgrid(g::MappedGrid) = g.logicalgrid + +""" + jacobian(g::MappedGrid) + +The Jacobian matrix of `g` as a grid function. +""" jacobian(g::MappedGrid) = g.jacobian -logicalgrid(g::MappedGrid) = g.logicalgrid # Indexing interface @@ -69,15 +94,26 @@ ) end -# TBD: refine and coarsen could be implemented once we have a simple manifold implementation. -# Before we do, we should consider the overhead of including such a field in the mapped grid struct. + +""" + mapped_grid(x, J, size::Vararg{Int}) +A `MappedGrid` with a default logical grid on a unit hyper box. `x` and `J` +are functions to be evaluated on the logical grid and `size` determines the +size of the logical grid. +""" function mapped_grid(x, J, size::Vararg{Int}) D = length(size) lg = equidistant_grid(ntuple(i->0., D), ntuple(i->1., D), size...) return mapped_grid(lg, x, J) end +""" + mapped_grid(lg::Grid, x, J) + +A `MappedGrid` with logical grid `lg`. Physical coordinates and Jacobian are +determined by the functions `x` and `J`. +""" function mapped_grid(lg::Grid, x, J) return MappedGrid( lg, @@ -86,6 +122,11 @@ ) end +""" + jacobian_determinant(g::MappedGrid) + +The jacobian determinant of `g` as a grid function. +""" function jacobian_determinant(g::MappedGrid) return map(jacobian(g)) do ∂x∂ξ det(∂x∂ξ) @@ -96,12 +137,22 @@ # TBD: Is there a better name? metric_determinant? # TBD: Is the best option to delete it? +""" + metric_tensor(g::MappedGrid) + +The metric tensor of `g` as a grid function. +""" function metric_tensor(g::MappedGrid) return map(jacobian(g)) do ∂x∂ξ ∂x∂ξ'*∂x∂ξ end end +""" + metric_tensor_inverse(g::MappedGrid) + +The inverse of the metric tensor of `g` as a grid function. +""" function metric_tensor_inverse(g::MappedGrid) return map(jacobian(g)) do ∂x∂ξ inv(∂x∂ξ'*∂x∂ξ) @@ -145,7 +196,7 @@ """ normal(g::MappedGrid, boundary) -The outward pointing normal as a grid function on the boundary +The outward pointing normal as a grid function on the corresponding boundary grid. """ function normal(g::MappedGrid, boundary) b_indices = boundary_indices(g, boundary)