Tpetra Matrix/Vector Services Version of the Day
TpetraExt_MMHelpers_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 
00043 #ifndef TPETRA_MMHELPERS_DECL_HPP
00044 #define TPETRA_MMHELPERS_DECL_HPP
00045 
00046 #include "Tpetra_ConfigDefs.hpp"
00047 #include "Teuchos_Array.hpp"
00048 #include <Kokkos_DefaultNode.hpp>
00049 #include <Kokkos_DefaultKernels.hpp>
00050 #include <set>
00051 #include <map>
00052 
00053 
00059 namespace Tpetra {
00060 #ifndef DOXYGEN_SHOULD_SKIP_THIS  
00061   // forward declaration
00062 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node, class SpMatOps>
00063 class CrsMatrix;
00064 
00065 template <class LocalOrdinal, class GlobalOrdinal, class Node>
00066 class Map;
00067 #endif
00068 //struct that holds views of the contents of a CrsMatrix. These
00069 //contents may be a mixture of local and remote rows of the
00070 //actual matrix.
00071 template <class Scalar, 
00072   class LocalOrdinal=int, 
00073   class GlobalOrdinal=LocalOrdinal, 
00074   class Node=KokkosClassic::DefaultNode::DefaultNodeType, 
00075   class SpMatOps= typename KokkosClassic::DefaultKernels<Scalar, LocalOrdinal, Node>::SparseOps >
00076 class CrsMatrixStruct {
00077 public:
00078   CrsMatrixStruct();
00079 
00080   virtual ~CrsMatrixStruct();
00081 
00082   void deleteContents();
00083 
00085   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > origRowMap;
00087   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > rowMap;
00089   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > colMap;
00091   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > domainMap;
00093   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > importColMap;
00095   Teuchos::RCP<CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps> >  importMatrix;  
00097   Teuchos::RCP<const CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps> >  origMatrix;
00098   
00099 };
00100 
00101 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node, class SpMatOps>
00102 int dumpCrsMatrixStruct(const CrsMatrixStruct<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps >& M);
00103 
00104 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
00105 class CrsWrapper {
00106  public:
00107   virtual ~CrsWrapper(){}
00108 
00109   virtual Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const = 0;
00110 
00111   virtual bool isFillComplete() = 0;
00112 
00113   virtual void insertGlobalValues(GlobalOrdinal globalRow, const Teuchos::ArrayView<const GlobalOrdinal> &indices, const Teuchos::ArrayView<const Scalar> &values) = 0;
00114 
00115   virtual void sumIntoGlobalValues(GlobalOrdinal globalRow, const Teuchos::ArrayView<const GlobalOrdinal> &indices, const Teuchos::ArrayView<const Scalar> &values) = 0;
00116 };
00117 
00118 template <class Scalar, 
00119   class LocalOrdinal=int, 
00120   class GlobalOrdinal=LocalOrdinal, 
00121   class Node=KokkosClassic::DefaultNode::DefaultNodeType, 
00122   class SpMatOps= typename KokkosClassic::DefaultKernels<Scalar, LocalOrdinal, Node>::SparseOps >
00123 class CrsWrapper_CrsMatrix : public CrsWrapper<Scalar, LocalOrdinal, GlobalOrdinal, Node>{
00124  public:
00125   CrsWrapper_CrsMatrix(CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps >& crsmatrix);
00126   virtual ~CrsWrapper_CrsMatrix();
00127 
00128   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const;
00129 
00130   bool isFillComplete();
00131 
00132   void insertGlobalValues(GlobalOrdinal globalRow, const Teuchos::ArrayView<const GlobalOrdinal> &indices, const Teuchos::ArrayView<const Scalar> &values);
00133   void sumIntoGlobalValues(GlobalOrdinal globalRow, const Teuchos::ArrayView<const GlobalOrdinal> &indices, const Teuchos::ArrayView<const Scalar> &values);
00134 
00135  private:
00136   CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& crsmat_;
00137 };
00138 
00139 template<class Scalar,
00140   class LocalOrdinal=int,
00141   class GlobalOrdinal=LocalOrdinal,
00142   class Node=KokkosClassic::DefaultNode::DefaultNodeType>
00143 class CrsWrapper_GraphBuilder : public CrsWrapper<Scalar, LocalOrdinal, GlobalOrdinal, Node>{
00144  public:
00145   CrsWrapper_GraphBuilder(const Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& map);
00146   virtual ~CrsWrapper_GraphBuilder();
00147 
00148   Teuchos::RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> > getRowMap() const {return rowmap_; }
00149 
00150   bool isFillComplete();
00151 
00152   void insertGlobalValues(GlobalOrdinal globalRow, const Teuchos::ArrayView<const GlobalOrdinal> &indices, const Teuchos::ArrayView<const Scalar> &values);
00153   void sumIntoGlobalValues(GlobalOrdinal globalRow, const Teuchos::ArrayView<const GlobalOrdinal> &indices, const Teuchos::ArrayView<const Scalar> &values);
00154 
00155   std::map<GlobalOrdinal,std::set<GlobalOrdinal>*>& get_graph();
00156 
00157   size_t get_max_row_length() { return max_row_length_; }
00158 
00159  private:
00160   std::map<GlobalOrdinal,std::set<GlobalOrdinal>*> graph_;
00161   const RCP<const Map<LocalOrdinal, GlobalOrdinal, Node> >& rowmap_;
00162   global_size_t max_row_length_;
00163 };
00164 
00165 template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node, class SpMatOps>
00166 void insert_matrix_locations(CrsWrapper_GraphBuilder<Scalar, LocalOrdinal, GlobalOrdinal, Node>& graphbuilder,
00167                               CrsMatrix<Scalar, LocalOrdinal, GlobalOrdinal, Node, SpMatOps>& C);
00168 
00169 
00170 
00171 }
00172 #endif // TPETRA_MMHELPERS_DECL_HPP
00173 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines