Reference documentation for deal.II version 9.1.1
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Private Attributes | List of all members
MeshWorker::LocalResults< number > Class Template Reference

#include <deal.II/meshworker/local_results.h>

Inheritance diagram for MeshWorker::LocalResults< number >:
[legend]

Public Member Functions

unsigned int n_values () const
 
unsigned int n_vectors () const
 
unsigned int n_matrices () const
 
unsigned int n_quadrature_points () const
 
unsigned int n_quadrature_values () const
 
number & value (unsigned int i)
 
number value (unsigned int i) const
 
BlockVector< number > & vector (unsigned int i)
 
const BlockVector< number > & vector (unsigned int i) const
 
MatrixBlock< FullMatrix< number > > & matrix (unsigned int i, bool external=false)
 
const MatrixBlock< FullMatrix< number > > & matrix (unsigned int i, bool external=false) const
 
Table< 2, number > & quadrature_values ()
 
number & quadrature_value (unsigned int k, unsigned int i)
 
number quadrature_value (unsigned int k, unsigned int i) const
 
void initialize_numbers (const unsigned int n)
 
void initialize_vectors (const unsigned int n)
 
void initialize_matrices (unsigned int n, bool both)
 
template<typename MatrixType >
void initialize_matrices (const MatrixBlockVector< MatrixType > &matrices, bool both)
 
template<typename MatrixType >
void initialize_matrices (const MGMatrixBlockVector< MatrixType > &matrices, bool both)
 
void initialize_quadrature (unsigned int np, unsigned int nv)
 
void reinit (const BlockIndices &local_sizes)
 
std::size_t memory_consumption () const
 

Private Attributes

std::vector< number > J
 
std::vector< BlockVector< number > > R
 
std::vector< MatrixBlock< FullMatrix< number > > > M1
 
std::vector< MatrixBlock< FullMatrix< number > > > M2
 
Table< 2, number > quadrature_data
 

Detailed Description

template<typename number>
class MeshWorker::LocalResults< number >

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 Assembler 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 assemblers using them:

  1. n_values() numbers accessed with value(), and stored in the data member J.

  2. n_vectors() vectors of the length of dofs on this cell, accessed by vector(), and stored in R.
  3. n_matrices() matrices of dimension dofs per cell in each direction, accessed by matrix() with second argument false. 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 true.

The local matrices initialized by reinit() of the info object and then assembled into the global system by Assembler classes.

Author
Guido Kanschat, 2009

Definition at line 211 of file local_results.h.

Member Function Documentation

◆ n_values()

template<typename number >
unsigned int MeshWorker::LocalResults< number >::n_values ( ) const
inline

The number of scalar values.

This number is set to a nonzero value by Assembler::CellsAndFaces

Definition at line 519 of file local_results.h.

◆ n_vectors()

template<typename number >
unsigned int MeshWorker::LocalResults< number >::n_vectors ( ) const
inline

The number of vectors.

This number is set to a nonzero value by Assembler::ResidualSimple and Assembler::ResidualLocalBlocksToGlobalBlocks.

Definition at line 527 of file local_results.h.

◆ n_matrices()

template<typename number >
unsigned int MeshWorker::LocalResults< number >::n_matrices ( ) const
inline

The number of matrices.

Definition at line 535 of file local_results.h.

◆ n_quadrature_points()

template<typename number >
unsigned int MeshWorker::LocalResults< number >::n_quadrature_points ( ) const
inline

The number of quadrature points in quadrature_values().

Definition at line 543 of file local_results.h.

◆ n_quadrature_values()

template<typename number >
unsigned int MeshWorker::LocalResults< number >::n_quadrature_values ( ) const
inline

The number of values in each quadrature point in quadrature_values().

Definition at line 551 of file local_results.h.

◆ value() [1/2]

template<typename number >
number & MeshWorker::LocalResults< number >::value ( unsigned int  i)
inline

Access scalar value at index i.

Definition at line 559 of file local_results.h.

◆ value() [2/2]

template<typename number >
number MeshWorker::LocalResults< number >::value ( unsigned int  i) const
inline

Read scalar value at index i.

Definition at line 607 of file local_results.h.

◆ vector() [1/2]

template<typename number >
BlockVector< number > & MeshWorker::LocalResults< number >::vector ( unsigned int  i)
inline

Access vector at index i.

Definition at line 568 of file local_results.h.

◆ vector() [2/2]

template<typename number >
const BlockVector< number > & MeshWorker::LocalResults< number >::vector ( unsigned int  i) const
inline

Read vector at index i.

Definition at line 616 of file local_results.h.

◆ matrix() [1/2]

template<typename number >
MatrixBlock< FullMatrix< number > > & MeshWorker::LocalResults< number >::matrix ( unsigned int  i,
bool  external = false 
)
inline

Access matrix at index i. For results on internal faces, a true value for external refers to the flux between cells, while false refers to entries coupling inside the cell.

Definition at line 577 of file local_results.h.

◆ matrix() [2/2]

template<typename number >
const MatrixBlock< FullMatrix< number > > & MeshWorker::LocalResults< number >::matrix ( unsigned int  i,
bool  external = false 
) const
inline

Read matrix at index i. For results on internal faces, a true value for external refers to the flux between cells, while false refers to entries coupling inside the cell.

Definition at line 625 of file local_results.h.

◆ quadrature_values()

template<typename number >
Table< 2, number > & MeshWorker::LocalResults< number >::quadrature_values ( )
inline

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.

Definition at line 599 of file local_results.h.

◆ quadrature_value() [1/2]

template<typename number >
number & MeshWorker::LocalResults< number >::quadrature_value ( unsigned int  k,
unsigned int  i 
)
inline

Access the ith value at quadrature point k

Definition at line 591 of file local_results.h.

◆ quadrature_value() [2/2]

template<typename number >
number MeshWorker::LocalResults< number >::quadrature_value ( unsigned int  k,
unsigned int  i 
) const
inline

Read the ith value at quadrature point k

Definition at line 639 of file local_results.h.

◆ initialize_numbers()

template<typename number >
void MeshWorker::LocalResults< number >::initialize_numbers ( const unsigned int  n)
inline

Initialize the vector with scalar values.

Note
This function is usually only called by the assembler.

Definition at line 421 of file local_results.h.

◆ initialize_vectors()

template<typename number >
void MeshWorker::LocalResults< number >::initialize_vectors ( const unsigned int  n)
inline

Initialize the vector with vector values.

Note
This function is usually only called by the assembler.

Definition at line 429 of file local_results.h.

◆ initialize_matrices() [1/3]

template<typename number >
void MeshWorker::LocalResults< number >::initialize_matrices ( unsigned int  n,
bool  both 
)
inline

Allocate 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.

Definition at line 490 of file local_results.h.

◆ initialize_matrices() [2/3]

template<typename number >
template<typename MatrixType >
void MeshWorker::LocalResults< number >::initialize_matrices ( const MatrixBlockVector< MatrixType > &  matrices,
bool  both 
)
inline

Allocate a local matrix for each of the global ones in 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.

Definition at line 438 of file local_results.h.

◆ initialize_matrices() [3/3]

template<typename number >
template<typename MatrixType >
void MeshWorker::LocalResults< number >::initialize_matrices ( const MGMatrixBlockVector< MatrixType > &  matrices,
bool  both 
)
inline

Allocate a local matrix for each of the global level objects in 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.

Definition at line 464 of file local_results.h.

◆ initialize_quadrature()

template<typename number >
void MeshWorker::LocalResults< number >::initialize_quadrature ( unsigned int  np,
unsigned int  nv 
)
inline

Initialize quadrature values to nv values in np quadrature points.

Definition at line 511 of file local_results.h.

◆ reinit()

template<typename number >
void MeshWorker::LocalResults< number >::reinit ( const BlockIndices local_sizes)

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.

Definition at line 28 of file mesh_worker.cc.

◆ memory_consumption()

template<typename number >
std::size_t MeshWorker::LocalResults< number >::memory_consumption ( ) const

The memory used by this object.

Definition at line 46 of file mesh_worker.cc.

Member Data Documentation

◆ J

template<typename number>
std::vector<number> MeshWorker::LocalResults< number >::J
private

The local numbers, computed on a cell or on a face.

Definition at line 389 of file local_results.h.

◆ R

template<typename number>
std::vector<BlockVector<number> > MeshWorker::LocalResults< number >::R
private

The local vectors. This field is public, so that local integrators can write to it.

Definition at line 395 of file local_results.h.

◆ M1

template<typename number>
std::vector<MatrixBlock<FullMatrix<number> > > MeshWorker::LocalResults< number >::M1
private

The local matrices coupling degrees of freedom in the cell itself or within the first cell on a face.

Definition at line 401 of file local_results.h.

◆ M2

template<typename number>
std::vector<MatrixBlock<FullMatrix<number> > > MeshWorker::LocalResults< number >::M2
private

The local matrices coupling test functions on the cell with trial functions on the other cell.

Only used on interior faces.

Definition at line 409 of file local_results.h.

◆ quadrature_data

template<typename number>
Table<2, number> MeshWorker::LocalResults< number >::quadrature_data
private

Values in quadrature points for writing into patch data.

Definition at line 414 of file local_results.h.


The documentation for this class was generated from the following files: