Stratimikos Version of the Day
Loading...
Searching...
No Matches
Stratimikos_BelosTpetraPrecHelpers.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Stratimikos: Thyra-based strategies for linear solvers
5// Copyright 2012 Sandia Corporation
6//
7// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8// the U.S. Government retains certain rights in this software.
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 Jennifer A. Loe (jloe@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41#ifndef STRATIMIKOS_BELOS_PREC_TPETRA_HELPERS_HPP
42#define STRATIMIKOS_BELOS_PREC_TPETRA_HELPERS_HPP
43
44#include "Stratimikos_LinearSolverBuilder.hpp"
45#include "Thyra_BelosTpetraPreconditionerFactory_decl.hpp"
46#include "Thyra_BelosTpetraPreconditionerFactory_def.hpp"
47
48#include "Teuchos_RCP.hpp"
49#include "Teuchos_ParameterList.hpp"
50#include "Teuchos_TestForException.hpp"
51#include "Teuchos_AbstractFactoryStd.hpp"
52
53#include <string>
54
55namespace Stratimikos {
56
57 template <typename MatrixType>
58 void enableBelosPrecTpetra(LinearSolverBuilder<typename MatrixType::scalar_type>& builder, const std::string& stratName = "BelosPrecTpetra")
59 {
60 const Teuchos::RCP<const Teuchos::ParameterList> precValidParams = Teuchos::sublist(builder.getValidParameters(), "Preconditioner Types");
61
62 TEUCHOS_TEST_FOR_EXCEPTION(precValidParams->isParameter(stratName), std::logic_error,
63 "Stratimikos::enableBelosPrecTpetra cannot add \"" + stratName +"\" because it is already included in builder!");
64
65 typedef typename MatrixType::scalar_type scalar_type;
66 typedef Thyra::PreconditionerFactoryBase<scalar_type> Base;
68
69 builder.setPreconditioningStrategyFactory(Teuchos::abstractFactoryStd<Base, Impl>(), stratName);
70 }
71
72} // namespace Stratimikos
73
74#endif
Concrete preconditioner factory subclass based on Belos. (Yes, Belos solvers can also be used as prec...

Generated for Stratimikos by doxygen 1.9.6