45#ifndef IFPACK2_PRECONDITIONER_HPP
46#define IFPACK2_PRECONDITIONER_HPP
48#include "Ifpack2_ConfigDefs.hpp"
49#include "Tpetra_Operator.hpp"
50#include "Tpetra_RowMatrix.hpp"
51#include "Teuchos_ParameterList.hpp"
52#include "Teuchos_ScalarTraits.hpp"
99template<
class Scalar =
100 Tpetra::Operator<>::scalar_type,
102 typename Tpetra::Operator<Scalar>::local_ordinal_type,
103 class GlobalOrdinal =
104 typename Tpetra::Operator<Scalar, LocalOrdinal>::global_ordinal_type,
106 typename Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
108 virtual public Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
123 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
130 virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
139 apply (
const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
140 Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
141 Teuchos::ETransp mode = Teuchos::NO_TRANS,
142 Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
143 Scalar beta = Teuchos::ScalarTraits<Scalar>::zero())
const = 0;
149 virtual bool supportsZeroStartingSolution () {
return false; };
183 virtual Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> >
getMatrix()
const = 0;
Interface for all Ifpack2 preconditioners.
Definition Ifpack2_Preconditioner.hpp:108
virtual double getComputeTime() const =0
The time (in seconds) spent in compute().
virtual void setZeroStartingSolution(bool zeroStartingSolution)
Set this preconditioner's parameters.
Definition Ifpack2_Preconditioner.hpp:152
virtual bool isInitialized() const =0
True if the preconditioner has been successfully initialized, else false.
Teuchos::ScalarTraits< Scalar >::magnitudeType magnitude_type
The type of the magnitude (absolute value) of a matrix entry.
Definition Ifpack2_Preconditioner.hpp:111
virtual void compute()=0
Set up the numerical values in this preconditioner.
virtual int getNumCompute() const =0
The number of calls to compute().
virtual Teuchos::RCP< const Tpetra::RowMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > > getMatrix() const =0
The input matrix given to the constructor.
virtual int getNumApply() const =0
The number of calls to apply().
virtual double getApplyTime() const =0
The time (in seconds) spent in apply().
virtual void setParameters(const Teuchos::ParameterList &List)=0
Set this preconditioner's parameters.
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
Apply the preconditioner to X, putting the result in Y.
virtual ~Preconditioner()
Destructor.
Definition Ifpack2_Preconditioner.hpp:114
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getRangeMap() const =0
The range Map of this operator.
virtual Teuchos::RCP< const Tpetra::Map< LocalOrdinal, GlobalOrdinal, Node > > getDomainMap() const =0
The domain Map of this operator.
virtual bool isComputed() const =0
True if the preconditioner has been successfully computed, else false.
virtual void initialize()=0
Set up the graph structure of this preconditioner.
virtual double getInitializeTime() const =0
The time (in seconds) spent in initialize().
virtual int getNumInitialize() const =0
The number of calls to initialize().
Preconditioners and smoothers for Tpetra sparse matrices.
Definition Ifpack2_AdditiveSchwarz_decl.hpp:74