Teko Version of the Day
Loading...
Searching...
No Matches
Teko_LU2x2PreconditionerFactory.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_LU2x2PreconditionerFactory_hpp__
48#define __Teko_LU2x2PreconditionerFactory_hpp__
49
50#include "Teuchos_RCP.hpp"
51
52#include "Teko_BlockPreconditionerFactory.hpp"
53#include "Teko_LU2x2Strategy.hpp"
54
55namespace Teko {
56
142public:
144
145
147 LU2x2PreconditionerFactory(LinearOp & invA00,LinearOp & invS);
148
150 LU2x2PreconditionerFactory(LinearOp & hatInvA00,LinearOp & tildeInvA00,LinearOp & invS);
151
160 LU2x2PreconditionerFactory(const Teuchos::RCP<LU2x2Strategy> & strategy);
161
162
168
170
177 LinearOp buildPreconditionerOperator(BlockedLinearOp & blo,BlockPreconditionerState & state) const;
178
191 virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);
192
207 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
208
222 virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
223
236 virtual bool useFullLDU() const { return useFullLDU_; }
237
248 virtual void setFullLDU(bool value)
249 { useFullLDU_ = value; }
250
251protected:
253
255 Teuchos::RCP<LU2x2Strategy> invOpsStrategy_;
256
262
263public:
276 static RCP<LU2x2Strategy>
277 buildStrategy(const std::string & name,
278 const Teuchos::ParameterList & settings,
279 const RCP<const InverseLibrary> & invLib,
280 const RCP<RequestHandler> & rh);
281
295 static void addStrategy(const std::string & name,const RCP<Cloneable> & clone);
296
297private:
299 static CloneFactory<LU2x2Strategy> strategyBuilder_;
300
302 static void initializeStrategyBuilder();
303};
304
305} // end namespace Teko
306
307#endif
Abstract class which block preconditioner factories in Teko should be based on.
virtual LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const =0
Function that is called to build the preconditioner for the linear operator that is passed in.
An implementation of a state object for block preconditioners.
Construct a preconditioner using a LDU dcomposition of a block 2x2 matrix.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
LU2x2PreconditionerFactory()
Default constructor for use with AutoClone.
virtual void initializeFromParameterList(const Teuchos::ParameterList &settings)
This function builds the internals of the preconditioner factory from a parameter list.
virtual void setFullLDU(bool value)
Set the type of inverse operation to use.
LU2x2PreconditionerFactory(const Teuchos::RCP< LU2x2Strategy > &strategy)
Constructor that permits the most generality in building and .
Teuchos::RCP< LU2x2Strategy > invOpsStrategy_
some members
virtual bool updateRequestedParameters(const Teuchos::ParameterList &pl)
Update this object with the fields from a parameter list.
static RCP< LU2x2Strategy > buildStrategy(const std::string &name, const Teuchos::ParameterList &settings, const RCP< const InverseLibrary > &invLib, const RCP< RequestHandler > &rh)
Builder function for creating strategies.
virtual bool useFullLDU() const
Determine the type of inverse operator to build.
static void addStrategy(const std::string &name, const RCP< Cloneable > &clone)
Add a strategy to the builder. This is done using the clone pattern.
LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const
Create the LU 2x2 preconditioner operator.