MueLu
Version of the Day
|
Wraps an existing MueLu::Hierarchy as a Xpetra::Operator. More...
#include <MueLu_XpetraOperator_decl.hpp>
Public Member Functions | |
const Teuchos::RCP< const Xpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > | getDomainMap () const |
Returns the Tpetra::Map object associated with the domain of this operator. More... | |
const 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... | |
Public Member Functions inherited from Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
virtual void | removeEmptyProcessesInPlace (const RCP< const Map > &) |
virtual void | apply (const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits< Scalar >::one(), Scalar beta=Teuchos::ScalarTraits< Scalar >::zero()) const =0 |
Public Member Functions inherited from Teuchos::Describable | |
virtual std::string | description () const |
virtual void | describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
virtual | ~Describable () |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Protected Member Functions | |
XpetraOperator () | |
Private Attributes | |
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | Hierarchy_ |
Constructor/Destructor | |
XpetraOperator (const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H) | |
Constructor. More... | |
virtual | ~XpetraOperator () |
Destructor. More... | |
MueLu specific | |
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | GetHierarchy () const |
Direct access to the underlying MueLu::Hierarchy. More... | |
Additional Inherited Members | |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
Wraps an existing MueLu::Hierarchy as a Xpetra::Operator.
Definition at line 28 of file MueLu_XpetraOperator_decl.hpp.
|
inlineprotected |
Definition at line 30 of file MueLu_XpetraOperator_decl.hpp.
MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::XpetraOperator | ( | const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > & | H | ) |
Constructor.
Definition at line 19 of file MueLu_XpetraOperator_def.hpp.
|
virtualdefault |
Destructor.
|
virtual |
Returns the Tpetra::Map object associated with the domain of this operator.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 29 of file MueLu_XpetraOperator_def.hpp.
|
virtual |
Returns the Tpetra::Map object associated with the range of this operator.
Implements Xpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 39 of file MueLu_XpetraOperator_def.hpp.
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.
[in] | X | - Xpetra::MultiVector of dimension NumVectors to multiply with matrix. |
[out] | Y | - Xpetra::MultiVector of dimension NumVectors containing result. |
Definition at line 48 of file MueLu_XpetraOperator_def.hpp.
bool MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::hasTransposeApply | ( | ) | const |
Indicates whether this operator supports applying the adjoint operator.
Definition at line 79 of file MueLu_XpetraOperator_def.hpp.
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 85 of file MueLu_XpetraOperator_def.hpp.
RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > MueLu::XpetraOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetHierarchy | ( | ) | const |
Direct access to the underlying MueLu::Hierarchy.
Definition at line 95 of file MueLu_XpetraOperator_def.hpp.
|
private |
Definition at line 78 of file MueLu_XpetraOperator_decl.hpp.