Teko Version of the Day
Loading...
Searching...
No Matches
Teko_LU2x2Strategy.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_LU2x2Strategy_hpp__
48#define __Teko_LU2x2Strategy_hpp__
49
50#include "Teuchos_RCP.hpp"
51#include "Thyra_LinearOpBase.hpp"
52
53#include "Teko_Utilities.hpp"
54#include "Teko_InverseFactory.hpp"
55#include "Teko_BlockPreconditionerFactory.hpp"
56
57
58namespace Teko {
59
104public:
105 virtual ~LU2x2Strategy() {}
106
108 virtual const Teko::LinearOp
109 getHatInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
110
112 virtual const Teko::LinearOp
113 getTildeInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
114
116 virtual const Teko::LinearOp
117 getInvS(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
118
130 virtual void initializeFromParameterList(const Teuchos::ParameterList & /* settings */,
131 const InverseLibrary & /* invLib */)
132 { }
133
148 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const
149 { return Teuchos::null; }
150
164 virtual bool updateRequestedParameters(const Teuchos::ParameterList & /* pl */)
165 { return true; }
166
168 void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
169 { requestHandler_ = rh; }
170
172 Teuchos::RCP<RequestHandler> getRequestHandler() const
173 { return requestHandler_; }
174
175private:
176 Teuchos::RCP<RequestHandler> requestHandler_;
177
178};
179
189public:
198 StaticLU2x2Strategy(const Teko::LinearOp & hInvA00,
199 const Teko::LinearOp & tInvA00,
200 const Teko::LinearOp & invS)
201 : hatInvA00_(hInvA00), tildeInvA00_(tInvA00), invS_(invS)
202 {}
203
204 virtual ~StaticLU2x2Strategy() {}
205
208
210 virtual const Teko::LinearOp
211 getHatInvA00(const Teko::BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
212 { return hatInvA00_; }
213
215 virtual const Teko::LinearOp
216 getTildeInvA00(const Teko::BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
217 { return tildeInvA00_; }
218
220 virtual const Teko::LinearOp
221 getInvS(const Teko::BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
222 { return invS_; }
223
225
226protected:
227 const Teko::LinearOp hatInvA00_;
228 const Teko::LinearOp tildeInvA00_;
229 const Teko::LinearOp invS_;
231private:
232 // hide me!
234};
235
236} // end namespace Teko
237
238#endif
An implementation of a state object for block preconditioners.
Abstract strategy for computing inv(F) and inv(S) in the LU2x2PreconditionerFactory.
Teuchos::RCP< RequestHandler > getRequestHandler() const
This method gets the request handler uses by this object.
virtual const Teko::LinearOp getInvS(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual void initializeFromParameterList(const Teuchos::ParameterList &, const InverseLibrary &)
This function builds the internals of the state from a parameter list.
virtual const Teko::LinearOp getTildeInvA00(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const =0
void setRequestHandler(const Teuchos::RCP< RequestHandler > &rh)
This method sets the request handler for this object.
virtual bool updateRequestedParameters(const Teuchos::ParameterList &)
Update this object with the fields from a parameter list.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
virtual const Teko::LinearOp getHatInvA00(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const =0
A simple strategy for use with LU2x2PreconditionerFactory, that offers static objects for inv(F) and ...
virtual const Teko::LinearOp getInvS(const Teko::BlockedLinearOp &, BlockPreconditionerState &) const
const Teko::LinearOp hatInvA00_
virtual const Teko::LinearOp getHatInvA00(const Teko::BlockedLinearOp &, BlockPreconditionerState &) const
const Teko::LinearOp tildeInvA00_
StaticLU2x2Strategy(const Teko::LinearOp &hInvA00, const Teko::LinearOp &tInvA00, const Teko::LinearOp &invS)
Constructor that takes the static and objects.
virtual const Teko::LinearOp getTildeInvA00(const Teko::BlockedLinearOp &, BlockPreconditionerState &) const