MueLu Version of the Day
MueLu_SaPFactory_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_SAPFACTORY_KOKKOS_DECL_HPP
47#define MUELU_SAPFACTORY_KOKKOS_DECL_HPP
48
49#include <string>
50
51#include "MueLu_ConfigDefs.hpp"
52#ifdef HAVE_MUELU_KOKKOS_REFACTOR
53
54#include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
55
57
58#include "MueLu_Level_fwd.hpp"
61#include "MueLu_PFactory.hpp"
65
66namespace MueLu {
67
97 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
98 class SaPFactory_kokkos;
99
100 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
101 class SaPFactory_kokkos<Scalar, LocalOrdinal, GlobalOrdinal, Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> > : public PFactory {
102 public:
103 typedef LocalOrdinal local_ordinal_type;
104 typedef GlobalOrdinal global_ordinal_type;
105 typedef typename DeviceType::execution_space execution_space;
106 typedef Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> node_type;
107
108 private:
109 // For compatibility
110 typedef node_type Node;
111#undef MUELU_SAPFACTORY_KOKKOS_SHORT
113
114 public:
115
117
118
122 SaPFactory_kokkos() { }
123
125 virtual ~SaPFactory_kokkos() { }
126
127 RCP<const ParameterList> GetValidParameterList() const;
128
130
132
133
134 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
135
137
139
140
147 void Build (Level& fineLevel, Level& coarseLevel) const;
148
149 void BuildP(Level& fineLevel, Level& coarseLevel) const;
150
151 void SatisfyPConstraints(RCP<Matrix> A, RCP<Matrix>& P) const;
152
154
155 };
156
157} //namespace MueLu
158
159#define MUELU_SAPFACTORY_KOKKOS_SHORT
160#endif // HAVE_MUELU_KOKKOS_REFACTOR
161#endif // MUELU_SAPFACTORY_KOKKOS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Namespace for MueLu classes and methods.