/usr/include/deal.II/lac/block_sparse_matrix.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 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 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 | //---------------------------------------------------------------------------
// $Id: block_sparse_matrix.h 20934 2010-04-02 13:09:20Z bangerth $
// Version: $Name$
//
// Copyright (C) 2000, 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__block_sparse_matrix_h
#define __deal2__block_sparse_matrix_h
#include <base/config.h>
#include <base/table.h>
#include <lac/block_matrix_base.h>
#include <lac/block_vector.h>
#include <lac/sparse_matrix.h>
#include <lac/block_sparsity_pattern.h>
#include <lac/exceptions.h>
#include <cmath>
DEAL_II_NAMESPACE_OPEN
/*! @addtogroup Matrix1
*@{
*/
/**
* Blocked sparse matrix based on the SparseMatrix class. This class
* implements the functions that are specific to the SparseMatrix base objects
* for a blocked sparse matrix, and leaves the actual work relaying most of
* the calls to the individual blocks to the functions implemented in the base
* class. See there also for a description of when this class is useful.
*
* @see @ref GlossBlockLA "Block (linear algebra)"
* @author Wolfgang Bangerth, 2000, 2004
*/
template <typename number>
class BlockSparseMatrix : public BlockMatrixBase<SparseMatrix<number> >
{
public:
/**
* Typedef the base class for simpler
* access to its own typedefs.
*/
typedef BlockMatrixBase<SparseMatrix<number> > BaseClass;
/**
* Typedef the type of the underlying
* matrix.
*/
typedef typename BaseClass::BlockType BlockType;
/**
* Import the typedefs from the base
* class.
*/
typedef typename BaseClass::value_type value_type;
typedef typename BaseClass::pointer pointer;
typedef typename BaseClass::const_pointer const_pointer;
typedef typename BaseClass::reference reference;
typedef typename BaseClass::const_reference const_reference;
typedef typename BaseClass::size_type size_type;
typedef typename BaseClass::iterator iterator;
typedef typename BaseClass::const_iterator const_iterator;
/**
* Constructor; initializes the
* matrix to be empty, without
* any structure, i.e. the
* matrix is not usable at
* all. This constructor is
* therefore only useful for
* matrices which are members of
* a class. All other matrices
* should be created at a point
* in the data flow where all
* necessary information is
* available.
*
* You have to initialize the
* matrix before usage with
* reinit(BlockSparsityPattern). The
* number of blocks per row and
* column are then determined by
* that function.
*/
BlockSparseMatrix ();
/**
* Constructor. Takes the given
* matrix sparsity structure to
* represent the sparsity pattern
* of this matrix. You can change
* the sparsity pattern later on
* by calling the reinit()
* function.
*
* This constructor initializes
* all sub-matrices with the
* sub-sparsity pattern within
* the argument.
*
* You have to make sure that the
* lifetime of the sparsity
* structure is at least as long
* as that of this matrix or as
* long as reinit() is not called
* with a new sparsity structure.
*/
BlockSparseMatrix (const BlockSparsityPattern &sparsity);
/**
* Destructor.
*/
virtual ~BlockSparseMatrix ();
/**
* Pseudo copy operator only copying
* empty objects. The sizes of the block
* matrices need to be the same.
*/
BlockSparseMatrix &
operator = (const BlockSparseMatrix &);
/**
* This operator assigns a scalar to a
* matrix. Since this does usually not
* make much sense (should we set all
* matrix entries to this value? Only
* the nonzero entries of the sparsity
* pattern?), this operation is only
* allowed if the actual value to be
* assigned is zero. This operator only
* exists to allow for the obvious
* notation <tt>matrix=0</tt>, which
* sets all elements of the matrix to
* zero, but keep the sparsity pattern
* previously used.
*/
BlockSparseMatrix &
operator = (const double d);
/**
* Release all memory and return
* to a state just like after
* having called the default
* constructor. It also forgets
* the sparsity pattern it was
* previously tied to.
*
* This calls SparseMatrix::clear on all
* sub-matrices and then resets this
* object to have no blocks at all.
*/
void clear ();
/**
* Reinitialize the sparse matrix
* with the given sparsity
* pattern. The latter tells the
* matrix how many nonzero
* elements there need to be
* reserved.
*
* Basically, this function only
* calls SparseMatrix::reinit() of the
* sub-matrices with the block
* sparsity patterns of the
* parameter.
*
* The elements of the matrix are
* set to zero by this function.
*/
virtual void reinit (const BlockSparsityPattern &sparsity);
/**
* Return whether the object is
* empty. It is empty if either
* both dimensions are zero or no
* BlockSparsityPattern is
* associated.
*/
bool empty () const;
/**
* Return the number of nonzero
* elements of this
* matrix. Actually, it returns
* the number of entries in the
* sparsity pattern; if any of
* the entries should happen to
* be zero, it is counted anyway.
*/
unsigned int n_nonzero_elements () const;
/**
* Return the number of actually
* nonzero elements. Just counts the
* number of actually nonzero elements
* (with absolute value larger than
* threshold) of all the blocks.
*/
unsigned int n_actually_nonzero_elements (const double threshold = 0.0) const;
/**
* Matrix-vector multiplication:
* let $dst = M*src$ with $M$
* being this matrix.
*/
template <typename block_number>
void vmult (BlockVector<block_number> &dst,
const BlockVector<block_number> &src) const;
/**
* Matrix-vector
* multiplication. Just like the
* previous function, but only
* applicable if the matrix has
* only one block column.
*/
template <typename block_number,
typename nonblock_number>
void vmult (BlockVector<block_number> &dst,
const Vector<nonblock_number> &src) const;
/**
* Matrix-vector
* multiplication. Just like the
* previous function, but only
* applicable if the matrix has
* only one block row.
*/
template <typename block_number,
typename nonblock_number>
void vmult (Vector<nonblock_number> &dst,
const BlockVector<block_number> &src) const;
/**
* Matrix-vector
* multiplication. Just like the
* previous function, but only
* applicable if the matrix has
* only one block.
*/
template <typename nonblock_number>
void vmult (Vector<nonblock_number> &dst,
const Vector<nonblock_number> &src) const;
/**
* Matrix-vector multiplication:
* let $dst = M^T*src$ with $M$
* being this matrix. This
* function does the same as
* vmult() but takes the
* transposed matrix.
*/
template <typename block_number>
void Tvmult (BlockVector<block_number> &dst,
const BlockVector<block_number> &src) const;
/**
* Matrix-vector
* multiplication. Just like the
* previous function, but only
* applicable if the matrix has
* only one block row.
*/
template <typename block_number,
typename nonblock_number>
void Tvmult (BlockVector<block_number> &dst,
const Vector<nonblock_number> &src) const;
/**
* Matrix-vector
* multiplication. Just like the
* previous function, but only
* applicable if the matrix has
* only one block column.
*/
template <typename block_number,
typename nonblock_number>
void Tvmult (Vector<nonblock_number> &dst,
const BlockVector<block_number> &src) const;
/**
* Matrix-vector
* multiplication. Just like the
* previous function, but only
* applicable if the matrix has
* only one block.
*/
template <typename nonblock_number>
void Tvmult (Vector<nonblock_number> &dst,
const Vector<nonblock_number> &src) const;
/**
* Apply the Jacobi
* preconditioner, which
* multiplies every element of
* the <tt>src</tt> vector by the
* inverse of the respective
* diagonal element and
* multiplies the result with the
* relaxation parameter
* <tt>omega</tt>.
*
* All diagonal blocks must be
* square matrices for this
* operation.
*/
template <class BlockVectorType>
void precondition_Jacobi (BlockVectorType &dst,
const BlockVectorType &src,
const number omega = 1.) const;
/**
* Apply the Jacobi
* preconditioner to a simple vector.
*
* The matrix must be a single
* square block for this.
*/
template <typename number2>
void precondition_Jacobi (Vector<number2> &dst,
const Vector<number2> &src,
const number omega = 1.) const;
/**
* Print the matrix in the usual
* format, i.e. as a matrix and
* not as a list of nonzero
* elements. For better
* readability, elements not in
* the matrix are displayed as
* empty space, while matrix
* elements which are explicitly
* set to zero are displayed as
* such.
*
* The parameters allow for a
* flexible setting of the output
* format: <tt>precision</tt> and
* <tt>scientific</tt> are used
* to determine the number
* format, where <tt>scientific =
* false</tt> means fixed point
* notation. A zero entry for
* <tt>width</tt> makes the
* function compute a width, but
* it may be changed to a
* positive value, if output is
* crude.
*
* Additionally, a character for
* an empty value may be
* specified.
*
* Finally, the whole matrix can
* be multiplied with a common
* denominator to produce more
* readable output, even
* integers.
*
* @attention This function may
* produce <b>large</b> amounts
* of output if applied to a
* large matrix!
*/
void print_formatted (std::ostream &out,
const unsigned int precision = 3,
const bool scientific = true,
const unsigned int width = 0,
const char *zero_string = " ",
const double denominator = 1.) const;
/**
* Return a (constant) reference
* to the underlying sparsity
* pattern of this matrix.
*
* Though the return value is
* declared <tt>const</tt>, you
* should be aware that it may
* change if you call any
* nonconstant function of
* objects which operate on it.
*/
const BlockSparsityPattern &
get_sparsity_pattern () const;
/**
* Determine an estimate for the
* memory consumption (in bytes)
* of this object.
*/
unsigned int memory_consumption () const;
/** @addtogroup Exceptions
* @{ */
/**
* Exception
*/
DeclException0 (ExcBlockDimensionMismatch);
//@}
private:
/**
* Pointer to the block sparsity
* pattern used for this
* matrix. In order to guarantee
* that it is not deleted while
* still in use, we subscribe to
* it using the SmartPointer
* class.
*/
SmartPointer<const BlockSparsityPattern,BlockSparseMatrix<number> > sparsity_pattern;
};
/*@}*/
/* ------------------------- Template functions ---------------------- */
template <typename number>
inline
BlockSparseMatrix<number> &
BlockSparseMatrix<number>::operator = (const double d)
{
Assert (d==0, ExcScalarAssignmentOnlyForZeroValue());
for (unsigned int r=0; r<this->n_block_rows(); ++r)
for (unsigned int c=0; c<this->n_block_cols(); ++c)
this->block(r,c) = d;
return *this;
}
template <typename number>
template <typename block_number>
inline
void
BlockSparseMatrix<number>::vmult (BlockVector<block_number> &dst,
const BlockVector<block_number> &src) const
{
BaseClass::vmult_block_block (dst, src);
}
template <typename number>
template <typename block_number,
typename nonblock_number>
inline
void
BlockSparseMatrix<number>::vmult (BlockVector<block_number> &dst,
const Vector<nonblock_number> &src) const
{
BaseClass::vmult_block_nonblock (dst, src);
}
template <typename number>
template <typename block_number,
typename nonblock_number>
inline
void
BlockSparseMatrix<number>::vmult (Vector<nonblock_number> &dst,
const BlockVector<block_number> &src) const
{
BaseClass::vmult_nonblock_block (dst, src);
}
template <typename number>
template <typename nonblock_number>
inline
void
BlockSparseMatrix<number>::vmult (Vector<nonblock_number> &dst,
const Vector<nonblock_number> &src) const
{
BaseClass::vmult_nonblock_nonblock (dst, src);
}
template <typename number>
template <typename block_number>
inline
void
BlockSparseMatrix<number>::Tvmult (BlockVector<block_number> &dst,
const BlockVector<block_number> &src) const
{
BaseClass::Tvmult_block_block (dst, src);
}
template <typename number>
template <typename block_number,
typename nonblock_number>
inline
void
BlockSparseMatrix<number>::Tvmult (BlockVector<block_number> &dst,
const Vector<nonblock_number> &src) const
{
BaseClass::Tvmult_block_nonblock (dst, src);
}
template <typename number>
template <typename block_number,
typename nonblock_number>
inline
void
BlockSparseMatrix<number>::Tvmult (Vector<nonblock_number> &dst,
const BlockVector<block_number> &src) const
{
BaseClass::Tvmult_nonblock_block (dst, src);
}
template <typename number>
template <typename nonblock_number>
inline
void
BlockSparseMatrix<number>::Tvmult (Vector<nonblock_number> &dst,
const Vector<nonblock_number> &src) const
{
BaseClass::Tvmult_nonblock_nonblock (dst, src);
}
template <typename number>
template <class BlockVectorType>
inline
void
BlockSparseMatrix<number>::
precondition_Jacobi (BlockVectorType &dst,
const BlockVectorType &src,
const number omega) const
{
Assert (this->n_block_rows() == this->n_block_cols(), ExcNotQuadratic());
Assert (dst.n_blocks() == this->n_block_rows(),
ExcDimensionMismatch(dst.n_blocks(), this->n_block_rows()));
Assert (src.n_blocks() == this->n_block_cols(),
ExcDimensionMismatch(src.n_blocks(), this->n_block_cols()));
// do a diagonal preconditioning. uses only
// the diagonal blocks of the matrix
for (unsigned int i=0; i<this->n_block_rows(); ++i)
this->block(i,i).precondition_Jacobi (dst.block(i),
src.block(i),
omega);
}
template <typename number>
template <typename number2>
inline
void
BlockSparseMatrix<number>::
precondition_Jacobi (Vector<number2> &dst,
const Vector<number2> &src,
const number omega) const
{
// check number of blocks. the sizes of the
// single block is checked in the function
// we call
Assert (this->n_block_cols() == 1,
ExcMessage ("This function only works if the matrix has "
"a single block"));
Assert (this->n_block_rows() == 1,
ExcMessage ("This function only works if the matrix has "
"a single block"));
// do a diagonal preconditioning. uses only
// the diagonal blocks of the matrix
this->block(0,0).precondition_Jacobi (dst, src, omega);
}
DEAL_II_NAMESPACE_CLOSE
#endif // __deal2__block_sparse_matrix_h
|