MueLu  Version of the Day
MueLu_UzawaSmoother_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 //
3 // ***********************************************************************
4 //
5 // MueLu: A package for multigrid based preconditioning
6 // Copyright 2012 Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact
39 // Jonathan Hu (jhu@sandia.gov)
40 // Andrey Prokopenko (aprokop@sandia.gov)
41 // Ray Tuminaro (rstumin@sandia.gov)
42 //
43 // ***********************************************************************
44 //
45 // @HEADER
46 
47 #ifndef MUELU_UZAWASMOOTHER_DECL_HPP_
48 #define MUELU_UZAWASMOOTHER_DECL_HPP_
49 
50 
51 #include "MueLu_ConfigDefs.hpp"
52 
53 #include <Teuchos_ParameterList.hpp>
54 
55 //Xpetra
56 #include <Xpetra_MapExtractor_fwd.hpp>
57 #include <Xpetra_MultiVectorFactory_fwd.hpp>
58 #include <Xpetra_CrsMatrixWrap_fwd.hpp>
59 #include <Xpetra_Matrix_fwd.hpp>
60 
61 //MueLu
63 #include "MueLu_SmootherPrototype.hpp"
68 #include "MueLu_Utilities_fwd.hpp"
69 
74 
75 namespace MueLu {
76 
83  template <class Scalar = SmootherPrototype<>::scalar_type,
87  class UzawaSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
88  {
89  typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
90 
91 #undef MUELU_UZAWASMOOTHER_SHORT
92 #include "MueLu_UseShortNames.hpp"
93 
94  public:
95 
97 
98 
99  RCP<const ParameterList> GetValidParameterList() const;
100 
101  void DeclareInput(Level &currentLevel) const;
102 
107  void SetVelocityPredictionFactoryManager(RCP<FactoryManager> FactManager);
108 
113  void SetSchurCompFactoryManager(RCP<FactoryManager> FactManager);
114 
119  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos);
120 
122 
124 
125 
128  void Setup(Level &currentLevel);
129 
135  void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero = false) const;
137 
138  RCP<SmootherPrototype> Copy() const;
139 
141 
142 
144  std::string description() const;
145 
147  //using MueLu::Describable::describe; // overloading, not hiding
148  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
149 
151  size_t getNodeSmootherComplexity() const;
152 
154 
155  private:
156 
158  std::string type_ = "Uzawa";
159 
160  RCP<const FactoryBase> AFact_;
161 
163  RCP<Matrix> A_ = Teuchos::null; //<! internal blocked operator "A" generated by AFact_
164 
165  RCP<const MapExtractorClass> rangeMapExtractor_;
166  RCP<const MapExtractorClass> domainMapExtractor_;
167 
169  Teuchos::RCP<Vector> diagFinv_;
170  Teuchos::RCP<Matrix> F_;
171  Teuchos::RCP<Matrix> G_;
172  Teuchos::RCP<Matrix> D_;
173  Teuchos::RCP<Matrix> Z_;
174 
175  Teuchos::RCP<SmootherBase> velPredictSmoo_;
176  Teuchos::RCP<SmootherBase> schurCompSmoo_;
177 
184  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
185 
186  }; // class UzawaSmoother
187 
188 } // namespace MueLu
189 
190 #define MUELU_UZAWASMOOTHER_SHORT
191 
192 #endif /* MUELU_UZAWASMOOTHER_DECL_HPP_ */
std::string description() const
Return a simple one-line description of this object.
void Setup(Level &currentLevel)
Setup routine.
MueLu::DefaultLocalOrdinal LocalOrdinal
RCP< const FactoryBase > AFact_
A Factory.
Base class for smoother prototypes.
Teuchos::RCP< Matrix > D_
divergence operator
void DeclareInput(Level &currentLevel) const
Input.
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
Namespace for MueLu classes and methods.
MueLu::DefaultNode Node
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
void SetVelocityPredictionFactoryManager(RCP< FactoryManager > FactManager)
Set factory manager for internal velocity prediction.
RCP< const ParameterList > GetValidParameterList() const
Input.
Teuchos::RCP< Matrix > F_
fluid operator
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Block triangle Uzawa smoother for 2x2 block matrices.
RCP< Matrix > A_
block operator
Teuchos::RCP< Matrix > Z_
pressure stabilization term or null block
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
Vector of internal factory managers.
Teuchos::RCP< Vector > diagFinv_
matrices
Teuchos::RCP< SmootherBase > schurCompSmoo_
smoother for SchurComplement equation
RCP< SmootherPrototype > Copy() const
void SetSchurCompFactoryManager(RCP< FactoryManager > FactManager)
Set factory manager for internal SchurComplement handling.
Teuchos::RCP< Matrix > G_
pressure gradient operator
Teuchos::RCP< SmootherBase > velPredictSmoo_
smoother for velocity prediction
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
std::string type_
smoother type
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos)
Add a factory manager at a specific position.
void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass