Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Friends

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

Inheritance diagram for DoFHandler< dim, spacedim >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef
IteratorSelector::CellAccessor 
cell_accessor
typedef
IteratorSelector::FaceAccessor 
face_accessor
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 ()
 DoFHandler (const Triangulation< dim, spacedim > &tria)
virtual ~DoFHandler ()
void initialize (const Triangulation< dim, spacedim > &tria, const FiniteElement< dim, spacedim > &fe)
virtual void distribute_dofs (const FiniteElement< dim, spacedim > &fe, const unsigned int offset=0)
void initialize_local_block_info ()
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 BlockInfoblock_info () const
unsigned int n_locally_owned_dofs () const
const IndexSetlocally_owned_dofs () const
const std::vector< IndexSet > & locally_owned_dofs_per_processor () const
const std::vector< unsigned int > & n_locally_owned_dofs_per_processor () const
const FiniteElement< dim,
spacedim > & 
get_fe () const
const Triangulation< dim,
spacedim > & 
get_tria () const
virtual std::size_t memory_consumption () const
template<class Archive >
void save (Archive &ar, const unsigned int version) const
template<class Archive >
void load (Archive &ar, const unsigned int version)
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 Member Functions

::ExceptionBaseExcRenumberingIncomplete ()
::ExceptionBaseExcGridsDoNotMatch ()
::ExceptionBaseExcInvalidBoundaryIndicator ()
::ExceptionBaseExcNewNumbersNotConsecutive (int arg1) throw (errortext << "The given list of new dof indices is not consecutive: " << "the index " << arg1 << " does not exist." )
::ExceptionBaseExcInvalidLevel (int arg1) throw (errortext << "The given level " << arg1 << " is not in the valid range!" )
::ExceptionBaseExcFacesHaveNoLevel ()
::ExceptionBaseExcEmptyLevel (int arg1) throw (errortext << "You tried to do something on level " << arg1 << ", but this level is empty." )

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

BlockInfo block_info_object
std::vector< unsigned int > vertex_dofs
SmartPointer< const
Triangulation< dim, spacedim >
, DoFHandler< dim, spacedim > > 
tria
SmartPointer< const
FiniteElement< dim, spacedim >
, DoFHandler< dim, spacedim > > 
selected_fe
std_cxx1x::shared_ptr
< internal::DoFHandler::Policy::PolicyBase
< dim, spacedim > > 
policy
internal::DoFHandler::NumberCache number_cache

Private Types

typedef
internal::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

Friends

class DoFAccessor
class DoFCellAccessor
struct internal::DoFAccessor::Implementation
struct internal::DoFCellAccessor::Implementation
struct internal::DoFHandler::Implementation
struct internal::DoFHandler::Policy::Implementation

Related Functions

(Note that these are not member functions.)


Auxiliary functions
template<int dim, int spacedim>
unsigned int max_dofs_per_cell (const DoFHandler< dim, spacedim > &dh)
template<int dim, int spacedim>
unsigned int max_dofs_per_face (const DoFHandler< dim, spacedim > &dh)
template<int dim, int spacedim>
unsigned int max_dofs_per_vertex (const DoFHandler< dim, spacedim > &dh)
template<int dim, int spacedim>
unsigned int n_components (const DoFHandler< dim, spacedim > &dh)
template<int dim, int spacedim>
bool fe_is_primitive (const DoFHandler< dim, spacedim > &dh)

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. The purpose of this class is first discussed in the step-2 tutorial program.

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.

Interaction with distributed meshes

Upon construction, this class takes a reference to a triangulation object. In most cases, this will be a reference to an object of type Triangulation, i.e. the class that represents triangulations that entirely reside on a single processor. However, it can also be of type parallel::distributed::Triangulation (see, for example, step-32, step-40 and in particular the Parallel computing with multiple processors using distributed memory module) in which case the DoFHandler object will proceed to only manage degrees of freedom on locally owned and ghost cells. This process is entirely transparent to the used.

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.

