Amesos_Mumps.h

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                Amesos: Direct Sparse Solver Package
//                 Copyright (2004) 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef AMESOS_MUMPS_H
#define AMESOS_MUMPS_H

#if defined(Amesos_SHOW_DEPRECATED_WARNINGS)
#ifdef __GNUC__
#warning "The Amesos package is deprecated"
#endif
#endif

class Epetra_Import;
class Epetra_RowMatrix;
class Epetra_MultiVector;
#include "Epetra_Import.h"
#include "Epetra_CrsMatrix.h"
#include "Epetra_Map.h"
#include "Epetra_SerialDenseVector.h"
class Epetra_IntSerialDenseVector;
class Epetra_SerialDenseMatrix;
class Amesos_EpetraInterface;

#include "Amesos_ConfigDefs.h"
#include "Amesos_BaseSolver.h"
#include "Amesos_NoCopiable.h"
#include "Amesos_Utils.h"
#include "Amesos_Time.h"
#include "Amesos_Status.h"
#include "Amesos_Control.h"
#include "Epetra_LinearProblem.h"
#ifdef EPETRA_MPI
#include "Epetra_MpiComm.h"
#else
#include "Epetra_Comm.h"
#endif
#include "Teuchos_RCP.hpp"
#include <map>
using namespace Teuchos;


extern "C" {
#include "dmumps_c.h"
}

class Amesos_Mumps: public Amesos_BaseSolver,
                    private Amesos_Time, 
                    private Amesos_NoCopiable, 
                    private Amesos_Utils,  
                    private Amesos_Control,  
                    private Amesos_Status { 

public: 


  Amesos_Mumps(const Epetra_LinearProblem& LinearProblem);


  ~Amesos_Mumps(void);


  int SymbolicFactorization() ;

  int NumericFactorization() ;

  int Solve();

  void Destroy();
  
  int SetUseTranspose(bool UseTranspose_in)
  {
    UseTranspose_ = UseTranspose_in;
    if (UseTranspose_in)
      return (-1);
    return (0);
  };
  
  bool UseTranspose() const {return(UseTranspose_);};

  int SetParameters( Teuchos::ParameterList &ParameterList );
  


  int NumSymbolicFact() const { return( Amesos_Status::NumSymbolicFact_ ); }

  int NumNumericFact() const { return( Amesos_Status::NumNumericFact_ ); }

  int NumSolve() const { return( Amesos_Status::NumSolve_ ); }


  

  void PrintTiming() const;
  

  void PrintStatus() const;

  void GetTiming( Teuchos::ParameterList &TimingParameterList ) const { Amesos_Time::GetTiming(TimingParameterList); }



  
#if 0

  int ComputeSchurComplement(bool flag,
           int NumSchurComplementRows, int * SchurComplementRows);


  Epetra_CrsMatrix * GetCrsSchurComplement();


  Epetra_SerialDenseMatrix * GetDenseSchurComplement();
#endif
  

  int SetPrecscaling(double * ColSca, double * RowSca )
  {
    ColSca_ = ColSca;
    RowSca_ = RowSca;
    return 0;
  }


  int SetRowScaling(double * RowSca )
  {
    RowSca_ = RowSca;
    return 0;
  }


  int SetColScaling(double * ColSca )
  {
    ColSca_ = ColSca;
    return 0;
  }


  int SetOrdering(int * PermIn)
  {
    PermIn_ = PermIn;
    return 0;
  }


  double * GetRINFO() ;


  int * GetINFO() ;


  double * GetRINFOG() ;


  int * GetINFOG() ;

  void SetICNTL(int pos, int value);

  void SetCNTL(int pos, double value);

  
  bool MatrixShapeOK() const
  {
  bool OK = true;

  if ( GetProblem()->GetOperator()->OperatorRangeMap().NumGlobalPoints() != 
       GetProblem()->GetOperator()->OperatorDomainMap().NumGlobalPoints() ) OK = false;
  return OK; 
}

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

  const Epetra_LinearProblem * GetProblem() const { return(Problem_); };

protected:
  
  Epetra_RowMatrix& Matrix();

  const Epetra_RowMatrix& Matrix() const;

  Epetra_Map& RedistrMap();

  Epetra_Import& RedistrImporter();
  
  Epetra_RowMatrix& RedistrMatrix(const bool ImportMatrix = false);

  Epetra_Map& SerialMap();

  Epetra_Import& SerialImporter();

  int ConvertToTriplet(const bool OnlyValues);     

  int CheckError();

  void CheckParameters();
  
  void SetICNTLandCNTL();

  bool IsConvertToTripletOK_;
  bool IsComputeSchurComplementOK_;


  bool NoDestroy_ ;  // Set true to prevent memory freeing
  
  std::vector <int> Row;
  std::vector<int> Col;
  std::vector<double> Val;

  int MaxProcs_;
  
  bool UseTranspose_;

  int MtxConvTime_, MtxRedistTime_, VecRedistTime_;
  int SymFactTime_, NumFactTime_, SolveTime_;  

  double * RowSca_, * ColSca_; 

  int * PermIn_;

  int NumSchurComplementRows_;
  int * SchurComplementRows_;

  RCP<Epetra_CrsMatrix> CrsSchurComplement_; 
  RCP<Epetra_SerialDenseMatrix> DenseSchurComplement_;

#ifdef HAVE_MPI
  MPI_Comm MUMPSComm_;
#endif

  const Epetra_LinearProblem* Problem_;

  RCP<Epetra_Map> RedistrMap_;
  RCP<Epetra_Import> RedistrImporter_;
  RCP<Epetra_CrsMatrix> RedistrMatrix_;
  RCP<Epetra_Map> SerialMap_;
  RCP<Epetra_Import> SerialImporter_;
  
  DMUMPS_STRUC_C MDS;

  std::map<int, int> ICNTL;
  std::map<int, double> CNTL;
};  // class Amesos_Mumps

#endif /* AMESOS_MUMPS_H */