doxygen fix

GEOS-DEV · Dec 23, 2024 · 4150280 · 4150280
1 parent 7784585
commit 4150280
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 8 deletions.
diff --git a/src/coreComponents/mesh/generators/CellBlock.hpp b/src/coreComponents/mesh/generators/CellBlock.hpp
@@ -196,9 +196,17 @@ class CellBlock : public CellBlockABC
   arrayView1d< globalIndex const > localToGlobalMapConstView() const
   { return m_localToGlobalMap.toViewConst(); }
 
+  /**
+   * @brief Get global to local map.
+   * @return The mapping relationship.
+   */
   unordered_map< globalIndex, localIndex > & globalToLocalMap()
   { return m_globalToLocalMap; }
 
+  /**
+   * @brief Get global to local map, const version.
+   * @return The mapping relationship.
+   */
   unordered_map< globalIndex, localIndex > const & globalToLocalMap() const
   { return m_globalToLocalMap; }
 

diff --git a/src/coreComponents/mesh/generators/EmbeddedSurfaceBlock.cpp b/src/coreComponents/mesh/generators/EmbeddedSurfaceBlock.cpp
@@ -96,4 +96,19 @@ void EmbeddedSurfaceBlock::setEmbeddedSurfElemNodes( ArrayOfArrays< real64 > &&
   m_embeddedSurfElemNodesCoords = _embeddedSurfElemNodes;
 }
 
+unordered_map< globalIndex, localIndex > & EmbeddedSurfaceBlock::globalToLocalMap()
+{
+  return m_globalToLocalMap;
+}
+
+unordered_map< globalIndex, localIndex > const & EmbeddedSurfaceBlock::globalToLocalMap() const
+{
+  return m_globalToLocalMap;
+}
+
+void EmbeddedSurfaceBlock::setGlobalToLocalMap( unordered_map< globalIndex, localIndex > && g2l )
+{
+  m_globalToLocalMap = g2l;
+}
+
 }
diff --git a/src/coreComponents/mesh/generators/EmbeddedSurfaceBlock.hpp b/src/coreComponents/mesh/generators/EmbeddedSurfaceBlock.hpp
@@ -102,16 +102,22 @@ class EmbeddedSurfaceBlock : public EmbeddedSurfaceBlockABC
    */
   void setEmbeddedSurfElemPermeability( array1d< real64 > && _perms );
 
-  unordered_map< globalIndex, localIndex > & globalToLocalMap()
-  { return m_globalToLocalMap; }
+  /**
+   * @brief Get global to local map.
+   * @return The mapping relationship.
+   */
+  unordered_map< globalIndex, localIndex > & globalToLocalMap();
 
-  unordered_map< globalIndex, localIndex > const & globalToLocalMap() const
-  { return m_globalToLocalMap; }
+  /**
+   * @brief Get global to local map, const version.
+   * @return The mapping relationship.
+   */
+  unordered_map< globalIndex, localIndex > const & globalToLocalMap() const;
 
-  void setGlobalToLocalMap( unordered_map< globalIndex, localIndex > && g2l )
-  {
-    m_globalToLocalMap = g2l;
-  }
+  /**
+   * @brief Set global to local map from a provided mapping.
+   */
+  void setGlobalToLocalMap( unordered_map< globalIndex, localIndex > && g2l );
 
 private: