MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_SmootherPrototype_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_SMOOTHERPROTOTYPE_DECL_HPP
47 #define MUELU_SMOOTHERPROTOTYPE_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
51 #include "MueLu_SmootherBase.hpp"
52 #include "MueLu_Factory.hpp"
53 
54 namespace MueLu {
55 
56  class Level;
57 
70  template <class Scalar = SmootherBase<>::scalar_type,
71  class LocalOrdinal = typename SmootherBase<Scalar>::local_ordinal_type,
72  class GlobalOrdinal = typename SmootherBase<Scalar, LocalOrdinal>::global_ordinal_type,
73  class Node = typename SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
75  public SmootherBase<Scalar, LocalOrdinal, GlobalOrdinal, Node>,
76  public Factory
77  {
78  public:
82  typedef Node node_type;
83 
84  private:
85 #undef MUELU_SMOOTHERPROTOTYPE_SHORT
86 #include "MueLu_UseShortNames.hpp"
87 
88  public:
90 
91 
93 
94  virtual ~SmootherPrototype();
95 
97 
99 
100 
101  virtual void DeclareInput(Level &currentLevel) const = 0;
102 
104 
106 
107 
108  virtual void Setup(Level &) = 0;
109 
110  virtual RCP<SmootherPrototype> Copy() const = 0;
111 
113 
115 
116 
118  bool IsSetup() const;
119 
121  // Developpers: this method must be called by your Setup() method.
122  void IsSetup(bool const &ToF);
123 
125 
127 
128  virtual void CallBuild(Level & /* requestedLevel */) const {
130  }
131 
133  virtual void CallDeclareInput(Level & requestedLevel) const {
134  DeclareInput(requestedLevel);
135  }
136 
138 
139  private:
140  bool isSetup_;
141 
142  }; // class SmootherPrototype
143 
144 } // namespace MueLu
145 
146 //TODO: private copy constructor
147 //TODO: update comments
148 
149 #define MUELU_SMOOTHERPROTOTYPE_SHORT
150 #endif // MUELU_SMOOTHERPROTOTYPE_DECL_HPP
virtual void DeclareInput(Level &currentLevel) const =0
Input.
MueLu::DefaultLocalOrdinal LocalOrdinal
Base class for smoother prototypes.
virtual void Setup(Level &)=0
MueLu::DefaultNode Node
virtual RCP< SmootherPrototype > Copy() const =0
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
bool IsSetup() const
Get the state of a smoother prototype.
Base class for smoothers.
virtual void CallDeclareInput(Level &requestedLevel) const
virtual void CallBuild(Level &) const
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)