Line data    Source code

       1             : // The libMesh Finite Element Library.
       2             : // Copyright (C) 2002-2026 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
       3             : 
       4             : // This library is free software; you can redistribute it and/or
       5             : // modify it under the terms of the GNU Lesser General Public
       6             : // License as published by the Free Software Foundation; either
       7             : // version 2.1 of the License, or (at your option) any later version.
       8             : 
       9             : // This library is distributed in the hope that it will be useful,
      10             : // but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             : // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      12             : // Lesser General Public License for more details.
      13             : 
      14             : // You should have received a copy of the GNU Lesser General Public
      15             : // License along with this library; if not, write to the Free Software
      16             : // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
      17             : 
      18             : 
      19             : 
      20             : #ifndef LIBMESH_CELL_HEX20_H
      21             : #define LIBMESH_CELL_HEX20_H
      22             : 
      23             : // Local includes
      24             : #include "libmesh/cell_hex.h"
      25             : #include "libmesh/cell_hex8.h"
      26             : #include "libmesh/fe_reference_element_traits.h"
      27             : 
      28             : namespace libMesh
      29             : {
      30             : 
      31             : /**
      32             :  * The \p Hex20 is an element in 3D composed of 20 nodes.  It is
      33             :  * numbered like this:
      34             :  *
      35             :  * \verbatim
      36             :  *   HEX20:      7              18             6
      37             :  *               o--------------o--------------o
      38             :  *              /:                            /|
      39             :  *             / :                           / |
      40             :  *            /  :                          /  |
      41             :  *         19/   :                       17/   |
      42             :  *          o    :                        o    |
      43             :  *         /     :                       /     |
      44             :  *        /    15o                      /    14o
      45             :  *       /       :                     /       |           zeta
      46             :  *     4/        :    16             5/        |            ^   eta (into page)
      47             :  *     o--------------o--------------o         |            | /
      48             :  *     |         :                   |         |            |/
      49             :  *     |         :                   |         |            o---> xi
      50             :  *     |         :              10   |         |
      51             :  *     |        3o..............o....|.........o
      52             :  *     |        .                    |        / 2
      53             :  *     |       .                   13|       /
      54             :  *  12 o      .                      o      /
      55             :  *     |     .                       |     /
      56             :  *     |  11o                        |    o
      57             :  *     |   .                         |   / 9
      58             :  *     |  .                          |  /
      59             :  *     | .                           | /
      60             :  *     |.                            |/
      61             :  *     o--------------o--------------o
      62             :  *     0              8              1
      63             :  * \endverbatim
      64             :  *
      65             :  * (xi, eta, zeta) in [-1,1]^3 are the reference element coordinates
      66             :  * associated with the given numbering.
      67             :  *
      68             :  * \author Benjamin S. Kirk
      69             :  * \date 2002
      70             :  * \brief A 3D hexahedral element with 20 nodes.
      71             :  */
      72             : class Hex20 final : public Hex
      73             : {
      74             : public:
      75             : 
      76             :   /**
      77             :    * Constructor.  By default this element has no parent.
      78             :    */
      79             :   explicit
      80      140065 :   Hex20 (Elem * p=nullptr) :
      81      140065 :     Hex(num_nodes, p, _nodelinks_data)
      82      140065 :   {}
      83             : 
      84             :   Hex20 (Hex20 &&) = delete;
      85             :   Hex20 (const Hex20 &) = delete;
      86             :   Hex20 & operator= (const Hex20 &) = delete;
      87             :   Hex20 & operator= (Hex20 &&) = delete;
      88      145356 :   virtual ~Hex20() = default;
      89             : 
      90             :   /**
      91             :    * \returns \p HEX20.
      92             :    */
      93   661181998 :   virtual ElemType type () const override { return HEX20; }
      94             : 
      95             :   /**
      96             :    * \returns 20.
      97             :    */
      98   163487516 :   virtual unsigned int n_nodes() const override { return num_nodes; }
      99             : 
     100             :   /**
     101             :    * \returns 1.
     102             :    */
     103           0 :   virtual unsigned int n_sub_elem() const override { return 1; }
     104             : 
     105             :   /**
     106             :    * \returns \p true if the specified (local) node number is a vertex.
     107             :    */
     108             :   virtual bool is_vertex(const unsigned int i) const override;
     109             : 
     110             :   /**
     111             :    * \returns \p true if the specified (local) node number is an edge.
     112             :    */
     113             :   virtual bool is_edge(const unsigned int i) const override;
     114             : 
     115             :   /**
     116             :    * \returns \p true if the specified (local) node number is a face.
     117             :    */
     118             :   virtual bool is_face(const unsigned int i) const override;
     119             : 
     120             :   /**
     121             :    * \returns \p true if the specified (local) node number is on the
     122             :    * specified side.
     123             :    */
     124             :   virtual bool is_node_on_side(const unsigned int n,
     125             :                                const unsigned int s) const override;
     126             : 
     127             :   virtual std::vector<unsigned int> nodes_on_side(const unsigned int s) const override;
     128             : 
     129             :   virtual std::vector<unsigned int> nodes_on_edge(const unsigned int e) const override;
     130             : 
     131             :   /**
     132             :    * \returns \p true if the specified (local) node number is on the
     133             :    * specified edge.
     134             :    */
     135             :   virtual bool is_node_on_edge(const unsigned int n,
     136             :                                const unsigned int e) const override;
     137             : 
     138             :   /**
     139             :    * \returns \p true if the element map is definitely affine within
     140             :    * numerical tolerances.
     141             :    */
     142             :   virtual bool has_affine_map () const override;
     143             : 
     144             :   /**
     145             :    * \returns SECOND.
     146             :    */
     147             :   virtual Order default_order() const override;
     148             : 
     149             :   /**
     150             :    * \returns \p Hex20::side_nodes_map[side][side_node] after doing some range checking.
     151             :    */
     152             :   virtual unsigned int local_side_node(unsigned int side,
     153             :                                        unsigned int side_node) const override;
     154             : 
     155             :   /**
     156             :    * \returns \p Hex20::edge_nodes_map[edge][edge_node] after doing some range checking.
     157             :    */
     158             :   virtual unsigned int local_edge_node(unsigned int edge,
     159             :                                        unsigned int edge_node) const override;
     160             : 
     161             :   /**
     162             :    * Builds a \p QUAD8 built coincident with face i.
     163             :    * The \p std::unique_ptr<Elem> handles the memory aspect.
     164             :    */
     165             :   virtual std::unique_ptr<Elem> build_side_ptr (const unsigned int i) override;
     166             : 
     167             :   /**
     168             :    * Rebuilds a \p QUAD8 built coincident with face i.
     169             :    */
     170             :   virtual void build_side_ptr (std::unique_ptr<Elem> & elem,
     171             :                                const unsigned int i) override;
     172             : 
     173             :   // Avoid hiding deprecated version with different signature
     174             :   using Elem::build_side_ptr;
     175             : 
     176             :   /**
     177             :    * Builds a \p EDGE3 built coincident with edge i.
     178             :    * The \p std::unique_ptr<Elem> handles the memory aspect.
     179             :    */
     180             :   virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int i) override;
     181             : 
     182             :   /**
     183             :    * Rebuilds a \p EDGE3 built coincident with edge i.
     184             :    */
     185             :   virtual void build_edge_ptr (std::unique_ptr<Elem> & edge, const unsigned int i) override;
     186             : 
     187             :   virtual void connectivity(const unsigned int sc,
     188             :                             const IOPackage iop,
     189             :                             std::vector<dof_id_type> & conn) const override;
     190             : 
     191             :   /**
     192             :    * \returns 2 for all \p n.
     193             :    */
     194           0 :   virtual unsigned int n_second_order_adjacent_vertices (const unsigned int) const override
     195           0 :   { return 2; }
     196             : 
     197             :   /**
     198             :    * \returns The element-local number of the \f$ v^{th} \f$ vertex
     199             :    * that defines the \f$ n^{th} \f$ second-order node.
     200             :    *
     201             :    * \note \p n uses the numbering shown above, \f$ 8 \le n < 20 \f$.
     202             :    */
     203             :   virtual unsigned short int second_order_adjacent_vertex (const unsigned int n,
     204             :                                                            const unsigned int v) const override;
     205             : 
     206             :   /**
     207             :    * \returns The child number \p c and element-local index \p v of the
     208             :    * \f$ n^{th} \f$ second-order node on the parent element.  See
     209             :    * elem.h for further details.
     210             :    */
     211             :   virtual std::pair<unsigned short int, unsigned short int>
     212             :   second_order_child_vertex (const unsigned int n) const override;
     213             : 
     214             :   /**
     215             :    * Geometric constants for Hex20.
     216             :    */
     217             :   static const int num_nodes = 20;
     218             :   static const int nodes_per_side = 8;
     219             :   static const int nodes_per_edge = 3;
     220             : 
     221             :   /**
     222             :    * These map the \f$ j^{th} \f$ node of the \f$ i^{th} \f$ edge or
     223             :    * side to element node numbers.  They are derived from the
     224             :    * first-order Hex8 tables; see fe_reference_element_traits.h.
     225             :    */
     226             :   static constexpr NodeMapTable<num_edges, nodes_per_edge>
     227             :   _edge_nodes = derived_edge_nodes<Hex8, num_edges>();
     228             :   static constexpr const unsigned int (&edge_nodes_map)[num_edges][nodes_per_edge] = _edge_nodes.values;
     229             : 
     230             :   static constexpr NodeMapTable<num_sides, nodes_per_side>
     231             :   _side_nodes = derived_side_nodes<Hex8, num_sides, nodes_per_side>
     232             :     (_edge_nodes.values, no_face_node);
     233             :   static constexpr const unsigned int (&side_nodes_map)[num_sides][nodes_per_side] = _side_nodes.values;
     234             : 
     235             :   /**
     236             :    * A specialization for computing the volume of a Hex20.
     237             :    */
     238             :   virtual Real volume () const override;
     239             : 
     240             :   virtual void permute(unsigned int perm_num) override final;
     241             : 
     242             :   virtual void flip(BoundaryInfo *) override final;
     243             : 
     244             :   ElemType side_type (const unsigned int s) const override final;
     245             : 
     246             : protected:
     247             : 
     248             :   /**
     249             :    * Data for links to nodes.
     250             :    */
     251             :   Node * _nodelinks_data[num_nodes];
     252             : 
     253             : 
     254             : 
     255             : #ifdef LIBMESH_ENABLE_AMR
     256             : 
     257             :   /**
     258             :    * Matrix used to create the elements children.
     259             :    */
     260     3294192 :   virtual Real embedding_matrix (const unsigned int i,
     261             :                                  const unsigned int j,
     262             :                                  const unsigned int k) const override
     263     3294192 :   { return _embedding_matrix[i][j][k]; }
     264             : 
     265             :   /**
     266             :    * Matrix that computes new nodal locations/solution values
     267             :    * from current nodes/solution.
     268             :    */
     269             :   static const Real _embedding_matrix[num_children][num_nodes][num_nodes];
     270             : 
     271     1634860 :   LIBMESH_ENABLE_TOPOLOGY_CACHES;
     272             : 
     273             : #endif // LIBMESH_ENABLE_AMR
     274             : 
     275             : };
     276             : 
     277             : } // namespace libMesh
     278             : 
     279             : #endif // LIBMESH_CELL_HEX20_H