MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_BlockedPFactory_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_BLOCKEDPFACTORY_DECL_HPP_
48#define MUELU_BLOCKEDPFACTORY_DECL_HPP_
49
50#include <set>
51#include <Xpetra_MapExtractorFactory_fwd.hpp>
52#include <Xpetra_Matrix_fwd.hpp>
53
54#include "MueLu_ConfigDefs.hpp"
55#include "MueLu_PFactory.hpp"
60
61namespace MueLu {
62
63
122 template <class Scalar = DefaultScalar,
125 class Node = DefaultNode>
126 class BlockedPFactory : public PFactory {
127#undef MUELU_BLOCKEDPFACTORY_SHORT
129 public:
130
132
133
137 BlockedPFactory(/*RCP<FactoryBase> AFact = Teuchos::null*/): diagonalView_("current") { }
138
140 virtual ~BlockedPFactory() { }
141
142 RCP<const ParameterList> GetValidParameterList() const;
143
145
147
148
150 void SetDiagonalView(std::string const& diagView) { diagonalView_ = diagView; }
151
153 void AddFactoryManager(RCP<const FactoryManagerBase> FactManager) { FactManager_.push_back(FactManager); }
154
156
158
159
161 std::string GetDiagonalView() { return diagonalView_; }
162
164
166
167
168 void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
170
172
173
180 void Build(Level& fineLevel, Level &coarseLevel) const;
181
182 void BuildP(Level &fineLevel, Level &coarseLevel) const;
183
185
186 private:
187 bool areGidsUnique(const std::vector<GO>& X) const {
188 std::set<GO> Y(X.begin(), X.end());
189 return X.size() == Y.size();
190 }
191
193 std::vector<Teuchos::RCP<const FactoryManagerBase> > FactManager_;
194
196 std::string diagonalView_;
197
198 };
199
200} //namespace MueLu
201
202#define MUELU_BLOCKEDPFACTORY_SHORT
203#endif /* MUELU_BLOCKEDPFACTORY_DECL_HPP_ */
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Factory for building blocked, segregated prolongation operators.
void SetDiagonalView(std::string const &diagView)
Change view of diagonal.
std::string diagonalView_
Factory parameters.
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
BlockedPFactory()
Constructor. User can supply a factory for generating the tentative prolongator.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
std::string GetDiagonalView()
Returns current view of diagonal.
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
bool areGidsUnique(const std::vector< GO > &X) const
std::vector< Teuchos::RCP< const FactoryManagerBase > > FactManager_
Input factories.
void AddFactoryManager(RCP< const FactoryManagerBase > FactManager)
Add a factory manager.
Class that holds all level-specific information.
Factory that provides an interface for a concrete implementation of a prolongation operator.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar