![]() |
Reference documentation for deal.II version 9.6.0
|
#include <deal.II/matrix_free/operators.h>
Public Types | |
using | value_type |
using | size_type |
Public Member Functions | |
LaplaceOperator () | |
virtual void | compute_diagonal () override |
void | set_coefficient (const std::shared_ptr< Table< 2, VectorizedArrayType > > &scalar_coefficient) |
virtual void | clear () override |
std::shared_ptr< Table< 2, VectorizedArrayType > > | get_coefficient () |
template<int n_components_compute> | |
void | do_operation_on_cell (FEEvaluation< dim, fe_degree, n_q_points_1d, n_components_compute, typename Base< dim, VectorType, VectorizedArrayType >::value_type, VectorizedArrayType > &phi, const unsigned int cell) const |
void | initialize (std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArrayType > > data, const std::vector< unsigned int > &selected_row_blocks=std::vector< unsigned int >(), const std::vector< unsigned int > &selected_column_blocks=std::vector< unsigned int >()) |
void | initialize (std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArrayType > > data, const MGConstrainedDoFs &mg_constrained_dofs, const unsigned int level, const std::vector< unsigned int > &selected_row_blocks=std::vector< unsigned int >()) |
void | initialize (std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArrayType > > data_, const std::vector< MGConstrainedDoFs > &mg_constrained_dofs, const unsigned int level, const std::vector< unsigned int > &selected_row_blocks=std::vector< unsigned int >()) |
size_type | m () const |
size_type | n () const |
void | vmult_interface_down (VectorType &dst, const VectorType &src) const |
void | vmult_interface_up (VectorType &dst, const VectorType &src) const |
void | vmult (VectorType &dst, const VectorType &src) const |
void | Tvmult (VectorType &dst, const VectorType &src) const |
void | vmult_add (VectorType &dst, const VectorType &src) const |
void | Tvmult_add (VectorType &dst, const VectorType &src) const |
value_type | el (const unsigned int row, const unsigned int col) const |
virtual std::size_t | memory_consumption () const |
void | initialize_dof_vector (VectorType &vec) const |
std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArrayType > > | get_matrix_free () const |
const std::shared_ptr< DiagonalMatrix< VectorType > > & | get_matrix_diagonal_inverse () const |
const std::shared_ptr< DiagonalMatrix< VectorType > > & | get_matrix_diagonal () const |
void | precondition_Jacobi (VectorType &dst, const VectorType &src, const value_type omega) const |
template<class Archive > | |
void | serialize (Archive &ar, const unsigned int version) |
Subscriptor functionality | |
Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class. | |
void | subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
void | unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const |
unsigned int | n_subscriptions () const |
template<typename StreamType > | |
void | list_subscribers (StreamType &stream) const |
void | list_subscribers () const |
Static Public Member Functions | |
static ::ExceptionBase & | ExcInUse (int arg1, std::string arg2, std::string arg3) |
static ::ExceptionBase & | ExcNoSubscriber (std::string arg1, std::string arg2) |
Protected Member Functions | |
void | preprocess_constraints (VectorType &dst, const VectorType &src) const |
void | postprocess_constraints (VectorType &dst, const VectorType &src) const |
void | set_constrained_entries_to_one (VectorType &dst) const |
virtual void | Tapply_add (VectorType &dst, const VectorType &src) const |
Protected Attributes | |
std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArrayType > > | data |
std::shared_ptr< DiagonalMatrix< VectorType > > | diagonal_entries |
std::shared_ptr< DiagonalMatrix< VectorType > > | inverse_diagonal_entries |
std::vector< unsigned int > | selected_rows |
std::vector< unsigned int > | selected_columns |
Private Types | |
using | map_value_type = decltype(counter_map)::value_type |
using | map_iterator = decltype(counter_map)::iterator |
Private Member Functions | |
virtual void | apply_add (VectorType &dst, const VectorType &src) const override |
void | local_apply_cell (const MatrixFree< dim, value_type, VectorizedArrayType > &data, VectorType &dst, const VectorType &src, const std::pair< unsigned int, unsigned int > &cell_range) const |
void | local_diagonal_cell (const MatrixFree< dim, value_type, VectorizedArrayType > &data, VectorType &dst, const VectorType &, const std::pair< unsigned int, unsigned int > &cell_range) const |
template<int n_components_compute> | |
void | do_operation_on_cell (FEEvaluation< dim, fe_degree, n_q_points_1d, n_components_compute, value_type, VectorizedArrayType > &phi, const unsigned int cell) const |
void | mult_add (VectorType &dst, const VectorType &src, const bool transpose) const |
void | adjust_ghost_range_if_necessary (const VectorType &vec, const bool is_row) const |
void | check_no_subscribers () const noexcept |
Private Attributes | |
std::shared_ptr< Table< 2, VectorizedArrayType > > | scalar_coefficient |
std::vector< std::vector< unsigned int > > | edge_constrained_indices |
std::vector< std::vector< std::pair< value_type, value_type > > > | edge_constrained_values |
bool | have_interface_matrices |
std::atomic< unsigned int > | counter |
std::map< std::string, unsigned int > | counter_map |
std::vector< std::atomic< bool > * > | validity_pointers |
const std::type_info * | object_info |
Static Private Attributes | |
static std::mutex | mutex |
This class implements the operation of the action of a Laplace matrix, namely \( L_{ij} = \int_\Omega c(\mathbf x) \mathbf \nabla N_i(\mathbf x) \cdot \mathbf \nabla N_j(\mathbf x)\,d \mathbf x\), where \(c(\mathbf x)\) is the scalar heterogeneity coefficient.
Note that this class only supports the non-blocked vector variant of the Base operator because only a single FEEvaluation object is used in the apply function.
Definition at line 869 of file operators.h.
using MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::value_type |
Number alias.
Definition at line 875 of file operators.h.
using MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::size_type |
size_type needed for preconditioner classes.
Definition at line 881 of file operators.h.
|
privateinherited |
The data type used in counter_map.
Definition at line 229 of file subscriptor.h.
|
privateinherited |
The iterator type used in counter_map.
Definition at line 234 of file subscriptor.h.
MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::LaplaceOperator | ( | ) |
Constructor.
Definition at line 2172 of file operators.h.
|
overridevirtual |
The diagonal is approximated by computing a local diagonal matrix per element and distributing it to the global diagonal. This will lead to wrong results on element with hanging nodes but is still an acceptable approximation to be used in preconditioners.
Implements MatrixFreeOperators::Base< dim, VectorType, VectorizedArrayType >.
Definition at line 2251 of file operators.h.
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::set_coefficient | ( | const std::shared_ptr< Table< 2, VectorizedArrayType > > & | scalar_coefficient | ) |
Set the heterogeneous scalar coefficient scalar_coefficient
to be used at the quadrature points. The Table needs to have as many rows as there are cell batches in the underlying MatrixFree object, MatrixFree::n_cell_batches(). The number of batches is related to the fact that the matrix-free operators do not work on individual cells, but instead of batches of cells at once due to vectorization. The Table can take two different numbers of columns. One case is to select it equal to the total number of quadrature points in dim
dimensions, which is the dim
th power of the n_q_points_1d
template parameter. Here, (*scalar_coefficient)(cell,q)
corresponds to the value of the coefficient on cell batch cell
and quadrature point index q
. The second supported variant is a Table with a single column, in which case the same variable coefficient value is used at all quadrature points of a cell.
Such tables can be initialized by
where mf_data
is a MatrixFree object and function
is a function which provides the following method VectorizedArray<double> value(const Point<dim,
VectorizedArray<double> > &p_vec)
.
If this function is not called, the coefficient is assumed to be unity.
The argument to this function is a shared pointer to such a table. The class stores the shared pointer to this table, not a deep copy and uses it to form the Laplace matrix. Consequently, you can update the table and re-use the current object to obtain the action of a Laplace matrix with this updated coefficient. Alternatively, if the table values are only to be filled once, the original shared pointer can also go out of scope in user code and the clear() command or destructor of this class will delete the table.
Definition at line 2210 of file operators.h.
|
overridevirtual |
Resets all data structures back to the same state as for a newly constructed object.
Reimplemented from MatrixFreeOperators::Base< dim, VectorType, VectorizedArrayType >.
Definition at line 2190 of file operators.h.
std::shared_ptr< Table< 2, VectorizedArrayType > > MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::get_coefficient | ( | ) |
Read/Write access to coefficients to be used in Laplace operator.
The function will throw an error if coefficients are not previously set by set_coefficient() function.
Definition at line 2231 of file operators.h.
|
overrideprivatevirtual |
Applies the laplace matrix operation on an input vector. It is assumed that the passed input and output vector are correctly initialized using initialize_dof_vector().
Implements MatrixFreeOperators::Base< dim, VectorType, VectorizedArrayType >.
Definition at line 2301 of file operators.h.
|
private |
Applies the Laplace operator on a cell.
Definition at line 2402 of file operators.h.
|
private |
Apply diagonal part of the Laplace operator on a cell.
Definition at line 2443 of file operators.h.
|
private |
Apply Laplace operator on a cell cell
.
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::do_operation_on_cell | ( | FEEvaluation< dim, fe_degree, n_q_points_1d, n_components_compute, typename Base< dim, VectorType, VectorizedArrayType >::value_type, VectorizedArrayType > & | phi, |
const unsigned int | cell ) const |
Definition at line 2337 of file operators.h.
|
inherited |
Initialize operator on fine scale.
The optional selection vector allows to choose only some components from the underlying MatrixFree object, e.g. just a single one. The entry selected_row_blocks
[i] in the vector chooses the DoFHandler and AffineConstraints object that was given as the selected_row_blocks
[i]-th argument to the MatrixFree::reinit() call. Different arguments for rows and columns also make it possible to select non-diagonal blocks or rectangular blocks. If the row vector is empty, all components are selected, otherwise its size must be smaller or equal to MatrixFree::n_components() and all indices need to be unique and within the range of 0 and MatrixFree::n_components(). If the column selection vector is empty, it is taken the same as the row selection, defining a diagonal block.
Definition at line 1304 of file operators.h.
|
inherited |
Initialize operator on a level level
for a single FiniteElement.
The optional selection vector allows to choose only some components from the underlying MatrixFree object, e.g. just a single one. The entry selected_row_blocks
[i] in the vector chooses the DoFHandler and AffineConstraints object that was given as the selected_row_blocks
[i]-th argument to the MatrixFree::reinit() call. Since a multigrid operator is always associated to inverting a matrix and thus represents a diagonal block, the same vector for rows and columns is used as opposed to the non-level initialization function. If empty, all components are selected.
Definition at line 1357 of file operators.h.
|
inherited |
Initialize operator on a level level
for multiple FiniteElement objects.
The optional selection vector allows to choose only some components from the underlying MatrixFree object, e.g. just a single one. The entry selected_row_blocks
[i] in the vector chooses the DoFHandler and AffineConstraints object that was given as the selected_row_blocks
[i]-th argument to the MatrixFree::reinit() call. Since a multigrid operator is always associated to inverting a matrix and thus represents a diagonal block, the same vector for rows and columns is used as opposed to the non-level initialization function. If empty, all components are selected.
Definition at line 1373 of file operators.h.
|
inherited |
Return the dimension of the codomain (or range) space.
Definition at line 1226 of file operators.h.
|
inherited |
Return the dimension of the domain space.
Definition at line 1240 of file operators.h.
|
inherited |
vmult operator for interface.
Definition at line 1623 of file operators.h.
|
inherited |
vmult operator for interface.
Definition at line 1677 of file operators.h.
|
inherited |
Matrix-vector multiplication.
Definition at line 1462 of file operators.h.
|
inherited |
Transpose matrix-vector multiplication.
Definition at line 1718 of file operators.h.
|
inherited |
Adding Matrix-vector multiplication.
Definition at line 1475 of file operators.h.
|
inherited |
Adding transpose matrix-vector multiplication.
Definition at line 1486 of file operators.h.
|
inherited |
Return the value of the matrix entry (row,col). In matrix-free context this function is valid only for row==col when diagonal is initialized.
Definition at line 1264 of file operators.h.
|
virtualinherited |
Determine an estimate for the memory consumption (in bytes) of this object.
Definition at line 1732 of file operators.h.
|
inherited |
A wrapper for initialize_dof_vector() of MatrixFree object.
Definition at line 1279 of file operators.h.
|
inherited |
Get read access to the MatrixFree object stored with this operator.
Definition at line 1746 of file operators.h.
|
inherited |
Get read access to the inverse diagonal of this operator.
Definition at line 1755 of file operators.h.
|
inherited |
Get read access to the diagonal of this operator.
Definition at line 1768 of file operators.h.
|
inherited |
Apply the Jacobi preconditioner, which multiplies every element of the src
vector by the inverse of the respective diagonal element and multiplies the result with the relaxation factor omega
.
Definition at line 1790 of file operators.h.
|
protectedinherited |
Perform necessary operations related to constraints before calling apply_add() or Tapply_add() inside mult_add().
Definition at line 1539 of file operators.h.
|
protectedinherited |
Perform necessary operations related to constraints after calling apply_add() or Tapply_add() inside mult_add().
Definition at line 1589 of file operators.h.
|
protectedinherited |
Set constrained entries (both from hanging nodes and edge constraints) of dst
to one.
Definition at line 1443 of file operators.h.
|
protectedvirtualinherited |
Apply transpose operator to src
and add result in dst
.
Default implementation is to call apply_add().
Definition at line 1779 of file operators.h.
|
privateinherited |
Function which implements vmult_add (transpose
= false) and Tvmult_add (transpose
= true).
Definition at line 1569 of file operators.h.
|
privateinherited |
Adjust the ghost range of the vectors to the storage requirements of the underlying MatrixFree class. This is used inside the mult_add() as well as vmult_interface_up() and vmult_interface_down() methods in order to ensure that the cell loops will be able to access the ghost indices with the correct local indices.
Definition at line 1497 of file operators.h.
|
inherited |
Subscribes a user of the object by storing the pointer validity
. The subscriber may be identified by text supplied as identifier
.
Definition at line 135 of file subscriptor.cc.
|
inherited |
Unsubscribes a user from the object.
identifier
and the validity
pointer must be the same as the one supplied to subscribe(). Definition at line 155 of file subscriptor.cc.
|
inlineinherited |
Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.
Definition at line 300 of file subscriptor.h.
|
inlineinherited |
List the subscribers to the input stream
.
Definition at line 317 of file subscriptor.h.
|
inherited |
List the subscribers to deallog
.
Definition at line 203 of file subscriptor.cc.
|
inlineinherited |
Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.
This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.
Definition at line 309 of file subscriptor.h.
|
privatenoexceptinherited |
Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.
Definition at line 52 of file subscriptor.cc.
|
private |
User-provided heterogeneity coefficient.
Definition at line 1013 of file operators.h.
|
protectedinherited |
MatrixFree object to be used with this operator.
Definition at line 435 of file operators.h.
|
protectedinherited |
A shared pointer to a diagonal matrix that stores the diagonal elements as a vector.
Definition at line 441 of file operators.h.
|
protectedinherited |
A shared pointer to a diagonal matrix that stores the inverse of diagonal elements as a vector.
Definition at line 447 of file operators.h.
|
protectedinherited |
A vector which defines the selection of sub-components of MatrixFree for the rows of the matrix representation.
Definition at line 453 of file operators.h.
|
protectedinherited |
A vector which defines the selection of sub-components of MatrixFree for the columns of the matrix representation.
Definition at line 459 of file operators.h.
|
privateinherited |
Indices of DoFs on edge in case the operator is used in GMG context.
Definition at line 465 of file operators.h.
|
mutableprivateinherited |
Auxiliary vector.
Definition at line 471 of file operators.h.
|
privateinherited |
A flag which determines whether or not this operator has interface matrices in GMG context.
Definition at line 477 of file operators.h.
|
mutableprivateinherited |
Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).
The creator (and owner) of an object is counted in the map below if HE manages to supply identification.
We use the mutable
keyword in order to allow subscription to constant objects also.
This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic
class template.
Definition at line 218 of file subscriptor.h.
|
mutableprivateinherited |
In this map, we count subscriptions for each different identification string supplied to subscribe().
Definition at line 224 of file subscriptor.h.
|
mutableprivateinherited |
In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.
Definition at line 240 of file subscriptor.h.
|
mutableprivateinherited |
Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.
Definition at line 248 of file subscriptor.h.
|
staticprivateinherited |
A mutex used to ensure data consistency when accessing the mutable
members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers()
.
Definition at line 271 of file subscriptor.h.