Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_MultPreconditionerFactory.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_MultiPreconditionerFactory_hpp__
48 #define __Teko_MultiPreconditionerFactory_hpp__
49 
50 #include "Teko_BlockPreconditionerFactory.hpp"
51 #include "Teko_Utilities.hpp"
52 #include "Teko_BlockImplicitLinearOp.hpp"
53 
54 namespace Teko {
55 
61 public:
62  MultPrecondState() {}
63 
64  Teuchos::RCP<BlockPreconditionerState> StateOne_;
65  Teuchos::RCP<BlockPreconditionerState> StateTwo_;
66 };
67 
92 public:
93 
95  MultPrecsLinearOp(const Teko::LinearOp &A, const Teko::LinearOp &M1,
96  const Teko::LinearOp &M2): A_(A), M1_(M1), M2_(M2) { }
97 
98  virtual Teko::VectorSpace range() const { return M1_->range(); }
99  virtual Teko::VectorSpace domain() const { return M1_->domain();}
100  virtual void implicitApply(const Teko::BlockedMultiVector & r, Teko::BlockedMultiVector & y,
101  const double alpha = 1.0, const double beta = 0.0) const;
102 
103 protected:
105 
106  Teko::LinearOp A_, M1_, M2_;
107 
108 private:
109  // hide me!
112 };
113 
120 public:
122  MultPreconditionerFactory(const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & FirstFactory,
123  const Teuchos::RCP<const Teko::BlockPreconditionerFactory> & SecondFactory);
124 
126 
128  Teko::LinearOp buildPreconditionerOperator(Teko::BlockedLinearOp & blo,
129  Teko::BlockPreconditionerState & state) const;
130 
132  virtual Teuchos::RCP<Teko::PreconditionerState> buildPreconditionerState() const;
133 
134 protected:
136 
137  // class members
138  Teuchos::RCP<const Teko::BlockPreconditionerFactory> FirstFactory_;
139  Teuchos::RCP<const Teko::BlockPreconditionerFactory> SecondFactory_;
140 
142  virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
143 };
144 
145 } // end namespace Teko
146 
147 #endif
virtual void implicitApply(const BlockedMultiVector &x, BlockedMultiVector &y, const double alpha=1.0, const double beta=0.0) const =0
Perform a matrix vector multiply with this implicitly defined blocked operator.
virtual Teko::VectorSpace domain() const
Domain space of this operator.
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...
virtual Teuchos::RCP< Teko::PreconditionerState > buildPreconditionerState() const
Build the MultPrecondState object.
virtual Teko::VectorSpace range() const
Range space of this operator.
virtual void initializeFromParameterList(const Teuchos::ParameterList &pl)
Initialize from a parameter list.
Abstract class which block preconditioner factories in Teko should be based on.
An implementation of a state object for block preconditioners.
A virtual class that simplifies the construction of custom operators.
MultPrecsLinearOp(const Teko::LinearOp &A, const Teko::LinearOp &M1, const Teko::LinearOp &M2)
Constructor.
Teko::LinearOp buildPreconditionerOperator(Teko::BlockedLinearOp &blo, Teko::BlockPreconditionerState &state) const
Function inherited from Teko::BlockPreconditionerFactory.
virtual void implicitApply(const Teko::BlockedMultiVector &r, Teko::BlockedMultiVector &y, const double alpha=1.0, const double beta=0.0) const
Perform a matrix vector multiply with this implicitly defined blocked operator.