MueLu  Version of the Day
MueLu_BlockedGaussSeidelSmoother_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_BlockedGaussSeidelSmoother_decl.hpp
48  *
49  * Created on: 30.01.2012
50  * Author: tobias
51  */
52 
53 #ifndef MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_DECL_HPP_
54 #define MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_DECL_HPP_
55 
56 #include "MueLu_ConfigDefs.hpp"
57 
59 
60 #include <Xpetra_MapExtractor_fwd.hpp>
61 
63 
64 #include "MueLu_SmootherPrototype.hpp"
68 #include "MueLu_Utilities_fwd.hpp"
69 
70 namespace MueLu {
71 
113  template <class Scalar = SmootherPrototype<>::scalar_type,
114  class LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type,
118  public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
119  {
120  typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
121 
122 #undef MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_SHORT
123 #include "MueLu_UseShortNames.hpp"
124 
125  public:
126 
128 
129 
133 
135  virtual ~BlockedGaussSeidelSmoother();
137 
139 
141 
142  void DeclareInput(Level &currentLevel) const;
143 
145  //void AddFactoryManager(RCP<const FactoryManagerBase> FactManager);
146 
148  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos);
149 
150 
152 
154 
155 
161  void Setup(Level &currentLevel);
162 
169  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
171 
173 
175 
176 
178  std::string description() const;
179 
181  //using MueLu::Describable::describe; // overloading, not hiding
182  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
183 
185 
186  private:
187 
189  std::string type_;
190 
192  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
193 
195  std::vector<Teuchos::RCP<const SmootherBase> > Inverse_;
196 
198  std::vector<bool> bIsBlockedOperator_;
199 
202 
204  RCP<Matrix> A_; // < ! internal blocked operator "A" generated by AFact_
205 
208  }; // class Amesos2Smoother
209 
210 } // namespace MueLu
211 
212 #define MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_SHORT
213 
214 #endif /* MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_DECL_HPP_ */
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
Base class for smoother prototypes.
block Gauss-Seidel method for blocked matrices
Namespace for MueLu classes and methods.
std::vector< Teuchos::RCP< const SmootherBase > > Inverse_
vector of smoother/solver factories
std::vector< bool > bIsBlockedOperator_
vector storing whether sub-block is a blocked operator (needed for nested blocked smoothers using Thy...
std::string description() const
Return a simple one-line description of this object.
RCP< const MapExtractorClass > rangeMapExtractor_
range map extractor (from A_ generated by AFact)
void DeclareInput(Level &currentLevel) const
Input.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void Setup(Level &currentLevel)
Setup routine In the Setup method the Inverse_ vector is filled with the corresponding SmootherBase o...
RCP< const ParameterList > GetValidParameterList() const
Input.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
vector of factory managers
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.
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level to an FancyOStream object.
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos)
Add a factory manager.