Reference documentation for deal.II version Git 251e984 2017-09-25 10:29:00 +0200
Public Member Functions | Public Attributes | List of all members
internal::DoFHandler::DoFLevel< dim > Class Template Reference

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

Public Member Functions

const types::global_dof_indexget_cell_cache_start (const unsigned int obj_index, const unsigned int dofs_per_cell) 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_indexcell_dof_indices_cache
DoFObjects< dim > dof_object

Detailed Description

template<int dim>
class internal::DoFHandler::DoFLevel< dim >

Structure for storing degree of freedom information for cells, organized by levels.

We store are cached values for the DoF indices on each cell in::cell_dof_indices_cache, since this is a frequently requested operation. The values are set by DoFCellAccessor::update_cell_dof_indices_cache and are used by DoFCellAccessor::get_dof_indices.

Note that vertices are separate from, and in fact have nothing to do with cells. The indices of degrees of freedom located on vertices therefore are not stored here, but rather in member variables of the DoFHandler class.

The indices of degrees of freedom located on lower dimensional objects, i.e. on lines for 2D and on quads and lines for 3D are treated similarly than that on cells. However, these geometrical objects, which are called faces as a generalization, are not organised in a hierarchical structure of levels. Therefore, the degrees of freedom located on these objects are stored in separate classes, namely the DoFFaces classes.

Access to this object is usually through the DoFAccessor::set_dof_index() and DoFAccessor::dof_index() functions or similar functions of derived classes that in turn access the member variables using the DoFHandler::get_dof_index() and corresponding setter functions. Knowledge of the actual data format is therefore encapsulated to the present hierarchy of classes as well as the DoFHandler class.

Wolfgang Bangerth, 1998, 2006, Guido Kanschat, 2012

Definition at line 70 of file dof_levels.h.

Member Function Documentation

template<int dim>
const types::global_dof_index * internal::DoFHandler::DoFLevel< dim >::get_cell_cache_start ( const unsigned int  obj_index,
const unsigned int  dofs_per_cell 
) const

Return a pointer to the beginning of the DoF indices cache for a given cell.

obj_indexThe number of the cell we are looking at.
dofs_per_cellThe number of DoFs per cell for this cell.
A pointer to the first DoF index for the current cell. The next dofs_per_cell indices are for the current cell.

Definition at line 117 of file dof_levels.h.

template<int dim>
std::size_t internal::DoFHandler::DoFLevel< dim >::memory_consumption ( ) const

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

Definition at line 133 of file dof_levels.h.

template<int dim>
template<class Archive >
void internal::DoFHandler::DoFLevel< 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

Definition at line 144 of file dof_levels.h.

Member Data Documentation

template<int dim>
std::vector<types::global_dof_index> internal::DoFHandler::DoFLevel< dim >::cell_dof_indices_cache

Cache for the DoF indices on cells. The size of this array equals the number of cells on a given level times selected_fe.dofs_per_cell.

Definition at line 77 of file dof_levels.h.

template<int dim>
DoFObjects<dim> internal::DoFHandler::DoFLevel< dim >::dof_object

The object containing dof-indices and related access-functions

Definition at line 82 of file dof_levels.h.

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