MueLu  Version of the Day
MueLu_UncoupledAggregationFactory_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 #ifndef MUELU_UNCOUPLEDAGGREGATIONFACTORY_DECL_HPP_
47 #define MUELU_UNCOUPLEDAGGREGATIONFACTORY_DECL_HPP_
48 
49 
50 #include <Xpetra_Map_fwd.hpp>
51 #include <Xpetra_Vector_fwd.hpp>
52 #include <Xpetra_VectorFactory_fwd.hpp>
53 
54 #include "MueLu_ConfigDefs.hpp"
57 
62 
67 
68 #include "MueLu_Level_fwd.hpp"
70 //#include "MueLu_Graph_fwd.hpp"
71 #include "MueLu_GraphBase.hpp"
72 #include "MueLu_Aggregates_fwd.hpp"
73 #include "MueLu_Exceptions.hpp"
74 
75 namespace MueLu {
76 
141 template <class LocalOrdinal = int,
142  class GlobalOrdinal = LocalOrdinal,
143  class Node = KokkosClassic::DefaultNode::DefaultNodeType>
145 #undef MUELU_UNCOUPLEDAGGREGATIONFACTORY_SHORT
147 
148 public:
150 
151 
154 
157 
159 
161 
163 
164 
165  // Options shared by all aggregation algorithms
166 
167  // deprecated
168  void SetOrdering(const std::string& ordering) {
169  SetParameter("aggregation: ordering", ParameterEntry(ordering));
170  }
171  // deprecated
172  void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected) {
173  SetParameter("aggregation: max selected neighbors", ParameterEntry(Teuchos::as<LocalOrdinal>(maxNeighAlreadySelected))); // revalidate
174  }
175  // deprecated
176  void SetMinNodesPerAggregate(int minNodesPerAggregate) {
177  SetParameter("aggregation: min agg size", ParameterEntry(Teuchos::as<LocalOrdinal>(minNodesPerAggregate))); // revalidate
178  }
179  // set information about 1-node aggregates (map name and generating factory)
180  void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
181  SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name))); // revalidate
182  SetFactory("OnePt aggregate map factory",mapFact);
183  }
184 
185  // deprecated
186  const std::string& GetOrdering() const {
187  const ParameterList& pL = GetParameterList();
188  return pL.get<std::string>("aggregation: ordering");
189  }
190  // deprecated
192  const ParameterList& pL = GetParameterList();
193  return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: max selected neighbors"));
194  }
195  // deprecated
197  const ParameterList& pL = GetParameterList();
198  return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: min agg size"));
199  }
200 
202 
204 
205 
206  void DeclareInput(Level &currentLevel) const;
207 
209 
211 
212 
214  void Build(Level &currentLevel) const;
215 
217 
219 
220 
222  //void Append(const RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > & alg);
223 
225  //void ClearAggregationAlgorithms() { algos_.clear(); }
227 
228 private:
229 
231  // will be filled in Build routine
232  mutable std::vector<RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > > algos_;
233 
237  mutable bool bDefinitionPhase_;
238 
239 }; // class UncoupledAggregationFactory
240 
241 }
242 
243 #define MUELU_UNCOUPLEDAGGREGATIONFACTORY_SHORT
244 #endif /* MUELU_UNCOUPLEDAGGREGATIONFACTORY_DECL_HPP_ */
std::vector< RCP< MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node > > > algos_
Append a new aggregation algorithm to list of aggregation algorithms.
T & get(const std::string &name, T def_value)
void DeclareInput(Level &currentLevel) const
Input.
Namespace for MueLu classes and methods.
void Build(Level &currentLevel) const
Build aggregates.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected)
virtual const Teuchos::ParameterList & GetParameterList() const
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
void SetOnePtMapName(const std::string name, Teuchos::RCP< const FactoryBase > mapFact)
virtual void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Configuration.
Factory for building uncoupled aggregates.
Base class for factories that use one level (currentLevel).