Anasazi Version of the Day
Public Member Functions | Static Public Member Functions
Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP > Class Template Reference

MatOrthoManager subclass using TSQR or SVQB. More...

#include <AnasaziTsqrOrthoManager.hpp>

Inheritance diagram for Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >:
Anasazi::MatOrthoManager< ScalarType, MV, OP > Anasazi::OrthoManager< ScalarType, MV >

List of all members.

Public Member Functions

 TsqrMatOrthoManager ()
 Default constructor (sets Op to Teuchos::null)
 TsqrMatOrthoManager (const Teuchos::RCP< const Teuchos::ParameterList > &params, const std::string &label="Anasazi", Teuchos::RCP< const OP > Op=Teuchos::null)
 Constructor.
virtual ~TsqrMatOrthoManager ()
 Destructor.
virtual void setOp (Teuchos::RCP< const OP > Op)
 Return the inner product operator.
virtual Teuchos::RCP< const OP > getOp () const
 Return the inner product operator, if any.

Static Public Member Functions

static Teuchos::RCP< const
Teuchos::ParameterList
getDefaultParameters ()
 Get default parameters for TsqrMatOrthoManager.

Detailed Description

template<class ScalarType, class MV, class OP>
class Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >

MatOrthoManager subclass using TSQR or SVQB.

Subclass of MatOrthoManager. When getOp() == null (Euclidean inner product), uses TSQR + Block Gram-Schmidt for orthogonalization. When getOp() != null, uses SVQBOrthoManager (Stathopoulos and Wu 2002: CholeskyQR + SVD) for orthogonalization. Avoids communication in either case. Initialization of either orthogonalization manager is "lazy," so you don't have to pay for scratch space if you don't use it.

Definition at line 157 of file AnasaziTsqrOrthoManager.hpp.


Constructor & Destructor Documentation

template<class ScalarType , class MV , class OP >
Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >::TsqrMatOrthoManager ( ) [inline]

Default constructor (sets Op to Teuchos::null)

Definition at line 209 of file AnasaziTsqrOrthoManager.hpp.

template<class ScalarType , class MV , class OP >
Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >::TsqrMatOrthoManager ( const Teuchos::RCP< const Teuchos::ParameterList > &  params,
const std::string &  label = "Anasazi",
Teuchos::RCP< const OP >  Op = Teuchos::null 
) [inline]

Constructor.

Parameters:
params[in] Parameters used to set up the orthogonalization. Call the getDefaultParameters() class method for default parameters and their documentation.
label[in] Label for timers (if timers are used)
Op[in] Inner product with respect to which to orthogonalize vectors. If Teuchos::null, use the Euclidean inner product.

Definition at line 226 of file AnasaziTsqrOrthoManager.hpp.

template<class ScalarType , class MV , class OP >
virtual Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >::~TsqrMatOrthoManager ( ) [inline, virtual]

Destructor.

Definition at line 237 of file AnasaziTsqrOrthoManager.hpp.


Member Function Documentation

template<class ScalarType , class MV , class OP >
static Teuchos::RCP<const Teuchos::ParameterList> Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >::getDefaultParameters ( ) [inline, static]

Get default parameters for TsqrMatOrthoManager.

Get a (pointer to a) default list of parameters for configuring a TsqrMatOrthoManager instance.

Note:
To get nondefault behavior, a good thing to do is to make a deep copy of the returned parameter list, and then modify individual entries as desired.
Warning:
This method is not reentrant. It should only be called by one thread at a time.

Definition at line 202 of file AnasaziTsqrOrthoManager.hpp.

template<class ScalarType , class MV , class OP >
virtual void Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >::setOp ( Teuchos::RCP< const OP >  Op) [inline, virtual]

Return the inner product operator.

Return the inner product operator used for orthogonalization. If it is Teuchos::null, then the vectors are orthogonalized with respect to the Euclidean inner product.

Note:
We override the base class' setOp() so that the SVQBOrthoManager gets the new op.

Reimplemented from Anasazi::MatOrthoManager< ScalarType, MV, OP >.

Definition at line 248 of file AnasaziTsqrOrthoManager.hpp.

template<class ScalarType , class MV , class OP >
virtual Teuchos::RCP< const OP > Anasazi::TsqrMatOrthoManager< ScalarType, MV, OP >::getOp ( ) const [inline, virtual]

Return the inner product operator, if any.

Note:
We override only to help C++ do name lookup in the other member functions.

Reimplemented from Anasazi::MatOrthoManager< ScalarType, MV, OP >.

Definition at line 262 of file AnasaziTsqrOrthoManager.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends