MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_HybridAggregationFactory_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_HYBRIDAGGREGATIONFACTORY_DECL_HPP_
47 #define MUELU_HYBRIDAGGREGATIONFACTORY_DECL_HPP_
48 
49 
50 #include <Xpetra_Map_fwd.hpp>
51 #include <Xpetra_Vector_fwd.hpp>
53 
54 #include "MueLu_ConfigDefs.hpp"
57 
59 
60 #include "MueLu_Level_fwd.hpp"
61 #include "MueLu_GraphBase.hpp"
62 #include "MueLu_Aggregates_fwd.hpp"
63 #include "MueLu_Exceptions.hpp"
65 
66 // Uncoupled Agg
71 
76 
77 // Structured Agg
79 
80 namespace MueLu {
81 
136  template <class LocalOrdinal, class GlobalOrdinal, class Node>
138 #undef MUELU_HYBRIDAGGREGATIONFACTORY_SHORT
140 
141  public:
143 
144 
147 
150 
152 
154 
156 
157 
158  void DeclareInput(Level &currentLevel) const;
159 
161 
163 
164 
166  void Build(Level &currentLevel) const;
167 
169 
170  private:
171 
173  // will be filled in Build routine
174  mutable std::vector<RCP<MueLu::AggregationAlgorithmBase<LocalOrdinal, GlobalOrdinal, Node> > > algos_;
175 
179  mutable bool bDefinitionPhase_;
180 
181  }; // class HybridAggregationFactory
182 
183 }
184 
185 #define MUELU_HYBRIDAGGREGATIONFACTORY_SHORT
186 #endif /* MUELU_HYBRIDAGGREGATIONFACTORY_DECL_HPP_ */
Factory for building aggregates on meshes partly structured and partly unstructured.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
std::vector< RCP< MueLu::AggregationAlgorithmBase< LocalOrdinal, GlobalOrdinal, Node > > > algos_
aggregation algorithms
void Build(Level &currentLevel) const
Build aggregates.
void DeclareInput(Level &currentLevel) const
Input.
Base class for factories that use one level (currentLevel).