Tpetra_Operator.hpp

// @HEADER
// *****************************************************************************
//          Tpetra: Templated Linear Algebra Services Package
//
// Copyright 2008 NTESS and the Tpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef TPETRA_OPERATOR_HPP
#define TPETRA_OPERATOR_HPP
 
#include <Tpetra_Operator_fwd.hpp>
#include <Tpetra_MultiVector_fwd.hpp>
#include <Tpetra_Vector_fwd.hpp>
#include <Tpetra_Map_fwd.hpp>
#include <Teuchos_Describable.hpp>
#include <Teuchos_BLAS_types.hpp>
#include <Teuchos_ScalarTraits.hpp>
 
namespace Tpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node>
class Operator : virtual public Teuchos::Describable {
 public:

  typedef Scalar scalar_type;

  typedef LocalOrdinal local_ordinal_type;

  typedef GlobalOrdinal global_ordinal_type;

  typedef Node node_type;



  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getDomainMap() const = 0;

  virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRangeMap() const = 0;


  virtual void
  apply(const MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &X,
        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 = 0;

  virtual bool hasTransposeApply() const;

  virtual bool hasDiagonal() const;

  virtual void getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag) const;

};
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
bool Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node>::hasTransposeApply() const {
  return false;
}
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
bool Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node>::hasDiagonal() const {
  return false;
}
 
template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
void Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node>::getLocalDiagCopy(Vector<Scalar, LocalOrdinal, GlobalOrdinal, Node> &diag) const {
  TEUCHOS_ASSERT(false);
}
 
}  // namespace Tpetra
 
#endif  // TPETRA_OPERATOR_HPP