changeset 2070:c68fa6c74477 feature/grids/geometry_functions

Explain parametrizations in docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Tue, 17 Feb 2026 20:25:13 +0100
parents 15f27fea9929
children 9e9c56f5a656
files src/Grids/geometry.jl
diffstat 1 files changed, 6 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/geometry.jl	Tue Feb 17 20:15:37 2026 +0100
+++ b/src/Grids/geometry.jl	Tue Feb 17 20:25:13 2026 +0100
@@ -6,12 +6,11 @@
 end
 
 
-# REVIEW:
-# 1.    Explain the parametrization, i.e., l(1) = p + s*t
 """
     Line(p,t)
 
 A line, as a callable object, starting at `p` with tangent `t`.
+The parametrization is ``l(s) = p + st``.
 
 # Example
 ```julia-repl
@@ -51,14 +50,11 @@
 end
 
 
-# REVIEW:
-# 1.    Explain the parametrization.
-# 3.    Do we want s in [0, 1]? Currently the line segment
-#       can return values "outside" of the interval [a,b].
 """
     LineSegment(a,b)
 
 A line segment, as a callable object, from `a` to `b`.
+The parametrization is ``l(s) = (1-s)a + s*b`` where ``s\in(0,1)``.
 
 # Example
 ```julia-repl
@@ -236,12 +232,15 @@
 end
 
 # REVIEW:
-# 1.    Explain parametrisation
 # 2.    Boundscheck for the parametrisation argumetns, i.e. within [0,1]?
 """
     TransfiniteInterpolationSurface(c₁, c₂, c₃, c₄)
 
 A surface defined by the transfinite interpolation of the curves `c₁`, `c₂`, `c₃`, and  `c₄`.
+The transfinite interpolation maps the unit square ([0,1]⊗[0,1]) to the patch delimited by the given curves.
+The curves should encircle the patch counterclockwise.
+
+See https://en.wikipedia.org/wiki/Transfinite_interpolation for more information on transfinite interpolation.
 """
 struct TransfiniteInterpolationSurface{T1,T2,T3,T4}
     c₁::T1