libMesh
cell_pyramid5.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2024 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_PYRAMID5_H
21 #define LIBMESH_CELL_PYRAMID5_H
22 
23 // Local includes
24 #include "libmesh/cell_pyramid.h"
25 
26 namespace libMesh
27 {
28 
57 class Pyramid5 final : public Pyramid
58 {
59 public:
60 
64  explicit
65  Pyramid5 (Elem * p=nullptr) :
67  {}
68 
69  Pyramid5 (Pyramid5 &&) = delete;
70  Pyramid5 (const Pyramid5 &) = delete;
71  Pyramid5 & operator= (const Pyramid5 &) = delete;
72  Pyramid5 & operator= (Pyramid5 &&) = delete;
73  virtual ~Pyramid5() = default;
74 
78  virtual ElemType type () const override { return PYRAMID5; }
79 
83  virtual unsigned int n_sub_elem() const override { return 1; }
84 
88  virtual bool is_vertex(const unsigned int i) const override;
89 
93  virtual bool is_edge(const unsigned int i) const override;
94 
98  virtual bool is_face(const unsigned int i) const override;
99 
104  virtual bool is_node_on_side(const unsigned int n,
105  const unsigned int s) const override;
106 
107  virtual std::vector<unsigned int> nodes_on_side(const unsigned int s) const override;
108 
109  virtual std::vector<unsigned int> nodes_on_edge(const unsigned int e) const override;
110 
115  virtual bool is_node_on_edge(const unsigned int n,
116  const unsigned int e) const override;
117 
122  virtual bool has_affine_map () const override;
123 
127  virtual Order default_order() const override;
128 
133  virtual std::unique_ptr<Elem> build_side_ptr (const unsigned int i,
134  bool proxy=false) override;
135 
139  virtual void build_side_ptr (std::unique_ptr<Elem> & elem,
140  const unsigned int i) override;
141 
146  virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int i) override;
147 
151  virtual void build_edge_ptr (std::unique_ptr<Elem> & edge, const unsigned int i) override;
152 
153  virtual void connectivity(const unsigned int sc,
154  const IOPackage iop,
155  std::vector<dof_id_type> & conn) const override;
156 
160  static const int num_nodes = 5;
161  static const int num_sides = 5;
162  static const int num_edges = 8;
163  static const int num_children = 0; // not implemented
164  static const int nodes_per_side = 4;
165  static const int nodes_per_edge = 2;
166 
171  static const unsigned int side_nodes_map[num_sides][nodes_per_side];
172 
177  static const unsigned int edge_nodes_map[num_edges][nodes_per_edge];
178 
183  virtual Point true_centroid () const override;
184 
188  virtual Real volume () const override;
189 
193  virtual BoundingBox loose_bounding_box () const override;
194 
195  virtual void permute(unsigned int perm_num) override final;
196 
197  virtual void flip(BoundaryInfo *) override final;
198 
199  ElemType side_type (const unsigned int s) const override final;
200 
201 protected:
202 
207 
208 
209 
210 #ifdef LIBMESH_ENABLE_AMR
211 
215  virtual Real embedding_matrix (const unsigned int,
216  const unsigned int,
217  const unsigned int) const override
218  { libmesh_not_implemented(); return 0.; }
219 
221 
222 #endif // LIBMESH_ENABLE_AMR
223 
224 };
225 
226 } // namespace libMesh
227 
228 
229 #endif // LIBMESH_CELL_PYRAMID5_H
virtual std::unique_ptr< Elem > build_edge_ptr(const unsigned int i) override
Builds a EDGE2 built coincident with edge i.
ElemType side_type(const unsigned int s) const override final
virtual Point true_centroid() const override
We compute the centroid of the Pyramid by treating it as a degenerate Hex8 element.
virtual void connectivity(const unsigned int sc, const IOPackage iop, std::vector< dof_id_type > &conn) const override
ElemType
Defines an enum for geometric element types.
The Pyramid is an element in 3D with 5 sides.
Definition: cell_pyramid.h:39
virtual std::vector< unsigned int > nodes_on_edge(const unsigned int e) const override
Order
defines an enum for polynomial orders.
Definition: enum_order.h:40
A Node is like a Point, but with more information.
Definition: node.h:52
virtual bool is_face(const unsigned int i) const override
Definition: cell_pyramid5.C:78
Node * _nodelinks_data[num_nodes]
Data for links to nodes.
virtual BoundingBox loose_bounding_box() const override
Builds a bounding box out of the nodal positions.
static const int nodes_per_edge
static const unsigned int edge_nodes_map[num_edges][nodes_per_edge]
This maps the node of the edge to element node numbers.
Pyramid5(Elem *p=nullptr)
Constructor.
Definition: cell_pyramid5.h:65
IOPackage
libMesh interfaces with several different software packages for the purposes of creating, reading, and writing mesh files.
virtual void flip(BoundaryInfo *) override final
Flips the element (by swapping node and neighbor pointers) to have a mapping Jacobian of opposite sig...
This is the base class from which all geometric element types are derived.
Definition: elem.h:94
virtual bool is_node_on_side(const unsigned int n, const unsigned int s) const override
Definition: cell_pyramid5.C:83
virtual Real volume() const override
Specialization for computing the volume of a pyramid.
virtual bool is_node_on_edge(const unsigned int n, const unsigned int e) const override
virtual bool has_affine_map() const override
virtual bool is_edge(const unsigned int i) const override
Definition: cell_pyramid5.C:73
static const int num_children
The libMesh namespace provides an interface to certain functionality in the library.
Pyramid5 & operator=(const Pyramid5 &)=delete
virtual ~Pyramid5()=default
static const int num_nodes
Geometric constants for Pyramid5.
virtual std::vector< unsigned int > nodes_on_side(const unsigned int s) const override
Definition: cell_pyramid5.C:93
The BoundaryInfo class contains information relevant to boundary conditions including storing faces...
Definition: boundary_info.h:57
static const int nodes_per_side
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i, bool proxy=false) override
Builds a QUAD4 or TRI3 built coincident with face i.
Defines a Cartesian bounding box by the two corner extremum.
Definition: bounding_box.h:40
virtual unsigned int n_nodes() const override
Definition: cell_pyramid.h:78
virtual void permute(unsigned int perm_num) override final
Permutes the element (by swapping node and neighbor pointers) according to the specified index...
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
virtual bool is_vertex(const unsigned int i) const override
Definition: cell_pyramid5.C:68
static const unsigned int side_nodes_map[num_sides][nodes_per_side]
This maps the node of the side to element node numbers.
virtual Real embedding_matrix(const unsigned int, const unsigned int, const unsigned int) const override
Matrix used to create the elements children.
The Pyramid5 is an element in 3D composed of 5 nodes.
Definition: cell_pyramid5.h:57
virtual unsigned int n_sub_elem() const override
Definition: cell_pyramid5.h:83
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:39
virtual Order default_order() const override
static const int num_sides
virtual ElemType type() const override
Definition: cell_pyramid5.h:78
static const int num_edges