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

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

#include <MueLu_XpetraOperator_decl.hpp>

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

Protected Member Functions
	XpetraOperator ()

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

Constructor/Destructor
	XpetraOperator (const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H)
	Constructor.
virtual	~XpetraOperator ()
	Destructor.
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getDomainMap () const
	Returns the Tpetra::Map object associated with the domain of this operator.
Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > >	getRangeMap () const
	Returns the Tpetra::Map object associated with the range of this operator.
void	apply (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar=Teuchos::ScalarTraits< Scalar >::one(), Scalar=Teuchos::ScalarTraits< Scalar >::one()) const
	Returns in Y the result of a Xpetra::Operator applied to a Xpetra::MultiVector X.
bool	hasTransposeApply () const
	Indicates whether this operator supports applying the adjoint operator.
void	residual (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &X, const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &B, Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &R) const
	Compute a residual R = B - (*this) * X.

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >

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

Definition at line 64 of file MueLu_XpetraOperator_decl.hpp.

Constructor & Destructor Documentation

XpetraOperator() [1/2]

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inlineprotected

Definition at line 66 of file MueLu_XpetraOperator_decl.hpp.

XpetraOperator() [2/2]

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inline

Constructor.

Definition at line 73 of file MueLu_XpetraOperator_decl.hpp.

~XpetraOperator()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

inlinevirtual

Destructor.

Definition at line 76 of file MueLu_XpetraOperator_decl.hpp.

Member Function Documentation

getDomainMap()

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

Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap

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

Definition at line 57 of file MueLu_XpetraOperator_def.hpp.

getRangeMap()

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

Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap

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

Definition at line 67 of file MueLu_XpetraOperator_def.hpp.

apply()

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

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

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

Parameters

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

Definition at line 77 of file MueLu_XpetraOperator_def.hpp.

hasTransposeApply()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

bool MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply ( ) const

inline

Indicates whether this operator supports applying the adjoint operator.

Definition at line 98 of file MueLu_XpetraOperator_decl.hpp.

residual()

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

void MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::residual	(	const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	X,
		const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	B,
		Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &	R
	)		const

Compute a residual R = B - (*this) * X.

Definition at line 109 of file MueLu_XpetraOperator_def.hpp.

GetHierarchy()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetHierarchy ( ) const

inline

Direct access to the underlying MueLu::Hierarchy.

Definition at line 109 of file MueLu_XpetraOperator_decl.hpp.

Member Data Documentation

Hierarchy_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>

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

private

Definition at line 114 of file MueLu_XpetraOperator_decl.hpp.

---

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

• MueLu_XpetraOperator_decl.hpp
• MueLu_XpetraOperator_def.hpp