Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_Details_OneLevelFactory_decl.hpp
1// @HEADER
2// *****************************************************************************
3// Ifpack2: Templated Object-Oriented Algebraic Preconditioner Package
4//
5// Copyright 2009 NTESS and the Ifpack2 contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP
11#define IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP
12
13#include "Ifpack2_ConfigDefs.hpp"
15#include "Tpetra_RowMatrix.hpp"
16#include <type_traits> // std::is_same
17
18namespace Ifpack2 {
19namespace Details {
20
91template<class MatrixType>
93public:
94 typedef typename MatrixType::scalar_type scalar_type;
95 typedef typename MatrixType::local_ordinal_type local_ordinal_type;
96 typedef typename MatrixType::global_ordinal_type global_ordinal_type;
97 typedef typename MatrixType::node_type node_type;
98 typedef ::Ifpack2::Preconditioner<scalar_type,
99 local_ordinal_type,
100 global_ordinal_type,
101 node_type> prec_type;
102 typedef ::Tpetra::RowMatrix<scalar_type,
103 local_ordinal_type,
104 global_ordinal_type,
105 node_type> row_matrix_type;
106
107 static_assert (std::is_same<MatrixType, row_matrix_type>::value,
108 "Ifpack2::Details::OneLevelFactory: MatrixType must be a "
109 "Tpetra::RowMatrix specialization.");
110
121 Teuchos::RCP<prec_type>
122 create (const std::string& precType,
123 const Teuchos::RCP<const row_matrix_type>& matrix) const;
124
125 bool
126 isSupported (const std::string& precType) const;
127};
128
129} // namespace Details
130} // namespace Ifpack2
131
132#endif // IFPACK2_DETAILS_ONELEVELFACTORY_DECL_HPP
"Factory" for creating single-level preconditioners.
Definition Ifpack2_Details_OneLevelFactory_decl.hpp:92
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:53
Interface for all Ifpack2 preconditioners.
Definition Ifpack2_Preconditioner.hpp:75
Preconditioners and smoothers for Tpetra sparse matrices.
Definition Ifpack2_AdditiveSchwarz_decl.hpp:41