Ifpack2_ILUT_decl.hpp

/*@HEADER
// ***********************************************************************
// 
//       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2009) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
//@HEADER
*/

//-----------------------------------------------------
// Ifpack2::ILUT is a translation of the Aztec ILUT
// implementation. The Aztec ILUT implementation was
// written by Ray Tuminaro.
// See notes in the Ifpack2::ILUT::Compute method.
// ABW.
//------------------------------------------------------

#ifndef IFPACK2_ILUT_DECL_HPP
#define IFPACK2_ILUT_DECL_HPP

#include "Ifpack2_ConfigDefs.hpp"
#include "Ifpack2_Preconditioner.hpp"
#include "Ifpack2_Condest.hpp"
#include "Ifpack2_Heap.hpp"
#include "Ifpack2_Parameters.hpp"

#include <Teuchos_Assert.hpp>
#include <Teuchos_RCP.hpp>
#include <Teuchos_Time.hpp>
#include <Teuchos_TypeNameTraits.hpp>
#include <Teuchos_ScalarTraits.hpp>

#include <string>
#include <sstream>
#include <iostream>
#include <cmath>

namespace Teuchos {
  // forward declaration
  class ParameterList;
}

namespace Ifpack2 {

// of a given Tpetra::RowMatrix.

template<class MatrixType>
class ILUT: virtual public Ifpack2::Preconditioner<typename MatrixType::scalar_type,typename MatrixType::local_ordinal_type,typename MatrixType::global_ordinal_type,typename MatrixType::node_type> {

public:
  typedef typename MatrixType::scalar_type Scalar;
  typedef typename MatrixType::local_ordinal_type LocalOrdinal;
  typedef typename MatrixType::global_ordinal_type GlobalOrdinal;
  typedef typename MatrixType::node_type Node;
  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType magnitudeType;

  // \name Constructors and Destructors

  explicit ILUT(const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &A);

  virtual ~ILUT();




  void setParameters(const Teuchos::ParameterList& params);


  void initialize();

  inline bool isInitialized() const {
    return(IsInitialized_);
  }


  void compute();

  inline bool isComputed() const {
    return(IsComputed_);
  }





  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;

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

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

  bool hasTransposeApply() const;




  magnitudeType computeCondEst(CondestType CT = Cheap, 
                               LocalOrdinal MaxIters = 1550,
                               magnitudeType Tol = 1e-9,
                               const Teuchos::Ptr<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > &Matrix_in = Teuchos::null);

  magnitudeType getCondEst() const { return Condest_; }

  const Teuchos::RCP<const Teuchos::Comm<int> > & getComm() const;

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

  const Teuchos::RCP<const MatrixType> getL() const { return L_; }
  
  const Teuchos::RCP<const MatrixType> getU() const { return U_; }
    
  int getNumInitialize() const;

  int getNumCompute() const;

  int getNumApply() const;

  double getInitializeTime() const;

  double getComputeTime() const;

  double getApplyTime() const;

  inline double getLevelOfFill() const {
    return(LevelOfFill_);
  }

  inline double getAbsoluteThreshold() const {
    return(Athresh_);
  }

  inline double getRelativeThreshold() const {
    return(Rthresh_);
  }

  inline magnitudeType getRelaxValue() const {
    return(RelaxValue_);
  }

  inline magnitudeType getDropTolerance() const {
    return(DropTolerance_);
  }

  global_size_t getGlobalNumEntries() const;

  size_t getNodeNumEntries() const;

  // @}



  std::string description() const;

  void describe(Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const;


private:

  // @{ Internal methods

  ILUT(const ILUT<MatrixType>& RHS);

  ILUT<MatrixType>& operator=(const ILUT<MatrixType>& RHS);


  // @{ Internal data and parameters

  const Teuchos::RCP<const Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node> > A_;
  const Teuchos::RCP<const Teuchos::Comm<int> > Comm_;
  Teuchos::RCP<MatrixType> L_;
  Teuchos::RCP<MatrixType> U_;
  double Athresh_;
  double Rthresh_;
  magnitudeType RelaxValue_;
  double LevelOfFill_;
  magnitudeType DropTolerance_;
  magnitudeType Condest_;
  bool IsInitialized_;
  bool IsComputed_;
  int NumInitialize_;
  int NumCompute_;
  mutable int NumApply_;
  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyTime_;
  mutable Teuchos::Time Time_;
  LocalOrdinal NumMyRows_;
  global_size_t NumGlobalNonzeros_;


}; // class ILUT

}//namespace Ifpack2

#endif /* IFPACK2_ILUT_HPP */