Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_LSCSIMPLECStrategy.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_LSCSIMPLECStrategy_hpp__
48 #define __Teko_LSCSIMPLECStrategy_hpp__
49 
50 #include "Teko_LSCStrategy.hpp"
51 
52 namespace Teko {
53 namespace NS {
54 
55 class LSCPrecondState; // forward declration
56 
67 public:
69 
72 
73  virtual ~LSCSIMPLECStrategy() {}
74 
76 
77 
85  virtual void buildState(BlockedLinearOp & A,BlockPreconditionerState & state) const;
86 
95  virtual LinearOp getInvBQBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
96 
105  virtual LinearOp getInvBHBt(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
106 
115  virtual LinearOp getInvF(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
116 
126  virtual LinearOp getOuterStabilization(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
127  { return Teuchos::null; }
128 
129  virtual LinearOp getInnerStabilization(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
130 
139  virtual LinearOp getInvMass(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
140 
149  virtual LinearOp getHScaling(const BlockedLinearOp & A,BlockPreconditionerState & state) const;
150 
157  virtual bool useFullLDU() const { return useFullLDU_; }
158 
160  virtual void initializeFromParameterList(const Teuchos::ParameterList & pl,
161  const InverseLibrary & invLib);
162 
164  virtual void initializeState(const BlockedLinearOp & A,LSCPrecondState * state) const;
165 
171  void computeInverses(const BlockedLinearOp & A,LSCPrecondState * state) const;
172 
174  virtual void setUseFullLDU(bool val) { useFullLDU_ = val; }
175 
176  virtual void setSymmetric(bool /* isSymmetric */) { }
177 
178 protected:
179  // how to invert the matrices
180  Teuchos::RCP<InverseFactory> invFactoryF_;
181  Teuchos::RCP<InverseFactory> invFactoryS_;
182 
183  // flags for handling various options
184  bool useFullLDU_;
185  DiagonalType scaleType_;
186 
187 private:
189 };
190 
191 } // end namespace NS
192 } // end namespace Teko
193 
194 #endif
virtual LinearOp getOuterStabilization(const BlockedLinearOp &, BlockPreconditionerState &) const
void computeInverses(const BlockedLinearOp &A, LSCPrecondState *state) const
virtual LinearOp getInvMass(const BlockedLinearOp &A, BlockPreconditionerState &state) const
An implementation of a state object for block preconditioners.
virtual void setUseFullLDU(bool val)
Set to true to use the Full LDU decomposition, false otherwise.
virtual void initializeState(const BlockedLinearOp &A, LSCPrecondState *state) const
Initialize the state object using this blocked linear operator.
virtual LinearOp getHScaling(const BlockedLinearOp &A, BlockPreconditionerState &state) const
Preconditioner state for the LSC factory.
A strategy that takes a single inverse factory and uses that for all inverses. If no mass matrix is p...
Strategy for driving LSCPreconditionerFactory.
virtual void initializeFromParameterList(const Teuchos::ParameterList &pl, const InverseLibrary &invLib)
Initialize from a parameter list.
virtual LinearOp getInnerStabilization(const BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual LinearOp getInvF(const BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual LinearOp getInvBHBt(const BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual LinearOp getInvBQBt(const BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual void buildState(BlockedLinearOp &A, BlockPreconditionerState &state) const
Functions inherited from LSCStrategy.