/usr/include/deal.II/multigrid/mg_transfer.h is in libdeal.ii-dev 8.4.2-2+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 | // ---------------------------------------------------------------------
//
// Copyright (C) 2001 - 2016 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE at
// the top level of the deal.II distribution.
//
// ---------------------------------------------------------------------
#ifndef dealii__mg_transfer_h
#define dealii__mg_transfer_h
#include <deal.II/base/config.h>
#include <deal.II/lac/block_vector.h>
#include <deal.II/lac/constraint_matrix.h>
#include <deal.II/lac/sparse_matrix.h>
#include <deal.II/lac/block_sparsity_pattern.h>
#include <deal.II/lac/trilinos_sparse_matrix.h>
#include <deal.II/lac/parallel_vector.h>
#include <deal.II/lac/vector_memory.h>
#include <deal.II/multigrid/mg_base.h>
#include <deal.II/multigrid/mg_constrained_dofs.h>
#include <deal.II/base/mg_level_object.h>
#include <deal.II/dofs/dof_handler.h>
#include <deal.II/base/std_cxx11/shared_ptr.h>
DEAL_II_NAMESPACE_OPEN
namespace internal
{
template <typename VectorType>
struct MatrixSelector
{
typedef ::dealii::SparsityPattern Sparsity;
typedef ::dealii::SparseMatrix<typename VectorType::value_type> Matrix;
template <typename SparsityPatternType, typename DoFHandlerType>
static void reinit(Matrix &matrix, Sparsity &sparsity, int level, const SparsityPatternType &sp, const DoFHandlerType &)
{
sparsity.copy_from (sp);
(void)level;
matrix.reinit (sparsity);
}
};
#ifdef DEAL_II_WITH_TRILINOS
template <typename Number>
struct MatrixSelector<parallel::distributed::Vector<Number> >
{
typedef ::dealii::TrilinosWrappers::SparsityPattern Sparsity;
typedef ::dealii::TrilinosWrappers::SparseMatrix Matrix;
template <typename SparsityPatternType, typename DoFHandlerType>
static void reinit(Matrix &matrix, Sparsity &, int level, const SparsityPatternType &sp, DoFHandlerType &dh)
{
matrix.reinit(dh.locally_owned_mg_dofs(level+1),
dh.locally_owned_mg_dofs(level),
sp, MPI_COMM_WORLD, true);
}
};
template <>
struct MatrixSelector<dealii::TrilinosWrappers::MPI::Vector>
{
typedef ::dealii::TrilinosWrappers::SparsityPattern Sparsity;
typedef ::dealii::TrilinosWrappers::SparseMatrix Matrix;
template <typename SparsityPatternType, typename DoFHandlerType>
static void reinit(Matrix &matrix, Sparsity &, int level, const SparsityPatternType &sp, DoFHandlerType &dh)
{
matrix.reinit(dh.locally_owned_mg_dofs(level+1),
dh.locally_owned_mg_dofs(level),
sp, MPI_COMM_WORLD, true);
}
};
template <>
struct MatrixSelector<dealii::TrilinosWrappers::Vector>
{
typedef ::dealii::TrilinosWrappers::SparsityPattern Sparsity;
typedef ::dealii::TrilinosWrappers::SparseMatrix Matrix;
template <typename SparsityPatternType, typename DoFHandlerType>
static void reinit(Matrix &, Sparsity &, int /*level*/, const SparsityPatternType &, DoFHandlerType &)
{
}
};
#endif
}
/*
* MGTransferBase is defined in mg_base.h
*/
/*!@addtogroup mg */
/*@{*/
/**
* Implementation of transfer between the global vectors and the multigrid
* levels for use in the derived class MGTransferPrebuilt and other classes.
*
* @author Wolfgang Bangerth, Guido Kanschat, Timo Heister, Martin Kronbichler
* @date 1999, 2000, 2001, 2002, 2003, 2004, 2012, 2015
*/
template <typename VectorType>
class MGLevelGlobalTransfer : public MGTransferBase<VectorType>
{
public:
/**
* Reset the object to the state it had right after the default constructor.
*/
void clear ();
/**
* Transfer from a vector on the global grid to vectors defined on each of
* the levels separately, i.a. an @p MGVector.
*/
template <int dim, class InVector, int spacedim>
void
copy_to_mg (const DoFHandler<dim,spacedim> &mg_dof,
MGLevelObject<VectorType> &dst,
const InVector &src) const;
/**
* Transfer from multi-level vector to normal vector.
*
* Copies data from active portions of an MGVector into the respective
* positions of a <tt>Vector<number></tt>. In order to keep the result
* consistent, constrained degrees of freedom are set to zero.
*/
template <int dim, class OutVector, int spacedim>
void
copy_from_mg (const DoFHandler<dim,spacedim> &mg_dof,
OutVector &dst,
const MGLevelObject<VectorType> &src) const;
/**
* Add a multi-level vector to a normal vector.
*
* Works as the previous function, but probably not for continuous elements.
*/
template <int dim, class OutVector, int spacedim>
void
copy_from_mg_add (const DoFHandler<dim,spacedim> &mg_dof,
OutVector &dst,
const MGLevelObject<VectorType> &src) const;
/**
* If this object operates on BlockVector objects, we need to describe how
* the individual vector components are mapped to the blocks of a vector.
* For example, for a Stokes system, we have dim+1 vector components for
* velocity and pressure, but we may want to use block vectors with only two
* blocks for all velocities in one block, and the pressure variables in the
* other.
*
* By default, if this function is not called, block vectors have as many
* blocks as the finite element has vector components. However, this can be
* changed by calling this function with an array that describes how vector
* components are to be grouped into blocks. The meaning of the argument is
* the same as the one given to the DoFTools::count_dofs_per_component
* function.
*/
void
set_component_to_block_map (const std::vector<unsigned int> &map);
/**
* Memory used by this object.
*/
std::size_t memory_consumption () const;
/**
* Print the copy index fields for debugging purposes.
*/
void print_indices(std::ostream &os) const;
protected:
/**
* Internal function to @p fill copy_indices*. Called by derived classes.
*/
template <int dim, int spacedim>
void fill_and_communicate_copy_indices(const DoFHandler<dim,spacedim> &mg_dof);
/**
* Sizes of the multi-level vectors.
*/
std::vector<types::global_dof_index> sizes;
/**
* Mapping for the copy_to_mg() and copy_from_mg() functions. Here only
* index pairs locally owned
*
* The data is organized as follows: one vector per level. Each element of
* these vectors contains first the global index, then the level index.
*/
std::vector<std::vector<std::pair<types::global_dof_index, types::global_dof_index> > >
copy_indices;
/**
* Additional degrees of freedom for the copy_to_mg() function. These are
* the ones where the global degree of freedom is locally owned and the
* level degree of freedom is not.
*
* Organization of the data is like for @p copy_indices_mine.
*/
std::vector<std::vector<std::pair<types::global_dof_index, types::global_dof_index> > >
copy_indices_global_mine;
/**
* Additional degrees of freedom for the copy_from_mg() function. These are
* the ones where the level degree of freedom is locally owned and the
* global degree of freedom is not.
*
* Organization of the data is like for @p copy_indices_mine.
*/
std::vector<std::vector<std::pair<types::global_dof_index, types::global_dof_index> > >
copy_indices_level_mine;
/**
* Stores whether the copy operation from the global to the level vector is
* actually a plain copy to the finest level. This means that the grid has
* no adaptive refinement and the numbering on the finest multigrid level is
* the same as in the global case.
*/
bool perform_plain_copy;
/**
* The vector that stores what has been given to the
* set_component_to_block_map() function.
*/
std::vector<unsigned int> component_to_block_map;
/**
* The mg_constrained_dofs of the level systems.
*/
SmartPointer<const MGConstrainedDoFs, MGLevelGlobalTransfer<VectorType> > mg_constrained_dofs;
};
/**
* Implementation of transfer between the global vectors and the multigrid
* levels for use in the derived class MGTransferPrebuilt and other classes.
* This class is a specialization for the case of
* parallel::distributed::Vector that requires a few different calling
* routines as compared to the %parallel vectors in the PETScWrappers and
* TrilinosWrappers namespaces.
*
* @author Martin Kronbichler
* @date 2016
*/
template <typename Number>
class MGLevelGlobalTransfer<parallel::distributed::Vector<Number> > : public MGTransferBase<parallel::distributed::Vector<Number> >
{
public:
/**
* Reset the object to the state it had right after the default constructor.
*/
void clear ();
/**
* Transfer from a vector on the global grid to vectors defined on each of
* the levels separately, i.a. an @p MGVector.
*/
template <int dim, typename Number2, int spacedim>
void
copy_to_mg (const DoFHandler<dim,spacedim> &mg_dof,
MGLevelObject<parallel::distributed::Vector<Number> > &dst,
const parallel::distributed::Vector<Number2> &src) const;
/**
* Transfer from multi-level vector to normal vector.
*
* Copies data from active portions of an MGVector into the respective
* positions of a <tt>Vector<number></tt>. In order to keep the result
* consistent, constrained degrees of freedom are set to zero.
*/
template <int dim, typename Number2, int spacedim>
void
copy_from_mg (const DoFHandler<dim,spacedim> &mg_dof,
parallel::distributed::Vector<Number2> &dst,
const MGLevelObject<parallel::distributed::Vector<Number> > &src) const;
/**
* Add a multi-level vector to a normal vector.
*
* Works as the previous function, but probably not for continuous elements.
*/
template <int dim, typename Number2, int spacedim>
void
copy_from_mg_add (const DoFHandler<dim,spacedim> &mg_dof,
parallel::distributed::Vector<Number2> &dst,
const MGLevelObject<parallel::distributed::Vector<Number> > &src) const;
/**
* If this object operates on BlockVector objects, we need to describe how
* the individual vector components are mapped to the blocks of a vector.
* For example, for a Stokes system, we have dim+1 vector components for
* velocity and pressure, but we may want to use block vectors with only two
* blocks for all velocities in one block, and the pressure variables in the
* other.
*
* By default, if this function is not called, block vectors have as many
* blocks as the finite element has vector components. However, this can be
* changed by calling this function with an array that describes how vector
* components are to be grouped into blocks. The meaning of the argument is
* the same as the one given to the DoFTools::count_dofs_per_component
* function.
*/
void
set_component_to_block_map (const std::vector<unsigned int> &map);
/**
* Memory used by this object.
*/
std::size_t memory_consumption () const;
/**
* Print the copy index fields for debugging purposes.
*/
void print_indices(std::ostream &os) const;
protected:
/**
* Internal function to @p fill copy_indices*. Called by derived classes.
*/
template <int dim, int spacedim>
void fill_and_communicate_copy_indices(const DoFHandler<dim,spacedim> &mg_dof);
/**
* Sizes of the multi-level vectors.
*/
std::vector<types::global_dof_index> sizes;
/**
* Mapping for the copy_to_mg() and copy_from_mg() functions. Here only
* index pairs locally owned is stored.
*
* The data is organized as follows: one vector per level. Each element of
* these vectors contains first the global index, then the level index.
*/
std::vector<std::vector<std::pair<unsigned int, unsigned int> > >
copy_indices;
/**
* Additional degrees of freedom for the copy_to_mg() function. These are
* the ones where the global degree of freedom is locally owned and the
* level degree of freedom is not.
*
* Organization of the data is like for @p copy_indices_mine.
*/
std::vector<std::vector<std::pair<unsigned int, unsigned int> > >
copy_indices_global_mine;
/**
* Additional degrees of freedom for the copy_from_mg() function. These are
* the ones where the level degree of freedom is locally owned and the
* global degree of freedom is not.
*
* Organization of the data is like for @p copy_indices_mine.
*/
std::vector<std::vector<std::pair<unsigned int, unsigned int> > >
copy_indices_level_mine;
/**
* Stores whether the copy operation from the global to the level vector is
* actually a plain copy to the finest level. This means that the grid has
* no adaptive refinement and the numbering on the finest multigrid level is
* the same as in the global case.
*/
bool perform_plain_copy;
/**
* The vector that stores what has been given to the
* set_component_to_block_map() function.
*/
std::vector<unsigned int> component_to_block_map;
/**
* The mg_constrained_dofs of the level systems.
*/
SmartPointer<const MGConstrainedDoFs, MGLevelGlobalTransfer<parallel::distributed::Vector<Number> > > mg_constrained_dofs;
/**
* In the function copy_to_mg, we need to access ghosted entries of the
* global vector for inserting into the level vectors. This vector is
* populated with those entries.
*/
mutable parallel::distributed::Vector<Number> ghosted_global_vector;
/**
* In the function copy_from_mg, we access all level vectors with certain
* ghost entries for inserting the result into a global vector.
*/
mutable MGLevelObject<parallel::distributed::Vector<Number> > ghosted_level_vector;
};
/**
* Implementation of the MGTransferBase interface for which the transfer
* operations are prebuilt upon construction of the object of this class as
* matrices. This is the fast way, since it only needs to build the operation
* once by looping over all cells and storing the result in a matrix for each
* level, but requires additional memory.
*
* See MGTransferBase to find out which of the transfer classes is best for
* your needs.
*
* @author Wolfgang Bangerth, Guido Kanschat, Timo Heister, Martin Kronbichler
* @date 1999, 2000, 2001, 2002, 2003, 2004, 2012, 2015
*/
template <typename VectorType>
class MGTransferPrebuilt : public MGLevelGlobalTransfer<VectorType>
{
public:
/**
* Constructor without constraint matrices. Use this constructor only with
* discontinuous finite elements or with no local refinement.
*/
MGTransferPrebuilt ();
/**
* Constructor with constraints. Equivalent to the default constructor
* followed by initialize_constraints().
*/
MGTransferPrebuilt (const ConstraintMatrix &constraints,
const MGConstrainedDoFs &mg_constrained_dofs);
/**
* Destructor.
*/
virtual ~MGTransferPrebuilt ();
/**
* Initialize the constraints to be used in build_matrices().
*/
void initialize_constraints (const ConstraintMatrix &constraints,
const MGConstrainedDoFs &mg_constrained_dofs);
/**
* Reset the object to the state it had right after the default constructor.
*/
void clear ();
/**
* Actually build the prolongation matrices for each level.
*/
template <int dim, int spacedim>
void build_matrices (const DoFHandler<dim,spacedim> &mg_dof);
/**
* Prolongate a vector from level <tt>to_level-1</tt> to level
* <tt>to_level</tt> using the embedding matrices of the underlying finite
* element. The previous content of <tt>dst</tt> is overwritten.
*
* @arg src is a vector with as many elements as there are degrees of
* freedom on the coarser level involved.
*
* @arg dst has as many elements as there are degrees of freedom on the
* finer level.
*/
virtual void prolongate (const unsigned int to_level,
VectorType &dst,
const VectorType &src) const;
/**
* Restrict a vector from level <tt>from_level</tt> to level
* <tt>from_level-1</tt> using the transpose operation of the @p prolongate
* method. If the region covered by cells on level <tt>from_level</tt> is
* smaller than that of level <tt>from_level-1</tt> (local refinement), then
* some degrees of freedom in <tt>dst</tt> are active and will not be
* altered. For the other degrees of freedom, the result of the restriction
* is added.
*
* @arg src is a vector with as many elements as there are degrees of
* freedom on the finer level involved.
*
* @arg dst has as many elements as there are degrees of freedom on the
* coarser level.
*/
virtual void restrict_and_add (const unsigned int from_level,
VectorType &dst,
const VectorType &src) const;
/**
* Finite element does not provide prolongation matrices.
*/
DeclException0(ExcNoProlongation);
/**
* You have to call build_matrices() before using this object.
*/
DeclException0(ExcMatricesNotBuilt);
/**
* Memory used by this object.
*/
std::size_t memory_consumption () const;
/**
* Print all the matrices for debugging purposes.
*/
void print_matrices(std::ostream &os) const;
private:
/**
* Sparsity patterns for transfer matrices.
*/
std::vector<std_cxx11::shared_ptr<typename internal::MatrixSelector<VectorType>::Sparsity> > prolongation_sparsities;
/**
* The actual prolongation matrix. column indices belong to the dof indices
* of the mother cell, i.e. the coarse level. while row indices belong to
* the child cell, i.e. the fine level.
*/
std::vector<std_cxx11::shared_ptr<typename internal::MatrixSelector<VectorType>::Matrix> > prolongation_matrices;
/**
* Degrees of freedom on the refinement edge excluding those on the
* boundary.
*/
std::vector<std::vector<bool> > interface_dofs;
/**
* The constraints of the global system.
*/
SmartPointer<const ConstraintMatrix, MGTransferPrebuilt<VectorType> > constraints;
};
/*@}*/
DEAL_II_NAMESPACE_CLOSE
#endif
|