Teko Version of the Day
Loading...
Searching...
No Matches
Teko_PCDStrategy.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_PCDStrategy_hpp__
48#define __Teko_PCDStrategy_hpp__
49
50#include "Teko_LU2x2Strategy.hpp"
51
52// Teuchos includes
53#include "Teuchos_Time.hpp"
54
55namespace Teko {
56namespace NS {
57
66class PCDStrategy : public LU2x2Strategy {
67public:
70
72 PCDStrategy(const Teuchos::RCP<InverseFactory> & invFA,
73 const Teuchos::RCP<InverseFactory> & invS);
74
76 virtual ~PCDStrategy() {}
77
79 virtual const Teko::LinearOp
80 getHatInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
81
83 virtual const Teko::LinearOp
84 getTildeInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
85
87 virtual const Teko::LinearOp
88 getInvS(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
89
97 virtual void initializeFromParameterList(const Teuchos::ParameterList & settings,
98 const InverseLibrary & invLib);
99
123 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
124
147 virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
148
149protected:
152 static void buildTimers();
153
160 void initializeState(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
161
162 // how to invert the matrices
163 Teuchos::RCP<InverseFactory> invFactoryF_; // for \tilde{A_00}\f$
164 Teuchos::RCP<InverseFactory> invFactoryS_;
165
166 DiagonalType massInverseType_;
167
169 Teuchos::RCP<Teuchos::ParameterList> lapParams_;
170
172 Teuchos::RCP<Teuchos::ParameterList> pcdParams_;
173
174 bool schurCompOrdering_;
175
176 static Teuchos::RCP<Teuchos::Time> initTimer_;
177 static Teuchos::RCP<Teuchos::Time> invSTimer_;
178 static Teuchos::RCP<Teuchos::Time> invFTimer_;
179 static Teuchos::RCP<Teuchos::Time> opsTimer_;
180
181public:
182 // some static functions for determining strings
183
184 static std::string getPCDString() { return "PCD Operator"; }
185 static std::string getPressureLaplaceString() { return "Pressure Laplace Operator"; }
186 static std::string getPressureMassString() { return "Pressure Mass Matrix"; }
187};
188
189} // end namespace NS
190} // end namespace Teko
191
192#endif
DiagonalType
Type describing the type of diagonal to construct.
An implementation of a state object for block preconditioners.
Abstract strategy for computing inv(F) and inv(S) in the LU2x2PreconditionerFactory.
Strategy for computing implementation of the Pressure convection diffusion preconditioner.
virtual const Teko::LinearOp getTildeInvA00(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual void initializeFromParameterList(const Teuchos::ParameterList &settings, const InverseLibrary &invLib)
This function builds the internals of the state from a parameter list.
virtual const Teko::LinearOp getInvS(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual const Teko::LinearOp getHatInvA00(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual ~PCDStrategy()
Destructor (does nothing)
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
virtual bool updateRequestedParameters(const Teuchos::ParameterList &pl)
Update this object with the fields from a parameter list.
void initializeState(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
PCDStrategy()
default Constructor