Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_Details_RowMatrix.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_ROWMATRIX_HPP
44 #define IFPACK2_DETAILS_ROWMATRIX_HPP
45 
46 #include "Ifpack2_ConfigDefs.hpp"
47 #include "Tpetra_RowMatrix.hpp"
48 #include "Ifpack2_Details_throwBecauseDeprecated.hpp"
49 
50 namespace Ifpack2 {
51 namespace Details {
52 
63 template<class MatrixType>
64 class RowMatrix :
65  public Tpetra::RowMatrix<typename MatrixType::scalar_type,
66  typename MatrixType::local_ordinal_type,
67  typename MatrixType::global_ordinal_type,
68  typename MatrixType::node_type> {
69 public:
71 
72  typedef typename MatrixType::scalar_type scalar_type;
73  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
74  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
75  typedef typename MatrixType::node_type node_type;
76 
78 
80 
82  virtual ~RowMatrix () {}
83 
85 
87 
91  Tpetra::global_size_t IFPACK2_DEPRECATED
92  getGlobalNumDiags () const final
93  {
94  throwBecauseDeprecated ("getGlobalNumDiags");
95  return Tpetra::global_size_t (0);
96  }
97 
101  std::size_t IFPACK2_DEPRECATED
102  getNodeNumDiags () const final
103  {
104  throwBecauseDeprecated ("getNodeNumDiags");
105  return std::size_t (0);
106  }
107 
111  bool IFPACK2_DEPRECATED
112  isLowerTriangular () const final
113  {
114  throwBecauseDeprecated ("isLowerTriangular");
115  return false;
116  }
117 
121  bool IFPACK2_DEPRECATED isUpperTriangular() const final
122  {
123  throwBecauseDeprecated ("isUpperTriangular");
124  return false;
125  }
126 };
127 
128 } // namespace Details
129 } // namespace Ifpack2
130 
131 #endif /* IFPACK2_DETAILS_ROWMATRIX_HPP */
bool IFPACK2_DEPRECATED isLowerTriangular() const final
Whether this graph is locally lower triangular.
Definition: Ifpack2_Details_RowMatrix.hpp:112
All Ifpack2 implementations of Tpetra::RowMatrix must inherit from this class.
Definition: Ifpack2_Details_RowMatrix.hpp:64
Ifpack2 implementation details.
bool IFPACK2_DEPRECATED isUpperTriangular() const final
Whether this graph is locally upper triangular.
Definition: Ifpack2_Details_RowMatrix.hpp:121
Tpetra::global_size_t IFPACK2_DEPRECATED getGlobalNumDiags() const final
The global number of diagonal entries.
Definition: Ifpack2_Details_RowMatrix.hpp:92
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
virtual ~RowMatrix()
Destructor (virtual for memory safety of derived classes)
Definition: Ifpack2_Details_RowMatrix.hpp:82
std::size_t IFPACK2_DEPRECATED getNodeNumDiags() const final
The local number of diagonal entries.
Definition: Ifpack2_Details_RowMatrix.hpp:102