Xpetra_Operator.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//             Xpetra: A linear algebra interface package
//
// Copyright 2012 NTESS and the Xpetra contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef XPETRA_OPERATOR_HPP
#define XPETRA_OPERATOR_HPP

#include "Xpetra_ConfigDefs.hpp"

#include <Teuchos_Describable.hpp>
#include <Teuchos_BLAS_types.hpp>
#include <Teuchos_ScalarTraits.hpp>

#include "Xpetra_Map.hpp"
#include "Xpetra_MultiVector.hpp"

namespace Xpetra {

template <class Scalar,
          class LocalOrdinal,
          class GlobalOrdinal,
          class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Operator : virtual public Teuchos::Describable {
  typedef Xpetra::Map<LocalOrdinal, GlobalOrdinal, Node> map_type;
  typedef Xpetra::MultiVector<Scalar, LocalOrdinal, GlobalOrdinal, Node> mv_type;

 public:
  virtual ~Operator() {}

  typedef Scalar scalar_type;

  typedef LocalOrdinal local_ordinal_type;

  typedef GlobalOrdinal global_ordinal_type;

  typedef Node node_type;



  virtual const Teuchos::RCP<const map_type> getDomainMap() const = 0;

  virtual const Teuchos::RCP<const map_type> getRangeMap() const = 0;


  virtual void
  apply(const mv_type& X, mv_type& 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 { return false; }


  virtual void removeEmptyProcessesInPlace(const RCP<const map_type>& /* newMap */) {}

  virtual void residual(const mv_type& X,
                        const mv_type& B,
                        mv_type& R) const = 0;
};

}  // namespace Xpetra

#define XPETRA_OPERATOR_SHORT
#endif  // XPETRA_OPERATOR_HPP