Reference documentation for deal.II version Git 11de1224af 2020-11-24 16:17:24 -0500
\(\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\}}\)
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
hp::DoFHandler< dim, spacedim > Class Template Reference

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

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

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

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 reinit (const Triangulation< dim, spacedim > &tria)
 
void distribute_dofs (const FiniteElement< dim, spacedim > &fe)
 
void distribute_dofs (const hp::FECollection< dim, spacedim > &fe)
 
void distribute_mg_dofs ()
 
bool has_hp_capabilities () const
 
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
 
Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 

Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

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
 

Cell iterator functions returning ranges of iterators

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

Detailed Description

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

Manage the distribution and numbering of the degrees of freedom for hp- FEM algorithms. This class satisfies the MeshType concept requirements.

The purpose of this class is to allow for an enumeration of degrees of freedom in the same way as the DoFHandler class, but it allows to use a different finite element on every cell. To this end, one assigns an active_fe_index to every cell that indicates which element within a collection of finite elements (represented by an object of type hp::FECollection) is the one that lives on this cell. The class then enumerates the degree of freedom associated with these finite elements on each cell of a triangulation and, if possible, identifies degrees of freedom at the interfaces of cells if they match. If neighboring cells have degrees of freedom along the common interface that do not immediate match (for example, if you have \(Q_2\) and \(Q_3\) elements meeting at a common face), then one needs to compute constraints to ensure that the resulting finite element space on the mesh remains conforming.

The whole process of working with objects of this type is explained in step-27. Many of the algorithms this class implements are described in the hp paper.

Active FE indices and their behavior under mesh refinement

The typical workflow for using this class is to create a mesh, assign an active FE index to every active cell, calls hp::DoFHandler::distribute_dofs(), and then assemble a linear system and solve a problem on this finite element space. However, one can skip assigning active FE indices upon mesh refinement in certain circumstances. In particular, the following rules apply:

Note
Finite elements need to be assigned to each cell by either calling set_fe() or distribute_dofs() first to make this functionality available.

Active FE indices and parallel meshes

When this class is used with either a parallel::shared::Triangulation or a parallel::distributed::Triangulation, you can only set active FE indices on cells that are locally owned, using a call such as cell->set_active_fe_index(...). On the other hand, setting the active FE index on ghost or artificial cells is not allowed.

Ghost cells do acquire the information what element is active on them, however: whenever you call hp::DoFHandler::distribute_dofs(), all processors that participate in the parallel mesh exchange information in such a way that the active FE index on ghost cells equals the active FE index that was set on that processor that owned that particular ghost cell. Consequently, one can query the active_fe_index on ghost cells, just not set it by hand.

On artificial cells, no information is available about the active_fe_index used there. That's because we don't even know whether these cells exist at all, and even if they did, the current processor does not know anything specific about them. See the glossary entry on artificial cells for more information.

During refinement and coarsening, information about the active_fe_index of each cell will be automatically transferred.

However, using a parallel::distributed::Triangulation with an hp::DoFHandler requires additional attention during serialization, since no information on active FE indices will be automatically transferred. This has to be done manually using the prepare_for_serialization_of_active_fe_indices() and deserialize_active_fe_indices() functions. The former has to be called before parallel::distributed::Triangulation::save() is invoked, and the latter needs to be run after parallel::distributed::Triangulation::load(). If further data will be attached to the triangulation via the parallel::distributed::CellDataTransfer, parallel::distributed::SolutionTransfer, or Particles::ParticleHandler classes, all corresponding preparation and deserialization function calls need to happen in the same order. Consult the documentation of parallel::distributed::SolutionTransfer for more information.

Deprecated:
The basic DoFHandler is capable of hp-adaptation now.

Definition at line 125 of file dof_handler.h.

Member Typedef Documentation

◆ level_cell_accessor

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

Definition at line 499 of file dof_handler.h.

◆ level_face_accessor

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

Definition at line 500 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
inherited

Definition at line 502 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
inherited

Definition at line 503 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
inherited

The type in which we store the active FE index.

Definition at line 529 of file dof_handler.h.

◆ offset_type

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

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

Definition at line 534 of file dof_handler.h.

Member Function Documentation

◆ initialize() [1/2]

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

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

Deprecated:
Use reinit() and distribute_dofs() instead.

Definition at line 2043 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 
)
inherited

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

Deprecated:
Use reinit() and distribute_dofs() instead.

Definition at line 2053 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)
inherited

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().
Deprecated:
Use distribute_dofs() instead.

Definition at line 2418 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)
inherited

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

Deprecated:
Use distribute_dofs() instead.

Definition at line 2427 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)
inherited

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 3048 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
inherited

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 3069 of file dof_handler.cc.

◆ reinit()

template<int dim, int spacedim>
void DoFHandler< dim, spacedim >::reinit ( const Triangulation< dim, spacedim > &  tria)
inherited

Assign a Triangulation to the DoFHandler.

Remove all associations with the previous Triangulation object and establish connections with the new one. All information about previous degrees of freedom will be removed. Activates hp-mode.

Definition at line 2064 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)
inherited

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 2492 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)
inherited

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

Definition at line 2502 of file dof_handler.cc.

◆ distribute_mg_dofs()

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

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 2676 of file dof_handler.cc.

◆ has_hp_capabilities()

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

Returns whether this DoFHandler has hp capabilities.

◆ has_level_dofs()

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

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
inherited

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

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 2708 of file dof_handler.cc.

◆ clear()

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

Clear all data of this object.

Definition at line 2742 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)
inherited

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 2789 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 
)
inherited

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

Definition at line 2901 of file dof_handler.cc.

◆ max_couplings_between_dofs()

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

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 2978 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
inherited

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 2944 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
inherited

Iterator to the first used cell on level level.

Definition at line 2097 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
inherited

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 2110 of file dof_handler.cc.

◆ end() [1/2]

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

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

Definition at line 2126 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
inherited

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 2135 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
inherited

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 2148 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
inherited

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 2161 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
inherited

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 2177 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
inherited

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

Definition at line 2193 of file dof_handler.cc.

◆ subscribe()

void Subscriptor::subscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

◆ unsubscribe()

void Subscriptor::unsubscribe ( std::atomic< bool > *const  validity,
const std::string &  identifier = "" 
) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

◆ list_subscribers() [1/2]

template<typename StreamType >
void Subscriptor::list_subscribers ( StreamType &  stream) const
inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

Member Data Documentation

◆ dimension

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

Make the dimension available in function templates.

Definition at line 509 of file dof_handler.h.

◆ space_dimension

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

Make the space dimension available in function templates.

Definition at line 514 of file dof_handler.h.

◆ default_fe_index

template<int dim, int spacedim = dim>
const unsigned int DoFHandler< dim, spacedim >::default_fe_index = 0
staticinherited

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

Definition at line 519 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
staticinherited

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

Definition at line 524 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
staticinherited
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 540 of file dof_handler.h.


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