Provides the numbering of the finite element degrees of freedom on the computational mesh. More...

#include <dofhandler.hh>

Inheritance diagram for DOFHandlerMultiDim:

Collaboration diagram for DOFHandlerMultiDim:

[legend]

Public Member Functions
	DOFHandlerMultiDim (Mesh &_mesh, bool make_elem_part=true)
	Constructor. More...

void	distribute_dofs (std::shared_ptr< DiscreteSpace > ds)
	Distributes degrees of freedom on the mesh needed for the given discrete space. More...

std::shared_ptr< DOFHandlerMultiDim >	sequential ()
	Returns sequential version of the current dof handler. More...

std::shared_ptr< VecScatter >	sequential_scatter ()
	Returns scatter context from parallel to sequential vectors. More...

VectorMPI	create_vector ()
	Allocates PETSc vector according to the dof distribution. More...

unsigned int	get_dof_indices (const ElementAccessor< 3 > &cell, std::vector< LongIdx > &indices) const override
	Returns the global indices of dofs associated to the `cell`. More...

unsigned int	get_loc_dof_indices (const ElementAccessor< 3 > &cell, std::vector< LongIdx > &indices) const override
	Returns the indices of dofs associated to the `cell` on the local process. More...

LongIdx	edge_index (int loc_edg) const
	Returns the global index of local edge. More...

LongIdx	nb_index (int loc_nb) const
	Returns the global index of local neighbour. More...

unsigned int	n_loc_edges () const
	Returns number of local edges. More...

unsigned int	n_loc_nb () const
	Returns number of local neighbours. More...

bool	el_is_local (int index) const

void	print () const
	Output structure of dof handler. More...

std::size_t	hash () const override

Range< DHCellAccessor >	own_range () const
	Returns range of DOF handler cells (only range of own without ghost cells) More...

Range< DHCellAccessor >	local_range () const
	Returns range over own and ghost cells of DOF handler. More...

Range< DHCellAccessor >	ghost_range () const
	Returns range over ghosts DOF handler cells. More...

const DHCellAccessor	cell_accessor_from_element (unsigned int elm_idx) const
	Return DHCellAccessor appropriate to ElementAccessor of given idx. More...

std::shared_ptr< DiscreteSpace >	ds () const
	Return pointer to discrete space for which the handler distributes dofs. More...

	~DOFHandlerMultiDim () override
	Destructor. More...

Public Member Functions inherited from DOFHandlerBase
	DOFHandlerBase (Mesh &_mesh)
	Constructor. More...

const unsigned int	n_global_dofs () const
	Getter for the number of all mesh dofs required by the given finite element. More...

const unsigned int	lsize () const
	Returns the number of dofs on the current process. More...

const unsigned int	max_elem_dofs () const
	Returns max. number of dofs on one element. More...

std::shared_ptr< Distribution >	distr () const

Mesh *	mesh () const
	Returns the mesh. More...

virtual	~DOFHandlerBase ()
	Destructor. More...

Private Member Functions
void	make_elem_partitioning ()
	Prepare parallel distribution of elements, edges and neighbours. More...

void	init_cell_starts ()
	Initialize vector of starting indices for elements. More...

void	init_node_dof_starts (std::vector< LongIdx > &node_dof_starts)
	Initialize auxiliary vector of starting indices of nodal dofs. More...

void	init_node_status (std::vector< short int > &node_status)
	Initialize node_status. More...

void	receive_ghost_dofs (unsigned int proc, std::vector< LongIdx > &dofs)
	Obtain dof numbers on ghost elements from other processor. More...

void	send_ghost_dofs (unsigned int proc)
	Send dof numbers to other processor. More...

void	update_local_dofs (unsigned int proc, const std::vector< bool > &update_cells, const std::vector< LongIdx > &dofs, const std::vector< LongIdx > &node_dof_starts, std::vector< LongIdx > &node_dofs)
	Update dofs on local elements from ghost element dofs. More...

void	create_sequential ()
	Communicate local dof indices to all processors and create new sequential dof handler. More...

Private Attributes
std::shared_ptr< DiscreteSpace >	ds_
	Pointer to the discrete space for which the handler distributes dofs. More...

bool	is_parallel_
	Indicator for parallel/sequential dof handler. More...

std::shared_ptr< DOFHandlerMultiDim >	dh_seq_
	Sequential dof handler associated to the current (parallel) one. More...

std::shared_ptr< VecScatter >	scatter_to_seq_
	Scatter context for parallel to sequential vectors. More...

std::vector< LongIdx >	cell_starts
	Starting indices for element dofs. More...

std::vector< LongIdx >	dof_indices
	Dof numbers on local and ghost elements. More...

std::vector< LongIdx >	local_to_global_dof_idx_
	Maps local and ghost dof indices to global ones. More...

std::unordered_map< LongIdx, LongIdx >	global_to_local_el_idx_
	Maps global element index into local/ghost index (obsolete). More...

Distribution *	el_ds_
	Distribution of elements. More...

vector< LongIdx >	edg_4_loc
	Local edge index -> global edge index. More...

vector< LongIdx >	nb_4_loc
	Local neighbour index -> global neighbour index. More...

vector< LongIdx >	ghost_4_loc
	Indices of ghost cells (neighbouring with local elements). More...

set< unsigned int >	ghost_proc
	Processors of ghost elements. More...

map< unsigned int, vector< LongIdx > >	ghost_proc_el
	Arrays of ghost cells for each neighbouring processor. More...

Static Private Attributes
static const int	INVALID_NODE = 1

static const int	VALID_NODE = 2

static const int	ASSIGNED_NODE = 3

static const int	INVALID_DOF = -1

Friends
class	DHCellAccessor

class	DHCellSide

Additional Inherited Members
Protected Attributes inherited from DOFHandlerBase
unsigned int	n_global_dofs_
	Number of global dofs assigned by the handler. More...

unsigned int	lsize_
	Number of dofs associated to local process. More...

unsigned int	loffset_
	Index of the first dof on the local process. More...

unsigned int	max_elem_dofs_
	Max. number of dofs per element. More...

Mesh *	mesh_
	Pointer to the mesh to which the dof handler is associated. More...

std::shared_ptr< Distribution >	dof_ds_
	Distribution of dofs associated to local process. More...

Detailed Description

Provides the numbering of the finite element degrees of freedom on the computational mesh.

Class DOFHandlerMultiDim distributes the degrees of freedom (dof) for a particular triplet of 1d, 2d and 3d finite elements on the computational mesh and provides mappings between local and global dofs. The template parameter dim denotes the spatial dimension of the reference finite element.

Currently the functionality is restricted to finite elements with internal and nodal dofs, i.e. the neighboring elements can share only dofs on nodes.

Definition at line 152 of file dofhandler.hh.

Constructor & Destructor Documentation

◆ DOFHandlerMultiDim()

DOFHandlerMultiDim::DOFHandlerMultiDim	(	Mesh &	_mesh,
		bool	make_elem_part = `true`
	)

Constructor.

Parameters

_mesh	The mesh.
make_elem_part	Allow switch off make_element_partitioning, necessary for boundary DOF handler.

Definition at line 42 of file dofhandler.cc.

◆ ~DOFHandlerMultiDim()

DOFHandlerMultiDim::~DOFHandlerMultiDim ( )

override

Destructor.

Definition at line 476 of file dofhandler.cc.

Member Function Documentation

◆ cell_accessor_from_element()

const DHCellAccessor DOFHandlerMultiDim::cell_accessor_from_element ( unsigned int elm_idx ) const

Return DHCellAccessor appropriate to ElementAccessor of given idx.

Definition at line 599 of file dofhandler.cc.

Here is the caller graph for this function:

◆ create_sequential()

void DOFHandlerMultiDim::create_sequential ( )

private

Communicate local dof indices to all processors and create new sequential dof handler.

Collective on all processors.

Definition at line 349 of file dofhandler.cc.

Here is the caller graph for this function:

◆ create_vector()

VectorMPI DOFHandlerMultiDim::create_vector ( )

Allocates PETSc vector according to the dof distribution.

Definition at line 437 of file dofhandler.cc.

◆ distribute_dofs()

void DOFHandlerMultiDim::distribute_dofs ( std::shared_ptr< DiscreteSpace > ds )

Distributes degrees of freedom on the mesh needed for the given discrete space.

By default, the dof handler is parallel, meaning that each processor has access to dofs on the local elements and on one layer of ghost elements (owned by neighbouring elements). This can be changed by setting sequential to true.

Parameters

ds	The discrete space consisting of finite elements for each mesh element.
sequential	If true then each processor will have information about all dofs.

Definition at line 242 of file dofhandler.cc.

Here is the caller graph for this function:

◆ ds()

std::shared_ptr<DiscreteSpace> DOFHandlerMultiDim::ds ( ) const

inline

Return pointer to discrete space for which the handler distributes dofs.

Definition at line 265 of file dofhandler.hh.

Here is the caller graph for this function:

◆ edge_index()

LongIdx DOFHandlerMultiDim::edge_index ( int loc_edg ) const

inline

Returns the global index of local edge.

Parameters

loc_edg Local index of edge.

Definition at line 219 of file dofhandler.hh.

◆ el_is_local()

bool DOFHandlerMultiDim::el_is_local ( int index ) const

Returns true if element is on local process.

Parameters

index Global element index.

Definition at line 567 of file dofhandler.cc.

Here is the caller graph for this function:

◆ get_dof_indices()

unsigned int DOFHandlerMultiDim::get_dof_indices	(	const ElementAccessor< 3 > &	cell,
		std::vector< LongIdx > &	indices
	)		const

overridevirtual

Returns the global indices of dofs associated to the cell.

Parameters

cell	The cell.
indices	Array of dof indices on the cell.

Implements DOFHandlerBase.

Definition at line 451 of file dofhandler.cc.

◆ get_loc_dof_indices()

unsigned int DOFHandlerMultiDim::get_loc_dof_indices	(	const ElementAccessor< 3 > &	cell,
		std::vector< LongIdx > &	indices
	)		const

overridevirtual

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

Parameters

cell	The cell.
indices	Array of dof indices on the cell.

Implements DOFHandlerBase.

Definition at line 464 of file dofhandler.cc.

◆ ghost_range()

Range< DHCellAccessor > DOFHandlerMultiDim::ghost_range ( ) const

Returns range over ghosts DOF handler cells.

Definition at line 592 of file dofhandler.cc.

Here is the caller graph for this function:

◆ hash()

std::size_t DOFHandlerMultiDim::hash ( ) const

overridevirtual

Implements DOFHandlerBase::hash.

Implements DOFHandlerBase.

Definition at line 573 of file dofhandler.cc.

◆ init_cell_starts()

void DOFHandlerMultiDim::init_cell_starts ( )

private

Initialize vector of starting indices for elements.

Definition at line 68 of file dofhandler.cc.

Here is the caller graph for this function:

◆ init_node_dof_starts()

void DOFHandlerMultiDim::init_node_dof_starts ( std::vector< LongIdx > & node_dof_starts )

private

Initialize auxiliary vector of starting indices of nodal dofs.

Parameters

node_dof_starts Vector of starting indices (output).

Definition at line 82 of file dofhandler.cc.

Here is the caller graph for this function:

◆ init_node_status()

void DOFHandlerMultiDim::init_node_status ( std::vector< short int > & node_status )

private

Initialize node_status.

Set VALID_NODE for nodes owned by local elements and INVALID_NODE for nodes owned by ghost elements.

Parameters

node_status Vector of nodal status (output).

Definition at line 99 of file dofhandler.cc.

Here is the caller graph for this function:

◆ local_range()

Range< DHCellAccessor > DOFHandlerMultiDim::local_range ( ) const

Returns range over own and ghost cells of DOF handler.

Definition at line 585 of file dofhandler.cc.

Here is the caller graph for this function:

◆ make_elem_partitioning()

void DOFHandlerMultiDim::make_elem_partitioning ( )

private

Prepare parallel distribution of elements, edges and neighbours.

Definition at line 481 of file dofhandler.cc.

Here is the caller graph for this function:

◆ n_loc_edges()

unsigned int DOFHandlerMultiDim::n_loc_edges ( ) const

inline

Returns number of local edges.

Definition at line 231 of file dofhandler.hh.

◆ n_loc_nb()

unsigned int DOFHandlerMultiDim::n_loc_nb ( ) const

inline

Returns number of local neighbours.

Definition at line 236 of file dofhandler.hh.

◆ nb_index()

LongIdx DOFHandlerMultiDim::nb_index ( int loc_nb ) const

inline

Returns the global index of local neighbour.

Parameters

