Teko Version of the Day
Loading...
Searching...
No Matches
Teko_PreconditionerFactory.hpp
1/*
2// @HEADER
3//
4// ***********************************************************************
5//
6// Teko: A package for block and physics based preconditioning
7// Copyright 2010 Sandia Corporation
8//
9// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10// the U.S. Government retains certain rights in this software.
11//
12// Redistribution and use in source and binary forms, with or without
13// modification, are permitted provided that the following conditions are
14// met:
15//
16// 1. Redistributions of source code must retain the above copyright
17// notice, this list of conditions and the following disclaimer.
18//
19// 2. Redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution.
22//
23// 3. Neither the name of the Corporation nor the names of the
24// contributors may be used to endorse or promote products derived from
25// this software without specific prior written permission.
26//
27// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38//
39// Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40//
41// ***********************************************************************
42//
43// @HEADER
44
45*/
46
47#ifndef __Teko_PreconditionerFactory_hpp__
48#define __Teko_PreconditionerFactory_hpp__
49
50#include "Teuchos_ParameterListAcceptor.hpp"
51
52// Thyra includes
53#include "Thyra_SolveSupportTypes.hpp"
54#include "Thyra_LinearOpSourceBase.hpp"
55#include "Thyra_PreconditionerFactoryBase.hpp"
56#include "Thyra_DefaultBlockedLinearOp.hpp"
57#include "Thyra_DefaultPreconditioner.hpp"
58
59// Teko includes
60#include "Teko_Utilities.hpp"
61#include "Teko_InverseLibrary.hpp"
62#include "Teko_CloneFactory.hpp"
63#include "Teko_PreconditionerState.hpp"
64#include "Teko_RequestHandler.hpp"
65#include "Teko_RequestHandlerContainer.hpp"
66
67namespace Teko {
68
69using Thyra::LinearOpBase;
70using Thyra::DefaultPreconditioner;
71
83 : public virtual Thyra::PreconditionerFactoryBase<double>, public RequestHandlerContainer
84 {
85public:
86
100 virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const = 0;
101
114 virtual Teuchos::RCP<PreconditionerState> buildPreconditionerState() const
115 { return Teuchos::rcp(new PreconditionerState()); }
116
118
119
132 virtual void initializeFromParameterList(const Teuchos::ParameterList & /* settings */)
133 { }
134
149 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const
150 { return Teuchos::null; }
151
165 virtual bool updateRequestedParameters(const Teuchos::ParameterList & /* pl */)
166 { return true; }
167
169
171 void setInverseLibrary(const Teuchos::RCP<const InverseLibrary> & il);
172
174 Teuchos::RCP<const InverseLibrary> getInverseLibrary() const;
175
177
178
180 bool isCompatible(const Thyra::LinearOpSourceBase<double> &fwdOpSrc) const;
181
183 Teuchos::RCP<Thyra::PreconditionerBase<double> > createPrec() const;
184
195 void initializePrec(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > & fwdOpSrc,
196 const Teuchos::RCP<const Thyra::MultiVectorBase<double> > & solnVec,
197 Thyra::PreconditionerBase<double> * precOp,
198 const Thyra::ESupportSolveUse supportSolveUse) const;
199
201 void initializePrec(const Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > & fwdOpSrc,
202 Thyra::PreconditionerBase<double> * precOp,
203 const Thyra::ESupportSolveUse supportSolveUse) const;
204
206 void uninitializePrec(Thyra::PreconditionerBase<double> * prec,
207 Teuchos::RCP<const Thyra::LinearOpSourceBase<double> > * fwdOpSrc,
208 Thyra::ESupportSolveUse *supportSolveUse) const;
210
212
213
215 void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & paramList);
216
218 Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList();
219
221 Teuchos::RCP< Teuchos::ParameterList > unsetParameterList();
223
225 void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
226 { callbackHandler_ = rh; }
227
229 Teuchos::RCP<RequestHandler> getRequestHandler() const
230 { return callbackHandler_; }
231
232protected:
234 Teuchos::RCP<Teuchos::ParameterList> paramList_;
235
237 Teuchos::RCP<RequestHandler> callbackHandler_;
238
239private:
241 Teuchos::RCP<const InverseLibrary> inverseLibrary_;
242
244 static void setOpRequestHandler(const RequestHandlerContainer & rhc,const LinearOp & op);
245
246public:
247
262 static Teuchos::RCP<PreconditionerFactory>
263 buildPreconditionerFactory(const std::string & name,
264 const Teuchos::ParameterList & settings,
265 const Teuchos::RCP<const InverseLibrary> & invLib=Teuchos::null);
266
280 static void addPreconditionerFactory(const std::string & name,const Teuchos::RCP<Cloneable> & clone);
281
284 static void getPreconditionerFactoryNames(std::vector<std::string> & names);
285
286private:
287
289 static CloneFactory<PreconditionerFactory> precFactoryBuilder_;
290
292 static void initializePrecFactoryBuilder();
293};
294
295} // end namespace Teko
296
297#endif
Abstract class which block preconditioner factories in Teko should be based on.
virtual void initializeFromParameterList(const Teuchos::ParameterList &)
This function builds the internals of the preconditioner factory from a parameter list.
void initializePrec(const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOpSrc, const Teuchos::RCP< const Thyra::MultiVectorBase< double > > &solnVec, Thyra::PreconditionerBase< double > *precOp, const Thyra::ESupportSolveUse supportSolveUse) const
initialize a newly created preconditioner object
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList()
Get the parameter list that was set using setParameterList().
void setInverseLibrary(const Teuchos::RCP< const InverseLibrary > &il)
Set the inverse library used by this preconditioner factory.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
static Teuchos::RCP< PreconditionerFactory > buildPreconditionerFactory(const std::string &name, const Teuchos::ParameterList &settings, const Teuchos::RCP< const InverseLibrary > &invLib=Teuchos::null)
Builder function for creating preconditioner factories (yes this is a factory factory).
Teuchos::RCP< Thyra::PreconditionerBase< double > > createPrec() const
create an instance of the preconditioner
void initializePrec(const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOpSrc, Thyra::PreconditionerBase< double > *precOp, const Thyra::ESupportSolveUse supportSolveUse) const
initialize a newly created preconditioner object
void setRequestHandler(const Teuchos::RCP< RequestHandler > &rh)
Set the request handler with pointers to the appropriate callbacks.
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > &paramList)
Set parameters from a parameter list and return with default values.
Teuchos::RCP< Teuchos::ParameterList > paramList_
for ParameterListAcceptor
static void addPreconditionerFactory(const std::string &name, const Teuchos::RCP< Cloneable > &clone)
Add a preconditioner factory to the builder. This is done using the clone pattern.
virtual LinearOp buildPreconditionerOperator(LinearOp &lo, PreconditionerState &state) const =0
Function that is called to build the preconditioner for the linear operator that is passed in.
Teuchos::RCP< RequestHandler > callbackHandler_
For handling requests and send requests back to the user.
void uninitializePrec(Thyra::PreconditionerBase< double > *prec, Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > *fwdOpSrc, Thyra::ESupportSolveUse *supportSolveUse) const
wipe clean a already initialized preconditioner object
bool isCompatible(const Thyra::LinearOpSourceBase< double > &fwdOpSrc) const
is this operator compatiable with the preconditioner factory?
static void getPreconditionerFactoryNames(std::vector< std::string > &names)
Get the names of the block preconditioner factories.
virtual Teuchos::RCP< PreconditionerState > buildPreconditionerState() const
Function that permits the construction of an arbitrary PreconditionerState object.
Teuchos::RCP< const InverseLibrary > getInverseLibrary() const
Get the inverse library used by this preconditioner factory.
virtual bool updateRequestedParameters(const Teuchos::ParameterList &)
Update this object with the fields from a parameter list.
Teuchos::RCP< RequestHandler > getRequestHandler() const
Get the request handler with pointers to the appropriate callbacks.
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList()
Unset the parameter list that was set using setParameterList().
An implementation of a state object preconditioners.