Flow123d  build_with_4.0.3-ea9b1ad
Public Member Functions | Private Attributes | Friends | List of all members
DHCellSide Class Reference

Side accessor allows to iterate over sides of DOF handler cell. More...

#include <dh_cell_accessor.hh>

Collaboration diagram for DHCellSide:
Collaboration graph
[legend]

Public Member Functions

 DHCellSide ()
 Default invalid accessor. More...
 
 DHCellSide (const DHCellAccessor &dh_cell_accessor, unsigned int side_idx)
 
virtual bool is_valid () const
 Check validity of accessor (see default constructor) More...
 
Side side () const
 Return Side of given cell and side_idx. More...
 
const DHCellAccessor & cell () const
 Return DHCellAccessor appropriate to the side. More...
 
DHCellAccessor & cell ()
 Return DHCellAccessor appropriate to the side. More...
 
unsigned int dim () const
 Return dimension of element appropriate to the side. More...
 
arma::vec3 centre () const
 Side centre. More...
 
ElementAccessor< 3 > element () const
 
unsigned int elem_idx () const
 
Boundary cond () const
 
unsigned int side_idx () const
 
double measure () const
 
double diameter () const
 
RangeConvert< DHEdgeSide, DHCellSide > edge_sides () const
 Returns range of all sides looped over common Edge. More...
 
unsigned int n_edge_sides () const
 
virtual void inc ()
 Iterates to next local element. More...
 
bool operator== (const DHCellSide &other)
 Comparison of accessors. More...
 
bool operator!= (const DHCellSide &other) const
 

Private Attributes

DHCellAccessor dh_cell_accessor_
 Appropriate DHCellAccessor. More...
 
unsigned int side_idx_
 Index of side. More...
 

Friends

class DHEdgeSide
 

Detailed Description

Side accessor allows to iterate over sides of DOF handler cell.

Iterator is defined by:

Definition at line 176 of file dh_cell_accessor.hh.

Constructor & Destructor Documentation

◆ DHCellSide() [1/2]

DHCellSide::DHCellSide ( )
inline

Default invalid accessor.

Create invalid dh_cell_accessor_.

Definition at line 184 of file dh_cell_accessor.hh.

◆ DHCellSide() [2/2]

DHCellSide::DHCellSide ( const DHCellAccessor &  dh_cell_accessor,
unsigned int  side_idx 
)
inline

DOF cell side accessor.

Definition at line 189 of file dh_cell_accessor.hh.

Member Function Documentation

◆ cell() [1/2]

DHCellAccessor& DHCellSide::cell ( )
inline

Return DHCellAccessor appropriate to the side.

Definition at line 209 of file dh_cell_accessor.hh.

◆ cell() [2/2]

const DHCellAccessor& DHCellSide::cell ( ) const
inline

Return DHCellAccessor appropriate to the side.

Definition at line 204 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ centre()

arma::vec3 DHCellSide::centre ( ) const
inline

Side centre.

Definition at line 219 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ cond()

Boundary DHCellSide::cond ( ) const
inline

Definition at line 231 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ diameter()

double DHCellSide::diameter ( ) const
inline

Definition at line 243 of file dh_cell_accessor.hh.

◆ dim()

unsigned int DHCellSide::dim ( ) const
inline

Return dimension of element appropriate to the side.

Definition at line 214 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ edge_sides()

RangeConvert< DHEdgeSide, DHCellSide > DHCellSide::edge_sides ( ) const
inline

Returns range of all sides looped over common Edge.

Definition at line 479 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ elem_idx()

unsigned int DHCellSide::elem_idx ( ) const
inline

Definition at line 227 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ element()

ElementAccessor<3> DHCellSide::element ( ) const
inline

Definition at line 223 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ inc()

virtual void DHCellSide::inc ( )
inlinevirtual

Iterates to next local element.

Definition at line 259 of file dh_cell_accessor.hh.

◆ is_valid()

virtual bool DHCellSide::is_valid ( ) const
inlinevirtual

Check validity of accessor (see default constructor)

Definition at line 193 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ measure()

double DHCellSide::measure ( ) const
inline

Definition at line 239 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ n_edge_sides()

unsigned int DHCellSide::n_edge_sides ( ) const
inline

Returns total number of sides appropriate to Edge that owns actual cell side.

return empty range if no element connected to Edge is local

Definition at line 485 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ operator!=()

bool DHCellSide::operator!= ( const DHCellSide &  other) const
inline

Definition at line 268 of file dh_cell_accessor.hh.

◆ operator==()

bool DHCellSide::operator== ( const DHCellSide &  other)
inline

Comparison of accessors.

Definition at line 264 of file dh_cell_accessor.hh.

◆ side()

Side DHCellSide::side ( ) const
inline

Return Side of given cell and side_idx.

Definition at line 198 of file dh_cell_accessor.hh.

◆ side_idx()

unsigned int DHCellSide::side_idx ( ) const
inline

Definition at line 235 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ DHEdgeSide

friend class DHEdgeSide
friend

Definition at line 278 of file dh_cell_accessor.hh.

Member Data Documentation

◆ dh_cell_accessor_

DHCellAccessor DHCellSide::dh_cell_accessor_
private

Appropriate DHCellAccessor.

Definition at line 274 of file dh_cell_accessor.hh.

◆ side_idx_

unsigned int DHCellSide::side_idx_
private

Index of side.

Definition at line 276 of file dh_cell_accessor.hh.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.1