Stratimikos Version of the Day
Loading...
Searching...
No Matches
Thyra_BelosTpetraPreconditionerFactory_decl.hpp
1/*@HEADER
2// ***********************************************************************
3//
4// Stratimikos: Thyra-based strategies for linear solvers
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 Jennifer A. Loe (jloe@sandia.gov)
38//
39// ***********************************************************************
40//@HEADER
41*/
42#ifndef THYRA_BELOS_TPETRA_PRECONDITIONERFACTORY_DECL_HPP
43#define THYRA_BELOS_TPETRA_PRECONDITIONERFACTORY_DECL_HPP
44
45#include "Thyra_PreconditionerFactoryBase.hpp"
46
47namespace Thyra {
48
52template <typename MatrixType>
54 public PreconditionerFactoryBase<typename MatrixType::scalar_type> {
55public:
57 typedef typename MatrixType::scalar_type scalar_type;
58
61
65
68
70 bool isCompatible(const LinearOpSourceBase<scalar_type> &fwdOp) const;
71
73 Teuchos::RCP<PreconditionerBase<scalar_type> > createPrec() const;
74
76 void initializePrec(
77 const Teuchos::RCP<const LinearOpSourceBase<scalar_type> > &fwdOp,
78 PreconditionerBase<scalar_type> *prec,
79 const ESupportSolveUse supportSolveUse
80 ) const;
81
84 PreconditionerBase<scalar_type> *prec,
85 Teuchos::RCP<const LinearOpSourceBase<scalar_type> > *fwdOp,
86 ESupportSolveUse *supportSolveUse
87 ) const;
88
90
93
95 void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> &paramList);
97 Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
99 Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
101 Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
103 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
105
108
110 std::string description() const;
111
113
114private:
115
116 Teuchos::RCP<Teuchos::ParameterList> paramList_;
117
118};
119
120} // namespace Thyra
121
122#endif // THYRA_BELOS_TPETRA_PRECONDITIONERFACTORY_DECL_HPP
Concrete preconditioner factory subclass based on Belos. (Yes, Belos solvers can also be used as prec...
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > &paramList)
Teuchos::RCP< const Teuchos::ParameterList > getParameterList() const
bool isCompatible(const LinearOpSourceBase< scalar_type > &fwdOp) const
void uninitializePrec(PreconditionerBase< scalar_type > *prec, Teuchos::RCP< const LinearOpSourceBase< scalar_type > > *fwdOp, ESupportSolveUse *supportSolveUse) const
void initializePrec(const Teuchos::RCP< const LinearOpSourceBase< scalar_type > > &fwdOp, PreconditionerBase< scalar_type > *prec, const ESupportSolveUse supportSolveUse) const
Teuchos::RCP< PreconditionerBase< scalar_type > > createPrec() const

Generated for Stratimikos by doxygen 1.10.0