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 <Teuchos_RCP.hpp>
00033 #include <Kokkos_DefaultNode.hpp>
00034 #include <Kokkos_DefaultKernels.hpp>
00035 #include "Tpetra_ConfigDefs.hpp"
00036 #include "Tpetra_Operator.hpp"
00037 #include <Teuchos_TimeMonitor.hpp>
00038 
00039 
00045 namespace Tpetra {
00046 
00047 #ifndef DOXYGEN_SHOULD_SKIP_THIS  
00048   // forward declaration
00049   template <class MatScalar, class LocalOrdinal, class GlobalOrdinal, class Node, class LocalMatOps>
00050   class CrsMatrix;
00051 #endif
00052 
00054   template <class OpScalar, class MatScalar = OpScalar, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType, class LocalMatOps = typename Kokkos::DefaultKernels<MatScalar,LocalOrdinal,Node>::SparseOps >
00055   class CrsMatrixMultiplyOp : public Operator<OpScalar,LocalOrdinal,GlobalOrdinal,Node> {
00056     public:
00058 
00059 
00061       CrsMatrixMultiplyOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00062 
00064       virtual ~CrsMatrixMultiplyOp();
00065 
00067 
00069 
00070 
00073       void apply(const MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> & X, MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00074                  Teuchos::ETransp mode = Teuchos::NO_TRANS, OpScalar alpha = Teuchos::ScalarTraits<OpScalar>::one(), OpScalar beta = Teuchos::ScalarTraits<OpScalar>::zero()) const;
00075 
00078       bool hasTransposeApply() const;
00079 
00082       const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getDomainMap() const;
00083 
00086       const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getRangeMap() const;
00087 
00089     
00090     protected:
00091       typedef MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> MV;
00092 
00093       // underlying CrsMatrix
00094       const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > matrix_;
00095 
00096       // multivectors used for import/export dest/source in apply()
00097       mutable Teuchos::RCP<MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> > importMV_, exportMV_;
00098 
00099 #ifdef HAVE_KOKKOS_CUDA_NODE_MEMORY_PROFILING
00100     Teuchos::RCP<Teuchos::Time> importTimer_, exportTimer_;
00101 #endif
00102 
00103       // private methods for transpose or non-transpose
00104       void applyTranspose(const MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> & X, MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00105                           OpScalar alpha, OpScalar beta) const;
00106 
00107       void applyNonTranspose(const MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> & X, MultiVector<OpScalar,LocalOrdinal,GlobalOrdinal,Node> &Y, 
00108                              OpScalar alpha, OpScalar beta) const;
00109   };
00110 
00115   template <class OpScalar, class MatScalar, class LocalOrdinal, class GlobalOrdinal, class Node, class LocalMatOps>
00116   Teuchos::RCP< CrsMatrixMultiplyOp<OpScalar,MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> >
00117   createCrsMatrixMultiplyOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00118 
00119 } // end of namespace Tpetra
00120 
00121 #endif // TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:21:41 2011 for Tpetra Matrix/Vector Services by  doxygen 1.6.3