MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_BraessSarazinSmoother_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_BraessSarazinSmoother_decl.hpp
48  *
49  * Created on: Apr 16, 2012
50  * Author: wiesner
51  */
52 
53 #ifndef MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_
54 #define MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_
55 #include "MueLu_ConfigDefs.hpp"
56 
58 
59 //Xpetra
63 #include <Xpetra_Matrix_fwd.hpp>
64 
65 //MueLu
67 #include "MueLu_SmootherPrototype.hpp"
71 #include "MueLu_Utilities_fwd.hpp"
72 
77 
78 namespace MueLu {
79 
86  template <class Scalar = SmootherPrototype<>::scalar_type,
87  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
88  class GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type,
89  class Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
90  class BraessSarazinSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
91  {
93 
94 #undef MUELU_BRAESSSARAZINSMOOTHER_SHORT
95 #include "MueLu_UseShortNames.hpp"
96 
97  public:
98 
100 
101 
105 
107  virtual ~BraessSarazinSmoother();
109 
111 
112 
114 
115  void DeclareInput(Level &currentLevel) const;
116 
118  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos = 0);
119 
121 
123 
124 
127  void Setup(Level &currentLevel);
128 
134  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
136 
138 
140 
141 
143  std::string description() const;
144 
146  //using MueLu::Describable::describe; // overloading, not hiding
147  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
148 
150  size_t getNodeSmootherComplexity() const;
151 
153 
154  private:
155 
157  std::string type_;
158 
161 
163  RCP<Matrix> A_; // < ! internal blocked operator "A" generated by AFact_
164 
167 
175 
177 
178  }; // class Amesos2Smoother
179 
180 } // namespace MueLu
181 
182 #define MUELU_BRAESSSARAZINSMOOTHER_SHORT
183 #endif /* MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_ */
BraessSarazin smoother for 2x2 block matrices.
RCP< Vector > D_
Inverse to approximation to block (0,0). Here, D_ = omega*inv(diag(A(0,0)))
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
Base class for smoother prototypes.
RCP< SmootherPrototype > Copy() const
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
RCP< Matrix > A01_
Block (0,1) [typically, pressure gradient operator].
void DeclareInput(Level &currentLevel) const
Input.
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< Matrix > A11_
Block (1,1) [typically, pressure stabilization term or null block].
RCP< const ParameterList > GetValidParameterList() const
Input.
RCP< const FactoryBase > AFact_
A Factory.
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos=0)
Add a factory manager for BraessSarazin internal SchurComplement handling.
void Setup(Level &currentLevel)
Setup routine.
RCP< Matrix > A10_
Block (1,0) [typically, divergence operator].
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
std::string description() const
Return a simple one-line description of this object.
Teuchos::RCP< SmootherBase > smoo_
Smoother for SchurComplement equation.
RCP< const FactoryManagerBase > FactManager_
Factory manager for creating the Schur Complement.