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

Cell accessor allow iterate over DOF handler cells. More...

#include <dh_cell_accessor.hh>

Collaboration diagram for DHCellAccessor:
Collaboration graph
[legend]

Public Member Functions

 DHCellAccessor ()
 Default invalid accessor. More...
 
 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...
 
RangeConvert< DHNeighbSide, DHCellSideneighb_sides () const
 Returns range of neighbour cell of lower dimension corresponding to cell of higher dimension. More...
 
bool is_own () const
 Return true if accessor represents own element (false for ghost element) 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
 
class DHEdgeSide
 
class DHNeighbSide
 

Detailed Description

Cell accessor allow iterate over DOF handler cells.

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

Iterator is defined by:

Definition at line 40 of file dh_cell_accessor.hh.

Constructor & Destructor Documentation

DHCellAccessor::DHCellAccessor ( )
inline

Default invalid accessor.

Definition at line 43 of file dh_cell_accessor.hh.

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

DOF cell accessor.

Definition at line 50 of file dh_cell_accessor.hh.

Member Function Documentation

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 387 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

unsigned int DHCellAccessor::dim ( ) const
inline

Return dimension of element appropriate to cell.

Definition at line 96 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

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

Return ElementAccessor to element of loc_ele_idx_.

Definition at line 68 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

unsigned int DHCellAccessor::elm_idx ( ) const
inline

Return serial idx to element of loc_ele_idx_.

Definition at line 61 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

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

Returns finite element object for given space dimension.

Definition at line 104 of file dh_cell_accessor.hh.

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 347 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

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 359 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

void DHCellAccessor::inc ( )
inline

Iterates to next local element.

Definition at line 126 of file dh_cell_accessor.hh.

bool DHCellAccessor::is_own ( ) const
inline

Return true if accessor represents own element (false for ghost element)

Definition at line 121 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

bool DHCellAccessor::is_valid ( ) const
inline

Check validity of accessor (see default constructor)

Definition at line 110 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

unsigned int DHCellAccessor::local_idx ( ) const
inline

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

Definition at line 55 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

unsigned int DHCellAccessor::n_dofs ( ) const
inline

Return number of dofs on given cell.

Definition at line 370 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

RangeConvert< DHNeighbSide, DHCellSide > DHCellAccessor::neighb_sides ( ) const
inline

Returns range of neighbour cell of lower dimension corresponding to cell of higher dimension.

Definition at line 411 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

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

Comparison of accessors.

Definition at line 131 of file dh_cell_accessor.hh.

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

Returns range of cell sides.

Definition at line 404 of file dh_cell_accessor.hh.

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class DHCellSide
friend

Definition at line 141 of file dh_cell_accessor.hh.

friend class DHEdgeSide
friend

Definition at line 142 of file dh_cell_accessor.hh.

friend class DHNeighbSide
friend

Definition at line 143 of file dh_cell_accessor.hh.

Member Data Documentation

const DOFHandlerMultiDim* DHCellAccessor::dof_handler_
private

Pointer to the DOF handler owning the element.

Definition at line 137 of file dh_cell_accessor.hh.

unsigned int DHCellAccessor::loc_ele_idx_
private

Index into DOFHandler::el_4_loc array.

Definition at line 139 of file dh_cell_accessor.hh.


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