Ifpack2_Preconditioner.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//       Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
//
// Copyright 2009 NTESS and the Ifpack2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER


#ifndef IFPACK2_PRECONDITIONER_HPP
#define IFPACK2_PRECONDITIONER_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Tpetra_Operator.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_ScalarTraits.hpp"
#include <iostream>

namespace Ifpack2 {

template <class Scalar =
              Tpetra::Operator<>::scalar_type,
          class LocalOrdinal =
              typename Tpetra::Operator<Scalar>::local_ordinal_type,
          class GlobalOrdinal =
              typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type,
          class Node =
              typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class Preconditioner : virtual public Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
 public:
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitude_type;

  virtual ~Preconditioner() {}



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

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

  virtual 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 = 0;

  virtual void setParameters(const Teuchos::ParameterList &List) = 0;

  virtual bool supportsZeroStartingSolution() { return false; };

  virtual void setZeroStartingSolution(bool zeroStartingSolution) { TEUCHOS_ASSERT(false); };

  virtual void initialize() = 0;

  virtual bool isInitialized() const = 0;

  virtual void compute() = 0;

  virtual bool isComputed() const = 0;

  virtual Teuchos::RCP<const Tpetra::RowMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node> > getMatrix() const = 0;

  virtual int getNumInitialize() const = 0;

  virtual int getNumCompute() const = 0;

  virtual int getNumApply() const = 0;

  virtual double getInitializeTime() const = 0;

  virtual double getComputeTime() const = 0;

  virtual double getApplyTime() const = 0;
};

}  // namespace Ifpack2

#endif  // IFPACK2_PRECONDITIONER_HPP