MueLu  Version of the Day
MueLu_BlockedPFactory_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_BlockedPFactory_decl.hpp
48  *
49  * Created on: 02.01.2012
50  * Author: tobias
51  */
52 
53 #ifndef MUELU_BLOCKEDPFACTORY_DECL_HPP_
54 #define MUELU_BLOCKEDPFACTORY_DECL_HPP_
55 
56 #include <Xpetra_MapExtractorFactory_fwd.hpp>
57 #include <Xpetra_Matrix_fwd.hpp>
58 
59 #include "MueLu_ConfigDefs.hpp"
60 #include "MueLu_PFactory.hpp"
64 #include "MueLu_Utilities_fwd.hpp"
65 
66 namespace MueLu {
67 
68 
126  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
127  class BlockedPFactory : public PFactory {
128 #undef MUELU_BLOCKEDPFACTORY_SHORT
129 #include "MueLu_UseShortNames.hpp"
130 
131  public:
132 
133 
135 
136 
140  BlockedPFactory(/*RCP<FactoryBase> AFact = Teuchos::null*/): diagonalView_("current") { }
141 
143  virtual ~BlockedPFactory() { }
144 
145  RCP<const ParameterList> GetValidParameterList() const;
146 
148 
150 
151 
153  void SetDiagonalView(std::string const& diagView) { diagonalView_ = diagView; }
154 
156  void AddFactoryManager(RCP<const FactoryManagerBase> FactManager) { FactManager_.push_back(FactManager); }
157 
159 
161 
162 
164  std::string GetDiagonalView() { return diagonalView_; }
165 
167 
169 
170 
171  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
173 
175 
176 
182  void Build(Level& fineLevel, Level &coarseLevel) const;
183 
184  void BuildP(Level &fineLevel, Level &coarseLevel) const;
185 
187 
188  private:
189  bool areGidsUnique(const std::vector<GO>& X) const {
190  std::set<GO> Y(X.begin(), X.end());
191  return X.size() == Y.size();
192  }
193 
195  std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
196  //RCP<FactoryBase> AFact_; //! A Factory
197 
199  std::string diagonalView_;
200 
201  };
202 
203 } //namespace MueLu
204 
205 #define MUELU_BLOCKEDPFACTORY_SHORT
206 #endif /* MUELU_BLOCKEDPFACTORY_DECL_HPP_ */
bool areGidsUnique(const std::vector< GO > &X) const
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
std::string GetDiagonalView()
Returns current view of diagonal.
Factory for building blocked, segregated prolongation operators.
Namespace for MueLu classes and methods.
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
Input factories.
std::string diagonalView_
Factory parameters.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual ~BlockedPFactory()
Destructor.
BlockedPFactory()
Constructor. User can supply a factory for generating the tentative prolongator.
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
Factory that provides an interface for a concrete implementation of a prolongation operator...
void SetDiagonalView(std::string const &diagView)
Change view of diagonal.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager)
Add a factory manager.