MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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>
53 
54 #include "MueLu_ConfigDefs.hpp"
57 
63 
68 
69 #include "MueLu_Level_fwd.hpp"
71 //#include "MueLu_Graph_fwd.hpp"
72 #include "MueLu_GraphBase.hpp"
73 #include "MueLu_Aggregates_fwd.hpp"
74 #include "MueLu_Exceptions.hpp"
75 
76 namespace MueLu {
77 
142 template <class LocalOrdinal = int,
143  class GlobalOrdinal = LocalOrdinal,
146 #undef MUELU_UNCOUPLEDAGGREGATIONFACTORY_SHORT
148 
149 public:
151 
152 
155 
158 
160 
162 
164 
165 
166  // Options shared by all aggregation algorithms
167 
168  // deprecated
169  void SetOrdering(const std::string& ordering) {
170  SetParameter("aggregation: ordering", ParameterEntry(ordering));
171  }
172  // deprecated
173  void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected) {
174  SetParameter("aggregation: max selected neighbors", ParameterEntry(Teuchos::as<LocalOrdinal>(maxNeighAlreadySelected))); // revalidate
175  }
176  // deprecated
177  void SetMinNodesPerAggregate(int minNodesPerAggregate) {
178  SetParameter("aggregation: min agg size", ParameterEntry(Teuchos::as<LocalOrdinal>(minNodesPerAggregate))); // revalidate
179  }
180  // set information about 1-node aggregates (map name and generating factory)
181  void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
182  SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name))); // revalidate
183  SetFactory("OnePt aggregate map factory",mapFact);
184  }
185 
186  // deprecated
187  const std::string& GetOrdering() const {
188  const ParameterList& pL = GetParameterList();
189  return pL.get<std::string>("aggregation: ordering");
190  }
191  // deprecated
193  const ParameterList& pL = GetParameterList();
194  return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: max selected neighbors"));
195  }
196  // deprecated
198  const ParameterList& pL = GetParameterList();
199  return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: min agg size"));
200  }
201 
203 
205 
206 
207  void DeclareInput(Level &currentLevel) const;
208 
210 
212 
213 
215  void Build(Level &currentLevel) const;
216 
218 
220 
221 
223  //void Append(const RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > & alg);
224 
226  //void ClearAggregationAlgorithms() { algos_.clear(); }
228 
229 private:
230 
232  // will be filled in Build routine
233  mutable std::vector<RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > > algos_;
234 
238  mutable bool bDefinitionPhase_;
239 
240 }; // class UncoupledAggregationFactory
241 
242 }
243 
244 #define MUELU_UNCOUPLEDAGGREGATIONFACTORY_SHORT
245 #endif /* MUELU_UNCOUPLEDAGGREGATIONFACTORY_DECL_HPP_ */
std::vector< RCP< MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node > > > algos_
Append a new aggregation algorithm to list of aggregation algorithms.
virtual const Teuchos::ParameterList & GetParameterList() const
T & get(const std::string &name, T def_value)
void DeclareInput(Level &currentLevel) const
Input.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected)
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
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)
void Build(Level &currentLevel) const
Build aggregates.
virtual void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)=0
Configuration.
Factory for building uncoupled aggregates.
Base class for factories that use one level (currentLevel).