MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_CoupledAggregationFactory_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_COUPLEDAGGREGATIONFACTORY_DECL_HPP
47 #define MUELU_COUPLEDAGGREGATIONFACTORY_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
52 
53 #include "MueLu_LocalAggregationAlgorithm.hpp"
54 #include "MueLu_LeftoverAggregationAlgorithm.hpp"
55 #include "MueLu_Level_fwd.hpp"
57 #include "MueLu_Exceptions.hpp"
58 
59 namespace MueLu {
60 
69  /* Factory input:
70  - a graph ("Graph") generated by GraphFact_
71 
72  Factory output:
73  - aggregates ("Aggegates")
74 
75  Factory options:
76  -
77  -
78  -
79  */
80 
81  template <class LocalOrdinal = int,
82  class GlobalOrdinal = LocalOrdinal,
85 #undef MUELU_COUPLEDAGGREGATIONFACTORY_SHORT
87 
88  public:
90 
91 
94 
97 
99 
101 
102 
103  // Options algo1
104  void SetOrdering(const std::string& ordering) { algo1_.SetOrdering(ordering); }
105  void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected) { algo1_.SetMaxNeighAlreadySelected(maxNeighAlreadySelected); }
106  const std::string& GetOrdering() const { return algo1_.GetOrdering(); }
108 
109  // Options algo2
110  void SetPhase3AggCreation(double phase3AggCreation) { algo2_.SetPhase3AggCreation(phase3AggCreation); }
111  double GetPhase3AggCreation() const { return algo2_.GetPhase3AggCreation(); }
112 
113  // Options shared algo1 and algo2
114  void SetMinNodesPerAggregate(int minNodesPerAggregate) { algo1_.SetMinNodesPerAggregate(minNodesPerAggregate); algo2_.SetMinNodesPerAggregate(minNodesPerAggregate); }
115  int GetMinNodesPerAggregate() const { return algo1_.GetMinNodesPerAggregate(); //TEUCHOS_TEST_FOR_EXCEPTION(algo2_.GetMinNodesPerAggregate() != algo1_.GetMinNodesPerAggregate(), Exceptions::RuntimeError, "");
116  }
117 
119 
121 
122 
123  void DeclareInput(Level &currentLevel) const;
124 
126 
128 
129 
131  void Build(Level &currentLevel) const;
132 
134 
135  private:
136 
140 
141  }; // class CoupledAggregationFactory
142 
143 } //namespace MueLu
144 
145 //TODO: can be more generic:
146 // - allow to choose algo
147 // - base class for algorithm and options forward to algorithm as parameter list
148 
149 #define MUELU_COUPLEDAGGREGATIONFACTORY_SHORT
150 #endif // MUELU_COUPLEDAGGREGATIONFACTORY_DECL_HPP
void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected)
Algorithm for coarsening a graph with uncoupled aggregation.
LocalAggregationAlgorithm algo1_
Algorithms.
Factory for coarsening a graph with uncoupled aggregation.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void Build(Level &currentLevel) const
Build aggregates.
Base class for factories that use one level (currentLevel).
void DeclareInput(Level &currentLevel) const
Input.
void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected)