MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_Q2Q1Q2CoarseGridFactory_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_Q2Q1Q2COARSEGRIDFACTORY_DECL_HPP
48 #define MUELU_Q2Q1Q2COARSEGRIDFACTORY_DECL_HPP
49 
50 #include "MueLu_ConfigDefs.hpp"
52 //#include "MueLu_Q2Q1Q2CoarseGridFactory_fwd.hpp"
53 
54 #include <Xpetra_Matrix_fwd.hpp>
55 #include <Xpetra_Map_fwd.hpp>
60 
61 #include "MueLu_Level_fwd.hpp"
62 #include "MueLu_Utilities_fwd.hpp"
63 #include "MueLu_PFactory.hpp"
64 
65 namespace MueLu {
66 
73  template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
75 #undef MUELU_Q2Q1Q2COARSEGRIDFACTORY_SHORT
76 #include "MueLu_UseShortNames.hpp"
77 
78  public:
80 
81 
84 
86  virtual ~Q2Q1Q2CoarseGridFactory();
87 
89 
91 
92 
99  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
100 
102 
104 
105 
107  void Build(Level &fineLevel, Level &coarseLevel) const;
108 
109  void BuildCoarseGrid(Level &fineLevel, Level &coarseLevel) const;
110 
111  /* For our geometric multigrid needs, we will explicitly build the
112  coarse grid here and store it as level data. There are two
113  things we care about here: coordinates of the dofs and
114  element-dof lists.
115 
116  We will assume only that the elements are numbered
117  lexicographically, left-to-right, bottom-to-top. The order of
118  the degrees of freedom will only be assumed on coarse grids. It
119  can be anything on the finest grid (fineLevel.GetLevelID()==1).
120 
121  We further assume that the x- and y-components of velocity are
122  zippered together: UX1 UY1 UX2 UY2 ETC...
123  */
124 
126 
127  private:
128  // No parameters need to be stored... To save "P", use
129  // coarseLevel.Set("P", finalP, this);
130 
131  }; // class Q2Q1Q2CoarseGridFactory
132 
133 } // namespace MueLu
134 
135 #define MUELU_Q2Q1Q2COARSEGRIDFACTORY_SHORT
136 #endif // MUELU_Q2Q1Q2COARSEGRIDFACTORY_DECL_HPP
Factory for GMG Q2-Q1-Q2 interpolation.
Base class for factories that use two levels (fineLevel and coarseLevel).
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void BuildCoarseGrid(Level &fineLevel, Level &coarseLevel) const
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Specifies the data that this class needs, and the factories that generate that data.
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.