KASKADE 7 development version
Public Types | Public Member Functions | List of all members
Kaskade::SymmetricMatrixOperator< X, Matrix > Class Template Reference

A symmetric operator represented by a matrix. More...

#include <symmetricOperators.hh>

Detailed Description

template<class X, class Matrix>
class Kaskade::SymmetricMatrixOperator< X, Matrix >

A symmetric operator represented by a matrix.

Definition at line 109 of file symmetricOperators.hh.

Inheritance diagram for Kaskade::SymmetricMatrixOperator< X, Matrix >:
Kaskade::SymmetricLinearOperator< X, X >

Public Types

typedef X::field_type field_type
 

Public Member Functions

 SymmetricMatrixOperator (Matrix const &A_)
 
virtual void apply (X const &x, X &y) const
 
virtual void applyscaleadd (field_type alpha, X const &x, X &y) const
 
virtual field_type applyDp (X const &x, X &y) const
 operator application Computes \( y \leftarrow Ax \) and returns the dual pairing \( \langle x,y \rangle \). More...
 
virtual field_type dp (X const &x, X const &y) const
 returns the dual pairing \( \langle x, y \rangle \) with respect to which the operator is symmetric More...
 
virtual Dune::SolverCategory::Category category () const override
 returns the category of the operator More...
 

Member Typedef Documentation

◆ field_type

template<class X , class Matrix >
typedef X::field_type Kaskade::SymmetricMatrixOperator< X, Matrix >::field_type

Definition at line 112 of file symmetricOperators.hh.

Constructor & Destructor Documentation

◆ SymmetricMatrixOperator()

template<class X , class Matrix >
Kaskade::SymmetricMatrixOperator< X, Matrix >::SymmetricMatrixOperator ( Matrix const &  A_)
inline

Definition at line 114 of file symmetricOperators.hh.

Member Function Documentation

◆ apply()

template<class X , class Matrix >
virtual void Kaskade::SymmetricMatrixOperator< X, Matrix >::apply ( X const &  x,
X &  y 
) const
inlinevirtual

Definition at line 118 of file symmetricOperators.hh.

◆ applyDp()

template<class X , class Matrix >
virtual field_type Kaskade::SymmetricMatrixOperator< X, Matrix >::applyDp ( X const &  x,
X &  y 
) const
inlinevirtual

operator application Computes \( y \leftarrow Ax \) and returns the dual pairing \( \langle x,y \rangle \).

Reimplemented from Kaskade::SymmetricLinearOperator< X, X >.

Definition at line 132 of file symmetricOperators.hh.

◆ applyscaleadd()

template<class X , class Matrix >
virtual void Kaskade::SymmetricMatrixOperator< X, Matrix >::applyscaleadd ( field_type  alpha,
X const &  x,
X &  y 
) const
inlinevirtual

Definition at line 123 of file symmetricOperators.hh.

◆ category()

virtual Dune::SolverCategory::Category Kaskade::SymmetricLinearOperator< X, X >::category ( ) const
inlineoverridevirtualinherited

returns the category of the operator

From the Dune doxygen documentation it is unclear what this is supposed to mean. We return a dummy here.

Definition at line 98 of file symmetricOperators.hh.

◆ dp()

template<class X , class Matrix >
virtual field_type Kaskade::SymmetricMatrixOperator< X, Matrix >::dp ( X const &  x,
X const &  y 
) const
inlinevirtual

returns the dual pairing \( \langle x, y \rangle \) with respect to which the operator is symmetric

Implements Kaskade::SymmetricLinearOperator< X, X >.

Definition at line 141 of file symmetricOperators.hh.

Referenced by Kaskade::SymmetricMatrixOperator< X, Matrix >::applyDp().


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