Teko Version of the Day
Loading...
Searching...
No Matches
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
52namespace Teko {
53namespace NS {
54
55class LSCPrecondState; // forward declaration
56
57// constant, not very flexible strategy for driving LSCPreconditioenrFactory
58class StaticLSCStrategy : public LSCStrategy {
59public:
60
61 // Staiblized constructor
62 StaticLSCStrategy(const LinearOp & invF,
63 const LinearOp & invBQBtmC,
64 const LinearOp & invD,
65 const LinearOp & invMass);
66
67 // Stable constructor
68 StaticLSCStrategy(const LinearOp & invF,
69 const LinearOp & invBQBtmC,
70 const LinearOp & invMass);
71
79 virtual void buildState(BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const {}
80
89 virtual LinearOp getInvF(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
90 { return invF_; }
91
100 virtual LinearOp getInvBQBt(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
101 { return invBQBtmC_; }
102
111 virtual LinearOp getInvBHBt(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
112 { return invBQBtmC_; }
113
122 virtual LinearOp getOuterStabilization(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
123 { return invD_; }
124
125 virtual LinearOp getInnerStabilization(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
126 { return Teuchos::null; }
127
136 virtual LinearOp getInvMass(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
137 { return invMass_; }
138
147 virtual LinearOp getHScaling(const BlockedLinearOp & /* A */,BlockPreconditionerState & /* state */) const
148 { return invMass_; }
149
156 virtual bool useFullLDU() const { return false; }
157
163 virtual void setSymmetric(bool /* isSymmetric */) { }
164
165protected:
166 // protected memebers
167 LinearOp invF_;
168 LinearOp invBQBtmC_;
169 LinearOp invD_;
170 LinearOp invMass_;
171};
172
173} // end namespace NS
174} // end namespace Teko
175
176#endif