loc_nb Local index of neighbour.

Definition at line 226 of file dofhandler.hh.

◆ own_range()

Range< DHCellAccessor > DOFHandlerMultiDim::own_range ( ) const

Returns range of DOF handler cells (only range of own without ghost cells)

Definition at line 578 of file dofhandler.cc.

Here is the caller graph for this function:

◆ print()

void DOFHandlerMultiDim::print ( ) const

Output structure of dof handler.

Definition at line 606 of file dofhandler.cc.

◆ receive_ghost_dofs()

void DOFHandlerMultiDim::receive_ghost_dofs	(	unsigned int	proc,
		std::vector< LongIdx > &	dofs
	)

private

Obtain dof numbers on ghost elements from other processor.

Parameters

proc	Neighbouring processor.
dofs	Array where dofs are stored (output).

Definition at line 126 of file dofhandler.cc.

Here is the caller graph for this function:

◆ send_ghost_dofs()

void DOFHandlerMultiDim::send_ghost_dofs ( unsigned int proc )

private

Send dof numbers to other processor.

Parameters

proc	Neighbouring processor.

Definition at line 147 of file dofhandler.cc.

Here is the caller graph for this function:

◆ sequential()

std::shared_ptr< DOFHandlerMultiDim > DOFHandlerMultiDim::sequential ( )

Returns sequential version of the current dof handler.

Collective on all processors.

Definition at line 54 of file dofhandler.cc.

Here is the caller graph for this function:

◆ sequential_scatter()

std::shared_ptr< VecScatter > DOFHandlerMultiDim::sequential_scatter ( )

Returns scatter context from parallel to sequential vectors.

For sequential dof handler it returns null pointer. Collective on all processors.

Definition at line 61 of file dofhandler.cc.

◆ update_local_dofs()

void DOFHandlerMultiDim::update_local_dofs	(	unsigned int	proc,
		const std::vector< bool > &	update_cells,
		const std::vector< LongIdx > &	dofs,
		const std::vector< LongIdx > &	node_dof_starts,
		std::vector< LongIdx > &	node_dofs
	)

private

Update dofs on local elements from ghost element dofs.

Parameters

proc	Neighbouring processor.
update_cells	Vector of global indices of elements which need to be updated from ghost elements.
dofs	Vector of dof indices on ghost elements from processor `proc`.
node_dof_starts	Vector of starting indices of nodal dofs.
node_dofs	Vector of nodal dof indices (output).

Definition at line 177 of file dofhandler.cc.

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ DHCellAccessor

friend class DHCellAccessor

friend

Definition at line 273 of file dofhandler.hh.

◆ DHCellSide

friend class DHCellSide

friend

Definition at line 274 of file dofhandler.hh.

Member Data Documentation

◆ ASSIGNED_NODE

const int DOFHandlerMultiDim::ASSIGNED_NODE = 3

staticprivate

Definition at line 349 of file dofhandler.hh.

◆ cell_starts

std::vector<LongIdx> DOFHandlerMultiDim::cell_starts

private

Starting indices for element dofs.

E.g. dof_indices[cell_starts[idx]] = dof number for first dof on the cell with index idx within the parallel structure. To use with element accessor use the following:

ElementAccessor<3> cell; ... // i-th dof number on the cell dof_indices[cell_starts[mesh_->get_row_4_el()[cell.idx()]]+i] = ...

For parallel dof handler, only local and ghost elements are stored, but the vector has size mesh_->n_elements()+1.

Definition at line 380 of file dofhandler.hh.

◆ dh_seq_

std::shared_ptr<DOFHandlerMultiDim> DOFHandlerMultiDim::dh_seq_

private

Sequential dof handler associated to the current (parallel) one.

Definition at line 360 of file dofhandler.hh.

◆ dof_indices

std::vector<LongIdx> DOFHandlerMultiDim::dof_indices

private

Dof numbers on local and ghost elements.

Dofs are ordered accordingly with cell_starts and local dof order given by the finite element. See cell_starts for more description.

Definition at line 388 of file dofhandler.hh.

◆ ds_

std::shared_ptr<DiscreteSpace> DOFHandlerMultiDim::ds_

private

Pointer to the discrete space for which the handler distributes dofs.

Definition at line 354 of file dofhandler.hh.

◆ edg_4_loc

vector<LongIdx> DOFHandlerMultiDim::edg_4_loc

private

Local edge index -> global edge index.

Definition at line 407 of file dofhandler.hh.

◆ el_ds_

Distribution* DOFHandlerMultiDim::el_ds_

private

Distribution of elements.

Definition at line 404 of file dofhandler.hh.

◆ ghost_4_loc

vector<LongIdx> DOFHandlerMultiDim::ghost_4_loc

private

Indices of ghost cells (neighbouring with local elements).

Definition at line 413 of file dofhandler.hh.

◆ ghost_proc

set<unsigned int> DOFHandlerMultiDim::ghost_proc

private

Processors of ghost elements.

Definition at line 416 of file dofhandler.hh.

◆ ghost_proc_el

map<unsigned int, vector<LongIdx> > DOFHandlerMultiDim::ghost_proc_el

private

Arrays of ghost cells for each neighbouring processor.

Definition at line 419 of file dofhandler.hh.

◆ global_to_local_el_idx_

std::unordered_map<LongIdx,LongIdx> DOFHandlerMultiDim::global_to_local_el_idx_

private

Maps global element index into local/ghost index (obsolete).

Definition at line 401 of file dofhandler.hh.

◆ INVALID_DOF

const int DOFHandlerMultiDim::INVALID_DOF = -1

staticprivate

Definition at line 350 of file dofhandler.hh.

◆ INVALID_NODE

const int DOFHandlerMultiDim::INVALID_NODE = 1

staticprivate

Flags used during distribution of dofs to mark node and dof status.

Definition at line 347 of file dofhandler.hh.

◆ is_parallel_

bool DOFHandlerMultiDim::is_parallel_

private

Indicator for parallel/sequential dof handler.

Definition at line 357 of file dofhandler.hh.

◆ local_to_global_dof_idx_

std::vector<LongIdx> DOFHandlerMultiDim::local_to_global_dof_idx_

private

Maps local and ghost dof indices to global ones.

First lsize_ entries correspond to dofs owned by local processor, the remaining entries are ghost dofs sorted by neighbouring processor id.

Definition at line 396 of file dofhandler.hh.

◆ nb_4_loc

vector<LongIdx> DOFHandlerMultiDim::nb_4_loc

private

Local neighbour index -> global neighbour index.

Definition at line 410 of file dofhandler.hh.

◆ scatter_to_seq_

std::shared_ptr<VecScatter> DOFHandlerMultiDim::scatter_to_seq_

private

Scatter context for parallel to sequential vectors.

Definition at line 363 of file dofhandler.hh.

◆ VALID_NODE

const int DOFHandlerMultiDim::VALID_NODE = 2

staticprivate

Definition at line 348 of file dofhandler.hh.

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

/opt/flow123d/flow123d/src/fem/dofhandler.hh
/opt/flow123d/flow123d/src/fem/dofhandler.cc

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DOFHandlerMultiDim()

◆ ~DOFHandlerMultiDim()

Member Function Documentation

◆ cell_accessor_from_element()

◆ create_sequential()

◆ create_vector()

◆ distribute_dofs()

◆ ds()

◆ edge_index()

◆ el_is_local()

◆ get_dof_indices()

◆ get_loc_dof_indices()

◆ ghost_range()

◆ hash()

◆ init_cell_starts()

◆ init_node_dof_starts()

◆ init_node_status()

◆ local_range()

◆ make_elem_partitioning()

◆ n_loc_edges()

◆ n_loc_nb()

◆ nb_index()

◆ own_range()

◆ print()

◆ receive_ghost_dofs()

◆ send_ghost_dofs()

◆ sequential()

◆ sequential_scatter()

◆ update_local_dofs()

Friends And Related Function Documentation

◆ DHCellAccessor

◆ DHCellSide

Member Data Documentation

◆ ASSIGNED_NODE

◆ cell_starts

◆ dh_seq_

◆ dof_indices

◆ ds_

◆ edg_4_loc

◆ el_ds_

◆ ghost_4_loc

◆ ghost_proc

◆ ghost_proc_el

◆ global_to_local_el_idx_

◆ INVALID_DOF

◆ INVALID_NODE

◆ is_parallel_

◆ local_to_global_dof_idx_

◆ nb_4_loc

◆ scatter_to_seq_

◆ VALID_NODE