MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Wraps an existing MueLu::Hierarchy as a Tpetra::Operator. More...

#include <MueLu_TpetraOperator_fwd.hpp>

Inheritance diagram for MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Member Functions
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const
	Returns the Tpetra::Map object associated with the domain of this operator. More...
Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const
	Returns the Tpetra::Map object associated with the range of this operator. More...
void	apply (const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::one()) const
	Returns in Y the result of a Tpetra::Operator applied to a Tpetra::MultiVector X. More...
bool	hasTransposeApply () const
	Indicates whether this operator supports applying the adjoint operator. More...

Protected Member Functions
	TpetraOperator ()

Private Attributes
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	Hierarchy_
RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	Operator_

Constructor/Destructor
	TpetraOperator (const RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &Op)
	Constructor. More...
	TpetraOperator (const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H)
	Constructor. More...
virtual	~TpetraOperator ()
	Destructor. More...

MueLu specific
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	GetHierarchy () const
	Direct access to the underlying MueLu::Hierarchy. More...
RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > >	GetOperator () const
	Direct access to the underlying MueLu::Operator. More...

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Wraps an existing MueLu::Hierarchy as a Tpetra::Operator.

Definition at line 54 of file MueLu_TpetraOperator_fwd.hpp.

Constructor & Destructor Documentation

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraOperator ( )

inlineprotected

Definition at line 67 of file MueLu_TpetraOperator_decl.hpp.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraOperator ( const RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  Op )

inline

Constructor.

Definition at line 74 of file MueLu_TpetraOperator_decl.hpp.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::TpetraOperator ( const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  H )

inline

Constructor.

Definition at line 77 of file MueLu_TpetraOperator_decl.hpp.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

virtual MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~TpetraOperator ( )

inlinevirtual

Destructor.

Definition at line 80 of file MueLu_TpetraOperator_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap

(

)

const

Returns the Tpetra::Map object associated with the domain of this operator.

Definition at line 70 of file MueLu_TpetraOperator_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap

(

)

const

Returns the Tpetra::Map object associated with the range of this operator.

Definition at line 88 of file MueLu_TpetraOperator_def.hpp.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::apply	(	const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	X,
		Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	Y,
		Teuchos::ETransp	mode = Teuchos::NO_TRANS,
		Scalar	alpha = Teuchos::ScalarTraits<Scalar>::one(),
		Scalar	beta = Teuchos::ScalarTraits<Scalar>::one()
	)		const

Returns in Y the result of a Tpetra::Operator applied to a Tpetra::MultiVector X.

Parameters

[in]	X	- Tpetra::MultiVector of dimension NumVectors to multiply with matrix.
[out]	Y	-Tpetra::MultiVector of dimension NumVectors containing result.

Definition at line 106 of file MueLu_TpetraOperator_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

bool MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply

(

)

const

Indicates whether this operator supports applying the adjoint operator.

Definition at line 131 of file MueLu_TpetraOperator_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetHierarchy

(

)

const

Direct access to the underlying MueLu::Hierarchy.

Definition at line 137 of file MueLu_TpetraOperator_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetOperator

(

)

const

Direct access to the underlying MueLu::Operator.

Definition at line 143 of file MueLu_TpetraOperator_def.hpp.

Member Data Documentation

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Hierarchy_

private

Definition at line 123 of file MueLu_TpetraOperator_decl.hpp.

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

RCP<Xpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > MueLu::TpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Operator_

private

Definition at line 124 of file MueLu_TpetraOperator_decl.hpp.

---

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

• MueLu_TpetraOperator_fwd.hpp
• MueLu_TpetraOperator_decl.hpp
• MueLu_TpetraOperator_def.hpp