MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_LocalAggregationAlgorithm_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_LOCALAGGREGATIONALGORITHM_DECL_HPP
47 #define MUELU_LOCALAGGREGATIONALGORITHM_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #include "MueLu_BaseClass.hpp"
52 
53 #include "MueLu_Aggregates_fwd.hpp"
55 #include "MueLu_GraphBase.hpp"
56 #include "MueLu_Utilities_fwd.hpp"
57 
58 namespace MueLu {
59 
60  /* ************************************************************************* */
61  /* definition of the structure from ML for holding aggregate information */
62  /* ------------------------------------------------------------------------- */
63  typedef struct MueLu_SuperNode_Struct
64  {
65  int length;
66  int maxLength;
67  int index;
71 
72  /* In the algorithm, aggStat[]=CA_READY/CA_NOTSEL/CA_SELECTED indicates whether a node has been aggregated. */
73  enum CANodeState {
74  CA_READY = -11, /* indicates that a node is available to be */
75  /* selected as a root node of an aggregate */
76 
77  CA_NOTSEL = -12, /* indicates that a node has been rejected */
78  /* as a root node. This could perhaps be */
79  /* because if this node had been selected a */
80  /* small aggregate would have resulted. */
81 
82  CA_SELECTED = -13 /* indicates that a node has been assigned */
83  /* to an aggregate. */
84  };
85 
95  template <class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
97 #undef MUELU_LOCALAGGREGATIONALGORITHM_SHORT
99 
100  typedef GO global_size_t; //TODO
101  typedef LO my_size_t; //TODO
102 
103  public:
105 
106 
109 
112 
114 
116 
117 
118  void SetOrdering(const std::string& ordering) { ordering_ = ordering; }
119  void SetMinNodesPerAggregate(int minNodesPerAggregate) { minNodesPerAggregate_ = minNodesPerAggregate; }
120  void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected) { maxNeighAlreadySelected_ = maxNeighAlreadySelected; }
121 
122  const std::string& GetOrdering() const { return ordering_; }
125 
127 
129 
130 
132  void CoarsenUncoupled(GraphBase const & graph, Aggregates & aggregates) const; // CoarsenUncoupled
133 
134  private:
136  std::string ordering_;
140 
142 
147  void RandomReorder(Teuchos::ArrayRCP<LO> list) const;
148 
150  int RandomOrdinal(int min, int max) const;
151 
153 
154  }; //class LocalAggregationFactory
155 
156 } //namespace MueLu
157 
158 #define MUELU_LOCALAGGREGATIONALGORITHM_SHORT
159 #endif // MUELU_LOCALAGGREGATIONALGORITHM_DECL_HPP
void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected)
Container class for aggregation information.
void CoarsenUncoupled(GraphBase const &graph, Aggregates &aggregates) const
Local aggregation.
GlobalOrdinal GO
Algorithm for coarsening a graph with uncoupled aggregation.
LocalOrdinal LO
void RandomReorder(Teuchos::ArrayRCP< LO > list) const
Utility to take a list of integers and reorder them randomly (by using a local permutation).
std::string ordering_
Aggregation options (TODO: Teuchos::ParameterList?)
int RandomOrdinal(int min, int max) const
Generate a random number in the range [min, max].
MueLu representation of a graph.
Base class for MueLu classes.
struct MueLu::MueLu_SuperNode_Struct MueLu_SuperNode