Reference documentation for deal.II version GIT relicensing-462-g03c82a14bd 2024-04-21 16:20: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\}}\)
Loading...
Searching...
No Matches
mg_constrained_dofs.cc
Go to the documentation of this file.
1// ------------------------------------------------------------------------
2//
3// SPDX-License-Identifier: LGPL-2.1-or-later
4// Copyright (C) 2023 by the deal.II authors
5//
6// This file is part of the deal.II library.
7//
8// Part of the source code is dual licensed under Apache-2.0 WITH
9// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
10// governing the source code and code contributions can be found in
11// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
12//
13// ------------------------------------------------------------------------
14
15
17
19
22
24
25
26template <int dim, int spacedim>
27void
30 const MGLevelObject<IndexSet> &level_relevant_dofs)
31{
32 boundary_indices.clear();
34 level_constraints.clear();
35 user_constraints.clear();
36
37 const unsigned int nlevels = dof.get_triangulation().n_global_levels();
38 const unsigned int min_level = level_relevant_dofs.min_level();
39 const unsigned int max_level = (level_relevant_dofs.max_level() == 0) ?
40 nlevels - 1 :
41 level_relevant_dofs.max_level();
42 const bool use_provided_level_relevant_dofs =
43 (level_relevant_dofs.max_level() > 0);
44
45 // At this point level_constraint and refinement_edge_indices are empty.
46 refinement_edge_indices.resize(nlevels);
47 level_constraints.resize(nlevels);
48 user_constraints.resize(nlevels);
49 for (unsigned int l = min_level; l <= max_level; ++l)
50 {
51 if (use_provided_level_relevant_dofs)
52 {
54 level_relevant_dofs[l]);
55 }
56 else
57 {
58 const IndexSet relevant_dofs =
61 relevant_dofs);
62 }
63 }
64
65 // TODO: currently we only consider very basic periodic constraints
66 const IdentityMatrix transformation(dof.get_fe().n_dofs_per_face());
67 const ComponentMask component_mask;
68 const double periodicity_factor = 1.0;
69
70 for (const auto &[first_cell, second_cell] :
72 {
73 // only consider non-artificial cells
74 if (first_cell.first->is_artificial_on_level())
75 continue;
76 if (second_cell.first.first->is_artificial_on_level())
77 continue;
78
79 // consider cell pairs with the same level
80 if (first_cell.first->level() != second_cell.first.first->level())
81 continue;
82
84 first_cell.first->as_dof_handler_level_iterator(dof)->face(
85 first_cell.second),
86 second_cell.first.first->as_dof_handler_level_iterator(dof)->face(
87 second_cell.first.second),
88 transformation,
89 level_constraints[first_cell.first->level()],
90 component_mask,
91 second_cell.second,
92 periodicity_factor,
93 first_cell.first->level());
94 }
95
96 for (unsigned int l = min_level; l <= max_level; ++l)
97 {
98 level_constraints[l].close();
99
100 // Initialize with empty IndexSet of correct size
102 }
103
105}
106
107
108
109template <int dim, int spacedim>
110void
112 const DoFHandler<dim, spacedim> &dof,
113 const std::set<types::boundary_id> &boundary_ids,
114 const ComponentMask &component_mask)
115{
116 // allocate an IndexSet for each global level. Contents will be
117 // overwritten inside make_boundary_list.
118 const unsigned int n_levels = dof.get_triangulation().n_global_levels();
119 Assert(boundary_indices.empty() || boundary_indices.size() == n_levels,
121 boundary_indices.resize(n_levels);
122
124 boundary_ids,
126 component_mask);
127}
128
129
130
131template <int dim, int spacedim>
132void
134 const unsigned int level,
135 const IndexSet &level_boundary_indices)
136{
137 const unsigned int n_levels = dof.get_triangulation().n_global_levels();
138 if (boundary_indices.empty())
139 {
140 boundary_indices.resize(n_levels);
141 for (unsigned int i = 0; i < n_levels; ++i)
142 boundary_indices[i] = IndexSet(dof.n_dofs(i));
143 }
144 AssertDimension(boundary_indices.size(), n_levels);
145 boundary_indices[level].add_indices(level_boundary_indices);
146}
147
148
149
150template <int dim, int spacedim>
151void
153 const DoFHandler<dim, spacedim> &dof,
154 const types::boundary_id bid,
155 const unsigned int first_vector_component)
156{
157 // For a given boundary id, find which vector component is on the boundary
158 // and set a zero boundary constraint for those degrees of freedom.
159 const unsigned int n_components = dof.get_fe_collection().n_components();
160 AssertIndexRange(first_vector_component + dim - 1, n_components);
161
162 ComponentMask comp_mask(n_components, false);
163
164
166 face = dof.get_triangulation().begin_face(),
167 endf = dof.get_triangulation().end_face();
168 for (; face != endf; ++face)
169 if (face->at_boundary() && face->boundary_id() == bid)
170 for (unsigned int d = 0; d < dim; ++d)
171 {
172 Tensor<1, dim, double> unit_vec;
173 unit_vec[d] = 1.0;
174
175 const Tensor<1, dim> normal_vec =
176 face->get_manifold().normal_vector(face, face->center());
177
178 if (std::abs(std::abs(unit_vec * normal_vec) - 1.0) < 1e-10)
179 comp_mask.set(d + first_vector_component, true);
180 else
181 Assert(
182 std::abs(unit_vec * normal_vec) < 1e-10,
184 "We can currently only support no normal flux conditions "
185 "for a specific boundary id if all faces are normal to the "
186 "x, y, or z axis."));
187 }
188
189 Assert(comp_mask.n_selected_components() == 1,
191 "We can currently only support no normal flux conditions "
192 "for a specific boundary id if all faces are facing in the "
193 "same direction, i.e., a boundary normal to the x-axis must "
194 "have a different boundary id than a boundary normal to the "
195 "y- or z-axis and so on. If the mesh here was produced using "
196 "GridGenerator::..., setting colorize=true during mesh generation "
197 "and calling make_no_normal_flux_constraints() for each no normal "
198 "flux boundary will fulfill the condition."));
199
200 this->make_zero_boundary_constraints(dof, {bid}, comp_mask);
201}
202
203
204
205void
207 const unsigned int level,
208 const AffineConstraints<double> &constraints_on_level)
209{
211
212 // Get the relevant DoFs from level_constraints if
213 // the user constraint matrix has not been initialized
214 if (user_constraints[level].get_local_lines().size() == 0)
215 user_constraints[level].reinit(
216 level_constraints[level].get_locally_owned_indices(),
217 level_constraints[level].get_local_lines());
218
219 user_constraints[level].merge(
220 constraints_on_level,
222 user_constraints[level].close();
223}
224
225
226
227void
229{
230 for (auto &constraint : user_constraints)
231 constraint.clear();
232}
233
234
235
236void
243
244
245
246template <typename Number>
247void
249 const unsigned int level,
250 const bool add_boundary_indices,
251 const bool add_refinement_edge_indices,
252 const bool add_level_constraints,
253 const bool add_user_constraints) const
254{
255 constraints.clear();
256
257 // determine local lines
258 IndexSet index_set(this->get_refinement_edge_indices(level).size());
259
261 index_set.add_indices(this->get_boundary_indices(level));
262
263 if (add_refinement_edge_indices)
264 index_set.add_indices(this->get_refinement_edge_indices(level));
265
266 if (add_level_constraints)
267 index_set.add_indices(this->get_level_constraints(level).get_local_lines());
268
270 index_set.add_indices(
271 this->get_user_constraint_matrix(level).get_local_lines());
272
273 constraints.reinit(level_constraints[level].get_locally_owned_indices(),
274 index_set);
275
276 // merge constraints
278 for (const auto i : this->get_boundary_indices(level))
279 constraints.constrain_dof_to_zero(i);
280
281 if (add_refinement_edge_indices)
282 for (const auto i : this->get_refinement_edge_indices(level))
283 constraints.constrain_dof_to_zero(i);
284
285 if (add_level_constraints)
286 constraints.merge(this->get_level_constraints(level),
288 true);
289
291 constraints.merge(this->get_user_constraint_matrix(level),
293 true);
294
295 // finalize setup
296 constraints.close();
297}
298
299#include "mg_constrained_dofs.inst"
300
301
void merge(const AffineConstraints< other_number > &other_constraints, const MergeConflictBehavior merge_conflict_behavior=no_conflicts_allowed, const bool allow_different_local_lines=false)
void constrain_dof_to_zero(const size_type constrained_dof)
void set(const unsigned int index, const bool value)
unsigned int n_selected_components(const unsigned int overall_number_of_components=numbers::invalid_unsigned_int) const
const hp::FECollection< dim, spacedim > & get_fe_collection() const
const FiniteElement< dim, spacedim > & get_fe(const types::fe_index index=0) const
const IndexSet & locally_owned_mg_dofs(const unsigned int level) const
const Triangulation< dim, spacedim > & get_triangulation() const
types::global_dof_index n_dofs() const
unsigned int n_dofs_per_face(unsigned int face_no=0, unsigned int child=0) const
void add_indices(const ForwardIterator &begin, const ForwardIterator &end)
Definition index_set.h:1820
std::vector< IndexSet > refinement_edge_indices
std::vector< AffineConstraints< double > > user_constraints
void make_no_normal_flux_constraints(const DoFHandler< dim, spacedim > &dof, const types::boundary_id bid, const unsigned int first_vector_component)
void make_zero_boundary_constraints(const DoFHandler< dim, spacedim > &dof, const std::set< types::boundary_id > &boundary_ids, const ComponentMask &component_mask={})
std::vector< IndexSet > boundary_indices
void add_boundary_indices(const DoFHandler< dim, spacedim > &dof, const unsigned int level, const IndexSet &boundary_indices)
void initialize(const DoFHandler< dim, spacedim > &dof, const MGLevelObject< IndexSet > &level_relevant_dofs=MGLevelObject< IndexSet >())
void merge_constraints(AffineConstraints< Number > &constraints, const unsigned int level, const bool add_boundary_indices, const bool add_refinement_edge_indices, const bool add_level_constraints, const bool add_user_constraints) const
std::vector< AffineConstraints< double > > level_constraints
bool have_boundary_indices() const
void add_user_constraints(const unsigned int level, const AffineConstraints< double > &constraints_on_level)
const IndexSet & get_refinement_edge_indices(unsigned int level) const
const AffineConstraints< double > & get_user_constraint_matrix(const unsigned int level) const
const AffineConstraints< double > & get_level_constraints(const unsigned int level) const
const IndexSet & get_boundary_indices(const unsigned int level) const
unsigned int max_level() const
unsigned int min_level() const
const std::map< std::pair< cell_iterator, unsigned int >, std::pair< std::pair< cell_iterator, unsigned int >, unsigned char > > & get_periodic_face_map() const
face_iterator end_face() const
virtual unsigned int n_global_levels() const
face_iterator begin_face() const
unsigned int n_components() const
#define DEAL_II_NAMESPACE_OPEN
Definition config.h:502
#define DEAL_II_NAMESPACE_CLOSE
Definition config.h:503
unsigned int level
Definition grid_out.cc:4626
#define Assert(cond, exc)
#define AssertDimension(dim1, dim2)
#define AssertIndexRange(index, range)
static ::ExceptionBase & ExcInternalError()
static ::ExceptionBase & ExcMessage(std::string arg1)
void set_periodicity_constraints(const FaceIterator &face_1, const std_cxx20::type_identity_t< FaceIterator > &face_2, const FullMatrix< double > &transformation, AffineConstraints< number > &affine_constraints, const ComponentMask &component_mask, const unsigned char combined_orientation, const number periodicity_factor, const unsigned int level=numbers::invalid_unsigned_int)
IndexSet extract_locally_relevant_level_dofs(const DoFHandler< dim, spacedim > &dof_handler, const unsigned int level)
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:1239
void extract_inner_interface_dofs(const DoFHandler< dim, spacedim > &mg_dof_handler, std::vector< IndexSet > &interface_dofs)
Definition mg_tools.cc:1443
::VectorizedArray< Number, width > abs(const ::VectorizedArray< Number, width > &)