MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_GeoInterpFactory_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 //
48 // Note 1: This implementation assumes the following:
49 // 1. The mesh is square and regular.
50 // 2. The number of ELEMENTS on the fine grid is even.
51 // 3. Coarsening by a factor of two.
52 //
53 // This should be general enough for 1-3 dimensions, but is originally
54 // implemented to work with two, so deal with it if there are bugs
55 // initially.
56 //
57 // ASSUMPTIONS TO ELIMINATE:
58 // 1. none that i can think of currently
59 //
60 // Note 2: This factory also generates the coarse grid coordinates.
61 // TODO: More elegant solution - MueLu_MultiVectorTransferFactory.cpp
62 // in $MUELU_HOME/src/MueCentral/ perhaps...
63 //
64 
65 #ifndef MUELU_GEOINTERPFACTORY_DECL_HPP
66 #define MUELU_GEOINTERPFACTORY_DECL_HPP
67 
68 #include "MueLu_ConfigDefs.hpp"
69 //#include "MueLu_SingleLevelFactoryBase.hpp"
70 //#include "MueLu_GeoInterpFactory_fwd.hpp"
71 
72 #include <Xpetra_Matrix_fwd.hpp>
73 #include <Xpetra_Map_fwd.hpp>
74 #include <Xpetra_MapFactory_fwd.hpp>
75 #include <Xpetra_CrsMatrixWrap_fwd.hpp>
76 #include <Xpetra_MultiVector_fwd.hpp>
77 #include <Xpetra_MultiVectorFactory_fwd.hpp>
78 
79 #include "MueLu_Level_fwd.hpp"
80 #include "MueLu_Utilities_fwd.hpp"
81 #include "MueLu_PFactory.hpp"
82 
83 namespace MueLu {
84 
91  template <class Scalar = DefaultScalar,
94  class Node = DefaultNode>
95  class GeoInterpFactory : public PFactory {
96 #undef MUELU_GEOINTERPFACTORY_SHORT
97 #include "MueLu_UseShortNames.hpp"
98 
99  public:
101 
102 
105 
107  virtual ~GeoInterpFactory();
108 
110 
112 
113 
120  void DeclareInput(Level &fineLevel, Level &coarseLevel) const;
121 
123 
125 
126 
128  void Build(Level &fineLevel, Level &coarseLevel) const;
129 
130  void BuildP(Level &fineLevel, Level &coarseLevel) const;
131 
132  //void BuildCoarseGrid(Level &fineLevel, Level &coarseLevel) const;
133 
134  /* For our geometric multigrid needs, we will explicitly build the
135  coarse grid here and store it as level data. There are two
136  things we care about here: coordinates of the dofs and
137  element-dof lists.
138 
139  We will assume only that the elements are numbered
140  lexicographically, left-to-right, bottom-to-top. The order of
141  the degrees of freedom will only be assumed on coarse grids. It
142  can be anything on the finest grid (fineLevel.GetLevelID()==1).
143 
144  We further assume that the x- and y-components of velocity are
145  zippered together: UX1 UY1 UX2 UY2 ETC...
146  */
147 
149 
150  private:
151  // No parameters need to be stored... To save "P", use
152  // coarseLevel.Set("P", finalP, this);
153 
154  }; // class GeoInterpFactory
155 
156 } // namespace MueLu
157 
158 #define MUELU_GEOINTERPFACTORY_SHORT
159 #endif // MUELU_GEOINTERPFACTORY_DECL_HPP
Factory for GMG Q2-Q1-Q2 interpolation.
MueLu::DefaultLocalOrdinal LocalOrdinal
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
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.
MueLu::DefaultNode Node
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
virtual ~GeoInterpFactory()
Destructor.
Factory that provides an interface for a concrete implementation of a prolongation operator...