Dune::LinearOperator< X, Y > Class Template Reference

A linear operator. More...

#include <dune/istl/operators.hh>

Inheritance diagram for Dune::LinearOperator< X, Y >:

Public Types
typedef X	domain_type
	The type of the domain of the operator.
typedef Y	range_type
	The type of the range of the operator.
typedef X::field_type	field_type
	The field type of the operator.

Public Member Functions
virtual void	apply (const X &x, Y &y) const =0
	apply operator to x: \( y = A(x) \) The input vector is consistent and the output must also be consistent on the interior+border partition.
virtual void	applyscaleadd (field_type alpha, const X &x, Y &y) const =0
	apply operator to x, scale and add: \( y = y + \alpha A(x) \)
virtual	~LinearOperator ()
	every abstract base class has a virtual destructor
virtual SolverCategory::Category	category () const =0
	Category of the linear operator (see SolverCategory::Category)

Detailed Description

template<class X, class Y>
class Dune::LinearOperator< X, Y >

A linear operator.

Abstract base class defining a linear operator \( A : X\to Y\), i.e. \( A(\alpha x) = \alpha A(x) \) and \( A(x+y) = A(x)+A(y)\) hold. The simplest solvers just need the application \( A(x)\) of the operator.

• enables on the fly computation through operator concept. If explicit representation of the operator is required use AssembledLinearOperator
• Some inverters may need an explicit formation of the operator as a matrix, e.g. BiCGStab, ILU, AMG, etc. In that case use the derived class

Member Typedef Documentation

domain_type

template<class X , class Y >

typedef X Dune::LinearOperator< X, Y >::domain_type

The type of the domain of the operator.

field_type

template<class X , class Y >

typedef X::field_type Dune::LinearOperator< X, Y >::field_type

The field type of the operator.

range_type

template<class X , class Y >

typedef Y Dune::LinearOperator< X, Y >::range_type

The type of the range of the operator.

Constructor & Destructor Documentation

~LinearOperator()

template<class X , class Y >

virtual Dune::LinearOperator< X, Y >::~LinearOperator ( )

inlinevirtual

every abstract base class has a virtual destructor

Member Function Documentation

apply()

template<class X , class Y >

virtual void Dune::LinearOperator< X, Y >::apply ( const X &  x, Y &  y  ) const

pure virtual

apply operator to x: \( y = A(x) \) The input vector is consistent and the output must also be consistent on the interior+border partition.

Implemented in Dune::NonoverlappingSchwarzOperator< M, X, Y, C >, Dune::MatrixAdapter< M, X, Y >, and Dune::OverlappingSchwarzOperator< M, X, Y, C >.

applyscaleadd()

template<class X , class Y >

virtual void Dune::LinearOperator< X, Y >::applyscaleadd ( field_type  alpha, const X &  x, Y &  y  ) const

pure virtual

apply operator to x, scale and add: \( y = y + \alpha A(x) \)

Implemented in Dune::NonoverlappingSchwarzOperator< M, X, Y, C >, Dune::MatrixAdapter< M, X, Y >, and Dune::OverlappingSchwarzOperator< M, X, Y, C >.

category()

template<class X , class Y >

virtual SolverCategory::Category Dune::LinearOperator< X, Y >::category ( ) const

pure virtual

Category of the linear operator (see SolverCategory::Category)

Implemented in Dune::NonoverlappingSchwarzOperator< M, X, Y, C >, Dune::MatrixAdapter< M, X, Y >, and Dune::OverlappingSchwarzOperator< M, X, Y, C >.

---

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

• operators.hh