libMesh
edge.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_EDGE_H
21 #define LIBMESH_EDGE_H
22 
23 // Local includes
24 #include "libmesh/elem.h"
25 
26 namespace libMesh
27 {
28 
37 class Edge : public Elem
38 {
39 public:
40 
45  Edge (const unsigned int nn,
46  Elem * p,
47  Node ** nodelinkdata) :
48  Elem(nn, num_sides, p, _elemlinks_data, nodelinkdata)
49  {
50  // Make sure the interior parent isn't undefined
51  if (LIBMESH_DIM > 1)
52  this->set_interior_parent(nullptr);
53  }
54 
55  Edge (Edge &&) = delete;
56  Edge (const Edge &) = delete;
57  Edge & operator= (const Edge &) = delete;
58  Edge & operator= (Edge &&) = delete;
59  virtual ~Edge() = default;
60 
64  static const int num_sides = 2;
65  static const int num_edges = 0;
66  static const int num_children = 2;
67  static const int nodes_per_side = 1;
68  static const int nodes_per_edge = invalid_int;
69 
73  virtual unsigned short dim () const override final { return 1; }
74 
78  virtual unsigned int n_nodes() const override { return 2; }
79 
83  virtual unsigned int n_sides() const override final { return 2; }
84 
88  virtual unsigned int n_vertices() const override final { return 2; }
89 
93  virtual unsigned int n_edges() const override final { return 0; }
94 
98  virtual unsigned int n_faces() const override final { return 0; }
99 
103  virtual unsigned int n_children() const override final { return 2; }
104 
108  virtual bool is_child_on_side(const unsigned int c,
109  const unsigned int s) const override final;
110 
114  virtual bool is_edge_on_side(const unsigned int,
115  const unsigned int) const override final
116  { return false; }
117 
122  virtual unsigned int opposite_side(const unsigned int s) const override final;
123 
129  virtual unsigned int opposite_node(const unsigned int n,
130  const unsigned int s) const override final;
131 
135  using Elem::key;
136 
141  virtual dof_id_type key (const unsigned int s) const override final
142  { return this->compute_key(this->node_id(s)); }
143 
150  virtual dof_id_type low_order_key (const unsigned int s) const override final
151  { return this->compute_key(this->node_id(s)); }
152 
156  virtual unsigned int local_side_node(unsigned int side,
157  unsigned int /*side_node*/) const override final;
158 
163  virtual unsigned int local_edge_node(unsigned int edge,
164  unsigned int edge_node) const override final;
165 
169  virtual std::unique_ptr<Elem> side_ptr (const unsigned int i) override final;
170 
174  virtual void side_ptr (std::unique_ptr<Elem> & side, const unsigned int i) override final;
175 
179  virtual std::unique_ptr<Elem> build_side_ptr (const unsigned int i) override final;
180 
184  virtual void build_side_ptr (std::unique_ptr<Elem> & elem,
185  const unsigned int i) override final;
186 
187  // Avoid hiding deprecated version with different signature
188  using Elem::build_side_ptr;
189 
193  virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int) override final
194  { libmesh_not_implemented(); return std::unique_ptr<Elem>(); }
195 
199  virtual void build_edge_ptr (std::unique_ptr<Elem> &, const unsigned int) override final
200  { libmesh_not_implemented(); }
201 
202  virtual std::vector<unsigned int> nodes_on_side(const unsigned int s) const override;
203 
204  virtual std::vector<unsigned int> nodes_on_edge(const unsigned int e) const override;
205 
206  virtual std::vector<unsigned int> sides_on_edge(const unsigned int) const override final
207  { return {}; }
208 
215  virtual std::vector<unsigned int> edges_adjacent_to_node(const unsigned int /*n*/) const override final
216  { return {}; }
217 
225  virtual Point quasicircumcenter () const override
226  { return (this->point(0) + this->point(1)) / 2; }
227 
228  // Any edge permutation flips the mapping Jacobian negative
229  virtual unsigned int n_permutations() const override final { return 0; }
230 
231  virtual void permute(unsigned int) override final { libmesh_error(); }
232 
233  virtual bool is_flipped() const override final;
234 
235  unsigned int center_node_on_side(const unsigned short side) const override final;
236 
237  ElemType side_type (const unsigned int s) const override final;
238 
239  virtual bool on_reference_element(const Point & p,
240  const Real eps = TOLERANCE) const override final;
241 
242 protected:
243 
247  Elem * _elemlinks_data[3+(LIBMESH_DIM>1)];
248 
249 #ifdef LIBMESH_ENABLE_AMR
250 
254  unsigned int side_children_matrix (const unsigned int,
255  const unsigned int) const
256  { libmesh_not_implemented(); return 0; }
257 
258 #endif
259 
260 };
261 
262 } // namespace libMesh
263 
264 #endif // LIBMESH_EDGE_H
virtual unsigned int n_vertices() const override final
Definition: edge.h:88
ElemType
Defines an enum for geometric element types.
A Node is like a Point, but with more information.
Definition: node.h:52
Edge(const unsigned int nn, Elem *p, Node **nodelinkdata)
Default line element, takes number of nodes and parent.
Definition: edge.h:45
virtual unsigned int local_edge_node(unsigned int edge, unsigned int edge_node) const override final
Throws an error.
Definition: edge.C:47
Elem * _elemlinks_data[3+(LIBMESH_DIM >1)]
Data for links to parent/neighbor/interior_parent elements.
Definition: edge.h:247
virtual std::vector< unsigned int > nodes_on_side(const unsigned int s) const override
Definition: edge.C:147
virtual unsigned int local_side_node(unsigned int side, unsigned int) const override final
Definition: edge.C:38
virtual dof_id_type key(const unsigned int s) const override final
Definition: edge.h:141
unsigned int side_children_matrix(const unsigned int, const unsigned int) const
Matrix that allows children to inherit boundary conditions.
Definition: edge.h:254
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i)=0
virtual dof_id_type key() const
Definition: elem.C:753
static constexpr Real TOLERANCE
static const int nodes_per_edge
Definition: edge.h:68
virtual bool is_flipped() const override final
Definition: edge.C:173
virtual unsigned short dim() const override final
Definition: edge.h:73
virtual unsigned int n_edges() const override final
Definition: edge.h:93
This is the base class from which all geometric element types are derived.
Definition: elem.h:94
The libMesh namespace provides an interface to certain functionality in the library.
static const int num_sides
Geometric constants for all Edges.
Definition: edge.h:64
virtual void permute(unsigned int) override final
Permutes the element (by swapping node and neighbor pointers) according to the specified index...
Definition: edge.h:231
void set_interior_parent(Elem *p)
Sets the pointer to the element&#39;s interior_parent.
Definition: elem.C:1248
virtual unsigned int n_permutations() const override final
Returns the number of independent permutations of element nodes - e.g.
Definition: edge.h:229
static const int num_children
Definition: edge.h:66
virtual std::vector< unsigned int > edges_adjacent_to_node(const unsigned int) const override final
1D elements don&#39;t have any edges, but they are themselves edges, so I guess an argument could be made...
Definition: edge.h:215
virtual bool is_edge_on_side(const unsigned int, const unsigned int) const override final
Definition: edge.h:114
virtual std::unique_ptr< Elem > build_edge_ptr(const unsigned int) override final
The Elem::build_edge_ptr() member makes no sense for edges.
Definition: edge.h:193
virtual dof_id_type low_order_key(const unsigned int s) const override final
Definition: edge.h:150
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i) override final
Definition: edge.C:86
const int invalid_int
A number which is used quite often to represent an invalid or uninitialized value for an integer...
Definition: libmesh.h:316
virtual Point quasicircumcenter() const override
Definition: edge.h:225
virtual unsigned int opposite_side(const unsigned int s) const override final
Definition: edge.C:128
virtual std::unique_ptr< Elem > side_ptr(const unsigned int i) override final
Definition: edge.C:56
virtual ~Edge()=default
virtual unsigned int n_children() const override final
Definition: edge.h:103
virtual unsigned int n_faces() const override final
Definition: edge.h:98
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
unsigned int center_node_on_side(const unsigned short side) const override final
Definition: edge.C:159
virtual void build_edge_ptr(std::unique_ptr< Elem > &, const unsigned int) override final
The Elem::build_edge_ptr() member makes no sense for edges.
Definition: edge.h:199
static const int num_edges
Definition: edge.h:65
virtual bool on_reference_element(const Point &p, const Real eps=TOLERANCE) const override final
Definition: edge.C:188
Edge & operator=(const Edge &)=delete
The Edge is an element in 1D.
Definition: edge.h:37
ElemType side_type(const unsigned int s) const override final
Definition: edge.C:165
virtual std::vector< unsigned int > sides_on_edge(const unsigned int) const override final
Definition: edge.h:206
static dof_id_type compute_key(dof_id_type n0)
Definition: elem.h:3294
virtual unsigned int opposite_node(const unsigned int n, const unsigned int s) const override final
Definition: edge.C:136
A Point defines a location in LIBMESH_DIM dimensional Real space.
Definition: point.h:39
dof_id_type node_id(const unsigned int i) const
Definition: elem.h:2475
const Point & point(const unsigned int i) const
Definition: elem.h:2453
virtual unsigned int n_nodes() const override
Definition: edge.h:78
virtual std::vector< unsigned int > nodes_on_edge(const unsigned int e) const override
Definition: edge.C:154
uint8_t dof_id_type
Definition: id_types.h:67
virtual bool is_child_on_side(const unsigned int c, const unsigned int s) const override final
Definition: edge.C:117
virtual unsigned int n_sides() const override final
Definition: edge.h:83
static const int nodes_per_side
Definition: edge.h:67