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 the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 // @HEADER
00041 
00042 #ifndef TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
00043 #define TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
00044 
00045 #include <Kokkos_DefaultNode.hpp>
00046 #include <Kokkos_DefaultKernels.hpp>
00047 #include "Tpetra_ConfigDefs.hpp"
00048 #include "Tpetra_Operator.hpp"
00049 #include <Teuchos_TimeMonitor.hpp>
00050 
00051 
00057 namespace Tpetra {
00058 
00059 #ifndef DOXYGEN_SHOULD_SKIP_THIS
00060   // forward declaration
00061   template <class MatScalar, class LocalOrdinal, class GlobalOrdinal, class Node, class LocalMatOps>
00062   class CrsMatrix;
00063 #endif
00064 
00130   template <class Scalar,
00131             class MatScalar = Scalar,
00132             class LocalOrdinal = int,
00133             class GlobalOrdinal = LocalOrdinal,
00134             class Node = KokkosClassic::DefaultNode::DefaultNodeType,
00135             class LocalMatOps = typename KokkosClassic::DefaultKernels<MatScalar,LocalOrdinal,Node>::SparseOps >
00136   class CrsMatrixMultiplyOp :
00137     public Operator<Scalar,LocalOrdinal,GlobalOrdinal,Node>
00138   {
00139   public:
00141 
00142 
00147     CrsMatrixMultiplyOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00148 
00150     virtual ~CrsMatrixMultiplyOp();
00151 
00153 
00154 
00155 
00161     void
00162     apply (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& X,
00163            MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& Y,
00164            Teuchos::ETransp mode = Teuchos::NO_TRANS,
00165            Scalar alpha = Teuchos::ScalarTraits<Scalar>::one(),
00166            Scalar beta = Teuchos::ScalarTraits<Scalar>::zero()) const;
00167 
00207     void
00208     gaussSeidel (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &B,
00209                  MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
00210                  const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &D,
00211                  const Scalar& dampingFactor,
00212                  const ESweepDirection direction,
00213                  const int numSweeps) const;
00214 
00239     void
00240     gaussSeidelCopy (MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &X,
00241                      const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &B,
00242                      const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &D,
00243                      const Scalar& dampingFactor,
00244                      const ESweepDirection direction,
00245                      const int numSweeps) const;
00246 
00252     bool hasTransposeApply() const;
00253 
00255     Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getDomainMap() const;
00256 
00258     Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > getRangeMap() const;
00259 
00261 
00262   protected:
00263     typedef MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> MV;
00264 
00266     const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > matrix_;
00267 
00280     mutable Teuchos::RCP<MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > importMV_;
00281 
00294     mutable Teuchos::RCP<MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> > exportMV_;
00295 
00296 #ifdef HAVE_KOKKOSCLASSIC_CUDA_NODE_MEMORY_PROFILING
00297     Teuchos::RCP<Teuchos::Time> importTimer_, exportTimer_;
00298 #endif
00299 
00302     void
00303     applyTranspose (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& X,
00304                     MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
00305         Teuchos::ETransp mode, 
00306                     Scalar alpha,
00307                     Scalar beta) const;
00308 
00310     void
00311     applyNonTranspose (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& X,
00312                        MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node> &Y,
00313                        Scalar alpha,
00314                        Scalar beta) const;
00315 
00316   private:
00336     Teuchos::RCP<MV>
00337     getColumnMapMultiVector (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& X_domainMap,
00338                              const bool force = false) const;
00339 
00361     Teuchos::RCP<MV>
00362     getRowMapMultiVector (const MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>& Y_rangeMap,
00363                           const bool force = false) const;
00364   };
00365 
00373   template <class Scalar,
00374             class MatScalar,
00375             class LocalOrdinal,
00376             class GlobalOrdinal,
00377             class Node,
00378             class LocalMatOps>
00379   Teuchos::RCP< CrsMatrixMultiplyOp<Scalar,MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> >
00380   createCrsMatrixMultiplyOp(const Teuchos::RCP<const CrsMatrix<MatScalar,LocalOrdinal,GlobalOrdinal,Node,LocalMatOps> > &A);
00381 
00382 } // end of namespace Tpetra
00383 
00384 #endif // TPETRA_CRSMATRIXMULTIPLYOP_DECL_HPP
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines