Teko Version of the Day
Public Member Functions
Teko::DiagonalPreconditionerOp Class Reference

#include <Teko_DiagonalPreconditionerOp.hpp>

Inheritance diagram for Teko::DiagonalPreconditionerOp:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DiagonalPreconditionerOp (Teuchos::RCP< EpetraExt_PointToBlockDiagPermute > BDP, const VectorSpace range, const VectorSpace domain)
 Constuctor.
virtual VectorSpace range () const
 Range space of this operator.
virtual VectorSpace domain () const
 Domain space of this operator.
virtual void implicitApply (const MultiVector &x, MultiVector &y, const double alpha=1.0, const double beta=0.0) const
 Apply the preconditioner.

Detailed Description

A virtual class that simplifies the construction of custom operators.

Definition at line 63 of file Teko_DiagonalPreconditionerOp.hpp.


Constructor & Destructor Documentation

Teko::DiagonalPreconditionerOp::DiagonalPreconditionerOp ( Teuchos::RCP< EpetraExt_PointToBlockDiagPermute >  BDP,
const VectorSpace  range,
const VectorSpace  domain 
)

Constuctor.

Definition at line 61 of file Teko_DiagonalPreconditionerOp.cpp.


Member Function Documentation

virtual VectorSpace Teko::DiagonalPreconditionerOp::range ( ) const [inline, virtual]

Range space of this operator.

Implements Teko::ImplicitLinearOp.

Definition at line 70 of file Teko_DiagonalPreconditionerOp.hpp.

virtual VectorSpace Teko::DiagonalPreconditionerOp::domain ( ) const [inline, virtual]

Domain space of this operator.

Implements Teko::ImplicitLinearOp.

Definition at line 73 of file Teko_DiagonalPreconditionerOp.hpp.

void Teko::DiagonalPreconditionerOp::implicitApply ( const MultiVector &  x,
MultiVector &  y,
const double  alpha = 1.0,
const double  beta = 0.0 
) const [virtual]

Apply the preconditioner.

The apply function takes one vector as input and applies a linear preconditioner. The result is returned in $y$. If this operator is reprsented as $M$ then $ y = \alpha M x + \beta y $

Parameters:
[in]x
[in,out]y
[in]alpha(default=1)
[in]beta(default=0)

Implements Teko::ImplicitLinearOp.

Definition at line 67 of file Teko_DiagonalPreconditionerOp.cpp.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables