Reference documentation for deal.II version 9.4.0
DoFHandler< dim, spacedim >::MGVertexDoFs Class Reference

## Public Member Functions

MGVertexDoFs ()

void init (const unsigned int coarsest_level, const unsigned int finest_level, const unsigned int dofs_per_vertex)

unsigned int get_coarsest_level () const

unsigned int get_finest_level () const

types::global_dof_indexaccess_index (const unsigned int level, const unsigned int dof_number, const unsigned int dofs_per_vertex)

## Private Attributes

unsigned int coarsest_level

unsigned int finest_level

std::unique_ptr< types::global_dof_index[]> indices

## Detailed Description

template<int dim, int spacedim = dim>
class DoFHandler< dim, spacedim >::MGVertexDoFs

A data structure that is used to store the DoF indices associated with a particular vertex. Unlike cells, vertices live on several levels of a multigrid hierarchy; consequently, we need to store DoF indices for each vertex for each of the levels it lives on. This class does this.

Definition at line 1360 of file dof_handler.h.

## ◆ MGVertexDoFs()

template<int dim, int spacedim = dim>
 DoFHandler< dim, spacedim >::MGVertexDoFs::MGVertexDoFs ( )

Constructor.

## ◆ init()

template<int dim, int spacedim = dim>
 void DoFHandler< dim, spacedim >::MGVertexDoFs::init ( const unsigned int coarsest_level, const unsigned int finest_level, const unsigned int dofs_per_vertex )

A function that is called to allocate the necessary amount of memory to store the indices of the DoFs that live on this vertex for the given (inclusive) range of levels.

## ◆ get_coarsest_level()

template<int dim, int spacedim = dim>
 unsigned int DoFHandler< dim, spacedim >::MGVertexDoFs::get_coarsest_level ( ) const

Return the coarsest level for which this structure stores data.

## ◆ get_finest_level()

template<int dim, int spacedim = dim>
 unsigned int DoFHandler< dim, spacedim >::MGVertexDoFs::get_finest_level ( ) const

Return the finest level for which this structure stores data.

## ◆ access_index()

template<int dim, int spacedim = dim>
 types::global_dof_index & DoFHandler< dim, spacedim >::MGVertexDoFs::access_index ( const unsigned int level, const unsigned int dof_number, const unsigned int dofs_per_vertex )

Return the index of the dof_numberth degree of freedom for the given level stored for the current vertex.

## ◆ coarsest_level

template<int dim, int spacedim = dim>
 unsigned int DoFHandler< dim, spacedim >::MGVertexDoFs::coarsest_level
private

Coarsest level for which this object stores DoF indices.

Definition at line 1403 of file dof_handler.h.

## ◆ finest_level

template<int dim, int spacedim = dim>
 unsigned int DoFHandler< dim, spacedim >::MGVertexDoFs::finest_level
private

Finest level for which this object stores DoF indices.

Definition at line 1408 of file dof_handler.h.

## ◆ indices

template<int dim, int spacedim = dim>
 std::unique_ptr DoFHandler< dim, spacedim >::MGVertexDoFs::indices
private

A pointer to an array where we store the indices of the DoFs that live on the various levels this vertex exists on.

The starting offset of the DoFs that belong to a level are given by n_dofs_per_vertex() * (level-coarsest_level). n_dofs_per_vertex() must therefore be passed as an argument to the functions that set or read an index.

Definition at line 1419 of file dof_handler.h.

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