Merge pull request #3752 from roystgnr/low_order_key

Use vertices to define low_order_key() for neighbor-finding and mesh stitching

Author: roystgnr

include/geom/cell_hex.h

@@ -125,11 +125,18 @@ class Hex : public Cell
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    */
   virtual dof_id_type key (const unsigned int s) const override;
 
+  /**
+   * \returns An id associated with the \p s side of this element, as
+   * defined solely by element vertices.  The id is not necessarily
+   * unique, but should be close.  This is particularly useful in the
+   * \p MeshBase::find_neighbors() routine.
+   */
+  virtual dof_id_type low_order_key (const unsigned int s) const override;
+
   /**
    * \returns \p Hex8::side_nodes_map[side][side_node] after doing some range checking.
    */

include/geom/cell_hex27.h

@@ -151,8 +151,7 @@ class Hex27 final : public Hex
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    *
    * We reimplement this method here for the \p Hex27 since we can
    * use the center node of each face to provide a perfect (unique)

include/geom/cell_inf_hex.h

@@ -151,11 +151,18 @@ class InfHex : public InfCell
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    */
   virtual dof_id_type key (const unsigned int s) const override;
 
+  /**
+   * \returns An id associated with the \p s side of this element, as
+   * defined solely by element vertices.  The id is not necessarily
+   * unique, but should be close.  This is particularly useful in the
+   * \p MeshBase::find_neighbors() routine.
+   */
+  virtual dof_id_type low_order_key (const unsigned int s) const override;
+
   /**
    * \returns \p InfHex8::side_nodes_map[side][side_node] after doing some range checking.
    */

include/geom/cell_inf_hex18.h

@@ -160,8 +160,7 @@ class InfHex18 final : public InfHex
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    *
    * We reimplement this method here for the \p InfHex18 since we can
    * use the center node of the bottom face to provide a perfect (unique)

include/geom/cell_inf_prism.h

@@ -143,11 +143,18 @@ class InfPrism : public InfCell
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    */
   virtual dof_id_type key (const unsigned int s) const override;
 
+  /**
+   * \returns An id associated with the \p s side of this element, as
+   * defined solely by element vertices.  The id is not necessarily
+   * unique, but should be close.  This is particularly useful in the
+   * \p MeshBase::find_neighbors() routine.
+   */
+  virtual dof_id_type low_order_key (const unsigned int s) const override;
+
   /**
    * \returns InfPrism6::side_nodes_map[side][side_node] after doing some range checking.
    */

include/geom/cell_prism.h

@@ -117,11 +117,18 @@ class Prism : public Cell
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    */
   virtual dof_id_type key (const unsigned int s) const override;
 
+  /**
+   * \returns An id associated with the \p s side of this element, as
+   * defined solely by element vertices.  The id is not necessarily
+   * unique, but should be close.  This is particularly useful in the
+   * \p MeshBase::find_neighbors() routine.
+   */
+  virtual dof_id_type low_order_key (const unsigned int s) const override;
+
   /**
    * \returns \p Prism6::side_nodes_map[side][side_node] after doing some range checking.
    */

include/geom/cell_prism18.h

@@ -156,8 +156,7 @@ class Prism18 final : public Prism
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    *
    * We reimplement this method here for the \p Prism18 since we can
    * use the center node of each quad face to provide a perfect (unique)

include/geom/cell_prism20.h

@@ -160,8 +160,7 @@ class Prism20 final : public Prism
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    *
    * We reimplement this method here for the \p Prism20 since we can
    * use the center node of each quad face to provide a perfect (unique)

include/geom/cell_prism21.h

@@ -163,8 +163,7 @@ class Prism21 final : public Prism
 
   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    *
    * We reimplement this method here for the \p Prism21 since we can
    * use the center node of each quad face to provide a perfect (unique)

include/geom/cell_pyramid.h

@@ -120,14 +120,21 @@ class Pyramid : public Cell
    */
   using Elem::key;
 
-  /**
+   /**
    * \returns An id associated with the \p s side of this element.
-   * The id is not necessarily unique, but should be close.  This is
-   * particularly useful in the \p MeshBase::find_neighbors() routine.
+   * The id is not necessarily unique, but should be close.
    */
   virtual dof_id_type key (const unsigned int s) const override;
 
   /**
+   * \returns An id associated with the \p s side of this element, as
+   * defined solely by element vertices.  The id is not necessarily
+   * unique, but should be close.  This is particularly useful in the
+   * \p MeshBase::find_neighbors() routine.
+   */
+  virtual dof_id_type low_order_key (const unsigned int s) const override;
+
+ /**
    * \returns \p Pyramid5::side_nodes_map[side][side_node] after doing some range checking.
    */
   virtual unsigned int local_side_node(unsigned int side,