Merge pull request cb-geo#194 from cb-geo/map_remove

🏁 Remove elements from a map - fixes cb-geo#89

Author: kks32

CMakeLists.txt

@@ -106,7 +106,7 @@ SET(test_src
   ${mpm_SOURCE_DIR}/tests/mpm_explicit_test.cc
   ${mpm_SOURCE_DIR}/tests/mpm_explicit_test_unitcell.cc
   ${mpm_SOURCE_DIR}/tests/node_container_test.cc
-  ${mpm_SOURCE_DIR}/tests/node_handler_test.cc
+  ${mpm_SOURCE_DIR}/tests/node_map_test.cc
   ${mpm_SOURCE_DIR}/tests/node_test.cc
   ${mpm_SOURCE_DIR}/tests/particle_container_test.cc
   ${mpm_SOURCE_DIR}/tests/particle_test.cc

include/cell.h

@@ -9,8 +9,8 @@
 #include "Eigen/LU"
 
 #include "affine_transform.h"
-#include "handler.h"
 #include "logger.h"
+#include "map.h"
 #include "node_base.h"
 #include "shapefn.h"
 
@@ -235,10 +235,10 @@ class Cell {
   std::vector<Index> particles_;
 
   //! Container of node pointers (local id, node pointer)
-  Handler<NodeBase<Tdim>> nodes_;
+  Map<NodeBase<Tdim>> nodes_;
 
   //! Container of cell neighbours
-  Handler<Cell<Tdim>> neighbour_cells_;
+  Map<Cell<Tdim>> neighbour_cells_;
 
   //! Shape function
   std::shared_ptr<const ShapeFn<Tdim>> shapefn_{nullptr};

include/handler.h include/map.hinclude/handler.h renamed to include/map.h

@@ -1,5 +1,5 @@
-#ifndef MPM_HANDLER_H_
-#define MPM_HANDLER_H_
+#ifndef MPM_MAP_H_
+#define MPM_MAP_H_
 
 #include <algorithm>
 #include <unordered_map>
@@ -9,14 +9,14 @@ namespace mpm {
 // Global index type for the node
 using Index = unsigned long long;
 
-// handler class
+// Map class
 //! \brief A class that offers a container and iterators
 //! \tparam T A class with a template argument Tdim
 template <class T>
-class Handler {
+class Map {
  public:
   //! Default constructor
-  Handler<T>() = default;
+  Map<T>() = default;
 
   //! Insert a pointer
   //! \param[in] ptr A shared pointer
@@ -27,6 +27,10 @@ class Handler {
   //! \param[in] ptr A shared pointer
   bool insert(Index id, const std::shared_ptr<T>& ptr);
 
+  //! Remove a pointer at a given id
+  //! \param[in] id Global/local index of the pointer
+  bool remove(Index id);
+
   //! Return number of elements in the container
   std::size_t size() const { return elements_.size(); }
 
@@ -53,9 +57,9 @@ class Handler {
  private:
   // Unordered map of index and pointer
   std::unordered_map<Index, std::shared_ptr<T>> elements_;
-};  // Handler class
+};  // Map class
 
-#include "handler.tcc"
+#include "map.tcc"
 
 }  // namespace mpm
-#endif  // MPM_HANDLER_H_
+#endif  // MPM_MAP_H_

include/handler.tcc include/map.tccinclude/handler.tcc renamed to include/map.tcc

@@ -1,22 +1,28 @@
 //! Insert a pointer
 template <class T>
-bool mpm::Handler<T>::insert(const std::shared_ptr<T>& ptr) {
+bool mpm::Map<T>::insert(const std::shared_ptr<T>& ptr) {
   bool insertion_status =
       elements_.insert(std::make_pair(ptr->id(), ptr)).second;
   return insertion_status;
 }
 
 //! Insert a pointer at a given id
 template <class T>
-bool mpm::Handler<T>::insert(mpm::Index id, const std::shared_ptr<T>& ptr) {
+bool mpm::Map<T>::insert(mpm::Index id, const std::shared_ptr<T>& ptr) {
   bool insertion_status = elements_.insert(std::make_pair(id, ptr)).second;
   return insertion_status;
 }
 
+//! Remove a pointer at a given id
+template <class T>
+bool mpm::Map<T>::remove(mpm::Index id) {
+  return elements_.erase(id);
+}
+
 //! Iterate over elements in the container
 template <class T>
 template <class Tunaryfn>
-Tunaryfn mpm::Handler<T>::for_each(Tunaryfn fn) {
+Tunaryfn mpm::Map<T>::for_each(Tunaryfn fn) {
   for (const auto& element : elements_) {
     fn((element).second);
   }

include/mesh.h

@@ -196,7 +196,7 @@ class Mesh {
   unsigned id_{std::numeric_limits<unsigned>::max()};
 
   //! Container of mesh neighbours
-  Handler<Mesh<Tdim>> neighbour_meshes_;
+  Map<Mesh<Tdim>> neighbour_meshes_;
 
   //! Container of particles
   Container<ParticleBase<Tdim>> particles_;
@@ -205,7 +205,7 @@ class Mesh {
   Container<NodeBase<Tdim>> nodes_;
 
   //! Map of nodes for fast retrieval
-  Handler<NodeBase<Tdim>> map_nodes_;
+  Map<NodeBase<Tdim>> map_nodes_;
 
   //! Container of cells
   Container<Cell<Tdim>> cells_;

include/mesh.tcc

@@ -54,10 +54,9 @@ bool mpm::Mesh<Tdim>::add_node(
 template <unsigned Tdim>
 bool mpm::Mesh<Tdim>::remove_node(
     const std::shared_ptr<mpm::NodeBase<Tdim>>& node) {
+  const mpm::Index id = node->id();
   // Remove a node if found in the container
-  bool status = nodes_.remove(node);
-  // TODO: Remove node from map_nodes_
-  return status;
+  return (nodes_.remove(node) && map_nodes_.remove(id));
 }
 
 //! Iterate over nodes

tests/node_handler_test.cc tests/node_map_test.cctests/node_handler_test.cc renamed to tests/node_map_test.cc

@@ -6,11 +6,11 @@
 #include "Eigen/Dense"
 #include "catch.hpp"
 
-#include "handler.h"
+#include "map.h"
 #include "node.h"
 
-//! \brief Check node handler class for 2D case
-TEST_CASE("Node handler is checked for 2D case", "[nodehandler][2D]") {
+//! \brief Check node map class for 2D case
+TEST_CASE("Node map is checked for 2D case", "[nodemap][2D]") {
   // Dimension
   const unsigned Dim = 2;
   // Degrees of freedom
@@ -32,41 +32,52 @@ TEST_CASE("Node handler is checked for 2D case", "[nodehandler][2D]") {
   std::shared_ptr<mpm::NodeBase<Dim>> node2 =
       std::make_shared<mpm::Node<Dim, Dof, Nphases>>(id2, coords);
 
-  // Node handler
-  auto nodehandler = std::make_shared<mpm::Handler<mpm::NodeBase<Dim>>>();
+  // Node 3
+  mpm::Index id3 = 2;
+  std::shared_ptr<mpm::NodeBase<Dim>> node3 =
+      std::make_shared<mpm::Node<Dim, Dof, Nphases>>(id3, coords);
 
-  // Check insert node
-  SECTION("Check insert node functionality") {
+  // Node map
+  auto nodemap = std::make_shared<mpm::Map<mpm::NodeBase<Dim>>>();
+
+  // Check insert and remove node
+  SECTION("Check insert and remove node functionality") {
     // Insert node 1 and check status
-    bool status1 = nodehandler->insert(node1);
-    REQUIRE(status1 == true);
+    REQUIRE(nodemap->insert(node1) == true);
     // Insert node 2 and check status
-    bool status2 = nodehandler->insert(node2->id(), node2);
-    REQUIRE(status2 == true);
+    REQUIRE(nodemap->insert(node2->id(), node2) == true);
+    // Insert node 3 and check status
+    REQUIRE(nodemap->insert(node3->id(), node3) == true);
     // Check size of node hanlder
-    REQUIRE(nodehandler->size() == 2);
+    REQUIRE(nodemap->size() == 3);
+    // Remove node 3 and check status
+    REQUIRE(nodemap->remove(node3->id()) == true);
+    // Try to remove node 3 again
+    REQUIRE(nodemap->remove(node3->id()) == false);
+    // Check size of node hanlder
+    REQUIRE(nodemap->size() == 2);
   }
 
   SECTION("Check operator []") {
     // Insert node 1
-    nodehandler->insert(id1, node1);
+    nodemap->insert(id1, node1);
     // Insert node 2
-    nodehandler->insert(id2, node2);
+    nodemap->insert(id2, node2);
 
     // Check operator []
-    REQUIRE((*nodehandler)[0]->id() == id1);
-    REQUIRE((*nodehandler)[1]->id() == id2);
+    REQUIRE((*nodemap)[0]->id() == id1);
+    REQUIRE((*nodemap)[1]->id() == id2);
   }
 
   // Check iterator
   SECTION("Check node range iterator") {
     // Insert node 1
-    nodehandler->insert(node1);
+    nodemap->insert(node1);
     // Insert node 2
-    nodehandler->insert(node2);
+    nodemap->insert(node2);
     // Check size of node hanlder
     std::size_t counter = 0;
-    for (auto itr = nodehandler->begin(); itr != nodehandler->end(); ++itr) {
+    for (auto itr = nodemap->begin(); itr != nodemap->end(); ++itr) {
       auto coords = ((*itr).second)->coordinates();
       // Check if coordinates for each node is zero
       for (unsigned i = 0; i < coords.size(); ++i)
@@ -81,14 +92,14 @@ TEST_CASE("Node handler is checked for 2D case", "[nodehandler][2D]") {
   // Check for_each
   SECTION("Check node for_each") {
     // Insert node 1
-    nodehandler->insert(node1);
+    nodemap->insert(node1);
     // Insert node 2
-    nodehandler->insert(node2);
+    nodemap->insert(node2);
     // Check size of node hanlder
-    REQUIRE(nodehandler->size() == 2);
+    REQUIRE(nodemap->size() == 2);
 
     // Check coordinates before updating
-    for (auto itr = nodehandler->begin(); itr != nodehandler->end(); ++itr) {
+    for (auto itr = nodemap->begin(); itr != nodemap->end(); ++itr) {
       auto coords = ((*itr).second)->coordinates();
       // Check if coordinates for each node is zero
       for (unsigned i = 0; i < coords.size(); ++i)
@@ -98,13 +109,13 @@ TEST_CASE("Node handler is checked for 2D case", "[nodehandler][2D]") {
     // Set coordinates to unity
     coords << 1., 1.;
 
-    // Iterate through node handler to update coordinaates
-    nodehandler->for_each(  // function structure
+    // Iterate through node map to update coordinaates
+    nodemap->for_each(  // function structure
         std::bind(&mpm::NodeBase<Dim>::assign_coordinates,
                   std::placeholders::_1, coords));
 
     // Check if update has gone through
-    for (auto itr = nodehandler->begin(); itr != nodehandler->end(); ++itr) {
+    for (auto itr = nodemap->begin(); itr != nodemap->end(); ++itr) {
       auto coords = ((*itr).second)->coordinates();
       // Check if coordinates for each node is zero
       for (unsigned i = 0; i < coords.size(); ++i)
@@ -113,8 +124,8 @@ TEST_CASE("Node handler is checked for 2D case", "[nodehandler][2D]") {
   }
 }
 
-//! \brief Check node handler class for 3D case
-TEST_CASE("Node handler is checked for 3D case", "[nodehandler][3D]") {
+//! \brief Check node map class for 3D case
+TEST_CASE("Node map is checked for 3D case", "[nodemap][3D]") {
   // Dimension
   const unsigned Dim = 3;
   // Degrees of freedom
@@ -136,41 +147,52 @@ TEST_CASE("Node handler is checked for 3D case", "[nodehandler][3D]") {
   std::shared_ptr<mpm::NodeBase<Dim>> node2 =
       std::make_shared<mpm::Node<Dim, Dof, Nphases>>(id2, coords);
 
-  // Node handler
-  auto nodehandler = std::make_shared<mpm::Handler<mpm::NodeBase<Dim>>>();
+  // Node 3
+  mpm::Index id3 = 2;
+  std::shared_ptr<mpm::NodeBase<Dim>> node3 =
+      std::make_shared<mpm::Node<Dim, Dof, Nphases>>(id3, coords);
+
+  // Node map
+  auto nodemap = std::make_shared<mpm::Map<mpm::NodeBase<Dim>>>();
 
   // Check insert node
   SECTION("Check insert node functionality") {
     // Insert node 1 and check status
-    bool status1 = nodehandler->insert(node1);
-    REQUIRE(status1 == true);
+    REQUIRE(nodemap->insert(node1) == true);
     // Insert node 2 and check status
-    bool status2 = nodehandler->insert(node2->id(), node2);
-    REQUIRE(status2 == true);
+    REQUIRE(nodemap->insert(node2->id(), node2) == true);
+    // Insert node 3 and check status
+    REQUIRE(nodemap->insert(node3->id(), node3) == true);
+    // Check size of node hanlder
+    REQUIRE(nodemap->size() == 3);
+    // Remove node 3 and check status
+    REQUIRE(nodemap->remove(node3->id()) == true);
+    // Try to remove node 3 again
+    REQUIRE(nodemap->remove(node3->id()) == false);
     // Check size of node hanlder
-    REQUIRE(nodehandler->size() == 2);
+    REQUIRE(nodemap->size() == 2);
   }
 
   SECTION("Check operator []") {
     // Insert node 1
-    nodehandler->insert(id1, node1);
+    nodemap->insert(id1, node1);
     // Insert node 2
-    nodehandler->insert(id2, node2);
+    nodemap->insert(id2, node2);
 
     // Check operator []
-    REQUIRE((*nodehandler)[0]->id() == id1);
-    REQUIRE((*nodehandler)[1]->id() == id2);
+    REQUIRE((*nodemap)[0]->id() == id1);
+    REQUIRE((*nodemap)[1]->id() == id2);
   }
 
   // Check iterator
   SECTION("Check node range iterator") {
     // Insert node 1
-    nodehandler->insert(node1);
+    nodemap->insert(node1);
     // Insert node 2
-    nodehandler->insert(node2);
+    nodemap->insert(node2);
     // Check size of node hanlder
     std::size_t counter = 0;
-    for (auto itr = nodehandler->begin(); itr != nodehandler->end(); ++itr) {
+    for (auto itr = nodemap->begin(); itr != nodemap->end(); ++itr) {
       auto coords = ((*itr).second)->coordinates();
       // Check if coordinates for each node is zero
       for (unsigned i = 0; i < coords.size(); ++i)
@@ -185,13 +207,13 @@ TEST_CASE("Node handler is checked for 3D case", "[nodehandler][3D]") {
   // Check for_each
   SECTION("Check node for_each") {
     // Insert node 1
-    nodehandler->insert(node1);
+    nodemap->insert(node1);
     // Insert node 2
-    nodehandler->insert(node2);
+    nodemap->insert(node2);
     // Check size of node hanlder
-    REQUIRE(nodehandler->size() == 2);
+    REQUIRE(nodemap->size() == 2);
 
-    for (auto itr = nodehandler->begin(); itr != nodehandler->end(); ++itr) {
+    for (auto itr = nodemap->begin(); itr != nodemap->end(); ++itr) {
       auto coords = ((*itr).second)->coordinates();
       // Check if coordinates for each node is zero
       for (unsigned i = 0; i < coords.size(); ++i)
@@ -201,14 +223,14 @@ TEST_CASE("Node handler is checked for 3D case", "[nodehandler][3D]") {
     // Set coordinates to unity
     coords << 1., 1., 1.;
 
-    // Iterate through node handler to update coordinaates
-    nodehandler->for_each(
+    // Iterate through node map to update coordinaates
+    nodemap->for_each(
         // function structure
         std::bind(&mpm::NodeBase<Dim>::assign_coordinates,
                   std::placeholders::_1, coords));
 
     // Check if update has gone through
-    for (auto itr = nodehandler->begin(); itr != nodehandler->end(); ++itr) {
+    for (auto itr = nodemap->begin(); itr != nodemap->end(); ++itr) {
       auto coords = ((*itr).second)->coordinates();
       // Check if coordinates for each node is zero
       for (unsigned i = 0; i < coords.size(); ++i)