MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_TogglePFactory_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_TOGGLEPFACTORY_DECL_HPP
47 #define MUELU_TOGGLEPFACTORY_DECL_HPP
48 
49 #include "MueLu_ConfigDefs.hpp"
51 
52 #include "MueLu_Level_fwd.hpp"
54 #include "MueLu_PFactory.hpp"
56 
57 namespace MueLu {
58 
91  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
92  class TogglePFactory : public PFactory {
93 #undef MUELU_TOGGLEPFACTORY_SHORT
94 #include "MueLu_UseShortNames.hpp"
95 
96  public:
97 
99 
100 
103 
105  virtual ~TogglePFactory() { }
106 
108 
110 
112 
113 
114  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
115 
117 
119 
120 
122  void Build(Level& fineLevel, Level &coarseLevel) const;
123 
124  void BuildP(Level &/* fineLevel */, Level &/* coarseLevel */) const { /* empty */ };
126 
128 
130  void AddProlongatorFactory(const RCP<const FactoryBase>& factory);
131 
133  size_t NumProlongatorFactories() const { return prolongatorFacts_.size(); }
134 
136  void AddPtentFactory(const RCP<const FactoryBase>& factory);
137 
139  size_t NumPtentFactories() const { return ptentFacts_.size(); }
140 
143 
145  size_t NumCoarseNullspaceFactories() const { return prolongatorFacts_.size(); }
146 
148  private:
150  mutable std::vector<RCP<const FactoryBase> > prolongatorFacts_;
151 
153  mutable std::vector<RCP<const FactoryBase> > ptentFacts_;
154 
156  mutable std::vector<RCP<const FactoryBase> > nspFacts_;
157 
158  mutable bool hasDeclaredInput_;
159  }; //class TogglePFactory
160 
161 } //namespace MueLu
162 
163 #define MUELU_TOGGLEPFACTORY_SHORT
164 #endif // MUELU_TOGGLEPFACTORY_DECL_HPP
std::vector< RCP< const FactoryBase > > ptentFacts_
list of user-defined tentative prolongation operator factories
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
void AddProlongatorFactory(const RCP< const FactoryBase > &factory)
Add a prolongator factory in the end of list of prolongator factories.
std::vector< RCP< const FactoryBase > > nspFacts_
list of user-defined nullspace factories (i.e. the prolongator factories which also generate the coar...
size_t NumPtentFactories() const
Returns number of tentative prolongator factories.
void BuildP(Level &, Level &) const
Abstract Build method.
std::vector< RCP< const FactoryBase > > prolongatorFacts_
list of user-defined prolongation operator factories
virtual ~TogglePFactory()
Destructor.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Prolongator factory which allows switching between two different prolongator strategies.
size_t NumCoarseNullspaceFactories() const
Returns number of coarse null space factories.
Factory that provides an interface for a concrete implementation of a prolongation operator...
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
void AddPtentFactory(const RCP< const FactoryBase > &factory)
Add a tentative prolongator factory in the end of list of prolongator factories.
size_t NumProlongatorFactories() const
Returns number of prolongator factories.
void AddCoarseNullspaceFactory(const RCP< const FactoryBase > &factory)
Add a coarse nullspace factory in the end of list of coarse nullspace factories.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.