MueLu Version of the Day
MueLu_SemiCoarsenPFactory_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_SEMICOARSENPFACTORY_KOKKOS_DECL_HPP
47#define MUELU_SEMICOARSENPFACTORY_KOKKOS_DECL_HPP
48
49#define HAVE_MUELU_KOKKOS_REFACTOR
50#ifdef HAVE_MUELU_KOKKOS_REFACTOR
51
52#include <Xpetra_Matrix_fwd.hpp>
53
54#include "MueLu_ConfigDefs.hpp"
55#include "MueLu_Level_fwd.hpp"
56#include "MueLu_PFactory.hpp"
58
59namespace MueLu {
60
99template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
101
102template <class Scalar, class LocalOrdinal, class GlobalOrdinal,
103 class DeviceType>
106 Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>> : public PFactory {
107public:
110 typedef typename DeviceType::execution_space execution_space;
111 typedef Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> node_type;
112
113private:
114 // For compatibility
116
117#undef MUELU_SEMICOARSENPFACTORY_KOKKOS_SHORT
119
120public:
122
123
125 SemiCoarsenPFactory_kokkos() : bTransferCoordinates_(false) {}
126
128 virtual ~SemiCoarsenPFactory_kokkos() = default;
130
131 RCP<const ParameterList> GetValidParameterList() const;
132
134
135
136 void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
137
139
141
142
143 void Build(Level &fineLevel, Level &coarseLevel) const;
144 void BuildP(Level &fineLevel, Level &coarseLevel) const;
145
147
148 void BuildSemiCoarsenP(Level &coarseLevel, const LO NFRows, const LO NFNodes,
149 const LO DofsPerNode, const LO NFLayers,
150 const LO NCLayers, const ArrayRCP<LO> LayerId,
151 const ArrayRCP<LO> VertLineId, const RCP<Matrix> &Amat,
152 const RCP<MultiVector> fineNullspace, RCP<Matrix> &P,
153 RCP<MultiVector> &coarseNullspace) const;
154
155 // boolean which is true if coordinate information is available to be
156 // transferred to coarse coordinate information
158}; // class SemiCoarsenPFactory_kokkos
159
160} // namespace MueLu
161
162#define MUELU_SEMICOARSENPFACTORY_KOKKOS_SHORT
163#endif // HAVE_MUELU_KOKKOS_REFACTOR
164#endif // MUELU_SEMICOARSENPFACTORY_KOKKOS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Factory that provides an interface for a concrete implementation of a prolongation operator.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void BuildSemiCoarsenP(Level &coarseLevel, const LO NFRows, const LO NFNodes, const LO DofsPerNode, const LO NFLayers, const LO NCLayers, const ArrayRCP< LO > LayerId, const ArrayRCP< LO > VertLineId, const RCP< Matrix > &Amat, const RCP< MultiVector > fineNullspace, RCP< Matrix > &P, RCP< MultiVector > &coarseNullspace) const
Prolongator factory performing semi-coarsening.
Namespace for MueLu classes and methods.