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