MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_BlockedCoarseMapFactory_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
47#ifndef MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_
48#define MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_
49#include "Xpetra_StridedMapFactory_fwd.hpp"
50
51#include "MueLu_ConfigDefs.hpp"
52#include "MueLu_CoarseMapFactory.hpp"
53
54#include "MueLu_Level_fwd.hpp"
56#include "MueLu_Exceptions.hpp"
57
58namespace MueLu {
59
93template <class Scalar = DefaultScalar,
96 class Node = DefaultNode>
97class BlockedCoarseMapFactory : public MueLu::CoarseMapFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> { //SingleLevelFactoryBase {
98#undef MUELU_BLOCKEDCOARSEMAPFACTORY_SHORT
100
101public:
102
104
105
106 RCP<const ParameterList> GetValidParameterList() const final;
107
113 void DeclareInput(Level &currentLevel) const final;
114
116
118
119
121 void Build(Level &currentLevel) const final;
122
124
125protected:
126
128 virtual GlobalOrdinal GetDomainGIDOffset(Level& currentLevel) const final;
129
130}; //class BlockedCoarseMapFactory
131
132} //namespace MueLu
133
134#define MUELU_BLOCKEDCOARSEMAPFACTORY_SHORT
135#endif /* MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Factory for generating coarse level map. Used by BlockedPFactory.
void Build(Level &currentLevel) const final
Build an object with this factory.
void DeclareInput(Level &currentLevel) const final
Specifies the data that this class needs, and the factories that generate that data.
virtual GlobalOrdinal GetDomainGIDOffset(Level &currentLevel) const final
Compute domain GID offset from another CoarseMap.
RCP< const ParameterList > GetValidParameterList() const final
Return a const parameter list of valid parameters that setParameterList() will accept.
Factory for generating coarse level map. Used by TentativePFactory.
Class that holds all level-specific information.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar