Ifpack2 Templated Preconditioning Package Version 1.0
Ifpack2_Preconditioner.hpp
Go to the documentation of this file.
00001 /*@HEADER
00002 // ***********************************************************************
00003 //
00004 //       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2009) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 */
00042 
00044 
00045 #ifndef IFPACK2_PRECONDITIONER_HPP
00046 #define IFPACK2_PRECONDITIONER_HPP
00047 
00048 #include "Ifpack2_ConfigDefs.hpp"
00049 #include "Ifpack2_CondestType.hpp"
00050 #include "Kokkos_DefaultNode.hpp"
00051 #include "Tpetra_Operator.hpp"
00052 #include "Tpetra_RowMatrix.hpp"
00053 #include "Teuchos_ParameterList.hpp"
00054 #include "Teuchos_ScalarTraits.hpp"
00055 #include <iostream>
00056 
00057 namespace Ifpack2 {
00058 
00100 template<class Scalar,
00101          class LocalOrdinal = int,
00102          class GlobalOrdinal = LocalOrdinal,
00103          class Node = KokkosClassic::DefaultNode::DefaultNodeType>
00104 class Preconditioner :
00105     virtual public Tpetra::Operator<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
00106 public:
00108   typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitude_type;
00109 
00111   TEUCHOS_DEPRECATED typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;
00112 
00114   virtual ~Preconditioner(){}
00115 
00117 
00118 
00123   virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
00124   getDomainMap () const = 0;
00125 
00130   virtual Teuchos::RCP<const Tpetra::Map<LocalOrdinal,GlobalOrdinal,Node> >
00131   getRangeMap () const = 0;
00132 
00138   virtual void
00139   apply (const Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
00140          Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
00141          Teuchos::ETransp mode = Teuchos::NO_TRANS,
00142          Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00143          Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const = 0;
00145 
00147   virtual void setParameters (const Teuchos::ParameterList& List) = 0;
00148 
00158   virtual void initialize() = 0;
00159 
00161   virtual bool isInitialized() const = 0;
00162 
00172   virtual void compute() = 0;
00173 
00175   virtual bool isComputed() const = 0;
00176 
00186   virtual magnitude_type TEUCHOS_DEPRECATED
00187   computeCondEst (CondestType CT = Ifpack2::Cheap,
00188                   LocalOrdinal MaxIters = 1550,
00189                   magnitude_type Tol = 1e-9,
00190                   const Teuchos::Ptr<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &Matrix = Teuchos::null) = 0;
00191 
00195   virtual magnitude_type TEUCHOS_DEPRECATED getCondEst() const = 0;
00196 
00198   virtual Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > getMatrix() const = 0;
00199 
00201   virtual int getNumInitialize() const = 0;
00202 
00204   virtual int getNumCompute() const = 0;
00205 
00207   virtual int getNumApply() const = 0;
00208 
00210   virtual double getInitializeTime() const = 0;
00211 
00213   virtual double getComputeTime() const = 0;
00214 
00216   virtual double getApplyTime() const = 0;
00217 };
00218 
00219 }//namespace Ifpack2
00220 
00221 #endif // IFPACK2_PRECONDITIONER_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends