MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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  * MueLu_BlockedCoarseMapFactory_decl.hpp
48  *
49  * Created on: Oct 16, 2012
50  * Author: tobias
51  */
52 
53 #ifndef MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_
54 #define MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_
56 
57 #include "MueLu_ConfigDefs.hpp"
58 #include "MueLu_CoarseMapFactory.hpp"
59 
60 #include "MueLu_Level_fwd.hpp"
61 #include "MueLu_Aggregates_fwd.hpp"
62 #include "MueLu_Exceptions.hpp"
63 
64 namespace MueLu {
65 
76 template <class Scalar = double,
77  class LocalOrdinal = int,
78  class GlobalOrdinal = LocalOrdinal,
80 class BlockedCoarseMapFactory : public MueLu::CoarseMapFactory<Scalar, LocalOrdinal, GlobalOrdinal, Node> { //SingleLevelFactoryBase {
81 #undef MUELU_BLOCKEDCOARSEMAPFACTORY_SHORT
82 #include "MueLu_UseShortNames.hpp"
83 
84 public:
85 
87 
88 
91 
93  virtual ~BlockedCoarseMapFactory();
94 
96 
98 
99 
101 
108  void DeclareInput(Level &currentLevel) const;
109 
111 
113 
114 
116  void Build(Level &currentLevel) const;
117 
119 
120 private:
121 
122 }; //class BlockedCoarseMapFactory
123 
124 } //namespace MueLu
125 
126 #define MUELU_BLOCKEDCOARSEMAPFACTORY_SHORT
127 #endif /* MUELU_BLOCKEDCOARSEMAPFACTORY_DECL_HPP_ */
Factory for generating coarse level map. Used by TentativePFactory.
void Build(Level &currentLevel) const
Build an object with this factory.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Factory for generating coarse level map. Used by BlockedPFactory.
void DeclareInput(Level &currentLevel) const
Specifies the data that this class needs, and the factories that generate that data.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.