]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Move function coordinate_to_one_dim_higher to an internal namespace.
authorSimon Sticko <simon@sticko.se>
Tue, 7 Apr 2020 18:48:05 +0000 (20:48 +0200)
committerSimon Sticko <simon@sticko.se>
Wed, 8 Apr 2020 12:38:59 +0000 (14:38 +0200)
include/deal.II/base/bounding_box.h
source/base/bounding_box.cc
tests/base/coordinate_to_one_dim_higher.cc

index 2f2b77d2d3eabce97b31a4c8bdecb48ebba86adf..3333bd744f8062b82e916a53e55480153e96b95f 100644 (file)
@@ -276,51 +276,54 @@ BoundingBox<dim, Number>
 create_unit_bounding_box();
 
 
-/**
- * This function defines a convention for how coordinates in dim
- * dimensions should translate to the coordinates in dim + 1 dimensions,
- * when one of the coordinates in dim + 1 dimensions is locked to a given
- * value.
- *
- * The convention is the following: Starting from the locked coordinate we
- * store the lower dimensional coordinates consecutively and wrapping
- * around when going over the dimension. This relationship can be
- * described by the following tables:
- *
- *                        2D
- * ------------------------------------------------
- * | locked in 2D | 1D coordinate | 2D coordinate |
- * |--------------------------------------------- |
- * |     x0       |      (a)      |   (x0,  a)    |
- * |     x1       |      (a)      |   (a , x1)    |
- * ------------------------------------------------
- *
- *                       3D
- * --------------------------------------------------
- * | locked in 3D | 2D coordinates | 3D coordinates |
- * |----------------------------------------------- |
- * |     x0       |    (a, b)      | (x0,  a,  b)   |
- * |     x1       |    (a, b)      | ( b, x1,  a)   |
- * |     x2       |    (a, b)      | ( a,  b, x2)   |
- * --------------------------------------------------
- *
- * Given a locked coordinate, this function maps a coordinate index in dim
- * dimension to a coordinate index in dim + 1 dimensions.
- *
- * @param locked_coordinate should be in the range [0, dim+1).
- * @param coordiante_in_dim should be in the range [0, dim).
- * @return A coordinate index in the range [0, dim+1)
- */
-template <int dim>
-inline unsigned int
-coordinate_to_one_dim_higher(const unsigned int locked_coordinate,
-                             const unsigned int coordiante_in_dim)
+namespace internal
 {
-  AssertIndexRange(locked_coordinate, dim + 1);
-  AssertIndexRange(coordiante_in_dim, dim);
-  return (locked_coordinate + coordiante_in_dim + 1) % (dim + 1);
-}
-
+  /**
+   * This function defines a convention for how coordinates in dim
+   * dimensions should translate to the coordinates in dim + 1 dimensions,
+   * when one of the coordinates in dim + 1 dimensions is locked to a given
+   * value.
+   *
+   * The convention is the following: Starting from the locked coordinate we
+   * store the lower dimensional coordinates consecutively and wrapping
+   * around when going over the dimension. This relationship can be
+   * described by the following tables:
+   *
+   *                        2D
+   * ------------------------------------------------
+   * | locked in 2D | 1D coordinate | 2D coordinate |
+   * |--------------------------------------------- |
+   * |     x0       |      (a)      |   (x0,  a)    |
+   * |     x1       |      (a)      |   (a , x1)    |
+   * ------------------------------------------------
+   *
+   *                       3D
+   * --------------------------------------------------
+   * | locked in 3D | 2D coordinates | 3D coordinates |
+   * |----------------------------------------------- |
+   * |     x0       |    (a, b)      | (x0,  a,  b)   |
+   * |     x1       |    (a, b)      | ( b, x1,  a)   |
+   * |     x2       |    (a, b)      | ( a,  b, x2)   |
+   * --------------------------------------------------
+   *
+   * Given a locked coordinate, this function maps a coordinate index in dim
+   * dimension to a coordinate index in dim + 1 dimensions.
+   *
+   * @param locked_coordinate should be in the range [0, dim+1).
+   * @param coordiante_in_dim should be in the range [0, dim).
+   * @return A coordinate index in the range [0, dim+1)
+   */
+  template <int dim>
+  inline unsigned int
+  coordinate_to_one_dim_higher(const unsigned int locked_coordinate,
+                               const unsigned int coordiante_in_dim)
+  {
+    AssertIndexRange(locked_coordinate, dim + 1);
+    AssertIndexRange(coordiante_in_dim, dim);
+    return (locked_coordinate + coordiante_in_dim + 1) % (dim + 1);
+  }
+
+} // namespace internal
 
 /*------------------------ Inline functions: BoundingBox --------------------*/
 
index 873445bbe9ba459aecefcbdaf680b1cd12d5c76f..3e886332cbba9fbcfc562bbb8caae39b85d0823b 100644 (file)
@@ -301,7 +301,7 @@ BoundingBox<spacedim, Number>::cross_section(const unsigned int direction) const
   for (unsigned int d = 0; d < spacedim - 1; ++d)
     {
       const int index_to_write_from =
-        coordinate_to_one_dim_higher<spacedim - 1>(direction, d);
+        internal::coordinate_to_one_dim_higher<spacedim - 1>(direction, d);
 
       cross_section_lower_upper_corner.first[d] =
         boundary_points.first[index_to_write_from];
index 26973e96080a18cdb3ea4561626bb092a061f50f..f903f789690d9ac8ea30b0b02df8d9e17a88a999 100644 (file)
@@ -33,7 +33,8 @@ print_what_each_coordinate_maps_to()
       deallog << "locked coordinate = " << locked << std::endl;
       for (unsigned int i = 0; i < dim; ++i)
         {
-          deallog << i << " -> " << coordinate_to_one_dim_higher<dim>(locked, i)
+          deallog << i << " -> "
+                  << internal::coordinate_to_one_dim_higher<dim>(locked, i)
                   << std::endl;
         }
     }

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.