Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_Details_RowGraph.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
5 // Copyright (2009) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 */
42 
43 #ifndef IFPACK2_DETAILS_ROWGRAPH_HPP
44 #define IFPACK2_DETAILS_ROWGRAPH_HPP
45 
46 #include "Ifpack2_ConfigDefs.hpp"
47 #include "Tpetra_RowGraph.hpp"
48 #include "Ifpack2_Details_throwBecauseDeprecated.hpp"
49 
50 namespace Ifpack2 {
51 namespace Details {
52 
63 template<class GraphType>
64 class RowGraph :
65  virtual public Tpetra::RowGraph<typename GraphType::local_ordinal_type,
66  typename GraphType::global_ordinal_type,
67  typename GraphType::node_type> {
68 public:
70 
71  typedef typename GraphType::local_ordinal_type local_ordinal_type;
72  typedef typename GraphType::global_ordinal_type global_ordinal_type;
73  typedef typename GraphType::node_type node_type;
74 
76 
78 
80  virtual ~RowGraph () {}
81 
83 
85 
89  Tpetra::global_size_t IFPACK2_DEPRECATED
90  getGlobalNumDiags () const final
91  {
92  throwBecauseDeprecated ("getGlobalNumDiags");
93  return Tpetra::global_size_t (0);
94  }
95 
99  std::size_t IFPACK2_DEPRECATED
100  getNodeNumDiags () const final
101  {
102  throwBecauseDeprecated ("getNodeNumDiags");
103  return std::size_t (0);
104  }
105 
109  bool IFPACK2_DEPRECATED
110  isLowerTriangular () const final
111  {
112  throwBecauseDeprecated ("isLowerTriangular");
113  return false;
114  }
115 
119  bool IFPACK2_DEPRECATED isUpperTriangular() const final
120  {
121  throwBecauseDeprecated ("isUpperTriangular");
122  return false;
123  }
124 };
125 
126 } // namespace Details
127 } // namespace Ifpack2
128 
129 #endif // IFPACK2_DETAILS_ROWGRAPH_HPP
bool IFPACK2_DEPRECATED isLowerTriangular() const final
Whether this graph is locally lower triangular.
Definition: Ifpack2_Details_RowGraph.hpp:110
bool IFPACK2_DEPRECATED isUpperTriangular() const final
Whether this graph is locally upper triangular.
Definition: Ifpack2_Details_RowGraph.hpp:119
Tpetra::global_size_t IFPACK2_DEPRECATED getGlobalNumDiags() const final
The global number of diagonal entries.
Definition: Ifpack2_Details_RowGraph.hpp:90
Ifpack2 implementation details.
virtual ~RowGraph()
Destructor (virtual for memory safety of derived classes)
Definition: Ifpack2_Details_RowGraph.hpp:80
std::size_t IFPACK2_DEPRECATED getNodeNumDiags() const final
The local number of diagonal entries.
Definition: Ifpack2_Details_RowGraph.hpp:100
All Ifpack2 implementations of Tpetra::RowGraph must inherit from this class.
Definition: Ifpack2_Details_RowGraph.hpp:64
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72