libMesh::Elem::SideIter Class Reference

The definition of the protected nested SideIter class. More...

#include <elem.h>

Public Member Functions
	SideIter (const unsigned int side_number, Elem *parent)
	SideIter ()
	SideIter (const SideIter &other)
SideIter &	operator= (const SideIter &other)
Elem *&	operator* () const
SideIter &	operator++ ()
bool	operator== (const SideIter &other) const
bool	side_on_boundary () const

Private Member Functions
void	_update_side_ptr () const

Private Attributes
std::unique_ptr< Elem >	_side
Elem *	_side_ptr
Elem *	_parent
unsigned int	_side_number

Detailed Description

The definition of the protected nested SideIter class.

Definition at line 3372 of file elem.h.

Constructor & Destructor Documentation

SideIter() [1/3]

libMesh::Elem::SideIter::SideIter ( const unsigned int  side_number, Elem *  parent  )

inline

Definition at line 3376 of file elem.h.

    : _side(),
      _side_ptr(nullptr),
      _parent(parent),
      _side_number(side_number)
  {}

SideIter() [2/3]

libMesh::Elem::SideIter::SideIter ( )

inline

Definition at line 3386 of file elem.h.

    : _side(),
      _side_ptr(nullptr),
      _parent(nullptr),
      _side_number(libMesh::invalid_uint)
  {}

SideIter() [3/3]

libMesh::Elem::SideIter::SideIter ( const SideIter &  other )

inline

Definition at line 3395 of file elem.h.

    : _side(),
      _side_ptr(nullptr),
      _parent(other._parent),
      _side_number(other._side_number)
  {}

Member Function Documentation

_update_side_ptr()

void libMesh::Elem::SideIter::_update_side_ptr ( ) const

inlineprivate

Definition at line 3449 of file elem.h.

  {
    // Construct new side, store in std::unique_ptr
    this->_side = this->_parent->build_side_ptr(this->_side_number);
 
    // Also set our internal naked pointer.  Memory is still owned
    // by the std::unique_ptr.
    this->_side_ptr = _side.get();
  }

References _parent, _side, _side_number, _side_ptr, and libMesh::Elem::build_side_ptr().

Referenced by operator*().

operator*()

Elem *& libMesh::Elem::SideIter::operator* ( ) const

inline

Definition at line 3412 of file elem.h.

  {
    // Set the std::unique_ptr
    this->_update_side_ptr();
 
    // Return a reference to _side_ptr
    return this->_side_ptr;
  }

References _side_ptr, and _update_side_ptr().

operator++()

SideIter & libMesh::Elem::SideIter::operator++ ( )

inline

Definition at line 3422 of file elem.h.

  {
    ++_side_number;
    return *this;
  }

References _side_number.

operator=()

SideIter & libMesh::Elem::SideIter::operator= ( const SideIter &  other )

inline

Definition at line 3404 of file elem.h.

  {
    this->_parent      = other._parent;
    this->_side_number = other._side_number;
    return *this;
  }

References _parent, and _side_number.

operator==()

bool libMesh::Elem::SideIter::operator== ( const SideIter &  other ) const

inline

Definition at line 3430 of file elem.h.

  {
    return (this->_side_number == other._side_number &&
            this->_parent      == other._parent);
  }

References _parent, and _side_number.

side_on_boundary()

bool libMesh::Elem::SideIter::side_on_boundary ( ) const

inline

Definition at line 3441 of file elem.h.

  {
    return this->_parent->neighbor_ptr(_side_number) == nullptr;
  }

References _parent, _side_number, and libMesh::Elem::neighbor_ptr().

Member Data Documentation

_parent

Elem* libMesh::Elem::SideIter::_parent

private

Definition at line 3473 of file elem.h.

Referenced by _update_side_ptr(), operator=(), operator==(), and side_on_boundary().

_side

std::unique_ptr<Elem> libMesh::Elem::SideIter::_side

mutableprivate

Definition at line 3461 of file elem.h.

Referenced by _update_side_ptr().

_side_number

unsigned int libMesh::Elem::SideIter::_side_number

private

Definition at line 3476 of file elem.h.

Referenced by _update_side_ptr(), operator++(), operator=(), operator==(), and side_on_boundary().

_side_ptr

Elem* libMesh::Elem::SideIter::_side_ptr

mutableprivate

Definition at line 3470 of file elem.h.

Referenced by _update_side_ptr(), and operator*().

---

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

• include/geom/elem.h