MueLu  Version of the Day
MueLu_OnePtAggregationAlgorithm_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 /*
47  * MueLu_OnePtAggregationAlgorithm_decl.hpp
48  *
49  * Created on: Sep 18, 2012
50  * Author: Tobias Wiesner
51  */
52 
53 #ifndef MUELU_ONEPTAGGREGATIONALGORITHM_DECL_HPP_
54 #define MUELU_ONEPTAGGREGATIONALGORITHM_DECL_HPP_
55 
56 #include "MueLu_ConfigDefs.hpp"
59 
61 #include "MueLu_Aggregates_fwd.hpp"
62 //#include "MueLu_Graph_fwd.hpp"
63 #include "MueLu_GraphBase.hpp"
64 
65 namespace MueLu {
84  template <class LocalOrdinal = int,
85  class GlobalOrdinal = LocalOrdinal,
86  class Node = KokkosClassic::DefaultNode::DefaultNodeType>
88  public MueLu::AggregationAlgorithmBase<LocalOrdinal,GlobalOrdinal,Node> {
89 #undef MUELU_ONEPTAGGREGATIONALGORITHM_SHORT
91 
92  public:
94 
95 
97  OnePtAggregationAlgorithm(RCP<const FactoryBase> const &graphFact = Teuchos::null);
98 
101 
103 
104 
106 
107 
110  void BuildAggregates(Teuchos::ParameterList const & params, GraphBase const & graph, Aggregates & aggregates, std::vector<unsigned>& aggStat, LO& numNonAggregatedNodes) const;
112 
113 
114  }; //class OnePtAggregationAlgorithm
115 
116 } //namespace MueLu
117 
118 #define MUELU_ONEPTAGGREGATIONALGORITHM_SHORT
119 #endif /* MUELU_ONEPTAGGREGATIONALGORITHM_DECL_HPP_ */
Algorithm for coarsening a graph with uncoupled aggregation. keep special marked nodes as singleton n...
Container class for aggregation information.
Pure virtual base class for all MueLu aggregation algorithms.
Namespace for MueLu classes and methods.
OnePtAggregationAlgorithm(RCP< const FactoryBase > const &graphFact=Teuchos::null)
Constructor.
MueLu representation of a graph.
void BuildAggregates(Teuchos::ParameterList const &params, GraphBase const &graph, Aggregates &aggregates, std::vector< unsigned > &aggStat, LO &numNonAggregatedNodes) const
Local aggregation.