Serializing (loading or storing) DoFHandler objects

Like many other classes in deal.II, the DoFHandler class can stream its contents to an archive using BOOST's serialization facilities. The data so stored can later be retrieved again from the archive to restore the contents of this object. This facility is frequently used to save the state of a program to disk for possible later resurrection, often in the context of checkpoint/restart strategies for long running computations or on computers that aren't very reliable (e.g. on very large clusters where individual nodes occasionally fail and then bring down an entire MPI job).

The model for doing so is similar for the DoFHandler class as it is for the Triangulation class (see the section in the general documentation of that class). In particular, the load() function does not exactly restore the same state as was stored previously using the save() function. Rather, the function assumes that you load data into a DoFHandler object that is already associated with a triangulation that has a content that matches the one that was used when the data was saved. Likewise, the load() function assumes that the current object is already associated with a finite element object that matches the one that was associated with it when data was saved; the latter can be achieved by calling DoFHandler::distribute_dofs() using the same kind of finite element before re-loading data from the serialization archive.

Author:
Wolfgang Bangerth

Definition at line 172 of file dof_handler.h.


Member Typedef Documentation

template<int dim, int spacedim = dim>
typedef internal::DoFHandler::Iterators<DoFHandler<dim,spacedim> > DoFHandler< dim, spacedim >::IteratorSelector [private]
template<int dim, int spacedim = dim>
typedef IteratorSelector::CellAccessor DoFHandler< dim, spacedim >::cell_accessor
template<int dim, int spacedim = dim>
typedef IteratorSelector::FaceAccessor DoFHandler< dim, spacedim >::face_accessor
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.

Definition at line 203 of file dof_handler.h.


Constructor & Destructor Documentation

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

Standard constructor, not initializing any data. After constructing an object with this constructor, use initialize() to make a valid DoFHandler.

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>
void DoFHandler< dim, spacedim >::initialize ( const Triangulation< dim, spacedim > &  tria,
const FiniteElement< dim, spacedim > &  fe 
)

Assign a Triangulation and a FiniteElement to the DoFHandler and compute the distribution of degrees of freedom over the mesh.

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 purpose of this function is first discussed in the introduction to the step-2 tutorial program.

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 >, and MGDoFHandler< 1, spacedim >.

template<int dim, int spacedim = dim>
void DoFHandler< dim, spacedim >::initialize_local_block_info (  )

After distribute_dofs() with an FESystem element, the block structure of global and level vectors is stored in a BlockInfo object accessible with block_info(). This function initializes the local block structure on each cell in the same object.

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 >, MGDoFHandler< 1, 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.

This function is called by the functions in DoFRenumbering function after computing the ordering of the degrees of freedom. This function is called, for example, by the functions in the DoFRenumbering namespace, but it can of course also be called from user code.

  • new_number This array must have a size equal to the number of degrees of freedom owned by the current processor, i.e. the size must be equal to what n_locally_owned_dofs() returns. If only one processor participates in storing the current mesh, then this equals the total number of degrees of freedom, i.e. the result of n_dofs(). The contents of this array are the new global indices for each freedom listed in the IndexSet returned by locally_owned_dofs(). In the case of a sequential mesh this means that the array is a list of new indices for each of the degrees of freedom on the current mesh. In the case that we have a parallel::distributed::Triangulation underlying this DoFHandler object, the array is a list of new indices for all the locally owned degrees of freedom, enumerated in the same order as the currently locally owned DoFs. In other words, assume that degree of freedom i is currently locally owned, then new_numbers[locally_owned_dofs().index_within_set(i)] returns the new global DoF index of i. Since the IndexSet of locally_owned_dofs() is complete in the sequential case, the latter convention for the content of the array reduces to the former in the case that only one processor participates in the mesh.

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

Referenced by MGDoFHandler< dim, spacedim >::renumber_dofs().

template<int dim, int spacedim = dim>
unsigned int DoFHandler< dim, spacedim >::max_couplings_between_dofs (  ) const
Deprecated:
Use CompressedSparsityPattern instead of initializing SparsityPattern with this value, see the discussion in step-2 and the Sparsity patterns module.

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-2 and step-11 example programs 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
Deprecated:
Use CompressedSparsityPattern instead of initializing SparsityPattern with this value.

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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, 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 >, MGDoFHandler< 1, spacedim >, and MGDoFHandler< dim >.

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

Return the global number of degrees of freedom. If the current object handles all degrees of freedom itself (even if you may intend to solve your linear system in parallel, such as in step-17 or step-18), then this number equals the number of locally owned degrees of freedom since this object doesn't know anything about what you want to do with it and believes that it owns every degree of freedom it knows about.

On the other hand, if this object operates on a parallel::distributed::Triangulation object, then this function returns the global number of degrees of freedom, accumulated over all processors.

In either case, included in the returned number are those DoFs which are constrained by hanging nodes, see Constraints on degrees of freedom.

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

Referenced by MGDoFHandler< dim, spacedim >::n_dofs().

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 BlockInfo& DoFHandler< dim, spacedim >::block_info (  ) const

Access to an object informing of the block structure of the dof handler.

If an FESystem is used in distribute_dofs(), degrees of freedom naturally split into several blocks. For each base element as many blocks appear as its multiplicity.

At the end of distribute_dofs(), the number of degrees of freedom in each block is counted, and stored in a BlockInfo object, which can be accessed here. In an MGDoFHandler, the same is done on each level. Additionally, the block structure on each cell can be generated in this object by calling initialize_local_block_indices().

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

Return the number of degrees of freedom that belong to this process.

If this is a sequential job, then the result equals that produced by n_dofs(). On the other hand, if we are operating on a parallel::distributed::Triangulation, then it includes only the degrees of freedom that the current processor owns. Note that in this case this does not include all degrees of freedom that have been distributed on the current processor's image of the mesh: in particular, some of the degrees of freedom on the interface between the cells owned by this processor and cells owned by other processors may be theirs, and degrees of freedom on ghost cells are also not necessarily included.

template<int dim, int spacedim = dim>
const IndexSet& DoFHandler< dim, spacedim >::locally_owned_dofs (  ) const

Return an IndexSet describing the set of locally owned DoFs as a subset of 0..n_dofs(). The number of elements of this set equals n_locally_owned_dofs().

template<int dim, int spacedim = dim>
const std::vector<IndexSet>& DoFHandler< dim, spacedim >::locally_owned_dofs_per_processor (  ) const

Returns a vector that stores the locally owned DoFs of each processor. If you are only interested in the number of elements each processor owns then n_dofs_per_processor() is a better choice.

If this is a sequential job, then the vector has a single element that equals the IndexSet representing the entire range [0,n_dofs()].

template<int dim, int spacedim = dim>
const std::vector<unsigned int>& DoFHandler< dim, spacedim >::n_locally_owned_dofs_per_processor (  ) const

Return a vector that stores the number of degrees of freedom each processor that participates in this triangulation owns locally. The sum of all these numbers equals the number of degrees of freedom that exist globally, i.e. what n_dofs() returns.

Each element of the vector returned by this function equals the number of elements of the corresponding sets returned by global_dof_indices().

If this is a sequential job, then the vector has a single element equal to n_dofs().

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.

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.

Referenced by MGConstrainedDoFs::initialize().

template<int dim, int spacedim = dim>
virtual std::size_t 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 this base class, although the actual object might be a derived class.

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

template<int dim, int spacedim = dim>
template<class Archive >
void DoFHandler< dim, spacedim >::save ( Archive &  ar,
const unsigned int  version 
) const

Write the data of this object to a stream for the purpose of serialization.

template<int dim, int spacedim = dim>
template<class Archive >
void DoFHandler< dim, spacedim >::load ( Archive &  ar,
const unsigned int  version 
)

Read the data of this object from a stream for the purpose of serialization.

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 >, MGDoFHandler< 1, spacedim >, and MGDoFHandler< dim >.


Friends And Related Function Documentation

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

Make accessor objects friends.

Definition at line 1404 of file dof_handler.h.

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

Definition at line 1405 of file dof_handler.h.

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

Definition at line 1406 of file dof_handler.h.

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

Definition at line 1407 of file dof_handler.h.

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

Definition at line 1409 of file dof_handler.h.

template<int dim, int spacedim = dim>
friend struct internal::DoFHandler::Policy::Implementation [friend]

Definition at line 1410 of file dof_handler.h.

template<int dim, int spacedim>
unsigned int max_dofs_per_cell ( const DoFHandler< dim, spacedim > &  dh ) [related]

Maximal number of degrees of freedom on a cell.

template<int dim, int spacedim>
unsigned int max_dofs_per_face ( const DoFHandler< dim, spacedim > &  dh ) [related]

Maximal number of degrees of freedom on a face.

This function exists for both non-hp and hp DoFHandlers, to allow for a uniform interface to query this property.

template<int dim, int spacedim>
unsigned int max_dofs_per_vertex ( const DoFHandler< dim, spacedim > &  dh ) [related]

Maximal number of degrees of freedom on a vertex.

This function exists for both non-hp and hp DoFHandlers, to allow for a uniform interface to query this property.

template<int dim, int spacedim>
unsigned int n_components ( const DoFHandler< dim, spacedim > &  dh ) [related]

Number of vector components in the finite element object used by this DoFHandler.

This function exists for both non-hp and hp DoFHandlers, to allow for a uniform interface to query this property.

template<int dim, int spacedim>
bool fe_is_primitive ( const DoFHandler< dim, spacedim > &  dh ) [related]

Find out whether the FiniteElement used by this DoFHandler is primitive or not.

This function exists for both non-hp and hp DoFHandlers, to allow for a uniform interface to query this property.


Member Data Documentation

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 >, MGDoFHandler< 1, spacedim >, and MGDoFHandler< dim >.

Definition at line 209 of file dof_handler.h.

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 >, MGDoFHandler< 1, spacedim >, and MGDoFHandler< dim >.

Definition at line 215 of file dof_handler.h.

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.

Definition at line 232 of file dof_handler.h.

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.

Definition at line 254 of file dof_handler.h.

template<int dim, int spacedim = dim>
BlockInfo DoFHandler< dim, spacedim >::block_info_object [protected]

The object containing information on the block structure.

Definition at line 1300 of file dof_handler.h.

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

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

Definition at line 1307 of file dof_handler.h.

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

Address of the triangulation to work on.

Definition at line 1316 of file dof_handler.h.

template<int dim, int spacedim = dim>
SmartPointer<const FiniteElement<dim,spacedim>,DoFHandler<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).

Definition at line 1331 of file dof_handler.h.

template<int dim, int spacedim = dim>
std_cxx1x::shared_ptr<internal::DoFHandler::Policy::PolicyBase<dim,spacedim> > DoFHandler< dim, spacedim >::policy [protected]

An object that describes how degrees of freedom should be distributed and renumbered.

Definition at line 1338 of file dof_handler.h.

template<int dim, int spacedim = dim>
internal::DoFHandler::NumberCache DoFHandler< dim, spacedim >::number_cache [protected]

A structure that contains all sorts of numbers that characterize the degrees of freedom this object works on.

For most members of this structure, there is an accessor function in this class that returns its value.

Definition at line 1351 of file dof_handler.h.

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.

Definition at line 1389 of file dof_handler.h.

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.

Definition at line 1399 of file dof_handler.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Fri Feb 3 2012 06:04:07 by doxygen 1.7.2