MueLu  Version of the Day
MueLu_SimpleSmoother_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_SIMPLESMOOTHER_DECL_HPP_
48 #define MUELU_SIMPLESMOOTHER_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 SimpleSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
88  {
89  typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
90 
91 #undef MUELU_SIMPLESMOOTHER_SHORT
92 #include "MueLu_UseShortNames.hpp"
93 
94  public:
95 
97 
98 
100  SimpleSmoother();
101 
103  virtual ~SimpleSmoother();
104 
106 
108 
109 
110  RCP<const ParameterList> GetValidParameterList() const;
111 
112  void DeclareInput(Level &currentLevel) const;
113 
116  void SetVelocityPredictionFactoryManager(RCP<FactoryManager> FactManager);
117 
120  void SetSchurCompFactoryManager(RCP<FactoryManager> FactManager);
121 
123  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos);
124 
126 
128 
129 
139  void Setup(Level &currentLevel);
140 
146  void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero = false) const;
148 
149  RCP<SmootherPrototype> Copy() const;
150 
152 
153 
155  std::string description() const;
156 
158  //using MueLu::Describable::describe; // overloading, not hiding
159  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
160 
162  size_t getNodeSmootherComplexity() const;
163 
165 
166  private:
167 
169  std::string type_;
170 
172  RCP<const FactoryBase> AFact_;
173 
175  RCP<Matrix> A_;
176 
178  RCP<const MapExtractorClass> rangeMapExtractor_;
179 
181  RCP<const MapExtractorClass> domainMapExtractor_;
182 
185 
187  Teuchos::RCP<Vector> diagFinv_;
188 
190  Teuchos::RCP<Matrix> F_;
191 
193  Teuchos::RCP<Matrix> G_;
194 
196  Teuchos::RCP<Matrix> D_;
197 
199  Teuchos::RCP<Matrix> Z_;
200 
202 
204  Teuchos::RCP<SmootherBase> velPredictSmoo_;
205 
207  Teuchos::RCP<SmootherBase> schurCompSmoo_;
208 
214  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
215 
216  };
217 
218 } // namespace MueLu
219 
220 #define MUELU_SIMPLESMOOTHER_SHORT
221 
222 #endif /* MUELU_SIMPLESMOOTHER_DECL_HPP_ */
Teuchos::RCP< SmootherBase > velPredictSmoo_
Smoother for velocity prediction.
void SetSchurCompFactoryManager(RCP< FactoryManager > FactManager)
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos)
Add a factory manager at a specific position.
MueLu::DefaultLocalOrdinal LocalOrdinal
std::string type_
smoother type
Teuchos::RCP< SmootherBase > schurCompSmoo_
Smoother for SchurComplement equation.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
Vector of internal factory managers.
void Setup(Level &currentLevel)
Setup routine.
Teuchos::RCP< Matrix > G_
Pressure gradient operator.
Base class for smoother prototypes.
Namespace for MueLu classes and methods.
void SetVelocityPredictionFactoryManager(RCP< FactoryManager > FactManager)
virtual ~SimpleSmoother()
Destructor.
MueLu::DefaultNode Node
RCP< SmootherPrototype > Copy() const
RCP< Matrix > A_
Internal blocked operator "A" generated by AFact_.
Teuchos::RCP< Matrix > F_
Fluid operator.
void DeclareInput(Level &currentLevel) const
Input.
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Teuchos::RCP< Vector > diagFinv_
Inverse diagonal of fluid operator (vector).
Teuchos::RCP< Matrix > Z_
Pressure stabilization term or null block.
Teuchos::RCP< Matrix > D_
Divergence operator.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
RCP< const MapExtractorClass > domainMapExtractor_
Domain map extractor (from A_ generated by AFact)
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
RCP< const FactoryBase > AFact_
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
RCP< const ParameterList > GetValidParameterList() const
Input.
RCP< const MapExtractorClass > rangeMapExtractor_
Range map extractor (from A_ generated by AFact)
std::string description() const
Return a simple one-line description of this object.
SIMPLE smoother for 2x2 block matrices.
void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.