Reference documentation for deal.II version GIT f6a5d312c9 2023-10-04 08:50:02+00:00
\(\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\}}\)
mg_tools.h
Go to the documentation of this file.
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 2005 - 2023 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of deal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #ifndef dealii_mg_tools_h
17 #define dealii_mg_tools_h
18 
19 #include <deal.II/base/config.h>
20 
21 #include <deal.II/base/index_set.h>
22 
24 #include <deal.II/dofs/dof_tools.h>
25 
26 #include <set>
27 #include <vector>
28 
29 
31 
32 // Forward declarations
33 #ifndef DOXYGEN
34 template <int dim, int spacedim>
35 DEAL_II_CXX20_REQUIRES((concepts::is_valid_dim_spacedim<dim, spacedim>))
36 class DoFHandler;
37 class MGConstrainedDoFs;
38 #endif
39 
52 namespace MGTools
53 {
57  template <int dim, int spacedim>
58  void
60  const DoFHandler<dim, spacedim> &dofs,
61  const unsigned int level,
62  std::vector<unsigned int> &row_lengths,
63  const DoFTools::Coupling flux_couplings = DoFTools::none);
64 
69  template <int dim, int spacedim>
70  void
72  const unsigned int level,
73  std::vector<unsigned int> &row_lengths,
74  const Table<2, DoFTools::Coupling> &couplings,
75  const Table<2, DoFTools::Coupling> &flux_couplings);
76 
89  template <int dim, int spacedim, typename number = double>
90  void
92  SparsityPatternBase &sparsity,
93  const unsigned int level,
94  const AffineConstraints<number> &constraints = {},
95  const bool keep_constrained_dofs = true);
96 
105  template <int dim, int spacedim, typename number = double>
106  void
108  SparsityPatternBase &sparsity,
109  const unsigned int level,
110  const AffineConstraints<number> &constraints = {},
111  const bool keep_constrained_dofs = true);
112 
113 
120  template <int dim, int spacedim>
121  void
123  SparsityPatternBase &sparsity,
124  const unsigned int level);
134  template <int dim, int spacedim>
135  void
137  SparsityPatternBase &sparsity,
138  const unsigned int level,
139  const Table<2, DoFTools::Coupling> &int_mask,
140  const Table<2, DoFTools::Coupling> &flux_mask);
141 
150  template <int dim, int spacedim>
151  void
153  const DoFHandler<dim, spacedim> &dof_handler,
154  SparsityPatternBase &sparsity,
155  const unsigned int level,
156  const Table<2, DoFTools::Coupling> &flux_mask);
157 
158 
165  template <int dim, int spacedim>
166  void
168  const MGConstrainedDoFs &mg_constrained_dofs,
169  SparsityPatternBase &sparsity,
170  const unsigned int level);
171 
172 
179  template <int dim, int spacedim>
180  void
182  const DoFHandler<dim, spacedim> &dof_handler,
183  std::vector<std::vector<types::global_dof_index>> &dofs_per_block,
184  std::vector<unsigned int> target_block = {});
185 
193  template <int dim, int spacedim>
194  void
196  const DoFHandler<dim, spacedim> &mg_dof,
197  std::vector<std::vector<types::global_dof_index>> &result,
198  const bool only_once = false,
199  std::vector<unsigned int> target_component = {});
200 
220  template <int dim, int spacedim>
221  void
223  const DoFHandler<dim, spacedim> &mg_dof,
224  const std::map<types::boundary_id, const Function<spacedim> *>
225  &function_map,
226  std::vector<std::set<types::global_dof_index>> &boundary_indices,
227  const ComponentMask &component_mask = {});
228 
236  template <int dim, int spacedim>
237  void
239  const std::map<types::boundary_id,
240  const Function<spacedim> *> &function_map,
241  std::vector<IndexSet> &boundary_indices,
242  const ComponentMask &component_mask = {});
243 
251  template <int dim, int spacedim>
252  void
254  const std::set<types::boundary_id> &boundary_ids,
255  std::vector<IndexSet> &boundary_indices,
256  const ComponentMask &component_mask = {});
257 
263  template <int dim, int spacedim>
264  void
266  std::vector<IndexSet> &interface_dofs);
267 
277  template <int dim, int spacedim>
278  unsigned int
280 
291  template <int dim, int spacedim>
292  std::vector<types::global_dof_index>
294 
302  template <int dim, int spacedim>
303  std::vector<types::global_dof_index>
305  const std::vector<std::shared_ptr<const Triangulation<dim, spacedim>>>
306  &trias);
307 
326  template <int dim, int spacedim>
327  double
329 
335  template <int dim, int spacedim>
336  double
338  const std::vector<std::shared_ptr<const Triangulation<dim, spacedim>>>
339  &trias);
340 
348  template <int dim, int spacedim>
349  std::vector<std::pair<types::global_dof_index, types::global_dof_index>>
351 
360  template <int dim, int spacedim>
361  std::vector<std::pair<types::global_dof_index, types::global_dof_index>>
363  const std::vector<std::shared_ptr<const Triangulation<dim, spacedim>>>
364  &trias);
365 
377  template <int dim, int spacedim>
378  double
380 
386  template <int dim, int spacedim>
387  double
389  const std::vector<std::shared_ptr<const Triangulation<dim, spacedim>>>
390  &trias);
391 
392 
393 } // namespace MGTools
394 
398 
399 #endif
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:477
#define DEAL_II_CXX20_REQUIRES(condition)
Definition: config.h:166
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:478
unsigned int level
Definition: grid_out.cc:4617
void make_flux_sparsity_pattern(const DoFHandler< dim, spacedim > &dof_handler, SparsityPatternBase &sparsity, const unsigned int level, const AffineConstraints< number > &constraints={}, const bool keep_constrained_dofs=true)
Definition: mg_tools.cc:606
std::vector< std::pair< types::global_dof_index, types::global_dof_index > > local_vertical_communication_cost(const Triangulation< dim, spacedim > &tria)
Definition: mg_tools.cc:1697
void make_interface_sparsity_pattern(const DoFHandler< dim, spacedim > &dof_handler, const MGConstrainedDoFs &mg_constrained_dofs, SparsityPatternBase &sparsity, const unsigned int level)
Definition: mg_tools.cc:1014
std::vector< types::global_dof_index > local_workload(const Triangulation< dim, spacedim > &tria)
Definition: mg_tools.cc:1629
void make_flux_sparsity_pattern_edge(const DoFHandler< dim, spacedim > &dof_handler, SparsityPatternBase &sparsity, const unsigned int level)
Definition: mg_tools.cc:680
void compute_row_length_vector(const DoFHandler< dim, spacedim > &dofs, const unsigned int level, std::vector< unsigned int > &row_lengths, const DoFTools::Coupling flux_couplings=DoFTools::none)
Definition: mg_tools.cc:107
void extract_inner_interface_dofs(const DoFHandler< dim, spacedim > &mg_dof_handler, std::vector< IndexSet > &interface_dofs)
Definition: mg_tools.cc:1444
double workload_imbalance(const Triangulation< dim, spacedim > &tria)
Definition: mg_tools.cc:1675
void count_dofs_per_block(const DoFHandler< dim, spacedim > &dof_handler, std::vector< std::vector< types::global_dof_index >> &dofs_per_block, std::vector< unsigned int > target_block={})
Definition: mg_tools.cc:1157
void make_boundary_list(const DoFHandler< dim, spacedim > &mg_dof, const std::map< types::boundary_id, const Function< spacedim > * > &function_map, std::vector< std::set< types::global_dof_index >> &boundary_indices, const ComponentMask &component_mask={})
Definition: mg_tools.cc:1240
double vertical_communication_efficiency(const Triangulation< dim, spacedim > &tria)
Definition: mg_tools.cc:1806
void make_sparsity_pattern(const DoFHandler< dim, spacedim > &dof_handler, SparsityPatternBase &sparsity, const unsigned int level, const AffineConstraints< number > &constraints={}, const bool keep_constrained_dofs=true)
Definition: mg_tools.cc:576
void count_dofs_per_component(const DoFHandler< dim, spacedim > &mg_dof, std::vector< std::vector< types::global_dof_index >> &result, const bool only_once=false, std::vector< unsigned int > target_component={})
Definition: mg_tools.cc:1055
unsigned int max_level_for_coarse_mesh(const Triangulation< dim, spacedim > &tria)
Definition: mg_tools.cc:1531
unsigned int boundary_id
Definition: types.h:141
const ::Triangulation< dim, spacedim > & tria