MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu_GeneralGeometricPFactory_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_GENERALGEOMETRICPFACTORY_DECL_HPP
47 #define MUELU_GENERALGEOMETRICPFACTORY_DECL_HPP
48 
50 
52 #include <Xpetra_Matrix_fwd.hpp>
53 
54 #include "MueLu_ConfigDefs.hpp"
55 #include "MueLu_PFactory.hpp"
57 
58 #include "MueLu_Level_fwd.hpp"
59 
60 namespace MueLuTests {
61 // Forward declaration of friend tester class used to UnitTest GeneralGeometricPFactory
62 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
64 } // namespace MueLuTests
65 
66 namespace MueLu {
67 
115 template <class Scalar = DefaultScalar,
118  class Node = DefaultNode>
120 #undef MUELU_GENERALGEOMETRICPFACTORY_SHORT
121 #include "MueLu_UseShortNames.hpp"
122 
123  public:
125 
127 
128 
131 
135 
137 
139 
140 
141  void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
142 
144 
146 
147 
148  void Build(Level& fineLevel, Level& coarseLevel) const;
149  void BuildP(Level& fineLevel, Level& coarseLevel) const;
150 
152 
153  private:
154  struct GeometricData {
155  // Geometric algorithm require a copious amount of data to be passed around so this struct
156  // will reduce the amount of input/output parameters of methods in the class. Additionally
157  // the struct can be rewritten to accomodate constraints of Kokkos/CUDA data types
158 
159  std::string meshLayout = "Global Lexicographic";
167  std::vector<std::vector<GO> > meshData; // These are sorted later so they are in std::vector
168  bool ghostInterface[6] = {false};
169 
171  coarseRate.resize(3);
172  endRate.resize(3);
175  offsets.resize(6);
177  startIndices.resize(6);
181  }
182  };
183 
184  struct NodesIDs {
185  // This small struct just carries basic data associated with coarse nodes that is needed
186  // to compute colMapP and to fillComplete P,
187 
191  std::vector<GO> colInds;
192  };
193 
194  struct NodeID {
195  // This small struct is similar to the one above but only for one node.
196  // It is used to create a vector of NodeID that can easily be sorted
197 
199  int PID;
201  };
202 
203  void MeshLayoutInterface(const int interpolationOrder, const LO blkSize,
204  RCP<const Map> fineCoordsMap, RCP<GeometricData> myGeometry,
205  RCP<NodesIDs> ghostedCoarseNodes,
206  Array<Array<GO> >& lCoarseNodesGIDs) const;
207 
208  void GetCoarsePoints(const int interpolationOrder, const LO blkSize,
209  RCP<const Map> fineCoordsMap, RCP<GeometricData> myGeometry,
210  RCP<NodesIDs> ghostedCoarseNodes,
211  Array<Array<GO> >& lCoarseNodesGIDs) const;
212 
215  const LO nnzP, const LO dofsPerNode,
216  RCP<const Map>& stridedDomainMapP,
217  RCP<Matrix>& Amat, RCP<Matrix>& P,
219  RCP<NodesIDs> ghostedCoarseNodes, Array<Array<GO> > coarseNodesGIDs,
220  int interpolationOrder) const;
221 
222  void ComputeStencil(const LO numDimension, const Array<GO> currentNodeIndices,
223  const Array<GO> coarseNodeIndices, const LO rate[3],
224  const Array<Array<typename Teuchos::ScalarTraits<Scalar>::coordinateType> > coord, const int interpolationOrder,
225  std::vector<double>& stencil) const;
226 
227  void ComputeConstantInterpolationStencil(const LO numDimension,
228  const Array<GO> currentNodeIndices,
229  const Array<GO> coarseNodeIndices,
230  const LO rate[3], std::vector<double>& stencil) const;
231 
232  void ComputeLinearInterpolationStencil(const LO numDimension, const Array<Array<typename Teuchos::ScalarTraits<Scalar>::coordinateType> > coord,
233  std::vector<double>& stencil) const;
234  void GetInterpolationFunctions(const LO numDimension,
236  double functions[4][8]) const;
237 
238  void sh_sort_permute(
239  const typename Teuchos::Array<LocalOrdinal>::iterator& first1,
240  const typename Teuchos::Array<LocalOrdinal>::iterator& last1,
241  const typename Teuchos::Array<LocalOrdinal>::iterator& first2,
242  const typename Teuchos::Array<LocalOrdinal>::iterator& last2) const;
243 
244  void sh_sort2(
245  const typename Teuchos::Array<LocalOrdinal>::iterator& first1,
246  const typename Teuchos::Array<LocalOrdinal>::iterator& last1,
247  const typename Teuchos::Array<LocalOrdinal>::iterator& first2,
248  const typename Teuchos::Array<LocalOrdinal>::iterator& last2) const;
249 
250  void GetGIDLocalLexicographic(const GO i, const GO j, const GO k,
251  const Array<LO> coarseNodeFineIndices,
252  const RCP<GeometricData> myGeo, const LO myRankIndex, const LO pi,
253  const LO pj, const LO pk,
254  const typename std::vector<std::vector<GO> >::iterator blockStart,
255  const typename std::vector<std::vector<GO> >::iterator blockEnd,
256  GO& myGID, LO& myPID, LO& myLID) const;
257 
258 }; // class GeneralGeometricPFactory
259 
260 } // namespace MueLu
261 
262 #define MUELU_GENERALGEOMETRICPFACTORY_SHORT
263 #endif // MUELU_GENERALGEOMETRICPFACTORY_DECL_HPP
void ComputeLinearInterpolationStencil(const LO numDimension, const Array< Array< typename Teuchos::ScalarTraits< Scalar >::coordinateType > > coord, std::vector< double > &stencil) const
MueLu::DefaultLocalOrdinal LocalOrdinal
void GetCoarsePoints(const int interpolationOrder, const LO blkSize, RCP< const Map > fineCoordsMap, RCP< GeometricData > myGeometry, RCP< NodesIDs > ghostedCoarseNodes, Array< Array< GO > > &lCoarseNodesGIDs) const
Tpetra::KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
void MakeGeneralGeometricP(RCP< GeometricData > myGeo, const RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::coordinateType, LO, GO, NO > > &fCoords, const LO nnzP, const LO dofsPerNode, RCP< const Map > &stridedDomainMapP, RCP< Matrix > &Amat, RCP< Matrix > &P, RCP< Xpetra::MultiVector< typename Teuchos::ScalarTraits< Scalar >::coordinateType, LO, GO, NO > > &cCoords, RCP< NodesIDs > ghostedCoarseNodes, Array< Array< GO > > coarseNodesGIDs, int interpolationOrder) const
GlobalOrdinal GO
void BuildP(Level &fineLevel, Level &coarseLevel) const
Abstract Build method.
LocalOrdinal LO
MueLu::DefaultNode Node
Prolongator factory performing geometric coarsening.
void MeshLayoutInterface(const int interpolationOrder, const LO blkSize, RCP< const Map > fineCoordsMap, RCP< GeometricData > myGeometry, RCP< NodesIDs > ghostedCoarseNodes, Array< Array< GO > > &lCoarseNodesGIDs) const
MueLu::DefaultScalar Scalar
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
void sh_sort2(const typename Teuchos::Array< LocalOrdinal >::iterator &first1, const typename Teuchos::Array< LocalOrdinal >::iterator &last1, const typename Teuchos::Array< LocalOrdinal >::iterator &first2, const typename Teuchos::Array< LocalOrdinal >::iterator &last2) const
void ComputeStencil(const LO numDimension, const Array< GO > currentNodeIndices, const Array< GO > coarseNodeIndices, const LO rate[3], const Array< Array< typename Teuchos::ScalarTraits< Scalar >::coordinateType > > coord, const int interpolationOrder, std::vector< double > &stencil) const
void GetGIDLocalLexicographic(const GO i, const GO j, const GO k, const Array< LO > coarseNodeFineIndices, const RCP< GeometricData > myGeo, const LO myRankIndex, const LO pi, const LO pj, const LO pk, const typename std::vector< std::vector< GO > >::iterator blockStart, const typename std::vector< std::vector< GO > >::iterator blockEnd, GO &myGID, LO &myPID, LO &myLID) const
void resize(size_type new_size, const value_type &x=value_type())
void GetInterpolationFunctions(const LO numDimension, const Teuchos::SerialDenseVector< LO, double > parameters, double functions[4][8]) const
void ComputeConstantInterpolationStencil(const LO numDimension, const Array< GO > currentNodeIndices, const Array< GO > coarseNodeIndices, const LO rate[3], std::vector< double > &stencil) const
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
void sh_sort_permute(const typename Teuchos::Array< LocalOrdinal >::iterator &first1, const typename Teuchos::Array< LocalOrdinal >::iterator &last1, const typename Teuchos::Array< LocalOrdinal >::iterator &first2, const typename Teuchos::Array< LocalOrdinal >::iterator &last2) const
void Build(Level &fineLevel, Level &coarseLevel) const
Build an object with this factory.
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
Node NO
Factory that provides an interface for a concrete implementation of a prolongation operator...
std::vector< T >::iterator iterator