Ifpack2 Templated Preconditioning Package Version 1.0
Loading...
Searching...
No Matches
Ifpack2_Factory_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_FACTORY_DECL_HPP
44#define IFPACK2_FACTORY_DECL_HPP
45
46#include "Ifpack2_ConfigDefs.hpp"
48#include "Ifpack2_Details_Factory.hpp"
49
50#include "Ifpack2_Chebyshev.hpp"
51#include "Ifpack2_RILUK.hpp"
52#include "Ifpack2_Experimental_RBILUK.hpp"
53
54#include <type_traits>
55
56namespace Ifpack2 {
57
59bool supportsUnsymmetric (const std::string& prec_type);
60
114class Factory {
115public:
126 template<class MatrixType>
127 static
128 Teuchos::RCP<Preconditioner<typename MatrixType::scalar_type,
129 typename MatrixType::local_ordinal_type,
130 typename MatrixType::global_ordinal_type,
131 typename MatrixType::node_type> >
132 create (const std::string& precType,
133 const Teuchos::RCP<const MatrixType>& matrix)
134 {
135 using Teuchos::RCP;
136 using Teuchos::rcp_implicit_cast;
137 typedef typename MatrixType::scalar_type SC;
138 typedef typename MatrixType::local_ordinal_type LO;
139 typedef typename MatrixType::global_ordinal_type GO;
140 typedef typename MatrixType::node_type NT;
141 typedef Tpetra::RowMatrix<SC, LO, GO, NT> row_matrix_type;
142
143 RCP<const row_matrix_type> A;
144 if (! matrix.is_null ()) {
145 A = rcp_implicit_cast<const row_matrix_type> (matrix);
146 }
147 Ifpack2::Details::Factory<SC, LO, GO, NT> factory;
148 return factory.create (precType, A);
149 }
150
166 template<class MatrixType>
167 static
168 Teuchos::RCP<Preconditioner<typename MatrixType::scalar_type,
169 typename MatrixType::local_ordinal_type,
170 typename MatrixType::global_ordinal_type,
171 typename MatrixType::node_type> >
172 create (const std::string& precType,
173 const Teuchos::RCP<const MatrixType>& matrix,
174 const int overlap)
175 {
176 using Teuchos::RCP;
177 using Teuchos::rcp_implicit_cast;
178 typedef typename MatrixType::scalar_type SC;
179 typedef typename MatrixType::local_ordinal_type LO;
180 typedef typename MatrixType::global_ordinal_type GO;
181 typedef typename MatrixType::node_type NT;
182 typedef Tpetra::RowMatrix<SC, LO, GO, NT> row_matrix_type;
183
184 RCP<const row_matrix_type> A;
185 if (! matrix.is_null ()) {
186 A = rcp_implicit_cast<const row_matrix_type> (matrix);
187 }
188 Ifpack2::Details::Factory<SC, LO, GO, NT> factory;
189 return factory.create (precType, A, overlap);
190 }
191
192 template<class MatrixType>
193 static
194 bool
195 isSupported (const std::string& precType)
196 {
197 typedef typename MatrixType::scalar_type SC;
198 typedef typename MatrixType::local_ordinal_type LO;
199 typedef typename MatrixType::global_ordinal_type GO;
200 typedef typename MatrixType::node_type NT;
201
202 Ifpack2::Details::Factory<SC, LO, GO, NT> factory;
203 return factory.isSupported (precType);
204 }
205
206};
207
208} // namespace Ifpack2
209
210#endif // IFPACK2_FACTORY_DECL_HPP
"Factory" for creating Ifpack2 preconditioners.
Definition: Ifpack2_Factory_decl.hpp:114
static Teuchos::RCP< Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > create(const std::string &precType, const Teuchos::RCP< const MatrixType > &matrix)
Create an instance of Ifpack2_Preconditioner given the string name of the preconditioner type.
Definition: Ifpack2_Factory_decl.hpp:132
static Teuchos::RCP< Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > create(const std::string &precType, const Teuchos::RCP< const MatrixType > &matrix, const int overlap)
Create an instance of Ifpack2_Preconditioner given the string name of the preconditioner type.
Definition: Ifpack2_Factory_decl.hpp:172
Interface for all Ifpack2 preconditioners.
Definition: Ifpack2_Preconditioner.hpp:108
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:74
bool supportsUnsymmetric(const std::string &prec_type)
\C true if the specified preconditioner type supports nonsymmetric matrices, else false.
Definition: Ifpack2_Factory.cpp:56