/usr/include/deal.II/multigrid/mg_transfer_block.h is in libdeal.ii-dev 6.3.1-1.1.
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 | //---------------------------------------------------------------------------
// $Id: mg_transfer_block.h 20871 2010-03-21 19:22:22Z kanschat $
// Version: $Name$
//
// Copyright (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__mg_transfer_block_h
#define __deal2__mg_transfer_block_h
#include <base/config.h>
#include <lac/block_vector.h>
#ifdef DEAL_PREFER_MATRIX_EZ
# include <lac/sparse_matrix_ez.h>
# include <lac/block_sparse_matrix_ez.h>
#else
# include <lac/sparsity_pattern.h>
# include <lac/block_sparsity_pattern.h>
#endif
#include <lac/vector_memory.h>
#include <lac/block_matrix_array.h>
#include <multigrid/mg_base.h>
#include <base/mg_level_object.h>
#include <dofs/dof_handler.h>
#include <base/std_cxx1x/shared_ptr.h>
DEAL_II_NAMESPACE_OPEN
template <int dim, int spacedim> class MGDoFHandler;
/*
* MGTransferBase is defined in mg_base.h
*/
/*!@addtogroup mg */
/*@{*/
/**
* Implementation of matrix generation for MGTransferBlock.
*
* This is the base class for MGTransfer objects for systems of
* equations where multigrid is applied only to one ore some blocks,
* where a @ref GlossBlock comprises all degrees of freedom generated
* by one base element.
*
* @author Guido Kanschat, 2001-2003
*/
class MGTransferBlockBase
{
public:
/**
* Memory used by this object.
*/
unsigned int memory_consumption () const;
protected:
/**
* Actually build the prolongation
* matrices for each level.
*
* This function is only called
* by derived classes. These can
* also set the member variables
* #selected and others to
* restrict the transfer matrices
* to certain blocks.
*/
template <int dim, int spacedim>
void build_matrices (const DoFHandler<dim,spacedim>& dof,
const MGDoFHandler<dim,spacedim>& mg_dof);
/**
* Flag of selected blocks.
*
* The transfer operators only act
* on the blocks having a
* <tt>true</tt> entry here.
*/
std::vector<bool> selected;
/**
* Number of blocks of multigrid
* vector.
*/
unsigned int n_mg_blocks;
/**
* For each block of the whole
* block vector, list to what
* block of the multigrid vector
* it is mapped. Since depending
* on #selected, there may be
* fewer mutlilevel blocks than
* original blocks, some of the
* entries may be illegal
* unsigned integers.
*/
std::vector<unsigned int> mg_block;
/**
* Sizes of the multi-level vectors.
*/
mutable std::vector<std::vector<unsigned int> > sizes;
/**
* Start index of each block.
*/
std::vector<unsigned int> block_start;
/**
* Start index of each block on
* all levels.
*/
std::vector<std::vector<unsigned int> > mg_block_start;
/**
* Call build_matrices()
* function first.
*/
DeclException0(ExcMatricesNotBuilt);
private:
std::vector<std_cxx1x::shared_ptr<BlockSparsityPattern> > prolongation_sparsities;
protected:
/**
* 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_cxx1x::shared_ptr<BlockSparseMatrix<double> > > prolongation_matrices;
/**
* Mapping for the
* <tt>copy_to/from_mg</tt>-functions.
* The indices into this vector
* are (in this order): global
* block number, level
* number. The data is first the
* global index inside the block,
* then the level index inside
* the block.
*/
std::vector<std::vector<std::vector<std::pair<unsigned int, unsigned int> > > >
copy_indices;
};
/**
* Implementation of the MGTransferBase interface for block
* matrices and block vectors.
*
* @warning This class is in an untested state. If you use it and you
* encounter problems, please contact Guido Kanschat.
*
* In addition to the functionality of
* MGTransferPrebuilt, the operation may be restricted to
* certain blocks of the vector.
*
* If the restricted mode is chosen, block vectors used in the
* transfer routines may only have as many blocks as there are
* @p trues in the selected-field.
*
* See MGTransferBase to find out which of the transfer classes
* is best for your needs.
*
* @author Guido Kanschat, 2001, 2002
*/
template <typename number>
class MGTransferBlock : public MGTransferBase<BlockVector<number> >,
private MGTransferBlockBase
{
public:
/**
* Default constructor.
*/
MGTransferBlock();
/**
* Destructor.
*/
virtual ~MGTransferBlock ();
/**
* Initialize additional #factors
* and #memory if the restriction
* of the blocks is to be
* weighted differently.
*/
void initialize (const std::vector<number>& factors,
VectorMemory<Vector<number> >& memory);
/**
* Build the prolongation
* matrices for each level.
*
* This function is a front-end
* for the same function in
* MGTransferBlockBase.
*/
template<int dim, int spacedim>
void build_matrices (const DoFHandler<dim,spacedim> &dof,
const MGDoFHandler<dim,spacedim> &mg_dof,
const std::vector<bool>& selected);
virtual void prolongate (const unsigned int to_level,
BlockVector<number> &dst,
const BlockVector<number> &src) const;
virtual void restrict_and_add (const unsigned int from_level,
BlockVector<number> &dst,
const BlockVector<number> &src) const;
/**
* Transfer from a vector on the
* global grid to a multilevel
* vector.
*
* The action for discontinuous
* elements is as follows: on an
* active mesh cell, the global
* vector entries are simply
* copied to the corresponding
* entries of the level
* vector. Then, these values are
* restricted down to the
* coarsest level.
*/
template <int dim, typename number2, int spacedim>
void
copy_to_mg (const MGDoFHandler<dim,spacedim>& mg_dof,
MGLevelObject<BlockVector<number> >& dst,
const BlockVector<number2>& src) const;
/**
* Transfer from multi-level vector to
* normal vector.
*
* Copies data from active
* portions of a multilevel
* vector into the respective
* positions of a global vector.
*/
template <int dim, typename number2, int spacedim>
void
copy_from_mg (const MGDoFHandler<dim,spacedim>& mg_dof,
BlockVector<number2>& dst,
const MGLevelObject<BlockVector<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 MGDoFHandler<dim,spacedim>& mg_dof,
BlockVector<number2>& dst,
const MGLevelObject<BlockVector<number> > &src) const;
MGTransferBlockBase::memory_consumption;
private:
/**
* Optional multiplication
* factors for each
* block. Requires
* initialization of #memory.
*/
std::vector<number> factors;
/**
* Memory pool required if
* additional multiplication
* using #factors is desired.
*/
SmartPointer<VectorMemory<Vector<number> >,MGTransferBlock<number> > memory;
};
//TODO:[GK] Update documentation for copy_* functions
/**
* Implementation of the MGTransferBase interface for block matrices
* and simple vectors. This class uses MGTransferBlockBase selecting a
* single block. The intergrid transfer operators are implemented for
* Vector objects, The copy functions between regular and multigrid
* vectors for Vector and BlockVector.
*
* See MGTransferBase to find out which of the transfer classes
* is best for your needs.
*
* @author Guido Kanschat, 2001, 2002, 2003
*/
template <typename number>
class MGTransferBlockSelect : public MGTransferBase<Vector<number> >,
private MGTransferBlockBase
{
public:
/**
* Destructor.
*/
virtual ~MGTransferBlockSelect ();
/**
* Actually build the prolongation
* matrices for grouped blocks.
*
* This function is a front-end
* for the same function in
* MGTransferBlockBase.
*
* @arg selected: Number of the
* block of the global vector
* to be copied from and to the
* multilevel vector.
*
* @arg mg_selected: Number
* of the component for which the
* transfer matrices should be
* built.
*/
template<int dim, int spacedim>
void build_matrices (const DoFHandler<dim,spacedim> &dof,
const MGDoFHandler<dim,spacedim> &mg_dof,
unsigned int selected);
/**
* Change selected
* block. Handle with care!
*/
void select (const unsigned int block);
virtual void prolongate (const unsigned int to_level,
Vector<number> &dst,
const Vector<number> &src) const;
virtual void restrict_and_add (const unsigned int from_level,
Vector<number> &dst,
const Vector<number> &src) const;
/**
* Transfer a single block from a
* vector on the global grid to a
* multilevel vector.
*/
template <int dim, typename number2, int spacedim>
void
copy_to_mg (const MGDoFHandler<dim,spacedim> &mg_dof,
MGLevelObject<Vector<number> > &dst,
const Vector<number2> &src) const;
/**
* Transfer from multilevel vector to
* normal vector.
*
* Copies data from active
* portions of an multilevel
* vector into the respective
* positions of a Vector.
*/
template <int dim, typename number2, int spacedim>
void
copy_from_mg (const MGDoFHandler<dim,spacedim> &mg_dof,
Vector<number2> &dst,
const MGLevelObject<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 MGDoFHandler<dim,spacedim> &mg_dof,
Vector<number2> &dst,
const MGLevelObject<Vector<number> > &src) const;
/**
* Transfer a block from a vector
* on the global grid to
* multilevel vectors. Only the
* block selected is transfered.
*/
template <int dim, typename number2, int spacedim>
void
copy_to_mg (const MGDoFHandler<dim,spacedim> &mg_dof,
MGLevelObject<Vector<number> > &dst,
const BlockVector<number2> &src) const;
/**
* Transfer from multilevel vector to
* normal vector.
*
* Copies data from active
* portions of a multilevel
* vector into the respective
* positions of a global
* BlockVector.
*/
template <int dim, typename number2, int spacedim>
void
copy_from_mg (const MGDoFHandler<dim,spacedim> &mg_dof,
BlockVector<number2> &dst,
const MGLevelObject<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 MGDoFHandler<dim,spacedim> &mg_dof,
BlockVector<number2> &dst,
const MGLevelObject<Vector<number> > &src) const;
/**
* Memory used by this object.
*/
unsigned int memory_consumption () const;
private:
/**
* Implementation of the public
* function.
*/
template <int dim, class OutVector, int spacedim>
void
do_copy_from_mg (const MGDoFHandler<dim,spacedim> &mg_dof,
OutVector &dst,
const MGLevelObject<Vector<number> > &src,
const unsigned int offset) const;
/**
* Implementation of the public
* function.
*/
template <int dim, class OutVector, int spacedim>
void
do_copy_from_mg_add (const MGDoFHandler<dim,spacedim> &mg_dof,
OutVector &dst,
const MGLevelObject<Vector<number> > &src,
const unsigned int offset) const;
/**
* Actual implementation of
* copy_to_mg().
*/
template <int dim, class InVector, int spacedim>
void
do_copy_to_mg (const MGDoFHandler<dim,spacedim> &mg_dof,
MGLevelObject<Vector<number> > &dst,
const InVector &src,
const unsigned int offset) const;
/**
* Selected block.
*/
unsigned int selected_block;
};
/*@}*/
//---------------------------------------------------------------------------
template <typename number>
inline void
MGTransferBlockSelect<number>::select(const unsigned int block)
{
selected_block = block;
}
DEAL_II_NAMESPACE_CLOSE
#endif
|