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 #ifndef MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_DECL_HPP_
48 #define MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_DECL_HPP_
49 
50 #include "MueLu_ConfigDefs.hpp"
51 
52 #include <Teuchos_ParameterList.hpp>
53 
54 #include <Xpetra_Matrix_fwd.hpp>
55 #include <Xpetra_BlockedCrsMatrix_fwd.hpp>
56 #include <Xpetra_ReorderedBlockedCrsMatrix_fwd.hpp>
57 #include <Xpetra_MultiVectorFactory_fwd.hpp>
58 #include <Xpetra_MapExtractor_fwd.hpp>
59 
61 
62 #include "MueLu_SmootherPrototype.hpp"
66 #include "MueLu_Utilities_fwd.hpp"
67 
68 namespace MueLu {
69 
111  template <class Scalar = SmootherPrototype<>::scalar_type,
116  public SmootherPrototype<Scalar,LocalOrdinal,GlobalOrdinal,Node>
117  {
118  typedef Xpetra::MapExtractor<Scalar, LocalOrdinal, GlobalOrdinal, Node> MapExtractorClass;
119 
120 #undef MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_SHORT
121 #include "MueLu_UseShortNames.hpp"
122 
123  public:
124 
126 
127 
131 
133  virtual ~BlockedGaussSeidelSmoother();
135 
137 
138  RCP<const ParameterList> GetValidParameterList() const;
139 
140  void DeclareInput(Level &currentLevel) const;
141 
143  //void AddFactoryManager(RCP<const FactoryManagerBase> FactManager);
144 
146  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager, int pos);
147 
148 
150 
152 
153 
159  void Setup(Level &currentLevel);
160 
167  void Apply(MultiVector& X, const MultiVector& B, bool InitialGuessIsZero = false) const;
169 
170  RCP<SmootherPrototype> Copy() const;
171 
173 
174 
176  std::string description() const;
177 
183  void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel = Default) const;
184 
186  size_t getNodeSmootherComplexity() const;
187 
189 
190  private:
191 
193  std::string type_;
194 
196  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
197 
199  std::vector<Teuchos::RCP<const SmootherBase> > Inverse_;
200 
202  std::vector<bool> bIsBlockedOperator_;
203 
205  RCP<FactoryBase> AFact_;
206 
208  RCP<Matrix> A_;
209 
211  RCP<const MapExtractorClass> rangeMapExtractor_;
212 
214  RCP<const MapExtractorClass> domainMapExtractor_;
215  }; // class Amesos2Smoother
216 
217 } // namespace MueLu
218 
219 #define MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_SHORT
220 
221 #endif /* MUELU_BLOCKEDGAUSSSEIDELSMOOTHER_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
RCP< const MapExtractorClass > domainMapExtractor_
domain map extractor (from A_ generated by AFact)
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > MapExtractorClass
size_t getNodeSmootherComplexity() const
Get a rough estimate of cost per iteration.
Base class for smoother prototypes.
block Gauss-Seidel method for blocked matrices
Namespace for MueLu classes and methods.
MueLu::DefaultNode Node
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.
MueLu::DefaultGlobalOrdinal GlobalOrdinal
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.
RCP< Matrix > A_
internal blocked operator "A" generated by AFact_
void print(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the object with some verbosity level verbLevel to an FancyOStream object out.
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager, int pos)
Add a factory manager.