Reference documentation for deal.II version GIT relicensing-384-g4769914377 2024-04-13 09:00: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\}}\)
No Matches
Public Member Functions | List of all members
internal::LinearOperatorImplementation::EmptyPayload Class Reference

#include <deal.II/lac/linear_operator.h>

Public Member Functions

template<typename... Args>
 EmptyPayload (const Args &...)
EmptyPayload identity_payload () const
EmptyPayload null_payload () const
EmptyPayload transpose_payload () const
template<typename Solver , typename Preconditioner >
EmptyPayload inverse_payload (Solver &, const Preconditioner &) const

Detailed Description

A dummy class for LinearOperators that do not require any extensions to facilitate the operations of the matrix.

This is the Payload class typically associated with deal.II's native SparseMatrix. To use Trilinos and PETSc sparse matrix classes it is necessary to initialize a LinearOperator with their associated Payload.

Definition at line 1098 of file linear_operator.h.

Constructor & Destructor Documentation

◆ EmptyPayload()

template<typename... Args>
internal::LinearOperatorImplementation::EmptyPayload::EmptyPayload ( const Args &  ...)

Default constructor

Since this class does not do anything in particular and needs no special configuration, we have only one generic constructor that can be called under any conditions.

Definition at line 1109 of file linear_operator.h.

Member Function Documentation

◆ identity_payload()

EmptyPayload internal::LinearOperatorImplementation::EmptyPayload::identity_payload ( ) const

Return a payload configured for identity operations

Definition at line 1117 of file linear_operator.h.

◆ null_payload()

EmptyPayload internal::LinearOperatorImplementation::EmptyPayload::null_payload ( ) const

Return a payload configured for null operations

Definition at line 1127 of file linear_operator.h.

◆ transpose_payload()

EmptyPayload internal::LinearOperatorImplementation::EmptyPayload::transpose_payload ( ) const

Return a payload configured for transpose operations

Definition at line 1137 of file linear_operator.h.

◆ inverse_payload()

template<typename Solver , typename Preconditioner >
EmptyPayload internal::LinearOperatorImplementation::EmptyPayload::inverse_payload ( Solver &  ,
const Preconditioner &   
) const

Return a payload configured for inverse operations

Definition at line 1148 of file linear_operator.h.

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