libMesh
cell_pyramid5.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2019 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 
52 class Pyramid5 final : public Pyramid
53 {
54 public:
55 
59  explicit
60  Pyramid5 (Elem * p=nullptr) :
62  {}
63 
64  Pyramid5 (Pyramid5 &&) = delete;
65  Pyramid5 (const Pyramid5 &) = delete;
66  Pyramid5 & operator= (const Pyramid5 &) = delete;
67  Pyramid5 & operator= (Pyramid5 &&) = delete;
68  virtual ~Pyramid5() = default;
69 
73  virtual ElemType type () const override { return PYRAMID5; }
74 
78  virtual unsigned int n_sub_elem() const override { return 1; }
79 
83  virtual bool is_vertex(const unsigned int i) const override;
84 
88  virtual bool is_edge(const unsigned int i) const override;
89 
93  virtual bool is_face(const unsigned int i) const override;
94 
99  virtual bool is_node_on_side(const unsigned int n,
100  const unsigned int s) const override;
101 
102  virtual std::vector<unsigned int> nodes_on_side(const unsigned int s) const override;
103 
108  virtual bool is_node_on_edge(const unsigned int n,
109  const unsigned int e) const override;
110 
115  virtual bool has_affine_map () const override;
116 
120  virtual Order default_order() const override;
121 
126  virtual std::unique_ptr<Elem> build_side_ptr (const unsigned int i,
127  bool proxy=true) override;
128 
132  virtual void build_side_ptr (std::unique_ptr<Elem> & elem,
133  const unsigned int i) override;
134 
139  virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int i) override;
140 
141  virtual void connectivity(const unsigned int sc,
142  const IOPackage iop,
143  std::vector<dof_id_type> & conn) const override;
144 
148  static const int num_nodes = 5;
149  static const int num_sides = 5;
150  static const int num_edges = 8;
151  static const int num_children = 0; // not implemented
152  static const int nodes_per_side = 4;
153  static const int nodes_per_edge = 2;
154 
159  static const unsigned int side_nodes_map[num_sides][nodes_per_side];
160 
165  static const unsigned int edge_nodes_map[num_edges][nodes_per_edge];
166 
170  virtual Real volume () const override;
171 
175  virtual BoundingBox loose_bounding_box () const override;
176 
177 protected:
178 
183 
184 
185 
186 #ifdef LIBMESH_ENABLE_AMR
187 
191  virtual float embedding_matrix (const unsigned int,
192  const unsigned int,
193  const unsigned int) const override
194  { libmesh_not_implemented(); return 0.; }
195 
197 
198 #endif // LIBMESH_ENABLE_AMR
199 
200 };
201 
202 } // namespace libMesh
203 
204 
205 #endif // LIBMESH_CELL_PYRAMID5_H
libMesh::Pyramid5::_nodelinks_data
Node * _nodelinks_data[num_nodes]
Data for links to nodes.
Definition: cell_pyramid5.h:182
libMesh::Pyramid5::build_edge_ptr
virtual std::unique_ptr< Elem > build_edge_ptr(const unsigned int i) override
Builds a EDGE2 built coincident with edge i.
Definition: cell_pyramid5.C:195
libMesh::Pyramid5::build_side_ptr
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i, bool proxy=true) override
Builds a QUAD4 or TRI3 built coincident with face i.
Definition: cell_pyramid5.C:128
libMesh::Pyramid5::num_sides
static const int num_sides
Definition: cell_pyramid5.h:149
libMesh::Pyramid5::volume
virtual Real volume() const override
Specialization for computing the volume of a pyramid.
Definition: cell_pyramid5.C:245
libMesh::Pyramid
The Pyramid is an element in 3D with 5 sides.
Definition: cell_pyramid.h:39
libMesh::IOPackage
IOPackage
libMesh interfaces with several different software packages for the purposes of creating,...
Definition: enum_io_package.h:37
libMesh::Pyramid5::num_edges
static const int num_edges
Definition: cell_pyramid5.h:150
libMesh::BoundingBox
Defines a Cartesian bounding box by the two corner extremum.
Definition: bounding_box.h:40
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
libMesh::Pyramid5::embedding_matrix
virtual float embedding_matrix(const unsigned int, const unsigned int, const unsigned int) const override
Matrix used to create the elements children.
Definition: cell_pyramid5.h:191
libMesh::Pyramid5::edge_nodes_map
static const unsigned int edge_nodes_map[num_edges][nodes_per_edge]
This maps the node of the edge to element node numbers.
Definition: cell_pyramid5.h:165
libMesh::Pyramid5::operator=
Pyramid5 & operator=(const Pyramid5 &)=delete
libMesh::Order
Order
Definition: enum_order.h:40
libMesh::Pyramid5::side_nodes_map
static const unsigned int side_nodes_map[num_sides][nodes_per_side]
This maps the node of the side to element node numbers.
Definition: cell_pyramid5.h:159
libMesh::Pyramid5::num_nodes
static const int num_nodes
Geometric constants for Pyramid5.
Definition: cell_pyramid5.h:148
libMesh::Pyramid5::is_edge
virtual bool is_edge(const unsigned int i) const override
Definition: cell_pyramid5.C:74
libMesh::Pyramid5::type
virtual ElemType type() const override
Definition: cell_pyramid5.h:73
libMesh::Pyramid5::nodes_per_side
static const int nodes_per_side
Definition: cell_pyramid5.h:152
libMesh::Pyramid5::has_affine_map
virtual bool has_affine_map() const override
Definition: cell_pyramid5.C:112
libMesh::Pyramid5::nodes_per_edge
static const int nodes_per_edge
Definition: cell_pyramid5.h:153
libMesh::Pyramid::n_nodes
virtual unsigned int n_nodes() const override
Definition: cell_pyramid.h:78
libMesh::Pyramid5::is_vertex
virtual bool is_vertex(const unsigned int i) const override
Definition: cell_pyramid5.C:69
libMesh::Node
A Node is like a Point, but with more information.
Definition: node.h:52
libMesh::Pyramid5
The Pyramid5 is an element in 3D composed of 5 nodes.
Definition: cell_pyramid5.h:52
libMesh::Pyramid5::is_node_on_side
virtual bool is_node_on_side(const unsigned int n, const unsigned int s) const override
Definition: cell_pyramid5.C:84
libMesh::Pyramid5::Pyramid5
Pyramid5(Elem *p=nullptr)
Constructor.
Definition: cell_pyramid5.h:60
libMesh::Pyramid5::is_node_on_edge
virtual bool is_node_on_edge(const unsigned int n, const unsigned int e) const override
Definition: cell_pyramid5.C:101
libMesh::Pyramid5::nodes_on_side
virtual std::vector< unsigned int > nodes_on_side(const unsigned int s) const override
Definition: cell_pyramid5.C:94
libMesh::Pyramid5::n_sub_elem
virtual unsigned int n_sub_elem() const override
Definition: cell_pyramid5.h:78
libMesh::PYRAMID5
Definition: enum_elem_type.h:53
libMesh::Pyramid5::loose_bounding_box
virtual BoundingBox loose_bounding_box() const override
Builds a bounding box out of the nodal positions.
Definition: cell_pyramid5.C:268
libMesh::Pyramid5::LIBMESH_ENABLE_TOPOLOGY_CACHES
LIBMESH_ENABLE_TOPOLOGY_CACHES
Definition: cell_pyramid5.h:196
libMesh::Elem
This is the base class from which all geometric element types are derived.
Definition: elem.h:100
libMesh::Pyramid5::num_children
static const int num_children
Definition: cell_pyramid5.h:151
libMesh::Pyramid5::is_face
virtual bool is_face(const unsigned int i) const override
Definition: cell_pyramid5.C:79
libMesh::Pyramid5::connectivity
virtual void connectivity(const unsigned int sc, const IOPackage iop, std::vector< dof_id_type > &conn) const override
Definition: cell_pyramid5.C:204
libMesh::Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
Definition: libmesh_common.h:121
libMesh::Pyramid5::~Pyramid5
virtual ~Pyramid5()=default
libMesh::Pyramid5::default_order
virtual Order default_order() const override
Definition: cell_pyramid5.C:121
libMesh::ElemType
ElemType
Defines an enum for geometric element types.
Definition: enum_elem_type.h:33