hp::DoFHandler< dim, spacedim > Class Template Reference
[hp finite element support]

Inheritance diagram for hp::DoFHandler< dim, spacedim >:

Inheritance graph
[legend]

List of all members.

Classes

class  ExcEmptyLevel
class  ExcFacesHaveNoLevel
class  ExcFunctionNotUseful
class  ExcGridsDoNotMatch
class  ExcInvalidBoundaryIndicator
class  ExcInvalidFEIndex
class  ExcInvalidLevel
class  ExcInvalidTriangulation
class  ExcMatrixHasWrongSize
class  ExcNewNumbersNotConsecutive
class  ExcNoFESelected
class  ExcRenumberingIncomplete

Public Types

typedef
IteratorSelector::raw_line_iterator 
raw_line_iterator
typedef
IteratorSelector::line_iterator 
line_iterator
typedef
IteratorSelector::active_line_iterator 
active_line_iterator
typedef
IteratorSelector::raw_quad_iterator 
raw_quad_iterator
typedef
IteratorSelector::quad_iterator 
quad_iterator
typedef
IteratorSelector::active_quad_iterator 
active_quad_iterator
typedef
IteratorSelector::raw_hex_iterator 
raw_hex_iterator
typedef
IteratorSelector::hex_iterator 
hex_iterator
typedef
IteratorSelector::active_hex_iterator 
active_hex_iterator
typedef
IteratorSelector::raw_cell_iterator 
raw_cell_iterator
typedef
IteratorSelector::cell_iterator 
cell_iterator
typedef
IteratorSelector::active_cell_iterator 
active_cell_iterator
typedef
IteratorSelector::raw_face_iterator 
raw_face_iterator
typedef
IteratorSelector::face_iterator 
face_iterator
typedef
IteratorSelector::active_face_iterator 
active_face_iterator
typedef FunctionMap< spacedim >
::type 
FunctionMap

Public Member Functions

 DoFHandler (const Triangulation< dim, spacedim > &tria)
virtual ~DoFHandler ()
virtual void distribute_dofs (const hp::FECollection< dim, spacedim > &fe)
virtual void clear ()
void renumber_dofs (const std::vector< unsigned int > &new_numbers)
unsigned int max_couplings_between_dofs () const
unsigned int max_couplings_between_boundary_dofs () const
unsigned int n_dofs () const
unsigned int n_boundary_dofs () const
unsigned int n_boundary_dofs (const FunctionMap &boundary_indicators) const
unsigned int n_boundary_dofs (const std::set< unsigned char > &boundary_indicators) const
const hp::FECollection< dim,
spacedim > & 
get_fe () const
const Triangulation< dim,
spacedim > & 
get_tria () const
virtual unsigned int memory_consumption () const
Cell iterator functions
raw_cell_iterator begin_raw (const unsigned int level=0) const
cell_iterator begin (const unsigned int level=0) const
active_cell_iterator begin_active (const unsigned int level=0) const
raw_cell_iterator end () const
cell_iterator end (const unsigned int level) const
raw_cell_iterator end_raw (const unsigned int level) const
active_cell_iterator end_active (const unsigned int level) const
raw_cell_iterator last_raw () const
raw_cell_iterator last_raw (const unsigned int level) const
cell_iterator last () const
cell_iterator last (const unsigned int level) const
active_cell_iterator last_active () const
active_cell_iterator last_active (const unsigned int level) const
Face iterator functions
raw_face_iterator begin_raw_face () const
face_iterator begin_face () const
active_face_iterator begin_active_face () const
raw_face_iterator end_face () const
raw_face_iterator end_raw_face () const
active_face_iterator end_active_face () const
raw_face_iterator last_raw_face () const
face_iterator last_face () const
active_face_iterator last_active_face () const
Line iterator functions
raw_line_iterator begin_raw_line (const unsigned int level=0) const
line_iterator begin_line (const unsigned int level=0) const
active_line_iterator begin_active_line (const unsigned int level=0) const
raw_line_iterator end_line () const
line_iterator end_line (const unsigned int level) const
raw_line_iterator end_raw_line (const unsigned int level) const
active_line_iterator end_active_line (const unsigned int level) const
raw_line_iterator last_raw_line () const
raw_line_iterator last_raw_line (const unsigned int level) const
line_iterator last_line () const
line_iterator last_line (const unsigned int level) const
active_line_iterator last_active_line () const
active_line_iterator last_active_line (const unsigned int level) const
Quad iterator functions
raw_quad_iterator begin_raw_quad (const unsigned int level=0) const
quad_iterator begin_quad (const unsigned int level=0) const
active_quad_iterator begin_active_quad (const unsigned int level=0) const
raw_quad_iterator end_quad () const
quad_iterator end_quad (const unsigned int level) const
raw_quad_iterator end_raw_quad (const unsigned int level) const
active_quad_iterator end_active_quad (const unsigned int level) const
raw_quad_iterator last_raw_quad () const
raw_quad_iterator last_raw_quad (const unsigned int level) const
quad_iterator last_quad () const
quad_iterator last_quad (const unsigned int level) const
active_quad_iterator last_active_quad () const
active_quad_iterator last_active_quad (const unsigned int level) const
Hex iterator functions
raw_hex_iterator begin_raw_hex (const unsigned int level=0) const
hex_iterator begin_hex (const unsigned int level=0) const
active_hex_iterator begin_active_hex (const unsigned int level=0) const
raw_hex_iterator end_hex () const
hex_iterator end_hex (const unsigned int level) const
raw_hex_iterator end_raw_hex (const unsigned int level) const
active_hex_iterator end_active_hex (const unsigned int level) const
raw_hex_iterator last_raw_hex () const
raw_hex_iterator last_raw_hex (const unsigned int level) const
hex_iterator last_hex () const
hex_iterator last_hex (const unsigned int level) const
active_hex_iterator last_active_hex () const
active_hex_iterator last_active_hex (const unsigned int level) const

Static Public Attributes

static const unsigned int dimension = dim
static const unsigned int space_dimension = spacedim
static const unsigned int invalid_dof_index = numbers::invalid_unsigned_int
static const unsigned int default_fe_index = numbers::invalid_unsigned_int

Protected Attributes

SmartPointer< const
Triangulation< dim, spacedim > > 
tria
SmartPointer< const
hp::FECollection< dim,
spacedim > > 
finite_elements

Package Attributes

 __pad0__:DoFHandler::Iterators<DoFHandler<dim
spacedim IteratorSelector

Private Member Functions

 DoFHandler (const DoFHandler &)
DoFHandleroperator= (const DoFHandler &)
void clear_space ()
void create_active_fe_table ()
virtual void pre_refinement_notification (const Triangulation< dim, spacedim > &tria)
virtual void post_refinement_notification (const Triangulation< dim, spacedim > &tria)
void compute_vertex_dof_identities (std::vector< unsigned int > &new_dof_indices) const
void compute_line_dof_identities (std::vector< unsigned int > &new_dof_indices) const
void compute_quad_dof_identities (std::vector< unsigned int > &new_dof_indices) const
void renumber_dofs_internal (const std::vector< unsigned int > &new_numbers, internal::int2type< 0 >)
void renumber_dofs_internal (const std::vector< unsigned int > &new_numbers, internal::int2type< 1 >)
void renumber_dofs_internal (const std::vector< unsigned int > &new_numbers, internal::int2type< 2 >)
void renumber_dofs_internal (const std::vector< unsigned int > &new_numbers, internal::int2type< 3 >)

Private Attributes

std::vector
< internal::hp::DoFLevel< dim > * > 
levels
internal::hp::DoFFaces< dim > * faces
unsigned int used_dofs
std::vector< unsigned intvertex_dofs
std::vector< unsigned intvertex_dofs_offsets
std::vector< std::vector< bool > * > has_children

Friends

class ::DoFAccessor
class ::DoFCellAccessor
class internal::DoFAccessor::Implementation
class internal::DoFCellAccessor::Implementation
class internal::hp::DoFLevel
class internal::hp::DoFObjects
class internal::hp::DoFHandler::Implementation


Detailed Description

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

Manage the distribution and numbering of the degrees of freedom for hp-FEM algorithms.

This class has not yet been implemented for the use in the codimension one case (spacedim != dim ).


Member Typedef Documentation

template<int dim, int spacedim = dim>
typedef IteratorSelector::raw_line_iterator hp::DoFHandler< dim, spacedim >::raw_line_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::line_iterator hp::DoFHandler< dim, spacedim >::line_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::active_line_iterator hp::DoFHandler< dim, spacedim >::active_line_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::raw_quad_iterator hp::DoFHandler< dim, spacedim >::raw_quad_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::quad_iterator hp::DoFHandler< dim, spacedim >::quad_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::active_quad_iterator hp::DoFHandler< dim, spacedim >::active_quad_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::raw_hex_iterator hp::DoFHandler< dim, spacedim >::raw_hex_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::hex_iterator hp::DoFHandler< dim, spacedim >::hex_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::active_hex_iterator hp::DoFHandler< dim, spacedim >::active_hex_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::raw_cell_iterator hp::DoFHandler< dim, spacedim >::raw_cell_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::cell_iterator hp::DoFHandler< dim, spacedim >::cell_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::active_cell_iterator hp::DoFHandler< dim, spacedim >::active_cell_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::raw_face_iterator hp::DoFHandler< dim, spacedim >::raw_face_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::face_iterator hp::DoFHandler< dim, spacedim >::face_iterator

template<int dim, int spacedim = dim>
typedef IteratorSelector::active_face_iterator hp::DoFHandler< dim, spacedim >::active_face_iterator

template<int dim, int spacedim = dim>
typedef FunctionMap<spacedim>::type hp::DoFHandler< dim, spacedim >::FunctionMap

Alias the FunctionMap type declared elsewhere.


Constructor & Destructor Documentation

template<int dim, int spacedim = dim>
hp::DoFHandler< dim, spacedim >::DoFHandler ( const Triangulation< dim, spacedim > &  tria  ) 

Constructor. Take tria as the triangulation to work on.

template<int dim, int spacedim = dim>
virtual hp::DoFHandler< dim, spacedim >::~DoFHandler (  )  [virtual]

Destructor.

template<int dim, int spacedim = dim>
hp::DoFHandler< dim, spacedim >::DoFHandler ( const DoFHandler< dim, spacedim > &   )  [private]

Copy constructor. I can see no reason why someone might want to use it, so I don't provide it. Since this class has pointer members, making it private prevents the compiler to provide it's own, incorrect one if anyone chose to copy such an object.


Member Function Documentation

template<int dim, int spacedim = dim>
virtual void hp::DoFHandler< dim, spacedim >::distribute_dofs ( const hp::FECollection< dim, spacedim > &  fe  )  [virtual]

Go through the triangulation and distribute the degrees of freedoms needed for the given finite element according to the given distribution method.

A pointer of the transferred finite element is stored. Therefore, the lifetime of the finite element object shall be longer than that of this object. If you don't want this behaviour, you may want to call the clear member function which also releases the lock of this object to the finite element.

template<int dim, int spacedim = dim>
virtual void hp::DoFHandler< dim, spacedim >::clear (  )  [virtual]

Clear all data of this object and especially delete the lock this object has to the finite element used the last time when distribute_dofs was called.

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::renumber_dofs ( const std::vector< unsigned int > &  new_numbers  ) 

Renumber degrees of freedom based on a list of new dof numbers for all the dofs.

new_numbers is an array of integers with size equal to the number of dofs on the present grid. It stores the new indices after renumbering in the order of the old indices.

This function is called by the functions in DoFRenumbering function after computing the ordering of the degrees of freedom. However, you can call this function yourself, which is necessary if a user wants to implement an ordering scheme herself, for example downwind numbering.

The new_number array must have a size equal to the number of degrees of freedom. Each entry must state the new global DoF number of the degree of freedom referenced.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::max_couplings_between_dofs (  )  const

Return the maximum number of degrees of freedom a degree of freedom in the given triangulation with the given finite element may couple with. This is the maximum number of entries per line in the system matrix; this information can therefore be used upon construction of the SparsityPattern object.

The returned number is not really the maximum number but an estimate based on the finite element and the maximum number of cells meeting at a vertex. The number holds for the constrained matrix also.

As for DoFHandler::max_couplings_between_dofs(), the result of this function is often not very accurate for 3d and/or high polynomial degrees. The consequences are discussed in the documentation of the module on Sparsity patterns.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::max_couplings_between_boundary_dofs (  )  const

Return the number of degrees of freedom located on the boundary another dof on the boundary can couple with.

The number is the same as for max_coupling_between_dofs in one dimension less.

template<int dim, int spacedim = dim>
raw_cell_iterator hp::DoFHandler< dim, spacedim >::begin_raw ( const unsigned int  level = 0  )  const

Iterator to the first cell, used or not, on level level. If a level has no cells, a past-the-end iterator is returned.

This function calls begin_raw_line in 1D and begin_raw_quad in 2D.

template<int dim, int spacedim = dim>
cell_iterator hp::DoFHandler< dim, spacedim >::begin ( const unsigned int  level = 0  )  const

Iterator to the first used cell on level level.

This function calls begin_line in 1D and begin_quad in 2D.

template<int dim, int spacedim = dim>
active_cell_iterator hp::DoFHandler< dim, spacedim >::begin_active ( const unsigned int  level = 0  )  const

Iterator to the first active cell on level level.

This function calls begin_active_line in 1D and begin_active_quad in 2D.

template<int dim, int spacedim = dim>
raw_cell_iterator hp::DoFHandler< dim, spacedim >::end (  )  const

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

This function calls end_line in 1D and end_quad in 2D.

template<int dim, int spacedim = dim>
cell_iterator hp::DoFHandler< dim, spacedim >::end ( const unsigned int  level  )  const

Return an iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_cell_iterator hp::DoFHandler< dim, spacedim >::end_raw ( const unsigned int  level  )  const

Return a raw iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
active_cell_iterator hp::DoFHandler< dim, spacedim >::end_active ( const unsigned int  level  )  const

Return an active iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_cell_iterator hp::DoFHandler< dim, spacedim >::last_raw (  )  const

Return an iterator pointing to the last cell, used or not.

This function calls last_raw_line in 1D and last_raw_quad in 2D.

template<int dim, int spacedim = dim>
raw_cell_iterator hp::DoFHandler< dim, spacedim >::last_raw ( const unsigned int  level  )  const

Return an iterator pointing to the last cell of the level level, used or not.

This function calls last_raw_line in 1D and last_raw_quad in 2D.

template<int dim, int spacedim = dim>
cell_iterator hp::DoFHandler< dim, spacedim >::last (  )  const

Return an iterator pointing to the last used cell.

This function calls last_line in 1D and last_quad in 2D.

template<int dim, int spacedim = dim>
cell_iterator hp::DoFHandler< dim, spacedim >::last ( const unsigned int  level  )  const

Return an iterator pointing to the last used cell on level level.

This function calls last_line in 1D and last_quad in 2D.

template<int dim, int spacedim = dim>
active_cell_iterator hp::DoFHandler< dim, spacedim >::last_active (  )  const

Return an iterator pointing to the last active cell.

This function calls last_active_line in 1D and last_active_quad in 2D.

template<int dim, int spacedim = dim>
active_cell_iterator hp::DoFHandler< dim, spacedim >::last_active ( const unsigned int  level  )  const

Return an iterator pointing to the last active cell on level level.

This function calls last_active_line in 1D and last_active_quad in 2D.

template<int dim, int spacedim = dim>
raw_face_iterator hp::DoFHandler< dim, spacedim >::begin_raw_face (  )  const

Iterator to the first face, used or not.

This function calls begin_raw_line in 2D and begin_raw_quad in 3D.

template<int dim, int spacedim = dim>
face_iterator hp::DoFHandler< dim, spacedim >::begin_face (  )  const

Iterator to the first used face.

This function calls begin_line in 2D and begin_quad in 3D.

template<int dim, int spacedim = dim>
active_face_iterator hp::DoFHandler< dim, spacedim >::begin_active_face (  )  const

Iterator to the first active face.

This function calls begin_active_line in 2D and begin_active_quad in 3D.

template<int dim, int spacedim = dim>
raw_face_iterator hp::DoFHandler< dim, spacedim >::end_face (  )  const

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

This function calls end_line in 2D and end_quad in 3D.

template<int dim, int spacedim = dim>
raw_face_iterator hp::DoFHandler< dim, spacedim >::end_raw_face (  )  const

Return a raw iterator past-the-end. This is the same as end_face().

template<int dim, int spacedim = dim>
active_face_iterator hp::DoFHandler< dim, spacedim >::end_active_face (  )  const

Return an active iterator past-the-end. This is the same as end_face().

template<int dim, int spacedim = dim>
raw_face_iterator hp::DoFHandler< dim, spacedim >::last_raw_face (  )  const

Return an iterator pointing to the last face, used or not.

This function calls last_raw_line in 2D and last_raw_quad in 3D.

