Ifpack2 Templated Preconditioning Package  Version 1.0
Ifpack2_Details_OneLevelFactory_def.hpp
1 /*@HEADER
2 // ***********************************************************************
3 //
4 // Ifpack2: Tempated 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_DEF_HPP
44 #define IFPACK2_DETAILS_ONELEVELFACTORY_DEF_HPP
45 
46 #include "Ifpack2_Chebyshev.hpp"
47 #include "Ifpack2_Details_DenseSolver.hpp"
48 #include "Ifpack2_Diagonal.hpp"
49 #include "Ifpack2_IdentitySolver.hpp"
50 #include "Ifpack2_ILUT.hpp"
51 #include "Ifpack2_Relaxation.hpp"
52 #include "Ifpack2_RILUK.hpp"
53 #include "Ifpack2_Experimental_RBILUK.hpp"
54 #include "Ifpack2_BlockRelaxation.hpp"
55 #include "Ifpack2_BandedContainer.hpp"
56 #include "Ifpack2_DenseContainer.hpp"
57 #include "Ifpack2_TriDiContainer.hpp"
58 
59 #ifdef HAVE_IFPACK2_AMESOS2
60 # include "Ifpack2_Details_Amesos2Wrapper.hpp"
61 #endif // HAVE_IFPACK2_AMESOS2
62 
63 namespace Ifpack2 {
64 namespace Details {
65 
66 template<class MatrixType>
67 Teuchos::RCP<typename OneLevelFactory<MatrixType>::prec_type>
68 OneLevelFactory<MatrixType>::create (const std::string& precType,
69  const Teuchos::RCP<const row_matrix_type>& matrix) const
70 {
71  using Teuchos::RCP;
72  using Teuchos::rcp;
73 
74  RCP<prec_type> prec;
75 
76  // precTypeUpper is the upper-case version of precType.
77  std::string precTypeUpper (precType);
78  if (precTypeUpper.size () > 0) {
79  std::locale locale;
80  for (size_t k = 0; k < precTypeUpper.size (); ++k) {
81  precTypeUpper[k] = std::toupper<char> (precTypeUpper[k], locale);
82  }
83  }
84 
85  if (precTypeUpper == "CHEBYSHEV") {
86  // We have to distinguish Ifpack2::Chebyshev from its
87  // implementation class Ifpack2::Details::Chebyshev.
88  prec = rcp (new ::Ifpack2::Chebyshev<row_matrix_type> (matrix));
89  }
90  else if (precTypeUpper == "DENSE" || precTypeUpper == "LAPACK") {
91  prec = rcp (new Details::DenseSolver<row_matrix_type> (matrix));
92  }
93  else if (precTypeUpper == "AMESOS2") {
94 #ifdef HAVE_IFPACK2_AMESOS2
95  prec = rcp (new Details::Amesos2Wrapper<row_matrix_type> (matrix));
96 #else
97  TEUCHOS_TEST_FOR_EXCEPTION(
98  true, std::invalid_argument, "Ifpack2::Details::OneLevelFactory: "
99  "You may not ask for the preconditioner \"AMESOS2\" unless "
100  "you have built Trilinos with the Amesos2 package enabled.");
101 #endif // HAVE_IFPACK2_AMESOS2
102  }
103  else if (precTypeUpper == "DIAGONAL") {
104  prec = rcp (new Diagonal<row_matrix_type> (matrix));
105  }
106  else if (precTypeUpper == "ILUT") {
107  prec = rcp (new ILUT<row_matrix_type> (matrix));
108  }
109  else if (precTypeUpper == "RELAXATION") {
110  prec = rcp (new Relaxation<row_matrix_type> (matrix));
111  }
112  else if (precTypeUpper == "RILUK") {
113  prec = rcp (new RILUK<row_matrix_type> (matrix));
114  }
115  else if (precTypeUpper == "RBILUK") {
116  prec = rcp (new Experimental::RBILUK<row_matrix_type>(matrix));
117  }
118  else if (precTypeUpper == "KRYLOV") {
119  TEUCHOS_TEST_FOR_EXCEPTION
120  (true, std::invalid_argument, "The \"KRYLOV\" preconditioner option has "
121  "been deprecated and removed. If you want a Krylov solver, use the "
122  "Belos package.");
123  }
124  else if (precTypeUpper == "BLOCK_RELAXATION" ||
125  precTypeUpper == "BLOCK RELAXATION" ||
126  precTypeUpper == "BLOCKRELAXATION" ) {
127  // FIXME (mfh 22 May 2014) We would prefer to have the choice of
128  // dense or sparse blocks (the "container type") be a run-time
129  // decision. This will require refactoring BlockRelaxation so
130  // that the "container type" is not a template parameter. For
131  // now, we default to use dense blocks.
132  typedef DenseContainer<row_matrix_type, scalar_type> container_type;
133  prec = rcp (new BlockRelaxation<row_matrix_type, container_type> (matrix));
134  }
135  else if (precTypeUpper == "TRIDI_RELAXATION" ||
136  precTypeUpper == "TRIDI RELAXATION" ||
137  precTypeUpper == "TRIDIRELAXATION" ||
138  precTypeUpper == "TRIDIAGONAL_RELAXATION" ||
139  precTypeUpper == "TRIDIAGONAL RELAXATION" ||
140  precTypeUpper == "TRIDIAGONALRELAXATION") {
141  typedef TriDiContainer<row_matrix_type, scalar_type> container_type;
142  prec = rcp (new BlockRelaxation<row_matrix_type, container_type> (matrix));
143 
144  }
145  else if (precTypeUpper == "BANDED_RELAXATION" ||
146  precTypeUpper == "BANDED RELAXATION" ||
147  precTypeUpper == "BANDEDRELAXATION") {
148  typedef BandedContainer<row_matrix_type, scalar_type> container_type;
149  prec = rcp (new BlockRelaxation<row_matrix_type, container_type> (matrix));
150  }
151  else if (precTypeUpper == "IDENTITY" || precTypeUpper == "IDENTITY_SOLVER") {
152  prec = rcp (new IdentitySolver<row_matrix_type> (matrix));
153  }
154  else {
155  TEUCHOS_TEST_FOR_EXCEPTION(
156  true, std::invalid_argument, "Ifpack2::Details::OneLevelFactory::create: "
157  "Invalid preconditioner type \"" << precType << "\".");
158  }
159 
160  TEUCHOS_TEST_FOR_EXCEPTION(
161  prec.is_null (), std::logic_error, "Ifpack2::Details::OneLevelFactory::"
162  "create: Return value is null right before return. This should never "
163  "happen. Please report this bug to the Ifpack2 developers.");
164  return prec;
165 }
166 
167 } // namespace Details
168 } // namespace Ifpack2
169 
170 #define IFPACK2_DETAILS_ONELEVELFACTORY_INSTANT(S,LO,GO,N) \
171  template class Ifpack2::Details::OneLevelFactory< Tpetra::RowMatrix<S, LO, GO, N> >;
172 
173 #endif // IFPACK2_DETAILS_ONELEVELFACTORY_DEF_HPP
Store and solve a local TriDi linear problem.
Definition: Ifpack2_TriDiContainer_decl.hpp:109
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:68
ILU(k) factorization of a given Tpetra::RowMatrix.
Definition: Ifpack2_RILUK_decl.hpp:243
"Preconditioner" that uses LAPACK&#39;s dense LU.
Definition: Ifpack2_Details_DenseSolver_decl.hpp:73
ILUT (incomplete LU factorization with threshold) of a Tpetra sparse matrix.
Definition: Ifpack2_ILUT_decl.hpp:91
Block relaxation preconditioners (or smoothers) for Tpetra::RowMatrix and Tpetra::CrsMatrix sparse ma...
Definition: Ifpack2_BlockRelaxation_decl.hpp:81
Ifpack2 implementation details.
"Identity" preconditioner.
Definition: Ifpack2_IdentitySolver_decl.hpp:59
Store and solve a local dense linear problem.
Definition: Ifpack2_DenseContainer_decl.hpp:109
Wrapper class for direct solvers in Amesos2.
Definition: Ifpack2_Details_Amesos2Wrapper_decl.hpp:102
Relaxation preconditioners for Tpetra::RowMatrix and Tpetra::CrsMatrix sparse matrices.
Definition: Ifpack2_Relaxation_decl.hpp:222
Preconditioners and smoothers for Tpetra sparse matrices.
Definition: Ifpack2_AdditiveSchwarz_decl.hpp:72
ILU(k) factorization of a given Tpetra::Experimental::BlockCrsMatrix.
Definition: Ifpack2_Experimental_RBILUK_decl.hpp:128
Store and solve a local Banded linear problem.
Definition: Ifpack2_BandedContainer_decl.hpp:108