Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_Details_OneLevelFactory_decl.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_ONELEVELFACTORY_DECL_HPP
44 #define IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP
45 
46 #include "Ifpack2_ConfigDefs.hpp"
48 #include "Tpetra_RowMatrix.hpp"
49 #include <type_traits> // std::is_same
50 
51 namespace Ifpack2 {
52 namespace Details {
53 
123 template<class MatrixType>
125 public:
126  typedef typename MatrixType::scalar_type scalar_type;
127  typedef typename MatrixType::local_ordinal_type local_ordinal_type;
128  typedef typename MatrixType::global_ordinal_type global_ordinal_type;
129  typedef typename MatrixType::node_type node_type;
130  typedef ::Ifpack2::Preconditioner<scalar_type,
131  local_ordinal_type,
132  global_ordinal_type,
133  node_type> prec_type;
134  typedef ::Tpetra::RowMatrix<scalar_type,
135  local_ordinal_type,
136  global_ordinal_type,
137  node_type> row_matrix_type;
138 
139  static_assert (std::is_same<MatrixType, row_matrix_type>::value,
140  "Ifpack2::Details::OneLevelFactory: MatrixType must be a "
141  "Tpetra::RowMatrix specialization.");
142 
153  Teuchos::RCP<prec_type>
154  create (const std::string& precType,
155  const Teuchos::RCP<const row_matrix_type>& matrix) const;
156 
157  bool
158  isSupported (const std::string& precType) const;
159 };
160 
161 } // namespace Details
162 } // namespace Ifpack2
163 
164 #endif // IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP
Ifpack2 implementation details.
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:107
"Factory" for creating single-level preconditioners.
Definition: Ifpack2_Details_OneLevelFactory_decl.hpp:124
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:73
Teuchos::RCP< prec_type > create(const std::string &precType, const Teuchos::RCP< const row_matrix_type > &matrix) const
Create an instance of Preconditioner given the string name of the preconditioner type.
Definition: Ifpack2_Details_OneLevelFactory_def.hpp:84