internal::DoFHandler::DoFObjects< dim > Class Template Reference
[Degrees of Freedom]

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

List of all members.

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 unsigned int global_index)
template<int dh_dim, int spacedim>
unsigned int 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 unsigned int index) const
template<int dh_dim, int spacedim>
bool fe_index_is_active (const ::DoFHandler< dh_dim, spacedim > &dof_handler, const unsigned int index, const unsigned int fe_index) const
unsigned int memory_consumption () const
template<int dh_dim, int spacedim>
unsigned int n_active_fe_indices (const ::DoFHandler< dh_dim, spacedim > &, const unsigned) const

Public Attributes

std::vector< unsigned intdofs

Friends

class DoFLevel
class DoFFaces

Detailed Description

template<int dim>
class internal::DoFHandler::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 theses classes are included in the DoFLevel and DoFFaces classes.

Author:
Tobias Leicht, 2006

Member Function Documentation

template<int dim>
template<int dh_dim, int spacedim>
void internal::DoFHandler::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 unsigned int  global_index 
) [inline]

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.

template<int dim>
template<int dh_dim, int spacedim>
unsigned int internal::DoFHandler::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.

References Assert, and internal::DoFHandler::DoFObjects< dim >::dofs.

template<int dim>
template<int dh_dim, int spacedim>
unsigned int internal::DoFHandler::DoFObjects< dim >::n_active_fe_indices ( const ::DoFHandler< dh_dim, spacedim > &  dof_handler,
const unsigned int  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

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

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

References Assert.

template<int dim>
unsigned int internal::DoFHandler::DoFObjects< dim >::memory_consumption (  )  const

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

template<int dim>
template<int dh_dim, int spacedim>
unsigned int internal::DoFHandler::DoFObjects< dim >::n_active_fe_indices ( const ::DoFHandler< dh_dim, spacedim > &  ,
const   unsigned 
) const [inline]

Friends And Related Function Documentation

template<int dim>
friend class DoFLevel [friend]

Make the DoFHandler and MGDoFHandler classes a friend, so that they can resize arrays as necessary.

template<int dim>
friend class DoFFaces [friend]

Member Data Documentation

template<int dim>
std::vector<unsigned int> internal::DoFHandler::DoFObjects< dim >::dofs

Store the global indices of the degrees of freedom.

Referenced by internal::DoFHandler::DoFObjects< dim >::get_dof_index().


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

deal.II documentation generated on Mon Nov 23 22:58:23 2009 by doxygen 1.6.1