Reference documentation for deal.II version Git 7f58f27 2017-09-20 15:35:49 -0600
Public Member Functions | Private Attributes | List of all members
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_index get_index (const unsigned int level, const unsigned int dof_number, const unsigned int dofs_per_vertex) const
 
void set_index (const unsigned int level, const unsigned int dof_number, const unsigned int dofs_per_vertex, const types::global_dof_index index)
 

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 974 of file dof_handler.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 1247 of file dof_handler.cc.

Member Function Documentation

template<int dim, int spacedim>
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.

Definition at line 1256 of file dof_handler.cc.

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

Return the coarsest level for which this structure stores data.

Definition at line 1279 of file dof_handler.cc.

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

Return the finest level for which this structure stores data.

Definition at line 1287 of file dof_handler.cc.

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

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

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

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

Member Data Documentation

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 1023 of file dof_handler.h.

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 1028 of file dof_handler.h.

template<int dim, int spacedim = dim>
std::unique_ptr<types::global_dof_index[]> 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 dofs_per_vertex * (level-coarsest_level). dofs_per_vertex must therefore be passed as an argument to the functions that set or read an index.

Definition at line 1039 of file dof_handler.h.


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