Flow123d  master-8d5574fc2
Public Member Functions | Private Attributes | List of all members
DHEdgeSide Class Reference

Class allows to iterate over sides of edge. More...

#include <dh_cell_accessor.hh>

Collaboration diagram for DHEdgeSide:
Collaboration graph
[legend]

Public Member Functions

 DHEdgeSide ()
 Default invalid accessor. More...
 
 DHEdgeSide (const DHCellSide &cell_side, unsigned int side_idx)
 
bool is_valid () const
 Check validity of accessor (see default constructor) More...
 
void inc ()
 Iterates to next edge side. More...
 
bool operator== (const DHEdgeSide &other)
 Comparison of accessors. More...
 
 operator DHCellSide () const
 This class is implicitly convertible to DHCellSide. More...
 

Private Attributes

const DOFHandlerMultiDimdof_handler_
 Pointer to the DOF handler owning the element. More...
 
unsigned int edge_idx_
 Global index of Edge. More...
 
unsigned int side_idx_
 Index of side owned by Edge. More...
 

Detailed Description

Class allows to iterate over sides of edge.

Iterator is defined by:

Note: Class is used only internally. Appropriate range method (DHCellSide::edge_sides) uses convertible iterators and returns corresponding DHCellSide.

Definition at line 293 of file dh_cell_accessor.hh.

Constructor & Destructor Documentation

◆ DHEdgeSide() [1/2]

DHEdgeSide::DHEdgeSide ( )
inline

Default invalid accessor.

Definition at line 296 of file dh_cell_accessor.hh.

◆ DHEdgeSide() [2/2]

DHEdgeSide::DHEdgeSide ( const DHCellSide cell_side,
unsigned int  side_idx 
)
inline

Valid accessor allows iterate over sides.

Definition at line 301 of file dh_cell_accessor.hh.

Member Function Documentation

◆ inc()

void DHEdgeSide::inc ( )
inline

Iterates to next edge side.

Definition at line 313 of file dh_cell_accessor.hh.

◆ is_valid()

bool DHEdgeSide::is_valid ( ) const
inline

Check validity of accessor (see default constructor)

Definition at line 308 of file dh_cell_accessor.hh.

◆ operator DHCellSide()

DHEdgeSide::operator DHCellSide ( ) const
inline

This class is implicitly convertible to DHCellSide.

Definition at line 323 of file dh_cell_accessor.hh.

◆ operator==()

bool DHEdgeSide::operator== ( const DHEdgeSide other)
inline

Comparison of accessors.

Definition at line 318 of file dh_cell_accessor.hh.

Member Data Documentation

◆ dof_handler_

const DOFHandlerMultiDim* DHEdgeSide::dof_handler_
private

Pointer to the DOF handler owning the element.

Definition at line 331 of file dh_cell_accessor.hh.

◆ edge_idx_

unsigned int DHEdgeSide::edge_idx_
private

Global index of Edge.

Definition at line 333 of file dh_cell_accessor.hh.

◆ side_idx_

unsigned int DHEdgeSide::side_idx_
private

Index of side owned by Edge.

Definition at line 335 of file dh_cell_accessor.hh.


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