MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_AggregationPhase1Algorithm_kokkos_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_AGGREGATIONPHASE1ALGORITHM_KOKKOS_DECL_HPP
47 #define MUELU_AGGREGATIONPHASE1ALGORITHM_KOKKOS_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 
51 #include <Tpetra_KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
52 
54 
55 #include "MueLu_Aggregates_fwd.hpp"
58 #include "MueLu_LWGraph_kokkos.hpp"
59 
60 namespace MueLu {
85 template <class LocalOrdinal = DefaultLocalOrdinal,
87  class Node = DefaultNode>
88 class AggregationPhase1Algorithm_kokkos : public MueLu::AggregationAlgorithmBase_kokkos<LocalOrdinal, GlobalOrdinal, Node> {
89 #undef MUELU_AGGREGATIONPHASE1ALGORITHM_KOKKOS_SHORT
91 
92  public:
96 
98 
99 
101  AggregationPhase1Algorithm_kokkos(const RCP<const FactoryBase>& /* graphFact */ = Teuchos::null) {}
102 
105 
107 
109 
110 
113  void BuildAggregates(const Teuchos::ParameterList& params,
114  const LWGraph_kokkos& graph,
115  Aggregates& aggregates,
116  Kokkos::View<unsigned*, device_type>& aggStat,
117  LO& numNonAggregatedNodes) const;
118 
119  void BuildAggregatesRandom(const LO maxAggSize,
120  const LWGraph_kokkos& graph,
121  Aggregates& aggregates,
122  Kokkos::View<unsigned*, device_type>& aggStat,
123  LO& numNonAggregatedNodes) const;
124 
125  void BuildAggregatesDeterministic(const LO maxAggSize,
126  const LWGraph_kokkos& graph,
127  Aggregates& aggregates,
128  Kokkos::View<unsigned*, device_type>& aggStat,
129  LO& numNonAggregatedNodes) const;
131 
132  std::string description() const { return "Phase 1 (main)"; }
133 };
134 
135 } // namespace MueLu
136 
137 #define MUELU_AGGREGATIONPHASE1ALGORITHM_KOKKOS_SHORT
138 #endif // MUELU_AGGREGATIONPHASE1ALGORITHM_KOKKOS_DECL_HPP
void BuildAggregatesRandom(const LO maxAggSize, const LWGraph_kokkos &graph, Aggregates &aggregates, Kokkos::View< unsigned *, device_type > &aggStat, LO &numNonAggregatedNodes) const
MueLu::DefaultLocalOrdinal LocalOrdinal
void BuildAggregatesDeterministic(const LO maxAggSize, const LWGraph_kokkos &graph, Aggregates &aggregates, Kokkos::View< unsigned *, device_type > &aggStat, LO &numNonAggregatedNodes) const
Lightweight MueLu representation of a compressed row storage graph.
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Container class for aggregation information.
LocalOrdinal LO
MueLu::DefaultNode Node
MueLu::DefaultGlobalOrdinal GlobalOrdinal
std::string description() const
Return a simple one-line description of this object.
void BuildAggregates(const Teuchos::ParameterList &params, const LWGraph_kokkos &graph, Aggregates &aggregates, Kokkos::View< unsigned *, device_type > &aggStat, LO &numNonAggregatedNodes) const
Local aggregation.
AggregationPhase1Algorithm_kokkos(const RCP< const FactoryBase > &=Teuchos::null)
Constructor.
typename std::conditional< OnHost, Kokkos::Device< Kokkos::Serial, Kokkos::HostSpace >, typename Node::device_type >::type device_type