MueLu  Version of the Day
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 #ifndef MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_
48 #define MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_
49 #include "MueLu_ConfigDefs.hpp"
50 
51 #include <Teuchos_ParameterList.hpp>
52 
53 //Xpetra
54 #include <Xpetra_MapExtractor_fwd.hpp>
55 #include <Xpetra_MultiVectorFactory_fwd.hpp>
56 #include <Xpetra_CrsMatrixWrap_fwd.hpp>
57 #include <Xpetra_Matrix_fwd.hpp>
58 
59 //MueLu
61 #include "MueLu_SmootherPrototype.hpp"
65 #include "MueLu_Utilities_fwd.hpp"
66 
71 
72 namespace MueLu {
73 
80  template <class Scalar = SmootherPrototype<>::scalar_type,
84  class BraessSarazinSmoother : public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
85  {
86 #undef MUELU_BRAESSSARAZINSMOOTHER_SHORT
87 #include "MueLu_UseShortNames.hpp"
88 
89  public:
90 
92 
93 
94  RCP<const ParameterList> GetValidParameterList() const;
95 
96  void DeclareInput(Level &currentLevel) const;
97 
99  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos = 0);
100 
102 
104 
105 
114  void Setup(Level &currentLevel);
115 
121  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
123 
124  RCP<SmootherPrototype> Copy() const;
125 
127 
128 
130  std::string description() const;
131 
137  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
138 
140  size_t getNodeSmootherComplexity() const;
141 
143 
144  private:
145 
147  std::string type_ = "Braess Sarazin";
148 
149  RCP<const FactoryBase> AFact_;
150  RCP<const FactoryManagerBase> FactManager_;
151 
153  RCP<Matrix> A_ = Teuchos::null; // < ! internal blocked operator "A" generated by AFact_
154 
155  RCP<const MapExtractor> rangeMapExtractor_;
156  RCP<const MapExtractor> domainMapExtractor_;
157 
159  RCP<Matrix> A00_;
160  RCP<Matrix> A01_;
161  RCP<Matrix> A10_;
162  RCP<Matrix> A11_;
163  RCP<Matrix> S_;
164  RCP<Vector> D_;
165 
166  Teuchos::RCP<SmootherBase> smoo_;
167 
168  }; // class Amesos2Smoother
169 
170 } // namespace MueLu
171 
172 #define MUELU_BRAESSSARAZINSMOOTHER_SHORT
173 #endif /* MUELU_BRAESSSARAZINSMOOTHER_DECL_HPP_ */
RCP< SmootherPrototype > Copy() const
MueLu::DefaultLocalOrdinal LocalOrdinal
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 MapExtractor > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
Base class for smoother prototypes.
Namespace for MueLu classes and methods.
MueLu::DefaultNode Node
std::string description() const
Return a simple one-line description of this object.
RCP< Matrix > A01_
Block (0,1) [typically, pressure gradient operator].
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void Apply(MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const
Apply the Braess Sarazin smoother.
RCP< Matrix > A11_
Block (1,1) [typically, pressure stabilization term or null block].
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
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 DeclareInput(Level &currentLevel) const
Input.
void Setup(Level &currentLevel)
Setup routine.
RCP< Matrix > A10_
Block (1,0) [typically, divergence operator].
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Teuchos::RCP< SmootherBase > smoo_
Smoother for SchurComplement equation.
RCP< const ParameterList > GetValidParameterList() const
Input.
RCP< const MapExtractor > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
RCP< const FactoryManagerBase > FactManager_
Factory manager for creating the Schur Complement.