Ifpack_Euclid.h

Go to the documentation of this file.

/*@HEADER
// ***********************************************************************
//
//       Ifpack: Object-Oriented Algebraic Preconditioner Package
//                 Copyright (2002) 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.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef IFPACK_EUCLID_H
#define IFPACK_EUCLID_H

#if defined(Ifpack_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Ifpack package is deprecated"
#endif
#endif

#include "Ifpack_ConfigDefs.h"
#ifdef HAVE_EUCLID

#include "Ifpack_Condest.h"
#include "Ifpack_ScalingType.h"
#include "Epetra_CompObject.h"
#include "Epetra_MultiVector.h"
#include "Epetra_Vector.h"
#include "Epetra_CrsGraph.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_BlockMap.h"
#include "Epetra_Map.h"
#include "Epetra_Object.h"
#include "Epetra_Comm.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_Time.h"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Epetra_MpiComm.h"

#include "Mem_dh.h"
#include "io_dh.h"
#include "TimeLog_dh.h"
#include "Parser_dh.h"
#include "Euclid_dh.h"

namespace Teuchos {
  class ParameterList;
}


  //The other files that were modified for Trilinos are getRow.c, call_epetra.{cpp,h}.

class Ifpack_Euclid: public Epetra_Object, public Epetra_CompObject, public virtual Epetra_Operator {

  friend std::ostream& operator << (std::ostream& os, const Ifpack_Euclid& A);

public:
  // @{ Constructors and destructors.
  Ifpack_Euclid(Epetra_CrsMatrix* A);

  ~Ifpack_Euclid(){ Destroy();}

  // @}
  // @{ Construction methods

  int Initialize();

  bool IsInitialized() const{ return(IsInitialized_);}


  int Compute();

  bool IsComputed() const{ return(IsComputed_);}



  int SetParameters(Teuchos::ParameterList& parameterlist);


  int SetParameter(std::string name, int Value);


  int SetParameter(std::string name, double Value);

  int SetUseTranspose(bool UseTranspose_in) {UseTranspose_ = UseTranspose_in; return(0);};
  // @}

  // @{ Mathematical functions.
  // Applies the matrix to X, returns the result in Y.
  int Apply(const Epetra_MultiVector& X,
               Epetra_MultiVector& Y) const{ return(Multiply(false,X,Y));}


  int Multiply(bool Trans, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const{ return A_->Multiply(Trans, X, Y); }


  int ApplyInverse(const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;

  double Condest(const Ifpack_CondestType CT = Ifpack_Cheap,  const int MaxIters = 1550,
                 const double Tol = 1e-9, Epetra_RowMatrix* Matrix_in = 0);

  double Condest() const{ return(Condest_);}

  // @}
  // @{ Query methods

  const char* Label() const {return(Label_);}

  void SetLabel(const char* Label_in){ strcpy(Label_,Label_in);}

  const Epetra_Map &OperatorDomainMap() const{return A_->DomainMap();}

  const Epetra_Map &OperatorRangeMap() const{return A_->RangeMap();}

  double NormInf() const {return(0.0);};

  bool HasNormInf() const {return(false);};

  bool UseTranspose() const {return(UseTranspose_);};

  const Epetra_Comm & Comm() const{return(A_->Comm());};

  const Epetra_CrsMatrix& Matrix() const{ return(*A_);}

  virtual int NumInitialize() const{ return(NumInitialize_);}

  virtual int NumCompute() const{ return(NumCompute_);}

  virtual int NumApplyInverse() const{ return(NumApplyInverse_);}

  virtual double InitializeTime() const{ return(InitializeTime_);}

  virtual double ComputeTime() const{ return(ComputeTime_);}

  virtual double ApplyInverseTime() const{ return(ApplyInverseTime_);}

  virtual double InitializeFlops() const{ return(0.0);}

  virtual double ComputeFlops() const{ return(ComputeFlops_);}

  virtual double ApplyInverseFlops() const{ return(ApplyInverseFlops_);}

private:

  // @}
  // @{ Private methods

  Ifpack_Euclid(const Ifpack_Euclid& RHS) : Time_(RHS.Comm()){}

  Ifpack_Euclid& operator=(const Ifpack_Euclid& RHS){ return(*this);}

  void Destroy();

  MPI_Comm GetMpiComm() const{ return (dynamic_cast<const Epetra_MpiComm*>(&A_->Comm()))->GetMpiComm();}

  int CallEuclid(double *x, double *y) const;


  int Solve(bool Trans, const Epetra_MultiVector& X, Epetra_MultiVector& Y) const;

  int NumGlobalRows() const {return(A_->NumGlobalRows());};

  int NumGlobalCols() const {return(A_->NumGlobalCols());};

  int NumMyRows() const {return(A_->NumMyRows());};

  int NumMyCols() const {return(A_->NumMyCols());};

  // @}
  // @{ Internal data

  Teuchos::RefCountPtr<Epetra_CrsMatrix> A_;
  Teuchos::ParameterList List_;
  bool UseTranspose_;
  double Condest_;
  bool IsInitialized_;
  bool IsComputed_;
  char Label_[160];
  int NumInitialize_;
  int NumCompute_;
  mutable int NumApplyInverse_;
  double InitializeTime_;
  double ComputeTime_;
  mutable double ApplyInverseTime_;
  double ComputeFlops_;
  mutable double ApplyInverseFlops_;
  mutable Epetra_Time Time_;
  Euclid_dh eu;
  int SetLevel_;
  int SetBJ_;
  int SetStats_;
  int SetMem_;
  double SetSparse_;
  int SetRowScale_;
  double SetILUT_;
};

std::ostream& operator << (std::ostream& os, const Ifpack_Euclid& A);

#endif // HAVE_EUCLID
#endif /* IFPACK_EUCLID_H */