]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Fix documentation of cylindrical manifold
authorMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Tue, 5 Mar 2019 17:39:31 +0000 (18:39 +0100)
committerMartin Kronbichler <kronbichler@lnm.mw.tum.de>
Tue, 5 Mar 2019 17:39:31 +0000 (18:39 +0100)
include/deal.II/grid/manifold_lib.h

index 6eb5d7e328783952c44bb9171dcd69fc3448359f..a550c26613faf4cb25d50ea08cacea042236c888 100644 (file)
@@ -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<spacedim> &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<spacedim>
   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;

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.