Merge pull request #1427 from DLR-AMR/typos-and-unused-code

Correct some typos and remove unused code

src/t8_cmesh/t8_cmesh_examples.h

@@ -102,7 +102,7 @@ t8_cmesh_new_hypercube (t8_eclass_t eclass, sc_MPI_Comm comm, int do_bcast, int
  * \param [in] polygons_x   The number of polygons along the x-axis.
  * \param [in] polygons_y   The number of polygons along the y-axis.
  *                              Only required if \a eclass is 2D or 3D.
- * \param [in] polygons_z       The number of polygons along the z-axis.
+ * \param [in] polygons_z   The number of polygons along the z-axis.
  *                              Only required if \a eclass is 3D.
  * \param [in] use_axis_aligned Use the axis-aligned geometry. If used, only two points per tree are stored.
  * \return                      A committed t8_cmesh structure with 
@@ -140,7 +140,7 @@ t8_cmesh_new_hypercube_pad (const t8_eclass_t eclass, sc_MPI_Comm comm, const do
  * \param [in] polygons_x   The number of polygons along the x-axis.
  * \param [in] polygons_y   The number of polygons along the y-axis.
  *                              Only required if \a eclass is 2D or 3D.
- * \param [in] polygons_z       The number of polygons along the z-axis.
+ * \param [in] polygons_z   The number of polygons along the z-axis.
  *                              Only required if \a eclass is 3D.
  * \param [in] periodic_x   Connect opposite sides of the hypercube in x-direction.
  * \param [in] periodic_y   Connect opposite sides of the hypercube in y-direction.

test/t8_cmesh_generator/t8_cmesh_parameterized_examples/t8_cmesh_params.hxx

@@ -34,10 +34,6 @@
 #include <t8_geometry/t8_geometry_implementations/t8_geometry_linear.hxx>
 #include <t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.hxx>
 
-#define T8_CMESH_TEST_NUM_COMMS 1
-#define T8_CMESH_BINARY 2
-#define T8_CMESH_DIM_RANGE 4 /* this is the dim range for hypercube hybrid and empty cmesh */
-#define T8_CMESH_MAX_TEST_DIMS 3
 #if T8CODE_TEST_LEVEL == 1
 #define T8_CMESH_MAX_NUM_OF_TREES 5
 #define T8_CMESH_MAX_NUM_OF_PRISMS 5
@@ -90,8 +86,6 @@ std::vector<t8_eclass_t> all_eclasses
 
 std::vector<int> do_bcast = { 0, 1 };
 std::vector<int> partition = { 0, 1 };
-/* Currently a dummy vector for examples that have partition argument but not fully support it yet */
-std::vector<int> no_partition = { 0 };
 
 std::vector<int> periodic = { 0, 1 };
 /* Currently a dummy vector for examples that have periodic argument but not fully support it yet */

test/t8_forest/t8_gtest_forest_commit.cxx

@@ -127,7 +127,7 @@ t8_test_forest_commit_abp_3step (t8_forest_t forest, int maxlevel)
   t8_forest_set_balance (forest_balance, forest_adapt, 0);
   t8_forest_commit (forest_balance);
 
-  /* partrition the forest */
+  /* partition the forest */
   t8_forest_set_partition (forest_partition, forest_balance, 0);
   t8_forest_commit (forest_partition);
 

test/t8_forest/t8_gtest_ghost_exchange.cxx

@@ -31,8 +31,6 @@
 #include <test/t8_gtest_macros.hxx>
 #include <test/t8_gtest_schemes.hxx>
 
-/* TODO: when this test works for all cmeshes remove if statement in test_cmesh_ghost_exchange_all () */
-
 /* This test program tests the forest ghost exchange routine.
  * Given a forest for which the ghost layer was created and an array
  * storing data for the local elements and the ghost elements, ghost_exchange

test/t8_forest_incomplete/t8_gtest_iterate_replace.cxx

@@ -117,7 +117,7 @@ t8_forest_replace (t8_forest_t forest_old, t8_forest_t forest_new, t8_locidx_t w
     ASSERT_EQ (num_outgoing, family_size);
     /* End check family */
 
-    /* If element got coarsen, only the first element
+    /* If element got coarsened, only the first element
      * should be called in the callback of forest_adapt. */
     for (t8_locidx_t i = 1; i < num_outgoing; i++) {
       ASSERT_EQ (adapt_data->callbacks[elidx_old + i], -3);
@@ -138,7 +138,7 @@ t8_forest_replace (t8_forest_t forest_old, t8_forest_t forest_new, t8_locidx_t w
   }
 }
 
-/** For each locale element: Remove, coarsen, leave untouched, or refine it depending on its index.
+/** For each local element: Remove, coarsen, leave untouched, or refine it depending on its index.
  *      if \a lelement_id mod 12 < 3  -> leave element untouched
  * else if \a lelement_id mod 12 < 6  -> coarse element
  * else if \a lelement_id mod 12 < 9  -> remove element

test/t8_schemes/t8_gtest_nca.cxx

@@ -151,7 +151,7 @@ TEST_P (nca, nca_check_deep)
  * \param[in] parent_a          An initialized element, descendant of \a correct_nca, not a descendant or ancestor of \a parent_b. \a desc_a will be a child of it
  * \param[in] parent_b          An initialized element, descendant of \a correct_nca, not a descendant or ancestor of \a parent_a. \a desc_b will be a child of it
  * \param[in] max_lvl           The maximal depth of the recursion
- * \param[in] scheme                the scheme to use
+ * \param[in] scheme            The scheme to use
  */
 static void
 t8_recursive_nca_check (t8_element_t *check_nca, t8_element_t *desc_a, t8_element_t *desc_b, t8_element_t *check,
@@ -284,7 +284,7 @@ TEST_P (nca, recursive_check_higher_level)
     /* Initialization for recursive_nca_check */
     num_children = scheme->element_get_num_children (tree_class, correct_nca_high_level);
     if (num_children > 1) {
-      /* Compute children on to different branches in the tree an test them. 
+      /* Compute children on two different branches in the tree an test them. 
        * This ensures, that the nca of all their descendants has to be correct_nca_high_level*/
       for (k = 0; k < num_children; k++) {
         scheme->element_get_child (tree_class, correct_nca_high_level, k, parent_a);