changeset 1805:0c705f0bb3a9 feature/grids/curvilinear

Add docstring for normal(g,b,i...)
author Jonatan Werpers <jonatan@werpers.com>
date Wed, 02 Oct 2024 20:57:40 +0200
parents 34ddb953a986
children f21bfc5f21aa
files src/Grids/mapped_grid.jl
diffstat 1 files changed, 5 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/mapped_grid.jl	Wed Oct 02 11:04:35 2024 -0700
+++ b/src/Grids/mapped_grid.jl	Wed Oct 02 20:57:40 2024 +0200
@@ -183,6 +183,11 @@
     end
 end
 
+"""
+    normal(g::MappedGrid, boundary, i...)
+
+The outward pointing normal to the specified boundary in grid point `i`.
+"""
 function normal(g::MappedGrid, boundary, i...)
     σ = _boundary_sign(component_type(g), boundary)
     ∂ξ∂x = inv(jacobian(g)[i...])