Amesos_CSparse.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_CSPARSE_H
#define AMESOS_CSPARSE_H

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

#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 "Amesos_Support.h"
#include "Epetra_LinearProblem.h"
#include "Epetra_Time.h"
#include "Epetra_Map.h"
#include "Epetra_Import.h"
#include "Epetra_Comm.h"
#include "Epetra_RowMatrix.h"
#include "Epetra_CrsMatrix.h"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RCP.hpp"

#include "cs.h"


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

public: 

  Amesos_CSparse(const Epetra_LinearProblem& LinearProblem );

  ~Amesos_CSparse();


  int SymbolicFactorization() ;

  int NumericFactorization() ;

  int Solve();
  

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


  bool MatrixShapeOK() const;


  int SetUseTranspose(bool UseTranspose) { UseTranspose_ = UseTranspose; return(0); }

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

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

  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); }
 

private:  
  
  int CheckError(const int error) const;

  inline const Epetra_Map& Map() const
  {
    return(Matrix_->RowMatrixRowMap());
  }
  
  inline const Epetra_RowMatrix& Matrix() const
  {
    return(*Matrix_);
  }

  inline Epetra_Map& SerialMap() 
  {
    return(*(SerialMap_.get()));
  }
  
  inline Epetra_RowMatrix& SerialMatrix()
  {
    return(*(SerialMatrix_.get()));
  }

  inline Epetra_CrsMatrix& SerialCrsMatrix()
  {
    return(*(SerialCrsMatrix_.get()));
  }

  inline Epetra_Import& Importer()
  {
    return(*(Importer_.get()));
  }
  
  int ConvertToSerial();
  int ConvertToCSparse();
  int PerformSymbolicFactorization();
  int PerformNumericFactorization(); 

  Teuchos::RCP<Epetra_Map> SerialMap_;
  Teuchos::RCP<Epetra_CrsMatrix> SerialCrsMatrix_;
  Teuchos::RCP<Epetra_RowMatrix> SerialMatrix_;
  Teuchos::RCP<Epetra_Import> Importer_;
  Teuchos::RCP<Amesos_StandardIndex> StdIndex_; 
  Teuchos::RCP<Amesos_StandardIndex> StdIndexRange_; 
  Teuchos::RCP<Amesos_StandardIndex> StdIndexDomain_; 

  const Epetra_Map* Map_;
  const Epetra_RowMatrix* Matrix_;

  bool UseTranspose_;
  const Epetra_LinearProblem* Problem_;

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

#ifdef HAVE_AMESOS_CSPARSE
  // Data for CSparse
  cs csMatrix;
  cs *csTranMatrix;
  css *csSymbolic;
  csn *csNumeric;
#endif

  //int mtype_;
  //void* pt_[64];

  //int iparm_[64];
  //int maxfct_; // Maximal number of factors with idential nonzero pattern (always 1)
  //int mnum_; //! Actual matrix for solution phase (always 1)
  //int msglvl_; //! Output level
  //int nrhs_; // Number of RHS

};  // class Amesos_CSparse  

#endif
#endif // AMESOS_CSPARSE_H