Stratimikos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Thyra_IfpackPreconditionerFactory.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_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP
43 #define THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP
44 
45 #include "Thyra_PreconditionerFactoryBase.hpp"
48 #include "Ifpack.h"
49 
50 namespace Thyra {
51 
56 class IfpackPreconditionerFactory : public PreconditionerFactoryBase<double> {
57 public:
58 
61 
64 
74 
76 
79 
81  bool isCompatible( const LinearOpSourceBase<double> &fwdOpSrc ) const;
83  bool applySupportsConj(EConj conj) const;
85  bool applyTransposeSupportsConj(EConj conj) const;
89  void initializePrec(
90  const Teuchos::RCP<const LinearOpSourceBase<double> > &fwdOpSrc
91  ,PreconditionerBase<double> *prec
92  ,const ESupportSolveUse supportSolveUse
93  ) const;
95  void uninitializePrec(
96  PreconditionerBase<double> *prec
97  ,Teuchos::RCP<const LinearOpSourceBase<double> > *fwdOpSrc
98  ,ESupportSolveUse *supportSolveUse
99  ) const;
100 
102 
105 
116 
118 
121 
123  std::string description() const;
124 
126 
127 private:
128 
129  // ////////////////////////////////
130  // Private data members
131 
133  ::Ifpack::EPrecType precType_;
134  int overlap_;
135 
136  // ////////////////////////////////
137  // Private member functions
138 
139  static void initializeTimers();
140 
141 };
142 
143 } // namespace Thyra
144 
145 #endif // THYRA_IFPACK_PRECONDITIONER_FACTORY_DECL_HPP
Concrete preconditioner factory subclass based on Ifpack.
Teuchos::RCP< Teuchos::ParameterList > paramList_
Teuchos::RCP< PreconditionerBase< double > > createPrec() const
bool isCompatible(const LinearOpSourceBase< double > &fwdOpSrc) const
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
void uninitializePrec(PreconditionerBase< double > *prec, Teuchos::RCP< const LinearOpSourceBase< double > > *fwdOpSrc, ESupportSolveUse *supportSolveUse) const
Teuchos::RCP< const Teuchos::ParameterList > getParameterList() const
void setParameterList(Teuchos::RCP< Teuchos::ParameterList > const &paramList)
STANDARD_COMPOSITION_MEMBERS(EpetraOperatorViewExtractorBase, epetraFwdOpViewExtractor)
Set the strategy object used to extract an Epetra_Operator view of an input forward operator...
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList()
void initializePrec(const Teuchos::RCP< const LinearOpSourceBase< double > > &fwdOpSrc, PreconditionerBase< double > *prec, const ESupportSolveUse supportSolveUse) const
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList()