Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_StaticLSCStrategy.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_StaticLSCStrategy_hpp__
48 #define __Teko_StaticLSCStrategy_hpp__
49 
50 #include "Teko_LSCStrategy.hpp"
51 
52 namespace Teko {
53 namespace NS {
54 
55 class LSCPrecondState; // forward declaration
56 
57 // constant, not very flexible strategy for driving LSCPreconditioenrFactory
58 class StaticLSCStrategy : public LSCStrategy {
59  public:
60  // Staiblized constructor
61  StaticLSCStrategy(const LinearOp& invF, const LinearOp& invBQBtmC, const LinearOp& invD,
62  const LinearOp& invMass);
63 
64  // Stable constructor
65  StaticLSCStrategy(const LinearOp& invF, const LinearOp& invBQBtmC, const LinearOp& invMass);
66 
74  virtual void buildState(BlockedLinearOp& /* A */, BlockPreconditionerState& /* state */) const {}
75 
84  virtual LinearOp getInvF(const BlockedLinearOp& /* A */,
85  BlockPreconditionerState& /* state */) const {
86  return invF_;
87  }
88 
97  virtual LinearOp getInvBQBt(const BlockedLinearOp& /* A */,
98  BlockPreconditionerState& /* state */) const {
99  return invBQBtmC_;
100  }
101 
110  virtual LinearOp getInvBHBt(const BlockedLinearOp& /* A */,
111  BlockPreconditionerState& /* state */) const {
112  return invBQBtmC_;
113  }
114 
123  virtual LinearOp getOuterStabilization(const BlockedLinearOp& /* A */,
124  BlockPreconditionerState& /* state */) const {
125  return invD_;
126  }
127 
128  virtual LinearOp getInnerStabilization(const BlockedLinearOp& /* A */,
129  BlockPreconditionerState& /* state */) const {
130  return Teuchos::null;
131  }
132 
141  virtual LinearOp getInvMass(const BlockedLinearOp& /* A */,
142  BlockPreconditionerState& /* state */) const {
143  return invMass_;
144  }
145 
154  virtual LinearOp getHScaling(const BlockedLinearOp& /* A */,
155  BlockPreconditionerState& /* state */) const {
156  return invMass_;
157  }
158 
165  virtual bool useFullLDU() const { return false; }
166 
172  virtual void setSymmetric(bool /* isSymmetric */) {}
173 
174  protected:
175  // protected memebers
176  LinearOp invF_;
177  LinearOp invBQBtmC_;
178  LinearOp invD_;
179  LinearOp invMass_;
180 };
181 
182 } // end namespace NS
183 } // end namespace Teko
184 
185 #endif