MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_ProjectorSmoother_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_PROJECTORSMOOTHER_DECL_HPP
47 #define MUELU_PROJECTORSMOOTHER_DECL_HPP
48 
49 #include <Xpetra_Matrix_fwd.hpp>
50 #include <Xpetra_MultiVector_fwd.hpp>
51 
52 #include "MueLu_ConfigDefs.hpp"
53 
54 #include "MueLu_SmootherPrototype.hpp"
56 #include "MueLu_Utilities_fwd.hpp"
57 
58 namespace MueLu {
59 
76  template <class Scalar = SmootherPrototype<>::scalar_type,
77  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
78  class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
79  class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
80  class ProjectorSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
81  {
82 #undef MUELU_PROJECTORSMOOTHER_SHORT
83 #include "MueLu_UseShortNames.hpp"
84 
85  public:
86 
88 
89 
92 
94  virtual ~ProjectorSmoother();
96 
98 
99 
100  void DeclareInput(Level &currentLevel) const;
101 
103 
105 
106 
108  void Setup(Level &currentLevel);
109 
116  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
118 
120 
122 
123 
125  std::string description() const;
126 
128  //using MueLu::Describable::describe; // overloading, not hiding
129  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
130 
132  size_t getNodeSmootherComplexity() const {return coarseSolver_->getNodeSmootherComplexity();}
133 
134 
136 
137  private:
140 
141  }; // class ProjectorSmoother
142 
143 } // namespace MueLu
144 
145 #define MUELU_PROJECTORSMOOTHER_SHORT
146 #endif // MUELU_PROJECTORSMOOTHER_DECL_HPP
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
std::string description() const
Return a simple one-line description of this object.
MueLu::DefaultLocalOrdinal LocalOrdinal
Base class for smoother prototypes.
RCP< SmootherPrototype > coarseSolver_
MueLu::DefaultNode Node
virtual ~ProjectorSmoother()
Destructor.
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< SmootherPrototype > Copy() const
void Setup(Level &currentLevel)
Set up the direct solver.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
This class enables the elimination of the nullspace component of the solution through the use of proj...
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the direct solver. Solves the linear system AX=B using the constructed solver.
ProjectorSmoother(RCP< SmootherPrototype > coarseSolver)
Constructor.
void DeclareInput(Level &currentLevel) const
Input.