MueLu Version of the Day
Loading...
Searching...
No Matches
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
55
56#include <KokkosCompat_ClassicNodeAPI_Wrapper.hpp>
57
58namespace MueLu {
59
106 template<class LocalOrdinal = DefaultLocalOrdinal,
108 class Node = DefaultNode>
110#undef MUELU_STRUCTUREDAGGREGATIONFACTORY_KOKKOS_SHORT
112
113 public:
115
116
119
122
123 RCP<const ParameterList> GetValidParameterList() const;
124
126
128
129 // set information about 1-node aggregates (map name and generating factory)
130 void SetOnePtMapName(const std::string name, Teuchos::RCP<const FactoryBase> mapFact) {
131 SetParameter("OnePt aggregate map name", ParameterEntry(std::string(name))); // revalidate
132 SetFactory("OnePt aggregate map factory",mapFact);
133 }
134
136
138
139
140 void DeclareInput(Level& currentLevel) const;
141
143
145
146
148 void Build(Level& currentLevel) const;
149
151
152 private:
153
157 mutable bool bDefinitionPhase_;
158
159 }; // class StructuredAggregationFactory
160
161}
162
163#define MUELU_STRUCTUREDAGGREGATIONFACTORY_KOKKOS_SHORT
164#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
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).
Factory for building structured aggregates or CrsGraph for interpolation base prolongator.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void SetOnePtMapName(const std::string name, Teuchos::RCP< const FactoryBase > mapFact)
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode