Ifpack2_SparseContainer_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
*/

#ifndef IFPACK2_SPARSECONTAINER_DECL_HPP
#define IFPACK2_SPARSECONTAINER_DECL_HPP

#include "Ifpack2_Container.hpp"
#include "Tpetra_MultiVector.hpp"
#include "Tpetra_Map.hpp"
#include "Tpetra_RowMatrix.hpp"
#include "Tpetra_CrsMatrix.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_RefCountPtr.hpp"


namespace Ifpack2 {

template<typename MatrixType, typename InverseType >
class SparseContainer : public Container<MatrixType,InverseType> {

public:
  typedef typename MatrixType::scalar_type          MatrixScalar;
  typedef typename MatrixType::local_ordinal_type   MatrixLocalOrdinal;
  typedef typename MatrixType::global_ordinal_type  MatrixGlobalOrdinal;
  typedef typename MatrixType::node_type            MatrixNode;

  typedef typename InverseType::scalar_type         InverseScalar;
  typedef typename InverseType::local_ordinal_type  InverseLocalOrdinal;
  typedef typename InverseType::global_ordinal_type InverseGlobalOrdinal;
  typedef typename InverseType::node_type           InverseNode;


  SparseContainer(const size_t NumRows, const size_t NumVectors = 1);

  virtual ~SparseContainer();


  virtual size_t getNumRows() const;

  // Returns the number of vectors in X/Y.
  //  virtual size_t getNumVectors() const;


  virtual MatrixLocalOrdinal & ID(const size_t i);

  virtual bool isInitialized() const;

  virtual bool isComputed() const;

  virtual void setParameters(const Teuchos::ParameterList& List);



  virtual void initialize();
  virtual void compute(const Teuchos::RCP<const Tpetra::RowMatrix<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode> >& Matrix);


  virtual void apply(const Tpetra::MultiVector<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode>& X,
         Tpetra::MultiVector<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode>& Y,
         Teuchos::ETransp mode=Teuchos::NO_TRANS,
         MatrixScalar alpha=Teuchos::ScalarTraits< MatrixScalar >::one(),
         MatrixScalar beta=Teuchos::ScalarTraits< MatrixScalar >::zero());


  virtual void weightedApply(const Tpetra::MultiVector<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode>& X,
           Tpetra::MultiVector<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode>& Y,
           const Tpetra::Vector<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode>& D,
           Teuchos::ETransp mode=Teuchos::NO_TRANS,
           MatrixScalar alpha=Teuchos::ScalarTraits< MatrixScalar >::one(),
           MatrixScalar beta=Teuchos::ScalarTraits< MatrixScalar >::zero());




  virtual void destroy();

  virtual std::ostream& print(std::ostream& os) const;



  virtual std::string description() const;

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


private:
  // private copy constructor
  SparseContainer(const SparseContainer<MatrixType,InverseType>& rhs);

  virtual void setNumVectors(const size_t NumVectors);

  virtual void extract(const Teuchos::RCP<const Tpetra::RowMatrix<MatrixScalar,MatrixLocalOrdinal,MatrixGlobalOrdinal,MatrixNode> >& Matrix);
  
  size_t NumRows_; 
  size_t NumVectors_; 
  Teuchos::RCP<Tpetra::Map<InverseLocalOrdinal,InverseGlobalOrdinal,InverseNode> > Map_;
  Teuchos::RCP<Tpetra::CrsMatrix<InverseScalar,InverseLocalOrdinal,InverseGlobalOrdinal,InverseNode> > Matrix_;
  mutable Teuchos::RCP<Tpetra::MultiVector<InverseScalar,InverseLocalOrdinal,InverseGlobalOrdinal,InverseNode> > Y_;
  mutable Teuchos::RCP<Tpetra::MultiVector<InverseScalar,InverseLocalOrdinal,InverseGlobalOrdinal,InverseNode> > X_;
  std::vector<MatrixLocalOrdinal> GID_;
  bool IsInitialized_;
  bool IsComputed_;
  Teuchos::RCP<Teuchos::Comm<int> > LocalComm_;
  Teuchos::RCP<InverseType> Inverse_;

  Teuchos::ParameterList List_;

};

}// namespace Ifpack2



#endif // IFPACK2_SPARSECONTAINER_HPP