Reference documentation for deal.II version Git 70d02132d0 2020-07-06 10:39:37 -0400
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Classes | Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Private Types | List of all members
DoFHandler< dim, spacedim > Class Template Reference

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

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

Classes

struct  ActiveFEIndexTransfer
 
class  MGVertexDoFs
 

Public Types

using cell_accessor = typename ActiveSelector::CellAccessor
 
using face_accessor = typename ActiveSelector::FaceAccessor
 
using line_iterator = typename ActiveSelector::line_iterator
 
using active_line_iterator = typename ActiveSelector::active_line_iterator
 
using quad_iterator = typename ActiveSelector::quad_iterator
 
using active_quad_iterator = typename ActiveSelector::active_quad_iterator
 
using hex_iterator = typename ActiveSelector::hex_iterator
 
using active_hex_iterator = typename ActiveSelector::active_hex_iterator
 
using active_cell_iterator = typename ActiveSelector::active_cell_iterator
 
using cell_iterator = typename ActiveSelector::cell_iterator
 
using face_iterator = typename ActiveSelector::face_iterator
 
using active_face_iterator = typename ActiveSelector::active_face_iterator
 
using level_cell_accessor = typename LevelSelector::CellAccessor
 
using level_face_accessor = typename LevelSelector::FaceAccessor
 
using level_cell_iterator = typename LevelSelector::cell_iterator
 
using level_face_iterator = typename LevelSelector::face_iterator
 
using active_fe_index_type = unsigned short int
 
using offset_type = unsigned int
 

Public Member Functions

 DoFHandler (const bool hp_capability_enabled=false)
 
 DoFHandler (const Triangulation< dim, spacedim > &tria, const bool hp_capability_enabled=false)
 
 DoFHandler (const DoFHandler &)=delete
 
virtual ~DoFHandler () override
 
DoFHandleroperator= (const DoFHandler &)=delete
 
void initialize (const Triangulation< dim, spacedim > &tria, const FiniteElement< dim, spacedim > &fe)
 
void initialize (const Triangulation< dim, spacedim > &tria, const hp::FECollection< dim, spacedim > &fe)
 
void set_fe (const FiniteElement< dim, spacedim > &fe)
 
void set_fe (const hp::FECollection< dim, spacedim > &fe)
 
void set_active_fe_indices (const std::vector< unsigned int > &active_fe_indices)
 
void get_active_fe_indices (std::vector< unsigned int > &active_fe_indices) const
 
void distribute_dofs (const FiniteElement< dim, spacedim > &fe)
 
void distribute_dofs (const hp::FECollection< dim, spacedim > &fe)
 
void distribute_mg_dofs ()
 
bool has_level_dofs () const
 
bool has_active_dofs () const
 
void initialize_local_block_info ()
 
void clear ()
 
void renumber_dofs (const std::vector< types::global_dof_index > &new_numbers)
 
void renumber_dofs (const unsigned int level, const std::vector< types::global_dof_index > &new_numbers)
 
unsigned int max_couplings_between_dofs () const
 
unsigned int max_couplings_between_boundary_dofs () const
 
Cell iterator functions
cell_iterator begin (const unsigned int level=0) const
 
active_cell_iterator begin_active (const unsigned int level=0) const
 
cell_iterator end () const
 
cell_iterator end (const unsigned int level) const
 
active_cell_iterator end_active (const unsigned int level) const
 
level_cell_iterator begin_mg (const unsigned int level=0) const
 
level_cell_iterator end_mg (const unsigned int level) const
 
level_cell_iterator end_mg () const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const
 
unsigned int n_subscriptions () const
 
template<typename StreamType >
void list_subscribers (StreamType &stream) const
 
void list_subscribers () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 

Public Attributes

const bool hp_capability_enabled
 

Static Public Attributes

static const unsigned int dimension = dim
 
static const unsigned int space_dimension = spacedim
 
static const unsigned int default_fe_index = 0
 
static const unsigned int invalid_fe_index = numbers::invalid_unsigned_int
 
static const active_fe_index_type invalid_active_fe_index
 

Private Types

using ActiveSelector = ::internal::DoFHandlerImplementation::Iterators< dim, spacedim, false >
 
using LevelSelector = ::internal::DoFHandlerImplementation::Iterators< dim, spacedim, true >
 

Cell iterator functions returning ranges of iterators

BlockInfo block_info_object
 
SmartPointer< const Triangulation< dim, spacedim >, DoFHandler< dim, spacedim > > tria
 
hp::FECollection< dim, spacedim > fe_collection
 
std::unique_ptr<::internal::DoFHandlerImplementation::Policy::PolicyBase< dim, spacedim > > policy
 
::internal::DoFHandlerImplementation::NumberCache number_cache
 
std::vector<::internal::DoFHandlerImplementation::NumberCachemg_number_cache
 
std::vector< std::vector< types::global_dof_index > > cell_dof_cache_indices
 
std::vector< std::vector< offset_type > > cell_dof_cache_ptr
 
std::vector< std::array< std::vector< types::global_dof_index >, dim+1 > > object_dof_indices
 
std::vector< std::array< std::vector< offset_type >, dim+1 > > object_dof_ptr
 
std::array< std::vector< active_fe_index_type >, dim+1 > hp_object_fe_indices
 
std::array< std::vector< offset_type >, dim+1 > hp_object_fe_ptr
 
std::vector< std::vector< active_fe_index_type > > hp_cell_active_fe_indices
 
std::vector< std::vector< active_fe_index_type > > hp_cell_future_fe_indices
 
std::vector< MGVertexDoFsmg_vertex_dofs
 
std::vector< std::unique_ptr<::internal::DoFHandlerImplementation::DoFLevel< dim > > > mg_levels
 
std::unique_ptr<::internal::DoFHandlerImplementation::DoFFaces< dim > > mg_faces
 
std::unique_ptr< ActiveFEIndexTransferactive_fe_index_transfer
 
std::vector< boost::signals2::connection > tria_listeners
 
template<int , int , int , bool >
class ::DoFAccessor
 
template<int , int , bool >
class ::DoFCellAccessor
 
struct ::internal::DoFAccessorImplementation::Implementation
 
struct ::internal::DoFCellAccessorImplementation::Implementation
 
struct ::internal::DoFHandlerImplementation::Implementation
 
struct ::internal::hp::DoFHandlerImplementation::Implementation
 
struct ::internal::DoFHandlerImplementation::Policy::Implementation
 
IteratorRange< cell_iteratorcell_iterators () const
 
IteratorRange< active_cell_iteratoractive_cell_iterators () const
 
IteratorRange< level_cell_iteratormg_cell_iterators () const
 
IteratorRange< cell_iteratorcell_iterators_on_level (const unsigned int level) const
 
IteratorRange< active_cell_iteratoractive_cell_iterators_on_level (const unsigned int level) const
 
IteratorRange< level_cell_iteratormg_cell_iterators_on_level (const unsigned int level) const
 
types::global_dof_index n_dofs () const
 
types::global_dof_index n_dofs (const unsigned int level) const
 
types::global_dof_index n_boundary_dofs () const
 
template<typename number >
types::global_dof_index n_boundary_dofs (const std::map< types::boundary_id, const Function< spacedim, number > *> &boundary_ids) const
 
types::global_dof_index n_boundary_dofs (const std::set< types::boundary_id > &boundary_ids) const
 
const BlockInfoblock_info () const
 
types::global_dof_index n_locally_owned_dofs () const
 
const IndexSetlocally_owned_dofs () const
 
const IndexSetlocally_owned_mg_dofs (const unsigned int level) const
 
const std::vector< IndexSet > & locally_owned_dofs_per_processor () const
 
const std::vector< types::global_dof_index > & n_locally_owned_dofs_per_processor () const
 
const std::vector< IndexSet > & locally_owned_mg_dofs_per_processor (const unsigned int level) const
 
const FiniteElement< dim, spacedim > & get_fe (const unsigned int index=0) const
 
const hp::FECollection< dim, spacedim > & get_fe_collection () const
 
const Triangulation< dim, spacedim > & get_triangulation () const
 
void prepare_for_serialization_of_active_fe_indices ()
 
void deserialize_active_fe_indices ()
 
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)
 
template<class Archive >
void serialize (Archive &archive, const unsigned int version)
 
static ::ExceptionBaseExcNoFESelected ()
 
static ::ExceptionBaseExcInvalidBoundaryIndicator ()
 
static ::ExceptionBaseExcInvalidLevel (int arg1)
 
static ::ExceptionBaseExcNewNumbersNotConsecutive (types::global_dof_index arg1)
 
static ::ExceptionBaseExcInvalidFEIndex (int arg1, int arg2)
 
static ::ExceptionBaseExcNotAvailableWithoutHP ()
 
static ::ExceptionBaseExcNotImplementedWithHP ()
 
void clear_space ()
 
void clear_mg_space ()
 
template<int structdim>
types::global_dof_index get_dof_index (const unsigned int obj_level, const unsigned int obj_index, const unsigned int fe_index, const unsigned int local_index) const
 
template<int structdim>
void set_dof_index (const unsigned int obj_level, const unsigned int obj_index, const unsigned int fe_index, const unsigned int local_index, const types::global_dof_index global_index) const
 
void setup_policy ()
 
void setup_policy_and_listeners ()
 
void create_active_fe_table ()
 
void pre_refinement_action ()
 
void post_refinement_action ()
 
void pre_active_fe_index_transfer ()
 
void pre_distributed_active_fe_index_transfer ()
 
void post_active_fe_index_transfer ()
 
void post_distributed_active_fe_index_transfer ()
 
void post_distributed_serialization_of_active_fe_indices ()
 

Additional Inherited Members

- Static Public Member Functions inherited from Subscriptor
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Detailed Description

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

Given a triangulation and a description of a finite element, this class enumerates degrees of freedom on all vertices, edges, faces, and cells of the triangulation. As a result, it also provides a basis for a discrete space \(V_h\) whose elements are finite element functions defined on each cell by a FiniteElement object. This class satisfies the MeshType concept requirements.

It is first used in the step-2 tutorial program.

For each vertex, line, quad, etc, this class stores 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::DoFHandlerImplementation::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 companions, like begin_active()), 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 compared to pure triangulation iterators. The order in which dof iterators are presented by the ++ and -- operators is the same as that for the corresponding iterators traversing the triangulation on which this DoFHandler is constructed.

The spacedim parameter has to be used if one wants to solve problems on surfaces. If not specified, this parameter takes the default value =dim implying that we want to solve problems in a domain whose dimension equals the dimension of the space in which it is embedded.

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 bandwidths 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-McKee 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 their 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<types::global_dof_index>) 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.

Definition at line 219 of file dof_handler.h.

Member Typedef Documentation

◆ ActiveSelector

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::ActiveSelector = ::internal::DoFHandlerImplementation::Iterators<dim, spacedim, false>
private

Definition at line 222 of file dof_handler.h.

◆ LevelSelector

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::LevelSelector = ::internal::DoFHandlerImplementation::Iterators<dim, spacedim, true>
private

Definition at line 224 of file dof_handler.h.

◆ level_cell_accessor

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::level_cell_accessor = typename LevelSelector::CellAccessor

Definition at line 404 of file dof_handler.h.

◆ level_face_accessor

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::level_face_accessor = typename LevelSelector::FaceAccessor

Definition at line 405 of file dof_handler.h.

◆ level_cell_iterator

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::level_cell_iterator = typename LevelSelector::cell_iterator

Definition at line 407 of file dof_handler.h.

◆ level_face_iterator

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::level_face_iterator = typename LevelSelector::face_iterator

Definition at line 408 of file dof_handler.h.

◆ active_fe_index_type

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::active_fe_index_type = unsigned short int

The type in which we store the active FE index.

Definition at line 440 of file dof_handler.h.

◆ offset_type

template<int dim, int spacedim = dim>
using DoFHandler< dim, spacedim >::offset_type = unsigned int

The type in which we store the offsets in the CRS data structures.

Definition at line 445 of file dof_handler.h.

Constructor & Destructor Documentation

◆ DoFHandler() [1/3]

template<int dim, int spacedim>
DoFHandler< dim, spacedim >::DoFHandler ( const bool  hp_capability_enabled = false)

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

Definition at line 1951 of file dof_handler.cc.

◆ DoFHandler() [2/3]

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

Constructor. Take tria as the triangulation to work on.

Definition at line 1960 of file dof_handler.cc.

◆ DoFHandler() [3/3]

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

Copy constructor. DoFHandler objects are large and expensive. They should not be copied, in particular not by accident, but rather deliberately constructed. As a consequence, this constructor is explicitly removed from the interface of this class.

◆ ~DoFHandler()

template<int dim, int spacedim>
DoFHandler< dim, spacedim >::~DoFHandler ( )
overridevirtual

Destructor.

Definition at line 1978 of file dof_handler.cc.

Member Function Documentation

◆ operator=()

template<int dim, int spacedim = dim>
DoFHandler& DoFHandler< dim, spacedim >::operator= ( const DoFHandler< dim, spacedim > &  )
delete

Copy operator. DoFHandler objects are large and expensive. They should not be copied, in particular not by accident, but rather deliberately constructed. As a consequence, this operator is explicitly removed from the interface of this class.

◆ initialize() [1/2]

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

Definition at line 2013 of file dof_handler.cc.

◆ initialize() [2/2]

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::initialize ( const Triangulation< dim, spacedim > &  tria,
const hp::FECollection< dim, spacedim > &  fe 
)

Same as above but taking an hp::FECollection object.

Definition at line 2023 of file dof_handler.cc.

◆ set_fe() [1/2]

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::set_fe ( const FiniteElement< dim, spacedim > &  fe)

Assign a FiniteElement fe to this object.

Note
This function makes a copy of the finite element given as argument, and stores it as a member variable. Consequently, it is possible to write code such as
dof_handler.set_fe(FE_Q<dim>(2));
You can then access the finite element later on by calling DoFHandler::get_fe(). However, it is often more convenient to keep a named finite element object as a member variable in your main class and refer to it directly whenever you need to access properties of the finite element (such as FiniteElementData::dofs_per_cell). This is what all tutorial programs do.
Warning
This function only sets a FiniteElement. Degrees of freedom have either not been distributed yet, or are distributed using a previously set element. In both cases, accessing degrees of freedom will lead to invalid results. To restore consistency, call distribute_dofs().

Definition at line 2382 of file dof_handler.cc.

◆ set_fe() [2/2]

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::set_fe ( const hp::FECollection< dim, spacedim > &  fe)

Same as above but taking an hp::FECollection object.

Definition at line 2391 of file dof_handler.cc.

◆ set_active_fe_indices()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::set_active_fe_indices ( const std::vector< unsigned int > &  active_fe_indices)

Go through the triangulation and set the active FE indices of all active cells to the values given in active_fe_indices.

Definition at line 2942 of file dof_handler.cc.

◆ get_active_fe_indices()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::get_active_fe_indices ( std::vector< unsigned int > &  active_fe_indices) const

Go through the triangulation and store the active FE indices of all active cells to the vector active_fe_indices. This vector is resized, if necessary.

Definition at line 2963 of file dof_handler.cc.

◆ distribute_dofs() [1/2]

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::distribute_dofs ( const FiniteElement< dim, spacedim > &  fe)

Go through the triangulation and "distribute" the degrees of freedom needed for the given finite element. "Distributing" degrees of freedom involves allocating memory to store the indices on all entities on which degrees of freedom can be located (e.g., vertices, edges, faces, etc.) and to then enumerate all degrees of freedom. In other words, while the mesh and the finite element object by themselves simply define a finite element space \(V_h\), the process of distributing degrees of freedom makes sure that there is a basis for this space and that the shape functions of this basis are enumerated in an indexable, predictable way.

The exact order in which degrees of freedom on a mesh are ordered, i.e., the order in which basis functions of the finite element space are enumerated, is something that deal.II treats as an implementation detail. By and large, degrees of freedom are enumerated in the same order in which we traverse cells, but you should not rely on any specific numbering. In contrast, if you want a particular ordering, use the functions in namespace DoFRenumbering.

This function is first discussed in the introduction to the step-2 tutorial program.

Note
This function makes a copy of the finite element given as argument, and stores it as a member variable, similarly to the above function set_fe().

Definition at line 2430 of file dof_handler.cc.

◆ distribute_dofs() [2/2]

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

Same as above but taking an hp::FECollection object.

Definition at line 2440 of file dof_handler.cc.

◆ distribute_mg_dofs()

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

Distribute level degrees of freedom on each level for geometric multigrid. The active DoFs need to be distributed using distribute_dofs() before calling this function.

Definition at line 2555 of file dof_handler.cc.

◆ has_level_dofs()

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

This function returns whether this DoFHandler has DoFs distributed on each multigrid level or in other words if distribute_mg_dofs() has been called.

◆ has_active_dofs()

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

This function returns whether this DoFHandler has active DoFs. This is equivalent to asking whether (i) distribute_dofs() has been called and (ii) the finite element for which degrees of freedom have been distributed actually has degrees of freedom (which is not the case for FE_Nothing, for example).

If this object is based on a parallel::distributed::Triangulation, then the current function returns true if any partition of the parallel DoFHandler object has any degrees of freedom. In other words, the function returns true even if the Triangulation does not own any active cells on the current MPI process, but at least one process owns cells and at least this one process has any degrees of freedom associated with it.

◆ initialize_local_block_info()

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

Definition at line 2587 of file dof_handler.cc.

◆ clear()

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

Clear all data of this object.

Definition at line 2621 of file dof_handler.cc.

◆ renumber_dofs() [1/2]

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::renumber_dofs ( const std::vector< types::global_dof_index > &  new_numbers)

Renumber degrees of freedom based on a list of new DoF indices for each of the degrees of freedom.

This function is called by the functions in DoFRenumbering function after computing a new ordering of the degree of freedom indices. However, 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::shared::Triangulation or 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.
Note
While it follows from the above, it may be surprising to know that the number of locally owned degrees of freedom in a parallel computation is an invariant under renumbering, even if the indices associated with these locally owned degrees of freedom are not. At a fundamental level, this invariant exists because the decision whether a degree of freedom is locally owned or not has nothing to do with that degree of freedom's (old or new) index. Indeed, degrees of freedom are locally owned if they are on a locally owned cell and not on an interface between cells where the neighboring cell has a lower subdomain id. Since both of these conditions are independent of the index associated with the DoF, a locally owned degree of freedom will also be locally owned after renumbering. On the other hand, properties such as whether the set of indices of locally owned DoFs forms a contiguous range or not (i.e., whether the locally_owned_dofs() returns an IndexSet object for which IndexSet::is_contiguous() returns true) are of course affected by the exact renumbering performed here. For example, while the initial numbering of DoF indices done in distribute_dofs() yields a contiguous numbering, the renumbering performed by DoFRenumbering::component_wise() will, in general, not yield contiguous locally owned DoF indices.

Definition at line 2683 of file dof_handler.cc.

◆ renumber_dofs() [2/2]

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::renumber_dofs ( const unsigned int  level,
const std::vector< types::global_dof_index > &  new_numbers 
)

The same function as above, but renumber the degrees of freedom of a single level of a multigrid hierarchy.

Definition at line 2795 of file dof_handler.cc.

◆ max_couplings_between_dofs()

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

Definition at line 2872 of file dof_handler.cc.

◆ max_couplings_between_boundary_dofs()

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

Note
The same applies to this function as to max_couplings_per_dofs() as regards the performance of this function. Think about one of the dynamic sparsity pattern classes instead (see Sparsity patterns).

Definition at line 2838 of file dof_handler.cc.

◆ begin()

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

Iterator to the first used cell on level level.

Definition at line 2063 of file dof_handler.cc.

◆ begin_active()

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

Iterator to the first active cell on level level. If the given level does not contain any active cells (i.e., all cells on this level are further refined), then this function returns end_active(level) so that loops of the kind

for (cell=dof_handler.begin_active(level);
cell!=dof_handler.end_active(level);
++cell)
{
...
}

have zero iterations, as may be expected if there are no active cells on this level.

Definition at line 2076 of file dof_handler.cc.

◆ end() [1/2]

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

Definition at line 2092 of file dof_handler.cc.

◆ end() [2/2]

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

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

Definition at line 2101 of file dof_handler.cc.

◆ end_active()

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

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

Definition at line 2114 of file dof_handler.cc.

◆ begin_mg()

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

Iterator to the first used cell on level level. This returns a level_cell_iterator that returns level dofs when dof_indices() is called.

Definition at line 2127 of file dof_handler.cc.

◆ end_mg() [1/2]

template<int dim, int spacedim>
DoFHandler< dim, spacedim >::level_cell_iterator DoFHandler< dim, spacedim >::end_mg ( const unsigned int  level) const

Iterator past the last cell on level level. This returns a level_cell_iterator that returns level dofs when dof_indices() is called.

Definition at line 2143 of file dof_handler.cc.

◆ end_mg() [2/2]

template<int dim, int spacedim>
DoFHandler< dim, spacedim >::level_cell_iterator DoFHandler< dim, spacedim >::end_mg ( ) const

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

Definition at line 2159 of file dof_handler.cc.

◆ n_dofs() [1/2]

template<int dim, int spacedim = dim>
types::global_dof_index 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.

Mathematically speaking, the number returned by this function equals the dimension of the finite element space (without taking into account constraints) that corresponds to (i) the mesh on which it is defined, and (ii) the finite element that is used by the current object. It also, of course, equals the number of shape functions that span this space.

◆ n_dofs() [2/2]

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

The (global) number of multilevel degrees of freedom on a given level.

If no level degrees of freedom have been assigned to this level, returns numbers::invalid_dof_index. Else returns the number of degrees of freedom on this level.

◆ n_boundary_dofs() [1/3]

template<int dim, int spacedim>
types::global_dof_index DoFHandler< dim, spacedim >::n_boundary_dofs ( ) const

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

Definition at line 2237 of file dof_handler.cc.

◆ n_boundary_dofs() [2/3]

template<int dim, int spacedim = dim>
template<typename number >
types::global_dof_index DoFHandler< dim, spacedim >::n_boundary_dofs ( const std::map< types::boundary_id, const Function< spacedim, number > *> &  boundary_ids) const

Return the number of locally owned 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 described in the documentation of that variant of DoFTools::make_boundary_sparsity_pattern() that takes a map.

There is, however, another overload of this function that takes a set argument (see below).

◆ n_boundary_dofs() [3/3]

template<int dim, int spacedim>
types::global_dof_index DoFHandler< dim, spacedim >::n_boundary_dofs ( const std::set< types::boundary_id > &  boundary_ids) 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

Definition at line 2285 of file dof_handler.cc.

◆ block_info()

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. If you have previously called distribute_mg_dofs(), the same is done on each level of the multigrid hierarchy. Additionally, the block structure on each cell can be generated in this object by calling initialize_local_block_info().

◆ n_locally_owned_dofs()

template<int dim, int spacedim = dim>
types::global_dof_index 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 DoFHandler, then the result equals that produced by n_dofs(). (Here, "sequential" means that either the whole program does not use MPI, or that it uses MPI but only uses a single MPI process, or that there are multiple MPI processes but the Triangulation on which this DoFHandler builds works only on one MPI process.) On the other hand, if we are operating on a parallel::distributed::Triangulation or parallel::shared::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.

◆ locally_owned_dofs()

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().

◆ locally_owned_mg_dofs()

template<int dim, int spacedim = dim>
const IndexSet& DoFHandler< dim, spacedim >::locally_owned_mg_dofs ( const unsigned int  level) const

Return an IndexSet describing the set of locally owned DoFs used for the given multigrid level as a subset of 0..n_dofs(level).

◆ locally_owned_dofs_per_processor()

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

Return a vector that stores the locally owned DoFs of each processor.

◆ n_locally_owned_dofs_per_processor()

template<int dim, int spacedim = dim>
const std::vector<types::global_dof_index>& 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.

◆ locally_owned_mg_dofs_per_processor()

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

Return a vector that stores the locally owned DoFs of each processor on the given level level.

◆ get_fe()

template<int dim, int spacedim = dim>
const FiniteElement<dim, spacedim>& DoFHandler< dim, spacedim >::get_fe ( const unsigned int  index = 0) const

Return a constant reference to the selected finite element object. Since there is only one FiniteElement index must be equal to zero which is also the default value.

◆ get_fe_collection()

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

Return a constant reference to the set of finite element objects that are used by this DoFHandler. Since this object only contains one FiniteElement, only this one object is returned wrapped in a hp::FECollection.

◆ get_triangulation()

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

Return a constant reference to the triangulation underlying this object.

◆ prepare_for_serialization_of_active_fe_indices()

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

Whenever serialization with a parallel::distributed::Triangulation as the underlying triangulation is considered, we also need to consider storing the active_fe_indices on all active cells as well.

This function registers that these indices are to be stored whenever the parallel::distributed::Triangulation::save() function is called on the underlying triangulation.

Note
Currently only implemented for triangulations of type parallel::distributed::Triangulation. An assertion will be triggered if a different type is registered.
See also
The documentation of parallel::distributed::SolutionTransfer has further information on serialization.

Definition at line 3335 of file dof_handler.cc.

◆ deserialize_active_fe_indices()

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

Whenever serialization with a parallel::distributed::Triangulation as the underlying triangulation is considered, we also need to consider storing the active_fe_indices on all active cells as well.

This function deserializes and distributes the previously stored active_fe_indices on all active cells.

Note
Currently only implemented for triangulations of type parallel::distributed::Triangulation. An assertion will be triggered if a different type is registered.
See also
The documentation of parallel::distributed::SolutionTransfer has further information on serialization.

Definition at line 3421 of file dof_handler.cc.

◆ memory_consumption()

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

Definition at line 2336 of file dof_handler.cc.

◆ save()

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.

◆ load()

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.

◆ serialize()

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

Write and read the data of this object from a stream for the purpose of serialization.

◆ clear_space()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::clear_space ( )
private

Free all memory used for non-multigrid data structures.

Definition at line 2640 of file dof_handler.cc.

◆ clear_mg_space()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::clear_mg_space ( )
private

Free all memory used for multigrid data structures.

Definition at line 2667 of file dof_handler.cc.

◆ get_dof_index()

template<int dim, int spacedim>
template<int structdim>
types::global_dof_index DoFHandler< dim, spacedim >::get_dof_index ( const unsigned int  obj_level,
const unsigned int  obj_index,
const unsigned int  fe_index,
const unsigned int  local_index 
) const
private

Return dof index of specified object.

Definition at line 2884 of file dof_handler.cc.

◆ set_dof_index()

template<int dim, int spacedim>
template<int structdim>
void DoFHandler< dim, spacedim >::set_dof_index ( const unsigned int  obj_level,
const unsigned int  obj_index,
const unsigned int  fe_index,
const unsigned int  local_index,
const types::global_dof_index  global_index 
) const
private

Return dof index of specified object.

Definition at line 2912 of file dof_handler.cc.

◆ setup_policy()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::setup_policy ( )
private

Setup DoFHandler policy.

Definition at line 2598 of file dof_handler.cc.

◆ setup_policy_and_listeners()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::setup_policy_and_listeners ( )
private

Setup DoFHandler policy and listeners (in the hp-context).

Definition at line 2980 of file dof_handler.cc.

◆ create_active_fe_table()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::create_active_fe_table ( )
private

Create default tables for the active_fe_indices. They are initialized with a zero indicator, meaning that fe[0] is going to be used by default. This method is called before refinement and while setting the finite elements via set_fe(). It ensures each cell has a valid active_fe_index.

Definition at line 3069 of file dof_handler.cc.

◆ pre_refinement_action()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::pre_refinement_action ( )
private

A function that will be triggered through a triangulation signal just before the triangulation is modified.

The function that stores the active_fe_flags of all cells that will be refined or coarsened before the refinement happens, so that they can be set again after refinement.

Definition at line 3123 of file dof_handler.cc.

◆ post_refinement_action()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::post_refinement_action ( )
private

A function that will be triggered through a triangulation signal just after the triangulation is modified.

The function that restores the active_fe_flags of all cells that were refined.

Definition at line 3132 of file dof_handler.cc.

◆ pre_active_fe_index_transfer()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::pre_active_fe_index_transfer ( )
private

A function that will be triggered through a triangulation signal just before the associated Triangulation or parallel::shared::Triangulation is modified.

The function that stores the active_fe_indices of all cells that will be refined or coarsened before the refinement happens, so that they can be set again after refinement.

Definition at line 3180 of file dof_handler.cc.

◆ pre_distributed_active_fe_index_transfer()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::pre_distributed_active_fe_index_transfer ( )
private

A function that will be triggered through a triangulation signal just before the associated parallel::distributed::Triangulation is modified.

The function that stores all active_fe_indices on locally owned cells for distribution over all participating processors.

Definition at line 3200 of file dof_handler.cc.

◆ post_active_fe_index_transfer()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::post_active_fe_index_transfer ( )
private

A function that will be triggered through a triangulation signal just after the associated Triangulation or parallel::shared::Triangulation is modified.

The function that restores the active_fe_indices of all cells that were refined or coarsened.

Definition at line 3273 of file dof_handler.cc.

◆ post_distributed_active_fe_index_transfer()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::post_distributed_active_fe_index_transfer ( )
private

A function that will be triggered through a triangulation signal just after the associated parallel::distributed::Triangulation is modified.

The function that restores all active_fe_indices on locally owned cells that have been communicated.

Definition at line 3299 of file dof_handler.cc.

◆ post_distributed_serialization_of_active_fe_indices()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::post_distributed_serialization_of_active_fe_indices ( )
private

A function that will be triggered through a triangulation signal just after the associated parallel::distributed::Triangulation has been saved.

The function frees all memory related to the transfer of active_fe_indices.

Definition at line 3398 of file dof_handler.cc.

Friends And Related Function Documentation

◆ ::DoFAccessor

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

Definition at line 1673 of file dof_handler.h.

◆ ::DoFCellAccessor

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

Definition at line 1675 of file dof_handler.h.

◆ ::internal::DoFAccessorImplementation::Implementation

template<int dim, int spacedim = dim>
friend struct ::internal::DoFAccessorImplementation::Implementation
friend

Definition at line 1676 of file dof_handler.h.

◆ ::internal::DoFCellAccessorImplementation::Implementation

template<int dim, int spacedim = dim>
friend struct ::internal::DoFCellAccessorImplementation::Implementation
friend

Definition at line 1677 of file dof_handler.h.

◆ ::internal::DoFHandlerImplementation::Implementation

template<int dim, int spacedim = dim>
friend struct ::internal::DoFHandlerImplementation::Implementation
friend

Definition at line 1681 of file dof_handler.h.

◆ ::internal::hp::DoFHandlerImplementation::Implementation

template<int dim, int spacedim = dim>
friend struct ::internal::hp::DoFHandlerImplementation::Implementation
friend

Definition at line 1682 of file dof_handler.h.

◆ ::internal::DoFHandlerImplementation::Policy::Implementation

template<int dim, int spacedim = dim>
friend struct ::internal::DoFHandlerImplementation::Policy:: Implementation
friend

Definition at line 1684 of file dof_handler.h.

Member Data Documentation

◆ dimension

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

Make the dimension available in function templates.

Definition at line 414 of file dof_handler.h.

◆ space_dimension

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

Make the space dimension available in function templates.

Definition at line 419 of file dof_handler.h.

◆ hp_capability_enabled

template<int dim, int spacedim = dim>
const bool DoFHandler< dim, spacedim >::hp_capability_enabled

Boolean indicating whether or not the current DoFHander has hp capabilities.

Definition at line 425 of file dof_handler.h.

◆ default_fe_index

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.

Definition at line 430 of file dof_handler.h.

◆ invalid_fe_index

template<int dim, int spacedim = dim>
const unsigned int DoFHandler< dim, spacedim >::invalid_fe_index = numbers::invalid_unsigned_int
static

Invalid index of the finite element to be used on a given cell.

Definition at line 435 of file dof_handler.h.

◆ invalid_active_fe_index

template<int dim, int spacedim = dim>
const DoFHandler< dim, spacedim >::active_fe_index_type DoFHandler< dim, spacedim >::invalid_active_fe_index
static
Initial value:
=
static_cast<active_fe_index_type>(-1)

Invalid active_fe_index which will be used as a default value to determine whether a future_fe_index has been set or not.

Definition at line 451 of file dof_handler.h.

◆ block_info_object

template<int dim, int spacedim = dim>
BlockInfo DoFHandler< dim, spacedim >::block_info_object
private

An object containing information on the block structure.

Definition at line 1409 of file dof_handler.h.

◆ tria

template<int dim, int spacedim = dim>
SmartPointer<const Triangulation<dim, spacedim>, DoFHandler<dim, spacedim> > DoFHandler< dim, spacedim >::tria
private

Address of the triangulation to work on.

Definition at line 1415 of file dof_handler.h.

◆ fe_collection

template<int dim, int spacedim = dim>
hp::FECollection<dim, spacedim> DoFHandler< dim, spacedim >::fe_collection
private

Store a hp::FECollection object. If only a single FiniteElement is used during initialization of this object, it contains the (one) FiniteElement.

Definition at line 1422 of file dof_handler.h.

◆ policy

template<int dim, int spacedim = dim>
std::unique_ptr<::internal::DoFHandlerImplementation::Policy:: PolicyBase<dim, spacedim> > DoFHandler< dim, spacedim >::policy
private

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

Definition at line 1430 of file dof_handler.h.

◆ number_cache

template<int dim, int spacedim = dim>
::internal::DoFHandlerImplementation::NumberCache DoFHandler< dim, spacedim >::number_cache
private

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 1439 of file dof_handler.h.

◆ mg_number_cache

template<int dim, int spacedim = dim>
std::vector<::internal::DoFHandlerImplementation::NumberCache> DoFHandler< dim, spacedim >::mg_number_cache
private

Data structure like number_cache, but for each multigrid level.

Definition at line 1445 of file dof_handler.h.

◆ cell_dof_cache_indices

template<int dim, int spacedim = dim>
std::vector<std::vector<types::global_dof_index> > DoFHandler< dim, spacedim >::cell_dof_cache_indices
mutableprivate

Cached indices of the degrees of freedom of all active cell. Identification of the appropriate position of a cell in the vectors is done via cell_dof_cache_ptr (CRS scheme).

Definition at line 1453 of file dof_handler.h.

◆ cell_dof_cache_ptr

template<int dim, int spacedim = dim>
std::vector<std::vector<offset_type> > DoFHandler< dim, spacedim >::cell_dof_cache_ptr
mutableprivate

Pointer to the first cached degree of freedom of an active cell (identified by level and level index) within cell_dof_cache_indices.

Definition at line 1459 of file dof_handler.h.

◆ object_dof_indices

template<int dim, int spacedim = dim>
std::vector<std::array<std::vector<types::global_dof_index>, dim + 1> > DoFHandler< dim, spacedim >::object_dof_indices
mutableprivate

Indices of degree of freedom of each d+1 geometric object (3D: vertex, line, quad, hex) for all relevant active finite elements. Identification of the appropriate position is done via object_dof_ptr (CRS scheme).

Definition at line 1467 of file dof_handler.h.

◆ object_dof_ptr

template<int dim, int spacedim = dim>
std::vector<std::array<std::vector<offset_type>, dim + 1> > DoFHandler< dim, spacedim >::object_dof_ptr
mutableprivate

Pointer to the first cached degree of freedom of a geometric object for all relevant active finite elements.

Note
In normal mode it is possible to access this data strucutre directly. In hp mode, an indirection via hp_object_fe_indices/hp_object_fe_ptr is necessary.

Definition at line 1478 of file dof_handler.h.

◆ hp_object_fe_indices

template<int dim, int spacedim = dim>
std::array<std::vector<active_fe_index_type>, dim + 1> DoFHandler< dim, spacedim >::hp_object_fe_indices
mutableprivate

Active fe indices of each geometric object. Identification of the appropriate position of a cell in the vectors is done via hp_object_fe_ptr (CRS scheme).

Definition at line 1486 of file dof_handler.h.

◆ hp_object_fe_ptr

template<int dim, int spacedim = dim>
std::array<std::vector<offset_type>, dim + 1> DoFHandler< dim, spacedim >::hp_object_fe_ptr
mutableprivate

Pointer to the first fe index of a geometric object.

Definition at line 1491 of file dof_handler.h.

◆ hp_cell_active_fe_indices

template<int dim, int spacedim = dim>
std::vector<std::vector<active_fe_index_type> > DoFHandler< dim, spacedim >::hp_cell_active_fe_indices
mutableprivate

Active fe index of an active cell (identified by level and level index). This vector is only used in hp mode.

Definition at line 1498 of file dof_handler.h.

◆ hp_cell_future_fe_indices

template<int dim, int spacedim = dim>
std::vector<std::vector<active_fe_index_type> > DoFHandler< dim, spacedim >::hp_cell_future_fe_indices
mutableprivate

Future fe index of an active cell (identified by level and level index). This vector is only used in hp mode.

Definition at line 1505 of file dof_handler.h.

◆ mg_vertex_dofs

template<int dim, int spacedim = dim>
std::vector<MGVertexDoFs> DoFHandler< dim, spacedim >::mg_vertex_dofs
private

An array to store the indices for level degrees of freedom located at vertices.

Definition at line 1511 of file dof_handler.h.

◆ mg_levels

template<int dim, int spacedim = dim>
std::vector< std::unique_ptr<::internal::DoFHandlerImplementation::DoFLevel<dim> > > DoFHandler< dim, spacedim >::mg_levels
private

Space to store the DoF numbers for the different multigrid levels.

Definition at line 1518 of file dof_handler.h.

◆ mg_faces

template<int dim, int spacedim = dim>
std::unique_ptr<::internal::DoFHandlerImplementation::DoFFaces<dim> > DoFHandler< dim, spacedim >::mg_faces
private

Space to store DoF numbers of faces in the multigrid context.

Definition at line 1524 of file dof_handler.h.

◆ active_fe_index_transfer

template<int dim, int spacedim = dim>
std::unique_ptr<ActiveFEIndexTransfer> DoFHandler< dim, spacedim >::active_fe_index_transfer
private

We embed our data structure into a pointer to control that all transfer related data only exists during the actual transfer process.

Definition at line 1530 of file dof_handler.h.

◆ tria_listeners

template<int dim, int spacedim = dim>
std::vector<boost::signals2::connection> DoFHandler< dim, spacedim >::tria_listeners
private

A list of connections with which this object connects to the triangulation to get information about when the triangulation changes.

Definition at line 1536 of file dof_handler.h.


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