MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_SmootherFactory_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 #ifndef MUELU_SMOOTHERFACTORY_DECL_HPP
47 #define MUELU_SMOOTHERFACTORY_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
51 
53 
54 #include "MueLu_Level_fwd.hpp"
58 
59 namespace MueLu {
60 
87  template <class Scalar = double,
88  class LocalOrdinal = int,
89  class GlobalOrdinal = LocalOrdinal,
92  public:
93  typedef Scalar scalar_type;
94  typedef LocalOrdinal local_ordinal_type;
95  typedef GlobalOrdinal global_ordinal_type;
96  typedef Node node_type;
97 
98  private:
99 #undef MUELU_SMOOTHERFACTORY_SHORT
100 #include "MueLu_UseShortNames.hpp"
101 
102  public:
104 
105 
144  //Note: Teuchos::null as parameter allowed (= no smoother)
145  //Note: precondition: input smoother must not be Setup()
146  SmootherFactory(RCP<SmootherPrototype> preAndPostSmootherPrototype = Teuchos::null);
147 
148  SmootherFactory(RCP<SmootherPrototype> preSmootherPrototype, RCP<SmootherPrototype> postSmootherPrototype);
149 
150  virtual ~SmootherFactory() { }
152 
154 
155 
157  void SetSmootherPrototypes(RCP<SmootherPrototype> preAndPostSmootherPrototype);
158 
160  void SetSmootherPrototypes(RCP<SmootherPrototype> preSmootherPrototype, RCP<SmootherPrototype> postSmootherPrototype);
161 
163  void GetSmootherPrototypes(RCP<SmootherPrototype>& preSmootherPrototype, RCP<SmootherPrototype>& postSmootherPrototype) const;
164 
166 
167 
169 
170  void DeclareInput(Level& currentLevel) const;
171 
173 
175 
176 
193  void Build(Level& currentLevel) const;
194 
195  void BuildSmoother(Level& currentLevel, const PreOrPost preOrPost = BOTH) const; // Build()
196 
198 
199 
201 
202 
204  std::string description() const;
205 
207  using MueLu::Describable::describe; // overloading, not hiding
208  void describe(Teuchos::FancyOStream& out, const VerbLevel verbLevel = Default) const;
209 
211 
212  private:
215 
216  void CheckPrototypes() const;
217 
219 
220  }; // class SmootherFactory
221 
222 } // namespace MueLu
223 
224 //TODO: doc: setup done twice if PostSmoother object != PreSmoother object and no adv. reused capability
225 #define MUELU_SMOOTHERFACTORY_SHORT
226 #endif // MUELU_SMOOTHERFACTORY_DECL_HPP
Generic Smoother Factory for generating the smoothers of the MG hierarchy.
SmootherFactory(RCP< SmootherPrototype > preAndPostSmootherPrototype=Teuchos::null)
Constructor.
virtual void describe(Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
RCP< SmootherPrototype > postSmootherPrototype_
RCP< const ParameterList > GetValidParameterList() const
Input.
void BuildSmoother(Level &currentLevel, const PreOrPost preOrPost=BOTH) const
void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
void Build(Level &currentLevel) const
Creates pre and post smoothers.
void SetSmootherPrototypes(RCP< SmootherPrototype > preAndPostSmootherPrototype)
Set smoother prototypes.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
std::string description() const
Return a simple one-line description of this object.
RCP< SmootherPrototype > preSmootherPrototype_
void GetSmootherPrototypes(RCP< SmootherPrototype > &preSmootherPrototype, RCP< SmootherPrototype > &postSmootherPrototype) const
Get smoother prototypes.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.