/usr/include/deal.II/meshworker/local_results.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 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 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 | // ---------------------------------------------------------------------
//
// Copyright (C) 2006 - 2015 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__mesh_worker_local_results_h
#define dealii__mesh_worker_local_results_h
#include <deal.II/base/config.h>
#include <deal.II/base/std_cxx11/function.h>
#include <deal.II/base/geometry_info.h>
#include <deal.II/lac/matrix_block.h>
#include <deal.II/lac/block_vector.h>
#include <deal.II/meshworker/vector_selector.h>
DEAL_II_NAMESPACE_OPEN
class BlockIndices;
template<int,int> class DoFHandler;
/**
* A collection of functions and classes for the mesh loops that are an
* ubiquitous part of each finite element program.
*
* The workhorse of this namespace is the loop() function, which implements a
* completely generic loop over all mesh cells. Since the calls to loop() are
* error-prone due to its generality, for many applications it is advisable to
* derive a class from MeshWorker::LocalIntegrator and use the less general
* integration_loop() instead.
*
* The loop() depends on certain objects handed to it as arguments. These
* objects are of two types, info objects like DoFInfo and IntegrationInfo and
* worker objects like LocalWorker and IntegrationWorker.
*
* Worker objects usually do two different jobs: first, they compute the local
* contribution of a cell or face to the global operation. Second, they
* assemble this local contribution into the global result, whether a
* functional, a form or a bilinear form. While the first job is particular to
* the problem being solved, the second is generic and only depends on the
* data structures. Therefore, base classes for workers assembling into global
* data are provided in the namespace Assembler.
*
* <h3>Template argument types</h3>
*
* The functions loop() and cell_action() take some arguments which are
* template parameters. Let us list the minimum requirements for these classes
* here and describe their properties.
*
* <h4>ITERATOR</h4>
*
* Any object that has an <tt>operator++()</tt> and points to a
* TriaObjectAccessor.
*
* <h4>DOFINFO</h4>
*
* For an example implementation, refer to the class template DoFInfo. In
* order to work with cell_action() and loop(), DOFINFO needs to follow the
* following interface.
* @code
* class DOFINFO
* {
* private:
* DOFINFO();
* DOFINFO(const DOFINFO&);
* DOFINFO& operator=(const DOFINFO&);
*
* public:
* template <class CellIt>
* void reinit(const CellIt& c);
*
* template <class CellIt, class FaceIt>
* void reinit(const CellIt& c, const FaceIt& f, unsigned int n);
*
* template <class CellIt, class FaceIt>
* void reinit(const CellIt& c, const FaceIt& f, unsigned int n,
* unsigned int s);
*
* friend template class DoFInfoBox<int dim, DOFINFO>;
* };
* @endcode
*
* The three private functions are called by DoFInfoBox and should not be
* needed elsewhere. Obviously, they can be made public and then the friend
* declaration at the end may be missing.
*
* Additionally, you will need at least one public constructor. Furthermore
* DOFINFO is pretty useless yet: functions to interface with INTEGRATIONINFO
* and ASSEMBLER are needed.
*
* DOFINFO objects are gathered in a DoFInfoBox. In those objects, we store
* the results of local operations on each cell and its faces. Once all this
* information has been gathered, an ASSEMBLER is used to assemble it into
* golbal data.
*
* <h4>INFOBOX</h4>
*
* This type is exemplified in IntegrationInfoBox. It collects the input data
* for actions on cells and faces in INFO objects (see below). It provides the
* following interface to loop() and cell_action():
*
* @code
* class INFOBOX
* {
* public:
* template <int dim, class DOFINFO>
* void post_cell(const DoFInfoBox<dim, DOFINFO>&);
*
* template <int dim, class DOFINFO>
* void post_faces(const DoFInfoBox<dim, DOFINFO>&);
*
* INFO cell;
* INFO boundary;
* INFO face;
* INFO subface;
* INFO neighbor;
* };
* @endcode
*
* The main purpose of this class is gathering the five INFO objects, which
* contain the temporary data used on each cell or face. The requirements on
* these objects are listed below. Here, we only note that there need to be
* these 5 objects with the names listed above.
*
* The two function templates are call back functions called in cell_action().
* The first is called before the faces are worked on, the second after the
* faces.
*
* <h4>INFO</h4>
*
* See IntegrationInfo for an example of these objects. They contain the
* temporary data needed on each cell or face to compute the result. The
* MeshWorker only uses the interface
*
* @code
* class INFO
* {
* public:
* void reinit(const DOFINFO& i);
* };
* @endcode
*
* <h3>Simplified interfaces</h3>
*
* Since the loop() is fairly general, a specialization integration_loop() is
* available, which is a wrapper around loop() with a simplified interface.
*
* The integration_loop() function loop takes most of the information that it
* needs to pass to loop() from an IntegrationInfoBox object. Its use is
* explained in step-12, but in short it requires functions that do the local
* integration on a cell, interior or boundary face, and it needs an object
* (called "assembler") that copies these local contributions into the global
* matrix and right hand side objects.
*
* Before we can run the integration loop, we have to initialize several data
* structures in our IntegrationWorker and assembler objects. For instance, we
* have to decide on the quadrature rule or we may need more than the default
* update flags.
*
* @ingroup MeshWorker
* @ingroup Integrators
* @author Guido Kanschat
* @date 2009
*/
namespace MeshWorker
{
/**
* The class providing the scrapbook to fill with results of local
* integration. Depending on the task the mesh worker loop is performing,
* local results can be of different types. They have in common that they
* are the result of local integration over a cell or face. Their actual
* type is determined by the Assember using them. It is also the assembler
* setting the arrays of local results to the sizes needed. Here is a list
* of the provided data types and the assembers using them:
*
* <ol>
* <li> n_values() numbers accessed with value(), and stored in the data
* member #J.
*
* <li> n_vectors() vectors of the length of dofs on this cell, accessed by
* vector(), and stored in #R.
* <li> n_matrices() matrices of dimension dofs per cell in each direction,
* accessed by matrix() with second argument <tt>false</tt>. These are
* stored in #M1, and they are the matrices coupling degrees of freedom in
* the same cell. For fluxes across faces, there is an additional set #M2 of
* matrices of the same size, but the dimension of the matrices being
* according to the degrees of freedom on both cells. These are accessed
* with matrix(), using the second argument <tt>true</tt>.
* </ol>
*
* The local matrices initialized by reinit() of the info object and then
* assembled into the global system by Assembler classes.
*
* @ingroup MeshWorker
* @author Guido Kanschat, 2009
*/
template <typename number>
class LocalResults
{
public:
/**
* The number of scalar values.
*
* This number is set to a nonzero value by Assember::CellsAndFaces
*
*/
unsigned int n_values () const;
/**
* The number of vectors.
*
* This number is set to a nonzero value by Assember::ResidualSimple and
* Assember::ResidualLocalBlocksToGlobalBlocks.
*/
unsigned int n_vectors () const;
/**
* The number of matrices.
*/
unsigned int n_matrices () const;
/**
* The number of quadrature points in quadrature_values().
*/
unsigned int n_quadrature_points() const;
/**
* The number of values in each quadrature point in quadrature_values().
*/
unsigned int n_quadrature_values() const;
/**
* Access scalar value at index @p i.
*/
number &value(unsigned int i);
/**
* Read scalar value at index @p i.
*/
number value(unsigned int i) const;
/**
* Access vector at index @p i.
*/
BlockVector<number> &vector(unsigned int i);
/**
* Read vector at index @p i.
*/
const BlockVector<number> &vector(unsigned int i) const;
/**
* Access matrix at index @p i. For results on internal faces, a true
* value for @p external refers to the flux between cells, while false
* refers to entries coupling inside the cell.
*/
MatrixBlock<FullMatrix<number> > &matrix(unsigned int i, bool external = false);
/**
* Read matrix at index @p i. For results on internal faces, a true value
* for @p external refers to the flux between cells, while false refers to
* entries coupling inside the cell.
*/
const MatrixBlock<FullMatrix<number> > &matrix(unsigned int i, bool external = false) const;
/**
* Access to the vector #quadrature_data of data in quadrature points,
* organized such that there is a vector for each point, containing one
* entry for each component.
*/
Table<2, number> &quadrature_values();
/**
* Access the <i>i</i>th value at quadrature point <i>k</i>
*/
number &quadrature_value(unsigned int k, unsigned int i);
/**
* Read the <i>i</i>th value at quadrature point <i>k</i>
*/
number quadrature_value(unsigned int k, unsigned int i) const;
/**
* Initialize the vector with scalar values.
*
* @note This function is usually only called by the assembler.
*/
void initialize_numbers(const unsigned int n);
/**
* Initialize the vector with vector values.
*
* @note This function is usually only called by the assembler.
*/
void initialize_vectors(const unsigned int n);
/**
* Allocate @p n local matrices. Additionally, set their block row and
* column coordinates to zero. The matrices themselves are resized by
* reinit().
*
* @note This function is usually only called by the assembler.
*/
void initialize_matrices(unsigned int n, bool both);
/**
* Allocate a local matrix for each of the global ones in @p matrices.
* Additionally, set their block row and column coordinates. The matrices
* themselves are resized by reinit().
*
* @note This function is usually only called by the assembler.
*/
template <typename MatrixType>
void initialize_matrices(const MatrixBlockVector<MatrixType> &matrices,
bool both);
/**
* Allocate a local matrix for each of the global level objects in @p
* matrices. Additionally, set their block row and column coordinates. The
* matrices themselves are resized by reinit().
*
* @note This function is usually only called by the assembler.
*/
template <typename MatrixType>
void initialize_matrices(const MGMatrixBlockVector<MatrixType> &matrices,
bool both);
/**
* Initialize quadrature values to <tt>nv</tt> values in <tt>np</tt>
* quadrature points.
*/
void initialize_quadrature(unsigned int np, unsigned int nv);
/**
* Reinitialize matrices for new cell. Does not resize any of the data
* vectors stored in this object, but resizes the vectors in #R and the
* matrices in #M1 and #M2 for hp and sets them to zero.
*/
void reinit(const BlockIndices &local_sizes);
template <class StreamType>
void print_debug(StreamType &os) const;
/**
* The memory used by this object.
*/
std::size_t memory_consumption () const;
private:
/**
* Initialize a single local matrix block. A helper function for
* initialize()
*/
void initialize_local(MatrixBlock<FullMatrix<number> > &M,
const unsigned int row,
const unsigned int col);
/**
* The local numbers, computed on a cell or on a face.
*/
std::vector<number> J;
/**
* The local vectors. This field is public, so that local integrators can
* write to it.
*/
std::vector<BlockVector<number> > R;
/**
* The local matrices coupling degrees of freedom in the cell itself or
* within the first cell on a face.
*/
std::vector<MatrixBlock<FullMatrix<number> > > M1;
/**
* The local matrices coupling test functions on the cell with trial
* functions on the other cell.
*
* Only used on interior faces.
*/
std::vector<MatrixBlock<FullMatrix<number> > > M2;
/**
* Values in quadrature points for writing into patch data.
*/
Table<2, number> quadrature_data;
};
//----------------------------------------------------------------------//
template <typename number>
inline void
LocalResults<number>::initialize_numbers(unsigned int n)
{
J.resize(n);
}
template <typename number>
inline void
LocalResults<number>::initialize_vectors(const unsigned int n)
{
R.resize(n);
}
template <typename number>
template <typename MatrixType>
inline void
LocalResults<number>::initialize_matrices
(const MatrixBlockVector<MatrixType> &matrices,
bool both)
{
M1.resize(matrices.size());
if (both)
M2.resize(matrices.size());
for (unsigned int i=0; i<matrices.size(); ++i)
{
const unsigned int row = matrices.block(i).row;
const unsigned int col = matrices.block(i).column;
M1[i].row = row;
M1[i].column = col;
if (both)
{
M2[i].row = row;
M2[i].column = col;
}
}
}
template <typename number>
template <typename MatrixType>
inline void
LocalResults<number>::initialize_matrices
(const MGMatrixBlockVector<MatrixType> &matrices,
bool both)
{
M1.resize(matrices.size());
if (both)
M2.resize(matrices.size());
for (unsigned int i=0; i<matrices.size(); ++i)
{
const MGLevelObject<MatrixBlock<MatrixType> > &o = matrices.block(i);
const unsigned int row = o[o.min_level()].row;
const unsigned int col = o[o.min_level()].column;
M1[i].row = row;
M1[i].column = col;
if (both)
{
M2[i].row = row;
M2[i].column = col;
}
}
}
template <typename number>
inline void
LocalResults<number>::initialize_matrices(const unsigned int n,
const bool both)
{
M1.resize(n);
if (both)
M2.resize(n);
for (unsigned int i=0; i<n; ++i)
{
M1[i].row = 0;
M1[i].column = 0;
if (both)
{
M2[i].row = 0;
M2[i].column = 0;
}
}
}
template <typename number>
inline void
LocalResults<number>::initialize_quadrature(unsigned int np, unsigned int nv)
{
quadrature_data.reinit(np, nv);
}
template <typename number>
inline
unsigned int
LocalResults<number>::n_values() const
{
return J.size();
}
template <typename number>
inline
unsigned int
LocalResults<number>::n_vectors() const
{
return R.size();
}
template <typename number>
inline
unsigned int
LocalResults<number>::n_matrices() const
{
return M1.size();
}
template <typename number>
inline
unsigned int
LocalResults<number>::n_quadrature_points() const
{
return quadrature_data.n_rows();
}
template <typename number>
inline
unsigned int
LocalResults<number>::n_quadrature_values() const
{
return quadrature_data.n_cols();
}
template <typename number>
inline
number &
LocalResults<number>::value(unsigned int i)
{
AssertIndexRange(i,J.size());
return J[i];
}
template <typename number>
inline
BlockVector<number> &
LocalResults<number>::vector(unsigned int i)
{
AssertIndexRange(i,R.size());
return R[i];
}
template <typename number>
inline
MatrixBlock<FullMatrix<number> > &
LocalResults<number>::matrix(unsigned int i, bool external)
{
if (external)
{
AssertIndexRange(i,M2.size());
return M2[i];
}
AssertIndexRange(i,M1.size());
return M1[i];
}
template <typename number>
inline
number &
LocalResults<number>::quadrature_value(unsigned int k, unsigned int i)
{
return quadrature_data(k,i);
}
template <typename number>
inline
Table<2, number> &
LocalResults<number>::quadrature_values()
{
return quadrature_data;
}
template <typename number>
inline
number
LocalResults<number>::value(unsigned int i) const
{
AssertIndexRange(i,J.size());
return J[i];
}
template <typename number>
inline
const BlockVector<number> &
LocalResults<number>::vector(unsigned int i) const
{
AssertIndexRange(i,R.size());
return R[i];
}
template <typename number>
inline
const MatrixBlock<FullMatrix<number> > &
LocalResults<number>::matrix(unsigned int i, bool external) const
{
if (external)
{
AssertIndexRange(i,M2.size());
return M2[i];
}
AssertIndexRange(i,M1.size());
return M1[i];
}
template <typename number>
inline
number
LocalResults<number>::quadrature_value(unsigned int k, unsigned int i) const
{
return quadrature_data(k,i);
}
template <typename number>
template <class StreamType>
void
LocalResults<number>::print_debug(StreamType &os) const
{
os << "J: " << J.size() << std::endl;
os << "R: " << R.size() << std::endl;
for (unsigned int i=0; i<R.size(); ++i)
{
os << " " << R[i].n_blocks() << " -";
for (unsigned int j=0; j<R[i].n_blocks(); ++j)
os << ' ' << R[i].block(j).size();
os << std::endl;
}
os << "M: " << M1.size() << " face " << M2.size() << std::endl;
for (unsigned int i=0; i<M1.size(); ++i)
{
os << " " << M1[i].row << "," << M1[i].column
<< " " << M1[i].matrix.m() << 'x' << M1[i].matrix.n();
if (i < M2.size())
os << " face " << M2[i].row << "," << M2[i].column
<< " " << M2[i].matrix.m() << 'x' << M2[i].matrix.n();
os << std::endl;
}
}
}
DEAL_II_NAMESPACE_CLOSE
#endif
|