Flow123d  release_3.0.0-973-g92f55e826
Public Member Functions | Private Attributes | Friends | List of all members
DHCellAccessor Class Reference

#include <dh_cell_accessor.hh>

Collaboration diagram for DHCellAccessor:
Collaboration graph
[legend]

Public Member Functions

 DHCellAccessor ()
 
 DHCellAccessor (const DOFHandlerMultiDim *dof_handler, unsigned int loc_idx)
 
unsigned int local_idx () const
 Return local index to element (index of DOF handler). More...
 
unsigned int elm_idx () const
 Return serial idx to element of loc_ele_idx_. More...
 
const ElementAccessor< 3 > elm () const
 Return ElementAccessor to element of loc_ele_idx_. More...
 
unsigned int get_dof_indices (std::vector< int > &indices) const
 Fill vector of the global indices of dofs associated to the cell. More...
 
unsigned int get_loc_dof_indices (std::vector< LongIdx > &indices) const
 Returns the indices of dofs associated to the cell on the local process. More...
 
unsigned int n_dofs () const
 Return number of dofs on given cell. More...
 
const Dofcell_dof (unsigned int idof) const
 Return dof on a given cell. More...
 
unsigned int dim () const
 Return dimension of element appropriate to cell. More...
 
template<unsigned int dim>
FiniteElement< dim > * fe () const
 Returns finite element object for given space dimension. More...
 
bool is_valid () const
 Check validity of accessor (see default constructor) More...
 
Range< DHCellSideside_range () const
 Returns range of cell sides. More...
 
Range< DHNeighbSideneighb_sides () const
 Returns range of neighbour cells of higher dimension. More...
 
void inc ()
 Iterates to next local element. More...
 
bool operator== (const DHCellAccessor &other)
 Comparison of accessors. More...
 

Private Attributes

const DOFHandlerMultiDimdof_handler_
 Pointer to the DOF handler owning the element. More...
 
unsigned int loc_ele_idx_
 Index into DOFHandler::el_4_loc array. More...
 

Friends

class DHCellSide
 

Detailed Description

Cell accessor allow iterate over DOF handler cells.

Iterating is possible over different ranges of local and ghost elements.

Definition at line 36 of file dh_cell_accessor.hh.

Constructor & Destructor Documentation

◆ DHCellAccessor() [1/2]

DHCellAccessor::DHCellAccessor ( )
inline

Default invalid accessor.

Definition at line 41 of file dh_cell_accessor.hh.

◆ DHCellAccessor() [2/2]

DHCellAccessor::DHCellAccessor ( const DOFHandlerMultiDim dof_handler,
unsigned int  loc_idx 
)
inline

DOF cell accessor.

Definition at line 48 of file dh_cell_accessor.hh.

Member Function Documentation

◆ cell_dof()

const Dof & DHCellAccessor::cell_dof ( unsigned int  idof) const
inline

Return dof on a given cell.

Parameters
idofNumber of dof on the cell.

Definition at line 349 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ dim()

unsigned int DHCellAccessor::dim ( ) const
inline

Return dimension of element appropriate to cell.

Definition at line 94 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ elm()

const ElementAccessor<3> DHCellAccessor::elm ( ) const
inline

Return ElementAccessor to element of loc_ele_idx_.

Definition at line 66 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ elm_idx()

unsigned int DHCellAccessor::elm_idx ( ) const
inline

Return serial idx to element of loc_ele_idx_.

Definition at line 59 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ fe()

template<unsigned int dim>
FiniteElement<dim>* DHCellAccessor::fe ( ) const
inline

Returns finite element object for given space dimension.

Definition at line 102 of file dh_cell_accessor.hh.

◆ get_dof_indices()

unsigned int DHCellAccessor::get_dof_indices ( std::vector< int > &  indices) const
inline

Fill vector of the global indices of dofs associated to the cell.

Parameters
indicesVector of dof indices on the cell.

Definition at line 309 of file dh_cell_accessor.hh.

◆ get_loc_dof_indices()

unsigned int DHCellAccessor::get_loc_dof_indices ( std::vector< LongIdx > &  indices) const
inline

Returns the indices of dofs associated to the cell on the local process.

Parameters
indicesArray of dof indices on the cell.

Definition at line 321 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ inc()

void DHCellAccessor::inc ( )
inline

Iterates to next local element.

Definition at line 119 of file dh_cell_accessor.hh.

◆ is_valid()

bool DHCellAccessor::is_valid ( ) const
inline

Check validity of accessor (see default constructor)

Definition at line 108 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ local_idx()

unsigned int DHCellAccessor::local_idx ( ) const
inline

Return local index to element (index of DOF handler).

Definition at line 53 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ n_dofs()

unsigned int DHCellAccessor::n_dofs ( ) const
inline

Return number of dofs on given cell.

Definition at line 332 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

◆ neighb_sides()

Range< DHNeighbSide > DHCellAccessor::neighb_sides ( ) const
inline

Returns range of neighbour cells of higher dimension.

Definition at line 373 of file dh_cell_accessor.hh.

◆ operator==()

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

Comparison of accessors.

Definition at line 124 of file dh_cell_accessor.hh.

◆ side_range()

Range< DHCellSide > DHCellAccessor::side_range ( ) const
inline

Returns range of cell sides.

Definition at line 366 of file dh_cell_accessor.hh.

Friends And Related Function Documentation

◆ DHCellSide

friend class DHCellSide
friend

Definition at line 134 of file dh_cell_accessor.hh.

Member Data Documentation

◆ dof_handler_

const DOFHandlerMultiDim* DHCellAccessor::dof_handler_
private

Pointer to the DOF handler owning the element.

Definition at line 130 of file dh_cell_accessor.hh.

◆ loc_ele_idx_

unsigned int DHCellAccessor::loc_ele_idx_
private

Index into DOFHandler::el_4_loc array.

Definition at line 132 of file dh_cell_accessor.hh.


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