Merge branch 'handle-neighbor-and-ghost' into handle_element-data

Author: lenaploetzke

mesh_handle/element.hxx

@@ -349,41 +349,47 @@ class element: public TCompetence<element<mesh_class, TCompetence...>>... {
     }
   }
 
-  //--- Getter for the member variables. ---
+  // --- Function to access mesh specific id. ---
   /**
-   * Getter for the tree id of the element.
-   * \return The element's local tree id.
+   * Getter for the index of the element in the mesh to which the element belongs.
+   * \return The local element id of the element in the mesh.
    */
   t8_locidx_t
-  get_local_tree_id () const
+  get_element_handle_id () const
   {
-    return m_tree_id;
+    if (m_is_ghost_element) {
+      return m_mesh->get_num_local_elements ()
+             + t8_forest_ghost_get_tree_element_offset (m_mesh->m_forest,
+                                                        m_tree_id - t8_forest_get_num_local_trees (m_mesh->m_forest))
+             + m_element_id;
+    }
+    return t8_forest_get_tree_element_offset (m_mesh->m_forest, m_tree_id) + m_element_id;
   }
 
+  //--- Getter for the member variables. ---
   /**
-   * Getter for the local element id in the tree of the element.
-   * \return The local element id in the tree of the element.
+   * Getter for the tree id of the element in the forest related to the mesh.
+   * \warning This is related to t8code's tree structure and should not be confused with \ref mesh specific ids.
+   * This function is mainly relevant for writing custom competences that need to access t8code functionality.
+   * \return The element's local tree id in the forest.
    */
   t8_locidx_t
-  get_local_element_id () const
+  get_local_tree_id () const
   {
-    return m_element_id;
+    return m_tree_id;
   }
 
   /**
-   * Getter for the flat local element id. This is the local index of the element in the mesh to which the element belongs.
-   * \return The flat local element id of the element.
+   * Getter for the local element id in the tree of the element in the forest related to the mesh.
+   * \warning This is related to t8code's tree structure and should not be confused with \ref mesh specific ids.
+   * For mesh specific id use \ref get_element_handle_id. 
+   * This function is mainly relevant for writing custom competences that need to access t8code functionality.
+   * \return The local element id in the tree of the element in the forest.
    */
   t8_locidx_t
-  get_flat_element_id () const
+  get_local_element_id () const
   {
-    if (m_is_ghost_element) {
-      return m_mesh->get_num_local_elements ()
-             + t8_forest_ghost_get_tree_element_offset (m_mesh->m_forest,
-                                                        m_tree_id - t8_forest_get_num_local_trees (m_mesh->m_forest))
-             + m_element_id;
-    }
-    return t8_forest_get_tree_element_offset (m_mesh->m_forest, m_tree_id) + m_element_id;
+    return m_element_id;
   }
 
   /**
@@ -416,7 +422,7 @@ class element: public TCompetence<element<mesh_class, TCompetence...>>... {
   const E&
   get_element_data () const
   {
-    return m_mesh->m_element_data[get_flat_element_id ()];
+    return m_mesh->m_element_data[get_element_handle_id ()];
   }
 
   /** 
@@ -431,7 +437,7 @@ class element: public TCompetence<element<mesh_class, TCompetence...>>... {
     SC_CHECK_ABORT (!m_is_ghost_element, "Element data cannot be set for ghost elements.\n");
     // Resize for the case that no data vector has been set previously.
     m_mesh->m_element_data.resize (m_mesh->get_num_local_elements () + m_mesh->get_num_ghosts ());
-    m_mesh->m_element_data[get_flat_element_id ()] = element_data;
+    m_mesh->m_element_data[get_element_handle_id ()] = element_data;
   }
 
  private:

test/mesh_handle/t8_gtest_ghost.cxx

@@ -135,7 +135,7 @@ TEST_P (t8_mesh_ghost_test, compare_neighbors_to_forest)
         EXPECT_EQ (num_neighbors, (int) neighbors_handle.size ());
         EXPECT_EQ (dual_faces_handle, std::vector<int> (dual_faces, dual_faces + num_neighbors));
         for (int ineighs = 0; ineighs < num_neighbors; ineighs++) {
-          EXPECT_EQ (neighbors_handle[ineighs]->get_flat_element_id (), neigh_ids[ineighs]);
+          EXPECT_EQ (neighbors_handle[ineighs]->get_element_handle_id (), neigh_ids[ineighs]);
         }
         for (int ineigh = 0; ineigh < num_neighbors; ineigh++) {
           EXPECT_EQ (scheme->element_get_shape (neigh_eclass, neighbors[ineigh]),