Belos::Operator< ScalarType > Class Template Reference

Belos's templated pure virtual class for constructing the operator that is used by the linear solver. More...

#include <BelosOperator.hpp>

Inheritance diagram for Belos::Operator< ScalarType >:
Inheritance graph
[legend]

List of all members.

Constructor/Destructor



 Operator ()
 Default constructor.
virtual ~Operator ()
 Destructor.

Operator application method



virtual void Apply (const MultiVec< ScalarType > &x, MultiVec< ScalarType > &y, ETrans trans=NOTRANS) const =0
 This routine takes the Belos::MultiVec x and applies the operator to it resulting in the Belos::MultiVec y, which is returned.

Detailed Description

template<class ScalarType>
class Belos::Operator< ScalarType >

Belos's templated pure virtual class for constructing the operator that is used by the linear solver.

This operator is used as the interface to the matrix (A), solution (X), and right-hand side (B) of the linear system AX = B. Furthermore, it is also the interface to left/right preconditioning and left/right scaling of the linear system.

A concrete implementation of this class is necessary. The user can create their own implementation if those supplied are not suitable for their needs.

Author:
Michael Heroux and Heidi Thornquist

Definition at line 60 of file BelosOperator.hpp.


Constructor & Destructor Documentation

template<class ScalarType>
Belos::Operator< ScalarType >::Operator (  )  [inline]

Default constructor.

Definition at line 67 of file BelosOperator.hpp.

template<class ScalarType>
virtual Belos::Operator< ScalarType >::~Operator (  )  [inline, virtual]

Destructor.

Definition at line 70 of file BelosOperator.hpp.


Member Function Documentation

template<class ScalarType>
virtual void Belos::Operator< ScalarType >::Apply ( const MultiVec< ScalarType > &  x,
MultiVec< ScalarType > &  y,
ETrans  trans = NOTRANS 
) const [pure virtual]

This routine takes the Belos::MultiVec x and applies the operator to it resulting in the Belos::MultiVec y, which is returned.

Note:
It is expected that any problem with applying this operator to x will be indicated by an std::exception being thrown.

Implemented in MyBetterOperator< ScalarType >, and MyOperator< ScalarType >.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:05:18 2011 for Belos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3