MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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  * MueLu_SimpleSmoother_decl.hpp
48  *
49  * Created on: 19.03.2013
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_SIMPLESMOOTHER_DECL_HPP_
54 #define MUELU_SIMPLESMOOTHER_DECL_HPP_
55 
56 
57 #include "MueLu_ConfigDefs.hpp"
58 
60 
61 //Xpetra
65 #include <Xpetra_Matrix_fwd.hpp>
66 
67 //MueLu
69 #include "MueLu_SmootherPrototype.hpp"
74 #include "MueLu_Utilities_fwd.hpp"
75 
80 
81 namespace MueLu {
82 
89  template <class Scalar = SmootherPrototype<>::scalar_type,
90  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
91  class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
92  class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
93  class SimpleSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
94  {
96 
97 #undef MUELU_SIMPLESMOOTHER_SHORT
98 #include "MueLu_UseShortNames.hpp"
99 
100  public:
101 
103 
104 
107  SimpleSmoother();
108 
110  virtual ~SimpleSmoother();
112 
114 
115 
117 
118  void DeclareInput(Level &currentLevel) const;
119 
123 
127 
129  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos);
130 
132 
134 
135 
138  void Setup(Level &currentLevel);
139 
145  void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero = false) const;
147 
149 
151 
152 
154  std::string description() const;
155 
157  //using MueLu::Describable::describe; // overloading, not hiding
158  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
159 
161  size_t getNodeSmootherComplexity() const;
162 
164 
165  private:
166 
168  std::string type_;
169 
171 
173  RCP<Matrix> A_; // < ! internal blocked operator "A" generated by AFact_
174 
177 
184 
187 
189 
194  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
195 
196  }; // class Amesos2Smoother
197 
198 } // namespace MueLu
199 
200 #define MUELU_SIMPLESMOOTHER_SHORT
201 
202 #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.
std::string type_
smoother type
Teuchos::RCP< SmootherBase > schurCompSmoo_
smoother for SchurComplement equation
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
vector of factory managers
void Setup(Level &currentLevel)
Setup routine.
Teuchos::RCP< Matrix > G_
pressure gradient operator
Base class for smoother prototypes.
void DeclareInput(Level &currentLevel) const
Input.
void SetVelocityPredictionFactoryManager(RCP< FactoryManager > FactManager)
virtual ~SimpleSmoother()
Destructor.
RCP< SmootherPrototype > Copy() const
RCP< Matrix > A_
block operator
Teuchos::RCP< Matrix > F_
fluid operator
RCP< const ParameterList > GetValidParameterList() const
Input.
std::string description() const
Return a simple one-line description of this object.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Teuchos::RCP< Vector > diagFinv_
matrices
Teuchos::RCP< Matrix > Z_
pressure stabilization term or null block
Teuchos::RCP< Matrix > D_
divergence operator
void Apply(MultiVector &X, MultiVector const &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
RCP< const FactoryBase > AFact_
A Factory.
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
SIMPLE smoother for 2x2 block matrices.