Teko Version of the Day
Loading...
Searching...
No Matches
Teko_InverseFactory.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_InverseFactory_hpp__
48#define __Teko_InverseFactory_hpp__
49
50// Teuchos includes
51#include "Teuchos_RCP.hpp"
52
53// Thyra includes
54#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
55#include "Thyra_PreconditionerFactoryBase.hpp"
56
57#include "Teko_Config.h"
58#include "Teko_Utilities.hpp"
59#include "Teko_PreconditionerState.hpp"
60#include "Teko_RequestHandler.hpp"
61#include "Teko_RequestHandlerContainer.hpp"
62
63namespace Teko {
64
72public:
73 virtual ~InverseFactory() {}
74
84 virtual InverseLinearOp buildInverse(const LinearOp & linearOp) const = 0;
85
98 virtual InverseLinearOp buildInverse(const LinearOp & linearOp,const LinearOp & /* precOp */) const
99 { return buildInverse(linearOp); }
100
101 #if 0
114 virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const PreconditionerState & parentState) const
115 { return buildInverse(linearOp); }
116
132 virtual InverseLinearOp buildInverse(const LinearOp & linearOp, const LinearOp & precOp, const PreconditionerState & parentState) const
133 { return buildInverse(linearOp,precOp); }
134 #endif
135
147 virtual void rebuildInverse(const LinearOp & source,InverseLinearOp & dest) const = 0;
148
161 virtual void rebuildInverse(const LinearOp & source,const LinearOp & /* precOp */,InverseLinearOp & dest) const
162 { rebuildInverse(source,dest); }
163
172 virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const = 0;
173
175 virtual std::string toString() const = 0;
176
191 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const
192 { return Teuchos::null; }
193
207 virtual bool updateRequestedParameters(const Teuchos::ParameterList & /* pl */)
208 { return true; }
209
211 void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
212 { callbackHandler_ = rh; }
213
215 Teuchos::RCP<RequestHandler> getRequestHandler() const
216 { return callbackHandler_; }
217
218protected:
220 Teuchos::RCP<RequestHandler> callbackHandler_;
221};
222
223class StaticOpInverseFactory : public InverseFactory {
224public:
226
227
236 StaticOpInverseFactory(const LinearOp inv)
237 : inverse_(inv) {}
238
240 StaticOpInverseFactory(const StaticOpInverseFactory & saFactory)
241 : inverse_(saFactory.inverse_) {}
243
244 virtual ~StaticOpInverseFactory() {}
245
248
260 virtual InverseLinearOp buildInverse(const LinearOp & /* linearOp */) const
261 { return Teuchos::rcp_const_cast<Thyra::LinearOpBase<double> >(this->inverse_); }
262
277 virtual void rebuildInverse(const LinearOp & /* source */,InverseLinearOp & /* dest */) const
278 { }
279
288 virtual Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const
289 { return Teuchos::null; }
290
292 virtual std::string toString() const { return inverse_->description(); }
293
294protected:
295 Teko::LinearOp inverse_;
296
297private:
298 // hide me!
299 StaticOpInverseFactory();
300};
301
303
304
315InverseLinearOp buildInverse(const InverseFactory & factory,const LinearOp & A);
316
328InverseLinearOp buildInverse(const InverseFactory & factory,const LinearOp & A,const LinearOp & precOp);
329
344void rebuildInverse(const InverseFactory & factory, const LinearOp & A, InverseLinearOp & invA);
345
361void rebuildInverse(const InverseFactory & factory, const LinearOp & A,const LinearOp & precOp, InverseLinearOp & invA);
362
379Teuchos::RCP<InverseFactory> invFactoryFromParamList(const Teuchos::ParameterList & list,const std::string & type);
380
394Teuchos::RCP<const Teuchos::ParameterList> invFactoryValidParameters();
395
397
398} // end namespace Teko
399
400#endif
RCP< InverseFactory > invFactoryFromParamList(const Teuchos::ParameterList &list, const std::string &type)
Build an InverseFactory object from a ParameterList, as specified in Stratimikos.
Teuchos::RCP< const Teuchos::ParameterList > invFactoryValidParameters()
Get a valid parameter list for the inverse factory class.
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)
Abstract class for building an inverse operator.
Teuchos::RCP< RequestHandler > getRequestHandler() const
Get the request handler with pointers to the appropriate callbacks.
virtual Teuchos::RCP< const Teuchos::ParameterList > getParameterList() const =0
A function that permits inspection of the parameters used to create this object.
void setRequestHandler(const Teuchos::RCP< RequestHandler > &rh)
Set the request handler with pointers to the appropriate callbacks.
virtual std::string toString() const =0
virtual InverseLinearOp buildInverse(const LinearOp &linearOp) const =0
Build an inverse operator.
virtual void rebuildInverse(const LinearOp &source, const LinearOp &, InverseLinearOp &dest) const
Pass in an already constructed inverse operator. Update the inverse operator based on the new source ...
void rebuildInverse(const InverseFactory &factory, const LinearOp &A, const LinearOp &precOp, InverseLinearOp &invA)
InverseLinearOp buildInverse(const InverseFactory &factory, const LinearOp &A, const LinearOp &precOp)
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
virtual InverseLinearOp buildInverse(const LinearOp &linearOp, const LinearOp &) const
Build a preconditioned inverse operator.
virtual bool updateRequestedParameters(const Teuchos::ParameterList &)
Update this object with the fields from a parameter list.
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 ...
Teuchos::RCP< RequestHandler > callbackHandler_
For handling requests and send requests back to the user.
An implementation of a state object preconditioners.