Reference documentation for deal.II version 9.2.0
|
#include <deal.II/lac/tensor_product_matrix.h>
Public Types | |
using | value_type = Number |
Public Member Functions | |
unsigned int | m () const |
unsigned int | n () const |
void | vmult (const ArrayView< Number > &dst, const ArrayView< const Number > &src) const |
void | apply_inverse (const ArrayView< Number > &dst, const ArrayView< const Number > &src) const |
Static Public Attributes | |
static constexpr int | n_rows_1d_static = n_rows_1d |
Protected Member Functions | |
TensorProductMatrixSymmetricSumBase ()=default | |
Protected Attributes | |
std::array< Table< 2, Number >, dim > | mass_matrix |
std::array< Table< 2, Number >, dim > | derivative_matrix |
std::array< AlignedVector< Number >, dim > | eigenvalues |
std::array< Table< 2, Number >, dim > | eigenvectors |
Private Attributes | |
AlignedVector< Number > | tmp_array |
Threads::Mutex | mutex |
This is an abstract base class used for a special matrix class, namely the TensorProductMatrixSymmetricSum.
First, the base class acts like a container storing 1D mass matrices and 1D derivative matrices as well as the generalized eigenvalues and eigenvectors for each tensor direction. For a detailed definition of these matrices and corresponding generalized eigenproblems we refer to the main documentation of TensorProductMatrixSymmetricSum.
Second, it implements the matrix-vector product with the tensor product matrix (vmult()) and its inverse (apply_inverse()) as described in the main documentation of TensorProductMatrixSymmetricSum.
dim | Dimension of the problem. Currently, 1D, 2D, and 3D codes are implemented. |
Number | Arithmetic type of the underlying array elements. |
n_rows_1d | Compile-time number of rows of 1D matrices (only valid if the number of rows and columns coincide for each dimension). By default at -1, which means that the number of rows is determined at run-time by means of the matrices passed to the reinit() function. |
Definition at line 76 of file tensor_product_matrix.h.
using TensorProductMatrixSymmetricSumBase< dim, Number, n_rows_1d >::value_type = Number |
Type of matrix entries. This alias is analogous to value_type
in the standard library containers.
Definition at line 83 of file tensor_product_matrix.h.
|
protecteddefault |
Default constructor.
unsigned int TensorProductMatrixSymmetricSumBase< dim, Number, n_rows_1d >::m | ( | ) | const |
Return the number of rows of the tensor product matrix resulting from the Kronecker product of 1D matrices, which is described in the main documentation of TensorProductMatrixSymmetricSum.
unsigned int TensorProductMatrixSymmetricSumBase< dim, Number, n_rows_1d >::n | ( | ) | const |
Return the number of columns of the tensor product matrix resulting from the Kronecker product of 1D matrices, which is described in the main documentation of TensorProductMatrixSymmetricSum.
void TensorProductMatrixSymmetricSumBase< dim, Number, n_rows_1d >::vmult | ( | const ArrayView< Number > & | dst, |
const ArrayView< const Number > & | src | ||
) | const |
Implements a matrix-vector product with the underlying matrix as described in the main documentation of TensorProductMatrixSymmetricSum. This function is operating on ArrayView to allow checks of array bounds with respect to dst
and src
.
void TensorProductMatrixSymmetricSumBase< dim, Number, n_rows_1d >::apply_inverse | ( | const ArrayView< Number > & | dst, |
const ArrayView< const Number > & | src | ||
) | const |
Implements a matrix-vector product with the underlying matrix as described in the main documentation of TensorProductMatrixSymmetricSum. This function is operating on ArrayView to allow checks of array bounds with respect to dst
and src
.
|
staticconstexpr |
The static number of rows of the 1D matrices. For more details, see the description of the template parameter n_rows_1d
.
Definition at line 89 of file tensor_product_matrix.h.
|
protected |
An array containing a mass matrix for each tensor direction.
Definition at line 135 of file tensor_product_matrix.h.
|
protected |
An array containing a derivative matrix for each tensor direction.
Definition at line 140 of file tensor_product_matrix.h.
|
protected |
An array storing the generalized eigenvalues for each tensor direction.
Definition at line 146 of file tensor_product_matrix.h.
|
protected |
An array storing the generalized eigenvectors for each tensor direction.
Definition at line 152 of file tensor_product_matrix.h.
|
mutableprivate |
An array for temporary data.
Definition at line 158 of file tensor_product_matrix.h.
|
mutableprivate |
A mutex that guards access to the array tmp_array
.
Definition at line 163 of file tensor_product_matrix.h.