template<int dim, int spacedim = dim>
face_iterator hp::DoFHandler< dim, spacedim >::last_face (  )  const

Return an iterator pointing to the last used face.

This function calls last_line in 2D and last_quad in 3D.

template<int dim, int spacedim = dim>
active_face_iterator hp::DoFHandler< dim, spacedim >::last_active_face (  )  const

Return an iterator pointing to the last active face.

This function calls last_active_line in 2D and last_active_quad in 3D.

template<int dim, int spacedim = dim>
raw_line_iterator hp::DoFHandler< dim, spacedim >::begin_raw_line ( const unsigned int  level = 0  )  const

Iterator to the first line, used or not, on level level. If a level has no lines, a past-the-end iterator is returned.

template<int dim, int spacedim = dim>
line_iterator hp::DoFHandler< dim, spacedim >::begin_line ( const unsigned int  level = 0  )  const

Iterator to the first used line on level level.

template<int dim, int spacedim = dim>
active_line_iterator hp::DoFHandler< dim, spacedim >::begin_active_line ( const unsigned int  level = 0  )  const

Iterator to the first active line on level level.

template<int dim, int spacedim = dim>
raw_line_iterator hp::DoFHandler< dim, spacedim >::end_line (  )  const

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

template<int dim, int spacedim = dim>
line_iterator hp::DoFHandler< dim, spacedim >::end_line ( const unsigned int  level  )  const

Return an iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_line_iterator hp::DoFHandler< dim, spacedim >::end_raw_line ( const unsigned int  level  )  const

Return a raw iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
active_line_iterator hp::DoFHandler< dim, spacedim >::end_active_line ( const unsigned int  level  )  const

Return an active iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_line_iterator hp::DoFHandler< dim, spacedim >::last_raw_line (  )  const

Return an iterator pointing to the last line, used or not.

template<int dim, int spacedim = dim>
raw_line_iterator hp::DoFHandler< dim, spacedim >::last_raw_line ( const unsigned int  level  )  const

Return an iterator pointing to the last line of the level level, used or not.

template<int dim, int spacedim = dim>
line_iterator hp::DoFHandler< dim, spacedim >::last_line (  )  const

Return an iterator pointing to the last used line.

template<int dim, int spacedim = dim>
line_iterator hp::DoFHandler< dim, spacedim >::last_line ( const unsigned int  level  )  const

Return an iterator pointing to the last used line on level level.

template<int dim, int spacedim = dim>
active_line_iterator hp::DoFHandler< dim, spacedim >::last_active_line (  )  const

Return an iterator pointing to the last active line.

template<int dim, int spacedim = dim>
active_line_iterator hp::DoFHandler< dim, spacedim >::last_active_line ( const unsigned int  level  )  const

Return an iterator pointing to the last active line on level level.

template<int dim, int spacedim = dim>
raw_quad_iterator hp::DoFHandler< dim, spacedim >::begin_raw_quad ( const unsigned int  level = 0  )  const

Iterator to the first quad, used or not, on level level. If a level has no quads, a past-the-end iterator is returned.

template<int dim, int spacedim = dim>
quad_iterator hp::DoFHandler< dim, spacedim >::begin_quad ( const unsigned int  level = 0  )  const

Iterator to the first used quad on level level.

template<int dim, int spacedim = dim>
active_quad_iterator hp::DoFHandler< dim, spacedim >::begin_active_quad ( const unsigned int  level = 0  )  const

Iterator to the first active quad on level level.

template<int dim, int spacedim = dim>
raw_quad_iterator hp::DoFHandler< dim, spacedim >::end_quad (  )  const

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

template<int dim, int spacedim = dim>
quad_iterator hp::DoFHandler< dim, spacedim >::end_quad ( const unsigned int  level  )  const

Return an iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_quad_iterator hp::DoFHandler< dim, spacedim >::end_raw_quad ( const unsigned int  level  )  const

Return a raw iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
active_quad_iterator hp::DoFHandler< dim, spacedim >::end_active_quad ( const unsigned int  level  )  const

Return an active iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_quad_iterator hp::DoFHandler< dim, spacedim >::last_raw_quad (  )  const

Return an iterator pointing to the last quad, used or not.

template<int dim, int spacedim = dim>
raw_quad_iterator hp::DoFHandler< dim, spacedim >::last_raw_quad ( const unsigned int  level  )  const

Return an iterator pointing to the last quad of the level level, used or not.

template<int dim, int spacedim = dim>
quad_iterator hp::DoFHandler< dim, spacedim >::last_quad (  )  const

Return an iterator pointing to the last used quad.

template<int dim, int spacedim = dim>
quad_iterator hp::DoFHandler< dim, spacedim >::last_quad ( const unsigned int  level  )  const

Return an iterator pointing to the last used quad on level level.

template<int dim, int spacedim = dim>
active_quad_iterator hp::DoFHandler< dim, spacedim >::last_active_quad (  )  const

Return an iterator pointing to the last active quad.

template<int dim, int spacedim = dim>
active_quad_iterator hp::DoFHandler< dim, spacedim >::last_active_quad ( const unsigned int  level  )  const

Return an iterator pointing to the last active quad on level level.

template<int dim, int spacedim = dim>
raw_hex_iterator hp::DoFHandler< dim, spacedim >::begin_raw_hex ( const unsigned int  level = 0  )  const

Iterator to the first hex, used or not, on level level. If a level has no hexs, a past-the-end iterator is returned.

template<int dim, int spacedim = dim>
hex_iterator hp::DoFHandler< dim, spacedim >::begin_hex ( const unsigned int  level = 0  )  const

Iterator to the first used hex on level level.

template<int dim, int spacedim = dim>
active_hex_iterator hp::DoFHandler< dim, spacedim >::begin_active_hex ( const unsigned int  level = 0  )  const

Iterator to the first active hex on level level.

template<int dim, int spacedim = dim>
raw_hex_iterator hp::DoFHandler< dim, spacedim >::end_hex (  )  const

Iterator past the end; this iterator serves for comparisons of iterators with past-the-end or before-the-beginning states.

template<int dim, int spacedim = dim>
hex_iterator hp::DoFHandler< dim, spacedim >::end_hex ( const unsigned int  level  )  const

Return an iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_hex_iterator hp::DoFHandler< dim, spacedim >::end_raw_hex ( const unsigned int  level  )  const

Return a raw iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
active_hex_iterator hp::DoFHandler< dim, spacedim >::end_active_hex ( const unsigned int  level  )  const

Return an active iterator which is the first iterator not on level. If level is the last level, then this returns end().

template<int dim, int spacedim = dim>
raw_hex_iterator hp::DoFHandler< dim, spacedim >::last_raw_hex (  )  const

Return an iterator pointing to the last hex, used or not.

template<int dim, int spacedim = dim>
raw_hex_iterator hp::DoFHandler< dim, spacedim >::last_raw_hex ( const unsigned int  level  )  const

Return an iterator pointing to the last hex of the level level, used or not.

template<int dim, int spacedim = dim>
hex_iterator hp::DoFHandler< dim, spacedim >::last_hex (  )  const

Return an iterator pointing to the last used hex.

template<int dim, int spacedim = dim>
hex_iterator hp::DoFHandler< dim, spacedim >::last_hex ( const unsigned int  level  )  const

Return an iterator pointing to the last used hex on level level.

template<int dim, int spacedim = dim>
active_hex_iterator hp::DoFHandler< dim, spacedim >::last_active_hex (  )  const

Return an iterator pointing to the last active hex.

template<int dim, int spacedim = dim>
active_hex_iterator hp::DoFHandler< dim, spacedim >::last_active_hex ( const unsigned int  level  )  const

Return an iterator pointing to the last active hex on level level.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::n_dofs (  )  const

Return number of degrees of freedom. Included in this number are those DoFs which are constrained by hanging nodes.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::n_boundary_dofs (  )  const

Return the number of degrees of freedom located on the boundary.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::n_boundary_dofs ( const FunctionMap boundary_indicators  )  const

Return the number of degrees of freedom located on those parts of the boundary which have a boundary indicator listed in the given set. The reason that a map rather than a set is used is the same as descibed in the section on the make_boundary_sparsity_pattern function.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::n_boundary_dofs ( const std::set< unsigned char > &  boundary_indicators  )  const

Same function, but with different data type of the argument, which is here simply a list of the boundary indicators under consideration.

template<int dim, int spacedim = dim>
const hp::FECollection<dim,spacedim>& hp::DoFHandler< dim, spacedim >::get_fe (  )  const

Return a constant reference to the set of finite element objects that are used by this DoFHandler.

Referenced by DoFTools::fe_is_primitive(), DoFTools::max_dofs_per_cell(), DoFTools::max_dofs_per_face(), DoFTools::max_dofs_per_vertex(), and DoFTools::n_components().

template<int dim, int spacedim = dim>
const Triangulation<dim,spacedim>& hp::DoFHandler< dim, spacedim >::get_tria (  )  const

Return a constant reference to the triangulation underlying this object.

template<int dim, int spacedim = dim>
virtual unsigned int hp::DoFHandler< dim, spacedim >::memory_consumption (  )  const [virtual]

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

This function is made virtual, since a dof handler object might be accessed through a pointers to thisr base class, although the actual object might be a derived class.

template<int dim, int spacedim = dim>
DoFHandler& hp::DoFHandler< dim, spacedim >::operator= ( const DoFHandler< dim, spacedim > &   )  [private]

Copy operator. I can see no reason why someone might want to use it, so I don't provide it. Since this class has pointer members, making it private prevents the compiler to provide it's own, incorrect one if anyone chose to copy such an object.

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::clear_space (  )  [private]

Free all used memory.

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::create_active_fe_table (  )  [private]

Create default tables for the active_fe_indices in the internal::hp::DoFLevels. They are initialized with the a zero indicator, meaning that fe[0] is going to be used by default. This method is called before refinement and before distribute_dofs is called. It ensures each cell has a valid active_fe_index.

template<int dim, int spacedim = dim>
virtual void hp::DoFHandler< dim, spacedim >::pre_refinement_notification ( const Triangulation< dim, spacedim > &  tria  )  [private, virtual]

Methods of the RefinementListener coming from the Triangulation. Here they are used to administrate the the active_fe_fields during the spatial refinement.

Reimplemented from Triangulation< dim, spacedim >::RefinementListener.

template<int dim, int spacedim = dim>
virtual void hp::DoFHandler< dim, spacedim >::post_refinement_notification ( const Triangulation< dim, spacedim > &  tria  )  [private, virtual]

After refinement is actually performed, the triangulation class calls this method on all objects derived from this class and registered with the triangulation.

Reimplemented from Triangulation< dim, spacedim >::RefinementListener.

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::compute_vertex_dof_identities ( std::vector< unsigned int > &  new_dof_indices  )  const [private]

Compute identities between DoFs located on vertices. Called from distribute_dofs().

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::compute_line_dof_identities ( std::vector< unsigned int > &  new_dof_indices  )  const [private]

Compute identities between DoFs located on lines. Called from distribute_dofs().

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::compute_quad_dof_identities ( std::vector< unsigned int > &  new_dof_indices  )  const [private]

Compute identities between DoFs located on quads. Called from distribute_dofs().

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::renumber_dofs_internal ( const std::vector< unsigned int > &  new_numbers,
internal::int2type< 0 >   
) [private]

Renumber the objects with the given and all lower structural dimensions, i.e. renumber vertices by giving a template argument of zero to the int2type argument, lines and vertices with one, etc.

Note that in contrast to the public renumber_dofs() function, these internal functions do not ensure that the new DoFs are contiguously numbered. The function may therefore also be used to assign different DoFs the same number, for example to unify hp DoFs corresponding to different finite elements but co-located on the same entity.

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::renumber_dofs_internal ( const std::vector< unsigned int > &  new_numbers,
internal::int2type< 1 >   
) [private]

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::renumber_dofs_internal ( const std::vector< unsigned int > &  new_numbers,
internal::int2type< 2 >   
) [private]

template<int dim, int spacedim = dim>
void hp::DoFHandler< dim, spacedim >::renumber_dofs_internal ( const std::vector< unsigned int > &  new_numbers,
internal::int2type< 3 >   
) [private]


Friends And Related Function Documentation

template<int dim, int spacedim = dim>
friend class ::DoFAccessor [friend]

Make accessor objects friends.

template<int dim, int spacedim = dim>
friend class ::DoFCellAccessor [friend]

template<int dim, int spacedim = dim>
friend class internal::DoFAccessor::Implementation [friend]

template<int dim, int spacedim = dim>
friend class internal::DoFCellAccessor::Implementation [friend]

template<int dim, int spacedim = dim>
friend class internal::hp::DoFLevel [friend]

Likewise for DoFLevel objects since they need to access the vertex dofs in the functions that set and retrieve vertex dof indices.

