MueLu  Version of the Day
Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <BelosMueLuAdapter.hpp>

Inheritance diagram for Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
Belos::OperatorT< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > Belos::OperatorT< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >

Public Member Functions

void Apply (const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x, Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &y, ETrans trans=NOTRANS) const
 This routine takes the Tpetra::MultiVector x and applies the operator to it resulting in the Tpetra::MultiVector y, which is returned. More...
 
- Public Member Functions inherited from Belos::OperatorT< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >
 OperatorT ()
 Default constructor. More...
 
virtual ~OperatorT ()
 Destructor. More...
 
- Public Member Functions inherited from Belos::OperatorT< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >
 OperatorT ()
 Default constructor. More...
 
virtual ~OperatorT ()
 Destructor. More...
 

Private Attributes

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

Constructor/Destructor

 MueLuOp (const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &H)
 Default constructor. More...
 
 MueLuOp (const RCP< MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A)
 
virtual ~MueLuOp ()
 Destructor. More...
 

Operator application method

void Apply (const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &x, Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &y, ETrans trans=NOTRANS) const
 This routine takes the Xpetra::MultiVector x and applies the operator to it resulting in the Xpetra::MultiVector y, which is returned. More...
 

Detailed Description

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 83 of file BelosMueLuAdapter.hpp.

Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MueLuOp ( const RCP< MueLu::Hierarchy< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  H)
inline

Default constructor.

Definition at line 95 of file BelosMueLuAdapter.hpp.

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MueLuOp ( const RCP< MueLu::AMGXOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  A)
inline

Definition at line 97 of file BelosMueLuAdapter.hpp.

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~MueLuOp ( )
inlinevirtual

Destructor.

Definition at line 100 of file BelosMueLuAdapter.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply ( const Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x,
Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  y,
ETrans  trans = NOTRANS 
) const
inlinevirtual

This routine takes the Xpetra::MultiVector x and applies the operator to it resulting in the Xpetra::MultiVector y, which is returned.

Note
It is expected that any problem with applying this operator to x will be indicated by an std::exception being thrown.

Implements Belos::OperatorT< Xpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >.

Definition at line 111 of file BelosMueLuAdapter.hpp.

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Apply ( const Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  x,
Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  y,
ETrans  trans = NOTRANS 
) const
inlinevirtual

This routine takes the Tpetra::MultiVector x and applies the operator to it resulting in the Tpetra::MultiVector y, which is returned.

Note
It is expected that any problem with applying this operator to x will be indicated by an std::exception being thrown.

Implements Belos::OperatorT< Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >.

Definition at line 140 of file BelosMueLuAdapter.hpp.

Member Data Documentation

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<MueLu::Hierarchy<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Hierarchy_
private

Definition at line 164 of file BelosMueLuAdapter.hpp.

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
RCP<MueLu::AMGXOperator<Scalar, LocalOrdinal, GlobalOrdinal, Node> > Belos::MueLuOp< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AMGX_
private

Definition at line 166 of file BelosMueLuAdapter.hpp.


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