Teko Version of the Day
Loading...
Searching...
No Matches
Teko_PreconditionerInverseFactory.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_PreconditionerInverseFactory_hpp__
48#define __Teko_PreconditionerInverseFactory_hpp__
49
50#include "Teko_InverseFactory.hpp"
51
52namespace Teko {
53
54class PreconditionerInverseFactory : public InverseFactory {
55public:
58
60
61
71 PreconditionerInverseFactory(const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > & precFactory,
72 const Teuchos::RCP<Teko::RequestHandler> & rh);
73
88 PreconditionerInverseFactory(const Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > & precFactory,
89 const Teuchos::RCP<const Teuchos::ParameterList> & xtraParam,
90 const Teuchos::RCP<Teko::RequestHandler> & rh);
91
93 PreconditionerInverseFactory(const PreconditionerInverseFactory & pFactory);
95
96 virtual ~PreconditionerInverseFactory() {}
97
110 virtual InverseLinearOp buildInverse(const LinearOp & linearOp) const;
111
124 virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const PreconditionerState & parentState) const;
125
140 virtual void rebuildInverse(const LinearOp & source,InverseLinearOp & dest) const;
141
150 virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
151
166 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
167
181 virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
182
184 virtual std::string toString() const { return precFactory_->description(); }
185
187 Teuchos::RCP<const Thyra::PreconditionerFactoryBase<double> > getPrecFactory() const
188 { return precFactory_; }
189
191 Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > getPrecFactory()
192 { return precFactory_; }
193
202 void setupParameterListFromRequestHandler();
203protected:
204
205 Teuchos::RCP<Thyra::PreconditionerFactoryBase<double> > precFactory_;
206 Teuchos::RCP<Teuchos::ParameterList> extraParams_;
207
208private:
209 // hide me!
210 PreconditionerInverseFactory();
211};
212
213}
214
215#endif
InverseLinearOp buildInverse(const InverseFactory &factory, const LinearOp &A)
Build an inverse operator using a factory and a linear operator.
void rebuildInverse(const InverseFactory &factory, const LinearOp &A, InverseLinearOp &invA)
virtual InverseLinearOp buildInverse(const LinearOp &linearOp) const =0
Build an inverse operator.
virtual void rebuildInverse(const LinearOp &source, InverseLinearOp &dest) const =0
Pass in an already constructed inverse operator. Update the inverse operator based on the new source ...