libMesh
Public Member Functions | Private Attributes | List of all members
libMesh::SideEdge< EdgeType, ParentType > Class Template Reference

This defines the SideEdge class. More...

#include <side.h>

Inheritance diagram for libMesh::SideEdge< EdgeType, ParentType >:
[legend]

Public Member Functions

 SideEdge (const Elem *my_parent, const unsigned int my_edge)
 Constructor. More...
 
virtual Node *& set_node (const unsigned int i) override
 Setting an edge node changes the node on the parent. More...
 
virtual unsigned int n_sides () const override
 

Private Attributes

const unsigned int _edge_number
 The side on the parent element. More...
 

Detailed Description

template<class EdgeType, class ParentType>
class libMesh::SideEdge< EdgeType, ParentType >

This defines the SideEdge class.

Like Side, SideEdge is basically a proxy (or stand-in replacement) class, this time for an element's edge. It acts like a standard Elem, but allocates no additional memory for storing connectivity. Instead, its nodes are mapped directly from the parent element (the element for which the side is created). Similarly, you cannot access the neighbors of a side since it does not store any.

Author
Roy H. Stogner

Definition at line 117 of file side.h.

Constructor & Destructor Documentation

◆ SideEdge()

template<class EdgeType , class ParentType >
libMesh::SideEdge< EdgeType, ParentType >::SideEdge ( const Elem my_parent,
const unsigned int  my_edge 
)

Constructor.

Creates a side from an element.

Definition at line 124 of file side.h.

References libMesh::SideEdge< EdgeType, ParentType >::_edge_number.

125  :
126  EdgeType(const_cast<Elem *>(my_parent)),
127  _edge_number(my_edge)
128  {
129  libmesh_assert(my_parent);
130  libmesh_assert_less (_edge_number, this->parent()->n_edges());
131  libmesh_assert_equal_to (this->dim(), 1);
132 
133  for (auto n : this->node_index_range())
134  this->_nodes[n] = this->parent()->node_ptr
135  (ParentType::edge_nodes_map[_edge_number][n]);
136  }
const unsigned int _edge_number
The side on the parent element.
Definition: side.h:157

Member Function Documentation

◆ n_sides()

template<class EdgeType , class ParentType >
virtual unsigned int libMesh::SideEdge< EdgeType, ParentType >::n_sides ( ) const
overridevirtual
Returns
0. Edges do not have sides, so don't even ask!

Definition at line 150 of file side.h.

150 { return 0; }

◆ set_node()

template<class EdgeType , class ParentType >
virtual Node* & libMesh::SideEdge< EdgeType, ParentType >::set_node ( const unsigned int  i)
overridevirtual

Setting an edge node changes the node on the parent.

Definition at line 141 of file side.h.

References libMesh::SideEdge< EdgeType, ParentType >::_edge_number, and libMesh::MeshTools::n_nodes().

142  {
143  libmesh_assert_less (i, this->n_nodes());
144  return this->parent()->set_node (ParentType::edge_nodes_map[_edge_number][i]);
145  }
dof_id_type n_nodes(const MeshBase::const_node_iterator &begin, const MeshBase::const_node_iterator &end)
Count up the number of nodes of a specific type (as defined by an iterator range).
const unsigned int _edge_number
The side on the parent element.
Definition: side.h:157

Member Data Documentation

◆ _edge_number

template<class EdgeType , class ParentType >
const unsigned int libMesh::SideEdge< EdgeType, ParentType >::_edge_number
private

The side on the parent element.

Definition at line 157 of file side.h.

Referenced by libMesh::SideEdge< EdgeType, ParentType >::set_node(), and libMesh::SideEdge< EdgeType, ParentType >::SideEdge().


The documentation for this class was generated from the following file: