Anasazi Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Anasazi::EpetraSymOp Class Reference

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

#include <AnasaziEpetraAdapter.hpp>

Inheritance diagram for Anasazi::EpetraSymOp:
Anasazi::Operator< double >

Public Member Functions

 EpetraSymOp (const Teuchos::RCP< Epetra_Operator > &Op, bool isTrans=false)
 Basic constructor for applying operator $ A^TA$ [default] or $ AA^T$.
 
 ~EpetraSymOp ()
 Destructor.
 
void Apply (const MultiVec< double > &X, MultiVec< double > &Y) const
 Apply method [inherited from Anasazi::Operator class].
 
int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Apply method [inherited from Epetra_Operator class].
 
int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Apply inverse method [inherited from Epetra_Operator class].
 
const char * Label () const
 Returns a character string describing the operator.
 
bool UseTranspose () const
 Returns the current UseTranspose setting [always false for this operator].
 
int SetUseTranspose (bool)
 If set true, the transpose of this operator will be applied [not functional for this operator].
 
bool HasNormInf () const
 Returns true if this object can provide an approximate inf-norm [always false for this operator].
 
double NormInf () const
 Returns the infinity norm of the global matrix [not functional for this operator].
 
const Epetra_Comm & Comm () const
 Returns the Epetra_Comm communicator associated with this operator.
 
const Epetra_Map & OperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this operator.
 
const Epetra_Map & OperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this operator.
 
- Public Member Functions inherited from Anasazi::Operator< double >
 Operator ()
 Default constructor.
 
virtual ~Operator ()
 Destructor.
 

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

◆ EpetraSymOp()

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.

◆ ~EpetraSymOp()

Anasazi::EpetraSymOp::~EpetraSymOp ( )

Destructor.

Definition at line 378 of file AnasaziEpetraAdapter.cpp.

Member Function Documentation

◆ Apply() [1/2]

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.

◆ Apply() [2/2]

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

Apply method [inherited from Epetra_Operator class].

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

Definition at line 445 of file AnasaziEpetraAdapter.cpp.

◆ ApplyInverse()

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

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.

Definition at line 476 of file AnasaziEpetraAdapter.cpp.

◆ Label()

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

Returns a character string describing the operator.

Definition at line 477 of file AnasaziEpetraAdapter.hpp.

◆ UseTranspose()

bool Anasazi::EpetraSymOp::UseTranspose ( ) const
inline

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

Definition at line 480 of file AnasaziEpetraAdapter.hpp.

◆ SetUseTranspose()

int Anasazi::EpetraSymOp::SetUseTranspose ( bool  )
inline

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

Definition at line 483 of file AnasaziEpetraAdapter.hpp.

◆ HasNormInf()

bool Anasazi::EpetraSymOp::HasNormInf ( ) const
inline

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

Definition at line 486 of file AnasaziEpetraAdapter.hpp.

◆ NormInf()

double Anasazi::EpetraSymOp::NormInf ( ) const
inline

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

Definition at line 489 of file AnasaziEpetraAdapter.hpp.

◆ Comm()

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

Returns the Epetra_Comm communicator associated with this operator.

Definition at line 492 of file AnasaziEpetraAdapter.hpp.

◆ OperatorDomainMap()

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

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

Definition at line 495 of file AnasaziEpetraAdapter.hpp.

◆ OperatorRangeMap()

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

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

Definition at line 498 of file AnasaziEpetraAdapter.hpp.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.8