MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_RAPFactory_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_RAPFACTORY_DECL_HPP
47#define MUELU_RAPFACTORY_DECL_HPP
48
49#include <string>
50
51#include <Xpetra_CrsMatrix_fwd.hpp>
52#include <Xpetra_MatrixFactory_fwd.hpp>
53#include <Xpetra_Matrix_fwd.hpp>
54#include <Xpetra_MatrixUtils_fwd.hpp>
55#include <Xpetra_VectorFactory_fwd.hpp>
56#include <Xpetra_Vector_fwd.hpp>
57
58#include "MueLu_ConfigDefs.hpp"
59
61
63#include "MueLu_Level_fwd.hpp"
67
68namespace MueLu {
73 template <class Scalar = DefaultScalar,
76 class Node = DefaultNode>
78#undef MUELU_RAPFACTORY_SHORT
80
81 public:
83
84
85 RAPFactory();
86
87 virtual ~RAPFactory() { }
88
90
92
93
94 RCP<const ParameterList> GetValidParameterList() const;
95
96 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
97
99
101
102 void Build(Level& fineLevel, Level& coarseLevel) const;
104
106
111 void AddTransferFactory(const RCP<const FactoryBase>& factory);
112
113 // TODO add a function to remove a specific transfer factory?
114
116 size_t NumTransferFactories() const { return transferFacts_.size(); }
117
119
120 private:
121
123
124 mutable
126
128
130
132 std::vector<RCP<const FactoryBase> > transferFacts_;
133
135
136 }; //class RAPFactory
137
138} //namespace MueLu
139
140#define MUELU_RAPFACTORY_SHORT
141#endif // MUELU_RAPFACTORY_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Class that holds all level-specific information.
Factory for building coarse matrices.
std::vector< RCP< const FactoryBase > > transferFacts_
list of user-defined transfer Factories
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
size_t NumTransferFactories() const
Returns number of transfer factories.
void AddTransferFactory(const RCP< const FactoryBase > &factory)
Add transfer factory in the end of list of transfer factories in RepartitionAcFactory.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
Base class for factories that use two levels (fineLevel and coarseLevel).
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar