15#ifndef dealii_dof_handler_h
16#define dealii_dof_handler_h
38#include <boost/serialization/split_member.hpp>
49template <
int dim,
int spacedim>
51template <
int dim,
int spacedim>
57 namespace DoFHandlerImplementation
59 struct Implementation;
63 template <
int dim,
int spacedim>
65 struct Implementation;
69 namespace DoFAccessorImplementation
71 struct Implementation;
74 namespace DoFCellAccessorImplementation
76 struct Implementation;
81 namespace DoFHandlerImplementation
83 struct Implementation;
92 template <
int dim,
int spacedim,
typename VectorType>
314template <
int dim,
int spacedim = dim>
511 static constexpr unsigned int dimension = dim;
516 static constexpr unsigned int space_dimension = spacedim;
600 std::vector<types::fe_index>
649 std::vector<types::fe_index>
815 const std::vector<types::global_dof_index> &new_numbers);
1129 template <
typename number>
1133 &boundary_ids)
const;
1228 DEAL_II_DEPRECATED_EARLY_WITH_COMMENT(
1229 "Access the MPI communicator with get_mpi_communicator() instead.")
1231 get_communicator() const;
1250 prepare_for_serialization_of_active_fe_indices();
1268 deserialize_active_fe_indices();
1279 memory_consumption() const;
1286 template <class Archive>
1288 save(Archive &ar, const
unsigned int version) const;
1295 template <class Archive>
1297 load(Archive &ar, const
unsigned int version);
1305 template <
class Archive>
1311 BOOST_SERIALIZATION_SPLIT_MEMBER()
1329 <<
"The given level " << arg1
1330 <<
" is not in the valid range!");
1337 <<
"The given list of new dof indices is not consecutive: "
1338 <<
"the index " << arg1 <<
" does not exist.");
1345 <<
"The mesh contains a cell with an active FE index of "
1346 << arg1 <<
", but the finite element collection only has "
1347 << arg2 <<
" elements");
1354 "The current function doesn't make sense when used with a "
1355 "DoFHandler without hp-capabilities.");
1362 "The current function has not yet been implemented for a "
1363 "DoFHandler with hp-capabilities.");
1386 init(
const unsigned int coarsest_level,
1387 const unsigned int finest_level,
1388 const unsigned int dofs_per_vertex);
1408 const unsigned int dof_number,
1409 const unsigned int dofs_per_vertex);
1431 std::unique_ptr<types::global_dof_index[]>
indices;
1446 std::map<const cell_iterator, const types::fe_index>
1459 std::map<const cell_iterator, const types::fe_index>
1475 parallel::distributed::
1476 CellDataTransfer<dim, spacedim, std::vector<types::fe_index>>>
1508 std::unique_ptr<::internal::DoFHandlerImplementation::Policy::
1509 PolicyBase<dim, spacedim>>
1524 std::vector<::internal::DoFHandlerImplementation::NumberCache>
1532 mutable std::vector<std::array<std::vector<types::global_dof_index>, dim + 1>>
1543 mutable std::vector<std::array<std::vector<offset_type>, dim + 1>>
1551 mutable std::array<std::vector<types::fe_index>, dim + 1>
1581 std::unique_ptr<::internal::DoFHandlerImplementation::DoFLevel<dim>>>
1587 std::unique_ptr<::internal::DoFHandlerImplementation::DoFFaces<dim>>
1709 template <
int,
int,
int,
bool>
1710 friend class ::DoFAccessor;
1711 template <
int,
int,
bool>
1712 friend class ::DoFCellAccessor;
1713 friend struct ::internal::DoFAccessorImplementation::Implementation;
1714 friend struct ::internal::DoFCellAccessorImplementation::Implementation;
1718 friend struct ::internal::DoFHandlerImplementation::Implementation;
1719 friend struct ::internal::hp::DoFHandlerImplementation::Implementation;
1720 friend struct ::internal::DoFHandlerImplementation::Policy::
1726 static_assert(dim <= spacedim,
1727 "The dimension <dim> of a DoFHandler must be less than or "
1728 "equal to the space dimension <spacedim> in which it lives.");
1736 namespace DoFHandlerImplementation
1749 template <
int dim,
int spacedim>
1777 template <
int dim,
int spacedim = dim>
1787 "No FiniteElement has been found in your FECollection that is "
1788 "dominated by all children of a cell you are trying to coarsen!");
1799template <
int dim,
int spacedim>
1803 return hp_capability_enabled;
1808template <
int dim,
int spacedim>
1812 return mg_number_cache.size() > 0;
1817template <
int dim,
int spacedim>
1821 return number_cache.n_global_dofs > 0;
1826template <
int dim,
int spacedim>
1830 return number_cache.n_global_dofs;
1835template <
int dim,
int spacedim>
1842 "n_dofs(level) can only be called after distribute_mg_dofs()"));
1844 return mg_number_cache[
level].n_global_dofs;
1849template <
int dim,
int spacedim>
1853 return number_cache.n_locally_owned_dofs;
1858template <
int dim,
int spacedim>
1862 return number_cache.locally_owned_dofs;
1867template <
int dim,
int spacedim>
1870 const unsigned int level)
const
1872 Assert(level < this->get_triangulation().n_global_levels(),
1873 ExcMessage(
"The given level index exceeds the number of levels "
1874 "present in the triangulation"));
1876 mg_number_cache.size() == this->get_triangulation().n_global_levels(),
1878 "The level dofs are not set up properly! Did you call distribute_mg_dofs()?"));
1879 return mg_number_cache[
level].locally_owned_dofs;
1884template <
int dim,
int spacedim>
1889 Assert(fe_collection.size() > 0,
1890 ExcMessage(
"No finite element collection is associated with "
1891 "this DoFHandler"));
1892 return fe_collection[number];
1897template <
int dim,
int spacedim>
1902 return fe_collection;
1907template <
int dim,
int spacedim>
1913 ExcMessage(
"This DoFHandler object has not been associated "
1914 "with a triangulation."));
1920template <
int dim,
int spacedim>
1925 ExcMessage(
"This DoFHandler object has not been associated "
1926 "with a triangulation."));
1927 return tria->get_mpi_communicator();
1932template <
int dim,
int spacedim>
1936 return get_mpi_communicator();
1941template <
int dim,
int spacedim>
1945 Assert(this->hp_capability_enabled ==
false, ExcNotImplementedWithHP());
1947 return block_info_object;
1952template <
int dim,
int spacedim>
1954template <
typename number>
1957 &boundary_ids)
const
1959 Assert(!(dim == 2 && spacedim == 3) || this->hp_capability_enabled ==
false,
1960 ExcNotImplementedWithHP());
1964 std::set<types::boundary_id> boundary_ids_only;
1967 boundary_ids.begin();
1968 p != boundary_ids.end();
1970 boundary_ids_only.insert(p->first);
1973 return n_boundary_dofs(boundary_ids_only);
1987 template <
int dim,
int spacedim>
1990 PolicyBase<dim, spacedim> &policy);
1995template <
int dim,
int spacedim>
1997template <
class Archive>
2000 if (this->hp_capability_enabled)
2002 ar &this->object_dof_indices;
2003 ar &this->object_dof_ptr;
2005 ar &this->hp_cell_active_fe_indices;
2006 ar &this->hp_cell_future_fe_indices;
2008 ar &hp_object_fe_ptr;
2009 ar &hp_object_fe_indices;
2013 ar &mg_number_cache;
2018 const unsigned int n_cells = this->tria->n_cells();
2019 std::string policy_name =
2026 ar &this->block_info_object;
2029 ar &this->object_dof_indices;
2030 ar &this->object_dof_ptr;
2035 unsigned int n_cells = this->tria->n_cells();
2036 std::string fe_name = this->get_fe(0).get_name();
2039 ar &
n_cells &fe_name &policy_name;
2045template <
int dim,
int spacedim>
2047template <
class Archive>
2050 if (this->hp_capability_enabled)
2052 ar &this->object_dof_indices;
2053 ar &this->object_dof_ptr;
2055 ar &this->hp_cell_active_fe_indices;
2056 ar &this->hp_cell_future_fe_indices;
2058 ar &hp_object_fe_ptr;
2059 ar &hp_object_fe_indices;
2063 ar &mg_number_cache;
2068 std::string policy_name;
2073 n_cells == this->tria->n_cells(),
2075 "The object being loaded into does not match the triangulation "
2076 "that has been stored previously."));
2079 ExcMessage(
"The policy currently associated with this DoFHandler (" +
2081 ") does not match the one that was associated with the "
2082 "DoFHandler previously stored (" +
2083 policy_name +
")."));
2087 ar &this->block_info_object;
2090 object_dof_indices.clear();
2092 object_dof_ptr.clear();
2094 ar &this->object_dof_indices;
2095 ar &this->object_dof_ptr;
2100 std::string fe_name;
2101 std::string policy_name;
2103 ar &
n_cells &fe_name &policy_name;
2106 n_cells == this->tria->n_cells(),
2108 "The object being loaded into does not match the triangulation "
2109 "that has been stored previously."));
2111 fe_name == this->get_fe(0).get_name(),
2113 "The finite element associated with this DoFHandler does not match "
2114 "the one that was associated with the DoFHandler previously stored."));
2117 "The policy currently associated with this DoFHandler (" +
2119 ") does not match the one that was associated with the "
2120 "DoFHandler previously stored (" +
2121 policy_name +
")."));
2127template <
int dim,
int spacedim>
2131 const unsigned int level,
2132 const unsigned int dof_number,
2133 const unsigned int dofs_per_vertex)
A small class collecting the different BlockIndices involved in global, multilevel and local computat...
unsigned int coarsest_level
types::global_dof_index & access_index(const unsigned int level, const unsigned int dof_number, const unsigned int dofs_per_vertex)
void init(const unsigned int coarsest_level, const unsigned int finest_level, const unsigned int dofs_per_vertex)
unsigned int get_finest_level() const
std::unique_ptr< types::global_dof_index[]> indices
unsigned int finest_level
unsigned int get_coarsest_level() const
cell_iterator end() const
void pre_distributed_transfer_action()
void post_transfer_action()
std::vector< types::fe_index > get_future_fe_indices() const
unsigned int max_couplings_between_dofs() const
std::vector< std::unique_ptr<::internal::DoFHandlerImplementation::DoFLevel< dim > > > mg_levels
std::unique_ptr< ActiveFEIndexTransfer > active_fe_index_transfer
hp::FECollection< dim, spacedim > fe_collection
void create_active_fe_table()
std::vector< std::vector< types::fe_index > > hp_cell_future_fe_indices
const hp::FECollection< dim, spacedim > & get_fe_collection() const
void save(Archive &ar, const unsigned int version) const
void set_active_fe_indices(const std::vector< unsigned int > &active_fe_indices)
BlockInfo block_info_object
bool has_active_dofs() const
std::vector< boost::signals2::connection > tria_listeners_for_transfer
level_cell_iterator end_mg() const
void renumber_dofs(const std::vector< types::global_dof_index > &new_numbers)
const FiniteElement< dim, spacedim > & get_fe(const types::fe_index index=0) const
const IndexSet & locally_owned_mg_dofs(const unsigned int level) const
void renumber_dofs(const unsigned int level, const std::vector< types::global_dof_index > &new_numbers)
level_cell_iterator begin_mg(const unsigned int level=0) const
void distribute_dofs(const FiniteElement< dim, spacedim > &fe)
types::global_dof_index n_boundary_dofs() const
DoFHandler(const Triangulation< dim, spacedim > &tria)
void connect_to_triangulation_signals()
std::vector< std::vector< types::fe_index > > hp_cell_active_fe_indices
std::vector< MGVertexDoFs > mg_vertex_dofs
std::vector< boost::signals2::connection > tria_listeners
void post_distributed_transfer_action()
std::vector< std::array< std::vector< types::global_dof_index >, dim+1 > > object_dof_indices
const Triangulation< dim, spacedim > & get_triangulation() const
typename LevelSelector::CellAccessor level_cell_accessor
void pre_transfer_action()
const IndexSet & locally_owned_dofs() const
void reinit(const Triangulation< dim, spacedim > &tria)
std::vector< std::array< std::vector< offset_type >, dim+1 > > object_dof_ptr
std::unique_ptr<::internal::DoFHandlerImplementation::DoFFaces< dim > > mg_faces
void serialize(Archive &archive, const unsigned int version)
DoFHandler & operator=(const DoFHandler &)=delete
DoFHandler(const DoFHandler &)=delete
active_cell_iterator begin_active(const unsigned int level=0) const
std::vector< types::fe_index > get_active_fe_indices() const
void distribute_mg_dofs()
active_cell_iterator end_active(const unsigned int level) const
bool hp_capability_enabled
bool has_hp_capabilities() const
void initialize_local_block_info()
types::global_dof_index n_dofs() const
void update_active_fe_table()
level_cell_iterator end_mg(const unsigned int level) const
cell_iterator end(const unsigned int level) const
typename LevelSelector::cell_iterator level_cell_iterator
std::vector<::internal::DoFHandlerImplementation::NumberCache > mg_number_cache
void load(Archive &ar, const unsigned int version)
typename LevelSelector::face_iterator level_face_iterator
cell_iterator begin(const unsigned int level=0) const
MPI_Comm get_mpi_communicator() const
std::array< std::vector< offset_type >, dim+1 > hp_object_fe_ptr
MPI_Comm get_communicator() const
void get_active_fe_indices(std::vector< unsigned int > &active_fe_indices) const
void distribute_dofs(const hp::FECollection< dim, spacedim > &fe)
types::global_dof_index n_boundary_dofs(const std::map< types::boundary_id, const Function< spacedim, number > * > &boundary_ids) const
ObserverPointer< const Triangulation< dim, spacedim >, DoFHandler< dim, spacedim > > tria
bool has_level_dofs() const
std::unique_ptr<::internal::DoFHandlerImplementation::Policy::PolicyBase< dim, spacedim > > policy
typename LevelSelector::FaceAccessor level_face_accessor
types::global_dof_index n_dofs(const unsigned int level) const
std::array< std::vector< types::fe_index >, dim+1 > hp_object_fe_indices
void set_active_fe_indices(const std::vector< types::fe_index > &active_fe_indices)
unsigned int max_couplings_between_boundary_dofs() const
types::global_dof_index n_locally_owned_dofs() const
types::global_dof_index n_boundary_dofs(const std::set< types::boundary_id > &boundary_ids) const
const BlockInfo & block_info() const
::internal::DoFHandlerImplementation::NumberCache number_cache
void set_future_fe_indices(const std::vector< types::fe_index > &future_fe_indices)
virtual ~DoFHandler() override
#define DEAL_II_DEPRECATED
#define DEAL_II_NAMESPACE_OPEN
#define DEAL_II_CXX20_REQUIRES(condition)
#define DEAL_II_NAMESPACE_CLOSE
IteratorRange< active_cell_iterator > active_cell_iterators() const
IteratorRange< level_cell_iterator > mg_cell_iterators() const
IteratorRange< cell_iterator > cell_iterators_on_level(const unsigned int level) const
IteratorRange< cell_iterator > cell_iterators() const
IteratorRange< active_cell_iterator > active_cell_iterators_on_level(const unsigned int level) const
IteratorRange< level_cell_iterator > mg_cell_iterators_on_level(const unsigned int level) const
#define DeclException0(Exception0)
#define Assert(cond, exc)
#define DeclException2(Exception2, type1, type2, outsequence)
#define DeclExceptionMsg(Exception, defaulttext)
static ::ExceptionBase & ExcNoDominatedFiniteElementOnChildren()
#define DeclException1(Exception1, type1, outsequence)
static ::ExceptionBase & ExcInvalidLevel(int arg1)
static ::ExceptionBase & ExcMessage(std::string arg1)
#define AssertThrow(cond, exc)
typename ActiveSelector::FaceAccessor face_accessor
typename ActiveSelector::cell_iterator cell_iterator
typename ActiveSelector::line_iterator line_iterator
typename ActiveSelector::face_iterator face_iterator
typename ActiveSelector::active_line_iterator active_line_iterator
typename ActiveSelector::active_cell_iterator active_cell_iterator
typename ActiveSelector::CellAccessor cell_accessor
typename ActiveSelector::quad_iterator quad_iterator
typename ActiveSelector::active_hex_iterator active_hex_iterator
typename ActiveSelector::active_quad_iterator active_quad_iterator
typename ActiveSelector::hex_iterator hex_iterator
typename ActiveSelector::active_face_iterator active_face_iterator
unsigned int n_cells(const internal::TriangulationImplementation::NumberCache< 1 > &c)
unsigned int dominated_future_fe_on_children(const typename DoFHandler< dim, spacedim >::cell_iterator &parent)
void communicate_future_fe_indices(DoFHandler< dim, spacedim > &dof_handler)
std::string policy_to_string(const ::internal::DoFHandlerImplementation::Policy::PolicyBase< dim, spacedim > &policy)
unsigned short int fe_index
std::map< const cell_iterator, const types::fe_index > refined_cells_fe_index
std::map< const cell_iterator, const types::fe_index > persisting_cells_fe_index
std::vector< types::fe_index > active_fe_indices
std::map< const cell_iterator, const types::fe_index > coarsened_cells_fe_index
std::unique_ptr< parallel::distributed::CellDataTransfer< dim, spacedim, std::vector< types::fe_index > > > cell_data_transfer