Tpetra Matrix/Vector Services Version of the Day
Tpetra_CrsMatrixMultiplyOp_decl.hpp
Go to the documentation of this file.
00001 //@HEADER
00002 // ************************************************************************
00003 // 
00004 //               Tpetra: Templated Linear Algebra Services Package 
00005 //                 Copyright (2008) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ************************************************************************
00027 //@HEADER
00028 
00029 #ifndef TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
00030 #define TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
00031 
00032 #include <Kokkos_DefaultNode.hpp>
00033 #include <Kokkos_DefaultKernels.hpp>
00034 #include "Tpetra_ConfigDefs.hpp"
00035 #include "Tpetra_Operator.hpp"
00036 #include <Teuchos_TimeMonitor.hpp>
00037 
00038 
00044 namespace Tpetra {
00045 
00046 #ifndef DOXYGEN_SHOULD_SKIP_THIS  
00047   // forward declaration
00048   template <class MatScalar, class LocalOrdinal, class GlobalOrdinal, class Node, class LocalMatOps>
00049   class CrsMatrix;
00050 #endif
00051 
00053   template <class Scalar, class MatScalar = Scalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType, class LocalMatOps = typename Kokkos::DefaultKernels<MatScalar,LocalOrdinal,Node>::SparseOps >
00054   class CrsMatrixMultiplyOp : public Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node> {
00055     public:
00057 
00058 
00060       CrsMatrixMultiplyOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00061 
00063       virtual ~CrsMatrixMultiplyOp();
00064 
00066 
00068 
00069 
00072       void apply(const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & X, MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00073                  Teuchos::ETransp mode = Teuchos::NO_TRANS, Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(), Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;
00074 
00077       bool hasTransposeApply() const;
00078 
00081       const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getDomainMap() const;
00082 
00085       const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getRangeMap() const;
00086 
00088     
00089     protected:
00090       typedef MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> MV;
00091 
00092       // underlying CrsMatrix
00093       const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > matrix_;
00094 
00095       // multivectors used for import/export dest/source in apply()
00096       mutable Teuchos::RCP<MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > importMV_, exportMV_;
00097 
00098 #ifdef HAVE_KOKKOS_CUDA_NODE_MEMORY_PROFILING
00099     Teuchos::RCP<Teuchos::Time> importTimer_, exportTimer_;
00100 #endif
00101 
00102       // private methods for transpose or non-transpose
00103       void applyTranspose(const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & X, MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00104                           Scalar alpha, Scalar beta) const;
00105 
00106       void applyNonTranspose(const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> & X, MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00107                              Scalar alpha, Scalar beta) const;
00108   };
00109 
00114   template <class Scalar, class MatScalar, class LocalOrdinal, class GlobalOrdinal, class Node, class LocalMatOps>
00115   Teuchos::RCP< CrsMatrixMultiplyOp<Scalar,MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> >
00116   createCrsMatrixMultiplyOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00117 
00118 } // end of namespace Tpetra
00119 
00120 #endif // TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines