]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Use @pre instead of @note in a number of places. 9333/head
authorWolfgang Bangerth <bangerth@colostate.edu>
Wed, 15 Jan 2020 05:24:02 +0000 (22:24 -0700)
committerWolfgang Bangerth <bangerth@colostate.edu>
Wed, 15 Jan 2020 15:57:52 +0000 (08:57 -0700)
include/deal.II/grid/grid_generator.h

index 03e036258fa873098e1257b7d5166350345372a2..8126aae9f56f04f2fd10b815ae4bc94ee1d81437 100644 (file)
@@ -86,7 +86,8 @@ namespace GridGenerator
    * cells. See hyper_rectangle(), if different lengths in different ordinate
    * directions are required.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim, int spacedim>
   void
@@ -140,7 +141,8 @@ namespace GridGenerator
    * dimensional space with the remaining entries set to zero. For example, a
    * <tt>Triangulation@<2,3@></tt> will be a square in the xy plane with z=0.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    *
    * @param tria The triangulation to create. It needs to be empty upon
    * calling this function.
@@ -196,7 +198,8 @@ namespace GridGenerator
    * <tt>Triangulation@<2,3@></tt> will be a rectangle in the xy plane with
    * z=0, defined by the two opposing corners @p p1 and @p p2.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim, int spacedim>
   void
@@ -551,7 +554,8 @@ namespace GridGenerator
    * vertices in the array of <code>corners</code> will no longer refer to the
    * same triangulation.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -567,7 +571,8 @@ namespace GridGenerator
    * of subdivisions in each of the @p dim directions. Colorizing is done
    * according to hyper_rectangle().
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -581,7 +586,8 @@ namespace GridGenerator
    * number of subdivisions in each of the @p dim directions may vary.
    * Colorizing is done according to hyper_rectangle().
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -638,7 +644,8 @@ namespace GridGenerator
    *
    * Presently only available in 2d and 3d.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -721,7 +728,8 @@ namespace GridGenerator
    *   what you see visualized is not necessarily exactly what is
    *   happening.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -752,7 +760,8 @@ namespace GridGenerator
    * @image html sphere.png
    * @image html sphere_section.png
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
 
   template <int spacedim>
@@ -768,7 +777,7 @@ namespace GridGenerator
    * boundary and 1 for the cut plane. The manifold id for the curved boundary
    * is set to zero, and a SphericalManifold is attached to it.
    *
-   * @note The triangulation passed as argument needs to be empty when calling
+   * @pre The triangulation passed as argument needs to be empty when calling
    * this function.
    */
   template <int dim>
@@ -786,7 +795,8 @@ namespace GridGenerator
    * boundary and 1 for the cut plane. The manifold id for the curved boundary
    * is set to zero, and a SphericalManifold is attached to it.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -819,7 +829,8 @@ namespace GridGenerator
    * The manifold id for the hull of the cylinder is set to zero, and a
    * CylindricalManifold is attached to it.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -854,7 +865,8 @@ namespace GridGenerator
    * @image html truncated_cone_2d.png
    * @image html truncated_cone_3d.png
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    *
    * @author Markus B&uuml;rg, 2009
    */
@@ -931,7 +943,8 @@ namespace GridGenerator
    * This function exists for triangulations of all space
    * dimensions, but throws an error if called in 1d.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -995,7 +1008,8 @@ namespace GridGenerator
    * with boundary id 1 and 2, respectively (see
    * @ref GlossColorization "the glossary entry on colorization").
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -1040,7 +1054,8 @@ namespace GridGenerator
    * @note This function is declared to exist for triangulations of all space
    * dimensions, but throws an error if called in 1d.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -1081,7 +1096,8 @@ namespace GridGenerator
    * declared to exist for triangulations of all space dimensions, but throws an
    * error if called in 1d.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -1116,7 +1132,8 @@ namespace GridGenerator
    * All manifold ids are set to zero, and a SphericalManifold is attached
    * to the triangulation.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -1150,7 +1167,8 @@ namespace GridGenerator
    * All manifold ids are set to zero, and a SphericalManifold is attached
    * to the triangulation.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    */
   template <int dim>
   void
@@ -1178,7 +1196,8 @@ namespace GridGenerator
    * All manifold ids are set to zero, and a CylindricalManifold is attached
    * to the triangulation.
    *
-   * @note The triangulation passed as argument needs to be empty when calling this function.
+   * @pre The triangulation passed as argument needs to be empty when calling
+   * this function.
    *
    * @image html cylinder_shell.png
    *
@@ -1564,7 +1583,7 @@ namespace GridGenerator
    * triangulation_2 have the same manifold descriptions. The output
    * Triangulation @p has the same manifold ids as these two triangulations.
    *
-   * @pre Both of the source conditions need to be available entirely locally.
+   * @note Both of the source conditions need to be available entirely locally.
    * In other words, they can not be objects of type
    * parallel::distributed::Triangulation.
    */
@@ -1663,7 +1682,7 @@ namespace GridGenerator
    * Note that numbers::flat_manifold_id (should it be a manifold id of @p
    * input) will always be the last entry in the first category.
    *
-   * @note The 2d input triangulation @p input must be a
+   * @pre The 2d input triangulation @p input must be a
    * @ref GlossCoarseMesh "coarse mesh",
    * i.e., it cannot have any
    * refined cells.
@@ -1690,7 +1709,7 @@ namespace GridGenerator
    * walls in z direction. The bottom and top get the next two free boundary
    * indicators.
    *
-   * @note The 2d input triangulation @p input must be a
+   * @pre The 2d input triangulation @p input must be a
    * @ref GlossCoarseMesh "coarse mesh",
    * i.e., it cannot have any
    * refined cells.

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.