MueLu  Version of the Day
MueLu_TentativePFactory_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_TENTATIVEPFACTORY_KOKKOS_DECL_HPP
47 #define MUELU_TENTATIVEPFACTORY_KOKKOS_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
50 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
51 
53 
54 #include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
55 
57 #include "MueLu_AmalgamationFactory_fwd.hpp" // FIXME (once we have kokkos version)
58 #include "MueLu_AmalgamationInfo_fwd.hpp" // FIXME (once we have kokkos version)
59 #include "MueLu_Level_fwd.hpp"
60 #include "MueLu_PerfUtils_fwd.hpp"
61 #include "MueLu_PFactory.hpp"
63 
64 namespace MueLu {
65 
104  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
105  class TentativePFactory_kokkos;
106 
107  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
108  class TentativePFactory_kokkos<Scalar, LocalOrdinal, GlobalOrdinal, Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> > : public PFactory {
109  public:
110  typedef LocalOrdinal local_ordinal_type;
111  typedef GlobalOrdinal global_ordinal_type;
112  typedef typename DeviceType::execution_space execution_space;
113  typedef Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> node_type;
114 
115  private:
116  // For compatibility
117  typedef node_type Node;
118 #undef MUELU_TENTATIVEPFACTORY_KOKKOS_SHORT
119 #include "MueLu_UseShortNames.hpp"
120 
121  public:
123 
124 
126  TentativePFactory_kokkos() { }
127 
129  virtual ~TentativePFactory_kokkos() { }
131 
132  RCP<const ParameterList> GetValidParameterList() const;
133 
135 
136 
137  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
138 
140 
142 
143 
144  void Build (Level& fineLevel, Level& coarseLevel) const;
145  void BuildP(Level& fineLevel, Level& coarseLevel) const;
146 
148 
149  // CUDA 7.5 places a restriction on the placement of __device__ lambdas:
150  //
151  // An explicit __device__ lambda cannot be defined in a member function
152  // that has private or protected access within its class.
153  //
154  // Therefore, we expose BuildPuncoupled for now. An alternative solution
155  // could be writing an out of class implementation, and then calling it in
156  // a member function.
157  void BuildPuncoupled(RCP<Matrix> A, RCP<Aggregates_kokkos> aggregates, RCP<AmalgamationInfo> amalgInfo, RCP<MultiVector> fineNullspace,
158  RCP<const Map> coarseMap, RCP<Matrix>& Ptentative, RCP<MultiVector>& coarseNullspace) const;
159 
160  private:
161 
162  void BuildPcoupled (RCP<Matrix> A, RCP<Aggregates_kokkos> aggregates, RCP<AmalgamationInfo> amalgInfo, RCP<MultiVector> fineNullspace,
163  RCP<const Map> coarseMap, RCP<Matrix>& Ptentative, RCP<MultiVector>& coarseNullspace) const;
164  bool isGoodMap(const Map& rowMap, const Map& colMap) const;
165 
166  };
167 
168 } //namespace MueLu
169 
170 #define MUELU_TENTATIVEPFACTORY_KOKKOS_SHORT
171 #endif // HAVE_MUELU_KOKKOS_REFACTOR
172 #endif // MUELU_TENTATIVEPFACTORY_KOKKOS_DECL_HPP
Namespace for MueLu classes and methods.