libMesh
cell_prism20.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2025 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_PRISM20_H
21 #define LIBMESH_CELL_PRISM20_H
22 
23 // Local includes
24 #include "libmesh/cell_prism.h"
25 
26 namespace libMesh
27 {
28 
79 class Prism20 final : public Prism
80 {
81 public:
82 
86  explicit
87  Prism20 (Elem * p=nullptr) :
89  {}
90 
91  Prism20 (Prism20 &&) = delete;
92  Prism20 (const Prism20 &) = delete;
93  Prism20 & operator= (const Prism20 &) = delete;
94  Prism20 & operator= (Prism20 &&) = delete;
95  virtual ~Prism20() = default;
96 
100  virtual ElemType type () const override { return PRISM20; }
101 
105  virtual unsigned int n_nodes() const override { return num_nodes; }
106 
110  virtual unsigned int n_sub_elem() const override { return 8; }
111 
115  virtual bool is_vertex(const unsigned int i) const override;
116 
120  virtual bool is_edge(const unsigned int i) const override;
121 
125  virtual bool is_face(const unsigned int i) const override;
126 
131  virtual bool is_node_on_side(const unsigned int n,
132  const unsigned int s) const override;
133 
134  virtual std::vector<unsigned int> nodes_on_side(const unsigned int s) const override;
135 
136  virtual std::vector<unsigned int> nodes_on_edge(const unsigned int e) const override;
137 
142  virtual bool is_node_on_edge(const unsigned int n,
143  const unsigned int e) const override;
144 
149  virtual bool has_affine_map () const override;
150 
154  virtual Order default_order() const override;
155 
159  using Elem::key;
160 
169  virtual dof_id_type key (const unsigned int s) const override;
170 
174  virtual unsigned int local_side_node(unsigned int side,
175  unsigned int side_node) const override;
176 
180  virtual unsigned int local_edge_node(unsigned int edge,
181  unsigned int edge_node) const override;
182 
187  virtual std::unique_ptr<Elem> build_side_ptr (const unsigned int i) override;
188 
192  virtual void build_side_ptr (std::unique_ptr<Elem> & elem,
193  const unsigned int i) override;
194 
195  // Avoid hiding deprecated version with different signature
196  using Elem::build_side_ptr;
197 
202  virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int i) override;
203 
208  virtual void build_edge_ptr (std::unique_ptr<Elem> & edge, const unsigned int i) override;
209 
210  virtual void connectivity(const unsigned int sc,
211  const IOPackage iop,
212  std::vector<dof_id_type> & conn) const override;
213 
218  virtual unsigned int n_second_order_adjacent_vertices (const unsigned int) const override;
219 
226  virtual unsigned short int second_order_adjacent_vertex (const unsigned int n,
227  const unsigned int v) const override;
228 
234  virtual std::pair<unsigned short int, unsigned short int>
235  second_order_child_vertex (const unsigned int n) const override;
236 
240  static const int num_nodes = 20;
241  static const int nodes_per_side = 9;
242  static const int nodes_per_edge = 3;
243 
248  static const unsigned int side_nodes_map[num_sides][nodes_per_side];
249 
254  static const unsigned int edge_nodes_map[num_edges][nodes_per_edge];
255 
256  virtual void permute(unsigned int perm_num) override final;
257 
258  virtual void flip(BoundaryInfo *) override final;
259 
260 #ifdef LIBMESH_ENABLE_AMR
261  virtual
262  const std::vector<std::pair<unsigned char, unsigned char>> &
264  unsigned int) const override
265  {
266  // We can't get any good bracketing nodes for child tri-center
267  // nodes on the parent prism midplane. No refining Prism20 for
268  // us.
269  libmesh_not_implemented_msg("Prism20 cannot be refined; use Prism21 instead.");
270  }
271 #endif
272 
273  unsigned int center_node_on_side(const unsigned short side) const override final;
274 
275  ElemType side_type (const unsigned int s) const override final;
276 
277 protected:
278 
283 
284 
285 
286 #ifdef LIBMESH_ENABLE_AMR
287 
291  virtual Real embedding_matrix (const unsigned int,
292  const unsigned int,
293  const unsigned int) const override
294  {
295  // We can't get any good bracketing nodes for child tri-center
296  // nodes on the parent prism midplane, so we can't auto-calculate
297  // embedding matrices and couldn't use them if we did.
298  libmesh_not_implemented_msg("Prism20 cannot be refined; use Prism21 instead.");
299  return 0;
300  }
301 
303 
304 #endif // LIBMESH_ENABLE_AMR
305 
314  static const unsigned short int _remaining_second_order_adjacent_vertices[5][4];
315 };
316 
317 } // namespace libMesh
318 
319 #endif // LIBMESH_CELL_PRISM20_H
The Prism20 is an element in 3D composed of 20 nodes.
Definition: cell_prism20.h:79
ElemType
Defines an enum for geometric element types.
virtual unsigned int n_second_order_adjacent_vertices(const unsigned int) const override
Definition: cell_prism20.C:495
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
static const int num_edges
Definition: cell_prism.h:74
Prism20(Elem *p=nullptr)
Constructor.
Definition: cell_prism20.h:87
virtual ElemType type() const override
Definition: cell_prism20.h:100
virtual void flip(BoundaryInfo *) override final
Flips the element (by swapping node and neighbor pointers) to have a mapping Jacobian of opposite sig...
Definition: cell_prism20.C:635
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i)=0
virtual dof_id_type key() const
Definition: elem.C:753
virtual std::pair< unsigned short int, unsigned short int > second_order_child_vertex(const unsigned int n) const override
Definition: cell_prism20.C:582
static const int num_nodes
Geometric constants for Prism20.
Definition: cell_prism20.h:240
IOPackage
libMesh interfaces with several different software packages for the purposes of creating, reading, and writing mesh files.
virtual unsigned int n_sub_elem() const override
Definition: cell_prism20.h:110
virtual void permute(unsigned int perm_num) override final
Permutes the element (by swapping node and neighbor pointers) according to the specified index...
Definition: cell_prism20.C:595
This is the base class from which all geometric element types are derived.
Definition: elem.h:94
virtual std::vector< unsigned int > nodes_on_edge(const unsigned int e) const override
Definition: cell_prism20.C:105
virtual bool is_vertex(const unsigned int i) const override
Definition: cell_prism20.C:64
The libMesh namespace provides an interface to certain functionality in the library.
ElemType side_type(const unsigned int s) const override final
Definition: cell_prism20.C:665
virtual unsigned short int second_order_adjacent_vertex(const unsigned int n, const unsigned int v) const override
Definition: cell_prism20.C:528
virtual bool is_node_on_edge(const unsigned int n, const unsigned int e) const override
Definition: cell_prism20.C:111
virtual ~Prism20()=default
static const int nodes_per_side
Definition: cell_prism20.h:241
virtual Order default_order() const override
Definition: cell_prism20.C:165
virtual unsigned int local_edge_node(unsigned int edge, unsigned int edge_node) const override
Definition: cell_prism20.C:219
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i) override
Builds a QUAD9 or TRI6 built coincident with face i.
Definition: cell_prism20.C:230
virtual std::vector< unsigned int > nodes_on_side(const unsigned int s) const override
Definition: cell_prism20.C:97
static const int nodes_per_edge
Definition: cell_prism20.h:242
virtual unsigned int n_nodes() const override
Definition: cell_prism20.h:105
The BoundaryInfo class contains information relevant to boundary conditions including storing faces...
Definition: boundary_info.h:57
The Prism is an element in 3D with 5 sides.
Definition: cell_prism.h:36
virtual void connectivity(const unsigned int sc, const IOPackage iop, std::vector< dof_id_type > &conn) const override
Definition: cell_prism20.C:324
virtual bool is_edge(const unsigned int i) const override
Definition: cell_prism20.C:71
virtual bool is_node_on_side(const unsigned int n, const unsigned int s) const override
Definition: cell_prism20.C:87
virtual std::unique_ptr< Elem > build_edge_ptr(const unsigned int i) override
Builds a EDGE3 or INFEDGE2 built coincident with edge i.
Definition: cell_prism20.C:310
virtual bool has_affine_map() const override
Definition: cell_prism20.C:122
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
static const int num_sides
Geometric constants for all Prisms.
Definition: cell_prism.h:73
static const unsigned short int _remaining_second_order_adjacent_vertices[5][4]
Matrix that tells which vertices define the location of mid-side (or second-order) nodes...
Definition: cell_prism20.h:314
virtual bool is_face(const unsigned int i) const override
Definition: cell_prism20.C:80
virtual Real embedding_matrix(const unsigned int, const unsigned int, const unsigned int) const override
Matrix used to create the elements children.
Definition: cell_prism20.h:291
unsigned int center_node_on_side(const unsigned short side) const override final
Definition: cell_prism20.C:653
virtual const std::vector< std::pair< unsigned char, unsigned char > > & parent_bracketing_nodes(unsigned int, unsigned int) const override
Definition: cell_prism20.h:263
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_prism20.h:248
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_prism20.h:254
Node * _nodelinks_data[num_nodes]
Data for links to nodes.
Definition: cell_prism20.h:282
Prism20 & operator=(const Prism20 &)=delete
uint8_t dof_id_type
Definition: id_types.h:67
virtual unsigned int local_side_node(unsigned int side, unsigned int side_node) const override
Definition: cell_prism20.C:203