Anasazi: Anasazi::EpetraSymOp Class Reference

Anasazi Version of the Day

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages

Adapter class for creating a symmetric operator from an Epetra_Operator. More...

#include <AnasaziEpetraAdapter.hpp>

Inheritance diagram for Anasazi::EpetraSymOp:

Public Member Functions
	EpetraSymOp (const Teuchos::RCP< Epetra_Operator > &Op, bool isTrans=false)
	Basic constructor for applying operator [default] or . More...

	~EpetraSymOp ()
	Destructor. More...

void	Apply (const MultiVec< double > &X, MultiVec< double > &Y) const
	Apply method [inherited from Anasazi::Operator class]. More...

int	Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Apply method [inherited from Epetra_Operator class]. More...

int	ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
	Apply inverse method [inherited from Epetra_Operator class]. More...

const char *	Label () const
	Returns a character string describing the operator. More...

bool	UseTranspose () const
	Returns the current UseTranspose setting [always false for this operator]. More...

int	SetUseTranspose (bool)
	If set true, the transpose of this operator will be applied [not functional for this operator]. More...

bool	HasNormInf () const
	Returns true if this object can provide an approximate inf-norm [always false for this operator]. More...

double	NormInf () const
	Returns the infinity norm of the global matrix [not functional for this operator]. More...

const Epetra_Comm &	Comm () const
	Returns the Epetra_Comm communicator associated with this operator. More...

const Epetra_Map &	OperatorDomainMap () const
	Returns the Epetra_Map object associated with the domain of this operator. More...

const Epetra_Map &	OperatorRangeMap () const
	Returns the Epetra_Map object associated with the range of this operator. More...

Public Member Functions inherited from Anasazi::Operator< double >
	Operator ()
	Default constructor. More...

virtual	~Operator ()
	Destructor. More...

Detailed Description

Adapter class for creating a symmetric operator from an Epetra_Operator.

This class will apply the operation $ A^TA$ [default] or $ AA^T$ , for the Apply method of the Epetra_Operator / Anasazi::Operator. The Anasazi::EpetraSymOp operator is useful when trying to compute a few singular values of the operator $ A$ . The singular values are the square-root of the eigenvalues of $ A^TA$ and $ AA^T$ .

Note: The Epetra package performs double-precision arithmetic, so the use of Epetra with Anasazi will only provide a double-precision eigensolver.

Examples:: BlockKrylovSchur/BlockKrylovSchurEpetraExSVD.cpp, and MVOPTester/MVOPTesterEx.cpp.

Definition at line 450 of file AnasaziEpetraAdapter.hpp.

Constructor & Destructor Documentation

Anasazi::EpetraSymOp::EpetraSymOp	(	const Teuchos::RCP< Epetra_Operator > &	Op,
		bool	isTrans = `false`
	)

Basic constructor for applying operator $ A^TA$ [default] or $ AA^T$ .

If isTrans is false this operator will apply $ A^TA$ , else it will apply $ AA^T$ .

Definition at line 372 of file AnasaziEpetraAdapter.cpp.

Anasazi::EpetraSymOp::~EpetraSymOp ( )

Destructor.

Definition at line 378 of file AnasaziEpetraAdapter.cpp.

Member Function Documentation

void Anasazi::EpetraSymOp::Apply	(	const MultiVec< double > &	X,
		MultiVec< double > &	Y
	)		const

virtual

Apply method [inherited from Anasazi::Operator class].

This method will apply $ A^TA$ or $ AA^T$ to X, returning Y.

Implements Anasazi::Operator< double >.

Definition at line 384 of file AnasaziEpetraAdapter.cpp.

int Anasazi::EpetraSymOp::Apply	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

virtual

Apply method [inherited from Epetra_Operator class].

This method will apply $ A^TA$ or $ AA^T$ to X, returning Y.

Implements Epetra_Operator.

Definition at line 445 of file AnasaziEpetraAdapter.cpp.

int Anasazi::EpetraSymOp::ApplyInverse	(	const Epetra_MultiVector &	X,
		Epetra_MultiVector &	Y
	)		const

virtual

Apply inverse method [inherited from Epetra_Operator class].

This method will apply $(A^TA)^{-1}$ or $(AA^T)^{-1}$ to X, returning Y.

Note: This method is only defined if $A^{-1}$ is defined for the given Epetra_Operator.

Implements Epetra_Operator.

Definition at line 476 of file AnasaziEpetraAdapter.cpp.

const char* Anasazi::EpetraSymOp::Label ( ) const

inlinevirtual

Returns a character string describing the operator.

Implements Epetra_Operator.

Definition at line 477 of file AnasaziEpetraAdapter.hpp.

bool Anasazi::EpetraSymOp::UseTranspose ( ) const

inlinevirtual

Returns the current UseTranspose setting [always false for this operator].

Implements Epetra_Operator.

Definition at line 480 of file AnasaziEpetraAdapter.hpp.

int Anasazi::EpetraSymOp::SetUseTranspose ( bool )

inlinevirtual

If set true, the transpose of this operator will be applied [not functional for this operator].

Implements Epetra_Operator.

Definition at line 483 of file AnasaziEpetraAdapter.hpp.

bool Anasazi::EpetraSymOp::HasNormInf ( ) const

inlinevirtual

Returns true if this object can provide an approximate inf-norm [always false for this operator].

Implements Epetra_Operator.

Definition at line 486 of file AnasaziEpetraAdapter.hpp.

double Anasazi::EpetraSymOp::NormInf ( ) const

inlinevirtual

Returns the infinity norm of the global matrix [not functional for this operator].

Implements Epetra_Operator.

Definition at line 489 of file AnasaziEpetraAdapter.hpp.

const Epetra_Comm& Anasazi::EpetraSymOp::Comm ( ) const

inlinevirtual

Returns the Epetra_Comm communicator associated with this operator.

Implements Epetra_Operator.

Definition at line 492 of file AnasaziEpetraAdapter.hpp.

const Epetra_Map& Anasazi::EpetraSymOp::OperatorDomainMap ( ) const

inlinevirtual

Returns the Epetra_Map object associated with the domain of this operator.

Implements Epetra_Operator.

Definition at line 495 of file AnasaziEpetraAdapter.hpp.

const Epetra_Map& Anasazi::EpetraSymOp::OperatorRangeMap ( ) const

inlinevirtual

Returns the Epetra_Map object associated with the range of this operator.

Implements Epetra_Operator.

Definition at line 498 of file AnasaziEpetraAdapter.hpp.

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