MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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 
56 #include "Teuchos_ScalarTraits.hpp"
57 
59 #include "MueLu_AmalgamationFactory_fwd.hpp" // FIXME_KOKKOS (once we have kokkos version)
60 #include "MueLu_AmalgamationInfo_fwd.hpp" // FIXME_KOKKOS (once we have kokkos version)
61 #include "MueLu_Level_fwd.hpp"
62 #include "MueLu_PerfUtils_fwd.hpp"
63 #include "MueLu_PFactory.hpp"
65 
66 namespace MueLu {
67 
106  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
107  class TentativePFactory_kokkos;
108 
109  template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
110  class TentativePFactory_kokkos<Scalar, LocalOrdinal, GlobalOrdinal, Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> > : public PFactory {
111  public:
112  typedef LocalOrdinal local_ordinal_type;
113  typedef GlobalOrdinal global_ordinal_type;
114  typedef typename DeviceType::execution_space execution_space;
116  typedef Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> node_type;
117  typedef typename Teuchos::ScalarTraits<Scalar>::magnitudeType real_type;
119 
120  private:
121  // For compatibility
122  typedef node_type Node;
123 #undef MUELU_TENTATIVEPFACTORY_KOKKOS_SHORT
124 #include "MueLu_UseShortNames.hpp"
125 
126  public:
128 
129 
131  TentativePFactory_kokkos() { }
132 
134  virtual ~TentativePFactory_kokkos() { }
136 
137  RCP<const ParameterList> GetValidParameterList() const;
138 
140 
141 
142  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
143 
145 
147 
148 
149  void Build (Level& fineLevel, Level& coarseLevel) const;
150  void BuildP(Level& fineLevel, Level& coarseLevel) const;
151 
153 
154  // CUDA 7.5 and 8.0 place a restriction on the placement of __device__ lambdas:
155  //
156  // An explicit __device__ lambda cannot be defined in a member function
157  // that has private or protected access within its class.
158  //
159  // Therefore, we expose BuildPuncoupled and isGoodMap for now. An alternative solution
160  // could be writing an out of class implementation, and then calling it in
161  // a member function.
162  void BuildPuncoupled(Level& coarseLevel, 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 int levelID) const;
164  bool isGoodMap(const Map& rowMap, const Map& colMap) const;
165 
166  private:
167 
168  void BuildPcoupled (RCP<Matrix> A, RCP<Aggregates_kokkos> aggregates, RCP<AmalgamationInfo> amalgInfo, RCP<MultiVector> fineNullspace,
169  RCP<const Map> coarseMap, RCP<Matrix>& Ptentative, RCP<MultiVector>& coarseNullspace) const;
170 
171  mutable bool bTransferCoordinates_ = false;
172 
173  };
174 
175 } //namespace MueLu
176 
177 #define MUELU_TENTATIVEPFACTORY_KOKKOS_SHORT
178 #endif // HAVE_MUELU_KOKKOS_REFACTOR
179 #endif // MUELU_TENTATIVEPFACTORY_KOKKOS_DECL_HPP