Teko Version of the Day
Loading...
Searching...
No Matches
Teko_SmootherPreconditionerFactory.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_SmootherPreconditionerFactory_hpp__
48#define __Teko_SmootherPreconditionerFactory_hpp__
49
50// Teko includes
51#include "Teko_PreconditionerFactory.hpp"
52#include "Teko_ImplicitLinearOp.hpp"
53#include "Teko_RequestHandlerContainer.hpp"
54
55namespace Teko {
56
62public:
63 SmootherLinearOp(const LinearOp & A, const LinearOp & invM,unsigned int applications,bool useDestAsInitialGuess=false);
64 SmootherLinearOp(const LinearOp & A, const LinearOp & invM,unsigned int applications,unsigned int block);
65
67 virtual VectorSpace range() const
68 { return invM_->range(); }
69
71 virtual VectorSpace domain() const
72 { return invM_->domain(); }
73
87 virtual void implicitApply(const MultiVector & x, MultiVector & y,
88 const double alpha = 1.0, const double beta = 0.0) const;
89
91 virtual void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh);
92
94 virtual Teuchos::RCP<RequestHandler> getRequestHandler() const;
95
96private:
97 // enum describing initial guess type
98 typedef enum {Unspecified, RequestInitialGuess, DestAsInitialGuess, NoInitialGuess} InitialGuessType;
99
100 LinearOp A_; // forward operator
101 LinearOp invM_; // preconditioner
102 unsigned int applications_; // how much smoothing is required
103 InitialGuessType initialGuessType_; // type of initial guess to use
104
105 // for producing an initial guess
106 Teuchos::RCP<RequestMesg> requestMesg_;
107
108 // used by RequestHandlerContainer interface
109 Teuchos::RCP<RequestHandler> requestHandler_;
110
111 SmootherLinearOp(); // hide me
112 SmootherLinearOp(const SmootherLinearOp &); // hide me
113};
114
115LinearOp buildSmootherLinearOp(const LinearOp & A,const LinearOp & invM,unsigned int applications,bool useDestAsInitialGuess=false);
116LinearOp buildSmootherLinearOp(const LinearOp & A,const LinearOp & invM,unsigned int applications,unsigned int initialGuessBlock);
117
120class SmootherPreconditionerFactory
121 : public virtual Teko::PreconditionerFactory {
122public:
124 SmootherPreconditionerFactory();
125
139 virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const;
140
142
143
154 virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);
155
157
158private:
159 // enum describing initial guess type
160 typedef enum {Unspecified, RequestInitialGuess, DestAsInitialGuess, NoInitialGuess} InitialGuessType;
161
162 // parameters specifying behavior of smoother operator
163 unsigned int sweepCount_;
164 InitialGuessType initialGuessType_;
165 unsigned int initialGuessBlock_;
166
167 // prectionditioner to use as residual correction in smoother
168 Teuchos::RCP<Teko::InverseFactory> precFactory_;
169};
170
171} // end namespace Teko
172
173#endif
A virtual class that simplifies the construction of custom operators.
Abstract class which block preconditioner factories in Teko should be based on.
virtual VectorSpace range() const
Range space of this operator.
virtual void setRequestHandler(const Teuchos::RCP< RequestHandler > &rh)
Set the request handler with pointers to the appropriate callbacks.
virtual void implicitApply(const MultiVector &x, MultiVector &y, const double alpha=1.0, const double beta=0.0) const
Perform a matrix vector multiply with this implicitly defined blocked operator.
virtual VectorSpace domain() const
Domain space of this operator.
virtual Teuchos::RCP< RequestHandler > getRequestHandler() const
Get the request handler with pointers to the appropriate callbacks.