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. More... | |
Constructor/Destructor | |
| XpetraOperator (const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H) | |
| Constructor. More... | |
| virtual | ~XpetraOperator () |
| Destructor. More... | |
| Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | getDomainMap () const |
| Returns the Tpetra::Map object associated with the domain of this operator. More... | |
| Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | getRangeMap () const |
| Returns the Tpetra::Map object associated with the range of this operator. More... | |
| 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. More... | |
| bool | hasTransposeApply () const |
| Indicates whether this operator supports applying the adjoint operator. More... | |
| 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. More... | |
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>
|
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>
|
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>
|
inlinevirtual |
Destructor.
Definition at line 76 of file MueLu_XpetraOperator_decl.hpp.
Member Function Documentation
◆ getDomainMap()
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inline |
Returns the Tpetra::Map object associated with the domain of this operator.
Definition at line 81 of file MueLu_XpetraOperator_decl.hpp.
◆ getRangeMap()
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inline |
Returns the Tpetra::Map object associated with the range of this operator.
Definition at line 89 of file MueLu_XpetraOperator_decl.hpp.
◆ apply()
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inline |
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 101 of file MueLu_XpetraOperator_decl.hpp.
◆ hasTransposeApply()
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inline |
Indicates whether this operator supports applying the adjoint operator.
Definition at line 131 of file MueLu_XpetraOperator_decl.hpp.
◆ residual()
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inline |
Compute a residual R = B - (*this) * X.
Definition at line 134 of file MueLu_XpetraOperator_decl.hpp.
◆ GetHierarchy()
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
inline |
Direct access to the underlying MueLu::Hierarchy.
Definition at line 146 of file MueLu_XpetraOperator_decl.hpp.
Member Data Documentation
◆ Hierarchy_
template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
|
private |
Definition at line 151 of file MueLu_XpetraOperator_decl.hpp.
The documentation for this class was generated from the following file:
