From a0f02dedcde22b485d0a2ed24f700894785d2e2c Mon Sep 17 00:00:00 2001 From: Martin Kronbichler Date: Tue, 5 Mar 2019 18:39:31 +0100 Subject: [PATCH] Fix documentation of cylindrical manifold --- include/deal.II/grid/manifold_lib.h | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/include/deal.II/grid/manifold_lib.h b/include/deal.II/grid/manifold_lib.h index 6eb5d7e328..a550c26613 100644 --- a/include/deal.II/grid/manifold_lib.h +++ b/include/deal.II/grid/manifold_lib.h @@ -406,17 +406,19 @@ public: clone() const override; /** - * Compute the Cartesian coordinates for a point given in cylindrical - * coordinates. + * Compute the cylindrical coordinates $(r, \phi, \lambda)$ for the given + * space point where $r$ denotes the distance from the axis, + * $\phi$ the angle between the given point and the computed normal + * direction, and $\lambda$ the axial position. */ virtual Point<3> pull_back(const Point &space_point) const override; /** - * Compute the cylindrical coordinates $(r, \phi, \lambda)$ for the given - * point where $r$ denotes the distance from the axis, - * $\phi$ the angle between the given point and the computed normal - * direction and $\lambda$ the axial position. + * Compute the Cartesian coordinates for a chart point given in cylindrical + * coordinates $(r, \phi, \lambda)$, where $r$ denotes the distance from the + * axis, $\phi$ the angle between the given point and the computed normal + * direction, and $\lambda$ the axial position. */ virtual Point push_forward(const Point<3> &chart_point) const override; @@ -425,7 +427,7 @@ public: * Compute the derivatives of the mapping from cylindrical coordinates * $(r, \phi, \lambda)$ to cartesian coordinates where $r$ denotes the * distance from the axis, $\phi$ the angle between the given point and the - * computed normal direction and $\lambda$ the axial position. + * computed normal direction, and $\lambda$ the axial position. */ virtual DerivativeForm<1, 3, spacedim> push_forward_gradient(const Point<3> &chart_point) const override; -- 2.39.5