Tpetra_ApplyOp.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef TPETRA_APPLYOP_HPP
#define TPETRA_APPLYOP_HPP

#include "Tpetra_ConfigDefs.hpp"
#include "Tpetra_Operator.hpp"
#include "Tpetra_MultiVector.hpp"


namespace Tpetra {
namespace details {

template <class Scalar, class OperatorType>
class ApplyOp : public Tpetra::Operator<Scalar,
                                        typename OperatorType::local_ordinal_type,
                                        typename OperatorType::global_ordinal_type,
                                        typename OperatorType::node_type> {
 public:
  // \name Typedefs

  typedef typename OperatorType::scalar_type scalar_type;

  typedef typename OperatorType::local_ordinal_type local_ordinal_type;

  typedef typename OperatorType::global_ordinal_type global_ordinal_type;

  typedef typename OperatorType::node_type node_type;



  ApplyOp(const Teuchos::RCP<const OperatorType>& op)
    : operator_(op) {}

  virtual ~ApplyOp() {}



  void
  apply(const Tpetra::MultiVector<Scalar, local_ordinal_type, global_ordinal_type, node_type>& X,
        Tpetra::MultiVector<Scalar, local_ordinal_type, global_ordinal_type, node_type>& Y,
        Teuchos::ETransp mode = Teuchos::NO_TRANS,
        Scalar alpha          = Teuchos::ScalarTraits<Scalar>::one(),
        Scalar beta           = Teuchos::ScalarTraits<Scalar>::zero()) const {
    operator_->template applyTempl<Scalar, Scalar>(X, Y, mode, alpha, beta);
  }

  bool hasTransposeApply() const {
    return operator_->hasTransposeApply();
  }

  Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
  getDomainMap() const {
    return operator_->getDomainMap();
  }

  Teuchos::RCP<const Tpetra::Map<local_ordinal_type, global_ordinal_type, node_type> >
  getRangeMap() const {
    return operator_->getRangeMap();
  }

 protected:
  Teuchos::RCP<const OperatorType> operator_;
};

}  // end of namespace details
}  // end of namespace Tpetra

#endif  // TPETRA_APPLYOP_HPP