#include <Teko_TpetraHelpers.hpp>

Public Member Functions
	ZeroedOperator (const std::vector< GO > &zeroIndices, const Teuchos::RCP< const Tpetra::Operator< ST, LO, GO, NT > > &op)
	Constructor for a ZeroedOperator.

Functions required by Tpetra_Operator
virtual	~ZeroedOperator ()
	Do nothing destructor.
int	SetUseTranspose (bool)
	Can't transpose a ZeroedOperator.
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.
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.

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

◆ ZeroedOperator()

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]	zeroIndices	Set of indices to zero out (must be local).
[in]	op	Underlying 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]	zeroIndices	Set of indices to zero out (must be local).
[in]	op	Underlying epetra operator to use.

Definition at line 208 of file Teko_TpetraHelpers.cpp.

◆ ~ZeroedOperator()

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

inlinevirtual

Do nothing destructor.

Definition at line 166 of file Teko_TpetraHelpers.hpp.

Member Function Documentation

◆ SetUseTranspose()

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

inline

Can't transpose a ZeroedOperator.

Definition at line 169 of file Teko_TpetraHelpers.hpp.

◆ apply()

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.

◆ applyInverse()

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:

Public Member Functions

Functions required by Tpetra_Operator