#include <deal.II/meshworker/dof_info.h>

Inheritance diagram for MeshWorker::DoFInfo< dim, spacedim, number >:

Public Member Functions
	DoFInfo (const BlockInfo &block_info)

	DoFInfo (const DoFHandler< dim, spacedim > &dof_handler)

template<class DHCellIterator >
void	reinit (const DHCellIterator &c)

template<class DHCellIterator , class DHFaceIterator >
void	reinit (const DHCellIterator &c, const DHFaceIterator &f, const unsigned int face_no)

template<class DHCellIterator , class DHFaceIterator >
void	reinit (const DHCellIterator &c, const DHFaceIterator &f, const unsigned int face_no, const unsigned int subface_no)

template<class DHFaceIterator >
void	set_face (const DHFaceIterator &f, const unsigned int face_no)

template<class DHFaceIterator >
void	set_subface (const DHFaceIterator &f, const unsigned int face_no, const unsigned int subface_no)

const BlockIndices &	local_indices () const

Public Member Functions inherited from MeshWorker::LocalResults< double >
unsigned int	n_values () const

unsigned int	n_vectors () const

unsigned int	n_matrices () const

unsigned int	n_quadrature_points () const

unsigned int	n_quadrature_values () const

double &	value (const unsigned int i)

double	value (const unsigned int i) const

BlockVector< double > &	vector (const unsigned int i)

const BlockVector< double > &	vector (const unsigned int i) const

MatrixBlock< FullMatrix< double > > &	matrix (const unsigned int i, const bool external=false)

const MatrixBlock< FullMatrix< double > > &	matrix (const unsigned int i, const bool external=false) const

Table< 2, double > &	quadrature_values ()

double &	quadrature_value (const unsigned int k, const unsigned int i)

double	quadrature_value (const unsigned int k, const unsigned int i) const

void	initialize_numbers (const unsigned int n)

void	initialize_vectors (const unsigned int n)

void	initialize_matrices (const unsigned int n, bool both)

void	initialize_matrices (const MatrixBlockVector< MatrixType > &matrices, bool both)

void	initialize_matrices (const MGMatrixBlockVector< MatrixType > &matrices, bool both)

void	initialize_quadrature (const unsigned int np, const unsigned int nv)

void	reinit (const BlockIndices &local_sizes)

void	print_debug (StreamType &os) const

std::size_t	memory_consumption () const

Public Attributes
Triangulation< dim, spacedim >::cell_iterator	cell
	The current cell. More...

Triangulation< dim, spacedim >::face_iterator	face
	The current face. More...

unsigned int	face_number

unsigned int	sub_number

std::vector< types::global_dof_index >	indices

std::vector< std::vector< types::global_dof_index > >	indices_by_block

SmartPointer< const BlockInfo, DoFInfo< dim, spacedim > >	block_info
	The block structure of the system. More...

bool	level_cell

Private Member Functions
	DoFInfo ()

void	set_block_indices ()
	Set up local block indices. More...

template<class DHCellIterator >
void	get_indices (const DHCellIterator &c)
	Fill index vector with active indices. More...

Private Attributes
std::vector< types::global_dof_index >	indices_org
	Auxiliary vector. More...

BlockIndices	aux_local_indices

Friends
class	DoFInfoBox< dim, DoFInfo< dim, spacedim, number > >

Detailed Description

template<int dim, int spacedim = dim, typename number = double>
class MeshWorker::DoFInfo< dim, spacedim, number >

A class containing information on geometry and degrees of freedom of a mesh object.

The information in these objects is usually used by one of the Assembler classes. It is also the kind of information which is needed in mesh based matrices (often referred to as matrix free methods).

In addition to the information on degrees of freedom stored in this class, it also provides the local computation space for the worker object operating on it in LocalResults. This base class will automatically be reinitialized on each cell, but initial setup is up to the user and should be done when initialize() for this class is called.

This class operates in two different modes, corresponding to the data models discussed in the Assembler namespace documentation.

The choice of the local data model is triggered by the vector BlockInfo::local_renumbering, which in turn is usually filled by BlockInfo::initialize_local(). If this function has been used, or the vector has been changed from zero-length, then local dof indices stored in this object will automatically be renumbered to reflect local block structure. This means, the first entries in indices will refer to the first block of the system, then comes the second block and so on.

The BlockInfo object is stored as a pointer. Therefore, if the block structure changes, for instance because of mesh refinement, the DoFInfo class will automatically use the new structures.

Author: Guido Kanschat, 2009

Definition at line 76 of file dof_info.h.

Constructor & Destructor Documentation

◆ DoFInfo() [1/3]

template<int dim, int spacedim = dim, typename number = double>

MeshWorker::DoFInfo< dim, spacedim, number >::DoFInfo ( const BlockInfo & block_info )

Constructor setting the block_info pointer.

◆ DoFInfo() [2/3]

template<int dim, int spacedim, typename number >

MeshWorker::DoFInfo< dim, spacedim, number >::DoFInfo ( const DoFHandler< dim, spacedim > & dof_handler )

Constructor leaving the block_info pointer empty, but setting the aux_local_indices.

Definition at line 302 of file dof_info.h.

◆ DoFInfo() [3/3]

template<int dim, int spacedim, typename number >

MeshWorker::DoFInfo< dim, spacedim, number >::DoFInfo

private

Standard constructor, not setting any block indices. Use of this constructor is not recommended, but it is needed for the arrays in DoFInfoBox.

Definition at line 293 of file dof_info.h.

Member Function Documentation

◆ reinit() [1/3]

template<int dim, int spacedim, typename number >

template<class DHCellIterator >

void MeshWorker::DoFInfo< dim, spacedim, number >::reinit ( const DHCellIterator & c )

inline

Set the current cell and fill indices.

Definition at line 334 of file dof_info.h.

◆ reinit() [2/3]

template<int dim, int spacedim, typename number >

template<class DHCellIterator , class DHFaceIterator >

void MeshWorker::DoFInfo< dim, spacedim, number >::reinit	(	const DHCellIterator &	c,
		const DHFaceIterator &	f,
		const unsigned int	face_no
	)

inline

Set the current face and fill indices if the cell changed.

Definition at line 364 of file dof_info.h.

◆ reinit() [3/3]

template<int dim, int spacedim, typename number >

template<class DHCellIterator , class DHFaceIterator >

void MeshWorker::DoFInfo< dim, spacedim, number >::reinit	(	const DHCellIterator &	c,
		const DHFaceIterator &	f,
		const unsigned int	face_no,
		const unsigned int	subface_no
	)

inline

Set the current subface and fill indices if the cell changed.

Definition at line 399 of file dof_info.h.

◆ set_face()

template<int dim, int spacedim, typename number >

template<class DHFaceIterator >

void MeshWorker::DoFInfo< dim, spacedim, number >::set_face	(	const DHFaceIterator &	f,
		const unsigned int	face_no
	)

inline

Switch to a new face of the same cell. Does not change indices and does not reset data in LocalResults.

Definition at line 352 of file dof_info.h.

◆ set_subface()

template<int dim, int spacedim, typename number >

template<class DHFaceIterator >

void MeshWorker::DoFInfo< dim, spacedim, number >::set_subface	(	const DHFaceIterator &	f,
		const unsigned int	face_no,
		const unsigned int	subface_no
	)

inline

Switch to a new subface of the same cell. Does not change indices and does not reset data in LocalResults.

Definition at line 386 of file dof_info.h.

◆ local_indices()

template<int dim, int spacedim, typename number >

const BlockIndices & MeshWorker::DoFInfo< dim, spacedim, number >::local_indices

inline

Definition at line 422 of file dof_info.h.

◆ set_block_indices()

template<int dim, int spacedim = dim, typename number = double>

void MeshWorker::DoFInfo< dim, spacedim, number >::set_block_indices ( )

private

Set up local block indices.

◆ get_indices()

template<int dim, int spacedim, typename number >

template<class DHCellIterator >

void MeshWorker::DoFInfo< dim, spacedim, number >::get_indices ( const DHCellIterator & c )

inlineprivate

Fill index vector with active indices.

Definition at line 317 of file dof_info.h.

Friends And Related Function Documentation

◆ DoFInfoBox< dim, DoFInfo< dim, spacedim, number > >

template<int dim, int spacedim = dim, typename number = double>

friend class DoFInfoBox< dim, DoFInfo< dim, spacedim, number > >

friend

Definition at line 207 of file dof_info.h.

Member Data Documentation

◆ cell

template<int dim, int spacedim = dim, typename number = double>

Triangulation<dim, spacedim>::cell_iterator MeshWorker::DoFInfo< dim, spacedim, number >::cell

The current cell.

Definition at line 80 of file dof_info.h.

◆ face

template<int dim, int spacedim = dim, typename number = double>

Triangulation<dim, spacedim>::face_iterator MeshWorker::DoFInfo< dim, spacedim, number >::face

The current face.

Definition at line 83 of file dof_info.h.

◆ face_number

template<int dim, int spacedim = dim, typename number = double>

unsigned int MeshWorker::DoFInfo< dim, spacedim, number >::face_number

The number of the current face on the current cell.

This number is numbers::invalid_unsigned_int if the info object was initialized with a cell.

Definition at line 91 of file dof_info.h.

◆ sub_number

template<int dim, int spacedim = dim, typename number = double>

unsigned int MeshWorker::DoFInfo< dim, spacedim, number >::sub_number

The number of the current subface on the current face

This number is numbers::invalid_unsigned_int if the info object was not initialized with a subface.

Definition at line 99 of file dof_info.h.

◆ indices

template<int dim, int spacedim = dim, typename number = double>

std::vector<types::global_dof_index> MeshWorker::DoFInfo< dim, spacedim, number >::indices

The DoF indices of the current cell

Definition at line 105 of file dof_info.h.

◆ indices_by_block

template<int dim, int spacedim = dim, typename number = double>

std::vector<std::vector<types::global_dof_index> > MeshWorker::DoFInfo< dim, spacedim, number >::indices_by_block

The DoF indices on the current cell, organized by local blocks. The size of this vector is zero, unless local blocks are used.

Definition at line 111 of file dof_info.h.

◆ block_info

template<int dim, int spacedim = dim, typename number = double>

SmartPointer<const BlockInfo, DoFInfo<dim, spacedim> > MeshWorker::DoFInfo< dim, spacedim, number >::block_info

The block structure of the system.

Definition at line 173 of file dof_info.h.

◆ level_cell

template<int dim, int spacedim = dim, typename number = double>

bool MeshWorker::DoFInfo< dim, spacedim, number >::level_cell

The structure refers to a cell with level data instead of active data.

Definition at line 178 of file dof_info.h.

◆ indices_org

template<int dim, int spacedim = dim, typename number = double>

std::vector<types::global_dof_index> MeshWorker::DoFInfo< dim, spacedim, number >::indices_org

private

Auxiliary vector.

Definition at line 198 of file dof_info.h.

◆ aux_local_indices

template<int dim, int spacedim = dim, typename number = double>

BlockIndices MeshWorker::DoFInfo< dim, spacedim, number >::aux_local_indices

private

An auxiliary local BlockIndices object created if block_info is not set. It contains just a single block of the size of degrees of freedom per cell.

Definition at line 205 of file dof_info.h.

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

include/deal.II/meshworker/dof_info.h

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

template<int dim, int spacedim = dim, typename number = double> class MeshWorker::DoFInfo< dim, spacedim, number >

Constructor & Destructor Documentation

◆ DoFInfo() [1/3]

◆ DoFInfo() [2/3]

◆ DoFInfo() [3/3]

Member Function Documentation

◆ reinit() [1/3]

◆ reinit() [2/3]

◆ reinit() [3/3]

◆ set_face()

◆ set_subface()

◆ local_indices()

◆ set_block_indices()

◆ get_indices()

Friends And Related Function Documentation

◆ DoFInfoBox< dim, DoFInfo< dim, spacedim, number > >

Member Data Documentation

◆ cell

◆ face

◆ face_number

◆ sub_number

◆ indices

◆ indices_by_block

◆ block_info

◆ level_cell

◆ indices_org

◆ aux_local_indices

template<int dim, int spacedim = dim, typename number = double>
class MeshWorker::DoFInfo< dim, spacedim, number >