Ifpack2 Templated Preconditioning Package Version 1.0
Public Member Functions
Ifpack2::BorderedOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Ifpack2 bordered operator. More...

#include <Ifpack2_BorderedOperator_decl.hpp>

Inherits Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

List of all members.

Public Member Functions

virtual ~BorderedOperator ()
 Destructor.
 BorderedOperator (const Teuchos::RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &A)
 constuctor with Tpetra::Operator input.
Methods implementing Tpetra::Operator.
virtual const Teuchos::RCP
< const Tpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > & 
getDomainMap () const
 Returns the Map associated with the domain of this operator, which must be compatible with X.getMap().
virtual const Teuchos::RCP
< const Tpetra::Map
< LocalOrdinal, GlobalOrdinal,
Node > > & 
getRangeMap () const
 Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().
bool hasTransposeApply () const
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 >::zero()) const
 Applies the effect of the bordered operator.

Detailed Description

template<class Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
class Ifpack2::BorderedOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Ifpack2 bordered operator.

Ifpack2::BorderedOperator is a concrete class extending Tpetra::Operator and defining an interface.

This class extends Tpetra::Operator, providing the additional methods:

The bordered operator is applied by apply() (which returns if isComputed() is false). Each time compute() is called, the object re-computes the actual values of the bordered operator.

Title of Method Description


Constructor & Destructor Documentation

template<class Scalar , class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
virtual Ifpack2::BorderedOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~BorderedOperator ( ) [inline, virtual]

Destructor.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Ifpack2::BorderedOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BorderedOperator ( const Teuchos::RCP< const Tpetra::Operator< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  A)

constuctor with Tpetra::Operator input.


Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & Ifpack2::BorderedOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getDomainMap ( ) const [virtual]

Returns the Map associated with the domain of this operator, which must be compatible with X.getMap().

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > & Ifpack2::BorderedOperator< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getRangeMap ( ) const [virtual]

Returns the Map associated with the range of this operator, which must be compatible with Y.getMap().

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Ifpack2::BorderedOperator< 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>::zero() 
) const

Applies the effect of the bordered operator.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends