libMesh::Side< SideType, ParentType > Class Template Reference

This defines the Side class. More...

#include <side.h>

Inheritance diagram for libMesh::Side< SideType, ParentType >:

Public Member Functions
	Side (const Elem *parent_in, const unsigned int side_in)
	Constructor. More...
	Side (Side &&)=delete
	Side (const Side &)=delete
Side &	operator= (const Side &)=delete
Side &	operator= (Side &&)=delete
virtual	~Side ()=default
virtual Node *&	set_node (const unsigned int i) override
	Setting a side node changes the node on the parent. More...

Private Attributes
const unsigned int	_side_number
	The side on the parent element. More...

Detailed Description

template<class SideType, class ParentType>
class libMesh::Side< SideType, ParentType >

This defines the Side class.

A Side is basically a proxy (or stand-in replacement) class for an element's side. 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

Benjamin S. Kirk

Date

2004

Proxy class for efficiently representing an Elem's side.

Definition at line 48 of file side.h.

Constructor & Destructor Documentation

Side() [1/3]

template<class SideType , class ParentType >

libMesh::Side< SideType, ParentType >::Side ( const Elem *  parent_in, const unsigned int  side_in  )

inline

Constructor.

Creates a side from an element.

Definition at line 55 of file side.h.

                                    :
    SideType(const_cast<Elem *>(parent_in)),
    _side_number(side_in)
  {
    libmesh_assert(parent_in);
    // may not be true when building infinite element sides
    // libmesh_assert_less (_side_number, this->parent()->n_sides());
    libmesh_assert_equal_to ((this->dim()+1), this->parent()->dim());
 
    for (auto n : this->node_index_range())
      this->_nodes[n] = this->parent()->node_ptr
        (ParentType::side_nodes_map[_side_number][n]);
  }

References libMesh::Side< SideType, ParentType >::_side_number, dim, and libMesh::libmesh_assert().

Side() [2/3]

template<class SideType , class ParentType >

libMesh::Side< SideType, ParentType >::Side ( Side< SideType, ParentType > &&  )

delete

Side() [3/3]

template<class SideType , class ParentType >

libMesh::Side< SideType, ParentType >::Side ( const Side< SideType, ParentType > &  )

delete

~Side()

template<class SideType , class ParentType >

virtual libMesh::Side< SideType, ParentType >::~Side ( )

virtualdefault

Member Function Documentation

operator=() [1/2]

template<class SideType , class ParentType >

Side& libMesh::Side< SideType, ParentType >::operator= ( const Side< SideType, ParentType > &  )

delete

operator=() [2/2]

template<class SideType , class ParentType >

Side& libMesh::Side< SideType, ParentType >::operator= ( Side< SideType, ParentType > &&  )

delete

set_node()

template<class SideType , class ParentType >

virtual Node* & libMesh::Side< SideType, ParentType >::set_node ( const unsigned int  i )

inlineoverridevirtual

Setting a side node changes the node on the parent.

Definition at line 79 of file side.h.

  {
    libmesh_assert_less (i, this->n_nodes());
    return this->parent()->set_node (ParentType::side_nodes_map[_side_number][i]);
  }

References libMesh::Side< SideType, ParentType >::_side_number, and n_nodes.

Member Data Documentation

_side_number

template<class SideType , class ParentType >

const unsigned int libMesh::Side< SideType, ParentType >::_side_number

private

The side on the parent element.

Definition at line 90 of file side.h.

Referenced by libMesh::Side< SideType, ParentType >::set_node(), and libMesh::Side< SideType, ParentType >::Side().

---

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

• include/geom/side.h