Add Elem::n_nodes_on_edge

loganharbour · loganharbour · commit 718c60aa5619 · 2022-11-09T13:39:24.000-07:00
diff --git a/include/geom/cell_hex20.h b/include/geom/cell_hex20.h
@@ -247,6 +247,12 @@ class Hex20 final : public Hex
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<Hex20>(s); }
 
+  /**
+   * \returns 3. Every edge has two nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Hex20>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_hex27.h b/include/geom/cell_hex27.h
@@ -265,6 +265,12 @@ class Hex27 final : public Hex
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<Hex27>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Hex27>(e); }
+
 protected:
 
 
diff --git a/include/geom/cell_hex8.h b/include/geom/cell_hex8.h
@@ -222,6 +222,12 @@ class Hex8 final : public Hex
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<Hex8>(s); }
 
+  /**
+   * \returns 2. Every edge has two nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Hex8>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_inf_hex16.h b/include/geom/cell_inf_hex16.h
@@ -242,6 +242,9 @@ class InfHex16 final : public InfHex
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side<InfHex16, 2>(s); }
 
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<InfHex16>(e) - ((e < 4) ? 0 : 1); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_inf_hex18.h b/include/geom/cell_inf_hex18.h
@@ -257,6 +257,9 @@ class InfHex18 final : public InfHex
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side<InfHex18, 3>(s); }
 
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<InfHex18>(e) - ((e < 4) ? 0 : 1); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_inf_hex8.h b/include/geom/cell_inf_hex8.h
@@ -195,6 +195,12 @@ class InfHex8 final : public InfHex
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<InfHex8>(s); }
 
+  /**
+   * \returns 2. Every edge has two nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<InfHex8>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_inf_prism12.h b/include/geom/cell_inf_prism12.h
@@ -233,6 +233,9 @@ class InfPrism12 final : public InfPrism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<InfPrism12>(s); }
 
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<InfPrism12>(e) - ((e < 3) ? 0 : 1); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_inf_prism6.h b/include/geom/cell_inf_prism6.h
@@ -191,6 +191,9 @@ class InfPrism6 final : public InfPrism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<InfPrism6>(s) - ((s == 0) ? 1 : 0); }
 
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<InfPrism6>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_prism15.h b/include/geom/cell_prism15.h
@@ -249,6 +249,12 @@ class Prism15 final : public Prism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Prism15, 2>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Prism15>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_prism18.h b/include/geom/cell_prism18.h
@@ -267,6 +267,12 @@ class Prism18 final : public Prism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Prism18, 3>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Prism18>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_prism20.h b/include/geom/cell_prism20.h
@@ -266,6 +266,12 @@ class Prism20 final : public Prism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Prism20, 2>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Prism20>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_prism21.h b/include/geom/cell_prism21.h
@@ -269,6 +269,12 @@ class Prism21 final : public Prism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Prism21, 2>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Prism21>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_prism6.h b/include/geom/cell_prism6.h
@@ -209,6 +209,12 @@ class Prism6 final : public Prism
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Prism6, 1>(s); }
 
+  /**
+   * \returns 2. Every edge has two nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Prism6>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_pyramid13.h b/include/geom/cell_pyramid13.h
@@ -237,6 +237,12 @@ class Pyramid13 final : public Pyramid
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Pyramid13, 2>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Pyramid13>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_pyramid14.h b/include/geom/cell_pyramid14.h
@@ -258,6 +258,12 @@ class Pyramid14 final : public Pyramid
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Pyramid14, 3>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Pyramid14>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_pyramid5.h b/include/geom/cell_pyramid5.h
@@ -202,6 +202,12 @@ class Pyramid5 final : public Pyramid
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return _n_nodes_on_side<Pyramid5, 1>(s); }
 
+  /**
+   * \returns 2. Every edge has two nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Pyramid5>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_tet10.h b/include/geom/cell_tet10.h
@@ -248,6 +248,12 @@ class Tet10 final : public Tet
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<Tet10>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Tet10>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/cell_tet14.h b/include/geom/cell_tet14.h
@@ -248,6 +248,12 @@ class Tet14 final : public Tet
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<Tet14>(s); }
 
+  /**
+   * \returns 3. Every edge has three nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Tet14>(e); }
+
 #ifdef LIBMESH_ENABLE_AMR
   virtual
   const std::vector<std::pair<unsigned char, unsigned char>> &
diff --git a/include/geom/cell_tet4.h b/include/geom/cell_tet4.h
@@ -255,6 +255,12 @@ class Tet4 final : public Tet
   virtual unsigned int n_nodes_on_side(const unsigned short s) const override final
   { return this->_n_nodes_on_side_constant<Tet4>(s); }
 
+  /**
+   * \returns 2. Every edge has two nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->_n_nodes_on_edge_constant<Tet4>(e); }
+
 protected:
 
   /**
diff --git a/include/geom/edge.h b/include/geom/edge.h
@@ -235,6 +235,12 @@ class Edge : public Elem
   virtual unsigned int n_nodes_on_side(const unsigned short libmesh_dbg_var(s)) const override final
   { libmesh_assert_less(s, 2); return 1; }
 
+  /**
+   * The \p Elem::n_nodes_on_edge() member makes no sense for edges.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short) const override final
+  { libmesh_not_implemented(); return 0; }
+
 protected:
 
   /**
diff --git a/include/geom/elem.h b/include/geom/elem.h
@@ -676,6 +676,11 @@ class Elem : public ReferenceCountedObject<Elem>,
    */
   virtual unsigned int n_edges () const = 0;
 
+  /**
+   * \returns The number of nodes on the edge with index \p e.
+   */
+  virtual unsigned int n_nodes_on_edge (const unsigned short) const = 0;
+
   /**
    * \returns An integer range from 0 up to (but not including)
    * the number of edges this element has.
@@ -1985,6 +1990,20 @@ class Elem : public ReferenceCountedObject<Elem>,
     return ElemClass::nodes_per_side;
   }
 
+  /**
+   * Helper for overriding n_nodes_per_edge in derived classes.
+   *
+   * Performs bound checking on \p s and returns nodes_per_edge
+   * for the given class for all edges.
+  */
+  template <class ElemClass>
+  unsigned int _n_nodes_on_edge_constant(const unsigned short libmesh_dbg_var(s)) const
+  {
+    static_assert(std::is_base_of<Elem, ElemClass>::value, "Not an Elem");
+    libmesh_assert_less(s, this->n_edges());
+    return ElemClass::nodes_per_edge;
+  }
+
   /**
    * Helper for overriding nodes_on_side in derived classes.
   */
diff --git a/include/geom/face.h b/include/geom/face.h
@@ -72,6 +72,9 @@ class Face : public Elem
   virtual unsigned int n_vertices_on_side(const unsigned short libmesh_dbg_var(s)) const override final
   { libmesh_assert_less(s, this->n_sides()); return 2; }
 
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->n_nodes_on_side(e); }
+
   /**
    * build_side and build_edge are identical for faces.
    */
diff --git a/include/geom/face_inf_quad.h b/include/geom/face_inf_quad.h
@@ -237,6 +237,9 @@ class InfQuad : public Elem
 
   virtual void permute(unsigned int) override final { libmesh_error(); }
 
+  virtual unsigned int n_nodes_on_edge(const unsigned short e) const override final
+  { return this->n_nodes_on_side(e); }
+
 protected:
 
   /**
diff --git a/include/geom/node_elem.h b/include/geom/node_elem.h
@@ -83,6 +83,12 @@ class NodeElem : public Elem
   virtual unsigned int n_nodes_on_side(const unsigned short) const override
   { libmesh_not_implemented(); return 0; }
 
+  /**
+   * The \p Elem::n_nodes_on_edge makes no sense for nodes.
+   */
+  virtual unsigned int n_nodes_on_edge(const unsigned short) const override
+  { libmesh_not_implemented(); return 0; }
+
   /**
    * The \p Elem::nodes_on_side_ptr makes no sense for nodes.
    */
diff --git a/include/geom/remote_elem.h b/include/geom/remote_elem.h
@@ -122,6 +122,9 @@ class RemoteElem : public Elem,
   virtual unsigned int n_nodes_on_side (const unsigned short) const override
   { libmesh_not_implemented(); return 0; }
 
+  virtual unsigned int n_nodes_on_edge (const unsigned short) const override
+  { libmesh_not_implemented(); return 0; }
+
   virtual unsigned int n_sides () const override
   { libmesh_not_implemented(); return 0; }
 
diff --git a/tests/geom/elem_test.C b/tests/geom/elem_test.C
@@ -316,6 +316,21 @@ public:
       }
   };
 
+  void test_n_nodes_on_edge()
+  {
+    LOG_UNIT_TEST;
+
+    for (const auto & elem : _mesh->active_local_element_ptr_range())
+      for (const auto e : elem->edge_index_range())
+      {
+        unsigned int n_nodes_on_edge = 0;
+        for (const auto n : elem->node_index_range())
+          if (elem->is_node_on_edge(n, e))
+            ++n_nodes_on_edge;
+        CPPUNIT_ASSERT_EQUAL(n_nodes_on_edge, elem->n_nodes_on_edge(e));
+      }
+  };
+
   void test_n_vertices_on_side()
   {
     LOG_UNIT_TEST;
@@ -376,6 +391,7 @@ public:
   CPPUNIT_TEST( test_center_node_on_side );     \
   CPPUNIT_TEST( test_side_type );               \
   CPPUNIT_TEST( test_n_nodes_on_side );         \
+  CPPUNIT_TEST( test_n_nodes_on_edge );         \
   CPPUNIT_TEST( test_n_vertices_on_side );      \
   CPPUNIT_TEST( test_nodes_on_side_ptr );       \
   CPPUNIT_TEST( test_elem_side_builder );
