MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_UncoupledAggregationFactory_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_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP
47#define MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP
48
49#include "MueLu_ConfigDefs.hpp"
50
51#include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
52
53#include <Xpetra_Map_fwd.hpp>
54#include <Xpetra_Vector_fwd.hpp>
55#include <Xpetra_VectorFactory_fwd.hpp>
56
58
66#include "MueLu_Exceptions.hpp"
68#include "MueLu_Level_fwd.hpp"
69#include "MueLu_LWGraph_kokkos.hpp"
73
74namespace MueLu {
75
140 template<class LocalOrdinal = DefaultLocalOrdinal,
142 class Node = DefaultNode>
144#undef MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_SHORT
146
147 public:
149
150
153
156
157 RCP<const ParameterList> GetValidParameterList() const;
158
160
162
163
164 // Options shared by all aggregation algorithms
165
166 // deprecated
167 void SetOrdering(const std::string& ordering) {
168 SetParameter("aggregation: ordering", ParameterEntry(ordering));
169 }
170 // deprecated
171 void SetMaxNeighAlreadySelected(int maxNeighAlreadySelected) {
172 SetParameter("aggregation: max selected neighbors", ParameterEntry(Teuchos::as<LocalOrdinal>(maxNeighAlreadySelected))); // revalidate
173 }
174 // deprecated
175 void SetMinNodesPerAggregate(int minNodesPerAggregate) {
176 SetParameter("aggregation: min agg size", ParameterEntry(Teuchos::as<LocalOrdinal>(minNodesPerAggregate))); // revalidate
177 }
178 // set information about 1-node aggregates (map name and generating factory)
179 void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
180 SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name))); // revalidate
181 SetFactory("OnePt aggregate map factory",mapFact);
182 }
183
184 // deprecated
185 const std::string& GetOrdering() const {
186 const ParameterList& pL = GetParameterList();
187 return pL.get<std::string>("aggregation: ordering");
188 }
189 // deprecated
191 const ParameterList& pL = GetParameterList();
192 return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: max selected neighbors"));
193 }
194 // deprecated
196 const ParameterList& pL = GetParameterList();
197 return Teuchos::as<int>(pL.get<LocalOrdinal>("aggregation: min agg size"));
198 }
199
201
203
204
205 void DeclareInput(Level &currentLevel) const;
206
208
210
211
213 void Build(Level &currentLevel) const;
214
216
218
219
221 //void Append(const RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > & alg);
222
224 //void ClearAggregationAlgorithms() { algos_.clear(); }
226
227 private:
228
230 // will be filled in Build routine
231 mutable std::vector<RCP<MueLu::AggregationAlgorithmBase_kokkos<LocalOrdinal, GlobalOrdinal, Node> > > algos_;
232
236 mutable bool bDefinitionPhase_;
237
238 }; // class UncoupledAggregationFactory_kokkos
239
240}
241
242#define MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_SHORT
243#endif // MUELU_UNCOUPLEDAGGREGATIONFACTORY_KOKKOS_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
virtual void SetFactory(const std::string &varName, const RCP< const FactoryBase > &factory)
Configuration.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual const Teuchos::ParameterList & GetParameterList() const
void SetParameter(const std::string &name, const ParameterEntry &entry)
Set a parameter directly as a ParameterEntry.
Base class for factories that use one level (currentLevel).
void SetOnePtMapName(const std::string name, Teuchos::RCP< const FactoryBase > mapFact)
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
std::vector< RCP< MueLu::AggregationAlgorithmBase_kokkos< LocalOrdinal, GlobalOrdinal, Node > > > algos_
Append a new aggregation algorithm to list of aggregation algorithms.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode