Reference documentation for deal.II version 9.3.3
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Public Attributes | Friends | List of all members
internal::DoFHandlerImplementation::DoFObjects< dim > Class Template Reference
Degrees of Freedom

#include <deal.II/dofs/dof_objects.h>

Inheritance diagram for internal::DoFHandlerImplementation::DoFObjects< dim >:
[legend]

Public Member Functions

template<int dh_dim, int spacedim>
void set_dof_index (const ::DoFHandler< dh_dim, spacedim > &dof_handler, const unsigned int obj_index, const unsigned int fe_index, const unsigned int local_index, const types::global_dof_index global_index)
 
template<int dh_dim, int spacedim>
types::global_dof_index get_dof_index (const ::DoFHandler< dh_dim, spacedim > &dof_handler, const unsigned int obj_index, const unsigned int fe_index, const unsigned int local_index) const
 
template<int dh_dim, int spacedim>
unsigned int n_active_fe_indices (const ::DoFHandler< dh_dim, spacedim > &dof_handler, const types::global_dof_index index) const
 
template<int dh_dim, int spacedim>
bool fe_index_is_active (const ::DoFHandler< dh_dim, spacedim > &dof_handler, const types::global_dof_index index, const unsigned int fe_index) const
 
std::size_t memory_consumption () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Public Attributes

std::vector< types::global_dof_index > dofs
 

Friends

template<int >
class DoFLevel
 
template<int >
class DoFFaces
 

Detailed Description

template<int dim>
class internal::DoFHandlerImplementation::DoFObjects< dim >

Store the indices of the degrees of freedom which are located on objects of dimension dim.

Information for all DoFObjects classes

The DoFObjects classes store the global indices of the degrees of freedom for each cell on a certain level. The global index or number of a degree of freedom is the zero-based index of the according value in the solution vector and the row and column index in the global matrix or the multigrid matrix for this level. These indices refer to the unconstrained vectors and matrices, where we have not taken account of the constraints introduced by hanging nodes.

Since vertices are not associated with a particular level, the indices associated with vertices are not stored in the DoFObjects classes but rather in the DoFHandler::vertex_dofs array.

The DoFObjects classes are not used directly, but objects of these classes are included in the DoFLevel and DoFFaces classes.

Definition at line 69 of file dof_objects.h.

Member Function Documentation

◆ set_dof_index()

template<int dim>
template<int dh_dim, int spacedim>
void internal::DoFHandlerImplementation::DoFObjects< dim >::set_dof_index ( const ::DoFHandler< dh_dim, spacedim > &  dof_handler,
const unsigned int  obj_index,
const unsigned int  fe_index,
const unsigned int  local_index,
const types::global_dof_index  global_index 
)

Set the global index of the local_index-th degree of freedom located on the object with number obj_index to the value given by the last argument. The dof_handler argument is used to access the finite element that is to be used to compute the location where this data is stored.

The third argument, fe_index, must equal zero. It is otherwise unused, but we retain the argument so that we can use the same interface for non-hp- and hp-finite element methods, in effect making it possible to share the DoFAccessor class hierarchy between hp- and non-hp-classes.

Definition at line 42 of file dof_objects.cc.

◆ get_dof_index()

template<int dim>
template<int dh_dim, int spacedim>
types::global_dof_index internal::DoFHandlerImplementation::DoFObjects< dim >::get_dof_index ( const ::DoFHandler< dh_dim, spacedim > &  dof_handler,
const unsigned int  obj_index,
const unsigned int  fe_index,
const unsigned int  local_index 
) const
inline

Return the global index of the local_index-th degree of freedom located on the object with number obj_index. The dof_handler argument is used to access the finite element that is to be used to compute the location where this data is stored.

The third argument, fe_index, must equal zero. It is otherwise unused, but we retain the argument so that we can use the same interface for non-hp- and hp-finite element methods, in effect making it possible to share the DoFAccessor class hierarchy between hp- and non-hp-classes.

Definition at line 200 of file dof_objects.h.

◆ n_active_fe_indices()

template<int dim>
template<int dh_dim, int spacedim>
unsigned int internal::DoFHandlerImplementation::DoFObjects< dim >::n_active_fe_indices ( const ::DoFHandler< dh_dim, spacedim > &  dof_handler,
const types::global_dof_index  index 
) const
inline

Return the value 1. The meaning of this function becomes clear by looking at what the corresponding functions in the classes internal::hp::DoFObjects

Definition at line 170 of file dof_objects.h.

◆ fe_index_is_active()

template<int dim>
template<int dh_dim, int spacedim>
bool internal::DoFHandlerImplementation::DoFObjects< dim >::fe_index_is_active ( const ::DoFHandler< dh_dim, spacedim > &  dof_handler,
const types::global_dof_index  index,
const unsigned int  fe_index 
) const
inline

Similar to the function above. Assert that the given index is zero, and then return true.

Definition at line 182 of file dof_objects.h.

◆ memory_consumption()

template<int dim>
std::size_t internal::DoFHandlerImplementation::DoFObjects< dim >::memory_consumption

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 32 of file dof_objects.cc.

◆ serialize()

template<int dim>
template<class Archive >
void internal::DoFHandlerImplementation::DoFObjects< dim >::serialize ( Archive &  ar,
const unsigned int  version 
)

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

Definition at line 231 of file dof_objects.h.

Friends And Related Function Documentation

◆ DoFLevel

template<int dim>
template<int >
friend class DoFLevel
friend

Definition at line 159 of file dof_objects.h.

◆ DoFFaces

template<int dim>
template<int >
friend class DoFFaces
friend

Definition at line 161 of file dof_objects.h.

Member Data Documentation

◆ dofs

template<int dim>
std::vector<types::global_dof_index> internal::DoFHandlerImplementation::DoFObjects< dim >::dofs

Store the global indices of the degrees of freedom.

Definition at line 75 of file dof_objects.h.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.4