Stratimikos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Thyra_MLPreconditionerFactory.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stratimikos: Thyra-based strategies for linear solvers
5// Copyright (2006) 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 Roscoe A. Bartlett (rabartl@sandia.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
43#define THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
44
45
46#include "Thyra_PreconditionerFactoryBase.hpp"
47#include "Thyra_EpetraOperatorViewExtractorBase.hpp"
48#include "Teuchos_StandardCompositionMacros.hpp"
49
50namespace Thyra {
51
52
57class MLPreconditionerFactory : public PreconditionerFactoryBase<double> {
58public:
59
62
65
75 EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor );
76
78
81
83 bool isCompatible( const LinearOpSourceBase<double> &fwdOp ) const;
85 bool applySupportsConj(EConj conj) const;
87 bool applyTransposeSupportsConj(EConj conj) const;
89 Teuchos::RCP<PreconditionerBase<double> > createPrec() const;
91 void initializePrec(
92 const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOp,
93 PreconditionerBase<double> *prec,
94 const ESupportSolveUse supportSolveUse
95 ) const;
98 PreconditionerBase<double> *prec
99 ,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOp
100 ,ESupportSolveUse *supportSolveUse
101 ) const;
102
104
107
109 void setParameterList(
110 Teuchos::RCP<Teuchos::ParameterList> const& paramList);
112 Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
114 Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
116 Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
118 Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
120
123
125 std::string description() const;
126
127 // ToDo: Add an override of describe(...) to give more detail!
128
130
131private:
132
133 Teuchos::RCP<Teuchos::ParameterList> paramList_;
134
135};
136
137
138} // namespace Thyra
139
140
141#endif // THYRA_ML_PRECONDITIONER_FACTORY_DECL_HPP
Concrete preconditioner factory subclass based on ML.
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList()
bool isCompatible(const LinearOpSourceBase< double > &fwdOp) const
STANDARD_COMPOSITION_MEMBERS(EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor)
Set the strategy object used to extract an Epetra_Operator view of an input forward operator.
void uninitializePrec(PreconditionerBase< double > *prec, Teuchos::RCP< const LinearOpSourceBase< double > > *fwdOp, ESupportSolveUse *supportSolveUse) const
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList()
void initializePrec(const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOp, PreconditionerBase< double > *prec, const ESupportSolveUse supportSolveUse) const
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Teuchos::RCP< const Teuchos::ParameterList > getParameterList() const
Teuchos::RCP< PreconditionerBase< double > > createPrec() const
void setParameterList(Teuchos::RCP< Teuchos::ParameterList > const &paramList)
Teuchos::RCP< Teuchos::ParameterList > paramList_