MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_InterfaceAggregationAlgorithm_def.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_OnePtAggregationAlgorithm_def.hpp
48  *
49  * Created on: Sep 18, 2012
50  * Author: Tobias Wiesner
51  */
52 
53 #ifndef MUELU_INTERFACEAGGREGATIONALGORITHM_DEF_HPP_
54 #define MUELU_INTERFACEAGGREGATIONALGORITHM_DEF_HPP_
55 
56 #include <Teuchos_Comm.hpp>
57 #include <Teuchos_CommHelpers.hpp>
58 
59 #include <Xpetra_Vector.hpp>
60 
61 #include "MueLu_InterfaceAggregationAlgorithm.hpp"
62 
63 //#include "MueLu_Graph.hpp"
64 #include "MueLu_GraphBase.hpp"
65 #include "MueLu_Aggregates.hpp"
66 #include "MueLu_Exceptions.hpp"
67 #include "MueLu_Monitor.hpp"
68 
69 namespace MueLu {
70 
71 template <class LocalOrdinal, class GlobalOrdinal, class Node>
73 {
74 }
75 
76 template <class LocalOrdinal, class GlobalOrdinal, class Node>
77 void InterfaceAggregationAlgorithm<LocalOrdinal, GlobalOrdinal, Node>::BuildAggregates(Teuchos::ParameterList const & /* params */, GraphBase const & graph, Aggregates & aggregates, std::vector<unsigned>& aggStat, LO& numNonAggregatedNodes) const {
78  Monitor m(*this, "BuildAggregates");
79 
80  const LocalOrdinal nRows = graph.GetNodeNumVertices();
81  const int myRank = graph.GetComm()->getRank();
82 
83  // vertex ids for output
84  Teuchos::ArrayRCP<LocalOrdinal> vertex2AggId = aggregates.GetVertex2AggId()->getDataNonConst(0);
85  Teuchos::ArrayRCP<LocalOrdinal> procWinner = aggregates.GetProcWinner()->getDataNonConst(0);
86 
87  // some internal variables
88  LocalOrdinal numLocalAggregates = aggregates.GetNumAggregates(); // number of local aggregates on current proc
89 
90  // main loop over all local rows of graph(A)
91  for(int iNode1 = 0; iNode1 < nRows; ++iNode1) {
92 
93  if (aggStat[iNode1] == INTERFACE) {
94 
95  aggregates.SetIsRoot(iNode1); // mark iNode1 as root node for new aggregate 'agg'
96  int aggIndex = numLocalAggregates;
97  std::vector<int> aggList;
98  aggList.push_back(iNode1);
99  ArrayView<const LO> neighOfINode = graph.getNeighborVertices(iNode1);
100 
101  for(int j = 0; j < neighOfINode.size(); ++j) {
102  LO neigh = neighOfINode[j];
103  if(neigh != iNode1 && graph.isLocalNeighborVertex(neigh)) {
104  if(aggStat[neigh] != AGGREGATED && aggStat[neigh] != INTERFACE &&
105  aggStat[neigh] != IGNORED) {
106  aggList.push_back(neigh);
107  }
108  }
109  }
110 
111  for (size_t k = 0; k < aggList.size(); k++) {
112  aggStat[aggList[k]] = AGGREGATED;
113  vertex2AggId[aggList[k]] = aggIndex;
114  procWinner[aggList[k]] = myRank;
115  }
116  ++numLocalAggregates;
117  numNonAggregatedNodes -= aggList.size();
118  }
119 
120  } // end for
121 
122  // update aggregate object
123  aggregates.SetNumAggregates(numLocalAggregates);
124 }
125 
126 } // end namespace
127 
128 
129 #endif /* MUELU_INTERFACEAGGREGATIONALGORITHM_DEF_HPP_ */
const RCP< LOVector > & GetProcWinner() const
Returns constant vector that maps local node IDs to owning processor IDs.
Container class for aggregation information.
virtual size_t GetNodeNumVertices() const =0
Return number of vertices owned by the calling node.
size_type size() const
LocalOrdinal LO
size_type size() const
void SetIsRoot(LO i, bool value=true)
Set root node information.
LO GetNumAggregates() const
returns the number of aggregates of the current processor. Note: could/should be renamed to GetNumLoc...
void BuildAggregates(Teuchos::ParameterList const &params, GraphBase const &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const
Local aggregation.
virtual bool isLocalNeighborVertex(LocalOrdinal v) const =0
Return true if vertex with local id &#39;v&#39; is on current process.
const RCP< LOMultiVector > & GetVertex2AggId() const
Returns constant vector that maps local node IDs to local aggregates IDs.
virtual const RCP< const Teuchos::Comm< int > > GetComm() const =0
MueLu representation of a graph.
Timer to be used in non-factories.
InterfaceAggregationAlgorithm(RCP< const FactoryBase > const &graphFact=Teuchos::null)
Constructor.
virtual Teuchos::ArrayView< const LocalOrdinal > getNeighborVertices(LocalOrdinal v) const =0
Return the list of vertices adjacent to the vertex &#39;v&#39;.
void SetNumAggregates(LO nAggregates)
Set number of local aggregates on current processor.