MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_MatrixFreeTentativeP_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_MATRIXFREETENTATIVEP_KOKKOS_DECL_HPP
47#define MUELU_MATRIXFREETENTATIVEP_KOKKOS_DECL_HPP
48
49#include "MueLu_ConfigDefs.hpp"
50
52
53#include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
54
55#include "Teuchos_ScalarTraits.hpp"
56
59#include "Xpetra_Operator.hpp"
61
62namespace MueLu {
63
68 // template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
69 // class MatrixFreeTentativeP_kokkos;
70
71 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class DeviceType>
72 class MatrixFreeTentativeP_kokkos<Scalar, LocalOrdinal, GlobalOrdinal, Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>> : public Xpetra::Operator<Scalar,LocalOrdinal,GlobalOrdinal,Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType>> {
73 public:
76 typedef typename DeviceType::execution_space execution_space;
77 typedef Kokkos::RangePolicy<local_ordinal_type, execution_space> range_type;
78 typedef Kokkos::MDRangePolicy<local_ordinal_type, execution_space, Kokkos::Rank<2>> md_range_type;
79 typedef Kokkos::Compat::KokkosDeviceWrapperNode<DeviceType> node_type;
80 typedef typename Teuchos::ScalarTraits<Scalar>::coordinateType real_type;
81
82 private:
83 // For compatibility
84 typedef node_type Node;
85#undef MUELU_MATRIXFREETENTATIVEP_KOKKOS_SHORT
87
88 public:
90
91
93 MatrixFreeTentativeP_kokkos(Teuchos::RCP<const Map> coarse_map, Teuchos::RCP<const Map> fine_map, Teuchos::RCP<const Aggregates_kokkos> aggregates)
94 : fine_map_(fine_map),
95 coarse_map_(coarse_map),
96 aggregates_(aggregates)
97 { }
98
102
103 // compute the apply operator, Y = alpha*R*X + beta*Y
104 void apply(const MultiVector &X, MultiVector &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, Scalar alpha=Teuchos::ScalarTraits<Scalar>::one(), Scalar beta=Teuchos::ScalarTraits<Scalar>::zero()) const override;
105
106 // compute the residual
107 void residual (const MultiVector &X, const MultiVector &B, MultiVector &R) const override;
108
109 // get the range map
110 Teuchos::RCP<const Map> getRangeMap() const override {
111 return fine_map_;
112 }
113
114 // get the domain map
115 Teuchos::RCP<const Map> getDomainMap() const override {
116 return coarse_map_;
117 }
118
119 // get the aggregates
120 Teuchos::RCP<const Aggregates_kokkos> getAggregates() const {
121 return aggregates_;
122 }
123
124 private:
125
126 // the fine map
127 const Teuchos::RCP<const Map> fine_map_;
128
129 // the coarse map
130 const Teuchos::RCP<const Map> coarse_map_;
131
132 // the aggregates required for the grid transfer
133 const Teuchos::RCP<const Aggregates_kokkos> aggregates_;
134 };
135
136} //namespace MueLu
137
138#define MUELU_MATRIXFREETENTATIVEP_KOKKOS_SHORT
139#endif // MUELU_MATRIXFREETENTATIVEP_KOKKOS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MatrixFreeTentativeP_kokkos(Teuchos::RCP< const Map > coarse_map, Teuchos::RCP< const Map > fine_map, Teuchos::RCP< const Aggregates_kokkos > aggregates)
Constructor.
Namespace for MueLu classes and methods.