template<int dim, int spacedim = dim>
friend class internal::hp::DoFObjects [friend]

template<int dim, int spacedim = dim>
friend class internal::hp::DoFHandler::Implementation [friend]


Member Data Documentation

template<int dim, int spacedim = dim>
hp::DoFHandler< dim, spacedim >::__pad0__ [package]

template<int dim, int spacedim = dim>
spacedim hp::DoFHandler< dim, spacedim >::IteratorSelector [package]

template<int dim, int spacedim = dim>
const unsigned int hp::DoFHandler< dim, spacedim >::dimension = dim [static]

Make the dimension available in function templates.

template<int dim, int spacedim = dim>
const unsigned int hp::DoFHandler< dim, spacedim >::space_dimension = spacedim [static]

Make the space dimension available in function templates.

template<int dim, int spacedim = dim>
const unsigned int hp::DoFHandler< dim, spacedim >::invalid_dof_index = numbers::invalid_unsigned_int [static]

When the arrays holding the DoF indices are set up, but before they are filled with actual values, they are set to an invalid value, in order to monitor possible problems. This invalid value is the constant defined here.

Please note that you should not rely on it having a certain value, but rather take its symbolic name.

template<int dim, int spacedim = dim>
const unsigned int hp::DoFHandler< dim, spacedim >::default_fe_index = numbers::invalid_unsigned_int [static]

The default index of the finite element to be used on a given cell. For the usual, non-hp DoFHandler class that only supports the same finite element to be used on all cells, the index of the finite element needs to be the same on all cells anyway, and by convention we pick zero for this value. The situation here is different, since the hp classes support the case where different finite element indices may be used on different cells. The default index consequently corresponds to an invalid value.

template<int dim, int spacedim = dim>
SmartPointer<const Triangulation<dim,spacedim> > hp::DoFHandler< dim, spacedim >::tria [protected]

Address of the triangulation to work on.

template<int dim, int spacedim = dim>
SmartPointer<const hp::FECollection<dim,spacedim> > hp::DoFHandler< dim, spacedim >::finite_elements [protected]

Store a pointer to the finite element set given latest for the distribution of dofs. In order to avoid destruction of the object before the lifetime of the DoF handler, we subscribe to the finite element object. To unlock the FE before the end of the lifetime of this DoF handler, use the clear() function (this clears all data of this object as well, though).

template<int dim, int spacedim = dim>
std::vector<internal::hp::DoFLevel<dim>*> hp::DoFHandler< dim, spacedim >::levels [private]

Space to store the DoF numbers for the different levels. Analogous to the levels[] tree of the Triangulation objects.

template<int dim, int spacedim = dim>
internal::hp::DoFFaces<dim>* hp::DoFHandler< dim, spacedim >::faces [private]

Space to store the DoF numbers for the faces. Analogous to the faces pointer of the Triangulation objects.

template<int dim, int spacedim = dim>
unsigned int hp::DoFHandler< dim, spacedim >::used_dofs [private]

Store the number of dofs created last time.

template<int dim, int spacedim = dim>
std::vector<unsigned int> hp::DoFHandler< dim, spacedim >::vertex_dofs [private]

Array to store the indices for degrees of freedom located at vertices.

The format used here, in the form of a linked list, is the same as used for the arrays used in the hp::DoFLevel hierarchy. Starting indices into this array are provided by the vertex_dofs_offsets field.

Access to this field is generally through the DoFAccessor::get_vertex_dof_index() and DoFAccessor::set_vertex_dof_index() functions, encapsulating the actual data format used to the present class.

template<int dim, int spacedim = dim>
std::vector<unsigned int> hp::DoFHandler< dim, spacedim >::vertex_dofs_offsets [private]

For each vertex in the triangulation, store the offset within the vertex_dofs array where the dofs for this vertex start.

As for that array, the format is the same as described in the documentation of hp::DoFLevel.

Access to this field is generally through the Accessor::get_vertex_dof_index() and Accessor::set_vertex_dof_index() functions, encapsulating the actual data format used to the present class.

template<int dim, int spacedim = dim>
std::vector<std::vector<bool> *> hp::DoFHandler< dim, spacedim >::has_children [private]

Array to store the information, if a cell on some level has children or not. It is used by the refinement listeners as a persistent buffer during the refinement.


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

deal.II documentation generated on Sat Aug 15 16:52:35 2009 by doxygen 1.5.9