Tpetra Matrix/Vector Services Version of the Day
Tpetra_RowGraph.hpp
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_ROWGRAPH_HPP
00043 #define TPETRA_ROWGRAPH_HPP
00044 
00045 #include <Teuchos_Describable.hpp>
00046 #include <Kokkos_DefaultNode.hpp>
00047 
00048 #include "Tpetra_ConfigDefs.hpp"
00049 #include "Tpetra_Map.hpp"
00050 #include "Tpetra_Import.hpp"
00051 #include "Tpetra_Export.hpp"
00052 
00053 namespace Tpetra 
00054 {
00055   
00057 
00063   template <class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = Kokkos::DefaultNode::DefaultNodeType>
00064   class RowGraph : virtual public Teuchos::Describable {
00065     public: 
00066       typedef LocalOrdinal  local_ordinal_type;
00067       typedef GlobalOrdinal global_ordinal_type;
00068       typedef Node          node_type;
00069 
00071 
00072 
00074       virtual ~RowGraph();
00075 
00077 
00079 
00080 
00082       virtual const Teuchos::RCP<const Teuchos::Comm<int> > & getComm() const = 0;
00083 
00085       virtual Teuchos::RCP<Node> getNode() const = 0;
00086 
00088       virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getRowMap() const = 0;
00089 
00091       virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getColMap() const = 0;
00092 
00094       virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getDomainMap() const = 0;
00095 
00097       virtual const Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal,Node> > & getRangeMap() const = 0;
00098 
00100       virtual Teuchos::RCP<const Import<LocalOrdinal,GlobalOrdinal,Node> > getImporter() const = 0;
00101 
00103       virtual Teuchos::RCP<const Export<LocalOrdinal,GlobalOrdinal,Node> > getExporter() const = 0;
00104 
00106       virtual global_size_t getGlobalNumRows() const = 0;
00107 
00109       virtual global_size_t getGlobalNumCols() const = 0;
00110 
00112       virtual size_t getNodeNumRows() const = 0;
00113 
00115       virtual size_t getNodeNumCols() const = 0;
00116 
00118       virtual GlobalOrdinal getIndexBase() const = 0;
00119 
00121       virtual global_size_t getGlobalNumEntries() const = 0;
00122 
00124       virtual size_t getNodeNumEntries() const = 0;
00125 
00127 
00128       virtual size_t getNumEntriesInGlobalRow(GlobalOrdinal globalRow) const = 0;
00129 
00131 
00132       virtual size_t getNumEntriesInLocalRow(LocalOrdinal localRow) const = 0;
00133 
00135       virtual global_size_t getGlobalNumDiags() const = 0;
00136 
00138       virtual size_t getNodeNumDiags() const = 0;
00139 
00141       virtual size_t getGlobalMaxNumRowEntries() const = 0;
00142 
00144       virtual size_t getNodeMaxNumRowEntries() const = 0;
00145 
00147       virtual bool hasColMap() const = 0;
00148 
00150       virtual bool isLowerTriangular() const = 0;
00151 
00153       virtual bool isUpperTriangular() const = 0;
00154 
00156       virtual bool isLocallyIndexed() const = 0;
00157 
00159       virtual bool isGloballyIndexed() const = 0;
00160 
00162       virtual bool isFillComplete() const = 0;
00163 
00165 
00167 
00168           
00170 
00179       virtual void getGlobalRowCopy(GlobalOrdinal GlobalRow,
00180                                     const Teuchos::ArrayView<GlobalOrdinal> &Indices,
00181                                     size_t &NumIndices) const = 0;
00182 
00184 
00193       virtual void getLocalRowCopy(LocalOrdinal LocalRow, 
00194                                    const Teuchos::ArrayView<LocalOrdinal> &Indices,
00195                                    size_t &NumIndices) const = 0;
00196 
00198 
00199   }; // class RowGraph
00200 
00201   template <class LocalOrdinal, class GlobalOrdinal, class Node>
00202   RowGraph<LocalOrdinal,GlobalOrdinal,Node>::~RowGraph() {
00203   }
00204 
00205 
00206 } // namespace Tpetra
00207 
00208 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines