MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_StructuredAggregationFactory_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_STRUCTUREDAGGREGATIONFACTORY_KOKKOS_DECL_HPP
47 #define MUELU_STRUCTUREDAGGREGATIONFACTORY_KOKKOS_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
51 #include "MueLu_Level_fwd.hpp"
52 #include "MueLu_Exceptions.hpp"
53 
54 #ifdef HAVE_MUELU_KOKKOS_REFACTOR
56 
57 #include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
58 
59 namespace MueLu {
60 
107  template <class LocalOrdinal = int,
108  class GlobalOrdinal = LocalOrdinal,
110  class StructuredAggregationFactory_kokkos : public SingleLevelFactoryBase {
111 #undef MUELU_STRUCTUREDAGGREGATIONFACTORY_KOKKOS_SHORT
113 
114  public:
116 
117 
119  StructuredAggregationFactory_kokkos();
120 
122  virtual ~StructuredAggregationFactory_kokkos() { }
123 
124  RCP<const ParameterList> GetValidParameterList() const;
125 
127 
129 
130  // set information about 1-node aggregates (map name and generating factory)
131  void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
132  SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name))); // revalidate
133  SetFactory("OnePt aggregate map factory",mapFact);
134  }
135 
137 
139 
140 
141  void DeclareInput(Level& currentLevel) const;
142 
144 
146 
147 
149  void Build(Level& currentLevel) const;
150 
152 
153  private:
154 
158  mutable bool bDefinitionPhase_;
159 
160  }; // class StructuredAggregationFactory
161 
162 }
163 
164 #define MUELU_STRUCTUREDAGGREGATIONFACTORY_KOKKOS_SHORT
165 #endif // HAVE_MUELU_KOKKOS_REFACTOR
166 #endif // MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP