Tpetra Matrix/Vector Services Version of the Day
Tpetra_BlockCrsGraph_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_BLOCKCRSGRAPH_DECL_HPP
00043 #define TPETRA_BLOCKCRSGRAPH_DECL_HPP
00044 
00045 #include "Tpetra_CrsGraph.hpp"
00046 #include "Tpetra_BlockMap.hpp"
00047 
00052 namespace Tpetra {
00053 
00064 template <class LocalOrdinal, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
00065 class BlockCrsGraph : public Teuchos::Describable {
00066  public:
00067   typedef LocalOrdinal  local_ordinal_type;
00068   typedef GlobalOrdinal global_ordinal_type;
00069   typedef Node          node_type;
00070 
00072 
00073 
00076   BlockCrsGraph(const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> >& blkRowMap, size_t maxNumEntriesPerRow, ProfileType pftype = DynamicProfile);
00077 
00079   ~BlockCrsGraph(){}
00080 
00082 
00084 
00085 
00087   void insertGlobalIndices(GlobalOrdinal row, const Teuchos::ArrayView<const GlobalOrdinal> &indices);
00088 
00090 
00092   Teuchos::ArrayRCP<const size_t> getNodeRowOffsets() const;
00093 
00095 
00097   Teuchos::ArrayRCP<const LocalOrdinal> getNodePackedIndices() const;
00099 
00101 
00102 
00104   void globalAssemble();
00105 
00110   void fillComplete(const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > &blkDomainMap, const Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > &blkRangeMap, OptimizeOption os = DoOptimizeStorage);
00111 
00117   void fillComplete(OptimizeOption os = DoOptimizeStorage);
00118 
00120   void optimizeStorage();
00121 
00123 
00125 
00126 
00128   bool isFillComplete() const;
00129 
00131   bool isLocallyIndexed() const;
00132 
00134   bool isUpperTriangular() const;
00135 
00137   bool isLowerTriangular() const;
00138 
00140   size_t getNodeNumBlockRows() const;
00141 
00143   size_t getGlobalNumBlockRows() const;
00144 
00146   size_t getNodeNumBlockDiags() const;
00147 
00149   size_t getNodeNumBlockEntries() const;
00150 
00152   size_t getGlobalBlockRowLength(GlobalOrdinal row) const;
00153 
00155   void getGlobalBlockRowView(GlobalOrdinal row,
00156                              Teuchos::ArrayView<const GlobalOrdinal>& blockCols) const;
00157 
00159   void getLocalBlockRowView(LocalOrdinal row,
00160                              Teuchos::ArrayView<const LocalOrdinal>& blockCols) const;
00161 
00163   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > getBlockRowMap() const;
00164 
00166   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > getBlockColMap() const;
00167 
00169   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > getBlockDomainMap() const;
00170 
00172   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > getBlockRangeMap() const;
00173 
00175 
00176  private:
00177   Teuchos::RCP<CrsGraph<LocalOrdinal,GlobalOrdinal,Node> > ptGraph_;
00178 
00179   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > blkRowMap_;
00180   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > blkColMap_;
00181   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > blkDomainMap_;
00182   Teuchos::RCP<const BlockMap<LocalOrdinal,GlobalOrdinal,Node> > blkRangeMap_;
00183 };//class BlockCrsGraph
00184 }//namespace Tpetra
00185 
00186 #endif
00187 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines