Tpetra Matrix/Vector Services Version of the Day
Tpetra_RowMatrixTransposer_decl.hpp
00001 
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //          Tpetra: Templated Linear Algebra Services Package
00006 //                 Copyright (2008) Sandia Corporation
00007 // 
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 // 
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
00039 // 
00040 // ************************************************************************
00041 // @HEADER
00042 
00043 #ifndef TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP
00044 #define TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP
00045 #include <Teuchos_RCP.hpp>
00046 #include <Kokkos_DefaultKernels.hpp>
00047 #include <Kokkos_DefaultNode.hpp>
00048 #include "Tpetra_CrsMatrix.hpp"
00049 #include "Tpetra_ConfigDefs.hpp"
00050 
00052 
00053 namespace Tpetra {
00054 
00055 template <class LocalOrdinal, class GlobalOrdinal, class Node>
00056 class Map;
00057 
00058 
00062 template <class Scalar, 
00063         class LocalOrdinal=int, 
00064         class GlobalOrdinal=LocalOrdinal, 
00065         class Node=Kokkos::DefaultNode::DefaultNodeType, 
00066     class SpMatOps   = typename Kokkos::DefaultKernels<Scalar,LocalOrdinal,Node>::SparseOps >
00067 class RowMatrixTransposer {
00068     
00069   public:
00070 
00072 
00073 
00074 
00081   RowMatrixTransposer(const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& origMatrix);
00082 
00084   
00085   virtual ~RowMatrixTransposer();
00087   
00089 
00090   
00092 
00100   RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps> >
00101   createTranspose(const OptimizeOption optimizeTranspose=DoOptimizeStorage
00102     , Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > transposeRowMap = Teuchos::null);
00103 
00104         
00105  private: 
00106         //The original matrix to be transposed.
00107         const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node>& origMatrix_;
00108         //The matrix in which the result of the tranpose is placed.
00109         RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps> > transposeMatrix_;
00110         //Whether or not to optimize the storage of the transpose matrix.
00111         OptimizeOption optimizeTranspose_;        
00112         const RCP<const Teuchos::Comm<int> > comm_;
00113         GlobalOrdinal indexBase_;
00114 };
00115 
00116 
00117 }
00118 
00119 #endif /* TPETRA_ROWMATRIXTRANSPOSER_DECL_HPP */
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines