Teko  Version of the Day
 All Classes Files Functions Variables Pages
Public Member Functions | List of all members
Teko::TpetraHelpers::ZeroedOperator Class Reference

#include <Teko_TpetraHelpers.hpp>

Inherits Operator< ST, LO, GO, NT >.

Public Member Functions

 ZeroedOperator (const std::vector< GO > &zeroIndices, const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &op)
 Constructor for a ZeroedOperator. More...
 
Functions required by Tpetra_Operator
virtual ~ZeroedOperator ()
 Do nothing destructor. More...
 
int SetUseTranspose (bool)
 Can't transpose a ZeroedOperator. More...
 
void apply (const Tpetra::MultiVector< ST, LO, GO, NT > &X, Tpetra::MultiVector< ST, LO, GO, NT > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, ST alpha=Teuchos::ScalarTraits< ST >::one(), ST beta=Teuchos::ScalarTraits< ST >::zero()) const
 Perform a matrix-vector product with certain rows zeroed out. More...
 
void applyInverse (const Tpetra::MultiVector< ST, LO, GO, NT > &, Tpetra::MultiVector< ST, LO, GO, NT > &, Teuchos::ETransp=Teuchos::NO_TRANS, ST=Teuchos::ScalarTraits< ST >::one(), ST=Teuchos::ScalarTraits< ST >::zero()) const
 Can't call ApplyInverse on a zeroed operator. More...
 
double NormInf () const
 
bool UseTranspose () const
 
bool HasNormInf () const
 
Teuchos::RCP< const
Tpetra::Map< LO, GO, NT > > 
getDomainMap () const
 
Teuchos::RCP< const
Tpetra::Map< LO, GO, NT > > 
getRangeMap () const
 

Detailed Description

A class that zeros out chosen rows of a matrix-vector product.

Definition at line 148 of file Teko_TpetraHelpers.hpp.

Constructor & Destructor Documentation

Teko::TpetraHelpers::ZeroedOperator::ZeroedOperator ( const std::vector< GO > &  zeroIndices,
const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &  op 
)

Constructor for a ZeroedOperator.

Build a ZeroedOperator based on a particular Tpetra_Operator and a set of indices to zero out. These indices must be local to this processor as specified by RowMap().

Parameters
[in]zeroIndicesSet of indices to zero out (must be local).
[in]opUnderlying Tpetra operator to use.

Build a ZeroedOperator based on a particular Epetra_Operator and a set of indices to zero out. These indices must be local to this processor as specified by RowMap().

Parameters
[in]zeroIndicesSet of indices to zero out (must be local).
[in]opUnderlying epetra operator to use.

Definition at line 208 of file Teko_TpetraHelpers.cpp.

virtual Teko::TpetraHelpers::ZeroedOperator::~ZeroedOperator ( )
inlinevirtual

Do nothing destructor.

Definition at line 166 of file Teko_TpetraHelpers.hpp.

Member Function Documentation

int Teko::TpetraHelpers::ZeroedOperator::SetUseTranspose ( bool  )
inline

Can't transpose a ZeroedOperator.

Definition at line 169 of file Teko_TpetraHelpers.hpp.

void Teko::TpetraHelpers::ZeroedOperator::apply ( const Tpetra::MultiVector< ST, LO, GO, NT > &  X,
Tpetra::MultiVector< ST, LO, GO, NT > &  Y,
Teuchos::ETransp  mode = Teuchos::NO_TRANS,
ST  alpha = Teuchos::ScalarTraits<ST>::one(),
ST  beta = Teuchos::ScalarTraits<ST>::zero() 
) const

Perform a matrix-vector product with certain rows zeroed out.

Definition at line 213 of file Teko_TpetraHelpers.cpp.

void Teko::TpetraHelpers::ZeroedOperator::applyInverse ( const Tpetra::MultiVector< ST, LO, GO, NT > &  ,
Tpetra::MultiVector< ST, LO, GO, NT > &  ,
Teuchos::ETransp  = Teuchos::NO_TRANS,
ST  = Teuchos::ScalarTraits<ST>::one(),
ST  = Teuchos::ScalarTraits<ST>::zero() 
) const
inline

Can't call ApplyInverse on a zeroed operator.

Definition at line 177 of file Teko_TpetraHelpers.hpp.


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