Reference documentation for deal.II version GIT 6da2e5d553 2022-07-01 18:55:02+00:00
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType > Class Template Referenceabstract

#include <deal.II/matrix_free/operators.h>

Inheritance diagram for MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >:
[legend]

Public Types

using value_type = typename Base< dim, VectorType, VectorizedArrayType >::value_type
 
using size_type = typename Base< dim, VectorType, VectorizedArrayType >::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 ()
 
void initialize (std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArray< typename VectorType::value_type > >> 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, VectorizedArray< typename VectorType::value_type > >> 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, VectorizedArray< typename VectorType::value_type > >> 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 (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void vmult_interface_up (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void vmult (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void Tvmult (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void vmult_add (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void Tvmult_add (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &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 (LinearAlgebra::distributed::Vector< double > &vec) const
 
std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArray< typename VectorType::value_type > > > get_matrix_free () const
 
const std::shared_ptr< DiagonalMatrix< LinearAlgebra::distributed::Vector< double > > > & get_matrix_diagonal_inverse () const
 
const std::shared_ptr< DiagonalMatrix< LinearAlgebra::distributed::Vector< double > > > & get_matrix_diagonal () const
 
void precondition_Jacobi (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src, const value_type omega) const
 

Protected Member Functions

void preprocess_constraints (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void postprocess_constraints (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 
void set_constrained_entries_to_one (LinearAlgebra::distributed::Vector< double > &dst) const
 
virtual void apply_add (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const=0
 
virtual void Tapply_add (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src) const
 

Protected Attributes

std::shared_ptr< const MatrixFree< dim, value_type, VectorizedArray< typename VectorType::value_type > > > data
 
std::shared_ptr< DiagonalMatrix< LinearAlgebra::distributed::Vector< double > > > diagonal_entries
 
std::shared_ptr< DiagonalMatrix< LinearAlgebra::distributed::Vector< double > > > inverse_diagonal_entries
 
std::vector< unsigned int > selected_rows
 
std::vector< unsigned int > selected_columns
 

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
 
void do_operation_on_cell (FEEvaluation< dim, fe_degree, n_q_points_1d, n_components, value_type > &phi, const unsigned int cell) const
 
void mult_add (LinearAlgebra::distributed::Vector< double > &dst, const LinearAlgebra::distributed::Vector< double > &src, const bool transpose) const
 
void adjust_ghost_range_if_necessary (const LinearAlgebra::distributed::Vector< double > &vec, const bool is_row) const
 

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
 

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

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
 
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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
void check_no_subscribers () const noexcept
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 

Detailed Description

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
class MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >

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 851 of file operators.h.

Member Typedef Documentation

◆ value_type

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
using MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::value_type = typename Base<dim, VectorType, VectorizedArrayType>::value_type

Number alias.

Definition at line 857 of file operators.h.

◆ size_type

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
using MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::size_type = typename Base<dim, VectorType, VectorizedArrayType>::size_type

size_type needed for preconditioner classes.

Definition at line 863 of file operators.h.

Constructor & Destructor Documentation

◆ LaplaceOperator()

template<int dim, int fe_degree, int n_q_points_1d, int n_components, typename VectorType , typename VectorizedArrayType >
MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::LaplaceOperator

Constructor.

Definition at line 2096 of file operators.h.

Member Function Documentation

◆ compute_diagonal()

template<int dim, int fe_degree, int n_q_points_1d, int n_components, typename VectorType , typename VectorizedArrayType >
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::compute_diagonal
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, LinearAlgebra::distributed::Vector< double >, VectorizedArray< typename VectorType::value_type > >.

Definition at line 2175 of file operators.h.

◆ set_coefficient()

template<int dim, int fe_degree, int n_q_points_1d, int n_components, typename VectorType , typename VectorizedArrayType >
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 dimth 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

std::shared_ptr<Table<2, VectorizedArray<double> > > coefficient;
coefficient = std::make_shared<Table<2, VectorizedArray<double> > >();
{
const unsigned int n_cells = mf_data.n_cell_batches();
const unsigned int n_q_points = fe_eval.n_q_points;
coefficient->reinit(n_cells, n_q_points);
for (unsigned int cell=0; cell<n_cells; ++cell)
{
fe_eval.reinit(cell);
for (unsigned int q=0; q<n_q_points; ++q)
(*coefficient)(cell,q) =
function.value(fe_eval.quadrature_point(q));
}
}
unsigned int n_cells(const internal::TriangulationImplementation::NumberCache< 1 > &c)
Definition: tria.cc:13763

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 2134 of file operators.h.

◆ clear()

template<int dim, int fe_degree, int n_q_points_1d, int n_components, typename VectorType , typename VectorizedArrayType >
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::clear
overridevirtual

Resets all data structures back to the same state as for a newly constructed object.

Reimplemented from MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double >, VectorizedArray< typename VectorType::value_type > >.

Definition at line 2114 of file operators.h.

◆ get_coefficient()

template<int dim, int fe_degree, int n_q_points_1d, int n_components, typename VectorType , typename VectorizedArrayType >
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 2155 of file operators.h.

◆ apply_add() [1/2]

template<int dim, int fe_degree, int n_q_points_1d, int n_components, typename VectorType , typename VectorizedArrayType >
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::apply_add ( VectorType &  dst,
const VectorType &  src 
) const
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().

Definition at line 2225 of file operators.h.

◆ local_apply_cell()

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::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
private

Applies the Laplace operator on a cell.

Definition at line 2324 of file operators.h.

◆ local_diagonal_cell()

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
void MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::local_diagonal_cell ( const MatrixFree< dim, value_type, VectorizedArrayType > &  data,
VectorType &  dst,
const VectorType &  ,
const std::pair< unsigned int, unsigned int > &  cell_range 
) const
private

Apply diagonal part of the Laplace operator on a cell.

Definition at line 2360 of file operators.h.

◆ do_operation_on_cell()

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
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, value_type > &  phi,
const unsigned int  cell 
) const
private

Apply Laplace operator on a cell cell.

Definition at line 2260 of file operators.h.

◆ initialize() [1/3]

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::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>() 
)
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 237 of file operators.h.

◆ initialize() [2/3]

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::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>() 
)
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 258 of file operators.h.

◆ initialize() [3/3]

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::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>() 
)
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 280 of file operators.h.

◆ m()

Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::size_type MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::m
inherited

Return the dimension of the codomain (or range) space.

Definition at line 291 of file operators.h.

◆ n()

Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::size_type MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::n
inherited

Return the dimension of the domain space.

Definition at line 297 of file operators.h.

◆ vmult_interface_down()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::vmult_interface_down ( VectorType &  dst,
const VectorType &  src 
) const
inherited

vmult operator for interface.

Definition at line 303 of file operators.h.

◆ vmult_interface_up()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::vmult_interface_up ( VectorType &  dst,
const VectorType &  src 
) const
inherited

vmult operator for interface.

Definition at line 309 of file operators.h.

◆ vmult()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::vmult ( VectorType &  dst,
const VectorType &  src 
) const
inherited

Matrix-vector multiplication.

Definition at line 315 of file operators.h.

◆ Tvmult()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::Tvmult ( VectorType &  dst,
const VectorType &  src 
) const
inherited

Transpose matrix-vector multiplication.

Definition at line 321 of file operators.h.

◆ vmult_add()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::vmult_add ( VectorType &  dst,
const VectorType &  src 
) const
inherited

Adding Matrix-vector multiplication.

Definition at line 327 of file operators.h.

◆ Tvmult_add()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::Tvmult_add ( VectorType &  dst,
const VectorType &  src 
) const
inherited

Adding transpose matrix-vector multiplication.

Definition at line 333 of file operators.h.

◆ el()

Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::value_type MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::el ( const unsigned int  row,
const unsigned int  col 
) const
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 340 of file operators.h.

◆ memory_consumption()

std::size_t MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::memory_consumption
virtualinherited

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 347 of file operators.h.

◆ initialize_dof_vector()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::initialize_dof_vector ( VectorType &  vec) const
inherited

A wrapper for initialize_dof_vector() of MatrixFree object.

Definition at line 353 of file operators.h.

◆ get_matrix_free()

std::shared_ptr< const MatrixFree< dim, typename Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::value_type, VectorizedArray< typename VectorType::value_type > > > MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::get_matrix_free
inherited

Get read access to the MatrixFree object stored with this operator.

Definition at line 374 of file operators.h.

◆ get_matrix_diagonal_inverse()

const std::shared_ptr< DiagonalMatrix< LinearAlgebra::distributed::Vector< double > > > & MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::get_matrix_diagonal_inverse
inherited

Get read access to the inverse diagonal of this operator.

Definition at line 380 of file operators.h.

◆ get_matrix_diagonal()

const std::shared_ptr< DiagonalMatrix< LinearAlgebra::distributed::Vector< double > > > & MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::get_matrix_diagonal
inherited

Get read access to the diagonal of this operator.

Definition at line 386 of file operators.h.

◆ precondition_Jacobi()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::precondition_Jacobi ( VectorType &  dst,
const VectorType &  src,
const value_type  omega 
) const
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 394 of file operators.h.

◆ preprocess_constraints()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::preprocess_constraints ( VectorType &  dst,
const VectorType &  src 
) const
protectedinherited

Perform necessary operations related to constraints before calling apply_add() or Tapply_add() inside mult_add().

Definition at line 404 of file operators.h.

◆ postprocess_constraints()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::postprocess_constraints ( VectorType &  dst,
const VectorType &  src 
) const
protectedinherited

Perform necessary operations related to constraints after calling apply_add() or Tapply_add() inside mult_add().

Definition at line 411 of file operators.h.

◆ set_constrained_entries_to_one()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::set_constrained_entries_to_one ( VectorType &  dst) const
protectedinherited

Set constrained entries (both from hanging nodes and edge constraints) of dst to one.

Definition at line 418 of file operators.h.

◆ apply_add() [2/2]

virtual void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::apply_add ( VectorType &  dst,
const VectorType &  src 
) const
protectedpure virtualinherited

Apply operator to src and add result in dst.

◆ Tapply_add()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::Tapply_add ( VectorType &  dst,
const VectorType &  src 
) const
protectedvirtualinherited

Apply transpose operator to src and add result in dst.

Default implementation is to call apply_add().

Definition at line 432 of file operators.h.

◆ mult_add()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::mult_add ( VectorType &  dst,
const VectorType &  src,
const bool  transpose 
) const
privateinherited

Function which implements vmult_add (transpose = false) and Tvmult_add (transpose = true).

Definition at line 487 of file operators.h.

◆ adjust_ghost_range_if_necessary()

void MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::adjust_ghost_range_if_necessary ( const VectorType &  vec,
const bool  is_row 
) const
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 499 of file operators.h.

Member Data Documentation

◆ scalar_coefficient

template<int dim, int fe_degree, int n_q_points_1d = fe_degree + 1, int n_components = 1, typename VectorType = LinearAlgebra::distributed::Vector<double>, typename VectorizedArrayType = VectorizedArray<typename VectorType::value_type>>
std::shared_ptr<Table<2, VectorizedArrayType> > MatrixFreeOperators::LaplaceOperator< dim, fe_degree, n_q_points_1d, n_components, VectorType, VectorizedArrayType >::scalar_coefficient
private

User-provided heterogeneity coefficient.

Definition at line 991 of file operators.h.

◆ data

std::shared_ptr<const MatrixFree<dim, value_type, VectorizedArray< typename VectorType::value_type > > > MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::data
protectedinherited

MatrixFree object to be used with this operator.

Definition at line 438 of file operators.h.

◆ diagonal_entries

std::shared_ptr<DiagonalMatrix<LinearAlgebra::distributed::Vector< double > > > MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::diagonal_entries
protectedinherited

A shared pointer to a diagonal matrix that stores the diagonal elements as a vector.

Definition at line 444 of file operators.h.

◆ inverse_diagonal_entries

std::shared_ptr<DiagonalMatrix<LinearAlgebra::distributed::Vector< double > > > MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::inverse_diagonal_entries
protectedinherited

A shared pointer to a diagonal matrix that stores the inverse of diagonal elements as a vector.

Definition at line 450 of file operators.h.

◆ selected_rows

std::vector<unsigned int> MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::selected_rows
protectedinherited

A vector which defines the selection of sub-components of MatrixFree for the rows of the matrix representation.

Definition at line 456 of file operators.h.

◆ selected_columns

std::vector<unsigned int> MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::selected_columns
protectedinherited

A vector which defines the selection of sub-components of MatrixFree for the columns of the matrix representation.

Definition at line 462 of file operators.h.

◆ edge_constrained_indices

std::vector<std::vector<unsigned int> > MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::edge_constrained_indices
privateinherited

Indices of DoFs on edge in case the operator is used in GMG context.

Definition at line 468 of file operators.h.

◆ edge_constrained_values

std::vector<std::vector<std::pair<value_type, value_type> > > MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::edge_constrained_values
mutableprivateinherited

Auxiliary vector.

Definition at line 474 of file operators.h.

◆ have_interface_matrices

bool MatrixFreeOperators::Base< dim, LinearAlgebra::distributed::Vector< double > , VectorizedArray< typename VectorType::value_type > >::have_interface_matrices
privateinherited

A flag which determines whether or not this operator has interface matrices in GMG context.

Definition at line 480 of file operators.h.


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