libMesh
Public Member Functions | Private Member Functions | Private Attributes | List of all members
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)
 
SideIteroperator= (const SideIter &other)
 
Elem *& operator* () const
 
SideIteroperator++ ()
 
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 3355 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 3359 of file elem.h.

3361  : _side(),
3362  _side_ptr(nullptr),
3363  _parent(parent),
3364  _side_number(side_number)
3365  {}
const Elem * parent() const
Definition: elem.h:3030
unsigned int _side_number
Definition: elem.h:3459
std::unique_ptr< Elem > _side
Definition: elem.h:3444

◆ SideIter() [2/3]

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

Definition at line 3369 of file elem.h.

3370  : _side(),
3371  _side_ptr(nullptr),
3372  _parent(nullptr),
3374  {}
const unsigned int invalid_uint
A number which is used quite often to represent an invalid or uninitialized value for an unsigned int...
Definition: libmesh.h:310
unsigned int _side_number
Definition: elem.h:3459
std::unique_ptr< Elem > _side
Definition: elem.h:3444

◆ SideIter() [3/3]

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

Definition at line 3378 of file elem.h.

3379  : _side(),
3380  _side_ptr(nullptr),
3381  _parent(other._parent),
3382  _side_number(other._side_number)
3383  {}
unsigned int _side_number
Definition: elem.h:3459
std::unique_ptr< Elem > _side
Definition: elem.h:3444

Member Function Documentation

◆ _update_side_ptr()

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

Definition at line 3432 of file elem.h.

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

Referenced by operator*().

3433  {
3434  // Construct new side, store in std::unique_ptr
3435  this->_side = this->_parent->build_side_ptr(this->_side_number);
3436 
3437  // Also set our internal naked pointer. Memory is still owned
3438  // by the std::unique_ptr.
3439  this->_side_ptr = _side.get();
3440  }
virtual std::unique_ptr< Elem > build_side_ptr(const unsigned int i)=0
unsigned int _side_number
Definition: elem.h:3459
std::unique_ptr< Elem > _side
Definition: elem.h:3444

◆ operator*()

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

Definition at line 3395 of file elem.h.

References _side_ptr, and _update_side_ptr().

3396  {
3397  // Set the std::unique_ptr
3398  this->_update_side_ptr();
3399 
3400  // Return a reference to _side_ptr
3401  return this->_side_ptr;
3402  }
void _update_side_ptr() const
Definition: elem.h:3432

◆ operator++()

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

Definition at line 3405 of file elem.h.

References _side_number.

3406  {
3407  ++_side_number;
3408  return *this;
3409  }
unsigned int _side_number
Definition: elem.h:3459

◆ operator=()

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

Definition at line 3387 of file elem.h.

References _parent, and _side_number.

3388  {
3389  this->_parent = other._parent;
3390  this->_side_number = other._side_number;
3391  return *this;
3392  }
unsigned int _side_number
Definition: elem.h:3459

◆ operator==()

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

Definition at line 3413 of file elem.h.

References _parent, and _side_number.

3414  {
3415  return (this->_side_number == other._side_number &&
3416  this->_parent == other._parent);
3417  }
unsigned int _side_number
Definition: elem.h:3459

◆ side_on_boundary()

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

Definition at line 3424 of file elem.h.

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

3425  {
3426  return this->_parent->neighbor_ptr(_side_number) == nullptr;
3427  }
unsigned int _side_number
Definition: elem.h:3459
const Elem * neighbor_ptr(unsigned int i) const
Definition: elem.h:2598

Member Data Documentation

◆ _parent

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

Definition at line 3456 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 3444 of file elem.h.

Referenced by _update_side_ptr().

◆ _side_number

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

Definition at line 3459 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 3453 of file elem.h.

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


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