Teko Version of the Day
Loading...
Searching...
No Matches
Teko_LSCStrategy.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_LSCStrategy_hpp__
48#define __Teko_LSCStrategy_hpp__
49
50#include "Teuchos_RCP.hpp"
51
52#include "Thyra_LinearOpBase.hpp"
53
54#include "Teko_Utilities.hpp"
55#include "Teko_InverseFactory.hpp"
56#include "Teko_BlockPreconditionerFactory.hpp"
57
58namespace Teko {
59namespace NS {
60
61class LSCPrecondState; // forward declaration
62
120public:
121 virtual ~LSCStrategy() {}
122
130 virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
131
140 virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
141
150 virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
151
160 virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
161
162 #if 0
171 virtual LinearOp getInvAlphaD(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
172 #endif
173
184 virtual LinearOp getOuterStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
185
196 virtual LinearOp getInnerStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
197
206 virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
207
216 virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const = 0;
217
224 virtual bool useFullLDU() const = 0;
225
231 virtual void setSymmetric(bool isSymmetric) = 0;
232
234 virtual void initializeFromParameterList(const Teuchos::ParameterList & /* pl */,const InverseLibrary & /* invLib */) {}
235
237 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const { return Teuchos::null;}
238
240 virtual bool updateRequestedParameters(const Teuchos::ParameterList & /* pl */) { return true; }
241
243 void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
244 { requestHandler_ = rh; }
245
247 Teuchos::RCP<RequestHandler> getRequestHandler() const
248 { return requestHandler_; }
249
250private:
251 Teuchos::RCP<RequestHandler> requestHandler_;
252
253};
254
255} // end namespace NS
256} // end namespace Teko
257
258#endif
An implementation of a state object for block preconditioners.
Strategy for driving LSCPreconditionerFactory.
virtual bool useFullLDU() const =0
virtual LinearOp getOuterStabilization(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual LinearOp getInnerStabilization(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual LinearOp getInvBHBt(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual LinearOp getInvBQBt(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual LinearOp getInvF(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual LinearOp getInvMass(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
void setRequestHandler(const Teuchos::RCP< RequestHandler > &rh)
This method sets the request handler for this object.
virtual LinearOp getHScaling(const BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual bool updateRequestedParameters(const Teuchos::ParameterList &)
For assiting in construction of the preconditioner.
Teuchos::RCP< RequestHandler > getRequestHandler() const
This method gets the request handler uses by this object.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
For assiting in construction of the preconditioner.
virtual void buildState(BlockedLinearOp &A, BlockPreconditionerState &state) const =0
virtual void setSymmetric(bool isSymmetric)=0
virtual void initializeFromParameterList(const Teuchos::ParameterList &, const InverseLibrary &)
Initialize from a parameter list.