DoFHandler< dim, spacedim > Class Template Reference
[Degrees of Freedom]

Inheritance diagram for DoFHandler< dim, spacedim >:

Inheritance graph
[legend]

List of all members.

Classes

class  ExcEmptyLevel
class  ExcFacesHaveNoLevel
class  ExcGridsDoNotMatch
class  ExcInvalidBoundaryIndicator
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 FiniteElement< dim, spacedim > &fe, const unsigned int offset=0)
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 FiniteElement< 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
face_iterator last_face (const unsigned int level) 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 = 0

Protected Attributes

SmartPointer< const
Triangulation< dim, spacedim > > 
tria
SmartPointer< const
FiniteElement< dim, spacedim > > 
selected_fe

Package Attributes

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

Private Member Functions

 DoFHandler (const DoFHandler &)
DoFHandleroperator= (const DoFHandler &)
void clear_space ()

Private Attributes

std::vector
< internal::DoFHandler::DoFLevel
< dim > * > 
levels
internal::DoFHandler::DoFFaces
< dim > * 
faces
unsigned int used_dofs
std::vector< unsigned intvertex_dofs

Friends

class DoFAccessor
class DoFCellAccessor
class internal::DoFAccessor::Implementation
class internal::DoFCellAccessor::Implementation
class internal::DoFHandler::Implementation


Detailed Description

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

Manage the distribution and numbering of the degrees of freedom for non-multigrid algorithms.

For each vertex, line, quad, etc, we store a list of the indices of degrees of freedom living on this object. These indices refer to the unconstrained degrees of freedom, i.e. constrained degrees of freedom are numbered in the same way as unconstrained ones, and are only later eliminated. This leads to the fact that indices in global vectors and matrices also refer to all degrees of freedom and some kind of condensation is needed to restrict the systems of equations to the unconstrained degrees of freedom only. The actual layout of storage of the indices is described in the internal::DoFHandler::DoFLevel class documentation.

The class offers iterators to traverse all cells, in much the same way as the Triangulation class does. Using the begin() and end() functions (and all their companions, like begin_active(), begin_line(), etc, just as for the Triangulation class), one can obtain iterators to walk over cells, and query the degree of freedom structures as well as the triangulation data. These iterators are built on top of those of the Triangulation class, but offer the additional information on degrees of freedom functionality than pure triangulation iterators. The order in which dof iterators are presented by the ++ and -- operators is the same as that for the corresponding triangulation iterators.

The spacedim parameter has to be used if one wants to solve problems in the boundary element method formulation or in an equivalent one, as it is explained in the Triangulation class. If not specified, this parameter takes the default value =dim so that this class can be used to solve problems in the finite element method formulation.

Distribution of indices for degrees of freedom

