Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_SIMPLEPreconditionerFactory.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_SIMPLEPreconditionerFactory_hpp__
48 #define __Teko_SIMPLEPreconditionerFactory_hpp__
49 
50 #include "Teko_BlockPreconditionerFactory.hpp"
51 #include "Teko_InverseFactory.hpp"
52 
53 namespace Teko {
54 namespace NS {
55 
56 // Declaration of the preconditioner factory
74  public:
75  // Constructor
76  SIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory>& inverse, double alpha);
77 
78  // Constructor
79  SIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory>& invVelFactory,
80  const Teuchos::RCP<InverseFactory>& invPrsFactory, double alpha);
81 
84 
85  // Function inherited from BlockPreconditionerFactory
86  LinearOp buildPreconditionerOperator(BlockedLinearOp& blo, BlockPreconditionerState& state) const;
87 
89  virtual void setMassMatrix(Teko::LinearOp& mass) { massMatrix_ = mass; }
90 
92  virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
93 
95  virtual bool updateRequestedParameters(const Teuchos::ParameterList& pl);
96 
98  virtual void initializeFromParameterList(const Teuchos::ParameterList& pl);
99 
100  protected:
102 
103  // class members
104  Teuchos::RCP<InverseFactory> customHFactory_;
105  Teuchos::RCP<InverseFactory> invVelFactory_;
106  Teuchos::RCP<InverseFactory> invPrsFactory_;
107  double alpha_;
108  DiagonalType fInverseType_;
109  // enum FInverseType {Diagonal,Lumped,AbsRowSum,Custom} fInverseType_;
110 
111  bool useMass_;
112  Teko::LinearOp massMatrix_;
113 
114  // Info for the block-diagonal approximation to H if used.
115  mutable Teuchos::ParameterList BlkDiagList_;
116 };
117 
118 } // end namespace NS
119 } // end namespace Teko
120 
121 #endif
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...
Abstract class which block preconditioner factories in Teko should be based on.
virtual bool updateRequestedParameters(const Teuchos::ParameterList &pl)
For assisting in construction of the preconditioner.
An implementation of a state object for block preconditioners.
virtual void setMassMatrix(Teko::LinearOp &mass)
Set the mass matrix for this factory.
virtual void initializeFromParameterList(const Teuchos::ParameterList &pl)
Initialize from a parameter list.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
For assisting in construction of the preconditioner.
LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const
Function that is called to build the preconditioner for the linear operator that is passed in...