The degrees of freedom (`dofs') are distributed on the given triangulation by the function distribute_dofs(). It gets passed a finite element object describing how many degrees of freedom are located on vertices, lines, etc. It traverses the triangulation cell by cell and numbers the dofs of that cell if not yet numbered. For non-multigrid algorithms, only active cells are considered. Active cells are defined to be those cells which have no children, i.e. they are the most refined ones.

Since the triangulation is traversed starting with the cells of the coarsest active level and going to more refined levels, the lowest numbers for dofs are given to the largest cells as well as their bounding lines and vertices, with the dofs of more refined cells getting higher numbers.

This numbering implies very large bandwiths of the resulting matrices and is thus vastly suboptimal for some solution algorithms. For this reason, the DoFRenumbering class offers several algorithms to reorder the dof numbering according. See there for a discussion of the implemented algorithms.

User defined renumbering schemes

The DoFRenumbering class offers a number of renumbering schemes like the Cuthill-McKey scheme. Basically, the function sets up an array in which for each degree of freedom we store the new index this DoF should have after renumbering. Using this array, the renumber_dofs() function of the present class is called, which actually performs the change from old DoF indices to the ones given in the array. In some cases, however, a user may want to compute her own renumbering order; in this case, one can allocate an array with one element per degree of freedom and fill it with the number that the respective degree of freedom shall be assigned. This number may, for example, be obtained by sorting the support points of the degrees of freedom in downwind direction. Then call the renumber_dofs(vector<unsigned int>) function with the array, which converts old into new degree of freedom indices.

Author:
Wolfgang Bangerth, 1998

Member Typedef Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Alias the FunctionMap type declared elsewhere.


Constructor & Destructor Documentation

template<int dim, int spacedim = dim>
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 DoFHandler< dim, spacedim >::~DoFHandler (  )  [virtual]

Destructor.

template<int dim, int spacedim = dim>
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 DoFHandler< dim, spacedim >::distribute_dofs ( const FiniteElement< dim, spacedim > &  fe,
const unsigned int  offset = 0 
) [virtual]

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

The additional optional parameter offset allows you to reserve space for a finite number of additional vector entries in the beginning of all discretization vectors, by starting the enumeration of degrees of freedom on the grid at a nonzero value. By default, this value is of course zero.

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.

Reimplemented in MGDoFHandler< dim, spacedim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
unsigned int 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 as well.

The determination of the number of couplings can be done by simple picture drawing. An example can be found in the implementation of this function.

Note that this function is most often used to determine the maximal row length for sparsity patterns. Unfortunately, while the estimates returned by this function are rather accurate in 1d and 2d, they are often significantly too high in 3d, leading the SparsityPattern class to allocate much too much memory in some cases. Unless someone comes around to improving the present function for 3d, there is not very much one can do about these cases. The typical way to work around this problem is to use an intermediate compressed sparsity pattern that only allocates memory on demand. Refer to the step-11 example program on how to do this. The problem is also discussed in the documentation of the module on Sparsity patterns.

template<int dim, int spacedim = dim>
unsigned int 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_couplings_between_dofs() in one dimension less.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
cell_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
raw_cell_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
active_cell_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first used face on level level.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first active face on level level.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first used line on level level.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first active line on level level.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
line_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
raw_line_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
active_line_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Return an iterator pointing to the last used line.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Return an iterator pointing to the last active line.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first used quad on level level.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first active quad on level level.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
quad_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
raw_quad_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
active_quad_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Return an iterator pointing to the last used quad.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Return an iterator pointing to the last active quad.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first used hex on level level.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Iterator to the first active hex on level level.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
hex_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
raw_hex_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
active_hex_iterator 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().

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Return an iterator pointing to the last used hex.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Return an iterator pointing to the last active hex.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
unsigned int 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 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 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 FiniteElement<dim,spacedim>& DoFHandler< dim, spacedim >::get_fe (  )  const

Return a constant reference to the selected finite element object.

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>& 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 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.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
DoFHandler& 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 DoFHandler< dim, spacedim >::clear_space (  )  [private]

Free all used memory.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.


Friends And Related Function Documentation

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

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::DoFHandler::Implementation [friend]


Member Data Documentation

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

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

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

Make the dimension available in function templates.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

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

Make the space dimension available in function templates.

Reimplemented in MGDoFHandler< dim, spacedim >, and MGDoFHandler< dim >.

template<int dim, int spacedim = dim>
const unsigned int 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 DoFHandler< dim, spacedim >::default_fe_index = 0 [static]

The default index of the finite element to be used on a given cell. Since the present class 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 is different for hp objects (i.e. the hp::DoFHandler class) where different finite element indices may be used on different cells, and the default index there corresponds to an invalid value.

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

Address of the triangulation to work on.

template<int dim, int spacedim = dim>
SmartPointer<const FiniteElement<dim,spacedim> > DoFHandler< dim, spacedim >::selected_fe [protected]

Store a pointer to the finite element 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::DoFHandler::DoFLevel<dim>*> 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::DoFHandler::DoFFaces<dim>* DoFHandler< dim, spacedim >::faces [private]

Space to store DoF numbers of faces. They are not stored in levels since faces are not organized hierarchically, but in a flat array.

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

Store the number of dofs created last time.

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

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


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

deal.II documentation generated on Sat Aug 15 16:51:50 2009 by doxygen 1.5.9